voice

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

post/v1/voice/outbound/cancel

Request

The document declares no server URL.
Auth
API key in header x-api-key
TypeScript
https://skmtc.dev/oneloop-hq/apis/feather-api/docs/v1/voice/outbound/cancel/post.ts
A function with typed inputs. Its response is checked against the schema.

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.

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'.