Skip to content
XOS Developers

Delete a membership role

Identity module

DELETE/membership-roles/{id}membershipRoles.delete

A role held through a membership. A person may hold several; capabilities are the union. A person cannot grant themselves a role. Soft-deletes the membership role: it moves to Trash and can be restored for its table's retention period.

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

Path and query parameters

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

Response 204: no body.

Code samples

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