Skip to main content
POST
Create 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

orgId
string
required

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

Body

application/json
name
string
required

Human-readable glossary name, unique within the organization.

Required string length: 1 - 100
Example:

"Brand Terms"

description
string

Optional summary of what this glossary covers.

Maximum string length: 500
Example:

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

scope
enum<string>

Which projects the glossary applies to: all projects in the org, or only selected ones assigned to it. Defaults to all.

Available options:
all,
selected
Example:

"all"

approvalRequired
boolean

When true, term translations from non-approvers are stored as proposals until approved.

Example:

false

approvalBypassAdmins
boolean

When true, org/glossary admins' edits are auto-approved even while approval is required.

Example:

true

qaTermConsistency
enum<string>

Severity when a required term is missing from a translation: off, warning, or error. See the quality checks guide.

Available options:
off,
warning,
error
Example:

"warning"

qaForbiddenTerms
enum<string>

Severity when a forbidden or deprecated term is used: off, warning, or error.

Available options:
off,
warning,
error
Example:

"error"

Response

The created glossary.

success
boolean
required
data
object
required