Skip to navigation

Cancel a batch call

Permanently stops the batch. Recipients that have not been dialed are marked canceled and will never be called. Calls already in progress are not hung up. A canceled batch cannot be resumed and cannot take new recipients.

Authentication

AuthorizationBearer

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

Path parameters

batch_call_idstringRequired

The batch returned by POST /calls/batch, a UUID.

Response

200
statusstringOptional
responseobjectOptional

Errors

401
Unauthorized Error
404
Not Found Error