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

This includes conversation, email, facebook, instagram, phone_call, phone_switch, push, sms, twitter and whatsapp.

Enum:"conversation""email""facebook""instagram""phone_call""phone_switch""push""sms""twitter""whatsapp"
Example:"conversation"
idstring

The id representing the message.

Example:"3"
delivered_asstring

The conversation's initiation type. Possible values are customer_initiated, campaigns_initiated (legacy campaigns), operator_initiated (Custom bot), automated (Series and other outbounds with dynamic audience message) and admin_initiated (fixed audience message, ticket initiated by an admin, group email).

Example:"operator_initiated"
subjectstring

Optional. The message subject. For Twitter, this will show a generic message regarding why the subject is obscured.

Example:""
bodystring

The message body, which may contain HTML. For Twitter, this will show a generic message regarding why the body is obscured.

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

The object who initiated the conversation, which can be a Contact, Admin or Team. Bots and campaigns send messages on behalf of Admins or Teams. For Twitter, this will be blank.

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
{
  "type": "conversation",
  "id": "3",
  "delivered_as": "operator_initiated",
  "subject": "",
  "body": "<p>Hey there!</p>",
  "author": {
    "type": "admin",
    "id": "274",
    "name": "Operator",
    "email": "operator+abcd1234@intercom.io"
  },
  "attachments": [
    { … }
  ],
  "url": null,
  "redacted": false
}