setGroupRole
Assigns a group member to a specific role.
Bot.setGroupRole(avatar_uuid, group_uuid, role_uuid)
.then(function(result) {
if (result.success) { console.log("Role revoked"); }
});Input
Variable | Required | Description |
|---|---|---|
| yes | The UUID of the avatar to assign to the specified role. |
| yes | The UUID of the group. |
| yes | The UUID of the group role. The “Everyone” role is |
Output
Function returns a Promise with the following data:
Variable | Type | Description |
|---|---|---|
| bool | True if command completed successfully |
| string | Error string if command has failed |
Comments
Ensure your bot has sufficient rights to assign or revoke members from group roles.
Check the complex example for detailed usage.