Skip to main content
PATCH
Update a key (write)

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

projectId
string
required

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

keyId
string
required

Translation key id (UUID).

Query Parameters

branch
string

Target an open translation branch instead of main. Required when the project's main branch is protected.

Body

application/json
key
string

New key name. Same segment rules as on create.

Required string length: 1 - 500
Example:

"home.hero.headline"

description
string | null

Replace the translator-facing context; null clears it.

Maximum string length: 1000
tags
string[]

Replace the key's tags.

Maximum array length: 20
Maximum string length: 50
isPlural
boolean

Toggle plural handling for the key.

screenshotUrl
string | null

Public URL of a context screenshot; null removes it.

screenshotFileId
string | null

Storage id of a context screenshot; null removes it.

Response

Updated

success
boolean
required
data
object
required