Skip to main content

CommunityRoleEditRequest

CommunityRoleEditRequest = object

Request object for modifying an existing role's properties.

Properties​

channelPermission?​

optional channelPermission?: ChannelPermission

The new default channel permissions. Optional. See ChannelPermission for available flags.

colorHex​

colorHex: string

The new hex color code for the role, in #RRGGBB format (a # followed by 6 hexadecimal digits). Required.

communityPermission?​

optional communityPermission?: CommunityPermission

The new community-level permissions. Optional. See CommunityPermission for available flags.

id​

id: CommunityRoleGuid

The unique identifier of the role to edit. Required.

isMentionable​

isMentionable: boolean

Whether the role can be mentioned in messages. Required.

name​

name: string

The new display name for the role. Required. Must be 1 to 100 characters and contain only letters, numbers, and hyphens. Spaces are not allowed, and the name cannot start or end with a hyphen or contain consecutive hyphens. A name that violates these rules fails with RequestValidationFailed. Note: the @everyone role's name cannot be changed.