Update Article Request Payload

REST API Reference

You can Update an Article

titlestring

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

Example:"Thanks for everything"

descriptionstring

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

Example:"Description of the Article"

bodystring

The content of the article in HTML. For multilingual articles, this will be the body of the default language's content. Mutually exclusive with body_markdown.

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

body_markdownstring

The content of the article in markdown. For multilingual articles, this will be the body of the default language's content. An alternative to body — you can provide content as markdown instead of HTML. Mutually exclusive with body.

Example:"## Updated heading\n\nNew content.\n"

author_idinteger

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.

Example:1295

statestring

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.

Enum:"published""draft"

Example:"draft"

parent_idstring

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

Example:"18"

parent_typestring

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

Example:"collection"

translated_contentobject or null(Article Translated Content)

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

audience_idsArray of integers or null

The list of audience IDs to assign to this article for Fin AI Agent targeting. Sending a top-level audience_ids broadcasts the same set to every locale. Sending audience_ids: [] clears all audience memberships from every locale. For per-locale targeting, use translated_content.<locale>.audience_ids instead. Sending both top-level and per-locale in the same request causes top-level to win. Unknown audience IDs return a 404 error. No partial commit occurs.

Example:

[
  1,
  2
]

ai_chatbot_availabilityboolean

Whether the article should be available for AI Chatbot (Fin). For multilingual articles, this sets the default language's availability.

Example:true

ai_copilot_availabilityboolean

Whether the article should be available for AI Copilot. For multilingual articles, this sets the default language's availability.

Example:true

ai_sales_agent_availabilityboolean

Whether the article should be available for AI Sales Agent. For multilingual articles, this sets the default language's availability.

Example:true

scheduled_publish_atstring or null, (date-time)

ISO 8601 timestamp at which to schedule a future publish of the article. When set together with state: "published", the article is scheduled instead of published immediately. Setting null cancels a pending publish schedule. Timestamps in the past or equal to the current time are rejected with 400 parameter_invalid — the value must be strictly in the future. Combining with state: "draft" returns 400 parameter_invalid. Sending in the same request as scheduled_unpublish_at returns 400 — only one pending schedule per article. Empty string returns 400 parameter_invalid.

Example:"2026-12-31T09:00:00Z"

scheduled_unpublish_atstring or null, (date-time)

ISO 8601 timestamp at which to schedule a future unpublish of the article. Setting null cancels a pending unpublish schedule. Timestamps in the past or equal to the current time are rejected with 400 parameter_invalid — the value must be strictly in the future. Rejected with 400 parameter_invalid if the article has never been published. Sending in the same request as scheduled_publish_at returns 400 — only one pending schedule per article. Empty string returns 400 parameter_invalid.

Example:"2026-12-31T17:00:00Z"

{
  "title": "Thanks for everything",
  "description": "Description of the Article",
  "body": "<p>This is the body in html</p>",
  "body_markdown": "## Updated heading\n\nNew content.\n",
  "author_id": 1295,
  "state": "draft",
  "parent_id": "18",
  "parent_type": "collection",
  "translated_content": {
    "type": "article_translated_content",
    "ar": { … },
    "bg": { … },
    "bs": { … },
    "ca": { … },
    "cs": { … },
    "da": { … },
    "de": { … },
    "el": { … },
    "en": { … },
    "es": { … },
    "et": { … },
    "fi": { … },
    "fr": { … },
    "he": { … },
    "hr": { … },
    "hu": { … },
    "id": { … },
    "it": { … },
    "ja": { … },
    "ko": { … },
    "lt": { … },
    "lv": { … },
    "mn": { … },
    "nb": { … },
    "nl": { … },
    "pl": { … },
    "pt": { … },
    "ro": { … },
    "ru": { … },
    "sl": { … },
    "sr": { … },
    "sv": { … },
    "tr": { … },
    "vi": { … },
    "pt-BR": { … },
    "zh-CN": { … },
    "zh-TW": { … }
  },
  "audience_ids": [
    1,
    2
  ],
  "ai_chatbot_availability": true,
  "ai_copilot_availability": true,
  "ai_sales_agent_availability": true,
  "scheduled_publish_at": "2026-12-31T09:00:00Z",
  "scheduled_unpublish_at": "2026-12-31T17:00:00Z"
}