Home
/
REST API Reference
/
Models
/
Conversation Rating

Intercom API (2.11)

The intercom API reference.

Download OpenAPI description
api.intercom.io.json
api.intercom.io.yaml
Overview
URL

https://developers.intercom.com

License

MIT

Languages
Servers
The production API server

https://api.intercom.io/

The european API server

https://api.eu.intercom.io/

The australian API server

https://api.au.intercom.io/

Admins

Everything about your Admins

Operations

Articles

Everything about your Articles

Operations

Companies

Everything about your Companies

Operations

Contacts

Everything about your contacts

Operations

Conversations

Everything about your Conversations

Operations

Data Attributes

Everything about your Data Attributes

Operations

Data Events

Everything about your Data Events

Operations

Data Export

Everything about your Data Exports

Operations

Help Center

Everything about your Help Center

Operations

Messages

Everything about your messages

Operations

News

Everything about your News

Operations

Notes

Everything about your Notes

Operations

Segments

Everything about your Segments

Operations

Subscription Types

Everything about subscription types

Operations

Switch

Everything about Switch

Operations

Tags

Everything about tags

Operations

Teams

Everything about your Teams

Operations

Ticket Type Attributes

Everything about your ticket type attributes

Operations

Ticket Types

Everything about your ticket types

Operations

Tickets

Everything about your tickets

Operations

Visitors

Everything about your Visitors

Operations

Models

Conversation Parts

A list of Conversation Part objects for each part message in the conversation. This is only returned when Retrieving a Conversation, and ignored when Listing all Conversations. There is a limit of 500 parts.

typestringrequired
Value"conversation_part.list"
Example: "conversation_part.list"
conversation_partsArray of objects(Conversation Parts)required

A list of Conversation Part objects for each part message in the conversation. This is only returned when Retrieving a Conversation, and ignored when Listing all Conversations. There is a limit of 500 parts.

conversation_parts[].​typestringrequired

Always conversation_part

Value"conversation_part"
Example: "conversation_part"
conversation_parts[].​idstringrequired

The id representing the conversation part.

Example: "3"
conversation_parts[].​part_typestringrequired

The type of conversation part.

Example: "comment"
conversation_parts[].​bodystring or null

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

Example: "<p>Okay!</p>"
conversation_parts[].​created_atinteger(date-time)required

The time the conversation part was created.

Example: 1663597223
conversation_parts[].​updated_atinteger(date-time)

The last time the conversation part was updated.

Example: 1663597260
conversation_parts[].​notified_atinteger(date-time)required

The time the user was notified with the conversation part.

Example: 1663597260
conversation_parts[].​assigned_toobject(Reference)

reference to another object

conversation_parts[].​authorobject(Conversation part author)required

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.

conversation_parts[].​author.​typestringrequired

The type of the author

Example: "admin"
conversation_parts[].​author.​idstringrequired

The id of the author

Example: "274"
conversation_parts[].​author.​namestringrequired

The name of the author

Example: "Operator"
conversation_parts[].​author.​emailstring(email)required

The email of the author

Example: "operator+abcd1234@intercom.io"
conversation_parts[].​attachmentsArray of objects(Conversation part attachments)

A list of attachments for the part.

conversation_parts[].​external_idstring or null

The external id of the conversation part

Example: "abcd1234"
conversation_parts[].​redactedbooleanrequired

Whether or not the conversation part has been redacted.

Example: false
total_countintegerrequired
Example: 2
{
  "type": "conversation_part.list",
  "conversation_parts": [
    { … }
  ],
  "total_count": 2
}

Conversation Rating

The Conversation Rating object which contains information on the rating and/or remark added by a Contact and the Admin assigned to the conversation.

ratingintegerrequired

The rating, between 1 and 5, for the conversation.

Example: 5
remarkstringrequired

An optional field to add a remark to correspond to the number rating

Example: ""
created_atinteger(date-time)required

The time the rating was requested in the conversation being rated.

Example: 1671028894
contactobject(Contact Reference)required

reference to contact object

contact.​typestringrequired

always contact

Value"contact"
Example: "contact"
contact.​idstringrequired

The unique identifier for the contact which is given by Intercom.

Example: "5ba682d23d7cf92bef87bfd4"
contact.​external_idstring or null

The unique identifier for the contact which is provided by the Client.

Example: "f3b87a2e09d514c6c2e79b9a"
teammateobject(Reference)required

reference to another object

teammate.​typestringrequired
Example: "contact"
teammate.​idstring or null
Example: "1a2b3c"
{
  "rating": 5,
  "remark": "",
  "created_at": 1671028894,
  "contact": {
    "type": "contact",
    "id": "5ba682d23d7cf92bef87bfd4",
    "external_id": "f3b87a2e09d514c6c2e79b9a"
  },
  "teammate": {
    "type": "contact",
    "id": "1a2b3c"
  }
}

Conversation source

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

typestringrequired

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

The id representing the message.

Example: "3"
delivered_asstringrequired

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

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)required

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.

author.​typestringrequired

The type of the author

Example: "admin"
author.​idstringrequired

The id of the author

Example: "274"
author.​namestringrequired

The name of the author

Example: "Operator"
author.​emailstring(email)required

The email of the author

Example: "operator+abcd1234@intercom.io"
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
redactedbooleanrequired

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
}