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

Update a glossary term

Replaces glossary term details for a specific term. Send the term text, description, and handling flags that you want to set; text and description are limited to 50 and 500 characters respectively.

3 parameters · 6 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 update.

The glossary term text, definition, and handling flags to set.

descriptionstringoptional
A detailed explanation or definition of the glossary term. Maximum 500 characters.
flagAbbreviationbooleanoptional
Specifies whether the term represents a shortened form of a word or phrase
flagCaseSensitivebooleanoptional
When true, the term matching considers uppercase and lowercase characters as distinct
flagForbiddenTermbooleanoptional
When true, marks this term as prohibited or not recommended for use in translations
flagNonTranslatablebooleanoptional
When true, this term will have the same translation across all target languages
textstringoptional
The glossary term. Maximum 50 characters.

5 status codes
200Returns the updated term and its translation data.
termobjectrequired
translationobjectoptional
400Returned when 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 update the term.
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 update the term, 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. text must be at most 50 characters and description at most 500 characters when provided.