Skip to main content
POST
Cancel the queued outbound backlog for the org, an agent, or a team

Authorizations

x-api-key
string
header
required

Body

application/json
scope
enum<string>
required

The grain to cancel: the whole org, a single agent, or a team.

Available options:
org,
agent,
team
agent_id
string<uuid> | null

Required when scope='agent'. Ignored otherwise.

team_id
string<uuid> | null

Required when scope='team'. Ignored otherwise.

Response

Successful Response

202 Accepted response for the async bulk-cancel contract.

The exhaustive backlog terminalization + RESERVED recall run to completion in a Celery task (bulk_cancel_outbound_dispatches); the HTTP request only accepts the work.

scope
enum<string>
required

The grain that was cancelled.

Available options:
org,
agent,
team
accepted
boolean
default:true

Always true on acceptance.

agent_id
string<uuid> | null

Set when scope='agent'.

team_id
string<uuid> | null

Set when scope='team'.