Tolgee Octri Demo
PUT/v2/projects/{projectId}/translations

Update translations for an existing key

Updates translations for an existing key in a project. Supply a non-empty key and a translations object mapping language tags to translation text; use namespace and branch to identify the key location. The response includes the key identifier and the translations changed by the request.

1 parameter · 5 body fields
projectIdintegerrequired
The numeric identifier of the project containing the key to update.

Existing key details and translations to update. Include both key and translations.

branchstringoptional
Branch name to set translations for
keystringrequired
Key name to set translations for
languagesToReturnarray<string>optional
List of languages to return translations for. If not provided, only modified translation will be provided.
namespacestringoptional
The namespace of the key. (When empty or null default namespace will be used)
translationsobjectrequired
Object mapping language tag to translation

5 status codes
200Returns the key identifier, name, namespace, plural status, and translations updated by the request.
keyIdintegerrequired
Id of key record
keyIsPluralbooleanrequired
keyNamestringrequired
Name of key
keyNamespacestringoptional
The namespace of the key
translationsobjectrequired
Translations object containing values updated in this request
400Returned when the request is invalid, including when `key` or `translations` is missing or `key` is empty.
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 is not permitted to edit the project translations.
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 is not found.
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 the update request is invalid, a 401 when the request is unauthenticated, a 403 when the authenticated user cannot edit the project, and a 404 when the project or key is not found. The projectId path parameter must identify the project. The body must include key and translations; key must contain at least one character.