Skip to main content
PATCH
Update a glossary

Authorizations

Authorization
string
header
required

API token: tsu_pat_… (PAT) or tsu_proj_… (project token). The token's granted RBAC permissions determine access; see each operation's x-permission.

Path Parameters

glossaryId
string
required

Glossary id (UUID) or id-embedded path slug.

Body

application/json
name
string

New glossary name.

Required string length: 1 - 100
Example:

"Brand Terms"

description
string | null

New description; pass null to clear it.

Maximum string length: 500
Example:

"Approved product and brand terminology for all UI surfaces."

scope
enum<string>

Change project applicability: all projects or only selected assigned ones.

Available options:
all,
selected
Example:

"selected"

approvalRequired
boolean

Toggle the term-translation approval workflow.

Example:

true

approvalBypassAdmins
boolean

Auto-approve admins' edits while approval is required.

Example:

true

qaTermConsistency
enum<string>

Severity for missing-required-term issues: off, warning, or error.

Available options:
off,
warning,
error
Example:

"warning"

qaForbiddenTerms
enum<string>

Severity for forbidden/deprecated-term issues: off, warning, or error.

Available options:
off,
warning,
error
Example:

"error"

Response

The updated glossary.

success
boolean
required
data
object
required