Skip to main content
Version: 0.37.97

APIGuildCreateRole

@deprecated

API and gateway v8 are deprecated and the types will not receive further updates, please update to v10.

Hierarchy

Index

Properties

Properties

optionalcolor

color?: null | number

RGB color value

@default

0

optionalhoist

hoist?: null | boolean

Whether the role should be displayed separately in the sidebar

@default

false

optionalicon

icon?: null | string

The role’s icon image (if the guild has the ROLE_ICONS feature)

id

id: string | number

optionalmentionable

mentionable?: null | boolean

Whether the role should be mentionable

@default

false

optionalname

name?: null | string

Name of the role

@default

“new role”

optionalpermissions

permissions?: null | string

Bitwise value of the enabled/disabled permissions

@default

“default role permissions in guild”

optionalunicode_emoji

unicode_emoji?: null | string

The role’s unicode emoji as a standard emoji (if the guild has the ROLE_ICONS feature)