Texa Desk Application API · Messages

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 Texa Desk, 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

api_access_tokenheaderrequired

A person's access token (Texa Desk, Profile settings → Access token) or an agent bot's token, in the api_access_token header. It acts as that person, with their role's permissions.

Path parameters

account_idintegerrequired

The numeric ID of the account

conversation_idintegerrequired

The numeric ID of the conversation

message_idintegerrequired

The numeric ID of the message

Body application/json

statusstringrequired

The new status of the message One of: sent, delivered, read, failed.

external_errorstring

Error description, stored only when status is failed

Responses

200

Success

idnumber

The ID of the message

contentstring

The text content of the message

account_idnumber

The ID of the account

inbox_idnumber

The ID of the inbox

conversation_idnumber

The ID of the conversation

message_typeinteger

The type of the message One of: 0, 1, 2, 3.

created_atinteger

The time at which message was created

updated_atinteger or string

The time at which message was updated

privateboolean

The flags which shows whether the message is private or not

statusstring

The status of the message One of: sent, delivered, read, failed.

source_idstring

The source ID of the message

content_typestring

The type of the template message One of: text, input_text, input_textarea, input_email, input_select, cards, form, article, incoming_email, input_csat, integrations, sticker, voice_call.

content_attributesobject

The content attributes for each content_type

sender_typestring

The type of the sender One of: Contact, User, AgentBot.

sender_idnumber

The ID of the sender

external_source_idsobject

The external source IDs of the message

additional_attributesobject

The additional attributes of the message

processed_message_contentstring

The processed message content

sentimentobject

The sentiment of the message

conversationobject

The conversation object

attachmentobject

The file object attached to the image

senderobject

User/Agent/AgentBot object

401

Unauthorized

descriptionstring

errorsarray of object

errors[].fieldstring

errors[].messagestring

errors[].codestring

403

The message does not belong to an API channel inbox

descriptionstring

errorsarray of object

errors[].fieldstring

errors[].messagestring

errors[].codestring

404

The message or conversation does not exist in the account

descriptionstring

errorsarray of object

errors[].fieldstring

errors[].messagestring

errors[].codestring

curl -X PATCH 'https://desk.texadesk.com/api/v1/accounts/1/conversations/1/messages/1' \ -H "api_access_token: $TEXA_DESK_TOKEN" \ -H "Content-Type: application/json" \ -d '{ "status": "sent" }'

import os, requests headers = {"api_access_token": os.environ["TEXA_DESK_TOKEN"]} body = { "status": "sent" } r = requests.patch("https://desk.texadesk.com/api/v1/accounts/1/conversations/1/messages/1", headers=headers, json=body) r.raise_for_status() print(r.json())

{ "id": 1.0, "content": "string", "account_id": 1.0, "inbox_id": 1.0, "conversation_id": 1.0, "message_type": 0, "created_at": 1, "updated_at": 1, "private": true, "status": "sent", "source_id": "string", "content_type": "text", "content_attributes": {}, "sender_type": "Contact", "sender_id": 1.0, "external_source_ids": {}, "additional_attributes": {}, "processed_message_content": "string", "sentiment": {}, "conversation": {}, "attachment": {}, "sender": {} }