v5

latestOpenAPI 3.0.02026-08-04258282491.7 KB

Messages

Update a message

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}

Path parameters

messageIdstring required

Headers

projectstring required

Request body

userstring

sessionstring

botboolean

messageRefstring

ticketstring

{"stackTrail":"components:schemas:UpdateMessageDto:properties:data","oasType":"schema","type":"unknown"}

{"stackTrail":"components:schemas:UpdateMessageDto:properties:translatedData","oasType":"schema","type":"unknown"}

typestring

emailIdstring

sessionNotificationsUnreadboolean

outboundstring

outboundTemplatestring

outboundSubjectstring

{"stackTrail":"components:schemas:UpdateMessageDto:properties:status","oasType":"schema","type":"unknown"}

{"stackTrail":"components:schemas:UpdateMessageDto:properties:comment","oasType":"schema","type":"unknown"}

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

{"stackTrail":"components:schemas:UpdateMessageDto:properties:aiData","oasType":"schema","type":"unknown"}

sendToChannelboolean

isNoteboolean

ratingstring

Response

{"stackTrail":"paths:/messages/{messageId}:put:responses:200:content:application/json:schema","oasType":"schema","type":"unknown"}