RESTPostAPIGuildRoleJSONBody

@see

https://discord.com/developers/docs/resources/guild#create-guild-role

Hierarchy

• RESTPostAPIGuildRoleJSONBody
  • RESTAPIGuildCreateRole

Index

Properties

• color
• colors
• hoist
• icon
• mentionable
• name
• permissions
• unicode_emoji

Properties

optionalcolor

color?: null | number

RGB color value

@defaultValue

0

@remarks

color will still be returned by the API, but using the colors field is recommended when doing requests.

optionalcolors

colors?: APIRoleColors

The role's colors

@defaultValue

{ "primary_color": 0, "secondary_color": null, "tertiary_color": null }

optionalhoist

hoist?: null | boolean

Whether the role should be displayed separately in the sidebar

@defaultValue

false

optionalicon

icon?: null | string

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

optionalmentionable

mentionable?: null | boolean

Whether the role should be mentionable

@defaultValue

false

optionalname

name?: null | string

Name of the role

@defaultValue

"new role"

optionalpermissions

permissions?: null | string

Bitwise value of the enabled/disabled permissions

@defaultValue

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)