Skip to main content
POST
Submit a dialer call disposition

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

id
string
required

Campaign id.

Body

application/json
attempt_id
string

The call-attempt id being dispositioned.

disposition
string

Outcome label (e.g. 'connected', 'callback_later', 'dnc', 'wrong_number'). Unrecognized values default to the 'connected' route.

notes
string

Optional free-text agent notes.

callback_scheduled_at
string<date-time>

Required when disposition routes to callback_scheduled. ISO-8601 with offset, must be in the future and within 90 days.

Response

The recorded disposition and the contact's resulting status.

The recorded disposition and the contact's resulting status.

data
object
meta
object