Create an article

You can create a new article by making a POST request to https://api.intercom.io/articles.

SecurityHTTP: bearerAuth
Request
header Parameters
Intercom-Version
string (intercom_version)
Default: 2.11

Intercom API version.
By default, it's equal to the version set in the app package.

Enum: "1.0" "1.1" "1.2" "1.3" "1.4" "2.0" "2.1" "2.2" "2.3" "2.4" "2.5" "2.6" "2.7" "2.8" "2.9" "2.10" "2.11" "Unstable"
Example: 2.11
Request Body schema: application/json
title
required
string

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

description
string

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

body
string

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

author_id
required
integer

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.

state
string

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"
parent_id
integer

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

parent_type
string

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

object 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.

post
/articles
Request samples
application/json
{ "title": "Thanks for everything", "description": "Description of the Article", "body": "Body of the Article", "author_id": 991270009, "state": "published", "parent_id": 503, "parent_type": "collection", "translated_content": { } }
Responses

200

article created

Response Schema: application/json
object or null (Article Statistics)

The statistics of an article.

type
string
Default: "article"

The type of object - article.

Value: "article"
id
string

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

workspace_id
string

The id of the workspace which the article belongs to.

title
string

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

description
string or null

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

body
string or null

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

author_id
integer

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.

state
string
Default: "draft"

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

Enum: "published" "draft"
created_at
integer <date-time>

The time when the article was created. For multilingual articles, this will be the timestamp of creation of the default language's content in seconds.

updated_at
integer <date-time>

The time when the article was last updated. For multilingual articles, this will be the timestamp of last update of the default language's content in seconds.

url
string or null

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

parent_id
integer or null

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

parent_ids
Array of integers

The ids of the article's parent collections or sections. An article without this field stands alone.

parent_type
string or null

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

default_locale
string

The default locale of the help center. This field is only returned for multilingual help centers.

object 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.

400

Bad Request

401

Unauthorized

Response samples
application/json
{ "id": "131", "type": "article", "workspace_id": "this_is_an_id26_that_should_be_at_least_4", "parent_id": 503, "parent_type": "collection", "parent_ids": [ ], "statistics": { "type": "article_statistics", "views": 0, "conversations": 0, "reactions": 0, "happy_reaction_percentage": 0, "neutral_reaction_percentage": 0, "sad_reaction_percentage": 0 }, "title": "Thanks for everything", "description": "Description of the Article", "body": "<p class=\"no-margin\">Body of the Article</p>", "author_id": 991270009, "state": "published", "created_at": 1716385061, "updated_at": 1716385061, "url": "http://help-center.test/myapp-26/en/articles/131-thanks-for-everything" }