Update a role
PATCH
/api/v1/roles/{id}
prm_roles_manage
Edits the name, description and permission set. The immutable administrator role cannot be edited at all.
Changing a role changes the authority of every manager holding it, and every API token those managers own, on the next request. There is no notification and no record against the affected tokens.
At a glance
- Authentication
- Staff token or session
- Requires permission
-
prm_roles_manageManage roles & permissions - Rate limit
t_mutate
Parameters
| Parameter | Description |
|---|---|
idrequired
path · integer
|
Role id. |
Errors
| Code | When it is returned |
|---|---|
ERR_FORBIDDEN403
|
the edit would add a permission the caller does not hold |