Intercom API (unofficial showcase)
POST/internal_articles

Create an internal article

Creates an internal article with the supplied content and ownership details. Supply title, owner_id, and author_id; provide content as either body in HTML or body_markdown in Markdown, not both.

  • IdempotentThe SDK sends Idempotency-Key, so a retried request is only applied once.

1 parameter · 10 body fields
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 details. title, owner_id, and author_id are required; provide content in either body or body_markdown, not both.

titlestringrequired
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_idintegerrequired
The id of the author of the article.
owner_idintegerrequired
The id of the owner of the article.
folder_idintegeroptional
The ID of the folder to place this article in, or null to leave it without a folder.
audience_idsarray<integer>optional
The list of audience IDs to target this internal article to for Fin AI Agent. Pass an empty array or omit the field for no audience targeting. 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). Defaults to false.
Default:false
ai_copilot_availabilitybooleanoptional
Whether the internal article should be available for AI Copilot. Defaults to false.
Default:false
ai_sales_agent_availabilitybooleanoptional
Whether the internal article should be available for AI Sales Agent. Defaults to false.
Default:false

3 status codes
200Returns the created internal article, including its article details and identifiers.
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.
400Returned when the request is invalid, such as when required fields are missing or mutually exclusive content fields are both supplied.

One documented failure

  • parameter_not_found

    author_id must be in the main body or default locale translated_content object

typestringrequired
The type is error.list
request_idstringoptional
errorsarray<object>required
An array of one or more error objects
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

Error handling

title, owner_id, and author_id are required. Provide either body or body_markdown, not both; each audience_ids value must identify an existing audience. A 400 is returned when the request is invalid, and a 401 is returned when the request is not authorized.