Skip to main content
POST
Create a queue disposition (wrap-up code) catalog row

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. 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

Path Parameters

queueId
string
required
Required string length: 1 - 128

Body

application/json
code
string
required

Immutable lowercase-ASCII slug the softphone picker posts. Unique across the queue's ACTIVE rows — a duplicate returns 409 DISPOSITION_ALREADY_EXISTS.

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

Human-readable picker label.

Required string length: 1 - 200
parentId
string<uuid>

Optional parent for a single level of nesting; must be a root disposition on the same queue.

sortOrder
integer
default:100

Picker display order.

Required range: 0 <= x <= 10000
requiredOnTerminate
boolean
default:true

When true the picker renders the row as required before the agent can leave wrap-up.

noteTemplate
string

Optional after-call-work note starter text. Omit for none — an explicit null is rejected on create (clear it via PATCH { noteTemplate: null }).

Maximum string length: 4096

Response

Created — the resource was created successfully.

data
object
required
meta
object
required