Messages

Update a message

Changed on

Edit an existing message. Only data (the message content, e.g. data.content as TipTap JSON) and attachments are persisted; all other schema properties are ignored, and data is replaced wholesale (an omitted data clears the content). Agents may only edit their own messages, sent through the widget or email channel, that the contact has not read yet and that are less than 2 minutes old; own internal notes can be edited at any time.

put/messages/{messageId}

Request

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

Path parameters

messageIdstring required

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