Skip to main content
POST
Create a term

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
term
string
required

The source-language term this entry defines.

Required string length: 1 - 500
Example:

"Sign in"

doNotTranslate
boolean

When true, the term must be left untranslated (brand names, product names).

Example:

false

caseSensitive
boolean

When true, matching and QA checks respect the term's exact casing.

Example:

false

usageStatus
enum<string>

Whether the term is preferred, deprecated, or forbidden. Defaults to preferred.

Available options:
preferred,
deprecated,
forbidden
Example:

"preferred"

notes
string | null

Optional guidance for translators on how to use the term.

Maximum string length: 2000
Example:

"Use the verb form; never capitalize mid-sentence."

translations
object

Optional seed translations as a languageCode -> value map.

Example:

Response

The created term with its translations.

success
boolean
required
data
object
required