Skip to main content
POST
Pause a run
Stops a running run from dialling, reversibly.

Pause is a real stop

  • Nothing further is dialled, including calls already queued when you paused. They are withdrawn from the dispatch queue, and anything the dispatcher had already picked up is refused at the call itself.
  • The work is held, not discarded. The conversations stay in place. Resume puts back exactly what pause held.
  • A contact already reached is not called again. Resume restores only the conversations that were never dialled.
  • A contact attached while paused is not called either. They join the held work and go out on resume.
affectedCalls is how many queued calls were withdrawn.

Only from RUNNING

Pausing a draft, a completed run or a cancelled one is a 422. A draft has nothing queued to stop.

Error Scenarios

  • 404 Not Found: the run does not exist, or belongs to another company
  • 422 Unprocessable Entity: the run is not running
  • 403 Forbidden: the API key does not hold write:runs

Resume Run

Put the held calls back

Cancel Run

Stop it for good instead

Authorizations

Authorization
string
header
required

API key for authentication using Bearer scheme

Path Parameters

id
string<uuid>
required

Query Parameters

companyId
string

Required for ATS API keys to specify which company to access. Ignored for standard company API keys.

Response

Transition applied

status
enum<string>
required

The run's status after the transition

Available options:
DRAFT,
SCHEDULED,
RUNNING,
PAUSED,
COMPLETED,
CANCELLED
Example:

"RUNNING"

affectedCalls
number
required

How many of the run's calls this request moved: queued by a launch, withdrawn by a pause, restored by a resume, closed out by a cancel. Not calls placed - a 2xx means queued, not dialled.

Example:

42