Skip to content

Intercom API (2.9)

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

Untag Company Request Payload

You can tag a single company or a list of companies.

namestringrequired

The name of the tag which will be untagged from the company

Example: "Independent"
companiesArray of objectsrequired

The id or company_id of the company can be passed as input parameters.

companies[].​idstring

The Intercom defined id representing the company.

Example: "531ee472cce572a6ec000006"
companies[].​company_idstring

The company id you have defined for the company.

Example: "6"
companies[].​untagboolean

Always set to true

Example: "true"
{ "name": "Independent", "companies": [ {} ] }

Update Article Request Payload

You can Update an Article

titlestring

The title of the article.For multilingual articles, this will be the title of the default language's content.

Example: "Thanks for everything"
descriptionstring

The description of the article. For multilingual articles, this will be the description of the default language's content.

Example: "Description of the Article"
bodystring

The content of the article. For multilingual articles, this will be the body of the default language's content.

Example: "<p>This is the body in html</p>"
author_idinteger

The id of the author of the article. For multilingual articles, this will be the id of the author of the default language's content. Must be a teammate on the help center's workspace.

Example: 1295
statestring

Whether the article will be published or will be a draft. Defaults to draft. For multilingual articles, this will be the state of the default language's content.

Enum"published""draft"
Example: "draft"
parent_idstring

The id of the article's parent collection or section. An article without this field stands alone.

Example: "18"
parent_typestring

The type of parent, which can either be a collection or section.

Example: "collection"
translated_contentobject or null(Article Translated Content)

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

{ "title": "Thanks for everything", "description": "Description of the Article", "body": "<p>This is the body in html</p>", "author_id": 1295, "state": "draft", "parent_id": "18", "parent_type": "collection", "translated_content": { "type": "article_translated_content", "ar": {}, "bg": {}, "bs": {}, "ca": {}, "cs": {}, "da": {}, "de": {}, "el": {}, "en": {}, "es": {}, "et": {}, "fi": {}, "fr": {}, "he": {}, "hr": {}, "hu": {}, "id": {}, "it": {}, "ja": {}, "ko": {}, "lt": {}, "lv": {}, "mn": {}, "nb": {}, "nl": {}, "pl": {}, "pt": {}, "ro": {}, "ru": {}, "sl": {}, "sr": {}, "sv": {}, "tr": {}, "vi": {}, "pt-BR": {}, "zh-CN": {}, "zh-TW": {} } }

Update Collection Request Payload

You can update a collection

namestring

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

Example: "collection 51"
descriptionstring

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

Example: "English description"
translated_contentobject or null(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.

{ "name": "collection 51", "description": "English description", "translated_content": { "type": "group_translated_content", "ar": {}, "bg": {}, "bs": {}, "ca": {}, "cs": {}, "da": {}, "de": {}, "el": {}, "en": {}, "es": {}, "et": {}, "fi": {}, "fr": {}, "he": {}, "hr": {}, "hu": {}, "id": {}, "it": {}, "ja": {}, "ko": {}, "lt": {}, "lv": {}, "mn": {}, "nb": {}, "nl": {}, "pl": {}, "pt": {}, "ro": {}, "ru": {}, "sl": {}, "sr": {}, "sv": {}, "tr": {}, "vi": {}, "pt-BR": {}, "zh-CN": {}, "zh-TW": {} } }