Predefined messages
Predefined messages are the organization's canned replies (text or media) that agents insert from the conversation composer.
Endpoints
| Method | Path | Description |
|---|---|---|
GET | /conversation-predefined-messages | List predefined messages |
GET | /conversation-predefined-messages/:id | Get a predefined message |
POST | /conversation-predefined-messages | Create a predefined message |
PATCH | /conversation-predefined-messages/:id | Update a predefined message |
DELETE | /conversation-predefined-messages/:id | Delete a predefined message |
The predefined message object
json
Fields
| Field | Type | Description |
|---|---|---|
id | integer | Read-only. Unique ID. |
organization_id | integer | Organization. Required on create; cannot be changed. |
title | string | Short label shown in the picker. Required. |
content | string | Text of the reply (caption for media). Required. |
message_type | string | One of text, image, video, document, audio, location. Default text. |
media_url | string | null | Media of the reply: the storage key from an upload URL of type conversation-predefined-message, or a full URL. |
filename | string | null | File name of the media. |
mime_type | string | null | MIME type of the media. |
created_by_user_id | integer | Read-only. Author: always the API key's user on create. |
created_by_user | object | null | Read-only. Author's id, email, first_name, last_name, avatar_url. Added to every response. |
created_at | string (date-time) | Read-only. |
updated_at | string (date-time) | Read-only. |
deleted_at | string (date-time) | null | Read-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.