Delete a role
Requires MANAGE_ROLES. The everyone role cannot be deleted. Deletion removes the role from every user and removes all channel overwrites targeting it.
Request
POST http://localhost:8989/api/roles/{roleID}/delete
Path parameters
| Parameter name | Value | Description | Additional |
|---|---|---|---|
| roleID | string | Role identifier. |
Required |
Authorisation
This request requires the use of one of following authorisation methods:
API key
.
Response
The following HTTP status codes may be returned, optionally with a response resource.
| Status code | Description | Resource |
|---|---|---|
| 200 | OK Operation completed successfully. |
Success Response |
| 400 | Bad Request The request is invalid, references a missing resource, or conflicts with existing state. |
Error Response |
| 401 | Unauthorized The Authorization header is missing or malformed. |
Error Response |
| 403 | Forbidden The token is invalid or expired, or the requester lacks a required permission. |
Error Response |
| 500 | Internal Server Error The server could not complete the operation. |
Error Response |