Skip to main content
PATCH
/
platform
/
api
/
v1
/
users
/
{id}
Update a user
curl --request PATCH \
  --url https://app.chatwoot.com/platform/api/v1/users/{id} \
  --header 'Content-Type: application/json' \
  --header 'api_access_token: <api-key>' \
  --data '
{
  "name": "Daniel",
  "display_name": "Dan",
  "email": "[email protected]",
  "password": "Password2!",
  "custom_attributes": {}
}
'
{
  "id": 123,
  "access_token": "<string>",
  "account_id": 123,
  "available_name": "<string>",
  "avatar_url": "<string>",
  "confirmed": true,
  "display_name": "<string>",
  "message_signature": "<string>",
  "email": "<string>",
  "hmac_identifier": "<string>",
  "inviter_id": 123,
  "name": "<string>",
  "provider": "<string>",
  "pubsub_token": "<string>",
  "role": "agent",
  "ui_settings": {},
  "uid": "<string>",
  "type": "<string>",
  "custom_attributes": {},
  "accounts": [
    {
      "id": 123,
      "name": "<string>",
      "status": "<string>",
      "active_at": "2023-11-07T05:31:56Z",
      "role": "administrator",
      "permissions": [
        "<string>"
      ],
      "availability": "<string>",
      "availability_status": "<string>",
      "auto_offline": true,
      "custom_role_id": 123,
      "custom_role": {}
    }
  ]
}

Authorizations

​
api_access_token
string
header
required

This token can be obtained by the system admin after creating a platformApp. This token should be used to provision agent bots, accounts, users and their roles.

Path Parameters

​
id
integer
required

The numeric ID of the user on the platform

Body

application/json
​
name
string

Name of the user

Example:

"Daniel"

​
display_name
string

Display name of the user

Example:

"Dan"

​
email
string

Email of the user

Example:

"[email protected]"

​
password
string

Password must contain uppercase, lowercase letters, number and a special character

Example:

"Password2!"

​
custom_attributes
object

Custom attributes you want to associate with the user

Example:
{}

Response

Success

​
id
number
​
access_token
string
​
account_id
number
​
available_name
string
​
avatar_url
string
​
confirmed
boolean
​
display_name
string | null
​
message_signature
string | null
​
email
string
​
hmac_identifier
string
​
inviter_id
number
​
name
string
​
provider
string
​
pubsub_token
string
​
role
enum<string>
Available options:
agent,
administrator
​
ui_settings
object
​
uid
string
​
type
string | null
​
custom_attributes
object

Available for users who are created through platform APIs and has custom attributes associated.

​
accounts
object[]