Guild Role experimental
Definitions
GuildRole
| FIELD | TYPE | DESCRIPTION |
|---|---|---|
| id | string | role id |
| name | string? | role name |
API
Set Guild Member Role
POST /guild.member.role.set| FIELD | TYPE | DESCRIPTION |
|---|---|---|
| guild_id | string | guild id |
| user_id | string | user id |
| role_id | string | role id |
Set a role for a user in the guild.
Unset Guild Member Role
POST /guild.member.role.unset| FIELD | TYPE | DESCRIPTION |
|---|---|---|
| guild_id | string | guild id |
| user_id | string | user id |
| role_id | string | role id |
Remove a role from a user in the guild.
Get Guild Role List
POST /guild.role.list| FIELD | TYPE | DESCRIPTION |
|---|---|---|
| guild_id | string | guild id |
| next | string? | pagination token |
Get all roles in a guild. Returns a paginated list of GuildRole objects.
Create Guild Role
POST /guild.role.create| FIELD | TYPE | DESCRIPTION |
|---|---|---|
| guild_id | string | guild id |
| data | GuildRole | role data |
Create a guild role. Returns a GuildRole object.
Update Guild Role
POST /guild.role.update| FIELD | TYPE | DESCRIPTION |
|---|---|---|
| guild_id | string | guild id |
| role_id | string | role id |
| data | GuildRole | role data |
Update a guild role.
Delete Guild Role
POST /guild.role.delete| FIELD | TYPE | DESCRIPTION |
|---|---|---|
| guild_id | string | guild id |
| role_id | string | role id |
Delete a guild role.
Events
guild-role-created
Triggered when a guild role is created. Required resources: guild, role.
guild-role-updated
Triggered when a guild role is updated. Required resources: guild, role.
guild-role-deleted
Triggered when a guild role is deleted. Required resources: guild, role.