Home
/
REST API Reference
/
Models
/
Article Translated Content

Intercom API (Unstable)

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

Operations

AI Content

With the AI Content APIs, you can create and manage External Pages and Content Import Sources for your Fin Content Library.

 

External Pages are pages that you want Fin to be able to answer questions about. The API for External Pages is a great way to ingest into your Fin Content Library pages that are not publicly accessible and hence can't be crawled by Intercom.

 

Content Import Sources are the sources of those pages, and they are used to determine the default audience for the pages (configured via the UI). You should create a Content Import Source for each source of External Pages that you want to ingest into your Fin Content Library.

 

You can then iterate through the content from that source via its API and POST it to the External Pages endpoint. That endpoint has an external_id parameter which allows you to specify the identifier from the source. The endpoint will then either create a new External Page or update an existing one as appropriate.",

Operations

Articles

Everything about your Articles

Operations

Internal Articles

Everything about your Internal Articles

Operations

Away Status Reasons

Everything about your away status reasons

Operations

Companies

Everything about your Companies

Operations

Contacts

Everything about your contacts

Operations

Conversations

Everything about your Conversations

Operations

Custom Object Instances

Everything about your Custom Object instances.

Permission Requirements

From now on, to access this endpoint, you need additional permissions. Please head over to the Developer Hub app package authentication settings to configure the required permissions.

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

Jobs

Everything about jobs

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 States

Everything about your ticket states

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

Article Statistics

The statistics of an article.

typestring

The type of object - article_statistics.

Default "article_statistics"
Value"article_statistics"
Example: "article_statistics"
viewsinteger

The number of total views the article has received.

Example: 10
conversionsinteger

The number of conversations started from the article.

Example: 0
reactionsinteger

The number of total reactions the article has received.

Example: 10
happy_reaction_percentagenumber(float)

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

Example: 40
neutral_reaction_percentagenumber(float)

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

Example: 40
sad_reaction_percentagenumber(float)

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 or null

The type of object - article_translated_content.

Enumnull"article_translated_content"
Example: "article_translated_content"
arobject or null(Article Content)

The Content of an Article.

bgobject or null(Article Content)

The Content of an Article.

bsobject or null(Article Content)

The Content of an Article.

caobject or null(Article Content)

The Content of an Article.

csobject or null(Article Content)

The Content of an Article.

daobject or null(Article Content)

The Content of an Article.

deobject or null(Article Content)

The Content of an Article.

elobject or null(Article Content)

The Content of an Article.

enobject or null(Article Content)

The Content of an Article.

esobject or null(Article Content)

The Content of an Article.

etobject or null(Article Content)

The Content of an Article.

fiobject or null(Article Content)

The Content of an Article.

frobject or null(Article Content)

The Content of an Article.

heobject or null(Article Content)

The Content of an Article.

hrobject or null(Article Content)

The Content of an Article.

huobject or null(Article Content)

The Content of an Article.

idobject or null(Article Content)

The Content of an Article.

itobject or null(Article Content)

The Content of an Article.

jaobject or null(Article Content)

The Content of an Article.

koobject or null(Article Content)

The Content of an Article.

ltobject or null(Article Content)

The Content of an Article.

lvobject or null(Article Content)

The Content of an Article.

mnobject or null(Article Content)

The Content of an Article.

nbobject or null(Article Content)

The Content of an Article.

nlobject or null(Article Content)

The Content of an Article.

plobject or null(Article Content)

The Content of an Article.

ptobject or null(Article Content)

The Content of an Article.

roobject or null(Article Content)

The Content of an Article.

ruobject or null(Article Content)

The Content of an Article.

slobject or null(Article Content)

The Content of an Article.

srobject or null(Article Content)

The Content of an Article.

svobject or null(Article Content)

The Content of an Article.

trobject or null(Article Content)

The Content of an Article.

viobject or null(Article Content)

The Content of an Article.

pt-BRobject or null(Article Content)

The Content of an Article.

zh-CNobject or null(Article Content)

The Content of an Article.

zh-TWobject or null(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."
}