Sign in
voice

Cancel the queued outbound backlog for the org, an agent, or a team

post/v1/voice/outbound/cancel

Request body

scope'org' | 'agent' | 'team' required

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

agent_idstring uuid nullable

Required when scope='agent'. Ignored otherwise.

team_idstring uuid nullable

Required when scope='team'. Ignored otherwise.

Response

Successful Response

acceptedboolean

Always true on acceptance.

scope'org' | 'agent' | 'team' required

The grain that was cancelled.

agent_idstring uuid nullable

Set when scope='agent'.

team_idstring uuid nullable

Set when scope='team'.

Changes

Changed in 1 of the 3 revisions of this API.1