provider Articles PUT /articles/{article_id}
@utdk/intercom /articles/{article_id}
Update an article
You can update the details of a single article by making a PUT request to `https://api.intercom.io/articles/<id>`. > 📘 Tags cannot be managed via the Articles API > > Article tags are read-only in responses. To create, update, or delete tags, use the Intercom UI or the Tags API endpoints.
Intercom-Version header
enum: 1.0, 1.1, 1.2, 1.3…
article_id path required
The unique identifier for the article which is given by Intercom.
integer

Try it

Authentication
Configure credentials for Intercom API
Gateway
The gateway proxies requests and injects credentials server-side. Configure credentials above, then enter your gateway URL.

Saved automatically to browser storage.

updatearticle
PUT/articles/{article_id}
You can update the details of a single article by making a PUT request to `https://api.intercom.io/articles/<id>`. > 📘 Tags cannot be managed via the Articles API > > Article tags are read-only in responses. To create, update, or delete tags, use the Intercom UI or the Tags API endpoints.

Parameters

required

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

Input

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

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

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

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.

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.

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

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

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

Enter a gateway URL above to enable sending.

Code snippet
Updates live as you fill in the form above.

TypeScript

import intercom from '@utdk/intercom';

await intercom.updatearticle({
  "Intercom-Version": "2.14"
})