hosting

PATCH /v1/sites/{site_id}/translation

Choose which languages this site serves to visitors.

Todos os endpoints de hosting

Autenticação

Envie uma chave de API como um token de portador. A chave deve ter a permissão sites.manage; uma chave sem ela é recusada com 403, e não 404.

Este endpoint não requer um ID de organização. Sua chave já identifica a organização à qual pertence, e a resposta é delimitada a ela.

Experimente

Substitua qualquer item entre colchetes por seus próprios valores e o espaço reservado para a chave por uma chave do seu painel.

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[]> }'

Conectado? O console da API no seu painel preenche o ID da sua organização real e a sua própria chave, e executa a requisição contra a API de produção para que você possa ver a resposta real. Abra este endpoint no console da API

Detalhes

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

Parâmetros

NomeTipoObrigatórioO que é
site_id (path)UuidSim

Corpo da requisição

NomeTipoObrigatórioO que é
served_localesLocaleCode[]SimThe languages this site publishes. An empty list means none — never "all".

Resposta

NomeTipoObrigatórioO que é
site_idUuidSimUUIDv7 identifier — sortable by creation time (docs/02 §8).
statestring<disabled, active, paused_standing, over_allowance>Sim⛔ `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.
tierSiteTranslationTierSim
available_tiersSiteTranslationTier[]SimThe ladder, so the screen never hardcodes a price.
word_countintegerSimTranslatable words measured at the last read.
document_countintegerSim
last_extracted_atstringNãoWhen 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_errorstringNãoWhy the last pass did nothing, in words the customer can act on.
localesSiteTranslationLocale[]Sim

Erros que este endpoint pode retornar

401 · 403 · 404 · 422