ASasksyllable
roles

Delete Role

Delete a role. Optionally, reassign existing users with that role to a new role.

delete/api/v1/roles/{role_id}

Request

  • Base URL
    https://api.syllable.cloud
  • URL
    https://api.syllable.cloud/api/v1/roles/{role_id}
  • Auth
    API key in header Syllable-API-Key

Path parameters

role_idinteger required

The ID of the role to delete

Query parameters

reasonstring required

The reason for deleting the role

new_role_idinteger nullable

Users with the deleted role will be reassigned to the new role, if a new role ID is provided

Response

Successful Response

unknown required

Changes

No operation changes recorded.