{"command":{"effect":"write","timeoutSeconds":30,"inputSchema":{"type":"object","description":"Stage changes to a published article as a draft by making a PUT request to\n`https://api.intercom.io/articles/<id>/draft`. The live article remains\nunchanged until the draft is published.\n\nThe article must already be published; staging a draft on an article that\nhas never been published returns `422`. That `422` has the short body\n`{ \"errors\": [{ \"message\": \"...\", \"status\": 422 }] }`, with no `type`,\n`request_id` or `code`. Other `422` errors use the standard error format.\n\nOnly text content is staged: `title`, `description`, `body` or\n`body_markdown`, and `author_id`, including per-locale values in\n`translated_content`. Any other field in the request body, such as `state`,\n`parent_id`, `folder_id`, `audience_ids`, the AI availability fields or the\nscheduling fields, is still validated but not applied, so the live article is left untouched. The\nscheduling, state and placement notes on the request schema's other fields\ndo not apply to this endpoint, because those fields are not applied.\n\nRequires the `read_write_articles_scope` OAuth scope.\n","properties":{"headers":{"type":"object","properties":{"Intercom-Version":{"$ref":"#/definitions/intercom_version","enum":["2.17"]}},"required":[],"additionalProperties":false},"path":{"type":"object","properties":{"id":{"type":"integer","examples":[123],"description":"The unique identifier for the article which is given by Intercom."}},"required":["id"],"additionalProperties":false},"body":{"$ref":"#/definitions/update_article_request","examples":[{"title":"Christmas is here!","body":"<p>New gifts in store for the jolly season</p>"}]}},"required":["path"],"additionalProperties":false,"definitions":{"intercom_version":{"description":"Intercom API version.</br>If you omit the header, the API uses the version set in your app package, and 1.0 if none is set.","type":"string","enum":["1.0","1.1","1.2","1.3","1.4","2.0","2.1","2.2","2.3","2.4","2.5","2.6","2.7","2.8","2.9","2.10","2.11","2.12","2.13","2.14","2.15","2.16","2.17"],"examples":["2.17"]},"update_article_request":{"description":"You can Update an Article","type":["object","null"],"title":"Update Article Request Payload","properties":{"title":{"type":"string","description":"The title of the article. For multilingual articles, this will be the title of the default language's content.","examples":["Thanks for everything"]},"description":{"type":"string","description":"The description of the article. For multilingual articles, this will be the description of the default language's content.","examples":["Description of the Article"]},"body":{"type":"string","description":"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`.","examples":["<p>This is the body in html</p>"]},"body_markdown":{"type":"string","description":"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`.","examples":["## Updated heading\n\nNew content.\n"]},"author_id":{"type":"integer","description":"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.","examples":[1295]},"state":{"type":"string","description":"Whether the article will be `published` or will be a `draft`. Omitting this field leaves the publish state unchanged, so a draft stays a draft and an edit to a published article goes live immediately unless that article already has a pending draft or a scheduled publish time is set in the same request. For multilingual articles, this will be the state of the default language's content.","enum":["published","draft"],"examples":["draft"]},"parent_id":{"type":["string","null"],"description":"The id of the collection or section to move the article into. Omitting this field or sending `null` leaves the article's parent unchanged. Send `home` to remove the article from its collection so that it stands alone.","examples":["18"]},"parent_ids":{"type":"array","description":"The ids of the parent collections to place this article in. Send an empty array to remove the article from all collections. When provided, this takes precedence over `parent_id`.","items":{"type":"integer"},"examples":[[18,19]]},"translated_content":{"$ref":"#/definitions/article_translated_content"},"folder_id":{"type":["integer","null"],"description":"The ID of the folder to place this article in, or null to remove it from its folder.","examples":[6]},"audience_ids":{"type":["array","null"],"description":"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.","items":{"type":"integer"},"examples":[[1,2]]},"ai_chatbot_availability":{"type":"boolean","description":"Whether the article should be available for AI Chatbot (Fin). For multilingual articles, this sets the default language's availability.","examples":[true]},"ai_copilot_availability":{"type":"boolean","description":"Whether the article should be available for AI Copilot. For multilingual articles, this sets the default language's availability.","examples":[true]},"ai_sales_agent_availability":{"type":"boolean","description":"Whether the article should be available for AI Sales Agent. For multilingual articles, this sets the default language's availability.","examples":[true]},"scheduled_publish_at":{"type":["string","null"],"format":"date-time","description":"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`.","examples":["2026-12-31T09:00:00Z"]},"scheduled_unpublish_at":{"type":["string","null"],"format":"date-time","description":"ISO 8601 timestamp at which to schedule a future unpublish of the article. The article must already be published; setting `state: \"published\"` in the same request does not count, and the request returns 400 `parameter_invalid`. Combining with `state: \"draft\"` also returns 400 `parameter_invalid`. The value must be strictly in the future; timestamps in the past or equal to the current time are rejected with 400 `parameter_invalid`. Setting `null` cancels a pending unpublish schedule. Sending in the same request as `scheduled_publish_at` returns 400 — only one pending schedule per article. Empty string returns 400 `parameter_invalid`.","examples":["2026-12-31T17:00:00Z"]}}},"article_translated_content":{"title":"Article Translated Content","type":["object","null"],"description":"The Translated Content of an Article. The keys are the locale codes and the values are the translated content of the article.","properties":{"type":{"type":["string","null"],"description":"The type of object - article_translated_content.","enum":[null,"article_translated_content"],"examples":["article_translated_content"]},"ar":{"$ref":"#/definitions/article_content"},"bg":{"$ref":"#/definitions/article_content"},"bs":{"$ref":"#/definitions/article_content"},"ca":{"$ref":"#/definitions/article_content"},"cs":{"$ref":"#/definitions/article_content"},"da":{"$ref":"#/definitions/article_content"},"de":{"$ref":"#/definitions/article_content"},"el":{"$ref":"#/definitions/article_content"},"en":{"$ref":"#/definitions/article_content"},"es":{"$ref":"#/definitions/article_content"},"et":{"$ref":"#/definitions/article_content"},"fi":{"$ref":"#/definitions/article_content"},"fr":{"$ref":"#/definitions/article_content"},"he":{"$ref":"#/definitions/article_content"},"hr":{"$ref":"#/definitions/article_content"},"hu":{"$ref":"#/definitions/article_content"},"id":{"$ref":"#/definitions/article_content"},"it":{"$ref":"#/definitions/article_content"},"ja":{"$ref":"#/definitions/article_content"},"ko":{"$ref":"#/definitions/article_content"},"lt":{"$ref":"#/definitions/article_content"},"lv":{"$ref":"#/definitions/article_content"},"mn":{"$ref":"#/definitions/article_content"},"nb":{"$ref":"#/definitions/article_content"},"nl":{"$ref":"#/definitions/article_content"},"pl":{"$ref":"#/definitions/article_content"},"pt":{"$ref":"#/definitions/article_content"},"ro":{"$ref":"#/definitions/article_content"},"ru":{"$ref":"#/definitions/article_content"},"sl":{"$ref":"#/definitions/article_content"},"sr":{"$ref":"#/definitions/article_content"},"sv":{"$ref":"#/definitions/article_content"},"tr":{"$ref":"#/definitions/article_content"},"vi":{"$ref":"#/definitions/article_content"},"pt-BR":{"$ref":"#/definitions/article_content"},"zh-CN":{"$ref":"#/definitions/article_content"},"zh-TW":{"$ref":"#/definitions/article_content"}}},"article_content":{"title":"Article Content","type":["object","null"],"description":"The Content of an Article.","properties":{"type":{"type":["string","null"],"description":"The type of object - `article_content` .","enum":[null,"article_content"],"examples":["article_content"]},"title":{"type":"string","description":"The title of the article.","examples":["How to create a new article"]},"description":{"type":"string","description":"The description of the article.","examples":["This article will show you how to create a new article."]},"body":{"type":"string","description":"The body of the article in HTML.","examples":["This is the body of the article."]},"body_markdown":{"type":["string","null"],"description":"The body of the article in markdown.","examples":["# How to create a new article\n\nThis is the body of the article.\n"]},"author_id":{"type":"integer","description":"The ID of the author of the article.","examples":["5017691"]},"state":{"type":"string","description":"Whether the article is `published` or is a `draft` .","enum":["published","draft"],"examples":["draft"]},"created_at":{"type":"integer","format":"date-time","description":"The time when the article was created (seconds).","examples":[1663597223]},"updated_at":{"type":"integer","format":"date-time","description":"The time when the article was last updated (seconds).","examples":[1663597260]},"has_unpublished_changes":{"type":"boolean","description":"Whether this locale's published content has unpublished changes staged as a draft on top of its live content.","examples":[false]},"draft_updated_at":{"type":["integer","null"],"format":"date-time","description":"The time, in seconds, when this locale's staged draft was last edited, or `null` when there is no staged draft.","examples":[1663597260]},"url":{"type":"string","description":"The URL of the article."},"audience_ids":{"type":["array","null"],"description":"The list of audience IDs this article content is targeted to for Fin AI Agent. On multilingual help centers this field appears per-locale inside `translated_content`. On single-language help centers it appears at the article root level. Empty array means no audience targeting is set.","items":{"type":"integer"},"examples":[[1,2]]},"ai_chatbot_availability":{"type":"boolean","description":"Whether the article is available for AI Chatbot.","examples":[true]},"ai_copilot_availability":{"type":"boolean","description":"Whether the article is available for AI Copilot.","examples":[true]},"ai_sales_agent_availability":{"type":"boolean","description":"Whether the article is available for AI Sales Agent.","examples":[true]}}}}},"name":"Stage an article draft","id":"intercom.stagearticledraft","example":{"path":{"id":123}},"maxRequests":1,"summary":false}}