Skip to main content

CommunityRoleCreateRequest

CommunityRoleCreateRequest = object

Request object for creating a new role in the community.

Properties​

channelPermission?​

optional channelPermission: ChannelPermission

The default channel permissions to grant. Optional. See ChannelPermission for available flags.

colorHex?​

optional colorHex: string

The hex color code for the role. Optional. Defaults to #FFFFFF if not specified.

communityPermission?​

optional communityPermission: CommunityPermission

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

isMentionable​

isMentionable: boolean

Whether the role can be mentioned in messages. Required.

name​

name: string

The display name for the role. Required.