Agents
Archive or unarchive an agent
Soft-archives the agent — it is excluded from listings and stops accepting calls, but all data is preserved and the operation is fully reversible.
Pass ?on=false to unarchive (restore) a previously archived agent.
409 is returned when:
- The agent is already in the requested state ("Agent is already archived" / "Agent is already active")
- The agent is linked to an active campaign ("Agent is associated with the [status] campaign "[name]". Complete or remove the campaign before archiving.")
delete/agent/{id}/archive
Path parameters
idstring required
Query parameters
onboolean
true (default) — archive the agent. false — unarchive (restore) a previously archived agent.
Response
Agent archived or unarchived successfully
Example response
{
"status": true
}