Create a role

Settings module

POST/rolesroles.create

A role: a platform role or an org custom role built from the capability set. Creates a role. Requires `Idempotency-Key`; a replay returns the original response. The organization is derived from the credential or the parent row, never from the body.

Requires the capability org.roles.manage.
OAuth scopes: org.
Send an Idempotency-Key header. A replay with the same key returns the original response.
Error statuses: 400, 401, 409, 422, 429. Errors are RFC 9457 problem details.

Request body: RoleCreate

roles.create: RoleCreate
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
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

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

Response 201: Role

roles.create: 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 POST "$XOS_BASE_URL/roles" \
  -H "Authorization: Bearer $XOS_API_KEY" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Content-Type: application/json" \
  -d '{"name":"Finance Approver","description":"Approves purchase orders up to the spend limit.","code":"site_lead","band":4}'

const { data } = await xos.roles.create({
    "name": "Finance Approver",
    "description": "Approves purchase orders up to the spend limit.",
    "code": "site_lead",
    "band": 4
  });

response = xos.roles.create({"name": "Finance Approver", "description": "Approves purchase orders up to the spend limit.", "code": "site_lead", "band": 4})

xos roles create --data '{"name":"Finance Approver","description":"Approves purchase orders up to the spend limit.","code":"site_lead","band":4}'