Context Management

Update a glossary term

Changed on

Updates the term's keyword or definition. An absent field keeps its stored value. null clears a nullable field or removes a map entry; other fields reject null. In batches and imports, items match stored items by natural key, stored items absent from the batch are untouched, and nothing else is deleted. A blank CSV cell counts as absent. The term ID and translations are kept when the keyword is renamed. Renaming to a keyword another term already has returns 409. Requires org:context:write.

patch/v2/context-groups/{groupId}/glossary/{entryId}

Request

  • Base URL: https://api.gtx.dev
  • URL: https://api.gtx.dev/v2/context-groups/{groupId}/glossary/{entryId}
  • Auth: one of:
    • HTTP bearer
    • HTTP bearer

Path parameters

groupIdstring required

Context group ID.

entryIdstring required

Glossary term ID.

Headers

gt-api-version'2025-01-01.v0' | '2025-11-03.v1' | '2026-02-18.v1' | '2026-03-06.v1'

API contract version. Defaults to the oldest supported version.

Request body

keywordstring
definitionstring nullable

null clears the definition.

Response

Glossary term updated

committedtrue required

Changes