PUT
Set a translation for one field in one locale

Authorizations

Authorization
string
header
required

A secret API key. Publishable keys cannot reach this API. A key may carry an expiry, and an expired key is refused exactly like an unknown one, with a 401 that names no reason; check the key's expires_at in the dashboard rather than inferring it from a response. When a merchant rolls a key's secret they choose a grace window of up to 3 days, and for its duration BOTH the new secret and the one it replaced authenticate, so an integration moves over on its own deploy schedule instead of at the instant the button is pressed. Move before the window closes: after it, the old secret is refused. Nothing else about this contract moves with a roll. The key keeps its id and its scopes, so the only thing an integration updates is the credential itself.

Headers

Idempotency-Key
string
required

A unique key per logical write. Replaying a request with the same key returns the first response byte for byte instead of applying the write twice.

Body

application/json

An UPSERT on (resource_type, resource_id, field, locale), so replaying the same request converges rather than accumulating. The locale must already be enabled on the store; one that is not answers 409, and GET /api/v1/locales is the enabled set. Every write through this route is recorded with origin=manual, and that cannot be opted out of: the store's own auto-translate skips manual rows so it never clobbers a human, so a row written here is permanently exempt from retranslation. origin is published on the read so the effect is visible.

resource_type
enum<string>
required
Available options:
product,
collection,
category,
page
resource_id
string
required
field
string
required
locale
string
required

Must be enabled on the store. See GET /api/v1/locales.

value
string
required

The translated text. May NOT be empty: the storefront applies whatever is stored, so "" would render a blank to shoppers rather than falling back to the source. Removing the translation is what restores the source text, and that is the DELETE.

source
string
required

The CURRENT source text this value translates, and it is required. Staleness is decided by comparing the recorded source against the live one, and a row with no recorded source can never be PROVEN stale, so it would be served forever even after the merchant rewrote the source.

Response

Success

data
object