Create New Conversation

Creating a conversation in chatwoot requires a source id.

Learn more about source_id: https://www.chatwoot.com/hc/user-guide/articles/1677839703-how-to-create-an-api-channel-inbox#send-messages-to-the-api-channel

Authorization

api_access_token<token>

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.

In: header

Path Parameters

account_id*integer

The numeric ID of the account

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

source_id*string

Conversation source id

inbox_id?integer

Id of inbox in which the conversation is created Allowed Inbox Types: Website, Phone, Api, Email

contact_id?integer

Contact Id for which conversation is created

additional_attributes?

Lets you specify attributes like browser information

custom_attributes?

The object to save custom attributes for conversation, accepts custom attributes key and value

status?string

Specify the conversation whether it's pending, open, closed

assignee_id?integer

Agent Id for assigning a conversation to an agent

team_id?integer

Team Id for assigning a conversation to a team\

snoozed_until?string

Snoozed until date time

message?

The initial message to be sent to the conversation

Response Body

`application/json`

curl -X POST "https://example.com/api/v1/accounts/0/conversations" \  -H "Content-Type: application/json" \  -d '{    "source_id": "1234567890"  }'

{
  "id": 0,
  "account_id": 0,
  "inbox_id": 0
}

{
  "description": "string",
  "errors": [
    {
      "field": "string",
      "message": "string",
      "code": "string"
    }
  ]
}

Authorization

Path Parameters

Request Body

Response Body

200application/json

403application/json

`application/json`

`application/json`