Update a role

Settings module

PATCH/roles/{id}roles.update

A role: a platform role or an org custom role built from the capability set. 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.roles.manage.
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

roles.update: Path and query parameters
Field	Type	Required	Description
id	string (uuid)	Yes	Identifier of the role.

Request body: RoleUpdate

roles.update: RoleUpdate
Field	Type	Required	Description
name	string \| null	No	Role name.Constraints: length 1 to 300
description	string \| null	No	What the role is for.Constraints: length 1 to 20000
band	integer	No	Band in Section 8 order, 1 Owner to 7 Viewer. Custom roles take 2 to 7, and a person assigns only roles at or below their own band.Constraints: range 1 to any

{
  "name": "Finance Approver",
  "description": "Approves purchase orders up to the spend limit.",
  "band": 4
}

Response 200: Role

roles.update: Role
Field	Type	Required	Description
id	string (uuid)	Yes	Identifier of the role.
org_id	string (uuid) \| null	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.
name	string \| null	Yes	Role name.Constraints: length 1 to 300
description	string \| null	Yes	What the role is for.Constraints: length 1 to 20000
code	string	Yes	Role code. System role labels come from the i18n catalogs keyed by it; custom role codes never reuse a system code.Constraints: pattern ^[A-Za-z0-9][A-Za-z0-9._-]{0,63}$
band	integer	Yes	Band in Section 8 order, 1 Owner to 7 Viewer. Custom roles take 2 to 7, and a person assigns only roles at or below their own band.Constraints: range 1 to any

{
  "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",
  "name": "Finance Approver",
  "description": "Approves purchase orders up to the spend limit.",
  "code": "site_lead",
  "band": 4
}

Code samples

curl -X PATCH "$XOS_BASE_URL/roles/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 '{"name":"Finance Approver","description":"Approves purchase orders up to the spend limit.","band":4}'

const { data, etag } = await xos.roles.update("0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f", {
    "name": "Finance Approver",
    "description": "Approves purchase orders up to the spend limit.",
    "band": 4
  }, { ifMatch: etag });

response = xos.roles.update("0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f", {"name": "Finance Approver", "description": "Approves purchase orders up to the spend limit.", "band": 4}, if_match=etag)

xos roles update 0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f --data '{"name":"Finance Approver","description":"Approves purchase orders up to the spend limit.","band":4}' --if-match auto