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

Update Internal Article Request Payload

You can Update an Internal Article

titlestring

The title of the article.

Example:"Thanks for everything"
bodystring

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

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:"## Updated\n\nNew content.\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. If none of body, body_markdown and json_blocks is provided, the existing content is kept.

localestring

The locale of the article. If omitted, the existing locale is kept.

Example:"en"
author_idinteger

The id of the author of the article.

Example:1295
owner_idinteger

The id of the author of the article.

Example:1295
folder_idinteger or null

The ID of the folder to place this article in. Pass null to remove it from its folder. If omitted, the folder is unchanged.

Example:6
audience_idsArray of integers or null

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.

Example:
[
  1,
  2
]
ai_chatbot_availabilityboolean

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

Example:true
ai_copilot_availabilityboolean

Whether the internal article should be available for AI Copilot.

Example:true
ai_sales_agent_availabilityboolean

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

Example:true
{
  "title": "Thanks for everything",
  "body": "string",
  "body_markdown": "## Updated\n\nNew content.\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
}