Intercom API (2.10)

The intercom API reference.

Download OpenAPI description
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

Deleted Object

Response returned when an object is deleted

idstring

The unique identifier for the news item which you provided in the URL.

Example: "6890762"
objectstring

The type of object which was deleted - news-item.

Value"news-item"
Example: "news-item"
deletedboolean

Whether the news item was deleted successfully or not.

Example: true
{ "id": "6890762", "object": "news-item", "deleted": true }

detach_contact_from_conversation_request

admin_idstringrequired

The id of the admin who is performing the action.

Example: "5017690"
{ "admin_id": "5017690" }

Error

The API will return an Error List for a failed request, which will contain one or more Error objects.

typestringrequired

The type is error.list

Example: "error.list"
request_idstring or null(uuid)
Example: "f93ecfa8-d08a-4325-8694-89aeb89c8f85"
errorsArray of objectsrequired

An array of one or more error objects

errors[].​codestringrequired

A string indicating the kind of error, used to further qualify the HTTP response code

Example: "unauthorized"
errors[].​messagestring or null

Optional. Human readable description of the error.

Example: "Access Token Invalid"
errors[].​fieldstring or null

Optional. Used to identify a particular field or query parameter that was in error.

Example: "email"
{ "type": "error.list", "request_id": "f93ecfa8-d08a-4325-8694-89aeb89c8f85", "errors": [ {} ] }