Update a verbiage term
Knowledge module
PATCH/verbiage-terms/{id}verbiageTerms.update
A controlled vocabulary term with casing rules. Em dashes are refused. Updates the fields sent; omitted fields are unchanged. Requires `If-Match` with the current `ETag`: a stale tag returns 412 and a missing tag returns 428.
- Requires the capability knowledge.verbiage.write.
- OAuth scopes: knowledge.
- Send If-Match with the ETag you read. A stale tag returns 412; a missing tag returns 428.
- Error statuses: 400, 401, 404, 412, 422, 428, 429. Errors are RFC 9457 problem details.
Path and query parameters
| Field | Type | Required | Description |
|---|---|---|---|
| id | string (uuid) | Yes | Identifier of the verbiage term. |
Request body: VerbiageTermUpdate
| Field | Type | Required | Description |
|---|---|---|---|
| term | string | No | Term.Constraints: length 1 to 300 |
| casing_rule | string | No | Casing rule.Constraints: length 1 to 300 |
| definition | string | No | Definition, a sentence ending in a period.Constraints: length 1 to 20000 |
{
"term": "Load-In",
"casing_rule": "Title Case as a noun",
"definition": "The arrival of equipment before a show."
}Response 200: VerbiageTerm
| Field | Type | Required | Description |
|---|---|---|---|
| id | string (uuid) | Yes | Identifier of the verbiage term. |
| org_id | string (uuid) | Yes | Identifier of the owning organization, derived from the parent row and never accepted from the caller. |
| created_at | string (date-time) | Yes | When the row was created. |
| created_by | string (uuid) | null | Yes | Identifier of the person who created the row; null when a seed, platform or system process created it. |
| updated_at | string (date-time) | Yes | When the row was last updated. |
| updated_by | string (uuid) | null | Yes | Identifier of the person who last updated the row; null when a seed, platform or system process updated it. |
| term | string | Yes | Term.Constraints: length 1 to 300 |
| casing_rule | string | Yes | Casing rule.Constraints: length 1 to 300 |
| definition | string | Yes | Definition, a sentence ending in a period.Constraints: length 1 to 20000 |
{
"id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
"org_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
"created_at": "2026-10-08T14:30:00Z",
"created_by": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
"updated_at": "2026-10-08T14:30:00Z",
"updated_by": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
"term": "Load-In",
"casing_rule": "Title Case as a noun",
"definition": "The arrival of equipment before a show."
}Code samples
curl -X PATCH "$XOS_BASE_URL/verbiage-terms/0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f" \
-H "Authorization: Bearer $XOS_API_KEY" \
-H 'If-Match: W/"etag-from-your-last-read"' \
-H "Content-Type: application/json" \
-d '{"term":"Load-In","casing_rule":"Title Case as a noun","definition":"The arrival of equipment before a show."}'const { data, etag } = await xos.verbiageTerms.update("0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f", {
"term": "Load-In",
"casing_rule": "Title Case as a noun",
"definition": "The arrival of equipment before a show."
}, { ifMatch: etag });response = xos.verbiage_terms.update("0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f", {"term": "Load-In", "casing_rule": "Title Case as a noun", "definition": "The arrival of equipment before a show."}, if_match=etag)xos verbiage-terms update 0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f --data '{"term":"Load-In","casing_rule":"Title Case as a noun","definition":"The arrival of equipment before a show."}' --if-match auto