Messages

Create New Message

Create a new message in the conversation.

Use application/json for text messages and multipart/form-data when the message includes file attachments.

Multipart attachment request

Send files with the attachments[] form field. curl -F sets the multipart/form-data content type and boundary automatically.

curl -X POST "https://app.chatwoot.com/api/v1/accounts/{account_id}/conversations/{conversation_id}/messages" \
  -H "Authorization: Bearer <your-api-token>" \
  -F "content=Here is the screenshot" \
  -F "message_type=outgoing" \
  -F "private=false" \
  -F "attachments[]=@/path/to/screenshot.png"

WhatsApp Template Messages

For WhatsApp channels, you can send structured template messages using the template_params field. Templates must be pre-approved in WhatsApp Business Manager.

By default, content is treated as the already-rendered transcript text for compatibility with existing API and mobile clients. To submit the original template body instead, set template_params.content_mode to raw_template; Chatwoot will substitute processed_params.body before saving the transcript.

Example Templates

Text with Image Header:

{
  "content": "Hi your order 121212 is confirmed. Please wait for further updates",
  "template_params": {
    "name": "order_confirmation",
    "category": "MARKETING",
    "language": "en",
    "processed_params": {
      "body": {
        "1": "121212"
      },
      "header": {
        "media_url": "https://picsum.photos/200/300",
        "media_type": "image"
      }
    }
  }
}

Text with Copy Code Button:

{
  "content": "Special offer! Get 30% off your next purchase. Use the code below",
  "template_params": {
    "name": "discount_coupon",
    "category": "MARKETING",
    "language": "en",
    "processed_params": {
      "body": {
        "discount_percentage": "30"
      },
      "buttons": [{
        "type": "copy_code",
        "parameter": "SAVE20"
      }]
    }
  }
}

POST

api

accounts

{account_id}

conversations

{conversation_id}

messages

Create New Message

curl --request POST \
  --url https://app.chatwoot.com/api/v1/accounts/{account_id}/conversations/{conversation_id}/messages \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "content": "Hello, how can I help you?",
  "message_type": "outgoing",
  "private": false,
  "content_type": "text",
  "content_attributes": {
    "items": [
      {
        "title": "Option 1",
        "value": "option_1",
        "description": "Optional WhatsApp list row subtitle"
      }
    ]
  },
  "campaign_id": 1
}
'

import requests

url = "https://app.chatwoot.com/api/v1/accounts/{account_id}/conversations/{conversation_id}/messages"

payload = {
    "content": "Hello, how can I help you?",
    "message_type": "outgoing",
    "private": False,
    "content_type": "text",
    "content_attributes": { "items": [
            {
                "title": "Option 1",
                "value": "option_1",
                "description": "Optional WhatsApp list row subtitle"
            }
        ] },
    "campaign_id": 1
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    content: 'Hello, how can I help you?',
    message_type: 'outgoing',
    private: false,
    content_type: 'text',
    content_attributes: {
      items: [
        {
          title: 'Option 1',
          value: 'option_1',
          description: 'Optional WhatsApp list row subtitle'
        }
      ]
    },
    campaign_id: 1
  })
};

