The ID of the guild.
The ID of the user to add.
Add a role to a member.
The ID of the guild.
The ID of the member.
The ID of the role to add.
Optional
reason: stringThe reason for adding the role.
Begine a prune.
The ID of the guild.
Optional
options: BeginPruneOptionsCreate a guild. This can only be used by bots in under 10 guilds.
Create an auto moderation rule for a guild.
The ID of the guild.
Create a bon for a user.
The ID of the guild.
The ID of the user.
Optional
options: CreateBanOptionsCreate a channel in a guild.
The ID of the guild.
Create an emoji in a guild.
The ID of the guild.
Create a guild from a template. This can only be used by bots in less than 10 guilds.
The code of the template to use.
Create a role.
The ID of the guild.
Optional
options: CreateRoleOptionsCreate a scheduled event in a guild.
The ID of the guild.
Create a guild template.
The ID of the guild to create a template from.
Delete a scheduled event.
The ID of the guild.
The ID of the scheduled event.
Optional
reason: stringThe reason for deleting the scheduled event. Discord's docs do not explicitly state a reason can be provided, so it may not be used.
Edit a guild.
The ID of the guild.
Edit an existing auto moderation rule.
The ID of the guild.
The ID of the rule to edit.
Edit the positions of channels in a guild.
The ID of the guild.
The channels to move. Unedited channels do not need to be specifed.
Modify the current member in a guild.
The ID of the guild.
Edit the current member's voice state in a guild. channelID
is required, and the current member must already be in that channel. See Discord's docs for more information.
The ID of the guild.
Edit an existing emoji.
The ID of the guild the emoji is in.
Edit a guild member.
The ID of the guild.
The ID of the member.
Edit an existing role.
The ID of the guild.
Edit the position of roles in a guild.
The ID of the guild.
Optional
reason: stringThe reason for moving the roles.
Edit an existing scheduled event in a guild.
The ID of the guild.
Edit a guild template.
The ID of the guild.
The code of the template.
Edit a guild member's voice state. channelID
is required, and the user must already be in that channel. See Discord's docs for more information.
The ID of the guild.
The ID of the member.
Edit the welcome screen in a guild.
The ID of the guild.
Edit the widget of a guild.
The ID of the guild.
Get the active threads in a guild.
The ID of the guild.
Get a guild's audit log.
Note: everything under the entries
key is raw from Discord. See their documentation for structure and other information. (audit_log_entries
)
The ID of the guild.
Optional
options: GetAuditLogOptionsGet an auto moderation rule for a guild.
The ID of the guild.
The ID of the rule to get.
Get the auto moderation rules for a guild.
The ID of the guild.
Get the bans in a guild.
Optional
options: GetBansOptionsGet the channels in a guild. Does not include threads.
The ID of the guild.
Get an emoji in a guild.
The ID of the guild.
The ID of the emoji to get.
Get the emojis in a guild.
The ID of the guild.
Get the integrations in a guild.
The ID of the guild.
Get the invites of a guild.
The id of the guild to get the invites of.
Get a guild's members. This requires the GUILD_MEMBERS
intent.
The ID of the guild.
Optional
options: GetMembersOptionsGet a preview of a guild. If the client is not already in this guild, the guild must be lurkable.
The ID of the guild.
Get the prune count of a guild.
The ID of the guild.
Optional
options: GetPruneCountOptionsGet a scheduled event.
The ID of the guild.
The ID of the scheduled event to get.
Optional
withUserCount: numberIf the number of users subscribed to the event should be included.
Get the users subscribed to a scheduled event.
Optional
options: GetScheduledEventUsersOptionsGet a guild's scheduled events
The ID of the guild.
Optional
withUserCount: numberIf the number of users subscribed to the event should be included.
Get a guild template.
The code of the template to get.
Get a guild's templates.
The ID of the guild.
Get the vanity url of a guild.
The ID of the guild.
Get the list of usable voice regions for a guild. This will return VIP servers when the guild is VIP-enabled.
The ID of the guild.
Get the welcome screen for a guild.
The ID of the guild.
Get the widget image of a guild.
The ID of the guild.
Optional
style: WidgetImageStyleThe style of the image.
Get a guild's widget settings.
The ID of the guild.
remove a role from a member.
The ID of the guild.
The ID of the member.
The ID of the role to remove.
Optional
reason: stringThe reason for removing the role.
Search the username & nicknames of members in a guild.
The ID of the guild.
Sync a guild template.
The ID of the guild.
The code of the template to sync.
Add a member to a guild. Requires an access token with the
guilds.join
scope.Returns the newly added member upon success, or void if the member is already in the guild.
Returns