Edit an article
update_article_draftDestructiveIdempotent
Save a new version of an article, as the console’s Save does: only the fields given change, over the article’s own (null clears one). A draft changes at once. A live (or scheduled) article changes at once for a key whose account may publish (modified: true moves its visible “Updated” date); for any other key the save waits for a publisher, and readers keep the words they see now. The slug of an article that has been published changes only with change_article_slug. Audited with the key and the tool. Dry run by default: it shows what changes, the cleaned HTML of a new body, its links and what the allowlist took out, and whether the save would wait.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| dek | No | ||
| body | No | The article’s text, in Markdown by default (body_format). A link to an entry is [Name](/<VHID>): it shows the entry’s current name while its text is that name. A heading “#” becomes a second-level heading (the title is the first). Raw HTML in Markdown is shown as text. | |
| slug | No | The address’s last part: lower-case letters and digits in words split by single hyphens (e.g. "x-drops-legacy-checkmarks"), at most 80, never 11 digits. | |
| title | No | ||
| topic | No | A News article’s one topic: "verification" (Verification), "impersonation" (Impersonation and scams), "official-accounts" (Official accounts), "vh-data" (VH data), "vh-updates" (VH updates); or a guide’s group on the guides page: "check" (Check an account), "use" (Use Verified Handles), "contribute" (Get listed and help keep it right), "developers" (Developers and AI). null for none. | |
| article | Yes | The article: its id (list_articles), its address ("/news/<slug>", "/guides/<slug>" or the full URL), or its slug alone. | |
| authors | No | The byline, in order: each author is an entry (VHID, short name or QID), at most 10. Whoever publishes may pick it again then. | |
| dry_run | No | true (the default): write nothing — show the change and the exact request it would send. false: make the change. | |
| summary | No | Why, in a few plain words, kept with the revision in the article’s history. Never an internal tracking ID. | |
| hero_alt | No | The hero image’s alt text: what it shows, for a reader who cannot see it. Only with a hero image. | |
| modified | No | A live article, saved by a publisher: true when this change matters to a reader, so its “Updated” date moves. | |
| body_format | No | "markdown" (the default) or "html": how `body` is written. Either is stored as cleaned HTML, through the site’s allowlist. | markdown |
| hero_media_id | No | The hero image: an uploaded image’s media id (upload_image, or media_catalog); null for none. |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| note | No | A dry run: what to do next to make the change, in words. | |
| result | No | A real run: the route’s own answer, where the tool adds facts of its own beside it. | |
| confirm | No | A dry run of a change that needs it: the exact target to send back as `confirm` with dry_run: false. | |
| dry_run | No | true: a dry run, which wrote nothing. Absent from a real run. | |
| replayed | No | A real run with an idempotency_key already used for this change: the first call’s answer, given back; nothing was written now. | |
| would_send | No | A dry run: the exact request the real run would send (`method`, `path`, any `headers` such as an Idempotency-Key, and its `body`, `form` or `query`), or the requests, in order. | |
| may_edit_live | No | A dry run of a live edit: whether this key’s account may edit this entry live. | |
| refused_because | No | A dry run the real run would be refused for: why, in words. |