Interface RESTPostAPIGuildRoleJSONBody

See

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

interface RESTPostAPIGuildRoleJSONBody {
    color?: null | number;
    colors?: APIRoleColors;
    hoist?: null | boolean;
    icon?: null | string;
    mentionable?: null | boolean;
    name?: null | string;
    permissions?: null | string;
    unicode_emoji?: null | string;
}

Hierarchy (View Summary)

Properties

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

Properties

Optionalcolor

color?: null | number

RGB color value

Default Value

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

Default Value

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

Optionalhoist

hoist?: null | boolean

Whether the role should be displayed separately in the sidebar

Default Value

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

Default Value

false

Optionalname

name?: null | string

Name of the role

Default Value

"new role"

Optionalpermissions

permissions?: null | string

Bitwise value of the enabled/disabled permissions

Default Value

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)

Settings

Member Visibility

On This Page

Properties