Modify Guild Member with Discord Bot API

Pipedream makes it easy to connect APIs for Discord Bot and 2,500+ other apps remarkably fast.

Trigger workflow on

HTTP requests, schedules and app events

Next, do this

Modify Guild Member with the Discord Bot API

No credit card required

▶

Watch us build a workflow

8 min

Watch now ➜

Trusted by 1,000,000+ developers from startups to Fortune 500 companies

Developers ♥ Pipedream

Getting Started#

Create a workflow to Modify Guild Member with the Discord Bot API. When you configure and deploy the workflow, it will run on Pipedream's servers 24x7 for free.

Configure the Modify Guild Member action
1. Connect your Discord Bot account
2. Select a Guild
3. Optional- Select a Channel
4. Select a User
5. Optional- Configure Nickname
6. Optional- Select one or more Role
7. Optional- Configure Mute
8. Optional- Configure Deaf
9. Optional- Configure Comunication Disabled Until
Select a trigger to run your workflow on HTTP requests, schedules or app events
Deploy the workflow
Send a test event to validate your setup
Turn on the trigger

Integrations#

Modify Guild Member with Discord Bot API on New Requests (Payload Only) from HTTP / Webhook API

HTTP / Webhook + Discord Bot

Try it

Modify Guild Member with Discord Bot API on New Submission from Typeform API

Typeform + Discord Bot

Try it

Modify Guild Member with Discord Bot API on Custom Events from Zoom API

Zoom + Discord Bot

Try it

Modify Guild Member with Discord Bot API on New Submission (Instant) from Jotform API

Jotform + Discord Bot

Try it

Modify Guild Member with Discord Bot API on New Custom Webhook Events from Stripe API

Stripe + Discord Bot

Try it

Details#

This is a pre-built, source-available component from Pipedream's GitHub repo. The component is developed by Pipedream and the community, and verified and maintained by Pipedream.

To contribute an update to an existing component or create a new component, create a PR on GitHub. If you're new to Pipedream component development, you can start with quickstarts for trigger span and action development, and then review the component API reference.

Modify Guild Member on Discord Bot

Description:Update attributes of a guild member. [See the docs here](https://discord.com/developers/docs/resources/guild#modify-guild-member)

Version:0.0.10

Key:discord_bot-modify-guild-member

View on GitHub

Code#

/* eslint-disable no-unused-vars */
import constants from "../../common/constants.mjs";
import common from "../common.mjs";

const { discord } = common.props;

const {
  GUILD_TEXT,
  GUILD_NEWS,
  ...OTHER_CHANNELS
} = constants.CHANNEL_TYPES;

const NOT_ALLOWED_CHANNELS =
  Object.values(OTHER_CHANNELS);

export default {
  ...common,
  key: "discord_bot-modify-guild-member",
  name: "Modify Guild Member",
  description: "Update attributes of a guild member. [See the docs here](https://discord.com/developers/docs/resources/guild#modify-guild-member)",
  type: "action",
  version: "0.0.10",
  props: {
    ...common.props,
    userId: {
      propDefinition: [
        discord,
        "userId",
        ({ guildId }) => ({
          guildId,
        }),
      ],
    },
    nick: {
      propDefinition: [
        discord,
        "nick",
      ],
      optional: true,
    },
    roles: {
      propDefinition: [
        discord,
        "roleId",
        ({
          guildId, userId,
        }) => ({
          guildId,
          userId,
          isAddRole: true,
        }),
      ],
      type: "string[]",
      optional: true,
    },
    mute: {
      type: "boolean",
      label: "Mute",
      description: "Whether the user is muted in voice channels. Will throw a 400 error if the user is not in a voice channel",
      optional: true,
    },
    deaf: {
      type: "boolean",
      label: "Deaf",
      description: "Whether the user is deafened in voice channels. Will throw a 400 error if the user is not in a voice channel",
      optional: true,
    },
    channelId: {
      description: "Id of channel to move user to (if they are connected to voice)",
      propDefinition: [
        discord,
        "channelId",
        ({ guildId }) => ({
          guildId,
          notAllowedChannels: NOT_ALLOWED_CHANNELS,
        }),
      ],
      optional: true,
    },
    comunicationDisabledUntil: {
      type: "string",
      label: "Comunication Disabled Until",
      description: "When the user's [timeout](https://support.discord.com/hc/en-us/articles/4413305239191-Time-Out-FAQ) will expire and the user will be able to communicate in the guild again (up to 28 days in the future), set to null to remove timeout. Will throw a 403 error if the user has the ADMINISTRATOR permission or is the owner of the guild. E.g. `2025-01-01T13:28:38+00:00`, `2030-01-01`",
      optional: true,
    },
  },
  async run({ $ }) {
    const {
      guildId,
      userId,
      nick,
      roles,
      mute,
      deaf,
      channelId,
      comunicationDisabledUntil,
    } = this;

    const response = await this.discord.modifyGuildMember({
      $,
      guildId,
      userId,
      nick,
      roles,
      mute,
      deaf,
      channel_id: channelId,
      communication_disabled_until: comunicationDisabledUntil,
    });

    $.export("$summary", `Member with Id ${userId} successfully modified!`);
    return response;
  },
};

Configuration#

This component may be configured based on the props defined in the component code. Pipedream automatically prompts for input values in the UI and CLI.

Label	Prop	Type	Description
Discord Bot	`discord`	`app`	This component uses the Discord Bot app.
Guild	`guildId`	`string`	Select a value from the drop down menu.
Channel	`channelId`	`string`	Select a value from the drop down menu.
User	`userId`	`string`	Select a value from the drop down menu.
Nickname	`nick`	`string`	Value to set user's nickname to.
Role	`roles`	`string[]`	Select a value from the drop down menu.
Mute	`mute`	`boolean`	Whether the user is muted in voice channels. Will throw a 400 error if the user is not in a voice channel
Deaf	`deaf`	`boolean`	Whether the user is deafened in voice channels. Will throw a 400 error if the user is not in a voice channel
Comunication Disabled Until	`comunicationDisabledUntil`	`string`	When the user's timeout will expire and the user will be able to communicate in the guild again (up to 28 days in the future), set to null to remove timeout. Will throw a 403 error if the user has the ADMINISTRATOR permission or is the owner of the guild. E.g. `2025-01-01T13:28:38+00:00`, `2030-01-01`

Authentication#

Discord Bot uses API keys for authentication. When you connect your Discord Bot account, Pipedream securely stores the keys so you can easily authenticate to Discord Bot APIs in both code and no-code steps.

This app allows you to use the Discord API using your own Discord bot. If you don't want to use a custom bot, and you just need to use the Discord API, exit this screen and use the Discord app, instead.

If you want to use your own Discord bot, but haven't created one yet, see these instructions or watch this video. You'll need to add this bot to your server(s) to make successful API requests.

Once you've created your bot, you'll find the Bot token within the Bot section of your app. Enter that token below.

About Discord Bot#

Use this app to interact with the Discord API using a bot in your account

More Ways to Use Discord Bot#

Triggers#

New Message in Channel from the Discord Bot API

Emit new event for each message posted to one or more channels

Try it

New Forum Thread Message from the Discord Bot API

Emit new event for each forum thread message posted. Note that your bot must have the MESSAGE_CONTENT privilege intent to see the message content. See the documentation

Try it

New Guild Member from the Discord Bot API

Emit new event for every member added to a guild. See docs here

Try it

New Tag Added to Forum Thread from the Discord Bot API

Emit new event when a new tag is added to a thread

Try it

New Thread Message from the Discord Bot API

Emit new event for each thread message posted.

Try it