Tolgee Octri Demo
POST/v2/organizations/{organizationId}/glossaries/{glossaryId}/terms/{termId}/translations

Set a glossary term translation

Sets a translation for a glossary term in a specified language. Supply languageTag and text to create or update the translation; the language tag cannot contain a comma and is limited to 20 characters.

  • IdempotentThe SDK sends Idempotency-Key, so a retried request is only applied once.

3 parameters · 2 body fields
organizationIdintegerrequired
The unique identifier of the organization that owns the glossary.
glossaryIdintegerrequired
The unique identifier of the glossary containing the term.
termIdintegerrequired
The unique identifier of the term to translate.

The language tag and translated text for the glossary term.

languageTagstringrequired
Language tag according to BCP 47 definition
textstringrequired
Translation text

5 status codes
200Returns the language tag and translation text that were set.
languageTagstringrequired
textstringrequired
400Returned when a required field is missing or a field value fails validation.
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 authentication is missing or invalid.
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 modify the translation.
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 organization, glossary, or term 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 request is invalid. A 401 is returned when authentication is missing or invalid. A 403 is returned when the authenticated user cannot modify the translation, and a 404 is returned when the organization, glossary, or term is not found. The organizationId, glossaryId, and termId path parameters must identify the organization, glossary, and term. languageTag and text are required; languageTag must be at most 20 characters and contain no commas, and text must be at most 50 characters.