Skip to main content
PATCH
/
api
/
v1
/
accounts
/
{account_id}
/
agents
/
{id}
Update Agent in Account
curl --request PATCH \
  --url https://app.chatwoot.com/api/v1/accounts/{account_id}/agents/{id} \
  --header 'Content-Type: application/json' \
  --header 'api_access_token: <api-key>' \
  --data '
{
  "role": "agent",
  "availability": "online",
  "auto_offline": true
}
'
{
  "id": 123,
  "account_id": 123,
  "auto_offline": true,
  "confirmed": true,
  "email": "<string>",
  "available_name": "<string>",
  "name": "<string>",
  "thumbnail": "<string>",
  "custom_role_id": 123
}

Authorizations

​
api_access_token
string
header
required

This token can be obtained by visiting the profile page or via rails console. Provides access to endpoints based on the user permissions levels. This token can be saved by an external system when user is created via API, to perform activities on behalf of the user.

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