Skip to main content
POST
Deactivate an agent

Headers

Authorization
string
required

Bearer [access_token]

Content-Type
string
required

application/json

Path Parameters

agentId
integer<int64>
required

User ID of the agent to deactivate.

Required range: x >= 1

Response

Always returned once authentication passes, whether the call succeeded or not. On success the body is {"success":true}. On failure the body is {"code":,"message":<description>} instead - the HTTP status stays 200, so check code (absent/0 means success) rather than the status to detect errors. Failure codes: invalid agent id (20012), agent already deactivated (990105), agent has not completed onboarding / no password set (990113), agent is office or team owner (990106), deactivating own account (990107), or not authorized (1900012).

Common API response wrapper

code
integer<int32>

Response code, 0 means success

Example:

0

message
string

Response message

Example:

"success"

data
object

Response data payload