Update Glossary Term
update_glossary_termUpdate an existing glossary term by merging your changes into its current fields—definition, label, parent, or custom attributes—and publish a draft when ready.
Instructions
Update a business term's text, parent or custom attributes — and publish a draft.
The glossary API replaces the whole term on update, so this reads the
current one first and merges your changes into it: omitting an argument
leaves that field alone rather than blanking it. attributes merges
the same way, per attribute — pass only the ones you are changing, and
set one to "" to clear it. A boolean is the exception: the
glossary has no empty boolean and rejects "", so set it to
True/False rather than trying to clear it.
Because the whole term is rewritten, every attribute the type marks required must hold a value — including ones made required after this term was created. That is checked before the call, and reported by name.
A term's type cannot be changed after creation. Its parent can:
pass parent_id to move it, or "" to make it a root term.
A draft is a different resource. A term left unpublished by
create_glossary_term(publish=false) can be read and deleted at the
ordinary path, but not written there — the service answers a plain
PUT on a draft with a 404. This routes the write to the draft
instead, so editing one works; and publish then promotes it to a
published term, which nothing else here could do. Publishing a term that
is already published is reported, not attempted: there is no draft to
promote and the service answers that with a 404 too.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| name | No | New name (unique among siblings, max 100 characters). | |
| label | No | New display label. | |
| publish | No | Publish the term if it is still a draft (default false). Pass it on its own to publish without changing anything else. | |
| term_id | Yes | The glossary term UUID. | |
| parent_id | No | Move the term under a different parent, or ``""`` to make it a root term. A term cannot be its own ancestor. | |
| attributes | No | Custom attributes to change, keyed by label. Same value forms as create_glossary_term — booleans as True/False, multi-select as a list. | |
| definition | No | New definition. | |
| description | No | New description, max 1000 characters. |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
No arguments | |||