Update Help Center Article
update_articleDestructiveIdempotent
Update article metadata—draft/publish status, promotion, labels, visibility, section, and sort position—and return the updated article. Content remains unchanged.
Instructions
Update article metadata only (draft, promoted, labels, tags, visibility, section, sort position, etc.) and return the updated article. Does NOT update content (title, body) — use update_article_translation for that.
Input Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| draft | No | Set true to unpublish the article (revert to draft) or false to publish it. | |
| position | No | Sort position within the section (manual ordering only; 0 = first/top). New articles default to position 0. To move an article to the END of its section, set this to one more than the highest current position: read the highest position P from list_articles with sort_by="position", sort_order="desc", then set position = P + 1. | |
| promoted | No | Set true to promote (feature) the article in its section, or false to unpromote it. | |
| author_id | No | User id of the article author (from search_users). | |
| article_id | Yes | Article ID — the numeric id of the article to update. Obtain it from list_articles or search_articles. | |
| section_id | No | Move the article to this section (numeric id from list_sections). | |
| label_names | No | Label names for search ranking (use list_labels to see existing labels). | |
| content_tag_ids | No | Content tag ids to attach (use list_content_tags to find them). | |
| user_segment_id | No | User segment that controls who can see the article (id from list_user_segments; if that is forbidden because the token is not a Guide admin, reuse the user_segment_id of an existing article from get_article). | |
| permission_group_id | No | Guide permission group controlling who can edit (id from list_permission_groups; if that is forbidden because the token is not a Guide admin, reuse the permission_group_id of an existing article from get_article). |