Skip to content

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

SchemasOperations

Articles

Everything about your Articles

SchemasOperations

Companies

Everything about your Companies

SchemasOperations

Contacts

Everything about your contacts

SchemasOperations

Conversations

Everything about your Conversations

SchemasOperations

Data Attributes

Everything about your Data Attributes

SchemasOperations

Data Events

Everything about your Data Events

SchemasOperations

Data Export

Everything about your Data Exports

SchemasOperations

Help Center

Everything about your Help Center

SchemasOperations

Messages

Everything about your messages

SchemasOperations
SchemasOperations
SchemasOperations

Segments

Everything about your Segments

SchemasOperations

Subscription Types

Everything about subscription types

SchemasOperations
Operations
SchemasOperations
SchemasOperations

Ticket Type Attributes

Everything about your ticket type attributes

Operations

Ticket Types

Everything about your ticket types

Operations

Tickets

Everything about your tickets

SchemasOperations

Visitors

Everything about your Visitors

Operations
Schemas

Deleted Collection Object

Response returned when an object is deleted

idstring

The unique identifier for the collection which you provided in the URL.

Example: "6890762"
objectstring

The type of object which was deleted. - collection

Value"collection"
Example: "collection"
deletedboolean

Whether the collection was deleted successfully or not.

Example: true
{ "id": "6890762", "object": "collection", "deleted": true }

Deleted Company Object

Response returned when an object is deleted

idstring

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

Example: "5b7e8b2f-7a1a-4e6c-8e1b-4f9d4f4c4d4f"
objectstring

The type of object which was deleted. - company

Value"company"
Example: "company"
deletedboolean

Whether the company was deleted successfully or not.

Example: true
{ "id": "5b7e8b2f-7a1a-4e6c-8e1b-4f9d4f4c4d4f", "object": "company", "deleted": true }

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 }