Messages

Create a new message

Changed on

Create a new message in a ticket. Required field: ticket (ticket ID). Optional fields: comment (rich text as TipTap doc JSON, or a plain string) or markdownComment (Markdown, converted server-side; takes precedence over comment), type (defaults to TEXT, or NOTE when isNote is true), isNote (creates an internal note), attachments (array of { name, url, type }), channel, replyTo (message ID to quote), data, and actions. Other schema properties are accepted for backwards compatibility but are ignored on create; messages are always attributed to the authenticated user.

post/messages

Request

  • Base URL
    https://api.gleap.io/v3
  • URL
    https://api.gleap.io/v3/messages
  • Auth
    HTTP bearer

Headers

projectstring required

Request body

userstring
sessionstring
botboolean
messageRefstring
ticketstring
dataunknown
translatedDataunknown
typestring
audience'requester' | 'public'
emailIdstring
sessionNotificationsUnreadboolean
outboundstring
outboundTemplatestring
outboundSubjectstring
statusunknown
commentunknown
markdownCommentstring

Markdown message body, honored when creating a message: the server converts it to TipTap JSON and it takes precedence over comment. Ignored when updating a message.

replyTostring
kaiChatboolean
aiDataunknown
sendToChannelboolean
isNoteboolean
ratingstring

Response

Ok

unknown required

Changes