Save or clear a value

Owner, Admin or Editor. Language and all parents must be active. Both keyVersion and the cell version must match. Different language cells have independent versions. ICU requires every declared parameter with compatible usage. Limits: 16 KiB UTF-8, 10 nested expressions and 1,000 AST nodes. Content is scoped to the explicit branch. Branch archives are read-only; current workspace roles still apply.

PATCH /api/v1/workspaces/{workspaceId}/projects/{projectId}/branches/{branchId}/keys/{keyId}/values/{locale}

Operation: saveTranslationValue · Download OpenAPI

Access

Requires an authenticated Localisync panel session. The API checks current membership and permissions for workspace operations. See authentication and request rules.

sessionCookie

{
  "type": "apiKey",
  "in": "cookie",
  "name": "__Host-localisync-session",
  "description": "Opaque server session. Local HTTP development uses its explicitly configured development cookie name."
}

Parameters

Name	Location	Required	Description
`workspaceId`	path	Yes
`projectId`	path	Yes
`keyId`	path	Yes
`locale`	path	Yes
`Origin`	header	Yes	Must exactly match the configured panel origin.
`X-CSRF-Token`	header	Yes	Token bound to the current opaque server session.
`branchId`	path	Yes	Explicit branch UUID in this project. No implicit main selection.

workspaceId

{
  "type": "string",
  "format": "uuid"
}

projectId

{
  "type": "string",
  "format": "uuid"
}

keyId

{
  "type": "string",
  "format": "uuid"
}

locale

{
  "type": "string",
  "minLength": 2,
  "maxLength": 255
}

Origin

{
  "type": "string"
}

X-CSRF-Token

{
  "type": "string"
}

branchId

{
  "type": "string",
  "format": "uuid"
}

Request body

Required: Yes.

application/json

Schema reference: SaveValue.

Field	Type	Required	Constraints / description
`value`	string or null	Yes	At most 16 KiB UTF-8. Null, empty or whitespace-only becomes Missing; other whitespace is preserved.; maxLength: `16384`
`version`	integer	Yes	minimum: `0`; maximum: `2147483646`
`keyVersion`	integer	Yes	minimum: `1`; maximum: `2147483646`

{
  "$ref": "#/components/schemas/SaveValue"
}

Example payload (illustrative):

{
  "value": "Payment successful",
  "version": 0,
  "keyVersion": 1
}

Responses

200

Committed result. Responses are private and Cache-Control: no-store.

Content type: application/json Schema reference: TranslationValue.

Field	Type	Required	Constraints / description
`keyId`	string	Yes	format: `"uuid"`
`locale`	string	Yes	minLength: `2`; maxLength: `255`
`value`	string or null	Yes	At most 16 KiB UTF-8. Null, empty or whitespace-only becomes Missing; other whitespace is preserved.; maxLength: `16384`
`version`	integer	Yes	Zero means no stored value yet. Clearing a stored value increments its version.; minimum: `0`
`evidenceId`	string or null	No	Current review evidence, included in matrix cells; null means Unreviewed.; format: `"uuid"`

{
  "$ref": "#/components/schemas/TranslationValue"
}