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

Create a glossary term

Creates a glossary term in the specified glossary. Provide its text, description, and four boolean flags to define how the term should be handled. The response includes the created term and its translation data.

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

2 parameters · 6 body fields
organizationIdintegerrequired
The unique identifier of the organization that owns the glossary.
glossaryIdintegerrequired
The unique identifier of the glossary to add the term to.

The glossary term text, definition, and handling flags.

descriptionstringrequired
A detailed explanation or definition of the glossary term
flagAbbreviationbooleanrequired
Specifies whether the term represents a shortened form of a word or phrase
flagCaseSensitivebooleanrequired
When true, the term matching considers uppercase and lowercase characters as distinct
flagForbiddenTermbooleanrequired
When true, marks this term as prohibited or not recommended for use in translations
flagNonTranslatablebooleanrequired
When true, this term will have the same translation across all target languages
textstringrequired
The glossary term. Maximum 50 characters.

5 status codes
200Returns the created term and its translation data.
termobjectrequired
translationobjectoptional
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 add terms to the glossary.
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 or glossary 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 add terms to the glossary, and a 404 is returned when the organization or glossary is not found. The organizationId and glossaryId path parameters must identify the organization and glossary. text, description, flagAbbreviation, flagCaseSensitive, flagForbiddenTerm, and flagNonTranslatable are required; text must be at most 50 characters and description at most 500 characters.