Messages

Update message status

Updates the delivery status of a single message. Available only for messages in API channel inboxes, where your own system is responsible for delivering messages and reporting what happened. Use this to push sent, delivered, and read receipts into Chatwoot, for example, to mark an agent’s message as read when the end user views it in your client, so the agent sees the read indicator on the message.

A message already marked read cannot be moved back to delivered. When reporting a failure, include external_error with the reason, which is shown to the agent along with the failed indicator.

PATCH

api

accounts

{account_id}

conversations

{conversation_id}

messages

{message_id}

Update message status

curl --request PATCH \
  --url https://app.chatwoot.com/api/v1/accounts/{account_id}/conversations/{conversation_id}/messages/{message_id} \
  --header 'Content-Type: application/json' \
  --header 'api_access_token: <api-key>' \
  --data '
{
  "external_error": "<string>"
}
'

import requests

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

payload = { "external_error": "<string>" }
headers = {
    "api_access_token": "<api-key>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'PATCH',
  headers: {api_access_token: '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({external_error: '<string>'})
};

fetch('https://app.chatwoot.com/api/v1/accounts/{account_id}/conversations/{conversation_id}/messages/{message_id}', 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/{message_id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PATCH",
  CURLOPT_POSTFIELDS => json_encode([
    'external_error' => '<string>'
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "api_access_token: <api-key>"
  ],
]);

$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/{message_id}"

	payload := strings.NewReader("{\n  \"external_error\": \"<string>\"\n}")

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

	req.Header.Add("api_access_token", "<api-key>")
	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.patch("https://app.chatwoot.com/api/v1/accounts/{account_id}/conversations/{conversation_id}/messages/{message_id}")
  .header("api_access_token", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"external_error\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

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

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

request = Net::HTTP::Patch.new(url)
request["api_access_token"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"external_error\": \"<string>\"\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>"
    }
  ]
}

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

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

message_id

integer

required

The numeric ID of the message

Body

application/json

status

enum<string>

required

The new status of the message

Available options:

sent,

delivered,

read,

failed

external_error

string

Error description, stored only when status is failed

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

Update message status

curl --request PATCH \
  --url https://app.chatwoot.com/api/v1/accounts/{account_id}/conversations/{conversation_id}/messages/{message_id} \
  --header 'Content-Type: application/json' \
  --header 'api_access_token: <api-key>' \
  --data '
{
  "external_error": "<string>"
}
'

import requests

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

payload = { "external_error": "<string>" }
headers = {
    "api_access_token": "<api-key>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'PATCH',
  headers: {api_access_token: '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({external_error: '<string>'})
};

fetch('https://app.chatwoot.com/api/v1/accounts/{account_id}/conversations/{conversation_id}/messages/{message_id}', 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/{message_id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PATCH",
  CURLOPT_POSTFIELDS => json_encode([
    'external_error' => '<string>'
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "api_access_token: <api-key>"
  ],
]);

$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/{message_id}"

	payload := strings.NewReader("{\n  \"external_error\": \"<string>\"\n}")

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

	req.Header.Add("api_access_token", "<api-key>")
	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.patch("https://app.chatwoot.com/api/v1/accounts/{account_id}/conversations/{conversation_id}/messages/{message_id}")
  .header("api_access_token", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"external_error\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

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

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

request = Net::HTTP::Patch.new(url)
request["api_access_token"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"external_error\": \"<string>\"\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>"
    }
  ]
}

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

Getting Started

Application APIs

Platform APIs

Client APIs

Other APIs

Update message status

Authorizations

Path Parameters

Body

Response