Conversation predefined messages

CRUD shortcuts (canned replies) for the organization. Listed in the Predefined Messages dialog with organization_id, sorted by title.

List

Endpoint:

GET
/conversation-predefined-messages

Create

Endpoint:

POST
/conversation-predefined-messages

Update

Endpoint:

PATCH
/conversation-predefined-messages/:id

Delete

Endpoint:

DELETE
/conversation-predefined-messages/:id

Fields (from UI types)

FieldTypeDescription
idNumberRecord id.
organization_idNumberOwning organization.
titleStringShort label in the picker.
contentStringText body for text templates.
message_typeStringtext, image, video, document, audio, location, etc.
media_urlStringOptional; may be a key or full URL depending on how the item was saved.
filenameStringOptional file name for media types.
mime_typeStringOptional MIME type.
created_by_user_idNumberUser who created the shortcut.
created_at / updated_atStringISO timestamps.

Media-based predefined messages use the same signing and upload flow as Upload attachment inside the dialog.

Report an issue with this documentation

Please log in to report issues with our documentation.