Cancel a batch
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
batchId
Batch identifier returned by lead submission.
Request
This endpoint expects an object.
reason
Optional client-defined cancellation reason stored on cancelled entries. Defaults to cancelled_by_client when omitted.
Response
OK
success
message
data
Errors
401
Unauthorized Error
403
Forbidden Error
404
Not Found Error
409
Conflict Error
