Role

Role

id

string

required

Unique identifier for the role

teamId

string

required

ID of the team associated with the role

name

string

required

Name of the role

iconUrl

string <uri>

optional

URL of the role's icon

Default:

null

color

string

required

Hexadecimal color code for the role

color2

string

optional

Additional color code for the role

Default:

null

permissions

number

required

Permission level of the role

Default:

0

priority

number

required

Priority of the role

Default:

0

createdAt

string <date-time>

required

Timestamp of when the role was created

Default:

CURRENT_TIMESTAMP

updatedAt

string <date-time>

optional

Timestamp of when the role was last updated

Default:

null

isDisplayedSeparately

boolean

required

Indicates if the role is displayed separately

Default:

true

isSelfAssignable

boolean

optional

Indicates if the role is self-assignable

Default:

false

iconEmojiId

string

optional

ID of the emoji used as the role's icon

Default:

null

mentionable

boolean

required

Indicates if the role is mentionable

Default:

true

botScope

object

required

Bot-specific scope information for the role

Default:

{}

userId

string

optional

ID of the user associated with the bot scope

Default:

null

Modified at 2025-01-03 19:42:50