Skip to main content
DELETE
cURL

Authorizations

Authorization
string
header
required

Send your API key as Authorization: Bearer YOUR_API_KEY.

Path Parameters

id
string
required

Agent id.

Minimum string length: 1

Query Parameters

cascade
enum<string>
required

Required for public API deletes. Removes the agent together with its campaign, that campaign's workflow, and its bindings in every project. The agent stops dialling immediately and is no longer returned by any read. Its voice is not released at the speech provider, so a voice added to your library still holds its slot.

Available options:
agent_and_campaign

Response

Agent removed.

success
boolean
required
deleted
boolean
required
deletedCampaign
boolean

True when the agent's campaign was removed with it.

Example:

true

deletedAgent
boolean

True when the agent itself was removed.

Example:

true

deletedCampaigns
integer

How many campaign and project-binding records were removed with the agent. A master agent bound into several projects counts one per binding, so this can be higher than the number of campaigns you know about.

Required range: x >= 0
Example:

1

answerInboundUnconfirmed
string[]

Sent only when some are: TFU Live numbers whose incoming calls did not confirm they follow the next campaign that answers them. The delete stands, and the platform keeps trying. Check those numbers in Phone Numbers.

Pattern: ^\+\d{10,15}$
Example: