Reply in a conversation

Adds a message or a private note to a conversation. This endpoint does not check the service window. For a reply to the customer, POST /accounts/{account_id}/developer/messages with conversation_id is better, because it checks the window first. The name of the key is the sender of the message. A request cannot set another sender.

Authentication

api_access_tokenstring

An API key that an administrator creates in Settings > Developer. The personal access token of a user does not work. A key reaches every inbox, conversation, and contact in the account that created it, and nothing in other accounts.

Path parameters

account_idintegerRequired

The id of your account. It is the number after /accounts/ in the dashboard URL.

conversation_idintegerRequired

The conversation number in the dashboard URL (display_id). It is not the internal id of the conversation.

Request

This endpoint expects an object.

contentstringOptional

The text of the message.

privatebooleanOptionalDefaults to false

When true, the message is a private note. Agents see it, and the customer does not get it.

template_paramsobjectOptional

Sends an approved WhatsApp template instead of free text. A template is necessary to start a conversation on WhatsApp, or to send after the 24-hour service window closes. When this field is present, the API does not check the service window on any channel. Send it only on an inbox that has approved templates.

Response

The message.

idintegerOptional

contentstring or nullOptional

inbox_idintegerOptional

conversation_idintegerOptional

The conversation number in the dashboard URL (display_id).

message_typeintegerOptional

0 for incoming, 1 for outgoing, 2 for activity, 3 for template.

content_typestringOptional

statusstringOptional

content_attributesmap from strings to anyOptional

created_atintegerOptional

Unix timestamp, in seconds.

privatebooleanOptional

source_idstring or nullOptional

sendermap from strings to anyOptional

The sender. For a message that a key sends, type is api_key and name is the name of the key.

Errors

401

Unauthorized Error

404

Not Found Error

422

Unprocessable Entity Error