Deactivates an agent and returns the updated agent.

When to use it

Use it to take an agent out of service without archiving or deleting it, and reverse it with Activate an agent. A second endpoint, Unpublish an agent, carries the same Deactivate Agent summary.

Required parameters

• agent_id (path): the ID of the agent.

Response

A successful call returns 200 OK with the updated Agent object, including its status and url.

Related: Activate an agent, Unpublish an agent, Run a bulk action on agents