Close Conversation Request

Assign Conversation Request

Payload of the request to assign a conversation

admin_idstring

The id of the admin who is adding the new participant.

Example: "12345"

customerIntercom User ID (object) or User ID (object) or Email (object)

One of:

{
  "admin_id": "12345",
  "customer": {
    "intercom_user_id": "6329bd9ffe4e2e91dac76188",
    "customer": { … }
  }
}

Close Conversation Request

Payload of the request to close a conversation

message_typestringrequired

Value"close"

Example: "close"

typestringrequired

Value"admin"

Example: "admin"

admin_idstringrequired

The id of the admin who is performing the action.

Example: "12345"

bodystring

Optionally you can leave a message in the conversation to provide additional context to the user and other teammates.

Example: " This conversation is now closed!"

{
  "message_type": "close",
  "type": "admin",
  "admin_id": "12345",
  "body": " This conversation is now closed!"
}

Collections

This will return a list of Collections for the App.

typestringrequired

The type of the object - list.

Value"list"

Example: "list"

pagesobject(Cursor based pages)

Cursor-based pagination is a technique used in the Intercom API to navigate through large amounts of data. A "cursor" or pointer is used to keep track of the current position in the result set, allowing the API to return the data in small chunks or "pages" as needed.

total_countintegerrequired

A count of the total number of collections.

Example: 1

dataArray of objects(Collection)required

An array of collection objects

data[].idstringrequired

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

Example: "6871119"

data[].workspace_idstringrequired

The id of the workspace which the collection belongs to.

Example: "hfi1bx4l"

data[].namestringrequired

The name of the collection. For multilingual collections, this will be the name of the default language's content.

Example: "Default language name"

data[].descriptionstring or null

The description of the collection. For multilingual help centers, this will be the description of the collection for the default language.

Example: "Default language description"

data[].created_atinteger(date-time)required

The time when the article was created (seconds). For multilingual articles, this will be the timestamp of creation of the default language's content.

Example: 1672928359

data[].updated_atinteger(date-time)

The time when the article was last updated (seconds). For multilingual articles, this will be the timestamp of last update of the default language's content.

Example: 1672928610

data[].urlstring or null

The URL of the collection. For multilingual help centers, this will be the URL of the collection for the default language.

Example: "http://intercom.test/help/collection/name"

data[].iconstring or null

The icon of the collection.

Example: "book-bookmark"

data[].orderintegerrequired

The order of the section in relation to others sections within a collection. Values go from 0 upwards. 0 is the default if there's no order.

Example: "1"

data[].default_localestringrequired

The default locale of the help center. This field is only returned for multilingual help centers.

Example: "en"

data[].translated_contentobject(Group Translated Content)

The Translated Content of an Group. The keys are the locale codes and the values are the translated content of the Group.

data[].parent_idstring or null

The id of the parent collection. If null then it is the first level collection.

Example: "6871118"

data[].help_center_idinteger or null

The id of the help center the collection is in.

Example: "123"

{
  "type": "list",
  "pages": {
    "type": "pages",
    "page": 1,
    "next": { … },
    "per_page": 2,
    "total_pages": 13
  },
  "total_count": 1,
  "data": [
    { … }
  ]
}

Intercom API (2.11)

Admins

Articles

Companies

Contacts

Conversations

Data Attributes

Data Events

Data Export

Help Center

Messages

News

Notes

Segments

Subscription Types

Switch

Tags

Teams

Ticket Type Attributes

Ticket Types

Tickets

Visitors

Models

Assign Conversation Request

Close Conversation Request

Collections