Skip to main content
POST
Pause dispatch for a Five9 Domain

Authorizations

X-API-Key
string
header
required

Path Parameters

tenancy_id
string
required

Body

application/json

Open a hold on dispatch.

All fields are optional. duration_seconds schedules an automatic resume; omit it for an open-ended hold that must be resumed explicitly. reason is a free-text audit note. lane narrows a Domain-scoped pause to one named dispatch lane and bucket narrows it to one provider rate bucket — both are validated against the fixed allowed sets.

duration_seconds
integer | null
Required range: 1 <= x <= 604800
reason
string | null
Maximum string length: 500
lane
string | null
bucket
string | null

Response

Successful Response

One hold on dispatch — an admin hold or an automatic backoff.

Both kinds share this one shape, so a single listing shows everything currently holding dispatch. scope says how much is held and the matching target field (tenancy_id, lane, bucket, or batch_id) says exactly what. cause is the machine-readable origin (admin_request for a human hold, the provider fault tag for an automatic backoff) and reason is the human note, if any. A released pause keeps its record: released_at and released_by complete the audit trail, and extensions lists every time a scheduled resume was pushed out.

id
string
required
scope
string
required
tenancy_id
string | null
required
bucket
string | null
required
lane
string | null
required
batch_id
string | null
required
status
string
required
cause
string
required
reason
string | null
required
created_by
string
required
created_at
string<date-time>
required
expires_at
string<date-time> | null
required
released_at
string<date-time> | null
required
released_by
string | null
required
extensions
Extensions · object[]
required