Archive a translation key

Owner/Admin only. Keeps values, history and the reserved key name. Parent workspace/project must be active. Content is scoped to the explicit branch. Branch archives are read-only; current workspace roles still apply.

POST /api/v1/workspaces/{workspaceId}/projects/{projectId}/branches/{branchId}/keys/{keyId}/archive

Operation: archiveTranslationKey · 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
`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"
}

Origin

{
  "type": "string"
}

X-CSRF-Token

{
  "type": "string"
}

branchId

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

Request body

Required: Yes.

application/json

Schema reference: Version.

Field	Type	Required	Constraints / description
`version`	integer	Yes	minimum: `1`; maximum: `2147483646`

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

Example payload (illustrative):

{
  "version": 1
}

Responses

201

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

Content type: application/json Schema reference: TranslationKey.

Field	Type	Required	Constraints / description
`name`	string	Yes	Case-sensitive letters, digits, underscore, hyphen or period. Unique in the project, including archived keys.; minLength: `1`; maxLength: `200`
`format`	`plain`, `icu`	Yes	default: `"plain"`
`parameters`	Array of object	Yes	maxItems: `32`; default: `[]`
`id`	string	Yes	format: `"uuid"`
`workspaceId`	string	Yes	format: `"uuid"`
`projectId`	string	Yes	format: `"uuid"`
`version`	integer	Yes	minimum: `1`; maximum: `2147483646`
`archivedAt`	string or null	Yes	format: `"date-time"`
`createdAt`	string	Yes	format: `"date-time"`
`tags`	Array of object	No	maxItems: `20`

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

400

Invalid request or ICU value; field and locale issues may be included.

Content type: application/json Schema reference: Error.

Field	Type	Required	Constraints / description
`error`	string	Yes	—
`message`	string	Yes	—
`requestId`	string	No	—
`details`	object	No	—
`statusCode`	integer	No	May be included by HTTP-level request limits.

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

401

Sign in to continue.

Content type: application/json Schema reference: Error.

Field	Type	Required	Constraints / description
`error`	string	Yes	—
`message`	string	Yes	—
`requestId`	string	No	—
`details`	object	No	—
`statusCode`	integer	No	May be included by HTTP-level request limits.

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

403

Current role cannot perform this action.

Content type: application/json Schema reference: Error.

Field	Type	Required	Constraints / description
`error`	string	Yes	—
`message`	string	Yes	—
`requestId`	string	No	—
`details`	object	No	—
`statusCode`	integer	No	May be included by HTTP-level request limits.

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

404

Project or key is not visible in the current workspace.

Content type: application/json Schema reference: Error.

Field	Type	Required	Constraints / description
`error`	string	Yes	—
`message`	string	Yes	—
`requestId`	string	No	—
`details`	object	No	—
`statusCode`	integer	No	May be included by HTTP-level request limits.

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

409

Stale version, reserved key name, archive or inactive-language conflict. Compare current data before retrying.

Content type: application/json Schema reference: Error.

Field	Type	Required	Constraints / description
`error`	string	Yes	—
`message`	string	Yes	—
`requestId`	string	No	—
`details`	object	No	—
`statusCode`	integer	No	May be included by HTTP-level request limits.

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

413

Mutation exceeds 1 MiB.

Content type: application/json Schema reference: Error.

Field	Type	Required	Constraints / description
`error`	string	Yes	—
`message`	string	Yes	—
`requestId`	string	No	—
`details`	object	No	—
`statusCode`	integer	No	May be included by HTTP-level request limits.

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

429

Request limit exceeded.

Content type: application/json Schema reference: Error.

Field	Type	Required	Constraints / description
`error`	string	Yes	—
`message`	string	Yes	—
`requestId`	string	No	—
`details`	object	No	—
`statusCode`	integer	No	May be included by HTTP-level request limits.

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

503

A required service is unavailable; no successful change is claimed.

Content type: application/json Schema reference: Error.

Field	Type	Required	Constraints / description
`error`	string	Yes	—
`message`	string	Yes	—
`requestId`	string	No	—
`details`	object	No	—
`statusCode`	integer	No	May be included by HTTP-level request limits.

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

Request errors and safe retries · Troubleshooting