fetch('https://app.chatwoot.com/api/v1/accounts/{account_id}/conversations/{conversation_id}/messages', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://app.chatwoot.com/api/v1/accounts/{account_id}/conversations/{conversation_id}/messages",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'content' => 'Hello, how can I help you?',
    'message_type' => 'outgoing',
    'private' => false,
    'content_type' => 'text',
    'content_attributes' => [
        'items' => [
                [
                                'title' => 'Option 1',
                                'value' => 'option_1',
                                'description' => 'Optional WhatsApp list row subtitle'
                ]
        ]
    ],
    'campaign_id' => 1
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://app.chatwoot.com/api/v1/accounts/{account_id}/conversations/{conversation_id}/messages"

	payload := strings.NewReader("{\n  \"content\": \"Hello, how can I help you?\",\n  \"message_type\": \"outgoing\",\n  \"private\": false,\n  \"content_type\": \"text\",\n  \"content_attributes\": {\n    \"items\": [\n      {\n        \"title\": \"Option 1\",\n        \"value\": \"option_1\",\n        \"description\": \"Optional WhatsApp list row subtitle\"\n      }\n    ]\n  },\n  \"campaign_id\": 1\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://app.chatwoot.com/api/v1/accounts/{account_id}/conversations/{conversation_id}/messages")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"content\": \"Hello, how can I help you?\",\n  \"message_type\": \"outgoing\",\n  \"private\": false,\n  \"content_type\": \"text\",\n  \"content_attributes\": {\n    \"items\": [\n      {\n        \"title\": \"Option 1\",\n        \"value\": \"option_1\",\n        \"description\": \"Optional WhatsApp list row subtitle\"\n      }\n    ]\n  },\n  \"campaign_id\": 1\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://app.chatwoot.com/api/v1/accounts/{account_id}/conversations/{conversation_id}/messages")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"content\": \"Hello, how can I help you?\",\n  \"message_type\": \"outgoing\",\n  \"private\": false,\n  \"content_type\": \"text\",\n  \"content_attributes\": {\n    \"items\": [\n      {\n        \"title\": \"Option 1\",\n        \"value\": \"option_1\",\n        \"description\": \"Optional WhatsApp list row subtitle\"\n      }\n    ]\n  },\n  \"campaign_id\": 1\n}"

response = http.request(request)
puts response.read_body

{
  "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": {}
}

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

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

Authorizations

Authorization

string

header

required

Authenticate with Authorization: Bearer <token> using a user API token from Profile Settings. Available in Chatwoot v4.19.0 and later.

Path Parameters

account_id

integer

required

The numeric ID of the account

conversation_id

integer

required

The numeric ID of the conversation

Body

content

string

required

The content of the message

Example:

"Hello, how can I help you?"

message_type

enum<string>

The type of the message

Available options:

outgoing,

incoming

Example:

"outgoing"

private

boolean

Flag to identify if it is a private note

Example:

false

content_type

enum<string>

Content type of the message

Available options:

text,

input_email,

cards,

input_select,

form,

article

Example:

"text"

content_attributes

object

Attributes based on the content type. For input_select, provide an items array with title, value, and optional description. WhatsApp list messages use description as the row subtitle when present.

Example:

{
  "items": [
    {
      "title": "Option 1",
      "value": "option_1",
      "description": "Optional WhatsApp list row subtitle"
    }
  ]
}

campaign_id

integer

The campaign id to which the message belongs

Example:

1

template_params

object

WhatsApp template parameters for sending structured messages

Show child attributes

Response

Success

number

The ID of the message

content

string

The text content of the message

account_id

number

The ID of the account

inbox_id

number

The ID of the inbox

conversation_id

number

The ID of the conversation

message_type

enum<integer>

The type of the message

Available options:

0,

1,

2,

3

created_at

integer

The time at which message was created

updated_at

The time at which message was updated

private

boolean

The flags which shows whether the message is private or not

status

enum<string> | null

The status of the message

Available options:

sent,

delivered,

read,

failed,

null

source_id

string | null

The source ID of the message

content_type

enum<string> | null

The type of the template message

Available options:

text,

input_text,

input_textarea,

input_email,

input_select,

cards,

form,

article,

incoming_email,

input_csat,

integrations,

sticker,

voice_call,

null

content_attributes

object

The content attributes for each content_type

sender_type

enum<string> | null

The type of the sender

Available options:

Contact,

User,

AgentBot,

Captain::Assistant,

null

sender_id

number | null

The ID of the sender

external_source_ids

object

The external source IDs of the message

additional_attributes

object

The additional attributes of the message

processed_message_content

string | null

The processed message content

sentiment

object | null

The sentiment of the message

conversation

object | null

The conversation object

attachment

