Update Member Nickname
discord.update_member_nickname
ActionChat & messagingconnection required
Calls the Discord API with the connection's credentials.
Set or clear a member's nickname in a server.
Connection
- Required
- Yes — the node will not save without one
- Auth type
- API key
- Providers
- Discord
- Secret shape
- the bot token (sent as "Authorization: Bot <token>") for every op except discord.execute_webhook, whose secret is the webhook URL
- Resolved by
- config.connection_id, else node.connection_id
Configuration
4 fields, 2 required. A dotted path is a nested object and name[] an array of objects — the editor renders the same tree.
| Field | Type | Required | Default | Constraints | Example |
|---|---|---|---|---|---|
guild_id Id of the Discord server (right-click the server → Copy Server ID). | string | Yes | — | — | — |
user_id Id of the member's Discord user account. | string | Yes | — | — | — |
nickname The new nickname, 1-32 characters; leave blank to clear it. | string | No | — | ≤ 32 characters | — |
reason Why the change was made; recorded in the server's audit log. | string | No | — | ≤ 512 characters | — |
Output
One shape.
result
| Field | Type | Example |
|---|---|---|
nick The member's server nickname, if they have one. | string | — |
roles Ids of the roles the member holds. | array | — |
joined_at When they joined the server (ISO-8601). | string | — |
user.id Id of the member's user account. | string | — |
user.username The member's username. | string | — |
{
"joined_at": "",
"nick": "",
"roles": [],
"user": {
"id": "",
"username": ""
}
}Notes
- Needs a Discord connection whose secret is the bot token.
- Needs MANAGE_NICKNAMES — this is the Modify Guild Member route, so CHANGE_NICKNAME (which only covers the bot renaming itself through a different endpoint) is not enough.
See Update Member Nickname run in a workflow.
In a technical demo we add the Discord connection, drop the node on the canvas and let Workflow Health pre-flight it before the first real run.