Predefined messages

Predefined messages are the organization's canned replies (text or media) that agents insert from the conversation composer.

Endpoints

MethodPathDescription
GET/conversation-predefined-messagesList predefined messages
GET/conversation-predefined-messages/:idGet a predefined message
POST/conversation-predefined-messagesCreate a predefined message
PATCH/conversation-predefined-messages/:idUpdate a predefined message
DELETE/conversation-predefined-messages/:idDelete a predefined message

The predefined message object

json

Fields

FieldTypeDescription
idintegerRead-only. Unique ID.
organization_idintegerOrganization. Required on create; cannot be changed.
titlestringShort label shown in the picker. Required.
contentstringText of the reply (caption for media). Required.
message_typestringOne of text, image, video, document, audio, location. Default text.
media_urlstring | nullMedia of the reply: the storage key from an upload URL of type conversation-predefined-message, or a full URL.
filenamestring | nullFile name of the media.
mime_typestring | nullMIME type of the media.
created_by_user_idintegerRead-only. Author: always the API key's user on create.
created_by_userobject | nullRead-only. Author's id, email, first_name, last_name, avatar_url. Added to every response.
created_atstring (date-time)Read-only.
updated_atstring (date-time)Read-only.
deleted_atstring (date-time) | nullRead-only. Set when deleted.

Only the author or an owner/admin of the organization can update or delete a predefined message.

Report an issue with this documentation

Please log in to report issues with our documentation.