Delete a role

1 min

DELETE

https://api.upstartcommerce.com/profile-permissions/roles/{roleId}

Deletes a role. By default, fails if the role is assigned to any users. Use cascade=true to remove the role from all users first.

Required Permission: profile-permissions.roles.delete

roleIdstringRole identifier

cascadeboolean<p>If true, removes role from all users before deleting</p>

acceptstringGenerated from available response content types

204Role deleted successfully

401Missing or invalid authentication token

404Role not found

409<p>Role is assigned to users (use cascade=true to force)</p>

500Internal server error

curl --request DELETE \
     --url 'https://api.upstartcommerce.com/profile-permissions/roles/{roleId}?cascade=boolean' \
     --header 'accept: application/json'