hosting

PATCH /v1/sites/{site_id}/translation

Choose which languages this site serves to visitors.

Tutti gli endpoint hosting

Autenticazione

Invia una chiave API come token di tipo bearer. La chiave deve disporre dell'autorizzazione sites.manage; una chiave sprovvista di tale autorizzazione viene rifiutata con 403 anziché 404.

Questo endpoint non richiede alcun ID organizzazione. La tua chiave identifica già l'organizzazione a cui appartiene e la risposta è limitata ad essa.

Provalo

Sostituisci qualsiasi elemento tra parentesi angolari con i tuoi valori e il segnaposto key con una chiave dalla tua 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[]> }'

Hai effettuato l'accesso? La console API nella tua dashboard inserisce il tuo ID organizzazione reale e la tua chiave personale, ed esegue la richiesta sull'API live in modo da poter vedere la risposta effettiva. Apri questo endpoint nella console API

Dettagli

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`.

Parametri

NomeTipoObbligatorioChe cos'è
site_id (path)Uuid

Corpo della richiesta

NomeTipoObbligatorioChe cos'è
served_localesLocaleCode[]The languages this site publishes. An empty list means none — never "all".

Risposta

NomeTipoObbligatorioChe cos'è
site_idUuidUUIDv7 identifier — sortable by creation time (docs/02 §8).
statestring<disabled, active, paused_standing, over_allowance>⛔ `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.
tierSiteTranslationTier
available_tiersSiteTranslationTier[]The ladder, so the screen never hardcodes a price.
word_countintegerTranslatable words measured at the last read.
document_countinteger
last_extracted_atstringNoWhen 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_errorstringNoWhy the last pass did nothing, in words the customer can act on.
localesSiteTranslationLocale[]

Errori che questo endpoint può restituire

401 · 403 · 404 · 422