Skip to content
Home/
REST API Reference
/
/
Article Translated Conten...

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

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

News

Everything about your News

SchemasOperations

Notes

Everything about your Notes

SchemasOperations

Segments

Everything about your Segments

SchemasOperations

Subscription Types

Everything about subscription types

SchemasOperations

Switch

Everything about Switch

Operations

Tags

Everything about tags

SchemasOperations

Teams

Everything about your Teams

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

Models

Schemas

Article Statistics

The statistics of an article.

typestringrequired

The type of object - article_statistics.

Default "article_statistics"
Value"article_statistics"
Example: "article_statistics"
viewsintegerrequired

The number of total views the article has received.

Example: 10
conversionsintegerrequired

The number of conversations started from the article.

Example: 0
reactionsintegerrequired

The number of total reactions the article has received.

Example: 10
happy_reaction_percentagenumber(float)required

The percentage of happy reactions the article has received against other types of reaction.

Example: 40
neutral_reaction_percentagenumber(float)required

The percentage of neutral reactions the article has received against other types of reaction.

Example: 40
sad_reaction_percentagenumber(float)required

The percentage of sad reactions the article has received against other types of reaction.

Example: 20
{
  "type": "article_statistics",
  "views": 10,
  "conversions": 0,
  "reactions": 10,
  "happy_reaction_percentage": 40,
  "neutral_reaction_percentage": 40,
  "sad_reaction_percentage": 20
}

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.

typestring

The type of object - article_translated_content.

Value"article_translated_content"
Example: "article_translated_content"
arobject(Article Content)

The Content of an Article.

bgobject(Article Content)

The Content of an Article.

bsobject(Article Content)

The Content of an Article.

caobject(Article Content)

The Content of an Article.

csobject(Article Content)

The Content of an Article.

daobject(Article Content)

The Content of an Article.

deobject(Article Content)

The Content of an Article.

elobject(Article Content)

The Content of an Article.

enobject(Article Content)

The Content of an Article.

esobject(Article Content)

The Content of an Article.

etobject(Article Content)

The Content of an Article.

fiobject(Article Content)

The Content of an Article.

frobject(Article Content)

The Content of an Article.

heobject(Article Content)

The Content of an Article.

hrobject(Article Content)

The Content of an Article.

huobject(Article Content)

The Content of an Article.

idobject(Article Content)

The Content of an Article.

itobject(Article Content)

The Content of an Article.

jaobject(Article Content)

The Content of an Article.

koobject(Article Content)

The Content of an Article.

ltobject(Article Content)

The Content of an Article.

lvobject(Article Content)

The Content of an Article.

mnobject(Article Content)

The Content of an Article.

nbobject(Article Content)

The Content of an Article.

nlobject(Article Content)

The Content of an Article.

plobject(Article Content)

The Content of an Article.

ptobject(Article Content)

The Content of an Article.

roobject(Article Content)

The Content of an Article.

ruobject(Article Content)

The Content of an Article.

slobject(Article Content)

The Content of an Article.

srobject(Article Content)

The Content of an Article.

svobject(Article Content)

The Content of an Article.

trobject(Article Content)

The Content of an Article.

viobject(Article Content)

The Content of an Article.

pt-BRobject(Article Content)

The Content of an Article.

zh-CNobject(Article Content)

The Content of an Article.

zh-TWobject(Article Content)

The Content of an Article.

