Pause dispatch for a Five9 Domain
Admin only. Holds outbound dispatch for this Domain by opening a pause record. Omit lane to hold the WHOLE Domain; provide a named lane to hold only that lane’s dispatch while the rest of the Domain keeps flowing. duration_seconds schedules an automatic resume; omit it for an open-ended hold that must be resumed explicitly.
Nothing is deleted or cancelled: the hold is an auditable record with who/when/why, listable under this Domain’s /pauses, and dispatch resumes exactly where it stopped. Batches are NOT rewritten by a Domain or lane hold. Cross-tenant access returns 404, never 403.
Authorizations
Path Parameters
Body
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.
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.