Skip to main content
POST
/
platform
/
api
/
v1
/
accounts
/
{account_id}
/
account_users
Create an Account User
curl --request POST \
  --url https://app.chatwoot.com/platform/api/v1/accounts/{account_id}/account_users \
  --header 'Content-Type: application/json' \
  --header 'api_access_token: <api-key>' \
  --data '
{
  "user_id": 1,
  "role": "administrator"
}
'
{
  "account_id": 123,
  "user_id": 123,
  "role": "<string>"
}

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

​
account_id
integer
required

The numeric ID of the account

Body

application/json
​
user_id
integer
required

The ID of the user

Example:

1

​
role
string
required

whether user is an administrator or agent

Example:

"administrator"

Response

Success

​
account_id
integer

The ID of the account

​
user_id
integer

The ID of the user

​
role
string

whether user is an administrator or agent