Skip to navigation

Pause all dispatchable batches

View as Markdown

Pause every dispatchable batch (queued or processing) for your company that still has accepted backlog. Already-paused batches 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.

Response

OK
successbooleanOptional
messagestringOptional
dataobjectOptional

Errors

401
Unauthorized Error