Skip to Content
inclamoDocs

Update message status

PATCH
/api/v1/accounts/{account_id}/conversations/{conversation_id}/messages/{message_id}

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.

Authorization

headerAuthorizationBearer <token>

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

The numeric ID of the account

conversation_id*integer

The numeric ID of the conversation

message_id*integer

The numeric ID of the message

Request Body

application/json
  1. body
status*string

The new status of the message

Value in"sent""delivered""read""failed"
external_error?string

Error description, stored only when status is failed

Response Body

Success

application/json
  1. response
id?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?integer

The type of the message

Value in0123
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?|

The status of the message

Value in"sent""delivered""read""failed"null
source_id?|

The source ID of the message

content_type?|

The type of the template message

Value in"text""input_text""input_textarea""input_email""input_select""cards""form""article""incoming_email""input_csat""integrations""sticker""voice_call"null
content_attributes?

The content attributes for each content_type

sender_type?|

The type of the sender

Value in"Contact""User""AgentBot""Captain::Assistant"null
sender_id?|

The ID of the sender

external_source_ids?

The external source IDs of the message

additional_attributes?

The additional attributes of the message

processed_message_content?|

The processed message content

sentiment?|

The sentiment of the message

conversation?|

The conversation object

attachment?|

The file object attached to the image

sender?

User/Agent/AgentBot object

Example Request
curl -X PATCH 'https://helpdesk.inclamo.com/api/v1/accounts/0/conversations/0/messages/0' \  -H 'Content-Type: application/json' \  -d '{  "status": "sent"}'
Example Response
{  "id": 0,  "content": "string",  "account_id": 0,  "inbox_id": 0,  "conversation_id": 0,  "message_type": 0,  "created_at": 0,  "updated_at": 0,  "private": true,  "status": "sent",  "source_id": "string",  "content_type": "text",  "content_attributes": {},  "sender_type": "Contact",  "sender_id": 0,  "external_source_ids": {},  "additional_attributes": {},  "processed_message_content": "string",  "sentiment": {},  "conversation": {},  "attachment": {},  "sender": {}}