Skip to content

UpdateRoleRequest

The changes to a role; what is omitted stays.

object
position

The new rank of the role, from 0 to 999.

integer
<= 999
permissions

The new permissions of the role, each once; empty removes them all.

Array<string>
Allowed values: manage_reports manage_accounts manage_domains manage_rules manage_settings manage_roles manage_invites view_audit manage_jobs manage_login_recovery manage_custom_emojis manage_webhooks manage_announcements manage_finance view_finance manage_supporters create_custom_emojis manage_oauth_apps manage_service_closure start_voice_rooms manage_errors manage_login_providers create_invites keep_posts_longer create_articles create_events
badge

The new badge of the role. Its holders keep their choice to show it.

Schema: RoleBadge

object
remove_badge

true removes the badge of the role, and every holder’s choice to show it; a new badge starts hidden. Sending it with badge is a 422 whose detail names remove_badge.

boolean

Example generated

{
"position": 1,
"permissions": [
"manage_reports"
],
"badge": {},
"remove_badge": true
}

For LLMs and coding agents:llms.txt,llms-full.txt, llms-small.txt

Analytics on this site