hosting
POST /v1/sites/{site_id}/translation/sources
The site tells us every translatable string it has.
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/sources \
-H "Authorization: Bearer zdk_live_…" \
-H "Content-Type: application/json" \
-d '{ "documents": <SiteTranslationSourceDocument[]> }'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
The push counterpart of `refreshSiteTranslation`, and it exists because a REST read of a WordPress post returns four fields — title, body, excerpt, slug — and a site is made of far more than that. Product attributes, variation names, category descriptions, menu labels, image alt text and every SEO field Yoast or Rank Math keeps in post meta are invisible to that read, and between them they are most of the words a visitor actually looks at. The Zinn® Translate plugin runs inside WordPress, enumerates all of it, and submits it here. **This is a point of spend**, so it asks entitlement, good standing (`CLAUDE.md` §2.46) and the tier allowance before registering anything, exactly as the pull path does and through the same helper. A `402` means the account is on hold, or the site holds more words than the tier covers. **The submission is the complete inventory, not a delta**, and that is load-bearing: anything the site does NOT send is retired (`CLAUDE.md` §2.52), so a deleted page stops being translated instead of being paid for for ever. Sending a partial list therefore deletes the translations of everything you left out. Registration is idempotent at the same content hash, so re-submitting an unchanged site costs nothing. Requires `sites.manage`.
Parameters
| Name | Type | Required | What it is |
|---|---|---|---|
site_id (path) | Uuid | Yes | — |
Idempotency-Key (header) | string | No | Client-generated key that makes an unsafe request replay-safe: the server stores the first response and returns it verbatim for repeats. |
Request body
| Name | Type | Required | What it is |
|---|---|---|---|
documents | SiteTranslationSourceDocument[] | Yes | — |
Response
| Name | Type | Required | What it is |
|---|---|---|---|
documents | integer | Yes | — |
words | integer | Yes | — |
fields_registered | integer | Yes | — |
fields_retired | integer | Yes | Sources 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_standing | boolean | No | §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. |
refused | string | No | Why nothing was read, empty when it was. |
Errors this endpoint can return
401 · 402 · 403 · 404 · 422 · 429