{
  "type": "article_translated_content",
  "ar": {
    "type": "article_content",
    "title": "How to create a new article",
    "description": "This article will show you how to create a new article.",
    "body": "This is the body of the article.",
    "author_id": "5017691",
    "state": "draft",
    "created_at": 1663597223,
    "updated_at": 1663597260,
    "url": "http://intercom.test/help/en/articles/3-default-language"
  },
  "bg": {
    "type": "article_content",
    "title": "How to create a new article",
    "description": "This article will show you how to create a new article.",
    "body": "This is the body of the article.",
    "author_id": "5017691",
    "state": "draft",
    "created_at": 1663597223,
    "updated_at": 1663597260,
    "url": "http://intercom.test/help/en/articles/3-default-language"
  },
  "bs": {
    "type": "article_content",
    "title": "How to create a new article",
    "description": "This article will show you how to create a new article.",
    "body": "This is the body of the article.",
    "author_id": "5017691",
    "state": "draft",
    "created_at": 1663597223,
    "updated_at": 1663597260,
    "url": "http://intercom.test/help/en/articles/3-default-language"
  },
  "ca": {
    "type": "article_content",
    "title": "How to create a new article",
    "description": "This article will show you how to create a new article.",
    "body": "This is the body of the article.",
    "author_id": "5017691",
    "state": "draft",
    "created_at": 1663597223,
    "updated_at": 1663597260,
    "url": "http://intercom.test/help/en/articles/3-default-language"
  },
  "cs": {
    "type": "article_content",
    "title": "How to create a new article",
    "description": "This article will show you how to create a new article.",
    "body": "This is the body of the article.",
    "author_id": "5017691",
    "state": "draft",
    "created_at": 1663597223,
    "updated_at": 1663597260,
    "url": "http://intercom.test/help/en/articles/3-default-language"
  },
  "da": {
    "type": "article_content",
    "title": "How to create a new article",
    "description": "This article will show you how to create a new article.",
    "body": "This is the body of the article.",
    "author_id": "5017691",
    "state": "draft",
    "created_at": 1663597223,
    "updated_at": 1663597260,
    "url": "http://intercom.test/help/en/articles/3-default-language"
  },
  "de": {
    "type": "article_content",
    "title": "How to create a new article",
    "description": "This article will show you how to create a new article.",
    "body": "This is the body of the article.",
    "author_id": "5017691",
    "state": "draft",
    "created_at": 1663597223,
    "updated_at": 1663597260,
    "url": "http://intercom.test/help/en/articles/3-default-language"
  },
  "el": {
    "type": "article_content",
    "title": "How to create a new article",
    "description": "This article will show you how to create a new article.",
    "body": "This is the body of the article.",
    "author_id": "5017691",
    "state": "draft",
    "created_at": 1663597223,
    "updated_at": 1663597260,
    "url": "http://intercom.test/help/en/articles/3-default-language"
  },
  "en": {
    "type": "article_content",
    "title": "How to create a new article",
    "description": "This article will show you how to create a new article.",
    "body": "This is the body of the article.",
    "author_id": "5017691",
    "state": "draft",
    "created_at": 1663597223,
    "updated_at": 1663597260,
    "url": "http://intercom.test/help/en/articles/3-default-language"
  },
  "es": {
    "type": "article_content",
    "title": "How to create a new article",
    "description": "This article will show you how to create a new article.",
    "body": "This is the body of the article.",
    "author_id": "5017691",
    "state": "draft",
    "created_at": 1663597223,
    "updated_at": 1663597260,
    "url": "http://intercom.test/help/en/articles/3-default-language"
  },
  "et": {
    "type": "article_content",
    "title": "How to create a new article",
    "description": "This article will show you how to create a new article.",
    "body": "This is the body of the article.",
    "author_id": "5017691",
    "state": "draft",
    "created_at": 1663597223,
    "updated_at": 1663597260,
    "url": "http://intercom.test/help/en/articles/3-default-language"
  },
  "fi": {
    "type": "article_content",
    "title": "How to create a new article",
    "description": "This article will show you how to create a new article.",
    "body": "This is the body of the article.",
    "author_id": "5017691",
    "state": "draft",
    "created_at": 1663597223,
    "updated_at": 1663597260,
    "url": "http://intercom.test/help/en/articles/3-default-language"
  },
  "fr": {
    "type": "article_content",
    "title": "How to create a new article",
    "description": "This article will show you how to create a new article.",
    "body": "This is the body of the article.",
    "author_id": "5017691",
    "state": "draft",
    "created_at": 1663597223,
    "updated_at": 1663597260,
    "url": "http://intercom.test/help/en/articles/3-default-language"
  },
  "he": {
    "type": "article_content",
    "title": "How to create a new article",
    "description": "This article will show you how to create a new article.",
    "body": "This is the body of the article.",
    "author_id": "5017691",
    "state": "draft",
    "created_at": 1663597223,
    "updated_at": 1663597260,
    "url": "http://intercom.test/help/en/articles/3-default-language"
  },
  "hr": {
    "type": "article_content",
    "title": "How to create a new article",
    "description": "This article will show you how to create a new article.",
    "body": "This is the body of the article.",
    "author_id": "5017691",
    "state": "draft",
    "created_at": 1663597223,
    "updated_at": 1663597260,
    "url": "http://intercom.test/help/en/articles/3-default-language"
  },
  "hu": {
    "type": "article_content",
    "title": "How to create a new article",
    "description": "This article will show you how to create a new article.",
    "body": "This is the body of the article.",
    "author_id": "5017691",
    "state": "draft",
    "created_at": 1663597223,
    "updated_at": 1663597260,
    "url": "http://intercom.test/help/en/articles/3-default-language"
  },
  "id": {
    "type": "article_content",
    "title": "How to create a new article",
    "description": "This article will show you how to create a new article.",
    "body": "This is the body of the article.",
    "author_id": "5017691",
    "state": "draft",
    "created_at": 1663597223,
    "updated_at": 1663597260,
    "url": "http://intercom.test/help/en/articles/3-default-language"
  },
  "it": {
    "type": "article_content",
    "title": "How to create a new article",
    "description": "This article will show you how to create a new article.",
    "body": "This is the body of the article.",
    "author_id": "5017691",
    "state": "draft",
    "created_at": 1663597223,
    "updated_at": 1663597260,
    "url": "http://intercom.test/help/en/articles/3-default-language"
  },
  "ja": {
    "type": "article_content",
    "title": "How to create a new article",
    "description": "This article will show you how to create a new article.",
    "body": "This is the body of the article.",
    "author_id": "5017691",
    "state": "draft",
    "created_at": 1663597223,
    "updated_at": 1663597260,
    "url": "http://intercom.test/help/en/articles/3-default-language"
  },
  "ko": {
    "type": "article_content",
    "title": "How to create a new article",
    "description": "This article will show you how to create a new article.",
    "body": "This is the body of the article.",
    "author_id": "5017691",
    "state": "draft",
    "created_at": 1663597223,
    "updated_at": 1663597260,
    "url": "http://intercom.test/help/en/articles/3-default-language"
  },
  "lt": {
    "type": "article_content",
    "title": "How to create a new article",
    "description": "This article will show you how to create a new article.",
    "body": "This is the body of the article.",
    "author_id": "5017691",
    "state": "draft",
    "created_at": 1663597223,
    "updated_at": 1663597260,
    "url": "http://intercom.test/help/en/articles/3-default-language"
  },
  "lv": {
    "type": "article_content",
    "title": "How to create a new article",
    "description": "This article will show you how to create a new article.",
    "body": "This is the body of the article.",
    "author_id": "5017691",
    "state": "draft",
    "created_at": 1663597223,
    "updated_at": 1663597260,
    "url": "http://intercom.test/help/en/articles/3-default-language"
  },
  "mn": {
    "type": "article_content",
    "title": "How to create a new article",
    "description": "This article will show you how to create a new article.",
    "body": "This is the body of the article.",
    "author_id": "5017691",
    "state": "draft",
    "created_at": 1663597223,
    "updated_at": 1663597260,
    "url": "http://intercom.test/help/en/articles/3-default-language"
  },
  "nb": {
    "type": "article_content",
    "title": "How to create a new article",
    "description": "This article will show you how to create a new article.",
    "body": "This is the body of the article.",
    "author_id": "5017691",
    "state": "draft",
    "created_at": 1663597223,
    "updated_at": 1663597260,
    "url": "http://intercom.test/help/en/articles/3-default-language"
  },
  "nl": {
    "type": "article_content",
    "title": "How to create a new article",
    "description": "This article will show you how to create a new article.",
    "body": "This is the body of the article.",
    "author_id": "5017691",
    "state": "draft",
    "created_at": 1663597223,
    "updated_at": 1663597260,
    "url": "http://intercom.test/help/en/articles/3-default-language"
  },
  "pl": {
    "type": "article_content",
    "title": "How to create a new article",
    "description": "This article will show you how to create a new article.",
    "body": "This is the body of the article.",
    "author_id": "5017691",
    "state": "draft",
    "created_at": 1663597223,
    "updated_at": 1663597260,
    "url": "http://intercom.test/help/en/articles/3-default-language"
  },
  "pt": {
    "type": "article_content",
    "title": "How to create a new article",
    "description": "This article will show you how to create a new article.",
    "body": "This is the body of the article.",
    "author_id": "5017691",
    "state": "draft",
    "created_at": 1663597223,
    "updated_at": 1663597260,
    "url": "http://intercom.test/help/en/articles/3-default-language"
  },
  "ro": {
    "type": "article_content",
    "title": "How to create a new article",
    "description": "This article will show you how to create a new article.",
    "body": "This is the body of the article.",
    "author_id": "5017691",
    "state": "draft",
    "created_at": 1663597223,
    "updated_at": 1663597260,
    "url": "http://intercom.test/help/en/articles/3-default-language"
  },
  "ru": {
    "type": "article_content",
    "title": "How to create a new article",
    "description": "This article will show you how to create a new article.",
    "body": "This is the body of the article.",
    "author_id": "5017691",
    "state": "draft",
    "created_at": 1663597223,
    "updated_at": 1663597260,
    "url": "http://intercom.test/help/en/articles/3-default-language"
  },
  "sl": {
    "type": "article_content",
    "title": "How to create a new article",
    "description": "This article will show you how to create a new article.",
    "body": "This is the body of the article.",
    "author_id": "5017691",
    "state": "draft",
    "created_at": 1663597223,
    "updated_at": 1663597260,
    "url": "http://intercom.test/help/en/articles/3-default-language"
  },
  "sr": {
    "type": "article_content",
    "title": "How to create a new article",
    "description": "This article will show you how to create a new article.",
    "body": "This is the body of the article.",
    "author_id": "5017691",
    "state": "draft",
    "created_at": 1663597223,
    "updated_at": 1663597260,
    "url": "http://intercom.test/help/en/articles/3-default-language"
  },
  "sv": {
    "type": "article_content",
    "title": "How to create a new article",
    "description": "This article will show you how to create a new article.",
    "body": "This is the body of the article.",
    "author_id": "5017691",
    "state": "draft",
    "created_at": 1663597223,
    "updated_at": 1663597260,
    "url": "http://intercom.test/help/en/articles/3-default-language"
  },
  "tr": {
    "type": "article_content",
    "title": "How to create a new article",
    "description": "This article will show you how to create a new article.",
    "body": "This is the body of the article.",
    "author_id": "5017691",
    "state": "draft",
    "created_at": 1663597223,
    "updated_at": 1663597260,
    "url": "http://intercom.test/help/en/articles/3-default-language"
  },
  "vi": {
    "type": "article_content",
    "title": "How to create a new article",
    "description": "This article will show you how to create a new article.",
    "body": "This is the body of the article.",
    "author_id": "5017691",
    "state": "draft",
    "created_at": 1663597223,
    "updated_at": 1663597260,
    "url": "http://intercom.test/help/en/articles/3-default-language"
  },
  "pt-BR": {
    "type": "article_content",
    "title": "How to create a new article",
    "description": "This article will show you how to create a new article.",
    "body": "This is the body of the article.",
    "author_id": "5017691",
    "state": "draft",
    "created_at": 1663597223,
    "updated_at": 1663597260,
    "url": "http://intercom.test/help/en/articles/3-default-language"
  },
  "zh-CN": {
    "type": "article_content",
    "title": "How to create a new article",
    "description": "This article will show you how to create a new article.",
    "body": "This is the body of the article.",
    "author_id": "5017691",
    "state": "draft",
    "created_at": 1663597223,
    "updated_at": 1663597260,
    "url": "http://intercom.test/help/en/articles/3-default-language"
  },
  "zh-TW": {
    "type": "article_content",
    "title": "How to create a new article",
    "description": "This article will show you how to create a new article.",
    "body": "This is the body of the article.",
    "author_id": "5017691",
    "state": "draft",
    "created_at": 1663597223,
    "updated_at": 1663597260,
    "url": "http://intercom.test/help/en/articles/3-default-language"
  }
}

Assign Conversation Request

Payload of the request to assign a conversation

message_typestringrequired
Value"assignment"
Example: "assignment"
typestringrequired
Enum"admin""team"
Example: "admin"
admin_idstringrequired

The id of the admin who is performing the action.

Example: "12345"
assignee_idstringrequired

The id of the admin or team which will be assigned the conversation. A conversation can be assigned both an admin and a team.\nSet 0 if you want this assign to no admin or team (ie. Unassigned).

Example: "4324241"
bodystring

Optionally you can send a response in the conversation when it is assigned.

Example: "Let me pass you over to one of my colleagues."
{
  "message_type": "assignment",
  "type": "admin",
  "admin_id": "12345",
  "assignee_id": "4324241",
  "body": "Let me pass you over to one of my colleagues."
}