`{role}` Tags

`{role.id;role}`

Gets the ID of a given role.

Name	Type	Description
`role`	Role?	The role to get the ID of.

`{role.name;role}`

Gets the name of a given role.

Name	Type	Description
`role`	Role?	The role to get the name of.

`{role.mention allow_mention;role}`

Returns the role @mention.

Name	Type	Default	Description
`role`	Role?		The role to get the mention of.
`allow_mention`	`boolean`	`true`	Whether to ping the role with this mention.

`{role.position;role}`

Gets the position of a role.

Name	Type	Description
`role`	Role?	The role to get the position of.

`{role.color;role}`

Gets the hex code of a role.

Name	Type	Default	Description
`role`	Role?		The role to get the color of.
`decimal`	`boolean`	`false`	Whether to return the role color in decimal.

`{role.managed;role}`

Returns true for managed roles. ex: Server Boost and Bot roles.

Name	Type	Description
`role`	Role?	The role to check if it is managed.

`{role.mentionable;role}`

Returns a boolean indicating whether the role can be mentioned.

Name	Type	Description
`role`	Role?	The role to check if it is mentionable.

`{role.createdAt}`

Returns the date the role was created.

Name	Type	Description
`role`	Role?	The role to get the creation date of.

`{role.hasPermission;permission_name;role}`

Check whether the role has the specified permission.

{role.hasPermission;administrator}

Name	Type	Description
`permission`	Permission	The permission to check for.
`role`	Role?	The role to check the permission of.

`{role.hoisted}`

Returns a boolean indicating whether the role is hoisted above other roles in the member list.

Name	Type	Description
`role`	Role?	The role to check if it is hoisted.

`{role.edit name color reason;role}`

Note

This tag is part of the Mutate Role expensive group.

Edit the role.

Name	Type	Description
`role`	Role?	The role to edit.
`name`	`string?`	Set the role's name.
`color`	Colour?	Set the role's colour.
`reason`	`string?`	The reason you are editing this role.

{role.edit name="Very cool" colour=teal}

`{role.create name color reason return_id;role}`

Note

This tag is part of the Mutate Role expensive group.

Create a new role.

Name	Type	Default	Description
`name`	`string`		The name of the role.
`color`	Colour?		The color of the role.
`reason`	`string?`		The reason you are creating this role.
`return_id`	`boolean`	`false`	Whether to return the created role's ID.

`{role.delete reason;role}`

Note

This tag is part of the Mutate Role expensive group. This tag is marked Dangerous and must be enabled in Advanced Settings.

Delete a role.

Name	Type	Description
`role`	Role	The role to delete.
`reason`	`string?`	The reason you are deleting this role.

`{role.icon;size;hash}`

Gets the icon of the role.

Name	Type	Default	Description
`role`	Role?		The role to get the icon of.
`size`	`number`	`256`	The size of the icon to return.
`hash`	`boolean`	`false`	Whether to return the icon hash instead of the URL created from the hash.

Tags

{role} Tags

`{role}` Tags