Delete a custom role

Delete a custom role. Cannot delete if members are still assigned to it.

DELETE /v1/roles/{roleId}

Delete a custom role

cURL

curl --request DELETE \
  --url http://localhost:3333/v1/roles/{roleId} \
  --header 'X-API-Key: <api-key>'

200

{
  "success": true,
  "message": "<string>"
}

Authorizations

X-API-Key · string · header · required

API key for authentication

Path Parameters

roleId · string · required

Role ID

Example:

"rol_abc123"

Response

200

application/json

Role deleted successfully

success · boolean

message · string