Update an article

You can update the details of a single article by making a PUT request to https://api.intercom.io/articles/<id>.

SecurityHTTP: bearerAuth

Request

path Parameters

required

integer

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

Example: 123

header Parameters

Intercom-Version

string (intercom_version)

Default: 2.10

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" "Unstable"

Example: 2.10

Request Body schema: application/json

title	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	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	string 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.

put

/articles/{id}

Request samples
Payload
curl
Node.js
Ruby
PHP
Python
Java
Go
C#
R
5 more
application/json
successful
{
"title": "Christmas is here!",
"body": "<p>New gifts in store for the jolly season</p>"
}

Responses

200

successful

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.

401

Unauthorized

404

Article Not Found

Response samples
200
401
404
application/json
successful
{
"id": "629",
"type": "article",
"workspace_id": "this_is_an_id38_that_should_be_at_least_4",
"parent_id": 2522,
"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": "Christmas is here!",
"description": "",
"body": "<p class=\"no-margin\">New gifts in store for the jolly season</p>",
"author_id": 991282309,
"state": "published",
"created_at": 1712222873,
"updated_at": 1712222874,
"url": "http://help-center.test/myapp-38/en/articles/629-christmas-is-here"
}