Skip to content
Home/
REST API Reference
/
/
Conversation source

Conversation source

The type of the conversation part that started this conversation. Can be Contact, Admin, Campaign, Automated or Operator initiated.

typestring

The origin of this conversation.

Example:"email"
idstring or null

The id of the source message.

Example:"3"
delivered_asstring

How the conversation was initiated.

Example:"operator_initiated"
recipientsArray of objects or null

The recipients of the source message. Only present for email conversations.

reply_toArray of objects or null

The Reply-To header addresses of the source message, where a reply will be routed. Can differ from the sender's From address. Only present for email conversations.

subjectstring

Optional. The message subject. For Twitter, this will show a generic message regarding why the subject is obscured. In webhook payloads for API version 2.15+, this field returns plain text.

Example:""
bodystring

The message body, which may contain HTML. For Twitter, this will show a generic message regarding why the body is obscured. In webhook payloads for API version 2.15+, this field returns plain text.

Example:"<p>Hey there!</p>"
authorobject(Conversation source author)

The author who started the conversation. Can be a Contact, Admin, or Bot.

attachmentsArray of objects(Part attachment)

A list of attachments for the part.

urlstring or null

The URL where the conversation was started. For Twitter, Email, and Bots, this will be blank.

Example:null
redactedboolean

Whether or not the source message has been redacted. Only applicable for contact initiated messages.

Example:false
email_message_metadataobject(Email Message Metadata)

Contains metadata if the message was sent as an email

{
  "type": "email",
  "id": "3",
  "delivered_as": "operator_initiated",
  "recipients": [
    { … }
  ],
  "reply_to": [
    { … }
  ],
  "subject": "",
  "body": "<p>Hey there!</p>",
  "author": {
    "type": "admin",
    "id": "274",
    "name": "Jane Doe",
    "email": "jane.doe@example.com"
  },
  "attachments": [
    { … }
  ],
  "url": null,
  "redacted": false,
  "email_message_metadata": {
    "message_id": "<CADKw7xrXzqSn8v3mP8K8Q8yZ6K8Q8yZ6@mail.gmail.com>",
    "subject": "Question about my order",
    "email_address_headers": [ … ],
    "history": "<div><span>On Jan 28, wrote:</span><blockquote>Previous thread</blockquote></div>"
  }
}