Skip to main content
POST
/
api
/
v1
/
accounts
/
{account_id}
/
conversations
/
{conversation_id}
/
assignments
Assign Conversation
curl --request POST \
  --url https://app.chatwoot.com/api/v1/accounts/{account_id}/conversations/{conversation_id}/assignments \
  --header 'Content-Type: application/json' \
  --header 'api_access_token: <api-key>' \
  --data '{
  "assignee_id": 1,
  "team_id": 1
}'
{
  "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 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

​
account_id
integer
required

The numeric ID of the account

​
conversation_id
integer
required

The numeric ID of the conversation

Body

application/json
​
assignee_id
number

Id of the assignee user

Example:

1

​
team_id
number

Id of the team. If the assignee_id is present, this param would be ignored

Example:

1

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[]
⌘I