Batches
Stop Active Batch
Batches
Stop Active Batch
Stops all active calls in a batch.
POST
/
v1
/
batches
/
{batch_id}
/
stop
Headers
authorization
string
requiredYour API key for authentication.
Path Parameters
batch_id
string
requiredThe unique identifier for the batch to be cancelled.
Response
status
string
The status of the request. If anything other than ‘success’, an error has occurred or all calls have already been completed.
message
string
A message describing the status of the request.
num_calls
number
The number of calls that were cancelled.
batch_id
array
The batch_id of the cancelled batch.