Propose a change to an entry
propose_entry_changeIdempotent
Propose a change for a reviewer to decide — for any entry you may propose to, including ones you could edit live; nothing changes until a person approves it. Give only what changes; null clears a field. qid proposes linking the entry to a Wikidata item, or a different one (null: unlink it), with adopt naming the fields the item may manage (left out: the server’s default on a first link, unchanged on a re-point); only a reviewer with Manage entries may approve that. note tells the reviewer why. Audited. Dry run by default: it names the entries already on the item.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| qid | No | The Wikidata item to link the entry to, e.g. "Q42" (a different one re-points it); null unlinks it. | |
| note | No | Why you propose this, in plain words: posted as the proposal’s first comment, which the reviewer reads with it. At most 2,000 characters. Never an internal tracking ID (a backlog or ticket number); a VHID is fine. | |
| adopt | No | With qid: the fields the item may manage; the rest are taken back by the site. | |
| entry | Yes | The entry: its VHID (11 digits), its short name (as in verifiedhandles.org/<short>), or its Wikidata QID (Q42). | |
| short | No | ||
| title | No | ||
| dry_run | No | true (the default): write nothing — show the change and the exact request it would send. false: make the change. | |
| gallery | No | The images after the lead: the whole ordered list of media ids, replacing the gallery; [] empties it. At most 5, each once, never the lead. | |
| subtitle | No | ||
| add_handles | No | ||
| clear_image | No | true: take the lead image off. At most one of image_media_id, image_commons_token and clear_image. | |
| description | No | ||
| handle_order | No | Every handle, in the order the entry should show them: exactly the entry’s handles after add_handles and remove_handles, each once (a masked email by its ref). | |
| image_media_id | No | A new lead image already on the site (media_catalog, get_entry), or one you uploaded held for this proposal (upload_image or upload_image_from_url with hold: true): only its uploader may propose a held image, and the approval releases it. | |
| remove_handles | No | Handles to take off, each by its value — or, for an email this key may not see (value null in get_entry’s editing.handles), by {platform_id: "email", ref}. | |
| idempotency_key | No | Optional: a key you choose (1–255 printable ASCII, e.g. a UUID), sent as the write’s Idempotency-Key. Calling again with the same key and the same change within 24 hours answers the first call’s result (replayed: true) and writes nothing; the same key with another change is refused (422). | |
| takeover_fields | No | Fields to take back from the Wikidata sync, keeping their values. | |
| base_revision_id | No | The revision you read (get_entry → editing.baseRevisionId). If the entry has changed since, the edit is refused as a conflict. Left out, the current revision is used. | |
| takeover_handles | No | Handles to take back from the Wikidata sync. | |
| relinquish_fields | No | Fields to hand to the Wikidata sync. | |
| relinquish_handles | No | Handles to hand to the Wikidata sync; only while Wikidata lists the value. | |
| image_commons_token | No | A new lead image from Wikimedia Commons: a hit’s `token` from search_commons_images. The file is recorded on the site first, as the editor’s picker does. | |
| release_held_handles | No | Held-back handles the sync may add back. | |
| credit_wikipedia_page | No | Credit the description “from Wikipedia”: an English Wikipedia article or draft, by title ("Draft:Dominic McLaughlin") or address. The server reads the page (redirects followed) and refuses it unless at least half of the description’s three-word phrases are the page’s lead (credit_text_differs, with the share). | |
| remove_wikipedia_credit | No | true: remove the “from Wikipedia” credit from the description. | |
| credit_let_wikidata_manage | No | With a draft named in credit_wikipedia_page: false keeps the description site-authored. By default a draft’s credit hands the description to the Wikidata sync, which leaves it alone until the draft is an article linked from the entry’s Wikidata item. |
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. |