Skip to content
Home/
REST API Reference
/
/
Create Internal Article R...

Create Internal Article Request Payload

You can create an Internal Article

titlestringrequired

The title of the article.

Example:"Thanks for everything"
bodystring

The content of the article in HTML. Mutually exclusive with body_markdown.

Example:"<p>This is the body in html</p>"
body_markdownstring

The content of the article in markdown. An alternative to body — you can provide content as markdown instead of HTML. Mutually exclusive with body and json_blocks.

Example:"# Internal Guide\n\nSome instructions.\n"
json_blocksArray of objects

The content of the article as a list of content blocks. Used only when body is not provided. Cannot be combined with body_markdown.

localestring

The locale of the article. Defaults to en.

Example:"en"
author_idintegerrequired

The id of the author of the article.

Example:1295
owner_idintegerrequired

The id of the owner of the article.

Example:1295
folder_idinteger or null

The ID of the folder to place this article in. Pass null to leave it without a folder.

Example:6
audience_idsArray of integers or null

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.

Example:
[
  1,
  2
]
ai_chatbot_availabilityboolean

Whether the internal article should be available for AI Chatbot (Fin). Defaults to false.

Default:false
Example:true
ai_copilot_availabilityboolean

Whether the internal article should be available for AI Copilot. Defaults to false.

Default:false
Example:true
ai_sales_agent_availabilityboolean

Whether the internal article should be available for AI Sales Agent. Defaults to false.

Default:false
Example:true
{
  "title": "Thanks for everything",
  "body": "<p>This is the body in html</p>",
  "body_markdown": "# Internal Guide\n\nSome instructions.\n",
  "json_blocks": [
    {}
  ],
  "locale": "en",
  "author_id": 1295,
  "owner_id": 1295,
  "folder_id": 6,
  "audience_ids": [
    1,
    2
  ],
  "ai_chatbot_availability": true,
  "ai_copilot_availability": true,
  "ai_sales_agent_availability": true
}