Skip to content

Delete a role assignment

People module

DELETE/role-assignments/{id}roleAssignments.delete

A canon workforce role staffed on a project, with its staffing ratio basis. Soft-deletes the role assignment: it moves to Trash and can be restored for its table's retention period.

  • Requires the capability people.role.write.
  • OAuth scopes: people.
  • Error statuses: 401, 404, 422, 429. Errors are RFC 9457 problem details.

Path and query parameters

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

Response 204: no body.

Code samples

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