object | null

The file object attached to the image

sender

object

User/Agent/AgentBot object

Create New Message

curl --request POST \
  --url https://app.chatwoot.com/api/v1/accounts/{account_id}/conversations/{conversation_id}/messages \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "content": "Hello, how can I help you?",
  "message_type": "outgoing",
  "private": false,
  "content_type": "text",
  "content_attributes": {
    "items": [
      {
        "title": "Option 1",
        "value": "option_1",
        "description": "Optional WhatsApp list row subtitle"
      }
    ]
  },
  "campaign_id": 1
}
'

import requests

url = "https://app.chatwoot.com/api/v1/accounts/{account_id}/conversations/{conversation_id}/messages"

payload = {
    "content": "Hello, how can I help you?",
    "message_type": "outgoing",
    "private": False,
    "content_type": "text",
    "content_attributes": { "items": [
            {
                "title": "Option 1",
                "value": "option_1",
                "description": "Optional WhatsApp list row subtitle"
            }
        ] },
    "campaign_id": 1
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    content: 'Hello, how can I help you?',
    message_type: 'outgoing',
    private: false,
    content_type: 'text',
    content_attributes: {
      items: [
        {
          title: 'Option 1',
          value: 'option_1',
          description: 'Optional WhatsApp list row subtitle'
        }
      ]
    },
    campaign_id: 1
  })
};

fetch('https://app.chatwoot.com/api/v1/accounts/{account_id}/conversations/{conversation_id}/messages', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://app.chatwoot.com/api/v1/accounts/{account_id}/conversations/{conversation_id}/messages",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'content' => 'Hello, how can I help you?',
    'message_type' => 'outgoing',
    'private' => false,
    'content_type' => 'text',
    'content_attributes' => [
        'items' => [
                [
                                'title' => 'Option 1',
                                'value' => 'option_1',
                                'description' => 'Optional WhatsApp list row subtitle'
                ]
        ]
    ],
    'campaign_id' => 1
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://app.chatwoot.com/api/v1/accounts/{account_id}/conversations/{conversation_id}/messages"

	payload := strings.NewReader("{\n  \"content\": \"Hello, how can I help you?\",\n  \"message_type\": \"outgoing\",\n  \"private\": false,\n  \"content_type\": \"text\",\n  \"content_attributes\": {\n    \"items\": [\n      {\n        \"title\": \"Option 1\",\n        \"value\": \"option_1\",\n        \"description\": \"Optional WhatsApp list row subtitle\"\n      }\n    ]\n  },\n  \"campaign_id\": 1\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://app.chatwoot.com/api/v1/accounts/{account_id}/conversations/{conversation_id}/messages")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"content\": \"Hello, how can I help you?\",\n  \"message_type\": \"outgoing\",\n  \"private\": false,\n  \"content_type\": \"text\",\n  \"content_attributes\": {\n    \"items\": [\n      {\n        \"title\": \"Option 1\",\n        \"value\": \"option_1\",\n        \"description\": \"Optional WhatsApp list row subtitle\"\n      }\n    ]\n  },\n  \"campaign_id\": 1\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://app.chatwoot.com/api/v1/accounts/{account_id}/conversations/{conversation_id}/messages")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"content\": \"Hello, how can I help you?\",\n  \"message_type\": \"outgoing\",\n  \"private\": false,\n  \"content_type\": \"text\",\n  \"content_attributes\": {\n    \"items\": [\n      {\n        \"title\": \"Option 1\",\n        \"value\": \"option_1\",\n        \"description\": \"Optional WhatsApp list row subtitle\"\n      }\n    ]\n  },\n  \"campaign_id\": 1\n}"

response = http.request(request)
puts response.read_body

{
  "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": {}
}

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

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

Getting Started

Application APIs

Platform APIs

Client APIs

Other APIs

Create New Message

Multipart attachment request

WhatsApp Template Messages

Example Templates

Authorizations

Path Parameters

Body

Response