Update role
/api/roles/{id}Change a role's name, description or permissions. Takes effect for everyone holding the role on their next request. Refused unless the role is below your highest role.
Needs the ManageRoles permission.
An API key, made on Settings, API keys. Every key starts with mbk_.
In: header
Path Parameters
uuidRequest Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
Response Body
application/json
application/problem+json
application/problem+json
application/problem+json
application/problem+json
application/problem+json
curl -X PUT "https://example.com/api/roles/497f6eca-6276-4993-bfeb-53cbbbba6f08" \ -H "Content-Type: application/json" \ -d '{ "name": "string", "description": null, "permissions": [ "string" ] }'{ "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "name": "string", "description": "string", "permissionNames": [ "string" ], "isBuiltIn": true, "locked": true, "userCount": 0, "position": 0}Delete role DELETE
Delete a role nobody holds. Refused unless the role is below your highest role. Needs the `ManageRoles` permission.
Move role POST
Move a role one place up or down in the order. A person's rank is their highest role. Refused for a role that is not below your highest role, and for a move that would put a role at your own place or above it. Administrator is always first. Returns the roles in their new order. Needs the `ManageRoles` permission.