Deactivate an agent
DELETE/agents/:agent_id
Deactivate an agent.
They can no longer sign in and stop receiving assignments, but their name and history stay intact — a message has to keep showing who sent it. The seat is released at the next billing cycle.
Any SSO permission naming this agent is removed at the same time, which invalidates every SSO link already issued for them.
Request
Responses
- 200
- 400
- 401
- 403
- 404
Agent deactivated.
The request was malformed, or a parameter was rejected.
Response Headers
Correlation id for this request. Quote it when reporting a problem.
No token, an expired token, or a credential that has been revoked.
Response Headers
Correlation id for this request. Quote it when reporting a problem.
Refused. Either the credential does not hold the scope this endpoint needs (code: insufficient_scope), or the account's IP allow-list does not include the calling address (code: ip_not_allowed).
Response Headers
Correlation id for this request. Quote it when reporting a problem.
No such resource in this account.
Response Headers
Correlation id for this request. Quote it when reporting a problem.