hosting

POST /v1/sites/{site_id}/translation/refresh

Read the site again now, rather than waiting for the next pass.

All hosting endpoints

Authentication

Send an API key as a bearer token. The key must carry the sites.manage permission; a key without it is refused with 403, not 404.

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 POST https://api.zinndigital.com/v1/sites/{site_id}/translation/refresh \
  -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

Re-reads the site's pages and posts and registers anything new or changed. The sweep does this on its own cadence; this is the button for a customer who has just published something and wants it translated now. **This is a point of spend**, so it asks good standing (`CLAUDE.md` §2.46) and the tier allowance before it reads anything. A `402` means the account is on hold — the body says so and says that it resumes automatically — or that the site now holds more words than the tier covers, with both numbers. Idempotent in the way that matters: content already registered at the same hash is a no-op that marks nothing stale and translates nothing again, so pressing the button twice costs nothing. Requires `sites.manage`.

Parameters

NameTypeRequiredWhat it is
site_id (path)UuidYes
Idempotency-Key (header)stringNoClient-generated key that makes an unsafe request replay-safe: the server stores the first response and returns it verbatim for repeats.

Response

NameTypeRequiredWhat it is
documentsintegerYes
wordsintegerYes
fields_registeredintegerYes
fields_retiredintegerYesSources removed because the site no longer has them. Reported rather than silent: a destructive step that says nothing is indistinguishable from one that did nothing.
skipped_not_in_good_standingbooleanNo§2.46 — counted and surfaced, never silent. `documents: 0` because the account is on hold looks identical to a pass that could not see any work.
refusedstringNoWhy nothing was read, empty when it was.

Errors this endpoint can return

401 · 402 · 403 · 404 · 429