v4

OpenAPI 3.0.02026-07-31257282489.4 KB

Messages

Create a new message

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

Headers

projectstring required

Request body

userstring

sessionstring

botboolean

messageRefstring

ticketstring

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

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

typestring

emailIdstring

sessionNotificationsUnreadboolean

outboundstring

outboundTemplatestring

outboundSubjectstring

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

{"stackTrail":"components:schemas:CreateMessageDto: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:CreateMessageDto:properties:aiData","oasType":"schema","type":"unknown"}

sendToChannelboolean

isNoteboolean

ratingstring

Response

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