Create a predefined message

Create a canned reply for the organization. The author (created_by_user_id) is always the API key's user.

Endpoint

POST
/conversation-predefined-messages

Body

NameTypeRequiredDescription
organization_idintegerYesYour organization ID.
titlestringYesLabel shown in the picker.
contentstringYesReply text (caption for media).
message_typestringNotext (default), image, video, document, audio or location.
media_urlstringNoFor media: the s3PathWithoutBucket of an upload URL of type conversation-predefined-message, or a full URL.
filenamestringNoFile name of the media.
mime_typestringNoMIME type of the media.

Request

Response

The created predefined message:

json

Errors

StatusWhen
400 Bad RequestA required field is missing, message_type is not allowed, or an unknown field was sent.

Report an issue with this documentation

Please log in to report issues with our documentation.