API Reference
Application API
- Account AgentBots
- Agents
- Canned Responses
- Custom Attributes
- Contacts
- Contact Labels
- Automation Rule
- Help Center
- Conversations
- Conversation Assignments
- Inboxes
- Messages
- Integrations
- Profile
- Teams
- Custom Filters
- Webhooks
- Reports
Platform API
- Accounts
- Account Users
- AgentBots
- Users
Client API
- Contacts API
- Conversations API
- Messages API
Other APIs
- CSAT Survey Page
Users
Create a User
Create a User
POST
/
platform
/
api
/
v1
/
users
curl --request POST \
--url https://app.chatwoot.com/platform/api/v1/users \
--header 'Content-Type: application/json' \
--header 'api_access_token: <api-key>' \
--data '{
"name": "Daniel",
"display_name": "Dan",
"email": "daniel@acme.inc",
"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
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.
Body
application/json
Response
200
application/json
Success
The response is of type object
.
curl --request POST \
--url https://app.chatwoot.com/platform/api/v1/users \
--header 'Content-Type: application/json' \
--header 'api_access_token: <api-key>' \
--data '{
"name": "Daniel",
"display_name": "Dan",
"email": "daniel@acme.inc",
"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": {}
}
]
}
Assistant
Responses are generated using AI and may contain mistakes.