Tolgee Octri Demo
PUT/v2/projects/{projectId}/keys/{id}

Edit a localization key

Replaces the editable details of a localization key in a project. Supply name and any other supported fields to update; the name cannot be empty, and the namespace is read-only. Empty or null branch values select the default branch.

2 parameters · 5 body fields
idintegerrequired
The integer ID of the key to edit.
projectIdintegerrequired
The integer ID of the project containing the key.

Key properties to update; name is required.

branchstringoptional
The branch of the key. (When empty or null default branch will be used)
descriptionstringoptional
Description of the key
maxCharLimitintegeroptional
Maximum character limit for translations of this key. Null means no limit.
namestringrequired
The key name. Must contain at least one character.
namespacestringoptional
The namespace of the key. (When empty or null default namespace will be used)

5 status codes
200Returns the updated key object, including its ID and name, and available branch, custom values, description, maximum character limit, and namespace.
branchstringoptional
Branch of key
customobjectoptional
Custom values of the key
descriptionstringoptional
Description of key
idintegerrequired
Id of key record
maxCharLimitintegeroptional
Maximum character limit for translations of this key
namestringrequired
Name of key
namespacestringoptional
Namespace of key
400Returned when the required name is missing or empty, the description exceeds 2,000 characters, or `maxCharLimit` is below 1.
codestringrequired
Allowed:unauthenticatedapi_access_forbiddenapi_key_not_foundinvalid_api_keyinvalid_project_api_keyproject_api_key_expiredbad_credentialsmfa_enabledinvalid_otp_codemfa_not_enabledcan_not_revoke_own_permissionsdata_corrupted
paramsarray<object>optional
401Returned when the request is unauthenticated.
codestringrequired
Allowed:unauthenticatedapi_access_forbiddenapi_key_not_foundinvalid_api_keyinvalid_project_api_keyproject_api_key_expiredbad_credentialsmfa_enabledinvalid_otp_codemfa_not_enabledcan_not_revoke_own_permissionsdata_corrupted
paramsarray<object>optional
403Returned when the authenticated user does not have permission to edit the key.
codestringrequired
Allowed:unauthenticatedapi_access_forbiddenapi_key_not_foundinvalid_api_keyinvalid_project_api_keyproject_api_key_expiredbad_credentialsmfa_enabledinvalid_otp_codemfa_not_enabledcan_not_revoke_own_permissionsdata_corrupted
paramsarray<object>optional
404Returned when the project or key does not exist.
codestringrequired
Allowed:unauthenticatedapi_access_forbiddenapi_key_not_foundinvalid_api_keyinvalid_project_api_keyproject_api_key_expiredbad_credentialsmfa_enabledinvalid_otp_codemfa_not_enabledcan_not_revoke_own_permissionsdata_corrupted
paramsarray<object>optional

Error handling

A 400 is returned when name is missing or empty, description exceeds 2,000 characters, or maxCharLimit is less than 1. A 401 is returned when the request is unauthenticated, a 403 when the authenticated user lacks permission, and a 404 when the project or key cannot be found. The id path parameter must identify the key, and name must contain at least one character; do not send namespace, which is read-only.