Skip to main content
PATCH
Changes state - verify before retry Update Batch Call Status changes the execution state of a batch call. Use it when you need to temporarily stop new outbound calls, continue a paused batch, or permanently cancel queued work. A batch can be paused while it is running or waiting, resumed while it is paused, and cancelled from any state except completed or cancelled, including while it is running.

​
When To Use Update Batch Call Status

  • Use pause when a running or waiting batch should stop creating new calls, but calls already in progress can finish.
  • Use resume when a paused batch should continue calling remaining leads.
  • Use cancel when a batch should stop permanently and queued calls should be removed. It works from any state except completed or cancelled; a running batch does not need to be paused first.

​
Status Actions

​
Verify The Result

The current API-key success response is an empty object. After HTTP 200, use List Batch Calls to check the batch status and List Calls with batch_call_id to inspect dispatch activity. If the listed batch is waiting, it is accepted and awaiting scheduler preparation. Other batches can run concurrently. See Batch Call Retries And Statuses for the full status diagram.

​
Common Errors

  • 400 Bad Request means the action is invalid or the current batch status does not allow that transition.
  • 404 Not Found means the batch call ID was not found in this workspace. A batch that belongs to another workspace is reported the same way.

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

​
id
string
required

Batch call ID

Example:

"batch_abc123"

Body

application/json
​
action
enum<string>
required

pause stops new outbound calls and keeps the batch resumable; resume re-enqueues the remaining leads; cancel removes queued calls and cannot be resumed. cancel works from any state except completed or cancelled, including running.

Available options:
pause,
resume,
cancel
Example:

"pause"

Response

Batch call status updated successfully.

The response is of type object.