Skip to navigation

Cancel all controllable batches

View as Markdown

Cancel accepted backlog across every controllable batch (queued, processing, or paused) for your company. Batches with no accepted backlog to cancel are skipped. Optionally scope the operation to one agent.

Authentication

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

Request

This endpoint expects an object.
agentIdstring or nullOptional
Optional agent ID. When provided, only batches for that agent are affected.
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