links

GET /v1/link-edits/{editId}

One bulk edit, and what happened on every site.

All links endpoints

Authentication

Send an API key as a bearer token. This endpoint does not state a specific permission in the specification, so give your key the least it needs and check the response rather than assuming.

This endpoint takes no organisation id. Your key already identifies the organisation it belongs to, and the response is scoped to it.

Try it

Replace anything in angle brackets with your own values, and the key placeholder with a key from your dashboard.

curl -X GET https://api.zinndigital.com/v1/link-edits/{editId} \
  -H "Authorization: Bearer zdk_live_…"

Signed in? The API console in your dashboard fills in your real organisation id and your own key, and runs the request against the live API so you can see the actual response. Open this endpoint in the API console

Details

Poll this while `status` is `pending` or `running`. Each entry in `items` is one site, and it carries the exact strings that were replaced — an edit screen that reports "197 links changed" and cannot show you one of them is asking to be trusted rather than checked. Gated on `links.view`: reading what was done is reading.

Parameters

NameTypeRequiredWhat it is
editId (path)stringYesThe bulk edit's id.

Response

NameTypeRequiredWhat it is
idstringYes
target_idstringNo
target_hoststringYesThe host as it read when the edit was made. Kept as a string as well as a key, because a rewrite can empty a target of its last link and an audit line reading "edited (deleted t…
actionstring<rewrite, unlink>Yes
new_hrefstringNo
new_textstringNoNew visible text. Empty means *keep whatever each link already says* — which is the common case, because one target's links carry many different anchors and flattening them all…
statusstring<pending, running, applied, partial, failed>Yes`partial` is the honest answer when some sites succeeded and some did not, and it exists because the other two are lies in that case: an operator's next action depends entirely…
expected_linksintegerYesWhat the operator was told would change, **recorded when they confirmed it** rather than recomputed later. The whole value of a confirmation is that it can be held up against th…
expected_postsintegerYes
expected_sitesintegerYes
undo_ofstringNoThe edit this one reverses, if any.
undone_bystringNoThe edit that has already reversed this one. Present so the screen offers undo once — two undos of one edit put the original change back.
created_atstringYes
finished_atstringNo
itemsLinkEditItem[]No

Errors this endpoint can return

401 · 403 · 404