v2

latestOpenAPI 3.0.0AGPLv32026-07-26125148364.7 KB

Server Permissions

Edit Role

Edit a role by its id.

patch/servers/{target}/roles/{role_id}

targetstring required

role_idstring required

X-Audit-Log-Reasonstring

Reason for action which is stored in the audit log.

namestring nullable

Role name

colourstring nullable

Role colour

hoistboolean nullable

Whether this role should be displayed separately

rankinteger nullable

Ranking position

Removed - no effect, use the edit server role positions route

iconstring nullable

Role icon

Provide an Autumn attachment Id.

removeFieldsRole[]

Fields to remove from role object

_idstring required

Unique Id

namestring required

Role name

colourstring nullable

Colour used for this role

This can be any valid CSS colour

hoistboolean

Whether this role should be shown separately on the member sidebar

rankinteger

Ranking of this role