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

Admin Reply

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"
created_atinteger

The time the reply was created. If not provided, the current time will be used.

Example:1590000000
reply_optionsArray of objects(Quick Reply Options)

The quick reply options to display to the end user. 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.

attachment_filesArray of objects, <= 10 items(Conversation attachment files)

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

skip_notificationsboolean

Option to disable notifications when replying to a conversation.

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