Roles

Actions in the category "Roles".

Create role

Creates a new role on your server.

Required permissions: Manage roles.

Inputs

Name	Type	Required	Details
Name	Text	Yes	Name of the role. Length: 1 to 100 characters. Default: new role.
Color	Color	No	Color of the role.
Display separately	Yes/No	Yes	Show members with this role separately in the member list. Default: No.
Anyone can mention	Yes/No	Yes	Allow @mentioning the role. Default: No.
Permissions	List of Permission	Yes	Permissions granted by the role. Default: [].
Audit log reason	Text	No	Reason recorded in the audit log. Maximum length: 512 characters.

Outputs

Name	Type	Details
Created role	Role	The newly created role.

Delete role

Permanently deletes a role from the server.

Required permissions: Manage roles.

Inputs

Name	Type	Required	Details
Role	Role	Yes	The role to delete.
Audit Log Reason	Text	No	Reason logged in the audit log. Maximum length: 512 characters.

Update role name

Renames a role.

Required permissions: Manage roles.

Inputs

Name	Type	Required	Details
Role	Role	Yes	The role to update.
Name	Text	Yes	The new role name (1-100 characters). Length: 1 to 100 characters.
Audit Log Reason	Text	No	Reason logged in the audit log. Maximum length: 512 characters.

Outputs

Name	Type	Details
Role	Role	The updated role.

Update role color

Changes the display color of a role.

Required permissions: Manage roles.

Inputs

Name	Type	Required	Details
Role	Role	Yes	The role to update.
Color	Color	Yes	The new color, or empty to clear it.
Audit Log Reason	Text	No	Reason logged in the audit log. Maximum length: 512 characters.

Outputs

Name	Type	Details
Role	Role	The updated role.

Update role hoist

Sets whether members of this role are displayed separately in the member list.

Required permissions: Manage roles.

Inputs

Name	Type	Required	Details
Role	Role	Yes	The role to update.
Hoist	Yes/No	Yes	Whether to hoist the role.
Audit Log Reason	Text	No	Reason logged in the audit log. Maximum length: 512 characters.

Outputs

Name	Type	Details
Role	Role	The updated role.

Allow or block role mentions

Sets whether the role can be mentioned by anyone.

Required permissions: Manage roles.

Inputs

Name	Type	Required	Details
Role	Role	Yes	The role to update.
Anyone can mention	Yes/No	Yes	Whether anyone can mention the role.
Audit Log Reason	Text	No	Reason logged in the audit log. Maximum length: 512 characters.

Outputs

Name	Type	Details
Role	Role	The updated role.

Update role permissions

Replaces the permission set granted by a role.

Required permissions: Manage roles.

Inputs

Name	Type	Required	Details
Role	Role	Yes	The role to update.
Permissions	List of Permission	Yes	The full permission flag set for the role.
Audit Log Reason	Text	No	Reason logged in the audit log. Maximum length: 512 characters.

Outputs

Name	Type	Details
Role	Role	The updated role.

Update role position

Moves a role to the given position in the role hierarchy.

Required permissions: Manage roles.

Inputs

Name	Type	Required	Details
Role	Role	Yes	The role to move.
Position	Whole number	Yes	The new position (0 is lowest). Minimum: 0.
Audit Log Reason	Text	No	Reason logged in the audit log. Maximum length: 512 characters.

Outputs

Name	Type	Details
Role	Role	The updated role.

Update role icon

Sets a custom icon for the role from a URL or attachment.

Required permissions: Manage roles.

Inputs

Name	Type	Required	Details
Role	Role	Yes	The role to update.
Icon URL	URL	No	URL of the icon image. Mutually exclusive with attachment. Use only one of these: Attachment.
Attachment	Attachment	No	Attachment to use as the icon. Mutually exclusive with icon URL. Use only one of these: Icon URL.
Audit Log Reason	Text	No	Reason logged in the audit log. Maximum length: 512 characters.

Outputs

Name	Type	Details
Role	Role	The updated role.

Update role Unicode emoji

Sets the role's icon to a unicode emoji, or clears it when empty.

Required permissions: Manage roles.

Inputs

Name	Type	Required	Details
Role	Role	Yes	The role to update.
Unicode Emoji	Text	Yes	The unicode emoji to use, or empty to clear. Maximum length: 16 characters.
Audit Log Reason	Text	No	Reason logged in the audit log. Maximum length: 512 characters.

Outputs

Name	Type	Details
Role	Role	The updated role.

Assign role to many members

Adds a role to a list of members in bulk.

Required permissions: Manage roles.

Inputs

Name	Type	Required	Details
Role	Role	Yes	The role to assign.
Members	List of Server member	Yes	The members that should receive the role.
Audit Log Reason	Text	No	Reason logged in the audit log. Maximum length: 512 characters.

Outputs

Name	Type	Details
Succeeded IDs	List of Discord ID	Member IDs that successfully received the role.
Failed IDs	List of Discord ID	Member IDs for which the assignment failed.

Fetch role by ID

Looks up a role using its ID.

Inputs

Name	Type	Required	Details
Role ID	Discord ID	Yes	The role ID to look up.

Outputs

Name	Type	Details
Role	Role	The found role, or empty if it does not exist. May be empty.

Fetch roles of server

Returns all roles defined in the server.

Outputs

Name	Type	Details
Roles	List of Role	The list of roles.

Bulk set role positions

Repositions multiple roles in a single API call. Requires MANAGE_ROLES.

Required permissions: Manage roles.

Inputs

Name	Type	Required	Details
Updates	List of Role position update	Yes	List of position updates to apply. Minimum items: 1.

Create role position update

Builds a single role reposition entry (a role plus its new position) for Bulk set role positions. Collect entries with Add role position or Add item to list.

Inputs

Name	Type	Required	Details
Role	Role	Yes	The role to move.
Position	Whole number	Yes	The role's new position (0 is lowest). Minimum: 0.

Outputs

Name	Type	Details
Position Update	Role position update	The constructed role position update.

Add role position

Appends a role reposition entry (a role plus its new position) to a list and returns the updated list. Leave the list empty to start a new one; use the result in Bulk set role positions.

Inputs

Name	Type	Required	Details
Updates	List of Role position update	No	The position-update list to extend (leave empty to start a new list). Maximum items: 250.
Role	Role	Yes	The role to move.
Position	Whole number	Yes	The role's new position (0 is lowest). Minimum: 0.

Outputs

Name	Type	Details
Updates	List of Role position update	The updated position-update list.

Fetch role by name

Finds a role on the server by its name. Returns an empty value if no role matches.

Inputs

Name	Type	Required	Details
Name	Text	Yes	Role name to search for. Length: 1 to 100 characters.
Case sensitive	Yes/No	Yes	Match upper/lower case exactly. Default: No.

Outputs

Name	Type	Details
Role	Role	The first matching role, or empty. May be empty.