Skip to main content
POST
Create a tenant away-state (pause) reason code

Authorizations

Authorization
string
header
required

Dashboard JWT token from Clerk

Headers

Idempotency-Key
string

Stripe-style idempotency token. Pass a stable, client-generated value (1-255 chars) to dedupe retries on transient timeouts. The same key+credential+path replays the original response for 24h on 2xx (5min on 4xx, 30s on 5xx). Returns 409 if a concurrent request with the same key is already in flight; replayed responses include the Idempotency-Replay: true response header.

Required string length: 1 - 255
X-Test-Mode
enum<string>

Sandbox opt-in for Clerk-session-authenticated requests — see Test mode explained for the full credential-header matrix and worked samples. Set to true to route the call through the test-mode pipeline: no real provider delivery, no credits deducted, response meta.test_mode: true. Ignored for live API keys (dv_live_sk_*) — server-to-server clients must use a test-prefixed key (dv_test_sk_*) to exercise sandbox. Test-prefixed keys unconditionally enable sandbox regardless of this header.

Available options:
true,
false

Body

application/json
code
string
required

Machine-readable slug (lowercase ASCII letters, digits, _ or -). Immutable once created.

Required string length: 1 - 64
Pattern: ^[a-z0-9_-]+$
display_label
string
required

Human-readable label rendered by the agent softphone pause picker.

Required string length: 1 - 64
max_seconds
integer | null

Optional ceiling on how long an agent may remain in this pause state, in seconds (1..86400). Omit or null for no ceiling.

Required range: 1 <= x <= 86400
active
boolean

Defaults to true; pass false to stage a code without exposing it to agents.

Response

Standard error envelope. error.code is machine-readable; see the error reference for the catalogue.

error
object
meta
object