Update an org state label
Platform module
PATCH/org-state-labels/{id}orgStateLabels.update
An org's display relabel of a record state. It never mints a new lifecycle. 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 org.views.write.
- OAuth scopes: org.
- 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 org state label. |
Request body: OrgStateLabelUpdate
| Field | Type | Required | Description |
|---|---|---|---|
| label | string | No | Display label.Constraints: length 1 to 300 |
{
"label": "With Client"
}Response 200: OrgStateLabel
| Field | Type | Required | Description |
|---|---|---|---|
| id | string (uuid) | Yes | Identifier of the org state label. |
| 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. |
| record_state | string | Yes | Record state relabeled. A Title Case value from the lifecycle's database enum.Constraints: pattern ^[A-Z0-9][A-Za-z0-9&'/.()-]*( [A-Za-z0-9&'/.()-]+)*$ |
| label | string | Yes | Display label.Constraints: length 1 to 300 |
{
"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",
"record_state": "In Review",
"label": "With Client"
}Code samples
curl -X PATCH "$XOS_BASE_URL/org-state-labels/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 '{"label":"With Client"}'const { data, etag } = await xos.orgStateLabels.update("0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f", {
"label": "With Client"
}, { ifMatch: etag });response = xos.org_state_labels.update("0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f", {"label": "With Client"}, if_match=etag)xos org-state-labels update 0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f --data '{"label":"With Client"}' --if-match auto