Skip to content
Home/
REST API Reference
/
/
Admin Reply on ticket

Admin Reply on ticket

Payload of the request to reply on behalf of an admin

message_typestringrequired
Enum:"comment""note""quick_reply"
Example:"comment"
typestringrequired
Value:"admin"
Example:"admin"
bodystring

The text body of the reply. Notes accept some HTML formatting. Must be present for comment and note message types.

Example:"Hello there!"
admin_idstringrequired

The id of the admin who is authoring the comment.

Example:"3156780"
reply_optionsArray of objects(Quick Reply Options)

The quick reply options to display. Must be present for quick_reply message types.

attachment_urlsArray of strings, (uri), <= 10 items

A list of image URLs that will be added as attachments. You can include up to 10 URLs.

cross_postboolean

If set to true, the note will be cross-posted to all linked conversations. Only applicable to note message types on back-office tickets.

Example:true
{
  "message_type": "comment",
  "type": "admin",
  "body": "Hello there!",
  "admin_id": "3156780",
  "reply_options": [
    { … }
  ],
  "attachment_urls": [
    "http://example.com"
  ],
  "cross_post": true
}