Edit role
discord_
Write
- Toolset
- Roles
roles - Discord permission
- Manage Roles
- Context cost
- 368 tokens, estimated1,470 bytes of definition, divided by 4
Update an existing role's name, color, permissions, hoist, or mentionable flag. Only provided fields change; passing permissions REPLACES the role's full permission set, and passing color sets a single solid color, removing any gradient or holographic colors. Requires the Manage Roles permission, and the role must be below the bot's highest role.
Risk and annotations
Read-onlyreadOnlyHint | no | Can modify your server. |
|---|---|---|
DestructivedestructiveHint | no | Declared non-destructive. |
IdempotentidempotentHint | yes | Repeating the call with the same arguments has no additional effect. |
Open worldopenWorldHint | yes | Interacts with an external system: Discord. |
Annotations are hints the server declares. Clients use them to decide when to ask you before a call.
Parameters
| Parameter | Type | Rules | Description |
|---|---|---|---|
| guild_ | string | pattern ^\d{17,20}$ | Discord server (guild) ID (snowflake). |
| role_ | string | pattern ^\d{17,20}$ | ID (snowflake) of the role to edit. |
| nameoptional | string | none | New role name (max 100 characters). |
| coloroptional | string | pattern ^#[0-9A-Fa-f]{6}$ | New role color as a hex string, e.g. '#FF5733'. |
| hoistoptional | boolean | none | If true, display members with this role separately in the member list. |
| mentionableoptional | boolean | none | If true, anyone can @mention this role. |
| permissionsoptional | array of strings or string | none | Permission flag names. Providing this REPLACES the role's entire permission set. Uses Discord PermissionsBitField flag names. |
Output
This tool declares no output schema. Its description says what it returns; this page shows no example rather than invent one.
Related tools
Also in Roles
-
List roles, Read-only
discord_list_ roles -
Create role, Write
discord_create_ role -
Delete role, Destructive
discord_delete_ role -
Add role to member, Write
discord_add_ role -
Remove role from member, Write
discord_remove_ role -
Get role members, Read-only
discord_get_ role_ members -
Set role position, Write
discord_set_ role_ position -
Set role icon, Write
discord_set_ role_ icon
Raw definition (1,470 bytes)
{
"name": "discord_edit_role",
"description": "Update an existing role's name, color, permissions, hoist, or mentionable flag. Only provided fields change; passing permissions REPLACES the role's full permission set, and passing color sets a single solid color, removing any gradient or holographic colors. Requires the Manage Roles permission, and the role must be below the bot's highest role.",
"inputSchema": {
"type": "object",
"properties": {
"guild_id": {
"type": "string",
"pattern": "^\\d{17,20}$",
"description": "Discord server (guild) ID (snowflake)."
},
"role_id": {
"type": "string",
"pattern": "^\\d{17,20}$",
"description": "ID (snowflake) of the role to edit."
},
"name": {
"description": "New role name (max 100 characters).",
"type": "string"
},
"color": {
"description": "New role color as a hex string, e.g. '#FF5733'.",
"type": "string",
"pattern": "^#[0-9A-Fa-f]{6}$"
},
"hoist": {
"description": "If true, display members with this role separately in the member list.",
"type": "boolean"
},
"mentionable": {
"description": "If true, anyone can @mention this role.",
"type": "boolean"
},
"permissions": {
"description": "Permission flag names. Providing this REPLACES the role's entire permission set. Uses Discord PermissionsBitField flag names.",
"anyOf": [
{
"type": "array",
"items": {
"type": "string"
}
},
{
"type": "string"
}
]
}
},
"required": [
"guild_id",
"role_id"
],
"additionalProperties": false
},
"annotations": {
"title": "Edit role",
"readOnlyHint": false,
"destructiveHint": false,
"idempotentHint": true,
"openWorldHint": true
}
}