Skip to main content
PATCH
Update Agent in Account

Authorizations

Authorization
string
header
required

Authenticate with Authorization: Bearer <token> using a user API token from Profile Settings. Available in Chatwoot v4.19.0 and later.

Path Parameters

id
integer
required

The ID of the agent to be updated.

account_id
integer
required

The numeric ID of the account

Body

application/json
role
enum<string>
required

Whether its administrator or agent

Available options:
agent,
administrator
Example:

"agent"

availability
enum<string>

The configured availability of the agent.

Available options:
online,
busy,
offline
Example:

"online"

auto_offline
boolean

Whether the agent is automatically marked offline when they are away.

Example:

true

Response

Success

id
integer
account_id
integer
availability_status
enum<string>
read-only

The effective availability status of the agent, derived from the configured availability, auto-offline setting, and current presence. To update an agent's configured availability, use the availability field in create or update requests.

Available options:
online,
busy,
offline
auto_offline
boolean

Whether the agent is automatically marked offline when they are away.

confirmed
boolean

Whether the agent has confirmed their email address.

email
string

The email of the agent

available_name
string

The available name of the agent

name
string

The name of the agent

role
enum<string>

The role of the agent

Available options:
agent,
administrator
thumbnail
string

The thumbnail of the agent

custom_role_id
integer | null

The custom role id of the agent