PATCH
/
platform
/
api
/
v1
/
users
/
{id}
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": "<string>",
  "email": "<string>",
  "password": "<string>",
  "custom_attributes": {}
}'
{
  "id": 123,
  "uid": "<string>",
  "name": "<string>",
  "available_name": "<string>",
  "display_name": "<string>",
  "email": "<string>",
  "account_id": 123,
  "role": "agent",
  "confirmed": true,
  "custom_attributes": {},
  "accounts": [
    {
      "id": 123,
      "name": "<string>",
      "role": "administrator"
    }
  ]
}

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

Response

200
application/json
Success

The response is of type object.