Skip to content
XOS Developers

Delete a role

Settings module

DELETE/roles/{id}roles.delete

A role: a platform role or an org custom role built from the capability set. Soft-deletes the role: it moves to Trash and can be restored for its table's retention period.

  • Requires the capability org.roles.manage.
  • OAuth scopes: org.
  • Error statuses: 401, 404, 422, 429. Errors are RFC 9457 problem details.

Path and query parameters

roles.delete: Path and query parameters
FieldTypeRequiredDescription
idstring (uuid)YesIdentifier of the role.

Response 204: no body.

Code samples

curl -X DELETE "$XOS_BASE_URL/roles/0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f" \
  -H "Authorization: Bearer $XOS_API_KEY"
const { data } = await xos.roles.delete("0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f");
response = xos.roles.delete("0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f")
xos roles delete 0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f