Intercom API (unofficial showcase)
PUT/internal_articles/{internal_article_id}

Update an internal article

Updates an existing internal article's details and configuration. Supply only the fields to change; provide content in either body or body_markdown, and pass an empty audience_ids array to clear existing audience memberships.

2 parameters · 10 body fields
internal_article_idintegerrequired
The unique integer identifier of the internal article to update.
Intercom-Versionstringoptional
The Intercom API version to use. Defaults to 2.17 when omitted.
Allowed:1.01.11.21.31.42.02.12.22.32.42.52.6Default:2.17

Internal article fields to update. Omitted fields remain unchanged; provide content in either body or body_markdown, not both.

titlestringoptional
The title of the article.
bodystringoptional
The content of the article in HTML. Mutually exclusive with `body_markdown`.
body_markdownstringoptional
The content of the article in markdown. An alternative to `body` — you can provide content as markdown instead of HTML. Mutually exclusive with `body`.
author_idintegeroptional
The id of the author of the article.
owner_idintegeroptional
The id of the author of the article.
folder_idintegeroptional
The ID of the folder to place this article in, or null to remove it from its folder.
audience_idsarray<integer>optional
The list of audience IDs to target this internal article to for Fin AI Agent. Omitting the field leaves existing audience memberships unchanged (PATCH semantics). Pass `[]` to clear all audience memberships. Unknown audience IDs return a `404` error with no partial commit.
ai_chatbot_availabilitybooleanoptional
Whether the internal article should be available for AI Chatbot (Fin).
ai_copilot_availabilitybooleanoptional
Whether the internal article should be available for AI Copilot.
ai_sales_agent_availabilitybooleanoptional
Whether the internal article should be available for AI Sales Agent.

3 status codes
200Returns the updated internal article object with its article details.
typestringoptional
The type of object - `internal_article`.
Allowed:internal_articleDefault:internal_article
idstringoptional
The unique identifier for the article which is given by Intercom.
titlestringoptional
The title of the article.
bodystringoptional
The body of the article in HTML.
body_markdownstringoptional
The body of the article in markdown.
owner_idintegeroptional
The id of the owner of the article.
author_idintegeroptional
The id of the author of the article.
created_atintegeroptional
The time when the article was created.
updated_atintegeroptional
The time when the article was last updated.
localestringoptional
The default locale of the article.
folder_idintegeroptional
The ID of the folder this article belongs to, or null if not in a folder.
audience_idsarray<integer>optional
The list of audience IDs this internal article is targeted to for Fin AI Agent. Empty array means no audience targeting is set.
ai_chatbot_availabilitybooleanoptional
Whether the internal article is available for AI Chatbot (Fin).
ai_copilot_availabilitybooleanoptional
Whether the internal article is available for AI Copilot.
ai_sales_agent_availabilitybooleanoptional
Whether the internal article is available for AI Sales Agent.
401Returned when the request is not authorized.

One documented failure

  • unauthorized

    Access Token Invalid

typestringrequired
The type is error.list
request_idstringoptional
errorsarray<object>required
An array of one or more error objects
404Returned when the internal article or a supplied audience does not exist.

One documented failure

  • not_found

    Resource Not Found

typestringrequired
The type is error.list
request_idstringoptional
errorsarray<object>required
An array of one or more error objects

Error handling

A 401 is returned when the request is not authorized. A 404 is returned when the article does not exist or a supplied audience_ids value does not identify an existing audience. The internal_article_id path parameter identifies the article to update; provide body or body_markdown, not both.