Skip to main content
PATCH
Update 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.

termId
string
required

Glossary term id (UUID).

Body

application/json
term
string

New source-language term text.

Required string length: 1 - 500
Example:

"Sign in"

doNotTranslate
boolean

Toggle the do-not-translate flag.

Example:

false

caseSensitive
boolean

Toggle case-sensitive matching.

Example:

false

usageStatus
enum<string>

Change the usage status: preferred, deprecated, or forbidden.

Available options:
preferred,
deprecated,
forbidden
Example:

"deprecated"

notes
string | null

New translator notes; pass null to clear.

Maximum string length: 2000
Example:

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

Response

The updated term.

success
boolean
required
data
object
required