hosting
PATCH /v1/sites/{site_id}/translation
Choose which languages this site serves to visitors.
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 PATCH https://api.zinndigital.com/v1/sites/{site_id}/translation \
-H "Authorization: Bearer zdk_live_…" \
-H "Content-Type: application/json" \
-d '{ "served_locales": <LocaleCode[]> }'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
Sets `served_locales` — the languages whose URLs the site publishes. **This does not buy or spend anything.** Every language is translated already: the tier includes all of them and the words were paid for at extraction, so switching one on is instant and switching one off costs nothing and destroys nothing. It is a publishing decision, not a purchase, which is why it needs `sites.manage` and not a billing scope. ⛔ An empty list means the site serves **no** translated URLs — it does not mean "all". Publishing 57 new indexed URL trees on someone's domain because a field was empty is an SEO event they did not ask for and cannot easily undo. A locale that is not in the platform's registry is a `422` naming it, never a silent drop: a typo that vanishes is how a customer waits a week for a language they believe they enabled. Requires `sites.manage`.
Parameters
| Name | Type | Required | What it is |
|---|---|---|---|
site_id (path) | Uuid | Yes | — |
Request body
| Name | Type | Required | What it is |
|---|---|---|---|
served_locales | LocaleCode[] | Yes | The languages this site publishes. An empty list means none — never "all". |
Response
| Name | Type | Required | What it is |
|---|---|---|---|
site_id | Uuid | Yes | UUIDv7 identifier — sortable by creation time (docs/02 §8). |
state | string<disabled, active, paused_standing, over_allowance> | Yes | ⛔ `paused_standing` is its own state, not a flavour of `disabled` — the remedies differ and only one of them is the customer's to act on. |
tier | SiteTranslationTier | Yes | — |
available_tiers | SiteTranslationTier[] | Yes | The ladder, so the screen never hardcodes a price. |
word_count | integer | Yes | Translatable words measured at the last read. |
document_count | integer | Yes | — |
last_extracted_at | string | No | When we last successfully read the site. ⛔ Distinct from the attempt cursor the sweep keeps: a failed pass advances that and must not move this, or the screen would report a sit… |
last_error | string | No | Why the last pass did nothing, in words the customer can act on. |
locales | SiteTranslationLocale[] | Yes | — |
Errors this endpoint can return
401 · 403 · 404 · 422