Skip to navigation

Cancel a batch

View as Markdown
Cancel accepted leads that have not yet been dialed. The batch is marked cancelled even when no accepted backlog remains. Calls already accepted by core may still complete and remain traceable.

Authentication

X-Company-API-Keystring
Company API key issued by SimZ.

Path parameters

batchIdstringRequired
Batch identifier returned by lead submission.

Request

This endpoint expects an object.
reasonstring or nullOptional

Optional client-defined cancellation reason stored on cancelled entries. Defaults to cancelled_by_client when omitted.

Response

OK
successbooleanOptional
messagestringOptional
dataobjectOptional

Errors

401
Unauthorized Error
403
Forbidden Error
404
Not Found Error
409
Conflict Error