Translation keys

Update translation key

Changed on Nov 7, 2026

Updates key, namespace, and/or it's metadata. It throws an error if translation key does not exist or if the new key/namespace combination already exists.

Use query key and namespace parameters to identify the translation key, and update it with the provided values in the request body.

The last seen date is updated automatically even if there is no changes.

Max size of description and code description is 500 characters, otherwise, the endpoint throws an error.

Set lock: true to prevent the translation key from being modified.

To clear the characters limit, set it to -1.

patch/api/v1/translation-keys

Request

Base URL
https://api.simplelocalize.io
Auth
API key in header X-SimpleLocalize-Token
TypeScript
https://skmtc.dev/simplelocalize/apis/simplelocalize-api/docs/api/v1/translation-keys/patch.ts
A function with typed inputs. Its response is checked against the schema.

Query parameters

keystring required

namespacestring

Request body

keystring

namespacestring

descriptionstring

codeDescriptionstring

charactersLimitinteger

deprecatedboolean

lockboolean

tagsstring[]

attributesobject

Response

Changes

Nov 7, 202667a25a25863a Revision changes
- warning
  deleted the header request parameter x-simplelocalize-client
- info
  added the new optional request property
- info
  added the new optional request property
- info
  added the new optional request property
Nov 12, 20250329534cd557 Revision changes
- warning
  deleted the header request parameter X-SimpleLocalize-Token
- info
  the endpoint scheme security Project API Key was added to the API
- info
  the endpoint scheme security apiKey was removed from the API
- info
  added the new optional header request parameter x-simplelocalize-client
- info
  added the optional property to the response with the status
- info
  added the optional property to the response with the status
- info
  added the optional property to the response with the status
- info
  added the optional property to the response with the status
- info
  added the optional property to the response with the status
- info
  added the optional property to the response with the status
- info
  added the optional property to the response with the status
- info
  added the optional property to the response with the status
- info
  added the optional property to the response with the status
- info
  added the optional property to the response with the status
- info
  added the optional property to the response with the status
- info
  added the optional property to the response with the status
- info
  added the optional property to the response with the status
- info
  added the optional property to the response with the status

Operation history (4 revisions)