Skip to main content
POST
text.glossary.update

Authorizations

Authorization
string
header
required

API key: sk_live_…

Headers

Idempotency-Key
string
required

Required: this capability has an external effect.

Maximum string length: 255
Pramaan-Max-Price-Micro
string

Optional. The most this request may be priced at, in micro-USD (a whole number above 0). It replaces the capability's own price ceiling for this request, lower or higher. Sources that could cost more are left out; when none is left the answer is 400 with the lowest limit that would work.

Pattern: ^[1-9]\d{0,14}$

Body

application/json
ref
string
required

The ref returned by text.glossary.create or text.glossary.list.

Pattern: ^(ref_[0-9A-HJKMNP-TV-Z]{26}|rh_[A-Za-z0-9_-]{24,1024})$
action
enum<string>
required

Change to make to your glossary.

Available options:
rename,
merge,
replace,
removeDictionary
name
string

New name; required only for rename.

Required string length: 1 - 100
dictionary
object

Language pair; required for dictionary changes.

confirm
boolean

Required only for dictionary removal, with no default.

Response

The result

updated
boolean
required

Whether the change was applied.