Delete agent
Remove an agent together with its campaign and its bindings in every project. The agent stops dialling immediately, and this cannot be undone through the API. Its voice is not released at the speech provider, so a voice added to your library still holds its slot.
Required API key scope: agents:write.
Authorizations
Send your API key as Authorization: Bearer YOUR_API_KEY.
Path Parameters
Agent id.
1Query Parameters
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.
agent_and_campaign Response
Agent removed.
True when the agent's campaign was removed with it.
true
True when the agent itself was removed.
true
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.
x >= 01
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.
^\+\d{10,15}$