RESTPostAPIGuildRoleJSONBody Interface

Signature

export interface RESTPostAPIGuildRoleJSONBody

No methods.

name?: string | null | undefined;

Name of the role

@default"new role"

permissions?: Permissions | null | undefined;

Bitwise value of the enabled/disabled permissions

@default"default role permissions in guild"

color?: number | null | undefined;

RGB color value

@default0

colors?: APIRoleColors;

The colors of the role.

hoist?: boolean | null | undefined;

Whether the role should be displayed separately in the sidebar

@defaultfalse

icon?: string | null | undefined;

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

unicode_emoji?: string | null | undefined;

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

mentionable?: boolean | null | undefined;

Whether the role should be mentionable

@defaultfalse