Create a conversation

Create a conversation

POST /public/api/v1/inboxes/{inbox_identifier}/contacts/{contact_identifier}/conversations

Try it

Create a conversation

cURL

curl --request POST \
  --url https://app.chatwoot.com/public/api/v1/inboxes/{inbox_identifier}/contacts/{contact_identifier}/conversations \
  --header 'Content-Type: application/json' \
  --data '
{
  "custom_attributes": {}
}
'

200

{
  "id": 123,
  "inbox_id": "<string>",
  "messages": [
    {
      "id": 123,
      "content": "<string>",
      "account_id": 123,
      "inbox_id": 123,
      "conversation_id": 123,
      "message_type": 0,
      "created_at": 123,
      "updated_at": 123,
      "private": true,
      "status": "sent",
      "source_id": "<string>",
      "content_type": "text",
      "content_attributes": {},
      "sender_type": "contact",
      "sender_id": 123,
      "external_source_ids": {},
      "additional_attributes": {},
      "processed_message_content": "<string>",
      "sentiment": {},
      "conversation": {},
      "attachment": {},
      "sender": {}
    }
  ],
  "contact": {}
}

Path Parameters

inbox_identifier · string · required

The identifier obtained from API inbox channel

contact_identifier · string · required

The source id of contact obtained on contact create

Body

application/json

custom_attributes · object

Custom attributes of the conversation

Example:

{}

Response

200

application/json

Success

id · integer

Id of the conversation

inbox_id · string

The inbox id of the conversation

messages · object[]

Messages in the conversation

Show child attributes

messages. id · number

The ID of the message

messages. content · string

The text content of the message

messages. account_id · number

The ID of the account

messages. inbox_id · number

The ID of the inbox

messages. conversation_id · number

The ID of the conversation

messages. message_type · enum<integer>

The type of the message

Available options: 0, 1, 2

messages. created_at · integer

The time at which message was created

messages. updated_at · integer

The time at which message was updated

messages. private · boolean

The flags which shows whether the message is private or not

messages. status · enum<string>

The status of the message

Available options: sent, delivered, read, failed

messages. source_id · string

The source ID of the message

messages. content_type · enum<string>

The type of the template message

Available options: text, input_select, cards, form

messages. content_attributes · object

The content attributes for each content_type

messages. sender_type · enum<string>

The type of the sender

Available options: contact, agent, agent_bot

messages. sender_id · number

The ID of the sender

messages. external_source_ids · object

The external source IDs of the message

messages. additional_attributes · object

The additional attributes of the message

messages. processed_message_content · string

The processed message content

messages. sentiment · object

The sentiment of the message

messages. conversation · object

The conversation object

messages. attachment · object

The file object attached to the image

messages. sender · object

User/Agent/AgentBot object

contact · object

The contact information associated to the conversation