RestManager

The ID of the group dm to add the user to.

userId

https://discord.com/developers/docs/resources/channel#group-dm-add-recipient

The user ID of the user to add to the group dm.

options

AddDmRecipientOptions

The options for adding the user

Returns

Promise<void>

Remarks

Requires an OAuth2 access token with the gdm.join scope

See

addGuildMember()

addGuildMember: (guildId, userId, options) => Promise<void>

Defined in: packages/rest/dist/types/types.d.ts:228

Adds a member to a guild.

Parameters

guildId

The ID of the thread to add the member to.

userId

https://discord.com/developers/docs/resources/guild#add-guild-member

The user ID of the member to add to the thread.

options

AddGuildMemberOptions

The options for the add of a guild member

Returns

Promise<void>

Remarks

Requires the bot to be in the specified server Requires an OAuth2 access token with the guilds.join scope

Fires a Guild Member Add gateway event.

See

addReaction()

addReaction: (channelId, messageId, reaction) => Promise<void>

Defined in: packages/rest/dist/types/types.d.ts:149

Adds a reaction to a message.

Parameters

channelId

The ID of the channel the message to add a reaction to is in.

messageId

https://discord.com/developers/docs/resources/channel#create-reaction

The ID of the message to add a reaction to.

reaction

string

The reaction to add to the message.

Returns

Promise<void>

Remarks

Requires the READ_MESSAGE_HISTORY permission.

If nobody else has reacted to the message:

Requires the ADD_REACTIONS permission.

Fires a Message Reaction Add gateway event.

See

addReactions()

addReactions: (channelId, messageId, reactions, ordered?) => Promise<void>

Defined in: packages/rest/dist/types/types.d.ts:168

Adds multiple a reaction to a message.

This function uses the addReaction() helper behind the scenes.

Parameters

channelId

The ID of the channel the message to add reactions to is in.

messageId

The ID of the message to add the reactions to.

reactions

string[]

The reactions to add to the message.

ordered?

boolean

Whether the reactions must be added in order or not.

Returns

Promise<void>

Remarks

Requires the READ_MESSAGE_HISTORY permission.

If nobody else has reacted to the message:

Requires the ADD_REACTIONS permission.

Fires a Message Reaction Add gateway event for every reaction added.

addRole()

addRole: (guildId, userId, roleId, reason?) => Promise<void>

Defined in: packages/rest/dist/types/types.d.ts:184

Adds a role to a member.

Parameters

guildId

The ID of the guild the member to add the role to is in.

userId

The user ID of the member to add the role to.

roleId

https://discord.com/developers/docs/resources/guild#add-guild-member-role

The ID of the role to add to the member.

reason?

string

An optional reason for the action, to be included in the audit log.

Returns

Promise<void>

Remarks

Requires the MANAGE_ROLES permission.

Fires a Guild Member Update gateway event.

See

addThreadMember()

addThreadMember: (channelId, userId) => Promise<void>

Defined in: packages/rest/dist/types/types.d.ts:199

Adds a member to a thread.

Parameters

channelId

The ID of the thread to add the member to.

userId

https://discord.com/developers/docs/resources/channel#add-thread-member

The user ID of the member to add to the thread.

Returns

Promise<void>

Remarks

Requires the ability to send messages in the thread. Requires the thread not be archived.

Fires a Thread Members Update gateway event.

See

applicationId

applicationId: bigint

Defined in: packages/rest/dist/types/types.d.ts:59

The application id. Normally this is not required for recent bots but old bot's application id is sometimes different from the bot id so it is required for those bots.

authorization?

optional authorization: string

Defined in: packages/rest/dist/types/types.d.ts:75

The authorization header value to attach when sending requests to the proxy.

authorizationHeader

authorizationHeader: string

Defined in: packages/rest/dist/types/types.d.ts:77

The authorization header name to attach when sending requests to the proxy

banMember()

banMember: (guildId, userId, options?, reason?) => Promise<void>

Defined in: packages/rest/dist/types/types.d.ts:2560

Bans a user from a guild.

Parameters

guildId

The ID of the guild to ban the user from.

userId

https://discord.com/developers/docs/resources/guild#create-guild-ban

The ID of the user to ban from the guild.

options?

CreateGuildBan

The parameters for the creation of the ban.

reason?

string

An optional reason for the action, to be included in the audit log.

Returns

Promise<void>

Remarks

Requires the BAN_MEMBERS permission.

Fires a Guild Ban Add gateway event.

See

baseUrl

baseUrl: string

Defined in: packages/rest/dist/types/types.d.ts:67

The base url to connect to. If you create a proxy rest, that url would go here. IT SHOULD NOT END WITH A /

Default

https://discord.com/api

bulkBanMembers()

bulkBanMembers: (guildId, options, reason?) => Promise<{ bannedUsers: string[]; failedUsers: string[]; }>

Defined in: packages/rest/dist/types/types.d.ts:2577

Bans up to 200 users from a guild.

Parameters

guildId

https://discord.com/developers/docs/resources/guild#bulk-guild-ban

The ID of the guild to ban the users from.

options

CreateGuildBulkBan

The users to ban and the other options for the ban.

reason?

string

An optional reason for the action, to be included in the audit log.

Returns

Promise<{ bannedUsers: string[]; failedUsers: string[]; }>

Remarks

Requires the BAN_MEMBERS and MANAGE_GUILD permissions.

If all provided users fail to be banned, discord will respond with an error (code: 500000: Failed to ban users)

Fires as many Guild Ban Add gateway events as many user where banned.

See

changeToDiscordFormat()

changeToDiscordFormat: (obj) => any

Defined in: packages/rest/dist/types/types.d.ts:106

Reshapes and modifies the obj as needed to make it ready for discords api.

Parameters

obj

any

Returns

any

checkRateLimits()

checkRateLimits: (url, identifier) => number | false

Defined in: packages/rest/dist/types/types.d.ts:103

Check the rate limits for a url or a bucket.

Parameters

url

string

identifier

string

Returns

number | false

consumeEntitlement()

consumeEntitlement: (applicationId, entitlementId) => Promise<void>

Defined in: packages/rest/dist/types/types.d.ts:2822

For One-Time Purchase consumable SKUs, marks a given entitlement for the user as consumed. The entitlement will have consumed: true when using List Entitlements

Parameters

applicationId

The id of the application to get the entitlement

entitlementId

https://discord.com/developers/docs/resources/emoji#create-application-emoji

The id of the entitlement to get

Returns

Promise<void>

createApplicationEmoji()

createApplicationEmoji: (options) => Promise<{ animated: boolean; available: boolean; id: string; managed: boolean; name: string; requireColons: boolean; roles: string[]; user: { accentColor: number; avatar: null | string; avatarDecorationData: { asset: string; skuId: string; }; banner: string; bot: boolean; discriminator: string; email: null | string; flags: number; globalName: null | string; id: string; locale: string; mfaEnabled: boolean; premiumType: PremiumTypes; publicFlags: number; system: boolean; username: string; verified: boolean; }; }>

Defined in: packages/rest/dist/types/types.d.ts:291

Creates an emoji for the application.

Parameters

options

CreateApplicationEmoji

The parameters for the creation of the emoji.

Returns

Promise<{ animated: boolean; available: boolean; id: string; managed: boolean; name: string; requireColons: boolean; roles: string[]; user: { accentColor: number; avatar: null | string; avatarDecorationData: { asset: string; skuId: string; }; banner: string; bot: boolean; discriminator: string; email: null | string; flags: number; globalName: null | string; id: string; locale: string; mfaEnabled: boolean; premiumType: PremiumTypes; publicFlags: number; system: boolean; username: string; verified: boolean; }; }>

An instance of the created DiscordEmoji.

See

createAutomodRule()

createAutomodRule: (guildId, options, reason?) => Promise<{ actions: object[]; creatorId: string; enabled: boolean; eventType: AutoModerationEventTypes; exemptChannels: string[]; exemptRoles: string[]; guildId: string; id: string; name: string; triggerMetadata: { allowList: string[]; keywordFilter: string[]; mentionRaidProtectionEnabled: boolean; mentionTotalLimit: number; presets: DiscordAutoModerationRuleTriggerMetadataPresets[]; regexPatterns: string[]; }; triggerType: AutoModerationTriggerTypes; }>

Defined in: packages/rest/dist/types/types.d.ts:244

Creates an automod rule in a guild.

Parameters

guildId

CreateAutoModerationRuleOptions

The ID of the guild to create the rule in.

options

The parameters for the creation of the rule.

reason?

string

An optional reason for the action, to be included in the audit log.

Returns

Promise<{ actions: object[]; creatorId: string; enabled: boolean; eventType: AutoModerationEventTypes; exemptChannels: string[]; exemptRoles: string[]; guildId: string; id: string; name: string; triggerMetadata: { allowList: string[]; keywordFilter: string[]; mentionRaidProtectionEnabled: boolean; mentionTotalLimit: number; presets: DiscordAutoModerationRuleTriggerMetadataPresets[]; regexPatterns: string[]; }; triggerType: AutoModerationTriggerTypes; }>

An instance of the created DiscordAutoModerationRule.

Remarks

Requires the MANAGE_GUILD permission.

Fires an Auto Moderation Rule Create gateway event.

See

https://discord.com/developers/docs/resources/auto-moderation#create-auto-moderation-rule

createBaseHeaders()

createBaseHeaders: () => Record<string, string>

Defined in: packages/rest/dist/types/types.d.ts:99

Allows the user to inject custom headers that will be sent with every request.

Returns

Record<string, string>

createChannel()

createChannel: (guildId, options, reason?) => Promise<{ applicationId: string; appliedTags: string[]; availableTags: object[]; bitrate: number; defaultAutoArchiveDuration: number; defaultForumLayout: ForumLayout; defaultReactionEmoji: null | { emojiId: string; emojiName: null | string; }; defaultSortOrder: null | SortOrderTypes; defaultThreadRateLimitPerUser: number; flags: ChannelFlags; guildId: string; icon: string; id: string; lastMessageId: null | string; lastPinTimestamp: null | string; managed: boolean; member: { flags: number; id: string; joinTimestamp: string; userId: string; }; memberCount: number; messageCount: number; name: string; newlyCreated: boolean; nsfw: boolean; ownerId: string; parentId: null | string; permissionOverwrites: object[]; permissions: string; position: number; rateLimitPerUser: number; recipients: object[]; rtcRegion: null | string; threadMetadata: { archived: boolean; archiveTimestamp: string; autoArchiveDuration: 60 | 1440 | 4320 | 10080; createTimestamp: null | string; invitable: boolean; locked: boolean; }; topic: null | string; totalMessageSent: number; type: ChannelTypes; userLimit: number; videoQualityMode: VideoQualityModes; }>

Defined in: packages/rest/dist/types/types.d.ts:264

Creates a channel within a guild.

Parameters

guildId

https://discord.com/developers/docs/resources/guild#create-guild-channel

The ID of the guild to create the channel within.

options

CreateGuildChannel

The parameters for the creation of the channel.

reason?

string

An optional reason for the action, to be included in the audit log.

Returns

Promise<{ applicationId: string; appliedTags: string[]; availableTags: object[]; bitrate: number; defaultAutoArchiveDuration: number; defaultForumLayout: ForumLayout; defaultReactionEmoji: null | { emojiId: string; emojiName: null | string; }; defaultSortOrder: null | SortOrderTypes; defaultThreadRateLimitPerUser: number; flags: ChannelFlags; guildId: string; icon: string; id: string; lastMessageId: null | string; lastPinTimestamp: null | string; managed: boolean; member: { flags: number; id: string; joinTimestamp: string; userId: string; }; memberCount: number; messageCount: number; name: string; newlyCreated: boolean; nsfw: boolean; ownerId: string; parentId: null | string; permissionOverwrites: object[]; permissions: string; position: number; rateLimitPerUser: number; recipients: object[]; rtcRegion: null | string; threadMetadata: { archived: boolean; archiveTimestamp: string; autoArchiveDuration: 60 | 1440 | 4320 | 10080; createTimestamp: null | string; invitable: boolean; locked: boolean; }; topic: null | string; totalMessageSent: number; type: ChannelTypes; userLimit: number; videoQualityMode: VideoQualityModes; }>

An instance of the created DiscordChannel.

Remarks

Requires the MANAGE_CHANNELS permission.

If setting permission overwrites, only the permissions the bot user has in the guild can be allowed or denied.

Setting the MANAGE_ROLES permission is only possible for guild administrators.

Fires a Channel Create gateway event.

See

createEmoji()

createEmoji: (guildId, options, reason?) => Promise<{ animated: boolean; available: boolean; id: string; managed: boolean; name: string; requireColons: boolean; roles: string[]; user: { accentColor: number; avatar: null | string; avatarDecorationData: { asset: string; skuId: string; }; banner: string; bot: boolean; discriminator: string; email: null | string; flags: number; globalName: null | string; id: string; locale: string; mfaEnabled: boolean; premiumType: PremiumTypes; publicFlags: number; system: boolean; username: string; verified: boolean; }; }>

Defined in: packages/rest/dist/types/types.d.ts:282

Creates an emoji in a guild.

Parameters

guildId

https://discord.com/developers/docs/resources/emoji#create-guild-emoji

The ID of the guild in which to create the emoji.

options

CreateGuildEmoji

The parameters for the creation of the emoji.

reason?

string

An optional reason for the action, to be included in the audit log.

Returns

An instance of the created DiscordEmoji.

Remarks

Requires the CREATE_GUILD_EXPRESSIONS permission.

Emojis have a maximum file size of 256 kilobits. Attempting to upload a larger emoji will cause the route to return 400 Bad Request.

Fires a Guild Emojis Update gateway event.

See

createForumThread()

createForumThread: (channelId, options, reason?) => Promise<{ applicationId: string; appliedTags: string[]; availableTags: object[]; bitrate: number; defaultAutoArchiveDuration: number; defaultForumLayout: ForumLayout; defaultReactionEmoji: null | { emojiId: string; emojiName: null | string; }; defaultSortOrder: null | SortOrderTypes; defaultThreadRateLimitPerUser: number; flags: ChannelFlags; guildId: string; icon: string; id: string; lastMessageId: null | string; lastPinTimestamp: null | string; managed: boolean; member: { flags: number; id: string; joinTimestamp: string; userId: string; }; memberCount: number; messageCount: number; name: string; newlyCreated: boolean; nsfw: boolean; ownerId: string; parentId: null | string; permissionOverwrites: object[]; permissions: string; position: number; rateLimitPerUser: number; recipients: object[]; rtcRegion: null | string; threadMetadata: { archived: boolean; archiveTimestamp: string; autoArchiveDuration: 60 | 1440 | 4320 | 10080; createTimestamp: null | string; invitable: boolean; locked: boolean; }; topic: null | string; totalMessageSent: number; type: ChannelTypes; userLimit: number; videoQualityMode: VideoQualityModes; }>

Defined in: packages/rest/dist/types/types.d.ts:308

Creates a new thread in a forum channel or media channel, and sends a message within the created thread.

Parameters

channelId

CreateForumPostWithMessage

The ID of the forum channel to create the thread within.

options

The parameters for the creation of the thread.

reason?

string

An optional reason for the action, to be included in the audit log.

Returns

An instance of DiscordChannel with a nested DiscordChannel object.

Remarks

Requires the CREATE_MESSAGES permission.

Fires a Thread Create gateway event. Fires a Message Create gateway event.

See

https://discord.com/developers/docs/resources/channel#start-thread-in-forum-or-media-channel

createGlobalApplicationCommand()

createGlobalApplicationCommand: (command, options?) => Promise<{ applicationId: string; contexts: null | DiscordInteractionContextType[]; defaultMemberPermissions: null | string; description: string; descriptionLocalizations: null | { bg: string; cs: string; da: string; de: string; el: string; en-GB: string; en-US: string; es-419: string; es-ES: string; fi: string; fr: string; hi: string; hr: string; hu: string; id: string; it: string; ja: string; ko: string; lt: string; nl: string; no: string; pl: string; pt-BR: string; ro: string; ru: string; sv-SE: string; th: string; tr: string; uk: string; vi: string; zh-CN: string; zh-TW: string; }; dmPermission: boolean; guildId: string; handler: DiscordInteractionEntryPointCommandHandlerType; id: string; integrationTypes: DiscordApplicationIntegrationType[]; name: string; nameLocalizations: null | { bg: string; cs: string; da: string; de: string; el: string; en-GB: string; en-US: string; es-419: string; es-ES: string; fi: string; fr: string; hi: string; hr: string; hu: string; id: string; it: string; ja: string; ko: string; lt: string; nl: string; no: string; pl: string; pt-BR: string; ro: string; ru: string; sv-SE: string; th: string; tr: string; uk: string; vi: string; zh-CN: string; zh-TW: string; }; nsfw: boolean; options: object[]; type: ApplicationCommandTypes; version: string; }>

Defined in: packages/rest/dist/types/types.d.ts:326

Creates an application command accessible globally; across different guilds and channels.

Parameters

command

CreateGlobalApplicationCommandOptions

The command to create.

options?

Additional options for the endpoint

Returns

Promise<{ applicationId: string; contexts: null | DiscordInteractionContextType[]; defaultMemberPermissions: null | string; description: string; descriptionLocalizations: null | { bg: string; cs: string; da: string; de: string; el: string; en-GB: string; en-US: string; es-419: string; es-ES: string; fi: string; fr: string; hi: string; hr: string; hu: string; id: string; it: string; ja: string; ko: string; lt: string; nl: string; no: string; pl: string; pt-BR: string; ro: string; ru: string; sv-SE: string; th: string; tr: string; uk: string; vi: string; zh-CN: string; zh-TW: string; }; dmPermission: boolean; guildId: string; handler: DiscordInteractionEntryPointCommandHandlerType; id: string; integrationTypes: DiscordApplicationIntegrationType[]; name: string; nameLocalizations: null | { bg: string; cs: string; da: string; de: string; el: string; en-GB: string; en-US: string; es-419: string; es-ES: string; fi: string; fr: string; hi: string; hr: string; hu: string; id: string; it: string; ja: string; ko: string; lt: string; nl: string; no: string; pl: string; pt-BR: string; ro: string; ru: string; sv-SE: string; th: string; tr: string; uk: string; vi: string; zh-CN: string; zh-TW: string; }; nsfw: boolean; options: object[]; type: ApplicationCommandTypes; version: string; }>

An instance of the created DiscordApplicationCommand.

Remarks

⚠️ Creating a command with the same name as an existing command for your application will overwrite the old command. ⚠️ Global commands once created are cached for periods of an hour, so changes made to existing commands will take an hour to surface. ⚠️ You can only create up to 200 new commands daily.

When using the bearer token the token needs the applications.commands.update scope and must be a Client grant token. You will be able to update only your own application commands

See

https://discord.com/developers/docs/interactions/application-commands#create-global-application-command

createGuild()

createGuild: (options) => Promise<{ afkChannelId: null | string; afkTimeout: number; applicationId: null | string; approximateMemberCount: number; approximatePresenceCount: number; banner: null | string; channels: object[]; defaultMessageNotifications: DefaultMessageNotificationLevels; description: null | string; discoverySplash: null | string; emojis: object[]; explicitContentFilter: ExplicitContentFilterLevels; features: GuildFeatures[]; icon: null | string; iconHash: null | string; id: string; joinedAt: string; large: boolean; maxMembers: number; maxPresences: null | number; maxStageVideoChannelUsers: number; maxVideoChannelUsers: number; memberCount: number; members: object[]; mfaLevel: MfaLevels; name: string; nsfwLevel: GuildNsfwLevel; owner: boolean; ownerId: string; permissions: string; preferredLocale: string; premiumProgressBarEnabled: boolean; premiumSubscriptionCount: number; premiumTier: PremiumTiers; presences: object[]; publicUpdatesChannelId: null | string; roles: object[]; rulesChannelId: null | string; safetyAlertsChannelId: null | string; soundboardSounds: object[]; splash: null | string; stageInstances: object[]; stickers: object[]; systemChannelFlags: SystemChannelFlags; systemChannelId: null | string; threads: object[]; unavailable: boolean; vanityUrlCode: null | string; verificationLevel: VerificationLevels; voiceStates: object[]; welcomeScreen: { description: null | string; welcomeChannels: object[]; }; widgetChannelId: null | string; widgetEnabled: boolean; }>

Defined in: packages/rest/dist/types/types.d.ts:340

Creates a guild.

Parameters

options

CreateGuild

The parameters for the creation of the guild.

Returns

Promise<{ afkChannelId: null | string; afkTimeout: number; applicationId: null | string; approximateMemberCount: number; approximatePresenceCount: number; banner: null | string; channels: object[]; defaultMessageNotifications: DefaultMessageNotificationLevels; description: null | string; discoverySplash: null | string; emojis: object[]; explicitContentFilter: ExplicitContentFilterLevels; features: GuildFeatures[]; icon: null | string; iconHash: null | string; id: string; joinedAt: string; large: boolean; maxMembers: number; maxPresences: null | number; maxStageVideoChannelUsers: number; maxVideoChannelUsers: number; memberCount: number; members: object[]; mfaLevel: MfaLevels; name: string; nsfwLevel: GuildNsfwLevel; owner: boolean; ownerId: string; permissions: string; preferredLocale: string; premiumProgressBarEnabled: boolean; premiumSubscriptionCount: number; premiumTier: PremiumTiers; presences: object[]; publicUpdatesChannelId: null | string; roles: object[]; rulesChannelId: null | string; safetyAlertsChannelId: null | string; soundboardSounds: object[]; splash: null | string; stageInstances: object[]; stickers: object[]; systemChannelFlags: SystemChannelFlags; systemChannelId: null | string; threads: object[]; unavailable: boolean; vanityUrlCode: null | string; verificationLevel: VerificationLevels; voiceStates: object[]; welcomeScreen: { description: null | string; welcomeChannels: object[]; }; widgetChannelId: null | string; widgetEnabled: boolean; }>

An instance of the created DiscordGuild.

Remarks

⚠️ This route can only be used by bots in fewer than 10 guilds.

Fires a Guild Create gateway event.

See

https://discord.com/developers/docs/resources/guild#create-guild

createGuildApplicationCommand()

createGuildApplicationCommand: (command, guildId, options?) => Promise<{ applicationId: string; contexts: null | DiscordInteractionContextType[]; defaultMemberPermissions: null | string; description: string; descriptionLocalizations: null | { bg: string; cs: string; da: string; de: string; el: string; en-GB: string; en-US: string; es-419: string; es-ES: string; fi: string; fr: string; hi: string; hr: string; hu: string; id: string; it: string; ja: string; ko: string; lt: string; nl: string; no: string; pl: string; pt-BR: string; ro: string; ru: string; sv-SE: string; th: string; tr: string; uk: string; vi: string; zh-CN: string; zh-TW: string; }; dmPermission: boolean; guildId: string; handler: DiscordInteractionEntryPointCommandHandlerType; id: string; integrationTypes: DiscordApplicationIntegrationType[]; name: string; nameLocalizations: null | { bg: string; cs: string; da: string; de: string; el: string; en-GB: string; en-US: string; es-419: string; es-ES: string; fi: string; fr: string; hi: string; hr: string; hu: string; id: string; it: string; ja: string; ko: string; lt: string; nl: string; no: string; pl: string; pt-BR: string; ro: string; ru: string; sv-SE: string; th: string; tr: string; uk: string; vi: string; zh-CN: string; zh-TW: string; }; nsfw: boolean; options: object[]; type: ApplicationCommandTypes; version: string; }>

Defined in: packages/rest/dist/types/types.d.ts:358

Creates an application command only accessible in a specific guild.

Parameters

command

The command to create.

guildId

CreateGuildApplicationCommandOptions

The ID of the guild to create the command for.

options?

Additional options for the endpoint

Returns

An instance of the created DiscordApplicationCommand.

Remarks

⚠️ Creating a command with the same name as an existing command for your application will overwrite the old command. ⚠️ You can only create up to 200 new commands daily.

When using the bearer token the token needs the applications.commands.update scope and must be a Client grant token. You will be able to update only your own application commands

See

https://discord.com/developers/docs/interactions/application-commands#create-guild-application-command

createGuildFromTemplate()

createGuildFromTemplate: (templateCode, options) => Promise<{ afkChannelId: null | string; afkTimeout: number; applicationId: null | string; approximateMemberCount: number; approximatePresenceCount: number; banner: null | string; channels: object[]; defaultMessageNotifications: DefaultMessageNotificationLevels; description: null | string; discoverySplash: null | string; emojis: object[]; explicitContentFilter: ExplicitContentFilterLevels; features: GuildFeatures[]; icon: null | string; iconHash: null | string; id: string; joinedAt: string; large: boolean; maxMembers: number; maxPresences: null | number; maxStageVideoChannelUsers: number; maxVideoChannelUsers: number; memberCount: number; members: object[]; mfaLevel: MfaLevels; name: string; nsfwLevel: GuildNsfwLevel; owner: boolean; ownerId: string; permissions: string; preferredLocale: string; premiumProgressBarEnabled: boolean; premiumSubscriptionCount: number; premiumTier: PremiumTiers; presences: object[]; publicUpdatesChannelId: null | string; roles: object[]; rulesChannelId: null | string; safetyAlertsChannelId: null | string; soundboardSounds: object[]; splash: null | string; stageInstances: object[]; stickers: object[]; systemChannelFlags: SystemChannelFlags; systemChannelId: null | string; threads: object[]; unavailable: boolean; vanityUrlCode: null | string; verificationLevel: VerificationLevels; voiceStates: object[]; welcomeScreen: { description: null | string; welcomeChannels: object[]; }; widgetChannelId: null | string; widgetEnabled: boolean; }>

Defined in: packages/rest/dist/types/types.d.ts:373

Creates a guild from a template.

Parameters

templateCode

string

The code of the template.

options

CreateGuildFromTemplate

The parameters for the creation of the guild.

Returns

An instance of the created DiscordGuild.

Remarks

⚠️ This route can only be used by bots in fewer than 10 guilds.

Fires a Guild Create gateway event.

See

https://discord.com/developers/docs/resources/guild-template#create-guild-from-guild-template

createGuildSoundboardSound()

createGuildSoundboardSound: (guildId, options, reason?) => Promise<{ available: boolean; emojiId: null | string; emojiName: null | string; guildId: string; name: string; soundId: string; user: { accentColor: number; avatar: null | string; avatarDecorationData: { asset: string; skuId: string; }; banner: string; bot: boolean; discriminator: string; email: null | string; flags: number; globalName: null | string; id: string; locale: string; mfaEnabled: boolean; premiumType: PremiumTypes; publicFlags: number; system: boolean; username: string; verified: boolean; }; volume: number; }>

Defined in: packages/rest/dist/types/types.d.ts:2888

Create a new soundboard sound for the guild.

Parameters

guildId

CreateGuildSoundboardSound

The guild to create the sounds in

options

The options to create the sound

reason?

string

The audit log reason

Returns

Promise<{ available: boolean; emojiId: null | string; emojiName: null | string; guildId: string; name: string; soundId: string; user: { accentColor: number; avatar: null | string; avatarDecorationData: { asset: string; skuId: string; }; banner: string; bot: boolean; discriminator: string; email: null | string; flags: number; globalName: null | string; id: string; locale: string; mfaEnabled: boolean; premiumType: PremiumTypes; publicFlags: number; system: boolean; username: string; verified: boolean; }; volume: number; }>

Remarks

Fires a Guild Soundboard Sound Create Gateway event.

Requires the CREATE_GUILD_EXPRESSIONS permission.

createGuildSticker()

createGuildSticker: (guildId, options, reason?) => Promise<{ available: boolean; description: string; formatType: StickerFormatTypes; guildId: string; id: string; name: string; packId: string; sortValue: number; tags: string; type: StickerTypes; user: { accentColor: number; avatar: null | string; avatarDecorationData: { asset: string; skuId: string; }; banner: string; bot: boolean; discriminator: string; email: null | string; flags: number; globalName: null | string; id: string; locale: string; mfaEnabled: boolean; premiumType: PremiumTypes; publicFlags: number; system: boolean; username: string; verified: boolean; }; }>

Defined in: packages/rest/dist/types/types.d.ts:389

Create a new sticker for the guild.

Parameters

guildId

CreateGuildStickerOptions

The ID of the guild to get

options

reason?

string

An optional reason for the action, to be included in the audit log.

Returns

Promise<{ available: boolean; description: string; formatType: StickerFormatTypes; guildId: string; id: string; name: string; packId: string; sortValue: number; tags: string; type: StickerTypes; user: { accentColor: number; avatar: null | string; avatarDecorationData: { asset: string; skuId: string; }; banner: string; bot: boolean; discriminator: string; email: null | string; flags: number; globalName: null | string; id: string; locale: string; mfaEnabled: boolean; premiumType: PremiumTypes; publicFlags: number; system: boolean; username: string; verified: boolean; }; }>

https://discord.com/developers/docs/resources/sticker#create-guild-sticker

Remarks

Requires the CREATE_GUILD_EXPRESSIONS permission. Fires a Guild Stickers Update Gateway event. Every guilds has five free sticker slots by default, and each Boost level will grant access to more slots. Lottie stickers can only be uploaded on guilds that have either the VERIFIED and/or the PARTNERED guild feature.

See

createGuildTemplate()

createGuildTemplate: (guildId, options) => Promise<{ code: string; createdAt: string; creator: { accentColor: number; avatar: null | string; avatarDecorationData: { asset: string; skuId: string; }; banner: string; bot: boolean; discriminator: string; email: null | string; flags: number; globalName: null | string; id: string; locale: string; mfaEnabled: boolean; premiumType: PremiumTypes; publicFlags: number; system: boolean; username: string; verified: boolean; }; creatorId: string; description: null | string; isDirty: null | boolean; name: string; serializedSourceGuild: { afkChannelId: null | number; afkTimeout: number; applicationId: null | string; approximateMemberCount: number; approximatePresenceCount: number; banner: null | string; channels: object[]; defaultMessageNotifications: DefaultMessageNotificationLevels; description: null | string; discoverySplash: null | string; emojis: object[]; explicitContentFilter: ExplicitContentFilterLevels; features: GuildFeatures[]; icon: null | string; iconHash: null | string; id: string; joinedAt: string; large: boolean; maxMembers: number; maxPresences: null | number; maxStageVideoChannelUsers: number; maxVideoChannelUsers: number; memberCount: number; members: object[]; mfaLevel: MfaLevels; name: string; nsfwLevel: GuildNsfwLevel; owner: boolean; ownerId: string; permissions: string; preferredLocale: string; premiumProgressBarEnabled: boolean; premiumSubscriptionCount: number; premiumTier: PremiumTiers; presences: object[]; publicUpdatesChannelId: null | string; roles: object[]; rulesChannelId: null | string; safetyAlertsChannelId: null | string; soundboardSounds: object[]; splash: null | string; stageInstances: object[]; stickers: object[]; systemChannelFlags: SystemChannelFlags; systemChannelId: null | number; threads: object[]; unavailable: boolean; vanityUrlCode: null | string; verificationLevel: VerificationLevels; voiceStates: object[]; welcomeScreen: { description: null | string; welcomeChannels: object[]; }; widgetChannelId: null | string; widgetEnabled: boolean; }; sourceGuildId: string; updatedAt: string; usageCount: number; }>

Defined in: packages/rest/dist/types/types.d.ts:404

Creates a template from a guild.

Parameters

guildId

https://discord.com/developers/docs/resources/guild-template#create-guild-template

The ID of the guild to create the template from.

options

CreateTemplate

The parameters for the creation of the template.

Returns

Promise<{ code: string; createdAt: string; creator: { accentColor: number; avatar: null | string; avatarDecorationData: { asset: string; skuId: string; }; banner: string; bot: boolean; discriminator: string; email: null | string; flags: number; globalName: null | string; id: string; locale: string; mfaEnabled: boolean; premiumType: PremiumTypes; publicFlags: number; system: boolean; username: string; verified: boolean; }; creatorId: string; description: null | string; isDirty: null | boolean; name: string; serializedSourceGuild: { afkChannelId: null | number; afkTimeout: number; applicationId: null | string; approximateMemberCount: number; approximatePresenceCount: number; banner: null | string; channels: object[]; defaultMessageNotifications: DefaultMessageNotificationLevels; description: null | string; discoverySplash: null | string; emojis: object[]; explicitContentFilter: ExplicitContentFilterLevels; features: GuildFeatures[]; icon: null | string; iconHash: null | string; id: string; joinedAt: string; large: boolean; maxMembers: number; maxPresences: null | number; maxStageVideoChannelUsers: number; maxVideoChannelUsers: number; memberCount: number; members: object[]; mfaLevel: MfaLevels; name: string; nsfwLevel: GuildNsfwLevel; owner: boolean; ownerId: string; permissions: string; preferredLocale: string; premiumProgressBarEnabled: boolean; premiumSubscriptionCount: number; premiumTier: PremiumTiers; presences: object[]; publicUpdatesChannelId: null | string; roles: object[]; rulesChannelId: null | string; safetyAlertsChannelId: null | string; soundboardSounds: object[]; splash: null | string; stageInstances: object[]; stickers: object[]; systemChannelFlags: SystemChannelFlags; systemChannelId: null | number; threads: object[]; unavailable: boolean; vanityUrlCode: null | string; verificationLevel: VerificationLevels; voiceStates: object[]; welcomeScreen: { description: null | string; welcomeChannels: object[]; }; widgetChannelId: null | string; widgetEnabled: boolean; }; sourceGuildId: string; updatedAt: string; usageCount: number; }>

An instance of the created DiscordTemplate.

Remarks

Requires the MANAGE_GUILD permission.

Fires a Guild Update gateway event.

See

createInvite()

createInvite: (channelId, options?, reason?) => Promise<{ approximateMemberCount: number; approximatePresenceCount: number; channel: null | { applicationId: string; appliedTags: string[]; availableTags: object[]; bitrate: number; defaultAutoArchiveDuration: number; defaultForumLayout: ForumLayout; defaultReactionEmoji: null | { emojiId: string; emojiName: null | string; }; defaultSortOrder: null | SortOrderTypes; defaultThreadRateLimitPerUser: number; flags: ChannelFlags; guildId: string; icon: string; id: string; lastMessageId: null | string; lastPinTimestamp: null | string; managed: boolean; member: { flags: number; id: string; joinTimestamp: string; userId: string; }; memberCount: number; messageCount: number; name: string; newlyCreated: boolean; nsfw: boolean; ownerId: string; parentId: null | string; permissionOverwrites: object[]; permissions: string; position: number; rateLimitPerUser: number; recipients: object[]; rtcRegion: null | string; threadMetadata: { archived: boolean; archiveTimestamp: string; autoArchiveDuration: 60 | 1440 | 4320 | 10080; createTimestamp: null | string; invitable: boolean; locked: boolean; }; topic: null | string; totalMessageSent: number; type: ChannelTypes; userLimit: number; videoQualityMode: VideoQualityModes; }; code: string; expiresAt: null | string; guild: { afkChannelId: null | string; afkTimeout: number; applicationId: null | string; approximateMemberCount: number; approximatePresenceCount: number; banner: null | string; channels: object[]; defaultMessageNotifications: DefaultMessageNotificationLevels; description: null | string; discoverySplash: null | string; emojis: object[]; explicitContentFilter: ExplicitContentFilterLevels; features: GuildFeatures[]; icon: null | string; iconHash: null | string; id: string; joinedAt: string; large: boolean; maxMembers: number; maxPresences: null | number; maxStageVideoChannelUsers: number; maxVideoChannelUsers: number; memberCount: number; members: object[]; mfaLevel: MfaLevels; name: string; nsfwLevel: GuildNsfwLevel; owner: boolean; ownerId: string; permissions: string; preferredLocale: string; premiumProgressBarEnabled: boolean; premiumSubscriptionCount: number; premiumTier: PremiumTiers; presences: object[]; publicUpdatesChannelId: null | string; roles: object[]; rulesChannelId: null | string; safetyAlertsChannelId: null | string; soundboardSounds: object[]; splash: null | string; stageInstances: object[]; stickers: object[]; systemChannelFlags: SystemChannelFlags; systemChannelId: null | string; threads: object[]; unavailable: boolean; vanityUrlCode: null | string; verificationLevel: VerificationLevels; voiceStates: object[]; welcomeScreen: { description: null | string; welcomeChannels: object[]; }; widgetChannelId: null | string; widgetEnabled: boolean; }; guildScheduledEvent: { channelId: null | string; creator: { accentColor: number; avatar: null | string; avatarDecorationData: { asset: string; skuId: string; }; banner: string; bot: boolean; discriminator: string; email: null | string; flags: number; globalName: null | string; id: string; locale: string; mfaEnabled: boolean; premiumType: PremiumTypes; publicFlags: number; system: boolean; username: string; verified: boolean; }; creatorId: null | string; description: string; entityId: null | string; entityMetadata: null | { location: string; }; entityType: ScheduledEventEntityType; guildId: string; id: string; image: null | string; name: string; privacyLevel: GuildOnly; recurrenceRule: null | { byMonth: null | DiscordScheduledEventRecurrenceRuleMonth[]; byMonthDay: null | number[]; byNWeekday: null | object[]; byWeekday: null | DiscordScheduledEventRecurrenceRuleWeekday[]; byYearDay: null | number[]; count: null | number; end: null | string; frequency: DiscordScheduledEventRecurrenceRuleFrequency; interval: number; start: string; }; scheduledEndTime: null | string; scheduledStartTime: string; status: ScheduledEventStatus; userCount: number; }; inviter: { accentColor: number; avatar: null | string; avatarDecorationData: { asset: string; skuId: string; }; banner: string; bot: boolean; discriminator: string; email: null | string; flags: number; globalName: null | string; id: string; locale: string; mfaEnabled: boolean; premiumType: PremiumTypes; publicFlags: number; system: boolean; username: string; verified: boolean; }; stageInstance: { members: object[]; participantCount: number; speakerCount: number; topic: string; }; targetApplication: { approximateGuildCount: number; approximateUserInstallCount: number; bot: { accentColor: number; avatar: null | string; avatarDecorationData: { asset: string; skuId: string; }; banner: string; bot: boolean; discriminator: string; email: null | string; flags: number; globalName: null | string; id: string; locale: string; mfaEnabled: boolean; premiumType: PremiumTypes; publicFlags: number; system: boolean; username: string; verified: boolean; }; botPublic: boolean; botRequireCodeGrant: boolean; coverImage: string; customInstallUrl: string; description: string; eventWebhooksStatus: DiscordApplicationEventWebhookStatus; eventWebhooksTypes: DiscordWebhookEventType[]; eventWebhooksUrl: null | string; flags: ApplicationFlags; guild: { afkChannelId: null | string; afkTimeout: number; applicationId: null | string; approximateMemberCount: number; approximatePresenceCount: number; banner: null | string; channels: object[]; defaultMessageNotifications: DefaultMessageNotificationLevels; description: null | string; discoverySplash: null | string; emojis: object[]; explicitContentFilter: ExplicitContentFilterLevels; features: GuildFeatures[]; icon: null | string; iconHash: null | string; id: string; joinedAt: string; large: boolean; maxMembers: number; maxPresences: null | number; maxStageVideoChannelUsers: number; maxVideoChannelUsers: number; memberCount: number; members: object[]; mfaLevel: MfaLevels; name: string; nsfwLevel: GuildNsfwLevel; owner: boolean; ownerId: string; permissions: string; preferredLocale: string; premiumProgressBarEnabled: boolean; premiumSubscriptionCount: number; premiumTier: PremiumTiers; presences: object[]; publicUpdatesChannelId: null | string; roles: object[]; rulesChannelId: null | string; safetyAlertsChannelId: null | string; soundboardSounds: object[]; splash: null | string; stageInstances: object[]; stickers: object[]; systemChannelFlags: SystemChannelFlags; systemChannelId: null | string; threads: object[]; unavailable: boolean; vanityUrlCode: null | string; verificationLevel: VerificationLevels; voiceStates: object[]; welcomeScreen: { description: null | string; welcomeChannels: object[]; }; widgetChannelId: null | string; widgetEnabled: boolean; }; guildId: string; icon: null | string; id: string; installParams: { permissions: string; scopes: OAuth2Scope[]; }; integrationTypesConfig: { 0: { oauth2InstallParams: { permissions: ...; scopes: ...; }; }; 1: { oauth2InstallParams: { permissions: ...; scopes: ...; }; }; }; interactionsEndpointUrl: null | string; name: string; owner: { accentColor: number; avatar: null | string; avatarDecorationData: { asset: string; skuId: string; }; banner: string; bot: boolean; discriminator: string; email: null | string; flags: number; globalName: null | string; id: string; locale: string; mfaEnabled: boolean; premiumType: PremiumTypes; publicFlags: number; system: boolean; username: string; verified: boolean; }; primarySkuId: string; privacyPolicyUrl: string; redirectUris: string[]; roleConnectionsVerificationUrl: null | string; rpcOrigins: string[]; slug: string; tags: string[]; team: null | { icon: null | string; id: string; members: object[]; name: string; ownerUserId: string; }; termsOfServiceUrl: string; verifyKey: string; }; targetType: TargetTypes; targetUser: { accentColor: number; avatar: null | string; avatarDecorationData: { asset: string; skuId: string; }; banner: string; bot: boolean; discriminator: string; email: null | string; flags: number; globalName: null | string; id: string; locale: string; mfaEnabled: boolean; premiumType: PremiumTypes; publicFlags: number; system: boolean; username: string; verified: boolean; }; type: DiscordInviteType; }>

Defined in: packages/rest/dist/types/types.d.ts:423

Creates an invite to a channel in a guild.

Parameters

channelId

https://discord.com/developers/docs/resources/channel#create-channel-invite

The ID of the channel to create the invite to.

options?

CreateChannelInvite

The parameters for the creation of the invite.

reason?

string

An optional reason for the action, to be included in the audit log.

Returns

Promise<{ approximateMemberCount: number; approximatePresenceCount: number; channel: null | { applicationId: string; appliedTags: string[]; availableTags: object[]; bitrate: number; defaultAutoArchiveDuration: number; defaultForumLayout: ForumLayout; defaultReactionEmoji: null | { emojiId: string; emojiName: null | string; }; defaultSortOrder: null | SortOrderTypes; defaultThreadRateLimitPerUser: number; flags: ChannelFlags; guildId: string; icon: string; id: string; lastMessageId: null | string; lastPinTimestamp: null | string; managed: boolean; member: { flags: number; id: string; joinTimestamp: string; userId: string; }; memberCount: number; messageCount: number; name: string; newlyCreated: boolean; nsfw: boolean; ownerId: string; parentId: null | string; permissionOverwrites: object[]; permissions: string; position: number; rateLimitPerUser: number; recipients: object[]; rtcRegion: null | string; threadMetadata: { archived: boolean; archiveTimestamp: string; autoArchiveDuration: 60 | 1440 | 4320 | 10080; createTimestamp: null | string; invitable: boolean; locked: boolean; }; topic: null | string; totalMessageSent: number; type: ChannelTypes; userLimit: number; videoQualityMode: VideoQualityModes; }; code: string; expiresAt: null | string; guild: { afkChannelId: null | string; afkTimeout: number; applicationId: null | string; approximateMemberCount: number; approximatePresenceCount: number; banner: null | string; channels: object[]; defaultMessageNotifications: DefaultMessageNotificationLevels; description: null | string; discoverySplash: null | string; emojis: object[]; explicitContentFilter: ExplicitContentFilterLevels; features: GuildFeatures[]; icon: null | string; iconHash: null | string; id: string; joinedAt: string; large: boolean; maxMembers: number; maxPresences: null | number; maxStageVideoChannelUsers: number; maxVideoChannelUsers: number; memberCount: number; members: object[]; mfaLevel: MfaLevels; name: string; nsfwLevel: GuildNsfwLevel; owner: boolean; ownerId: string; permissions: string; preferredLocale: string; premiumProgressBarEnabled: boolean; premiumSubscriptionCount: number; premiumTier: PremiumTiers; presences: object[]; publicUpdatesChannelId: null | string; roles: object[]; rulesChannelId: null | string; safetyAlertsChannelId: null | string; soundboardSounds: object[]; splash: null | string; stageInstances: object[]; stickers: object[]; systemChannelFlags: SystemChannelFlags; systemChannelId: null | string; threads: object[]; unavailable: boolean; vanityUrlCode: null | string; verificationLevel: VerificationLevels; voiceStates: object[]; welcomeScreen: { description: null | string; welcomeChannels: object[]; }; widgetChannelId: null | string; widgetEnabled: boolean; }; guildScheduledEvent: { channelId: null | string; creator: { accentColor: number; avatar: null | string; avatarDecorationData: { asset: string; skuId: string; }; banner: string; bot: boolean; discriminator: string; email: null | string; flags: number; globalName: null | string; id: string; locale: string; mfaEnabled: boolean; premiumType: PremiumTypes; publicFlags: number; system: boolean; username: string; verified: boolean; }; creatorId: null | string; description: string; entityId: null | string; entityMetadata: null | { location: string; }; entityType: ScheduledEventEntityType; guildId: string; id: string; image: null | string; name: string; privacyLevel: GuildOnly; recurrenceRule: null | { byMonth: null | DiscordScheduledEventRecurrenceRuleMonth[]; byMonthDay: null | number[]; byNWeekday: null | object[]; byWeekday: null | DiscordScheduledEventRecurrenceRuleWeekday[]; byYearDay: null | number[]; count: null | number; end: null | string; frequency: DiscordScheduledEventRecurrenceRuleFrequency; interval: number; start: string; }; scheduledEndTime: null | string; scheduledStartTime: string; status: ScheduledEventStatus; userCount: number; }; inviter: { accentColor: number; avatar: null | string; avatarDecorationData: { asset: string; skuId: string; }; banner: string; bot: boolean; discriminator: string; email: null | string; flags: number; globalName: null | string; id: string; locale: string; mfaEnabled: boolean; premiumType: PremiumTypes; publicFlags: number; system: boolean; username: string; verified: boolean; }; stageInstance: { members: object[]; participantCount: number; speakerCount: number; topic: string; }; targetApplication: { approximateGuildCount: number; approximateUserInstallCount: number; bot: { accentColor: number; avatar: null | string; avatarDecorationData: { asset: string; skuId: string; }; banner: string; bot: boolean; discriminator: string; email: null | string; flags: number; globalName: null | string; id: string; locale: string; mfaEnabled: boolean; premiumType: PremiumTypes; publicFlags: number; system: boolean; username: string; verified: boolean; }; botPublic: boolean; botRequireCodeGrant: boolean; coverImage: string; customInstallUrl: string; description: string; eventWebhooksStatus: DiscordApplicationEventWebhookStatus; eventWebhooksTypes: DiscordWebhookEventType[]; eventWebhooksUrl: null | string; flags: ApplicationFlags; guild: { afkChannelId: null | string; afkTimeout: number; applicationId: null | string; approximateMemberCount: number; approximatePresenceCount: number; banner: null | string; channels: object[]; defaultMessageNotifications: DefaultMessageNotificationLevels; description: null | string; discoverySplash: null | string; emojis: object[]; explicitContentFilter: ExplicitContentFilterLevels; features: GuildFeatures[]; icon: null | string; iconHash: null | string; id: string; joinedAt: string; large: boolean; maxMembers: number; maxPresences: null | number; maxStageVideoChannelUsers: number; maxVideoChannelUsers: number; memberCount: number; members: object[]; mfaLevel: MfaLevels; name: string; nsfwLevel: GuildNsfwLevel; owner: boolean; ownerId: string; permissions: string; preferredLocale: string; premiumProgressBarEnabled: boolean; premiumSubscriptionCount: number; premiumTier: PremiumTiers; presences: object[]; publicUpdatesChannelId: null | string; roles: object[]; rulesChannelId: null | string; safetyAlertsChannelId: null | string; soundboardSounds: object[]; splash: null | string; stageInstances: object[]; stickers: object[]; systemChannelFlags: SystemChannelFlags; systemChannelId: null | string; threads: object[]; unavailable: boolean; vanityUrlCode: null | string; verificationLevel: VerificationLevels; voiceStates: object[]; welcomeScreen: { description: null | string; welcomeChannels: object[]; }; widgetChannelId: null | string; widgetEnabled: boolean; }; guildId: string; icon: null | string; id: string; installParams: { permissions: string; scopes: OAuth2Scope[]; }; integrationTypesConfig: { 0: { oauth2InstallParams: { permissions: ...; scopes: ...; }; }; 1: { oauth2InstallParams: { permissions: ...; scopes: ...; }; }; }; interactionsEndpointUrl: null | string; name: string; owner: { accentColor: number; avatar: null | string; avatarDecorationData: { asset: string; skuId: string; }; banner: string; bot: boolean; discriminator: string; email: null | string; flags: number; globalName: null | string; id: string; locale: string; mfaEnabled: boolean; premiumType: PremiumTypes; publicFlags: number; system: boolean; username: string; verified: boolean; }; primarySkuId: string; privacyPolicyUrl: string; redirectUris: string[]; roleConnectionsVerificationUrl: null | string; rpcOrigins: string[]; slug: string; tags: string[]; team: null | { icon: null | string; id: string; members: object[]; name: string; ownerUserId: string; }; termsOfServiceUrl: string; verifyKey: string; }; targetType: TargetTypes; targetUser: { accentColor: number; avatar: null | string; avatarDecorationData: { asset: string; skuId: string; }; banner: string; bot: boolean; discriminator: string; email: null | string; flags: number; globalName: null | string; id: string; locale: string; mfaEnabled: boolean; premiumType: PremiumTypes; publicFlags: number; system: boolean; username: string; verified: boolean; }; type: DiscordInviteType; }>

An instance of the created DiscordInvite.

Remarks

Requires the CREATE_INSTANT_INVITE permission.

Fires an Invite Create gateway event.

See

createRequestBody()

createRequestBody: (method, options?) => RequestBody

Defined in: packages/rest/dist/types/types.d.ts:108

Creates the request body and headers that are necessary to send a request. Will handle different types of methods and everything necessary for discord.

Parameters

createRole()

createRole: (guildId, options, reason?) => Promise<{ color: number; flags: RoleFlags; hoist: boolean; icon: string; id: string; managed: boolean; mentionable: boolean; name: string; permissions: string; position: number; tags: { availableForPurchase: null; botId: string; guildConnections: null; integrationId: string; premiumSubscriber: null; subscriptionListingId: string; }; unicodeEmoji: string; }>

Defined in: packages/rest/dist/types/types.d.ts:439

Creates a role in a guild.

Parameters

guildId

https://discord.com/developers/docs/resources/guild#create-guild-role

The ID of the guild to create the role in.

options

CreateGuildRole

The parameters for the creation of the role.

reason?

string

An optional reason for the action, to be included in the audit log.

Returns

Promise<{ color: number; flags: RoleFlags; hoist: boolean; icon: string; id: string; managed: boolean; mentionable: boolean; name: string; permissions: string; position: number; tags: { availableForPurchase: null; botId: string; guildConnections: null; integrationId: string; premiumSubscriber: null; subscriptionListingId: string; }; unicodeEmoji: string; }>

An instance of the created DiscordRole.

Remarks

Requires the MANAGE_ROLES permission.

Fires a Guild Role Create gateway event.

See

createScheduledEvent()

createScheduledEvent: (guildId, options, reason?) => Promise<{ channelId: null | string; creator: { accentColor: number; avatar: null | string; avatarDecorationData: { asset: string; skuId: string; }; banner: string; bot: boolean; discriminator: string; email: null | string; flags: number; globalName: null | string; id: string; locale: string; mfaEnabled: boolean; premiumType: PremiumTypes; publicFlags: number; system: boolean; username: string; verified: boolean; }; creatorId: null | string; description: string; entityId: null | string; entityMetadata: null | { location: string; }; entityType: ScheduledEventEntityType; guildId: string; id: string; image: null | string; name: string; privacyLevel: GuildOnly; recurrenceRule: null | { byMonth: null | DiscordScheduledEventRecurrenceRuleMonth[]; byMonthDay: null | number[]; byNWeekday: null | object[]; byWeekday: null | DiscordScheduledEventRecurrenceRuleWeekday[]; byYearDay: null | number[]; count: null | number; end: null | string; frequency: DiscordScheduledEventRecurrenceRuleFrequency; interval: number; start: string; }; scheduledEndTime: null | string; scheduledStartTime: string; status: ScheduledEventStatus; userCount: number; }>

Defined in: packages/rest/dist/types/types.d.ts:457

Creates a scheduled event in a guild.

Parameters

guildId

https://discord.com/developers/docs/resources/guild-scheduled-event#create-guild-scheduled-event

The ID of the guild to create the scheduled event in.

options

CreateScheduledEvent

The parameters for the creation of the scheduled event.

reason?

string

An optional reason for the action, to be included in the audit log.

Returns

Promise<{ channelId: null | string; creator: { accentColor: number; avatar: null | string; avatarDecorationData: { asset: string; skuId: string; }; banner: string; bot: boolean; discriminator: string; email: null | string; flags: number; globalName: null | string; id: string; locale: string; mfaEnabled: boolean; premiumType: PremiumTypes; publicFlags: number; system: boolean; username: string; verified: boolean; }; creatorId: null | string; description: string; entityId: null | string; entityMetadata: null | { location: string; }; entityType: ScheduledEventEntityType; guildId: string; id: string; image: null | string; name: string; privacyLevel: GuildOnly; recurrenceRule: null | { byMonth: null | DiscordScheduledEventRecurrenceRuleMonth[]; byMonthDay: null | number[]; byNWeekday: null | object[]; byWeekday: null | DiscordScheduledEventRecurrenceRuleWeekday[]; byYearDay: null | number[]; count: null | number; end: null | string; frequency: DiscordScheduledEventRecurrenceRuleFrequency; interval: number; start: string; }; scheduledEndTime: null | string; scheduledStartTime: string; status: ScheduledEventStatus; userCount: number; }>

An instance of the created DiscordScheduledEvent.

Remarks

Requires the MANAGE_EVENTS permission.

A guild can only have a maximum of 100 events with a status of ScheduledEventStatus.Active or ScheduledEventStatus.Scheduled (inclusive).

Fires a Guild Scheduled Event Create gateway event.

See

createStageInstance()

createStageInstance: (options, reason?) => Promise<{ channelId: string; guildId: string; guildScheduledEventId: string; id: string; topic: string; }>

Defined in: packages/rest/dist/types/types.d.ts:472

Creates a stage instance associated with a stage channel.

Parameters

options

CreateStageInstance

The parameters for the creation of the stage instance.

reason?

string

An optional reason for the action, to be included in the audit log.

Returns

Promise<{ channelId: string; guildId: string; guildScheduledEventId: string; id: string; topic: string; }>

An instance of the created DiscordStageInstance.

Remarks

Requires the user to be a moderator of the stage channel.

Fires a Stage Instance Create gateway event.

See

https://discord.com/developers/docs/resources/stage-instance#create-stage-instance

createTestEntitlement()

createTestEntitlement: (applicationId, body) => Promise<Partial<{ applicationId: string; consumed: boolean; deleted: boolean; endsAt: null | string; guildId: string; id: string; skuId: string; startsAt: null | string; type: DiscordEntitlementType; userId: string; }>>

Defined in: packages/rest/dist/types/types.d.ts:2808

Creates a test entitlement to a given SKU for a given guild or user. Discord will act as though that user or guild has entitlement to your premium offering.

Parameters

applicationId

The id of the application to create the entitlement

body

CreateEntitlement

The options for new entitlement

Returns

Promise<Partial<{ applicationId: string; consumed: boolean; deleted: boolean; endsAt: null | string; guildId: string; id: string; skuId: string; startsAt: null | string; type: DiscordEntitlementType; userId: string; }>>

Remarks

This endpoint returns a partial entitlement object. It will not contain subscription_id, starts_at, or ends_at, as it's valid in perpetuity.

createWebhook()

createWebhook: (channelId, options, reason?) => Promise<Camelize<DiscordWebhook>>

Defined in: packages/rest/dist/types/types.d.ts:490

Creates a webhook.

Parameters

channelId

https://discord.com/developers/docs/resources/webhook#create-webhook

The ID of the channel to create the webhook in.

options

CreateWebhook

The parameters for the creation of the webhook.

reason?

string

An optional reason for the action, to be included in the audit log.

Returns

Promise<Camelize<DiscordWebhook>>

An instance of the created DiscordWebhook.

Remarks

Requires the MANAGE_WEBHOOKS permission.

⚠️ The webhook name must not contain the substrings 'clyde', or 'discord' (case-insensitive).

Fires a Webhooks Update gateway event.

See

delete()

delete: (url, options?) => Promise<void>

Defined in: packages/rest/dist/types/types.d.ts:128

Make a delete request to the api.

Parameters

url

string

options?

Omit<MakeRequestOptions, "body">

Returns

Promise<void>

deleteApplicationEmoji()

deleteApplicationEmoji: (id) => Promise<void>

Defined in: packages/rest/dist/types/types.d.ts:570

Deletes an emoji from the application.

Parameters

id

https://discord.com/developers/docs/resources/emoji#delete-application-emoji

The ID of the emoji to delete.

Returns

Promise<void>

See

deleteAutomodRule()

deleteAutomodRule: (guildId, ruleId, reason?) => Promise<void>

Defined in: packages/rest/dist/types/types.d.ts:505

Deletes an automod rule.

Parameters

guildId

The ID of the guild to delete the rule from.

ruleId

https://discord.com/developers/docs/resources/auto-moderation#delete-auto-moderation-rule

The ID of the automod rule to delete.

reason?

string

An optional reason for the action, to be included in the audit log.

Returns

Promise<void>

Remarks

Requires the MANAGE_GUILD permission.

Fires an Auto Moderation Rule Delete gateway event.

See

deleteChannel()

deleteChannel: (channelId, reason?) => Promise<void>

Defined in: packages/rest/dist/types/types.d.ts:531

Deletes a channel from within a guild.

Parameters

channelId

https://discord.com/developers/docs/resources/channel#deleteclose-channel

The ID of the channel to delete.

reason?

string

An optional reason for the action, to be included in the audit log.

Returns

Promise<void>

nothing

Remarks

For community guilds, the Rules, Guidelines and Community Update channels cannot be deleted.

If the channel is a thread:

Requires the MANAGE_THREADS permission.
Fires a Thread Delete gateway event.

Otherwise:

Requires the MANAGE_CHANNELS permission.
⚠️ Deleting a category channel does not delete its child channels. Instead, they will have their parent_id property removed, and a Channel Update gateway event will fire for each of them.
Fires a Channel Delete gateway event.

See

deleteChannelPermissionOverride()

deleteChannelPermissionOverride: (channelId, overwriteId, reason?) => Promise<void>

Defined in: packages/rest/dist/types/types.d.ts:546

Deletes a permission override for a user or role in a channel.

Parameters

channelId

The ID of the channel to delete the permission override of.

overwriteId

https://discord.com/developers/docs/resources/channel#delete-channel-permission

The ID of the permission override to delete.

reason?

string

An optional reason for the action, to be included in the audit log.

Returns

Promise<void>

Remarks

Requires the MANAGE_ROLES permission.

Fires a Channel Update gateway event.

See

deleteEmoji()

deleteEmoji: (guildId, id, reason?) => Promise<void>

Defined in: packages/rest/dist/types/types.d.ts:562

Deletes an emoji from a guild.

Parameters

guildId

The ID of the guild from which to delete the emoji.

id

https://discord.com/developers/docs/resources/emoji#delete-guild-emoji

The ID of the emoji to delete.

reason?

string

An optional reason for the action, to be included in the audit log.

Returns

Promise<void>

Remarks

For emojis created by the current user, requires either the CREATE_GUILD_EXPRESSIONS or MANAGE_GUILD_EXPRESSIONS permission. For other emojis, requires the MANAGE_GUILD_EXPRESSIONS permission.

Fires a Guild Emojis Update gateway event.

See

deleteFollowupMessage()

deleteFollowupMessage: (token, messageId) => Promise<void>

Defined in: packages/rest/dist/types/types.d.ts:584

Deletes a follow-up message to an interaction.

Parameters

token

string

The interaction token to use, provided in the original interaction.

messageId

https://discord.com/developers/docs/interactions/receiving-and-responding#delete-followup-message

The ID of the message to delete.

Returns

Promise<void>

Remarks

Unlike deleteMessage(), this endpoint allows the bot user to act without needing to see the channel the message is in.

Fires a Message Delete event.

See

deleteGlobalApplicationCommand()

deleteGlobalApplicationCommand: (commandId) => Promise<void>

Defined in: packages/rest/dist/types/types.d.ts:592

Deletes an application command registered globally.

Parameters

commandId

https://discord.com/developers/docs/interactions/application-commands#delete-global-application-command

The ID of the command to delete.

Returns

Promise<void>

See

deleteGuild()

deleteGuild: (guildId) => Promise<void>

Defined in: packages/rest/dist/types/types.d.ts:605

Deletes a guild.

Parameters

guildId

https://discord.com/developers/docs/resources/guild#delete-guild

The ID of the guild to delete.

Returns

Promise<void>

Remarks

The bot user must be the owner of the guild.

Fires a Guild Delete gateway event.

See

deleteGuildApplicationCommand()

deleteGuildApplicationCommand: (commandId, guildId) => Promise<void>

Defined in: packages/rest/dist/types/types.d.ts:614

Deletes an application command registered in a guild.

Parameters

commandId

The ID of the command to delete from the guild.

guildId

https://discord.com/developers/docs/interactions/application-commands#delete-guild-application-command

The ID of the guild to delete the command from.

Returns

Promise<void>

See

deleteGuildSoundboardSound()

deleteGuildSoundboardSound: (guildId, soundId, reason?) => Promise<void>

Defined in: packages/rest/dist/types/types.d.ts:2917

Delete the given soundboard sound.

Parameters

guildId

The guild to create the sounds in

soundId

The sound id to delete

reason?

string

The audit log reason

Returns

Promise<void>

Remarks

Fires a Guild Soundboard Sound Delete Gateway event.

For sounds created by the current user, requires either the CREATE_GUILD_EXPRESSIONS or MANAGE_GUILD_EXPRESSIONS permission. For other sounds, requires the MANAGE_GUILD_EXPRESSIONS permission.

deleteGuildSticker()

deleteGuildSticker: (guildId, stickerId, reason?) => Promise<void>

Defined in: packages/rest/dist/types/types.d.ts:631

Delete a new sticker for the guild.

Parameters

guildId

The ID of the guild to get

stickerId

reason?

string

An optional reason for the action, to be included in the audit log.

Returns

Promise<void>

https://discord.com/developers/docs/resources/sticker#delete-guild-sticker

Remarks

For stickers created by the current user, requires either the CREATE_GUILD_EXPRESSIONS or MANAGE_GUILD_EXPRESSIONS permission. For other stickers, requires the MANAGE_GUILD_EXPRESSIONS permission. Fires a Guild Stickers Update Gateway event. Every guilds has five free sticker slots by default, and each Boost level will grant access to more slots. Lottie stickers can only be uploaded on guilds that have either the VERIFIED and/or the PARTNERED guild feature.

See

deleteGuildTemplate()

deleteGuildTemplate: (guildId, templateCode) => Promise<void>

Defined in: packages/rest/dist/types/types.d.ts:645

Deletes a template from a guild.

Parameters

guildId

https://discord.com/developers/docs/resources/guild-template#delete-guild-template

The ID of the guild to delete the template from.

templateCode

string

The code of the template to delete.

Returns

Promise<void>

Remarks

Requires the MANAGE_GUILD permission.

Fires a Guild Update gateway event.

See

deleteIntegration()

deleteIntegration: (guildId, integrationId, reason?) => Promise<void>

Defined in: packages/rest/dist/types/types.d.ts:663

Deletes an integration attached to a guild.

Parameters

guildId

The ID of the guild from which to delete the integration.

integrationId

https://discord.com/developers/docs/resources/guild#delete-guild-integration

The ID of the integration to delete from the guild.

reason?

string

An optional reason for the action, to be included in the audit log.

Returns

Promise<void>

Remarks

Requires the MANAGE_GUILD permission.

Deletes all webhooks associated with the integration, and kicks the associated bot if there is one.

Fires a Guild Integrations Update gateway event. Fires a Integration Delete gateway event.

See

deleteInvite()

deleteInvite: (inviteCode, reason?) => Promise<void>

Defined in: packages/rest/dist/types/types.d.ts:677

Deletes an invite to a channel.

Parameters

inviteCode

string

The invite code of the invite to delete.

reason?

string

An optional reason for the action, to be included in the audit log.

Returns

Promise<void>

Remarks

Requires the MANAGE_CHANNELS permission.

Fires an Invite Delete gateway event.

See

https://discord.com/developers/docs/resources/channel#delete-channel-invite

deleteMessage()

deleteMessage: (channelId, messageId, reason?) => Promise<void>

Defined in: packages/rest/dist/types/types.d.ts:693

Deletes a message from a channel.

Parameters

channelId

The ID of the channel to delete the message from.

messageId

https://discord.com/developers/docs/resources/channel#delete-message

The ID of the message to delete from the channel.

reason?

string

An optional reason for the action, to be included in the audit log.

Returns

Promise<void>

Remarks

If not deleting own message:

Requires the MANAGE_MESSAGES permission.

Fires a Message Delete gateway event.

See

deleteMessages()

deleteMessages: (channelId, messageIds, reason?) => Promise<void>

Defined in: packages/rest/dist/types/types.d.ts:710

Deletes multiple messages from a channel.

Parameters

channelId

https://discord.com/developers/docs/resources/channel#bulk-delete-messages

The ID of the channel to delete the messages from.

messageIds

BigString[]

The IDs of the messages to delete from the channel.

reason?

string

An optional reason for the action, to be included in the audit log.

Returns

Promise<void>

Remarks

Requires the MANAGE_MESSAGES permission.

⚠️ Messages older than 2 weeks old cannot be deleted.

Fires a Message Delete Bulk gateway event.

See

deleteOriginalInteractionResponse()

deleteOriginalInteractionResponse: (token) => Promise<void>

Defined in: packages/rest/dist/types/types.d.ts:723

Deletes the initial message response to an interaction.

Parameters

token

string

The interaction token to use, provided in the original interaction.

Returns

Promise<void>

Remarks

Unlike deleteMessage(), this endpoint allows the bot user to act without needing to see the channel the message is in.

Fires a Message Delete event.

See

https://discord.com/developers/docs/interactions/receiving-and-responding#delete-original-interaction-response

deleteOwnReaction()

deleteOwnReaction: (channelId, messageId, reaction) => Promise<void>

Defined in: packages/rest/dist/types/types.d.ts:738

Deletes a reaction added by the bot user from a message.

Parameters

channelId

The ID of the channel the message to delete the reaction from is in.

messageId

https://discord.com/developers/docs/resources/channel#delete-own-reaction

The ID of the message to delete the reaction from.

reaction

string

The reaction to delete from the message.

Returns

Promise<void>

Remarks

Requires the READ_MESSAGE_HISTORY permission.

Fires a Message Reaction Remove gateway event.

See

deleteQueueDelay

deleteQueueDelay: number

Defined in: packages/rest/dist/types/types.d.ts:87

The time in milliseconds to wait before deleting this queue if it is empty. Defaults to 60000(one minute).

deleteReactionsAll()

deleteReactionsAll: (channelId, messageId) => Promise<void>

Defined in: packages/rest/dist/types/types.d.ts:754

Deletes all reactions for all emojis from a message.

Parameters

channelId

The ID of the channel the message to delete the reactions from is in.

messageId

https://discord.com/developers/docs/resources/channel#delete-all-reactions

The ID of the message to delete the reactions from.

Returns

Promise<void>

Remarks

Requires the READ_MESSAGE_HISTORY permission.

Requires the MANAGE_MESSAGES permission.

Fires a Message Reaction Remove All gateway event.

See

deleteReactionsEmoji()

deleteReactionsEmoji: (channelId, messageId, reaction) => Promise<void>

Defined in: packages/rest/dist/types/types.d.ts:771

Deletes all reactions for an emoji from a message.

Parameters

channelId

The ID of the channel the message to delete the reactions from is in.

messageId

https://discord.com/developers/docs/resources/channel#delete-all-reactions-for-emoji

The ID of the message to delete the reactions from.

reaction

string

The reaction to remove from the message.

Returns

Promise<void>

Remarks

Requires the READ_MESSAGE_HISTORY permission.

Requires the MANAGE_MESSAGES permission.

Fires a Message Reaction Remove Emoji gateway event.

See

deleteRole()

deleteRole: (guildId, roleId, reason?) => Promise<void>

Defined in: packages/rest/dist/types/types.d.ts:786

Deletes a role from a guild.

Parameters

guildId

The ID of the guild to delete the role from.

roleId

https://discord.com/developers/docs/resources/guild#delete-guild-role

The ID of the role to delete.

reason?

string

An optional reason for the action, to be included in the audit log.

Returns

Promise<void>

Remarks

Requires the MANAGE_ROLES permission.

Fires a Guild Role Delete gateway event.

See

deleteScheduledEvent()

deleteScheduledEvent: (guildId, eventId) => Promise<void>

Defined in: packages/rest/dist/types/types.d.ts:800

Deletes a scheduled event from a guild.

Parameters

guildId

The ID of the guild to delete the scheduled event from.

eventId

https://discord.com/developers/docs/resources/guild-scheduled-event#delete-guild-scheduled-event

The ID of the scheduled event to delete.

Returns

Promise<void>

Remarks

Requires the MANAGE_EVENTS permission.

Fires a Guild Scheduled Event Delete gateway event.

See

deleteStageInstance()

deleteStageInstance: (channelId, reason?) => Promise<void>

Defined in: packages/rest/dist/types/types.d.ts:814

Deletes the stage instance associated with a stage channel, if one exists.

Parameters

channelId

https://discord.com/developers/docs/resources/stage-instance#delete-stage-instance

The ID of the stage channel the stage instance is associated with.

reason?

string

An optional reason for the action, to be included in the audit log.

Returns

Promise<void>

Remarks

Requires the user to be a moderator of the stage channel.

Fires a Stage Instance Delete gateway event.

See

deleteTestEntitlement()

deleteTestEntitlement: (applicationId, entitlementId) => Promise<void>

Defined in: packages/rest/dist/types/types.d.ts:2815

Deletes a currently-active test entitlement. Discord will act as though that user or guild no longer has entitlement to your premium offering.

Parameters

applicationId

The id of the application from where delete the entitlement

entitlementId

The id of the entitlement to delete

Returns

Promise<void>

deleteUserReaction()

deleteUserReaction: (channelId, messageId, userId, reaction) => Promise<void>

Defined in: packages/rest/dist/types/types.d.ts:832

Deletes a user's reaction from a message.

Parameters

channelId

The ID of the channel the message to delete the reaction from is in.

messageId

The ID of the message to delete the reaction from.

userId

https://discord.com/developers/docs/resources/channel#delete-user-reaction

The ID of the user whose reaction to delete.

reaction

string

The reaction to delete from the message.

Returns

Promise<void>

Remarks

Requires the READ_MESSAGE_HISTORY permission.

Requires the MANAGE_MESSAGES permission.

Fires a Message Reaction Remove gateway event.

See

deleteWebhook()

deleteWebhook: (webhookId, reason?) => Promise<void>

Defined in: packages/rest/dist/types/types.d.ts:845

Deletes a webhook.

Parameters

webhookId

https://discord.com/developers/docs/resources/webhook#delete-webhook

The ID of the webhook to delete.

reason?

string

Returns

Promise<void>

Remarks

Requires the MANAGE_WEBHOOKS permission.

Fires a Webhooks Update gateway event.

See

deleteWebhookMessage()

deleteWebhookMessage: (webhookId, token, messageId, options?) => Promise<void>

Defined in: packages/rest/dist/types/types.d.ts:859

Deletes a webhook message.

Parameters

webhookId

The ID of the webhook to delete the message belonging to.

token

string

The webhook token, used to manage the webhook.

messageId

DeleteWebhookMessageOptions

The ID of the message to delete.

options?

The parameters for the deletion of the message.

Returns

Promise<void>

Remarks

Fires a Message Delete gateway event.

See

https://discord.com/developers/docs/resources/webhook#delete-webhook

deleteWebhookWithToken()

deleteWebhookWithToken: (webhookId, token) => Promise<void>

Defined in: packages/rest/dist/types/types.d.ts:871

Deletes a webhook message using the webhook token, thereby bypassing the need for authentication + permissions.

Parameters

webhookId

https://discord.com/developers/docs/resources/webhook#delete-webhook-with-token

The ID of the webhook to delete the message belonging to.

token

string

The webhook token, used to delete the webhook.

Returns

Promise<void>

Remarks

Fires a Message Delete gateway event.

See

editApplicationCommandPermissions()

editApplicationCommandPermissions: (guildId, commandId, bearerToken, options) => Promise<{ applicationId: string; guildId: string; id: string; permissions: object[]; }>

Defined in: packages/rest/dist/types/types.d.ts:886

Edits the permissions for a guild application command.

Parameters

guildId

The ID of the guild the command is registered in.

commandId

https://discord.com/developers/docs/interactions/application-commands#edit-application-command-permissions

The ID of the command to edit the permissions of.

bearerToken

string

The bearer token to use to make the request.

options

object[]

The parameters for the edit of the command permissions.

Returns

Promise<{ applicationId: string; guildId: string; id: string; permissions: object[]; }>

An instance of the edited DiscordGuildApplicationCommandPermissions.

Remarks

The bearer token requires the applications.commands.permissions.update scope to be enabled, and to have access to the guild whose ID has been provided in the parameters.

See

editApplicationEmoji()

editApplicationEmoji: (id, options) => Promise<{ animated: boolean; available: boolean; id: string; managed: boolean; name: string; requireColons: boolean; roles: string[]; user: { accentColor: number; avatar: null | string; avatarDecorationData: { asset: string; skuId: string; }; banner: string; bot: boolean; discriminator: string; email: null | string; flags: number; globalName: null | string; id: string; locale: string; mfaEnabled: boolean; premiumType: PremiumTypes; publicFlags: number; system: boolean; username: string; verified: boolean; }; }>

Defined in: packages/rest/dist/types/types.d.ts:1002

Edits an application emoji.

Parameters

id

https://discord.com/developers/docs/resources/emoji#modify-application-emoji

The ID of the emoji to edit.

options

ModifyApplicationEmoji

The parameters for the edit of the emoji.

Returns

An instance of the updated DiscordEmoji.

See

editApplicationInfo()

editApplicationInfo: (body) => Promise<{ approximateGuildCount: number; approximateUserInstallCount: number; bot: { accentColor: number; avatar: null | string; avatarDecorationData: { asset: string; skuId: string; }; banner: string; bot: boolean; discriminator: string; email: null | string; flags: number; globalName: null | string; id: string; locale: string; mfaEnabled: boolean; premiumType: PremiumTypes; publicFlags: number; system: boolean; username: string; verified: boolean; }; botPublic: boolean; botRequireCodeGrant: boolean; coverImage: string; customInstallUrl: string; description: string; eventWebhooksStatus: DiscordApplicationEventWebhookStatus; eventWebhooksTypes: DiscordWebhookEventType[]; eventWebhooksUrl: null | string; flags: ApplicationFlags; guild: { afkChannelId: null | string; afkTimeout: number; applicationId: null | string; approximateMemberCount: number; approximatePresenceCount: number; banner: null | string; channels: object[]; defaultMessageNotifications: DefaultMessageNotificationLevels; description: null | string; discoverySplash: null | string; emojis: object[]; explicitContentFilter: ExplicitContentFilterLevels; features: GuildFeatures[]; icon: null | string; iconHash: null | string; id: string; joinedAt: string; large: boolean; maxMembers: number; maxPresences: null | number; maxStageVideoChannelUsers: number; maxVideoChannelUsers: number; memberCount: number; members: object[]; mfaLevel: MfaLevels; name: string; nsfwLevel: GuildNsfwLevel; owner: boolean; ownerId: string; permissions: string; preferredLocale: string; premiumProgressBarEnabled: boolean; premiumSubscriptionCount: number; premiumTier: PremiumTiers; presences: object[]; publicUpdatesChannelId: null | string; roles: object[]; rulesChannelId: null | string; safetyAlertsChannelId: null | string; soundboardSounds: object[]; splash: null | string; stageInstances: object[]; stickers: object[]; systemChannelFlags: SystemChannelFlags; systemChannelId: null | string; threads: object[]; unavailable: boolean; vanityUrlCode: null | string; verificationLevel: VerificationLevels; voiceStates: object[]; welcomeScreen: { description: null | string; welcomeChannels: object[]; }; widgetChannelId: null | string; widgetEnabled: boolean; }; guildId: string; icon: null | string; id: string; installParams: { permissions: string; scopes: OAuth2Scope[]; }; integrationTypesConfig: { 0: { oauth2InstallParams: { permissions: string; scopes: OAuth2Scope[]; }; }; 1: { oauth2InstallParams: { permissions: string; scopes: OAuth2Scope[]; }; }; }; interactionsEndpointUrl: null | string; name: string; owner: { accentColor: number; avatar: null | string; avatarDecorationData: { asset: string; skuId: string; }; banner: string; bot: boolean; discriminator: string; email: null | string; flags: number; globalName: null | string; id: string; locale: string; mfaEnabled: boolean; premiumType: PremiumTypes; publicFlags: number; system: boolean; username: string; verified: boolean; }; primarySkuId: string; privacyPolicyUrl: string; redirectUris: string[]; roleConnectionsVerificationUrl: null | string; rpcOrigins: string[]; slug: string; tags: string[]; team: null | { icon: null | string; id: string; members: object[]; name: string; ownerUserId: string; }; termsOfServiceUrl: string; verifyKey: string; }>

Defined in: packages/rest/dist/types/types.d.ts:1392

Edit properties of the app associated with the requesting bot user.

Parameters

body

EditApplication

Returns

Promise<{ approximateGuildCount: number; approximateUserInstallCount: number; bot: { accentColor: number; avatar: null | string; avatarDecorationData: { asset: string; skuId: string; }; banner: string; bot: boolean; discriminator: string; email: null | string; flags: number; globalName: null | string; id: string; locale: string; mfaEnabled: boolean; premiumType: PremiumTypes; publicFlags: number; system: boolean; username: string; verified: boolean; }; botPublic: boolean; botRequireCodeGrant: boolean; coverImage: string; customInstallUrl: string; description: string; eventWebhooksStatus: DiscordApplicationEventWebhookStatus; eventWebhooksTypes: DiscordWebhookEventType[]; eventWebhooksUrl: null | string; flags: ApplicationFlags; guild: { afkChannelId: null | string; afkTimeout: number; applicationId: null | string; approximateMemberCount: number; approximatePresenceCount: number; banner: null | string; channels: object[]; defaultMessageNotifications: DefaultMessageNotificationLevels; description: null | string; discoverySplash: null | string; emojis: object[]; explicitContentFilter: ExplicitContentFilterLevels; features: GuildFeatures[]; icon: null | string; iconHash: null | string; id: string; joinedAt: string; large: boolean; maxMembers: number; maxPresences: null | number; maxStageVideoChannelUsers: number; maxVideoChannelUsers: number; memberCount: number; members: object[]; mfaLevel: MfaLevels; name: string; nsfwLevel: GuildNsfwLevel; owner: boolean; ownerId: string; permissions: string; preferredLocale: string; premiumProgressBarEnabled: boolean; premiumSubscriptionCount: number; premiumTier: PremiumTiers; presences: object[]; publicUpdatesChannelId: null | string; roles: object[]; rulesChannelId: null | string; safetyAlertsChannelId: null | string; soundboardSounds: object[]; splash: null | string; stageInstances: object[]; stickers: object[]; systemChannelFlags: SystemChannelFlags; systemChannelId: null | string; threads: object[]; unavailable: boolean; vanityUrlCode: null | string; verificationLevel: VerificationLevels; voiceStates: object[]; welcomeScreen: { description: null | string; welcomeChannels: object[]; }; widgetChannelId: null | string; widgetEnabled: boolean; }; guildId: string; icon: null | string; id: string; installParams: { permissions: string; scopes: OAuth2Scope[]; }; integrationTypesConfig: { 0: { oauth2InstallParams: { permissions: string; scopes: OAuth2Scope[]; }; }; 1: { oauth2InstallParams: { permissions: string; scopes: OAuth2Scope[]; }; }; }; interactionsEndpointUrl: null | string; name: string; owner: { accentColor: number; avatar: null | string; avatarDecorationData: { asset: string; skuId: string; }; banner: string; bot: boolean; discriminator: string; email: null | string; flags: number; globalName: null | string; id: string; locale: string; mfaEnabled: boolean; premiumType: PremiumTypes; publicFlags: number; system: boolean; username: string; verified: boolean; }; primarySkuId: string; privacyPolicyUrl: string; redirectUris: string[]; roleConnectionsVerificationUrl: null | string; rpcOrigins: string[]; slug: string; tags: string[]; team: null | { icon: null | string; id: string; members: object[]; name: string; ownerUserId: string; }; termsOfServiceUrl: string; verifyKey: string; }>

Remarks

Only properties that are passed will be updated.

editAutomodRule()

editAutomodRule: (guildId, ruleId, options, reason?) => Promise<{ actions: object[]; creatorId: string; enabled: boolean; eventType: AutoModerationEventTypes; exemptChannels: string[]; exemptRoles: string[]; guildId: string; id: string; name: string; triggerMetadata: { allowList: string[]; keywordFilter: string[]; mentionRaidProtectionEnabled: boolean; mentionTotalLimit: number; presets: DiscordAutoModerationRuleTriggerMetadataPresets[]; regexPatterns: string[]; }; triggerType: AutoModerationTriggerTypes; }>

Defined in: packages/rest/dist/types/types.d.ts:903

Edits an automod rule.

Parameters

guildId

The ID of the guild to edit the rule in.

ruleId

https://discord.com/developers/docs/resources/auto-moderation#modify-auto-moderation-rule

The ID of the rule to edit.

options

Partial<EditAutoModerationRuleOptions>

The parameters for the edit of the rule.

reason?

string

An optional reason for the action, to be included in the audit log.

Returns

An instance of the edited DiscordAutoModerationRule.

Remarks

Requires the MANAGE_GUILD permission.

Fires an Auto Moderation Rule Update gateway event.

See

editBotMember()

editBotMember: (guildId, options, reason?) => Promise<{ avatar: string; avatarDecorationData: null | { asset: string; skuId: string; }; banner: string; communicationDisabledUntil: null | string; deaf: boolean; flags: number; joinedAt: string; mute: boolean; nick: null | string; pending: boolean; permissions: string; premiumSince: null | string; roles: string[]; user: { accentColor: number; avatar: null | string; avatarDecorationData: { asset: string; skuId: string; }; banner: string; bot: boolean; discriminator: string; email: null | string; flags: number; globalName: null | string; id: string; locale: string; mfaEnabled: boolean; premiumType: PremiumTypes; publicFlags: number; system: boolean; username: string; verified: boolean; }; }>

Defined in: packages/rest/dist/types/types.d.ts:2591

Edits the nickname of the bot user.

Parameters

guildId

https://discord.com/developers/docs/resources/guild#modify-current-member

The ID of the guild to edit the nickname of the bot user in.

options

EditBotMemberOptions

The parameters for the edit of the nickname.

reason?

string

An optional reason for the action, to be included in the audit log.

Returns

Promise<{ avatar: string; avatarDecorationData: null | { asset: string; skuId: string; }; banner: string; communicationDisabledUntil: null | string; deaf: boolean; flags: number; joinedAt: string; mute: boolean; nick: null | string; pending: boolean; permissions: string; premiumSince: null | string; roles: string[]; user: { accentColor: number; avatar: null | string; avatarDecorationData: { asset: string; skuId: string; }; banner: string; bot: boolean; discriminator: string; email: null | string; flags: number; globalName: null | string; id: string; locale: string; mfaEnabled: boolean; premiumType: PremiumTypes; publicFlags: number; system: boolean; username: string; verified: boolean; }; }>

An instance of the edited DiscordMember

Remarks

Fires a Guild Member Update gateway event.

See

editBotProfile()

editBotProfile: (options) => Promise<{ accentColor: number; avatar: null | string; avatarDecorationData: { asset: string; skuId: string; }; banner: string; bot: boolean; discriminator: string; email: null | string; flags: number; globalName: null | string; id: string; locale: string; mfaEnabled: boolean; premiumType: PremiumTypes; publicFlags: number; system: boolean; username: string; verified: boolean; }>

Defined in: packages/rest/dist/types/types.d.ts:908

Modifies the bot's username, avatar or banner. NOTE: username: if changed may cause the bot's discriminator to be randomized.

Parameters

options

botAvatarURL

null | string

botBannerURL

null | string

username

string

Returns

Promise<{ accentColor: number; avatar: null | string; avatarDecorationData: { asset: string; skuId: string; }; banner: string; bot: boolean; discriminator: string; email: null | string; flags: number; globalName: null | string; id: string; locale: string; mfaEnabled: boolean; premiumType: PremiumTypes; publicFlags: number; system: boolean; username: string; verified: boolean; }>

editChannel()

editChannel: (channelId, options, reason?) => Promise<{ applicationId: string; appliedTags: string[]; availableTags: object[]; bitrate: number; defaultAutoArchiveDuration: number; defaultForumLayout: ForumLayout; defaultReactionEmoji: null | { emojiId: string; emojiName: null | string; }; defaultSortOrder: null | SortOrderTypes; defaultThreadRateLimitPerUser: number; flags: ChannelFlags; guildId: string; icon: string; id: string; lastMessageId: null | string; lastPinTimestamp: null | string; managed: boolean; member: { flags: number; id: string; joinTimestamp: string; userId: string; }; memberCount: number; messageCount: number; name: string; newlyCreated: boolean; nsfw: boolean; ownerId: string; parentId: null | string; permissionOverwrites: object[]; permissions: string; position: number; rateLimitPerUser: number; recipients: object[]; rtcRegion: null | string; threadMetadata: { archived: boolean; archiveTimestamp: string; autoArchiveDuration: 60 | 1440 | 4320 | 10080; createTimestamp: null | string; invitable: boolean; locked: boolean; }; topic: null | string; totalMessageSent: number; type: ChannelTypes; userLimit: number; videoQualityMode: VideoQualityModes; }>

Defined in: packages/rest/dist/types/types.d.ts:943

Edits a channel's settings.

Parameters

channelId

The ID of the channel to edit.

options

ModifyChannel

The parameters for the edit of the channel.

reason?

string

An optional reason for the action, to be included in the audit log.

Returns

An instance of the edited DiscordChannel.

Remarks

If editing a channel of type ChannelTypes.GroupDm:

Fires a Channel Update gateway event.

If editing a thread channel:

Requires the MANAGE_THREADS permission unless if setting the archived property to false when the locked property is also false, in which case only the SEND_MESSAGES permission is required.
Fires a Thread Update gateway event.

If editing a guild channel:

Requires the MANAGE_CHANNELS permission.
If modifying permission overrides:
- Requires the MANAGE_ROLES permission.
- Only permissions the bot user has in the guild or parent channel can be allowed/denied unless the bot user has a MANAGE_ROLES permission override in the channel.
If modifying a channel of type ChannelTypes.GuildCategory:
- Fires a Channel Update gateway event for each child channel impacted in this change.
Otherwise:
- Fires a Channel Update gateway event.

editChannelPermissionOverrides()

editChannelPermissionOverrides: (channelId, options, reason?) => Promise<void>

Defined in: packages/rest/dist/types/types.d.ts:960

Edits the permission overrides for a user or role in a channel.

Parameters

channelId

EditChannelPermissionOverridesOptions

The ID of the channel to edit the permission overrides of.

options

The permission override.

reason?

string

An optional reason for the action, to be included in the audit log.

Returns

Promise<void>

Remarks

Requires the MANAGE_ROLES permission.

Only permissions the bot user has in the guild or parent channel can be allowed/denied unless the bot user has a MANAGE_ROLES permission override in the channel.

Fires a Channel Update gateway event.

See

https://discord.com/developers/docs/resources/channel#edit-channel-permissions

editChannelPositions()

editChannelPositions: (guildId, channelPositions) => Promise<void>

Defined in: packages/rest/dist/types/types.d.ts:974

Edits the positions of a set of channels in a guild.

Parameters

guildId

ModifyGuildChannelPositions[]

The ID of the guild in which to edit the positions of the channels.

channelPositions

A set of objects defining the updated positions of the channels.

Returns

Promise<void>

Remarks

Requires the MANAGE_CHANNELS permission.

Fires a Channel Update gateway event for every channel impacted in this change.

See

https://discord.com/developers/docs/resources/guild#modify-guild-channel-positions

editEmoji()

editEmoji: (guildId, id, options, reason?) => Promise<{ animated: boolean; available: boolean; id: string; managed: boolean; name: string; requireColons: boolean; roles: string[]; user: { accentColor: number; avatar: null | string; avatarDecorationData: { asset: string; skuId: string; }; banner: string; bot: boolean; discriminator: string; email: null | string; flags: number; globalName: null | string; id: string; locale: string; mfaEnabled: boolean; premiumType: PremiumTypes; publicFlags: number; system: boolean; username: string; verified: boolean; }; }>

Defined in: packages/rest/dist/types/types.d.ts:992

Edits an emoji.

Parameters

guildId

The ID of the guild in which to edit the emoji.

id

https://discord.com/developers/docs/resources/emoji#modify-guild-emoji

The ID of the emoji to edit.

options

ModifyGuildEmoji

The parameters for the edit of the emoji.

reason?

string

An optional reason for the action, to be included in the audit log.

Returns

An instance of the updated DiscordEmoji.

Remarks

For emojis created by the current user, requires either the CREATE_GUILD_EXPRESSIONS or MANAGE_GUILD_EXPRESSIONS permission. For other emojis, requires the MANAGE_GUILD_EXPRESSIONS permission.

Fires a Guild Emojis Update gateway event.

See

editFollowupMessage()

editFollowupMessage: (token, messageId, options) => Promise<{ activity: { partyId: string; type: MessageActivityTypes; }; application: { approximateGuildCount: number; approximateUserInstallCount: number; bot: { accentColor: number; avatar: null | string; avatarDecorationData: { asset: string; skuId: string; }; banner: string; bot: boolean; discriminator: string; email: null | string; flags: number; globalName: null | string; id: string; locale: string; mfaEnabled: boolean; premiumType: PremiumTypes; publicFlags: number; system: boolean; username: string; verified: boolean; }; botPublic: boolean; botRequireCodeGrant: boolean; coverImage: string; customInstallUrl: string; description: string; eventWebhooksStatus: DiscordApplicationEventWebhookStatus; eventWebhooksTypes: DiscordWebhookEventType[]; eventWebhooksUrl: null | string; flags: ApplicationFlags; guild: { afkChannelId: null | string; afkTimeout: number; applicationId: null | string; approximateMemberCount: number; approximatePresenceCount: number; banner: null | string; channels: object[]; defaultMessageNotifications: DefaultMessageNotificationLevels; description: null | string; discoverySplash: null | string; emojis: object[]; explicitContentFilter: ExplicitContentFilterLevels; features: GuildFeatures[]; icon: null | string; iconHash: null | string; id: string; joinedAt: string; large: boolean; maxMembers: number; maxPresences: null | number; maxStageVideoChannelUsers: number; maxVideoChannelUsers: number; memberCount: number; members: object[]; mfaLevel: MfaLevels; name: string; nsfwLevel: GuildNsfwLevel; owner: boolean; ownerId: string; permissions: string; preferredLocale: string; premiumProgressBarEnabled: boolean; premiumSubscriptionCount: number; premiumTier: PremiumTiers; presences: object[]; publicUpdatesChannelId: null | string; roles: object[]; rulesChannelId: null | string; safetyAlertsChannelId: null | string; soundboardSounds: object[]; splash: null | string; stageInstances: object[]; stickers: object[]; systemChannelFlags: SystemChannelFlags; systemChannelId: null | string; threads: object[]; unavailable: boolean; vanityUrlCode: null | string; verificationLevel: VerificationLevels; voiceStates: object[]; welcomeScreen: { description: null | string; welcomeChannels: object[]; }; widgetChannelId: null | string; widgetEnabled: boolean; }; guildId: string; icon: null | string; id: string; installParams: { permissions: string; scopes: OAuth2Scope[]; }; integrationTypesConfig: { 0: { oauth2InstallParams: { permissions: ...; scopes: ...; }; }; 1: { oauth2InstallParams: { permissions: ...; scopes: ...; }; }; }; interactionsEndpointUrl: null | string; name: string; owner: { accentColor: number; avatar: null | string; avatarDecorationData: { asset: string; skuId: string; }; banner: string; bot: boolean; discriminator: string; email: null | string; flags: number; globalName: null | string; id: string; locale: string; mfaEnabled: boolean; premiumType: PremiumTypes; publicFlags: number; system: boolean; username: string; verified: boolean; }; primarySkuId: string; privacyPolicyUrl: string; redirectUris: string[]; roleConnectionsVerificationUrl: null | string; rpcOrigins: string[]; slug: string; tags: string[]; team: null | { icon: null | string; id: string; members: object[]; name: string; ownerUserId: string; }; termsOfServiceUrl: string; verifyKey: string; }; applicationId: string; attachments: object[]; author: { accentColor: number; avatar: null | string; avatarDecorationData: { asset: string; skuId: string; }; banner: string; bot: boolean; discriminator: string; email: null | string; flags: number; globalName: null | string; id: string; locale: string; mfaEnabled: boolean; premiumType: PremiumTypes; publicFlags: number; system: boolean; username: string; verified: boolean; }; call: { endedTimestamp: string; participants: string[]; }; channelId: string; components: ({ components: ({ channelTypes: ... | ...; customId: string; defaultValues: ... | ...; disabled: ... | ... | ...; maxValues: ... | ...; minValues: ... | ...; options: ... | ...; placeholder: ... | ...; type: ... | ... | ... | ... | ...; } | { customId: ... | ...; disabled: ... | ... | ...; emoji: ... | ...; label: ... | ...; skuId: ... | ...; style: ButtonStyles; type: Button; url: ... | ...; } | { customId: string; label: string; maxLength: ... | ...; minLength: ... | ...; placeholder: ... | ...; required: ... | ... | ...; style: TextStyles; type: InputText; value: ... | ...; })[]; type: ActionRow; } | { channelTypes: ChannelTypes[]; customId: string; defaultValues: object[]; disabled: boolean; maxValues: number; minValues: number; options: object[]; placeholder: string; type: SelectMenu | SelectMenuUsers | SelectMenuRoles | SelectMenuUsersAndRoles | SelectMenuChannels; } | { customId: string; disabled: boolean; emoji: { animated: boolean; id: string; name: string; }; label: string; skuId: string; style: ButtonStyles; type: Button; url: string; } | { customId: string; label: string; maxLength: number; minLength: number; placeholder: string; required: boolean; style: TextStyles; type: InputText; value: string; })[]; content: string; editedTimestamp: null | string; embeds: object[]; flags: MessageFlags; guildId: string; id: string; interaction: { id: string; member: { avatar: string; avatarDecorationData: null | { asset: string; skuId: string; }; banner: string; communicationDisabledUntil: null | string; deaf: boolean; flags: number; joinedAt: string; mute: boolean; nick: null | string; pending: boolean; permissions: string; premiumSince: null | string; roles: string[]; user: { accentColor: number; avatar: null | string; avatarDecorationData: { asset: ...; skuId: ...; }; banner: string; bot: boolean; discriminator: string; email: null | string; flags: number; globalName: null | string; id: string; locale: string; mfaEnabled: boolean; premiumType: PremiumTypes; publicFlags: number; system: boolean; username: string; verified: boolean; }; }; name: string; type: InteractionTypes; user: { accentColor: number; avatar: null | string; avatarDecorationData: { asset: string; skuId: string; }; banner: string; bot: boolean; discriminator: string; email: null | string; flags: number; globalName: null | string; id: string; locale: string; mfaEnabled: boolean; premiumType: PremiumTypes; publicFlags: number; system: boolean; username: string; verified: boolean; }; }; interactionMetadata: { authorizingIntegrationOwners: { 0: string; 1: string; }; id: string; originalResponseMessageId: string; targetMessageId: string; targetUser: { accentColor: number; avatar: null | string; avatarDecorationData: { asset: string; skuId: string; }; banner: string; bot: boolean; discriminator: string; email: null | string; flags: number; globalName: null | string; id: string; locale: string; mfaEnabled: boolean; premiumType: PremiumTypes; publicFlags: number; system: boolean; username: string; verified: boolean; }; type: InteractionTypes; user: { accentColor: number; avatar: null | string; avatarDecorationData: { asset: string; skuId: string; }; banner: string; bot: boolean; discriminator: string; email: null | string; flags: number; globalName: null | string; id: string; locale: string; mfaEnabled: boolean; premiumType: PremiumTypes; publicFlags: number; system: boolean; username: string; verified: boolean; }; } | { authorizingIntegrationOwners: { 0: string; 1: string; }; id: string; interactedMessageId: string; originalResponseMessageId: string; type: InteractionTypes; user: { accentColor: number; avatar: null | string; avatarDecorationData: { asset: string; skuId: string; }; banner: string; bot: boolean; discriminator: string; email: null | string; flags: number; globalName: null | string; id: string; locale: string; mfaEnabled: boolean; premiumType: PremiumTypes; publicFlags: number; system: boolean; username: string; verified: boolean; }; } | { authorizingIntegrationOwners: { 0: string; 1: string; }; id: string; originalResponseMessageId: string; triggeringInteractionMetadata: { id: string; type: InteractionTypes; user: { username: string; globalName: string | null; locale?: string | undefined; flags?: number | undefined; premiumType?: PremiumTypes | undefined; ... 11 more ...; avatarDecorationData?: { ...; } | undefined; }; authorizingIntegrationOwners: { ...; }; originalResponseMessageI...; type: InteractionTypes; user: { accentColor: number; avatar: null | string; avatarDecorationData: { asset: string; skuId: string; }; banner: string; bot: boolean; discriminator: string; email: null | string; flags: number; globalName: null | string; id: string; locale: string; mfaEnabled: boolean; premiumType: PremiumTypes; publicFlags: number; system: boolean; username: string; verified: boolean; }; }; member: { avatar: string; avatarDecorationData: null | { asset: string; skuId: string; }; banner: string; communicationDisabledUntil: null | string; deaf: boolean; flags: number; joinedAt: string; mute: boolean; nick: null | string; pending: boolean; permissions: string; premiumSince: null | string; roles: string[]; user: { accentColor: number; avatar: null | string; avatarDecorationData: { asset: string; skuId: string; }; banner: string; bot: boolean; discriminator: string; email: null | string; flags: number; globalName: null | string; id: string; locale: string; mfaEnabled: boolean; premiumType: PremiumTypes; publicFlags: number; system: boolean; username: string; verified: boolean; }; }; mentionChannels: object[]; mentionEveryone: boolean; mentionRoles: string[]; mentions: object[]; messageReference: { channelId: string; failIfNotExists: boolean; guildId: string; messageId: string; type: DiscordMessageReferenceType; }; messageSnapshots: object[]; nonce: string | number; pinned: boolean; poll: { allowMultiselect: boolean; answers: object[]; expiry: null | string; layoutType: Default; question: { emoji: { animated: boolean; available: boolean; id: string; managed: boolean; name: string; requireColons: boolean; roles: string[]; user: { accentColor: ... | ...; avatar: ... | ...; avatarDecorationData: ... | ...; banner: ... | ...; bot: ... | ... | ...; discriminator: string; email: ... | ... | ...; flags: ... | ...; globalName: ... | ...; id: string; locale: ... | ...; mfaEnabled: ... | ... | ...; premiumType: ... | ...; publicFlags: ... | ...; system: ... | ... | ...; username: string; verified: ... | ... | ...; }; }; text: string; }; results: { answerCounts: object[]; isFinalized: boolean; }; }; position: number; reactions: object[]; referencedMessage: { id: string; channelId: string; guildId?: string | undefined; author: { username: string; globalName: string | null; locale?: string | undefined; flags?: number | undefined; premiumType?: PremiumTypes | undefined; ... 11 more ...; avatarDecorationData?: { ...; } | undefined; }; ... 31 more ...; call?: { ...; } | un...; stickerItems: object[]; stickers: object[]; thread: { applicationId: string; appliedTags: string[]; availableTags: object[]; bitrate: number; defaultAutoArchiveDuration: number; defaultForumLayout: ForumLayout; defaultReactionEmoji: null | { emojiId: string; emojiName: null | string; }; defaultSortOrder: null | SortOrderTypes; defaultThreadRateLimitPerUser: number; flags: ChannelFlags; guildId: string; icon: string; id: string; lastMessageId: null | string; lastPinTimestamp: null | string; managed: boolean; member: { flags: number; id: string; joinTimestamp: string; userId: string; }; memberCount: number; messageCount: number; name: string; newlyCreated: boolean; nsfw: boolean; ownerId: string; parentId: null | string; permissionOverwrites: object[]; permissions: string; position: number; rateLimitPerUser: number; recipients: object[]; rtcRegion: null | string; threadMetadata: { archived: boolean; archiveTimestamp: string; autoArchiveDuration: 60 | 1440 | 4320 | 10080; createTimestamp: null | string; invitable: boolean; locked: boolean; }; topic: null | string; totalMessageSent: number; type: ChannelTypes; userLimit: number; videoQualityMode: VideoQualityModes; }; timestamp: string; tts: boolean; type: MessageTypes; webhookId: string; }>

Defined in: packages/rest/dist/types/types.d.ts:1020

Edits a follow-up message to an interaction.

Parameters

token

string

The interaction token to use, provided in the original interaction.

messageId

InteractionCallbackData

The ID of the message to edit.

options

The parameters for the edit of the message.

Returns

Promise<{ activity: { partyId: string; type: MessageActivityTypes; }; application: { approximateGuildCount: number; approximateUserInstallCount: number; bot: { accentColor: number; avatar: null | string; avatarDecorationData: { asset: string; skuId: string; }; banner: string; bot: boolean; discriminator: string; email: null | string; flags: number; globalName: null | string; id: string; locale: string; mfaEnabled: boolean; premiumType: PremiumTypes; publicFlags: number; system: boolean; username: string; verified: boolean; }; botPublic: boolean; botRequireCodeGrant: boolean; coverImage: string; customInstallUrl: string; description: string; eventWebhooksStatus: DiscordApplicationEventWebhookStatus; eventWebhooksTypes: DiscordWebhookEventType[]; eventWebhooksUrl: null | string; flags: ApplicationFlags; guild: { afkChannelId: null | string; afkTimeout: number; applicationId: null | string; approximateMemberCount: number; approximatePresenceCount: number; banner: null | string; channels: object[]; defaultMessageNotifications: DefaultMessageNotificationLevels; description: null | string; discoverySplash: null | string; emojis: object[]; explicitContentFilter: ExplicitContentFilterLevels; features: GuildFeatures[]; icon: null | string; iconHash: null | string; id: string; joinedAt: string; large: boolean; maxMembers: number; maxPresences: null | number; maxStageVideoChannelUsers: number; maxVideoChannelUsers: number; memberCount: number; members: object[]; mfaLevel: MfaLevels; name: string; nsfwLevel: GuildNsfwLevel; owner: boolean; ownerId: string; permissions: string; preferredLocale: string; premiumProgressBarEnabled: boolean; premiumSubscriptionCount: number; premiumTier: PremiumTiers; presences: object[]; publicUpdatesChannelId: null | string; roles: object[]; rulesChannelId: null | string; safetyAlertsChannelId: null | string; soundboardSounds: object[]; splash: null | string; stageInstances: object[]; stickers: object[]; systemChannelFlags: SystemChannelFlags; systemChannelId: null | string; threads: object[]; unavailable: boolean; vanityUrlCode: null | string; verificationLevel: VerificationLevels; voiceStates: object[]; welcomeScreen: { description: null | string; welcomeChannels: object[]; }; widgetChannelId: null | string; widgetEnabled: boolean; }; guildId: string; icon: null | string; id: string; installParams: { permissions: string; scopes: OAuth2Scope[]; }; integrationTypesConfig: { 0: { oauth2InstallParams: { permissions: ...; scopes: ...; }; }; 1: { oauth2InstallParams: { permissions: ...; scopes: ...; }; }; }; interactionsEndpointUrl: null | string; name: string; owner: { accentColor: number; avatar: null | string; avatarDecorationData: { asset: string; skuId: string; }; banner: string; bot: boolean; discriminator: string; email: null | string; flags: number; globalName: null | string; id: string; locale: string; mfaEnabled: boolean; premiumType: PremiumTypes; publicFlags: number; system: boolean; username: string; verified: boolean; }; primarySkuId: string; privacyPolicyUrl: string; redirectUris: string[]; roleConnectionsVerificationUrl: null | string; rpcOrigins: string[]; slug: string; tags: string[]; team: null | { icon: null | string; id: string; members: object[]; name: string; ownerUserId: string; }; termsOfServiceUrl: string; verifyKey: string; }; applicationId: string; attachments: object[]; author: { accentColor: number; avatar: null | string; avatarDecorationData: { asset: string; skuId: string; }; banner: string; bot: boolean; discriminator: string; email: null | string; flags: number; globalName: null | string; id: string; locale: string; mfaEnabled: boolean; premiumType: PremiumTypes; publicFlags: number; system: boolean; username: string; verified: boolean; }; call: { endedTimestamp: string; participants: string[]; }; channelId: string; components: ({ components: ({ channelTypes: ... | ...; customId: string; defaultValues: ... | ...; disabled: ... | ... | ...; maxValues: ... | ...; minValues: ... | ...; options: ... | ...; placeholder: ... | ...; type: ... | ... | ... | ... | ...; } | { customId: ... | ...; disabled: ... | ... | ...; emoji: ... | ...; label: ... | ...; skuId: ... | ...; style: ButtonStyles; type: Button; url: ... | ...; } | { customId: string; label: string; maxLength: ... | ...; minLength: ... | ...; placeholder: ... | ...; required: ... | ... | ...; style: TextStyles; type: InputText; value: ... | ...; })[]; type: ActionRow; } | { channelTypes: ChannelTypes[]; customId: string; defaultValues: object[]; disabled: boolean; maxValues: number; minValues: number; options: object[]; placeholder: string; type: SelectMenu | SelectMenuUsers | SelectMenuRoles | SelectMenuUsersAndRoles | SelectMenuChannels; } | { customId: string; disabled: boolean; emoji: { animated: boolean; id: string; name: string; }; label: string; skuId: string; style: ButtonStyles; type: Button; url: string; } | { customId: string; label: string; maxLength: number; minLength: number; placeholder: string; required: boolean; style: TextStyles; type: InputText; value: string; })[]; content: string; editedTimestamp: null | string; embeds: object[]; flags: MessageFlags; guildId: string; id: string; interaction: { id: string; member: { avatar: string; avatarDecorationData: null | { asset: string; skuId: string; }; banner: string; communicationDisabledUntil: null | string; deaf: boolean; flags: number; joinedAt: string; mute: boolean; nick: null | string; pending: boolean; permissions: string; premiumSince: null | string; roles: string[]; user: { accentColor: number; avatar: null | string; avatarDecorationData: { asset: ...; skuId: ...; }; banner: string; bot: boolean; discriminator: string; email: null | string; flags: number; globalName: null | string; id: string; locale: string; mfaEnabled: boolean; premiumType: PremiumTypes; publicFlags: number; system: boolean; username: string; verified: boolean; }; }; name: string; type: InteractionTypes; user: { accentColor: number; avatar: null | string; avatarDecorationData: { asset: string; skuId: string; }; banner: string; bot: boolean; discriminator: string; email: null | string; flags: number; globalName: null | string; id: string; locale: string; mfaEnabled: boolean; premiumType: PremiumTypes; publicFlags: number; system: boolean; username: string; verified: boolean; }; }; interactionMetadata: { authorizingIntegrationOwners: { 0: string; 1: string; }; id: string; originalResponseMessageId: string; targetMessageId: string; targetUser: { accentColor: number; avatar: null | string; avatarDecorationData: { asset: string; skuId: string; }; banner: string; bot: boolean; discriminator: string; email: null | string; flags: number; globalName: null | string; id: string; locale: string; mfaEnabled: boolean; premiumType: PremiumTypes; publicFlags: number; system: boolean; username: string; verified: boolean; }; type: InteractionTypes; user: { accentColor: number; avatar: null | string; avatarDecorationData: { asset: string; skuId: string; }; banner: string; bot: boolean; discriminator: string; email: null | string; flags: number; globalName: null | string; id: string; locale: string; mfaEnabled: boolean; premiumType: PremiumTypes; publicFlags: number; system: boolean; username: string; verified: boolean; }; } | { authorizingIntegrationOwners: { 0: string; 1: string; }; id: string; interactedMessageId: string; originalResponseMessageId: string; type: InteractionTypes; user: { accentColor: number; avatar: null | string; avatarDecorationData: { asset: string; skuId: string; }; banner: string; bot: boolean; discriminator: string; email: null | string; flags: number; globalName: null | string; id: string; locale: string; mfaEnabled: boolean; premiumType: PremiumTypes; publicFlags: number; system: boolean; username: string; verified: boolean; }; } | { authorizingIntegrationOwners: { 0: string; 1: string; }; id: string; originalResponseMessageId: string; triggeringInteractionMetadata: { id: string; type: InteractionTypes; user: { username: string; globalName: string | null; locale?: string | undefined; flags?: number | undefined; premiumType?: PremiumTypes | undefined; ... 11 more ...; avatarDecorationData?: { ...; } | undefined; }; authorizingIntegrationOwners: { ...; }; originalResponseMessageI...; type: InteractionTypes; user: { accentColor: number; avatar: null | string; avatarDecorationData: { asset: string; skuId: string; }; banner: string; bot: boolean; discriminator: string; email: null | string; flags: number; globalName: null | string; id: string; locale: string; mfaEnabled: boolean; premiumType: PremiumTypes; publicFlags: number; system: boolean; username: string; verified: boolean; }; }; member: { avatar: string; avatarDecorationData: null | { asset: string; skuId: string; }; banner: string; communicationDisabledUntil: null | string; deaf: boolean; flags: number; joinedAt: string; mute: boolean; nick: null | string; pending: boolean; permissions: string; premiumSince: null | string; roles: string[]; user: { accentColor: number; avatar: null | string; avatarDecorationData: { asset: string; skuId: string; }; banner: string; bot: boolean; discriminator: string; email: null | string; flags: number; globalName: null | string; id: string; locale: string; mfaEnabled: boolean; premiumType: PremiumTypes; publicFlags: number; system: boolean; username: string; verified: boolean; }; }; mentionChannels: object[]; mentionEveryone: boolean; mentionRoles: string[]; mentions: object[]; messageReference: { channelId: string; failIfNotExists: boolean; guildId: string; messageId: string; type: DiscordMessageReferenceType; }; messageSnapshots: object[]; nonce: string | number; pinned: boolean; poll: { allowMultiselect: boolean; answers: object[]; expiry: null | string; layoutType: Default; question: { emoji: { animated: boolean; available: boolean; id: string; managed: boolean; name: string; requireColons: boolean; roles: string[]; user: { accentColor: ... | ...; avatar: ... | ...; avatarDecorationData: ... | ...; banner: ... | ...; bot: ... | ... | ...; discriminator: string; email: ... | ... | ...; flags: ... | ...; globalName: ... | ...; id: string; locale: ... | ...; mfaEnabled: ... | ... | ...; premiumType: ... | ...; publicFlags: ... | ...; system: ... | ... | ...; username: string; verified: ... | ... | ...; }; }; text: string; }; results: { answerCounts: object[]; isFinalized: boolean; }; }; position: number; reactions: object[]; referencedMessage: { id: string; channelId: string; guildId?: string | undefined; author: { username: string; globalName: string | null; locale?: string | undefined; flags?: number | undefined; premiumType?: PremiumTypes | undefined; ... 11 more ...; avatarDecorationData?: { ...; } | undefined; }; ... 31 more ...; call?: { ...; } | un...; stickerItems: object[]; stickers: object[]; thread: { applicationId: string; appliedTags: string[]; availableTags: object[]; bitrate: number; defaultAutoArchiveDuration: number; defaultForumLayout: ForumLayout; defaultReactionEmoji: null | { emojiId: string; emojiName: null | string; }; defaultSortOrder: null | SortOrderTypes; defaultThreadRateLimitPerUser: number; flags: ChannelFlags; guildId: string; icon: string; id: string; lastMessageId: null | string; lastPinTimestamp: null | string; managed: boolean; member: { flags: number; id: string; joinTimestamp: string; userId: string; }; memberCount: number; messageCount: number; name: string; newlyCreated: boolean; nsfw: boolean; ownerId: string; parentId: null | string; permissionOverwrites: object[]; permissions: string; position: number; rateLimitPerUser: number; recipients: object[]; rtcRegion: null | string; threadMetadata: { archived: boolean; archiveTimestamp: string; autoArchiveDuration: 60 | 1440 | 4320 | 10080; createTimestamp: null | string; invitable: boolean; locked: boolean; }; topic: null | string; totalMessageSent: number; type: ChannelTypes; userLimit: number; videoQualityMode: VideoQualityModes; }; timestamp: string; tts: boolean; type: MessageTypes; webhookId: string; }>

An instance of the edited DiscordMessage.

Remarks

Unlike editMessage(), this endpoint allows the bot user to act without needing to see the channel the message is in.

Does not support ephemeral follow-up messages due to these being stateless.

Fires a Message Update event.

See

https://discord.com/developers/docs/interactions/receiving-and-responding#edit-followup-message

editGlobalApplicationCommand()

editGlobalApplicationCommand: (commandId, options) => Promise<{ applicationId: string; contexts: null | DiscordInteractionContextType[]; defaultMemberPermissions: null | string; description: string; descriptionLocalizations: null | { bg: string; cs: string; da: string; de: string; el: string; en-GB: string; en-US: string; es-419: string; es-ES: string; fi: string; fr: string; hi: string; hr: string; hu: string; id: string; it: string; ja: string; ko: string; lt: string; nl: string; no: string; pl: string; pt-BR: string; ro: string; ru: string; sv-SE: string; th: string; tr: string; uk: string; vi: string; zh-CN: string; zh-TW: string; }; dmPermission: boolean; guildId: string; handler: DiscordInteractionEntryPointCommandHandlerType; id: string; integrationTypes: DiscordApplicationIntegrationType[]; name: string; nameLocalizations: null | { bg: string; cs: string; da: string; de: string; el: string; en-GB: string; en-US: string; es-419: string; es-ES: string; fi: string; fr: string; hi: string; hr: string; hu: string; id: string; it: string; ja: string; ko: string; lt: string; nl: string; no: string; pl: string; pt-BR: string; ro: string; ru: string; sv-SE: string; th: string; tr: string; uk: string; vi: string; zh-CN: string; zh-TW: string; }; nsfw: boolean; options: object[]; type: ApplicationCommandTypes; version: string; }>

Defined in: packages/rest/dist/types/types.d.ts:1030

Edits a global application command.

Parameters

commandId

The ID of the command to edit.

options

https://discord.com/developers/docs/interactions/application-commands#edit-global-application-command

The parameters for the edit of the command.

Returns

An instance of the edited DiscordApplicationCommand.

See

editGuild()

editGuild: (guildId, options, reason?) => Promise<{ afkChannelId: null | string; afkTimeout: number; applicationId: null | string; approximateMemberCount: number; approximatePresenceCount: number; banner: null | string; channels: object[]; defaultMessageNotifications: DefaultMessageNotificationLevels; description: null | string; discoverySplash: null | string; emojis: object[]; explicitContentFilter: ExplicitContentFilterLevels; features: GuildFeatures[]; icon: null | string; iconHash: null | string; id: string; joinedAt: string; large: boolean; maxMembers: number; maxPresences: null | number; maxStageVideoChannelUsers: number; maxVideoChannelUsers: number; memberCount: number; members: object[]; mfaLevel: MfaLevels; name: string; nsfwLevel: GuildNsfwLevel; owner: boolean; ownerId: string; permissions: string; preferredLocale: string; premiumProgressBarEnabled: boolean; premiumSubscriptionCount: number; premiumTier: PremiumTiers; presences: object[]; publicUpdatesChannelId: null | string; roles: object[]; rulesChannelId: null | string; safetyAlertsChannelId: null | string; soundboardSounds: object[]; splash: null | string; stageInstances: object[]; stickers: object[]; systemChannelFlags: SystemChannelFlags; systemChannelId: null | string; threads: object[]; unavailable: boolean; vanityUrlCode: null | string; verificationLevel: VerificationLevels; voiceStates: object[]; welcomeScreen: { description: null | string; welcomeChannels: object[]; }; widgetChannelId: null | string; widgetEnabled: boolean; }>

Defined in: packages/rest/dist/types/types.d.ts:1049

Edits a guild's settings.

Parameters

guildId

https://discord.com/developers/docs/resources/guild#modify-guild

The ID of the guild to edit.

options

ModifyGuild

The parameters for the edit of the guild.

reason?

string

An optional reason for the action, to be included in the audit log.

Returns

An instance of the edited DiscordGuild.

Remarks

Requires the MANAGE_GUILD permission.

If attempting to add or remove the GuildFeatures.Community feature:

Requires the ADMINISTRATOR permission.

Fires a Guild Update gateway event.

See

editGuildApplicationCommand()

editGuildApplicationCommand: (commandId, guildId, options) => Promise<{ applicationId: string; contexts: null | DiscordInteractionContextType[]; defaultMemberPermissions: null | string; description: string; descriptionLocalizations: null | { bg: string; cs: string; da: string; de: string; el: string; en-GB: string; en-US: string; es-419: string; es-ES: string; fi: string; fr: string; hi: string; hr: string; hu: string; id: string; it: string; ja: string; ko: string; lt: string; nl: string; no: string; pl: string; pt-BR: string; ro: string; ru: string; sv-SE: string; th: string; tr: string; uk: string; vi: string; zh-CN: string; zh-TW: string; }; dmPermission: boolean; guildId: string; handler: DiscordInteractionEntryPointCommandHandlerType; id: string; integrationTypes: DiscordApplicationIntegrationType[]; name: string; nameLocalizations: null | { bg: string; cs: string; da: string; de: string; el: string; en-GB: string; en-US: string; es-419: string; es-ES: string; fi: string; fr: string; hi: string; hr: string; hu: string; id: string; it: string; ja: string; ko: string; lt: string; nl: string; no: string; pl: string; pt-BR: string; ro: string; ru: string; sv-SE: string; th: string; tr: string; uk: string; vi: string; zh-CN: string; zh-TW: string; }; nsfw: boolean; options: object[]; type: ApplicationCommandTypes; version: string; }>

Defined in: packages/rest/dist/types/types.d.ts:1060

Edits an application command registered in a guild.

Parameters

commandId

The ID of the command to edit.

guildId

The ID of the guild the command is registered in.

options

https://discord.com/developers/docs/interactions/application-commands#edit-guild-application-command

The parameters for the edit of the command.

Returns

An instance of the edited DiscordApplicationCommand.

See

editGuildMfaLevel()

editGuildMfaLevel: (guildId, mfaLevel, reason?) => Promise<void>

Defined in: packages/rest/dist/types/types.d.ts:1064

Modify a guild's MFA level. Requires guild ownership.

Parameters

guildId

mfaLevel

MfaLevels

reason?

string

An optional reason for the action, to be included in the audit log.

Returns

Promise<void>

editGuildOnboarding()

editGuildOnboarding: (guildId, options, reason?) => Promise<{ defaultChannelIds: string[]; enabled: boolean; guildId: string; mode: DiscordGuildOnboardingMode; prompts: object[]; }>

Defined in: packages/rest/dist/types/types.d.ts:2783

Modifies the onboarding configuration of the guild.

Parameters

guildId

The guild to get the onboarding from

options

EditGuildOnboarding

reason?

string

An optional reason for the action, to be included in the audit log.

Returns

Promise<{ defaultChannelIds: string[]; enabled: boolean; guildId: string; mode: DiscordGuildOnboardingMode; prompts: object[]; }>

Remarks

Requires the MANAGE_GUILD and MANAGE_ROLES permissions.

Onboarding enforces constraints when enabled. These constraints are:

at least 7 default channels
at least 5 of the 7 channels must allow sending messages to the @everyone role

The mode field modifies what is considered when enforcing these constraints.

editGuildSticker()

editGuildSticker: (guildId, stickerId, options, reason?) => Promise<{ available: boolean; description: string; formatType: StickerFormatTypes; guildId: string; id: string; name: string; packId: string; sortValue: number; tags: string; type: StickerTypes; user: { accentColor: number; avatar: null | string; avatarDecorationData: { asset: string; skuId: string; }; banner: string; bot: boolean; discriminator: string; email: null | string; flags: number; globalName: null | string; id: string; locale: string; mfaEnabled: boolean; premiumType: PremiumTypes; publicFlags: number; system: boolean; username: string; verified: boolean; }; }>

Defined in: packages/rest/dist/types/types.d.ts:1079

Edit the given sticker.

Parameters

guildId

The ID of the guild to get

stickerId

AtLeastOne<EditGuildStickerOptions>

options

reason?

string

An optional reason for the action, to be included in the audit log.

Returns

https://discord.com/developers/docs/resources/sticker#modify-guild-sticker

Remarks

See

editGuildTemplate()

editGuildTemplate: (guildId, templateCode, options) => Promise<{ code: string; createdAt: string; creator: { accentColor: number; avatar: null | string; avatarDecorationData: { asset: string; skuId: string; }; banner: string; bot: boolean; discriminator: string; email: null | string; flags: number; globalName: null | string; id: string; locale: string; mfaEnabled: boolean; premiumType: PremiumTypes; publicFlags: number; system: boolean; username: string; verified: boolean; }; creatorId: string; description: null | string; isDirty: null | boolean; name: string; serializedSourceGuild: { afkChannelId: null | number; afkTimeout: number; applicationId: null | string; approximateMemberCount: number; approximatePresenceCount: number; banner: null | string; channels: object[]; defaultMessageNotifications: DefaultMessageNotificationLevels; description: null | string; discoverySplash: null | string; emojis: object[]; explicitContentFilter: ExplicitContentFilterLevels; features: GuildFeatures[]; icon: null | string; iconHash: null | string; id: string; joinedAt: string; large: boolean; maxMembers: number; maxPresences: null | number; maxStageVideoChannelUsers: number; maxVideoChannelUsers: number; memberCount: number; members: object[]; mfaLevel: MfaLevels; name: string; nsfwLevel: GuildNsfwLevel; owner: boolean; ownerId: string; permissions: string; preferredLocale: string; premiumProgressBarEnabled: boolean; premiumSubscriptionCount: number; premiumTier: PremiumTiers; presences: object[]; publicUpdatesChannelId: null | string; roles: object[]; rulesChannelId: null | string; safetyAlertsChannelId: null | string; soundboardSounds: object[]; splash: null | string; stageInstances: object[]; stickers: object[]; systemChannelFlags: SystemChannelFlags; systemChannelId: null | number; threads: object[]; unavailable: boolean; vanityUrlCode: null | string; verificationLevel: VerificationLevels; voiceStates: object[]; welcomeScreen: { description: null | string; welcomeChannels: object[]; }; widgetChannelId: null | string; widgetEnabled: boolean; }; sourceGuildId: string; updatedAt: string; usageCount: number; }>

Defined in: packages/rest/dist/types/types.d.ts:1095

Edits a template's settings.

Parameters

guildId

https://discord.com/developers/docs/resources/guild-template#modify-guild-template

The ID of the guild to edit a template of.

templateCode

string

The code of the template to edit.

options

ModifyGuildTemplate

The parameters for the edit of the template.

Returns

An instance of the edited DiscordTemplate.

Remarks

Requires the MANAGE_GUILD permission.

Fires a Guild Update gateway event.

See

editMember()

editMember: (guildId, userId, options, reason?) => Promise<{ avatar: string; avatarDecorationData: null | { asset: string; skuId: string; }; banner: string; communicationDisabledUntil: null | string; deaf: boolean; flags: number; joinedAt: string; mute: boolean; nick: null | string; pending: boolean; permissions: string; premiumSince: null | string; roles: string[]; user: { accentColor: number; avatar: null | string; avatarDecorationData: { asset: string; skuId: string; }; banner: string; bot: boolean; discriminator: string; email: null | string; flags: number; globalName: null | string; id: string; locale: string; mfaEnabled: boolean; premiumType: PremiumTypes; publicFlags: number; system: boolean; username: string; verified: boolean; }; }>

Defined in: packages/rest/dist/types/types.d.ts:2608

Edits a member's properties.

Parameters

guildId

The ID of the guild to edit the member of.

userId

https://discord.com/developers/docs/resources/guild#modify-guild-member

The user ID of the member to edit.

options

ModifyGuildMember

The parameters for the edit of the user.

reason?

string

An optional reason for the action, to be included in the audit log.

Returns

Remarks

This endpoint requires various permissions depending on what is edited about the member. To find out the required permission to enact a change, read the documentation of this endpoint's parameters.

Fires a Guild Member Update gateway event.

See

editMessage()

editMessage: (channelId, messageId, options) => Promise<{ activity: { partyId: string; type: MessageActivityTypes; }; application: { approximateGuildCount: number; approximateUserInstallCount: number; bot: { accentColor: number; avatar: null | string; avatarDecorationData: { asset: string; skuId: string; }; banner: string; bot: boolean; discriminator: string; email: null | string; flags: number; globalName: null | string; id: string; locale: string; mfaEnabled: boolean; premiumType: PremiumTypes; publicFlags: number; system: boolean; username: string; verified: boolean; }; botPublic: boolean; botRequireCodeGrant: boolean; coverImage: string; customInstallUrl: string; description: string; eventWebhooksStatus: DiscordApplicationEventWebhookStatus; eventWebhooksTypes: DiscordWebhookEventType[]; eventWebhooksUrl: null | string; flags: ApplicationFlags; guild: { afkChannelId: null | string; afkTimeout: number; applicationId: null | string; approximateMemberCount: number; approximatePresenceCount: number; banner: null | string; channels: object[]; defaultMessageNotifications: DefaultMessageNotificationLevels; description: null | string; discoverySplash: null | string; emojis: object[]; explicitContentFilter: ExplicitContentFilterLevels; features: GuildFeatures[]; icon: null | string; iconHash: null | string; id: string; joinedAt: string; large: boolean; maxMembers: number; maxPresences: null | number; maxStageVideoChannelUsers: number; maxVideoChannelUsers: number; memberCount: number; members: object[]; mfaLevel: MfaLevels; name: string; nsfwLevel: GuildNsfwLevel; owner: boolean; ownerId: string; permissions: string; preferredLocale: string; premiumProgressBarEnabled: boolean; premiumSubscriptionCount: number; premiumTier: PremiumTiers; presences: object[]; publicUpdatesChannelId: null | string; roles: object[]; rulesChannelId: null | string; safetyAlertsChannelId: null | string; soundboardSounds: object[]; splash: null | string; stageInstances: object[]; stickers: object[]; systemChannelFlags: SystemChannelFlags; systemChannelId: null | string; threads: object[]; unavailable: boolean; vanityUrlCode: null | string; verificationLevel: VerificationLevels; voiceStates: object[]; welcomeScreen: { description: null | string; welcomeChannels: object[]; }; widgetChannelId: null | string; widgetEnabled: boolean; }; guildId: string; icon: null | string; id: string; installParams: { permissions: string; scopes: OAuth2Scope[]; }; integrationTypesConfig: { 0: { oauth2InstallParams: { permissions: ...; scopes: ...; }; }; 1: { oauth2InstallParams: { permissions: ...; scopes: ...; }; }; }; interactionsEndpointUrl: null | string; name: string; owner: { accentColor: number; avatar: null | string; avatarDecorationData: { asset: string; skuId: string; }; banner: string; bot: boolean; discriminator: string; email: null | string; flags: number; globalName: null | string; id: string; locale: string; mfaEnabled: boolean; premiumType: PremiumTypes; publicFlags: number; system: boolean; username: string; verified: boolean; }; primarySkuId: string; privacyPolicyUrl: string; redirectUris: string[]; roleConnectionsVerificationUrl: null | string; rpcOrigins: string[]; slug: string; tags: string[]; team: null | { icon: null | string; id: string; members: object[]; name: string; ownerUserId: string; }; termsOfServiceUrl: string; verifyKey: string; }; applicationId: string; attachments: object[]; author: { accentColor: number; avatar: null | string; avatarDecorationData: { asset: string; skuId: string; }; banner: string; bot: boolean; discriminator: string; email: null | string; flags: number; globalName: null | string; id: string; locale: string; mfaEnabled: boolean; premiumType: PremiumTypes; publicFlags: number; system: boolean; username: string; verified: boolean; }; call: { endedTimestamp: string; participants: string[]; }; channelId: string; components: ({ components: ({ channelTypes: ... | ...; customId: string; defaultValues: ... | ...; disabled: ... | ... | ...; maxValues: ... | ...; minValues: ... | ...; options: ... | ...; placeholder: ... | ...; type: ... | ... | ... | ... | ...; } | { customId: ... | ...; disabled: ... | ... | ...; emoji: ... | ...; label: ... | ...; skuId: ... | ...; style: ButtonStyles; type: Button; url: ... | ...; } | { customId: string; label: string; maxLength: ... | ...; minLength: ... | ...; placeholder: ... | ...; required: ... | ... | ...; style: TextStyles; type: InputText; value: ... | ...; })[]; type: ActionRow; } | { channelTypes: ChannelTypes[]; customId: string; defaultValues: object[]; disabled: boolean; maxValues: number; minValues: number; options: object[]; placeholder: string; type: SelectMenu | SelectMenuUsers | SelectMenuRoles | SelectMenuUsersAndRoles | SelectMenuChannels; } | { customId: string; disabled: boolean; emoji: { animated: boolean; id: string; name: string; }; label: string; skuId: string; style: ButtonStyles; type: Button; url: string; } | { customId: string; label: string; maxLength: number; minLength: number; placeholder: string; required: boolean; style: TextStyles; type: InputText; value: string; })[]; content: string; editedTimestamp: null | string; embeds: object[]; flags: MessageFlags; guildId: string; id: string; interaction: { id: string; member: { avatar: string; avatarDecorationData: null | { asset: string; skuId: string; }; banner: string; communicationDisabledUntil: null | string; deaf: boolean; flags: number; joinedAt: string; mute: boolean; nick: null | string; pending: boolean; permissions: string; premiumSince: null | string; roles: string[]; user: { accentColor: number; avatar: null | string; avatarDecorationData: { asset: ...; skuId: ...; }; banner: string; bot: boolean; discriminator: string; email: null | string; flags: number; globalName: null | string; id: string; locale: string; mfaEnabled: boolean; premiumType: PremiumTypes; publicFlags: number; system: boolean; username: string; verified: boolean; }; }; name: string; type: InteractionTypes; user: { accentColor: number; avatar: null | string; avatarDecorationData: { asset: string; skuId: string; }; banner: string; bot: boolean; discriminator: string; email: null | string; flags: number; globalName: null | string; id: string; locale: string; mfaEnabled: boolean; premiumType: PremiumTypes; publicFlags: number; system: boolean; username: string; verified: boolean; }; }; interactionMetadata: { authorizingIntegrationOwners: { 0: string; 1: string; }; id: string; originalResponseMessageId: string; targetMessageId: string; targetUser: { accentColor: number; avatar: null | string; avatarDecorationData: { asset: string; skuId: string; }; banner: string; bot: boolean; discriminator: string; email: null | string; flags: number; globalName: null | string; id: string; locale: string; mfaEnabled: boolean; premiumType: PremiumTypes; publicFlags: number; system: boolean; username: string; verified: boolean; }; type: InteractionTypes; user: { accentColor: number; avatar: null | string; avatarDecorationData: { asset: string; skuId: string; }; banner: string; bot: boolean; discriminator: string; email: null | string; flags: number; globalName: null | string; id: string; locale: string; mfaEnabled: boolean; premiumType: PremiumTypes; publicFlags: number; system: boolean; username: string; verified: boolean; }; } | { authorizingIntegrationOwners: { 0: string; 1: string; }; id: string; interactedMessageId: string; originalResponseMessageId: string; type: InteractionTypes; user: { accentColor: number; avatar: null | string; avatarDecorationData: { asset: string; skuId: string; }; banner: string; bot: boolean; discriminator: string; email: null | string; flags: number; globalName: null | string; id: string; locale: string; mfaEnabled: boolean; premiumType: PremiumTypes; publicFlags: number; system: boolean; username: string; verified: boolean; }; } | { authorizingIntegrationOwners: { 0: string; 1: string; }; id: string; originalResponseMessageId: string; triggeringInteractionMetadata: { id: string; type: InteractionTypes; user: { username: string; globalName: string | null; locale?: string | undefined; flags?: number | undefined; premiumType?: PremiumTypes | undefined; ... 11 more ...; avatarDecorationData?: { ...; } | undefined; }; authorizingIntegrationOwners: { ...; }; originalResponseMessageI...; type: InteractionTypes; user: { accentColor: number; avatar: null | string; avatarDecorationData: { asset: string; skuId: string; }; banner: string; bot: boolean; discriminator: string; email: null | string; flags: number; globalName: null | string; id: string; locale: string; mfaEnabled: boolean; premiumType: PremiumTypes; publicFlags: number; system: boolean; username: string; verified: boolean; }; }; member: { avatar: string; avatarDecorationData: null | { asset: string; skuId: string; }; banner: string; communicationDisabledUntil: null | string; deaf: boolean; flags: number; joinedAt: string; mute: boolean; nick: null | string; pending: boolean; permissions: string; premiumSince: null | string; roles: string[]; user: { accentColor: number; avatar: null | string; avatarDecorationData: { asset: string; skuId: string; }; banner: string; bot: boolean; discriminator: string; email: null | string; flags: number; globalName: null | string; id: string; locale: string; mfaEnabled: boolean; premiumType: PremiumTypes; publicFlags: number; system: boolean; username: string; verified: boolean; }; }; mentionChannels: object[]; mentionEveryone: boolean; mentionRoles: string[]; mentions: object[]; messageReference: { channelId: string; failIfNotExists: boolean; guildId: string; messageId: string; type: DiscordMessageReferenceType; }; messageSnapshots: object[]; nonce: string | number; pinned: boolean; poll: { allowMultiselect: boolean; answers: object[]; expiry: null | string; layoutType: Default; question: { emoji: { animated: boolean; available: boolean; id: string; managed: boolean; name: string; requireColons: boolean; roles: string[]; user: { accentColor: ... | ...; avatar: ... | ...; avatarDecorationData: ... | ...; banner: ... | ...; bot: ... | ... | ...; discriminator: string; email: ... | ... | ...; flags: ... | ...; globalName: ... | ...; id: string; locale: ... | ...; mfaEnabled: ... | ... | ...; premiumType: ... | ...; publicFlags: ... | ...; system: ... | ... | ...; username: string; verified: ... | ... | ...; }; }; text: string; }; results: { answerCounts: object[]; isFinalized: boolean; }; }; position: number; reactions: object[]; referencedMessage: { id: string; channelId: string; guildId?: string | undefined; author: { username: string; globalName: string | null; locale?: string | undefined; flags?: number | undefined; premiumType?: PremiumTypes | undefined; ... 11 more ...; avatarDecorationData?: { ...; } | undefined; }; ... 31 more ...; call?: { ...; } | un...; stickerItems: object[]; stickers: object[]; thread: { applicationId: string; appliedTags: string[]; availableTags: object[]; bitrate: number; defaultAutoArchiveDuration: number; defaultForumLayout: ForumLayout; defaultReactionEmoji: null | { emojiId: string; emojiName: null | string; }; defaultSortOrder: null | SortOrderTypes; defaultThreadRateLimitPerUser: number; flags: ChannelFlags; guildId: string; icon: string; id: string; lastMessageId: null | string; lastPinTimestamp: null | string; managed: boolean; member: { flags: number; id: string; joinTimestamp: string; userId: string; }; memberCount: number; messageCount: number; name: string; newlyCreated: boolean; nsfw: boolean; ownerId: string; parentId: null | string; permissionOverwrites: object[]; permissions: string; position: number; rateLimitPerUser: number; recipients: object[]; rtcRegion: null | string; threadMetadata: { archived: boolean; archiveTimestamp: string; autoArchiveDuration: 60 | 1440 | 4320 | 10080; createTimestamp: null | string; invitable: boolean; locked: boolean; }; topic: null | string; totalMessageSent: number; type: ChannelTypes; userLimit: number; videoQualityMode: VideoQualityModes; }; timestamp: string; tts: boolean; type: MessageTypes; webhookId: string; }>

Defined in: packages/rest/dist/types/types.d.ts:1113

Edits a message.

Parameters

channelId

The ID of the channel to edit the message in.

messageId

https://discord.com/developers/docs/resources/channel#edit-message

The IDs of the message to edit.

options

EditMessage

The parameters for the edit of the message.

Returns

An instance of the edited DiscordMessage.

Remarks

If editing another user's message:

Requires the MANAGE_MESSAGES permission.
Only the flags property of the options object parameter can be edited.

Fires a Message Update gateway event.

See

editOriginalInteractionResponse()

editOriginalInteractionResponse: (token, options) => Promise<{ activity: { partyId: string; type: MessageActivityTypes; }; application: { approximateGuildCount: number; approximateUserInstallCount: number; bot: { accentColor: number; avatar: null | string; avatarDecorationData: { asset: string; skuId: string; }; banner: string; bot: boolean; discriminator: string; email: null | string; flags: number; globalName: null | string; id: string; locale: string; mfaEnabled: boolean; premiumType: PremiumTypes; publicFlags: number; system: boolean; username: string; verified: boolean; }; botPublic: boolean; botRequireCodeGrant: boolean; coverImage: string; customInstallUrl: string; description: string; eventWebhooksStatus: DiscordApplicationEventWebhookStatus; eventWebhooksTypes: DiscordWebhookEventType[]; eventWebhooksUrl: null | string; flags: ApplicationFlags; guild: { afkChannelId: null | string; afkTimeout: number; applicationId: null | string; approximateMemberCount: number; approximatePresenceCount: number; banner: null | string; channels: object[]; defaultMessageNotifications: DefaultMessageNotificationLevels; description: null | string; discoverySplash: null | string; emojis: object[]; explicitContentFilter: ExplicitContentFilterLevels; features: GuildFeatures[]; icon: null | string; iconHash: null | string; id: string; joinedAt: string; large: boolean; maxMembers: number; maxPresences: null | number; maxStageVideoChannelUsers: number; maxVideoChannelUsers: number; memberCount: number; members: object[]; mfaLevel: MfaLevels; name: string; nsfwLevel: GuildNsfwLevel; owner: boolean; ownerId: string; permissions: string; preferredLocale: string; premiumProgressBarEnabled: boolean; premiumSubscriptionCount: number; premiumTier: PremiumTiers; presences: object[]; publicUpdatesChannelId: null | string; roles: object[]; rulesChannelId: null | string; safetyAlertsChannelId: null | string; soundboardSounds: object[]; splash: null | string; stageInstances: object[]; stickers: object[]; systemChannelFlags: SystemChannelFlags; systemChannelId: null | string; threads: object[]; unavailable: boolean; vanityUrlCode: null | string; verificationLevel: VerificationLevels; voiceStates: object[]; welcomeScreen: { description: null | string; welcomeChannels: object[]; }; widgetChannelId: null | string; widgetEnabled: boolean; }; guildId: string; icon: null | string; id: string; installParams: { permissions: string; scopes: OAuth2Scope[]; }; integrationTypesConfig: { 0: { oauth2InstallParams: { permissions: ...; scopes: ...; }; }; 1: { oauth2InstallParams: { permissions: ...; scopes: ...; }; }; }; interactionsEndpointUrl: null | string; name: string; owner: { accentColor: number; avatar: null | string; avatarDecorationData: { asset: string; skuId: string; }; banner: string; bot: boolean; discriminator: string; email: null | string; flags: number; globalName: null | string; id: string; locale: string; mfaEnabled: boolean; premiumType: PremiumTypes; publicFlags: number; system: boolean; username: string; verified: boolean; }; primarySkuId: string; privacyPolicyUrl: string; redirectUris: string[]; roleConnectionsVerificationUrl: null | string; rpcOrigins: string[]; slug: string; tags: string[]; team: null | { icon: null | string; id: string; members: object[]; name: string; ownerUserId: string; }; termsOfServiceUrl: string; verifyKey: string; }; applicationId: string; attachments: object[]; author: { accentColor: number; avatar: null | string; avatarDecorationData: { asset: string; skuId: string; }; banner: string; bot: boolean; discriminator: string; email: null | string; flags: number; globalName: null | string; id: string; locale: string; mfaEnabled: boolean; premiumType: PremiumTypes; publicFlags: number; system: boolean; username: string; verified: boolean; }; call: { endedTimestamp: string; participants: string[]; }; channelId: string; components: ({ components: ({ channelTypes: ... | ...; customId: string; defaultValues: ... | ...; disabled: ... | ... | ...; maxValues: ... | ...; minValues: ... | ...; options: ... | ...; placeholder: ... | ...; type: ... | ... | ... | ... | ...; } | { customId: ... | ...; disabled: ... | ... | ...; emoji: ... | ...; label: ... | ...; skuId: ... | ...; style: ButtonStyles; type: Button; url: ... | ...; } | { customId: string; label: string; maxLength: ... | ...; minLength: ... | ...; placeholder: ... | ...; required: ... | ... | ...; style: TextStyles; type: InputText; value: ... | ...; })[]; type: ActionRow; } | { channelTypes: ChannelTypes[]; customId: string; defaultValues: object[]; disabled: boolean; maxValues: number; minValues: number; options: object[]; placeholder: string; type: SelectMenu | SelectMenuUsers | SelectMenuRoles | SelectMenuUsersAndRoles | SelectMenuChannels; } | { customId: string; disabled: boolean; emoji: { animated: boolean; id: string; name: string; }; label: string; skuId: string; style: ButtonStyles; type: Button; url: string; } | { customId: string; label: string; maxLength: number; minLength: number; placeholder: string; required: boolean; style: TextStyles; type: InputText; value: string; })[]; content: string; editedTimestamp: null | string; embeds: object[]; flags: MessageFlags; guildId: string; id: string; interaction: { id: string; member: { avatar: string; avatarDecorationData: null | { asset: string; skuId: string; }; banner: string; communicationDisabledUntil: null | string; deaf: boolean; flags: number; joinedAt: string; mute: boolean; nick: null | string; pending: boolean; permissions: string; premiumSince: null | string; roles: string[]; user: { accentColor: number; avatar: null | string; avatarDecorationData: { asset: ...; skuId: ...; }; banner: string; bot: boolean; discriminator: string; email: null | string; flags: number; globalName: null | string; id: string; locale: string; mfaEnabled: boolean; premiumType: PremiumTypes; publicFlags: number; system: boolean; username: string; verified: boolean; }; }; name: string; type: InteractionTypes; user: { accentColor: number; avatar: null | string; avatarDecorationData: { asset: string; skuId: string; }; banner: string; bot: boolean; discriminator: string; email: null | string; flags: number; globalName: null | string; id: string; locale: string; mfaEnabled: boolean; premiumType: PremiumTypes; publicFlags: number; system: boolean; username: string; verified: boolean; }; }; interactionMetadata: { authorizingIntegrationOwners: { 0: string; 1: string; }; id: string; originalResponseMessageId: string; targetMessageId: string; targetUser: { accentColor: number; avatar: null | string; avatarDecorationData: { asset: string; skuId: string; }; banner: string; bot: boolean; discriminator: string; email: null | string; flags: number; globalName: null | string; id: string; locale: string; mfaEnabled: boolean; premiumType: PremiumTypes; publicFlags: number; system: boolean; username: string; verified: boolean; }; type: InteractionTypes; user: { accentColor: number; avatar: null | string; avatarDecorationData: { asset: string; skuId: string; }; banner: string; bot: boolean; discriminator: string; email: null | string; flags: number; globalName: null | string; id: string; locale: string; mfaEnabled: boolean; premiumType: PremiumTypes; publicFlags: number; system: boolean; username: string; verified: boolean; }; } | { authorizingIntegrationOwners: { 0: string; 1: string; }; id: string; interactedMessageId: string; originalResponseMessageId: string; type: InteractionTypes; user: { accentColor: number; avatar: null | string; avatarDecorationData: { asset: string; skuId: string; }; banner: string; bot: boolean; discriminator: string; email: null | string; flags: number; globalName: null | string; id: string; locale: string; mfaEnabled: boolean; premiumType: PremiumTypes; publicFlags: number; system: boolean; username: string; verified: boolean; }; } | { authorizingIntegrationOwners: { 0: string; 1: string; }; id: string; originalResponseMessageId: string; triggeringInteractionMetadata: { id: string; type: InteractionTypes; user: { username: string; globalName: string | null; locale?: string | undefined; flags?: number | undefined; premiumType?: PremiumTypes | undefined; ... 11 more ...; avatarDecorationData?: { ...; } | undefined; }; authorizingIntegrationOwners: { ...; }; originalResponseMessageI...; type: InteractionTypes; user: { accentColor: number; avatar: null | string; avatarDecorationData: { asset: string; skuId: string; }; banner: string; bot: boolean; discriminator: string; email: null | string; flags: number; globalName: null | string; id: string; locale: string; mfaEnabled: boolean; premiumType: PremiumTypes; publicFlags: number; system: boolean; username: string; verified: boolean; }; }; member: { avatar: string; avatarDecorationData: null | { asset: string; skuId: string; }; banner: string; communicationDisabledUntil: null | string; deaf: boolean; flags: number; joinedAt: string; mute: boolean; nick: null | string; pending: boolean; permissions: string; premiumSince: null | string; roles: string[]; user: { accentColor: number; avatar: null | string; avatarDecorationData: { asset: string; skuId: string; }; banner: string; bot: boolean; discriminator: string; email: null | string; flags: number; globalName: null | string; id: string; locale: string; mfaEnabled: boolean; premiumType: PremiumTypes; publicFlags: number; system: boolean; username: string; verified: boolean; }; }; mentionChannels: object[]; mentionEveryone: boolean; mentionRoles: string[]; mentions: object[]; messageReference: { channelId: string; failIfNotExists: boolean; guildId: string; messageId: string; type: DiscordMessageReferenceType; }; messageSnapshots: object[]; nonce: string | number; pinned: boolean; poll: { allowMultiselect: boolean; answers: object[]; expiry: null | string; layoutType: Default; question: { emoji: { animated: boolean; available: boolean; id: string; managed: boolean; name: string; requireColons: boolean; roles: string[]; user: { accentColor: ... | ...; avatar: ... | ...; avatarDecorationData: ... | ...; banner: ... | ...; bot: ... | ... | ...; discriminator: string; email: ... | ... | ...; flags: ... | ...; globalName: ... | ...; id: string; locale: ... | ...; mfaEnabled: ... | ... | ...; premiumType: ... | ...; publicFlags: ... | ...; system: ... | ... | ...; username: string; verified: ... | ... | ...; }; }; text: string; }; results: { answerCounts: object[]; isFinalized: boolean; }; }; position: number; reactions: object[]; referencedMessage: { id: string; channelId: string; guildId?: string | undefined; author: { username: string; globalName: string | null; locale?: string | undefined; flags?: number | undefined; premiumType?: PremiumTypes | undefined; ... 11 more ...; avatarDecorationData?: { ...; } | undefined; }; ... 31 more ...; call?: { ...; } | un...; stickerItems: object[]; stickers: object[]; thread: { applicationId: string; appliedTags: string[]; availableTags: object[]; bitrate: number; defaultAutoArchiveDuration: number; defaultForumLayout: ForumLayout; defaultReactionEmoji: null | { emojiId: string; emojiName: null | string; }; defaultSortOrder: null | SortOrderTypes; defaultThreadRateLimitPerUser: number; flags: ChannelFlags; guildId: string; icon: string; id: string; lastMessageId: null | string; lastPinTimestamp: null | string; managed: boolean; member: { flags: number; id: string; joinTimestamp: string; userId: string; }; memberCount: number; messageCount: number; name: string; newlyCreated: boolean; nsfw: boolean; ownerId: string; parentId: null | string; permissionOverwrites: object[]; permissions: string; position: number; rateLimitPerUser: number; recipients: object[]; rtcRegion: null | string; threadMetadata: { archived: boolean; archiveTimestamp: string; autoArchiveDuration: 60 | 1440 | 4320 | 10080; createTimestamp: null | string; invitable: boolean; locked: boolean; }; topic: null | string; totalMessageSent: number; type: ChannelTypes; userLimit: number; videoQualityMode: VideoQualityModes; }; timestamp: string; tts: boolean; type: MessageTypes; webhookId: string; }>

Defined in: packages/rest/dist/types/types.d.ts:1130

Edits the initial message response to an interaction.

Parameters

token

string

The interaction token to use, provided in the original interaction.

options

InteractionCallbackData

The parameters for the edit of the response.

Returns

An instance of the edited DiscordMessage.

Remarks

Unlike editMessage(), this endpoint allows the bot user to act without needing to see the channel the message is in.

Does not support ephemeral follow-up messages due to these being stateless.

Fires a Message Update event.

See

https://discord.com/developers/docs/interactions/receiving-and-responding#edit-original-interaction-response

editOriginalWebhookMessage()

editOriginalWebhookMessage: (webhookId, token, options) => Promise<{ activity: { partyId: string; type: MessageActivityTypes; }; application: { approximateGuildCount: number; approximateUserInstallCount: number; bot: { accentColor: number; avatar: null | string; avatarDecorationData: { asset: string; skuId: string; }; banner: string; bot: boolean; discriminator: string; email: null | string; flags: number; globalName: null | string; id: string; locale: string; mfaEnabled: boolean; premiumType: PremiumTypes; publicFlags: number; system: boolean; username: string; verified: boolean; }; botPublic: boolean; botRequireCodeGrant: boolean; coverImage: string; customInstallUrl: string; description: string; eventWebhooksStatus: DiscordApplicationEventWebhookStatus; eventWebhooksTypes: DiscordWebhookEventType[]; eventWebhooksUrl: null | string; flags: ApplicationFlags; guild: { afkChannelId: null | string; afkTimeout: number; applicationId: null | string; approximateMemberCount: number; approximatePresenceCount: number; banner: null | string; channels: object[]; defaultMessageNotifications: DefaultMessageNotificationLevels; description: null | string; discoverySplash: null | string; emojis: object[]; explicitContentFilter: ExplicitContentFilterLevels; features: GuildFeatures[]; icon: null | string; iconHash: null | string; id: string; joinedAt: string; large: boolean; maxMembers: number; maxPresences: null | number; maxStageVideoChannelUsers: number; maxVideoChannelUsers: number; memberCount: number; members: object[]; mfaLevel: MfaLevels; name: string; nsfwLevel: GuildNsfwLevel; owner: boolean; ownerId: string; permissions: string; preferredLocale: string; premiumProgressBarEnabled: boolean; premiumSubscriptionCount: number; premiumTier: PremiumTiers; presences: object[]; publicUpdatesChannelId: null | string; roles: object[]; rulesChannelId: null | string; safetyAlertsChannelId: null | string; soundboardSounds: object[]; splash: null | string; stageInstances: object[]; stickers: object[]; systemChannelFlags: SystemChannelFlags; systemChannelId: null | string; threads: object[]; unavailable: boolean; vanityUrlCode: null | string; verificationLevel: VerificationLevels; voiceStates: object[]; welcomeScreen: { description: null | string; welcomeChannels: object[]; }; widgetChannelId: null | string; widgetEnabled: boolean; }; guildId: string; icon: null | string; id: string; installParams: { permissions: string; scopes: OAuth2Scope[]; }; integrationTypesConfig: { 0: { oauth2InstallParams: { permissions: ...; scopes: ...; }; }; 1: { oauth2InstallParams: { permissions: ...; scopes: ...; }; }; }; interactionsEndpointUrl: null | string; name: string; owner: { accentColor: number; avatar: null | string; avatarDecorationData: { asset: string; skuId: string; }; banner: string; bot: boolean; discriminator: string; email: null | string; flags: number; globalName: null | string; id: string; locale: string; mfaEnabled: boolean; premiumType: PremiumTypes; publicFlags: number; system: boolean; username: string; verified: boolean; }; primarySkuId: string; privacyPolicyUrl: string; redirectUris: string[]; roleConnectionsVerificationUrl: null | string; rpcOrigins: string[]; slug: string; tags: string[]; team: null | { icon: null | string; id: string; members: object[]; name: string; ownerUserId: string; }; termsOfServiceUrl: string; verifyKey: string; }; applicationId: string; attachments: object[]; author: { accentColor: number; avatar: null | string; avatarDecorationData: { asset: string; skuId: string; }; banner: string; bot: boolean; discriminator: string; email: null | string; flags: number; globalName: null | string; id: string; locale: string; mfaEnabled: boolean; premiumType: PremiumTypes; publicFlags: number; system: boolean; username: string; verified: boolean; }; call: { endedTimestamp: string; participants: string[]; }; channelId: string; components: ({ components: ({ channelTypes: ... | ...; customId: string; defaultValues: ... | ...; disabled: ... | ... | ...; maxValues: ... | ...; minValues: ... | ...; options: ... | ...; placeholder: ... | ...; type: ... | ... | ... | ... | ...; } | { customId: ... | ...; disabled: ... | ... | ...; emoji: ... | ...; label: ... | ...; skuId: ... | ...; style: ButtonStyles; type: Button; url: ... | ...; } | { customId: string; label: string; maxLength: ... | ...; minLength: ... | ...; placeholder: ... | ...; required: ... | ... | ...; style: TextStyles; type: InputText; value: ... | ...; })[]; type: ActionRow; } | { channelTypes: ChannelTypes[]; customId: string; defaultValues: object[]; disabled: boolean; maxValues: number; minValues: number; options: object[]; placeholder: string; type: SelectMenu | SelectMenuUsers | SelectMenuRoles | SelectMenuUsersAndRoles | SelectMenuChannels; } | { customId: string; disabled: boolean; emoji: { animated: boolean; id: string; name: string; }; label: string; skuId: string; style: ButtonStyles; type: Button; url: string; } | { customId: string; label: string; maxLength: number; minLength: number; placeholder: string; required: boolean; style: TextStyles; type: InputText; value: string; })[]; content: string; editedTimestamp: null | string; embeds: object[]; flags: MessageFlags; guildId: string; id: string; interaction: { id: string; member: { avatar: string; avatarDecorationData: null | { asset: string; skuId: string; }; banner: string; communicationDisabledUntil: null | string; deaf: boolean; flags: number; joinedAt: string; mute: boolean; nick: null | string; pending: boolean; permissions: string; premiumSince: null | string; roles: string[]; user: { accentColor: number; avatar: null | string; avatarDecorationData: { asset: ...; skuId: ...; }; banner: string; bot: boolean; discriminator: string; email: null | string; flags: number; globalName: null | string; id: string; locale: string; mfaEnabled: boolean; premiumType: PremiumTypes; publicFlags: number; system: boolean; username: string; verified: boolean; }; }; name: string; type: InteractionTypes; user: { accentColor: number; avatar: null | string; avatarDecorationData: { asset: string; skuId: string; }; banner: string; bot: boolean; discriminator: string; email: null | string; flags: number; globalName: null | string; id: string; locale: string; mfaEnabled: boolean; premiumType: PremiumTypes; publicFlags: number; system: boolean; username: string; verified: boolean; }; }; interactionMetadata: { authorizingIntegrationOwners: { 0: string; 1: string; }; id: string; originalResponseMessageId: string; targetMessageId: string; targetUser: { accentColor: number; avatar: null | string; avatarDecorationData: { asset: string; skuId: string; }; banner: string; bot: boolean; discriminator: string; email: null | string; flags: number; globalName: null | string; id: string; locale: string; mfaEnabled: boolean; premiumType: PremiumTypes; publicFlags: number; system: boolean; username: string; verified: boolean; }; type: InteractionTypes; user: { accentColor: number; avatar: null | string; avatarDecorationData: { asset: string; skuId: string; }; banner: string; bot: boolean; discriminator: string; email: null | string; flags: number; globalName: null | string; id: string; locale: string; mfaEnabled: boolean; premiumType: PremiumTypes; publicFlags: number; system: boolean; username: string; verified: boolean; }; } | { authorizingIntegrationOwners: { 0: string; 1: string; }; id: string; interactedMessageId: string; originalResponseMessageId: string; type: InteractionTypes; user: { accentColor: number; avatar: null | string; avatarDecorationData: { asset: string; skuId: string; }; banner: string; bot: boolean; discriminator: string; email: null | string; flags: number; globalName: null | string; id: string; locale: string; mfaEnabled: boolean; premiumType: PremiumTypes; publicFlags: number; system: boolean; username: string; verified: boolean; }; } | { authorizingIntegrationOwners: { 0: string; 1: string; }; id: string; originalResponseMessageId: string; triggeringInteractionMetadata: { id: string; type: InteractionTypes; user: { username: string; globalName: string | null; locale?: string | undefined; flags?: number | undefined; premiumType?: PremiumTypes | undefined; ... 11 more ...; avatarDecorationData?: { ...; } | undefined; }; authorizingIntegrationOwners: { ...; }; originalResponseMessageI...; type: InteractionTypes; user: { accentColor: number; avatar: null | string; avatarDecorationData: { asset: string; skuId: string; }; banner: string; bot: boolean; discriminator: string; email: null | string; flags: number; globalName: null | string; id: string; locale: string; mfaEnabled: boolean; premiumType: PremiumTypes; publicFlags: number; system: boolean; username: string; verified: boolean; }; }; member: { avatar: string; avatarDecorationData: null | { asset: string; skuId: string; }; banner: string; communicationDisabledUntil: null | string; deaf: boolean; flags: number; joinedAt: string; mute: boolean; nick: null | string; pending: boolean; permissions: string; premiumSince: null | string; roles: string[]; user: { accentColor: number; avatar: null | string; avatarDecorationData: { asset: string; skuId: string; }; banner: string; bot: boolean; discriminator: string; email: null | string; flags: number; globalName: null | string; id: string; locale: string; mfaEnabled: boolean; premiumType: PremiumTypes; publicFlags: number; system: boolean; username: string; verified: boolean; }; }; mentionChannels: object[]; mentionEveryone: boolean; mentionRoles: string[]; mentions: object[]; messageReference: { channelId: string; failIfNotExists: boolean; guildId: string; messageId: string; type: DiscordMessageReferenceType; }; messageSnapshots: object[]; nonce: string | number; pinned: boolean; poll: { allowMultiselect: boolean; answers: object[]; expiry: null | string; layoutType: Default; question: { emoji: { animated: boolean; available: boolean; id: string; managed: boolean; name: string; requireColons: boolean; roles: string[]; user: { accentColor: ... | ...; avatar: ... | ...; avatarDecorationData: ... | ...; banner: ... | ...; bot: ... | ... | ...; discriminator: string; email: ... | ... | ...; flags: ... | ...; globalName: ... | ...; id: string; locale: ... | ...; mfaEnabled: ... | ... | ...; premiumType: ... | ...; publicFlags: ... | ...; system: ... | ... | ...; username: string; verified: ... | ... | ...; }; }; text: string; }; results: { answerCounts: object[]; isFinalized: boolean; }; }; position: number; reactions: object[]; referencedMessage: { id: string; channelId: string; guildId?: string | undefined; author: { username: string; globalName: string | null; locale?: string | undefined; flags?: number | undefined; premiumType?: PremiumTypes | undefined; ... 11 more ...; avatarDecorationData?: { ...; } | undefined; }; ... 31 more ...; call?: { ...; } | un...; stickerItems: object[]; stickers: object[]; thread: { applicationId: string; appliedTags: string[]; availableTags: object[]; bitrate: number; defaultAutoArchiveDuration: number; defaultForumLayout: ForumLayout; defaultReactionEmoji: null | { emojiId: string; emojiName: null | string; }; defaultSortOrder: null | SortOrderTypes; defaultThreadRateLimitPerUser: number; flags: ChannelFlags; guildId: string; icon: string; id: string; lastMessageId: null | string; lastPinTimestamp: null | string; managed: boolean; member: { flags: number; id: string; joinTimestamp: string; userId: string; }; memberCount: number; messageCount: number; name: string; newlyCreated: boolean; nsfw: boolean; ownerId: string; parentId: null | string; permissionOverwrites: object[]; permissions: string; position: number; rateLimitPerUser: number; recipients: object[]; rtcRegion: null | string; threadMetadata: { archived: boolean; archiveTimestamp: string; autoArchiveDuration: 60 | 1440 | 4320 | 10080; createTimestamp: null | string; invitable: boolean; locked: boolean; }; topic: null | string; totalMessageSent: number; type: ChannelTypes; userLimit: number; videoQualityMode: VideoQualityModes; }; timestamp: string; tts: boolean; type: MessageTypes; webhookId: string; }>

Defined in: packages/rest/dist/types/types.d.ts:1144

Edits the original webhook message.

Parameters

webhookId

https://discord.com/developers/docs/resources/webhook#edit-webhook-message

The ID of the webhook to edit the original message of.

token

string

The webhook token, used to edit the message.

options

InteractionCallbackData & object

The parameters for the edit of the message.

Returns

An instance of the edited DiscordMessage.

Remarks

Fires a Message Update gateway event.

See

editOwnVoiceState()

editOwnVoiceState: (guildId, options) => Promise<void>

Defined in: packages/rest/dist/types/types.d.ts:1164

Edits the voice state of the bot user.

Parameters

guildId

https://discord.com/developers/docs/resources/voice#modify-current-user-voice-state

The ID of the guild in which to edit the voice state of the bot user.

options

EditOwnVoiceState

The parameters for the edit of the voice state.

Returns

Promise<void>

Remarks

The channelId property of the options object parameter must point to a stage channel, and the bot user must already have joined it.

If attempting to unmute oneself:

Requires the MUTE_MEMBERS permission.

If attempting to request to speak:

Requires the REQUEST_TO_SPEAK permission.

See

editRole()

editRole: (guildId, roleId, options, reason?) => Promise<{ color: number; flags: RoleFlags; hoist: boolean; icon: string; id: string; managed: boolean; mentionable: boolean; name: string; permissions: string; position: number; tags: { availableForPurchase: null; botId: string; guildConnections: null; integrationId: string; premiumSubscriber: null; subscriptionListingId: string; }; unicodeEmoji: string; }>

Defined in: packages/rest/dist/types/types.d.ts:1181

Edits a role in a guild.

Parameters

guildId

The ID of the guild to edit the role in.

roleId

https://discord.com/developers/docs/resources/guild#modify-guild-role

The ID of the role to edit.

options

EditGuildRole

The parameters for the edit of the role.

reason?

string

An optional reason for the action, to be included in the audit log.

Returns

An instance of the edited DiscordRole.

Remarks

Requires the MANAGE_ROLES permission.

Fires a Guild Role Update gateway event.

See

editRolePositions()

editRolePositions: (guildId, options, reason?) => Promise<object[]>

Defined in: packages/rest/dist/types/types.d.ts:1197

Edits the positions of a set of roles.

Parameters

guildId

https://discord.com/developers/docs/resources/guild#modify-guild-role-positions

The ID of the guild to edit the role positions in.

options

ModifyRolePositions[]

The parameters for the edit of the role positions.

reason?

string

An optional reason for the action, to be included in the audit log.

Returns

Promise<object[]>

A collection of DiscordRole objects assorted by role ID.

Remarks

Requires the MANAGE_ROLES permission.

Fires a Guild Role Update gateway event for every role impacted in this change.

See

editScheduledEvent()

editScheduledEvent: (guildId, eventId, options, reason?) => Promise<{ channelId: null | string; creator: { accentColor: number; avatar: null | string; avatarDecorationData: { asset: string; skuId: string; }; banner: string; bot: boolean; discriminator: string; email: null | string; flags: number; globalName: null | string; id: string; locale: string; mfaEnabled: boolean; premiumType: PremiumTypes; publicFlags: number; system: boolean; username: string; verified: boolean; }; creatorId: null | string; description: string; entityId: null | string; entityMetadata: null | { location: string; }; entityType: ScheduledEventEntityType; guildId: string; id: string; image: null | string; name: string; privacyLevel: GuildOnly; recurrenceRule: null | { byMonth: null | DiscordScheduledEventRecurrenceRuleMonth[]; byMonthDay: null | number[]; byNWeekday: null | object[]; byWeekday: null | DiscordScheduledEventRecurrenceRuleWeekday[]; byYearDay: null | number[]; count: null | number; end: null | string; frequency: DiscordScheduledEventRecurrenceRuleFrequency; interval: number; start: string; }; scheduledEndTime: null | string; scheduledStartTime: string; status: ScheduledEventStatus; userCount: number; }>

Defined in: packages/rest/dist/types/types.d.ts:1217

Edits a scheduled event.

Parameters

guildId

The ID of the guild to edit the scheduled event in.

eventId

https://discord.com/developers/docs/resources/guild-scheduled-event#modify-guild-scheduled-event

The ID of the scheduled event to edit.

options

Partial<EditScheduledEvent>

reason?

string

An optional reason for the action, to be included in the audit log.

Returns

An instance of the edited DiscordScheduledEvent.

Remarks

Requires the MANAGE_EVENTS permission.

To start or end an event, modify the event's status property.

The entity_metadata property is discarded for events whose entity_type is not ScheduledEventEntityType.External.

Fires a Guild Scheduled Event Update gateway event.

See

editStageInstance()

editStageInstance: (channelId, topic, reason?) => Promise<{ channelId: string; guildId: string; guildScheduledEventId: string; id: string; topic: string; }>

Defined in: packages/rest/dist/types/types.d.ts:1233

Edits a stage instance.

Parameters

channelId

https://discord.com/developers/docs/resources/stage-instance#modify-stage-instance

The ID of the stage channel the stage instance is associated with.

topic

string

Topic of the Stage instance (1-120 characters).

reason?

string

An optional reason for the action, to be included in the audit log.

Returns

Promise<{ channelId: string; guildId: string; guildScheduledEventId: string; id: string; topic: string; }>

An instance of the updated DiscordStageInstance.

Remarks

Requires the user to be a moderator of the stage channel.

Fires a Stage Instance Update event.

See

editUserApplicationRoleConnection()

editUserApplicationRoleConnection: (bearerToken, applicationId, options) => Promise<{ metadata: {}; platformName: null | string; platformUsername: null | string; }>

Defined in: packages/rest/dist/types/types.d.ts:1261

Edit the current user application role connection for the application.

Parameters

bearerToken

string

The access token of the user

applicationId

https://discord.com/developers/docs/resources/user#update-user-application-role-connection

The id of the application to edit the role connection

options

The options to edit

metadata

{}

platformName

null | string

platformUsername

null | string

Returns

Promise<{ metadata: {}; platformName: null | string; platformUsername: null | string; }>

Remarks

This requires the role_connections.write scope.

See

editUserVoiceState()

editUserVoiceState: (guildId, options) => Promise<void>

Defined in: packages/rest/dist/types/types.d.ts:1247

Edits the voice state of another user.

Parameters

guildId

https://discord.com/developers/docs/resources/voice#modify-user-voice-state

The ID of the guild in which to edit the voice state of the bot user.

options

EditUserVoiceState

The parameters for the edit of the voice state.

Returns

Promise<void>

Remarks

The channelId property of the options object parameter must point to a stage channel, and the user must already have joined it.

Requires the MUTE_MEMBERS permission.

See

editWebhook()

editWebhook: (webhookId, options, reason?) => Promise<Camelize<DiscordWebhook>>

Defined in: packages/rest/dist/types/types.d.ts:1276

Edits a webhook.

Parameters

webhookId

https://discord.com/developers/docs/resources/webhook#edit-webhook

The ID of the webhook to edit.

options

ModifyWebhook

reason?

string

An optional reason for the action, to be included in the audit log.

Returns

Promise<Camelize<DiscordWebhook>>

An instance of the edited DiscordWebhook.

Remarks

Requires the MANAGE_WEBHOOKS permission.

Fires a Webhooks Update gateway event.

See

editWebhookMessage()

editWebhookMessage: (webhookId, token, messageId, options) => Promise<{ activity: { partyId: string; type: MessageActivityTypes; }; application: { approximateGuildCount: number; approximateUserInstallCount: number; bot: { accentColor: number; avatar: null | string; avatarDecorationData: { asset: string; skuId: string; }; banner: string; bot: boolean; discriminator: string; email: null | string; flags: number; globalName: null | string; id: string; locale: string; mfaEnabled: boolean; premiumType: PremiumTypes; publicFlags: number; system: boolean; username: string; verified: boolean; }; botPublic: boolean; botRequireCodeGrant: boolean; coverImage: string; customInstallUrl: string; description: string; eventWebhooksStatus: DiscordApplicationEventWebhookStatus; eventWebhooksTypes: DiscordWebhookEventType[]; eventWebhooksUrl: null | string; flags: ApplicationFlags; guild: { afkChannelId: null | string; afkTimeout: number; applicationId: null | string; approximateMemberCount: number; approximatePresenceCount: number; banner: null | string; channels: object[]; defaultMessageNotifications: DefaultMessageNotificationLevels; description: null | string; discoverySplash: null | string; emojis: object[]; explicitContentFilter: ExplicitContentFilterLevels; features: GuildFeatures[]; icon: null | string; iconHash: null | string; id: string; joinedAt: string; large: boolean; maxMembers: number; maxPresences: null | number; maxStageVideoChannelUsers: number; maxVideoChannelUsers: number; memberCount: number; members: object[]; mfaLevel: MfaLevels; name: string; nsfwLevel: GuildNsfwLevel; owner: boolean; ownerId: string; permissions: string; preferredLocale: string; premiumProgressBarEnabled: boolean; premiumSubscriptionCount: number; premiumTier: PremiumTiers; presences: object[]; publicUpdatesChannelId: null | string; roles: object[]; rulesChannelId: null | string; safetyAlertsChannelId: null | string; soundboardSounds: object[]; splash: null | string; stageInstances: object[]; stickers: object[]; systemChannelFlags: SystemChannelFlags; systemChannelId: null | string; threads: object[]; unavailable: boolean; vanityUrlCode: null | string; verificationLevel: VerificationLevels; voiceStates: object[]; welcomeScreen: { description: null | string; welcomeChannels: object[]; }; widgetChannelId: null | string; widgetEnabled: boolean; }; guildId: string; icon: null | string; id: string; installParams: { permissions: string; scopes: OAuth2Scope[]; }; integrationTypesConfig: { 0: { oauth2InstallParams: { permissions: ...; scopes: ...; }; }; 1: { oauth2InstallParams: { permissions: ...; scopes: ...; }; }; }; interactionsEndpointUrl: null | string; name: string; owner: { accentColor: number; avatar: null | string; avatarDecorationData: { asset: string; skuId: string; }; banner: string; bot: boolean; discriminator: string; email: null | string; flags: number; globalName: null | string; id: string; locale: string; mfaEnabled: boolean; premiumType: PremiumTypes; publicFlags: number; system: boolean; username: string; verified: boolean; }; primarySkuId: string; privacyPolicyUrl: string; redirectUris: string[]; roleConnectionsVerificationUrl: null | string; rpcOrigins: string[]; slug: string; tags: string[]; team: null | { icon: null | string; id: string; members: object[]; name: string; ownerUserId: string; }; termsOfServiceUrl: string; verifyKey: string; }; applicationId: string; attachments: object[]; author: { accentColor: number; avatar: null | string; avatarDecorationData: { asset: string; skuId: string; }; banner: string; bot: boolean; discriminator: string; email: null | string; flags: number; globalName: null | string; id: string; locale: string; mfaEnabled: boolean; premiumType: PremiumTypes; publicFlags: number; system: boolean; username: string; verified: boolean; }; call: { endedTimestamp: string; participants: string[]; }; channelId: string; components: ({ components: ({ channelTypes: ... | ...; customId: string; defaultValues: ... | ...; disabled: ... | ... | ...; maxValues: ... | ...; minValues: ... | ...; options: ... | ...; placeholder: ... | ...; type: ... | ... | ... | ... | ...; } | { customId: ... | ...; disabled: ... | ... | ...; emoji: ... | ...; label: ... | ...; skuId: ... | ...; style: ButtonStyles; type: Button; url: ... | ...; } | { customId: string; label: string; maxLength: ... | ...; minLength: ... | ...; placeholder: ... | ...; required: ... | ... | ...; style: TextStyles; type: InputText; value: ... | ...; })[]; type: ActionRow; } | { channelTypes: ChannelTypes[]; customId: string; defaultValues: object[]; disabled: boolean; maxValues: number; minValues: number; options: object[]; placeholder: string; type: SelectMenu | SelectMenuUsers | SelectMenuRoles | SelectMenuUsersAndRoles | SelectMenuChannels; } | { customId: string; disabled: boolean; emoji: { animated: boolean; id: string; name: string; }; label: string; skuId: string; style: ButtonStyles; type: Button; url: string; } | { customId: string; label: string; maxLength: number; minLength: number; placeholder: string; required: boolean; style: TextStyles; type: InputText; value: string; })[]; content: string; editedTimestamp: null | string; embeds: object[]; flags: MessageFlags; guildId: string; id: string; interaction: { id: string; member: { avatar: string; avatarDecorationData: null | { asset: string; skuId: string; }; banner: string; communicationDisabledUntil: null | string; deaf: boolean; flags: number; joinedAt: string; mute: boolean; nick: null | string; pending: boolean; permissions: string; premiumSince: null | string; roles: string[]; user: { accentColor: number; avatar: null | string; avatarDecorationData: { asset: ...; skuId: ...; }; banner: string; bot: boolean; discriminator: string; email: null | string; flags: number; globalName: null | string; id: string; locale: string; mfaEnabled: boolean; premiumType: PremiumTypes; publicFlags: number; system: boolean; username: string; verified: boolean; }; }; name: string; type: InteractionTypes; user: { accentColor: number; avatar: null | string; avatarDecorationData: { asset: string; skuId: string; }; banner: string; bot: boolean; discriminator: string; email: null | string; flags: number; globalName: null | string; id: string; locale: string; mfaEnabled: boolean; premiumType: PremiumTypes; publicFlags: number; system: boolean; username: string; verified: boolean; }; }; interactionMetadata: { authorizingIntegrationOwners: { 0: string; 1: string; }; id: string; originalResponseMessageId: string; targetMessageId: string; targetUser: { accentColor: number; avatar: null | string; avatarDecorationData: { asset: string; skuId: string; }; banner: string; bot: boolean; discriminator: string; email: null | string; flags: number; globalName: null | string; id: string; locale: string; mfaEnabled: boolean; premiumType: PremiumTypes; publicFlags: number; system: boolean; username: string; verified: boolean; }; type: InteractionTypes; user: { accentColor: number; avatar: null | string; avatarDecorationData: { asset: string; skuId: string; }; banner: string; bot: boolean; discriminator: string; email: null | string; flags: number; globalName: null | string; id: string; locale: string; mfaEnabled: boolean; premiumType: PremiumTypes; publicFlags: number; system: boolean; username: string; verified: boolean; }; } | { authorizingIntegrationOwners: { 0: string; 1: string; }; id: string; interactedMessageId: string; originalResponseMessageId: string; type: InteractionTypes; user: { accentColor: number; avatar: null | string; avatarDecorationData: { asset: string; skuId: string; }; banner: string; bot: boolean; discriminator: string; email: null | string; flags: number; globalName: null | string; id: string; locale: string; mfaEnabled: boolean; premiumType: PremiumTypes; publicFlags: number; system: boolean; username: string; verified: boolean; }; } | { authorizingIntegrationOwners: { 0: string; 1: string; }; id: string; originalResponseMessageId: string; triggeringInteractionMetadata: { id: string; type: InteractionTypes; user: { username: string; globalName: string | null; locale?: string | undefined; flags?: number | undefined; premiumType?: PremiumTypes | undefined; ... 11 more ...; avatarDecorationData?: { ...; } | undefined; }; authorizingIntegrationOwners: { ...; }; originalResponseMessageI...; type: InteractionTypes; user: { accentColor: number; avatar: null | string; avatarDecorationData: { asset: string; skuId: string; }; banner: string; bot: boolean; discriminator: string; email: null | string; flags: number; globalName: null | string; id: string; locale: string; mfaEnabled: boolean; premiumType: PremiumTypes; publicFlags: number; system: boolean; username: string; verified: boolean; }; }; member: { avatar: string; avatarDecorationData: null | { asset: string; skuId: string; }; banner: string; communicationDisabledUntil: null | string; deaf: boolean; flags: number; joinedAt: string; mute: boolean; nick: null | string; pending: boolean; permissions: string; premiumSince: null | string; roles: string[]; user: { accentColor: number; avatar: null | string; avatarDecorationData: { asset: string; skuId: string; }; banner: string; bot: boolean; discriminator: string; email: null | string; flags: number; globalName: null | string; id: string; locale: string; mfaEnabled: boolean; premiumType: PremiumTypes; publicFlags: number; system: boolean; username: string; verified: boolean; }; }; mentionChannels: object[]; mentionEveryone: boolean; mentionRoles: string[]; mentions: object[]; messageReference: { channelId: string; failIfNotExists: boolean; guildId: string; messageId: string; type: DiscordMessageReferenceType; }; messageSnapshots: object[]; nonce: string | number; pinned: boolean; poll: { allowMultiselect: boolean; answers: object[]; expiry: null | string; layoutType: Default; question: { emoji: { animated: boolean; available: boolean; id: string; managed: boolean; name: string; requireColons: boolean; roles: string[]; user: { accentColor: ... | ...; avatar: ... | ...; avatarDecorationData: ... | ...; banner: ... | ...; bot: ... | ... | ...; discriminator: string; email: ... | ... | ...; flags: ... | ...; globalName: ... | ...; id: string; locale: ... | ...; mfaEnabled: ... | ... | ...; premiumType: ... | ...; publicFlags: ... | ...; system: ... | ... | ...; username: string; verified: ... | ... | ...; }; }; text: string; }; results: { answerCounts: object[]; isFinalized: boolean; }; }; position: number; reactions: object[]; referencedMessage: { id: string; channelId: string; guildId?: string | undefined; author: { username: string; globalName: string | null; locale?: string | undefined; flags?: number | undefined; premiumType?: PremiumTypes | undefined; ... 11 more ...; avatarDecorationData?: { ...; } | undefined; }; ... 31 more ...; call?: { ...; } | un...; stickerItems: object[]; stickers: object[]; thread: { applicationId: string; appliedTags: string[]; availableTags: object[]; bitrate: number; defaultAutoArchiveDuration: number; defaultForumLayout: ForumLayout; defaultReactionEmoji: null | { emojiId: string; emojiName: null | string; }; defaultSortOrder: null | SortOrderTypes; defaultThreadRateLimitPerUser: number; flags: ChannelFlags; guildId: string; icon: string; id: string; lastMessageId: null | string; lastPinTimestamp: null | string; managed: boolean; member: { flags: number; id: string; joinTimestamp: string; userId: string; }; memberCount: number; messageCount: number; name: string; newlyCreated: boolean; nsfw: boolean; ownerId: string; parentId: null | string; permissionOverwrites: object[]; permissions: string; position: number; rateLimitPerUser: number; recipients: object[]; rtcRegion: null | string; threadMetadata: { archived: boolean; archiveTimestamp: string; autoArchiveDuration: 60 | 1440 | 4320 | 10080; createTimestamp: null | string; invitable: boolean; locked: boolean; }; topic: null | string; totalMessageSent: number; type: ChannelTypes; userLimit: number; videoQualityMode: VideoQualityModes; }; timestamp: string; tts: boolean; type: MessageTypes; webhookId: string; }>

Defined in: packages/rest/dist/types/types.d.ts:1291

Edits a webhook message.

Parameters

webhookId

The ID of the webhook to edit the message of.

token

string

The webhook token, used to edit the message.

messageId

https://discord.com/developers/docs/resources/webhook#edit-webhook-message

The ID of the message to edit.

options

InteractionCallbackData & object

The parameters for the edit of the message.

Returns

An instance of the edited DiscordMessage.

Remarks

Fires a Message Update gateway event.

See

editWebhookWithToken()

editWebhookWithToken: (webhookId, token, options) => Promise<Camelize<DiscordWebhook>>

Defined in: packages/rest/dist/types/types.d.ts:1308

Edits a webhook using the webhook token, thereby bypassing the need for authentication + permissions.

Parameters

webhookId

https://discord.com/developers/docs/resources/webhook#modify-webhook-with-token

The ID of the webhook to edit.

token

string

The webhook token, used to edit the webhook.

options

Omit<ModifyWebhook, "channelId">

Returns

Promise<Camelize<DiscordWebhook>>

An instance of the edited DiscordWebhook.

Remarks

Requires the MANAGE_WEBHOOKS permission.

Fires a Webhooks Update gateway event.

See

editWelcomeScreen()

editWelcomeScreen: (guildId, options, reason?) => Promise<{ description: null | string; welcomeChannels: object[]; }>

Defined in: packages/rest/dist/types/types.d.ts:1324

Edits a guild's welcome screen.

Parameters

guildId

https://discord.com/developers/docs/resources/guild#modify-guild-welcome-screen

The ID of the guild to edit the welcome screen of.

options

The parameters for the edit of the welcome screen.

description

null | string

enabled

null | boolean

welcomeScreen

null | object[]

reason?

string

An optional reason for the action, to be included in the audit log.

Returns

Promise<{ description: null | string; welcomeChannels: object[]; }>

An instance of the edited DiscordWelcomeScreen.

Remarks

Requires the MANAGE_GUILD permission.

Fires a Guild Update gateway event.

See

editWidgetSettings()

editWidgetSettings: (guildId, options, reason?) => Promise<{ channelId: null | string; enabled: boolean; }>

Defined in: packages/rest/dist/types/types.d.ts:1339

Edits the settings of a guild's widget.

Parameters

guildId

https://discord.com/developers/docs/resources/guild#modify-guild-widget

The ID of the guild to edit the settings of the widget of.

options

channelId

null | string

enabled

boolean

reason?

string

An optional reason for the action, to be included in the audit log.

Returns

Promise<{ channelId: null | string; enabled: boolean; }>

An instance of the edited DiscordGuildWidgetSettings.

Remarks

Requires the MANAGE_GUILD permission.

Fires a Guild Update gateway event.

See

endPoll()

endPoll: (channelId, messageId) => Promise<{ activity: { partyId: string; type: MessageActivityTypes; }; application: { approximateGuildCount: number; approximateUserInstallCount: number; bot: { accentColor: number; avatar: null | string; avatarDecorationData: { asset: string; skuId: string; }; banner: string; bot: boolean; discriminator: string; email: null | string; flags: number; globalName: null | string; id: string; locale: string; mfaEnabled: boolean; premiumType: PremiumTypes; publicFlags: number; system: boolean; username: string; verified: boolean; }; botPublic: boolean; botRequireCodeGrant: boolean; coverImage: string; customInstallUrl: string; description: string; eventWebhooksStatus: DiscordApplicationEventWebhookStatus; eventWebhooksTypes: DiscordWebhookEventType[]; eventWebhooksUrl: null | string; flags: ApplicationFlags; guild: { afkChannelId: null | string; afkTimeout: number; applicationId: null | string; approximateMemberCount: number; approximatePresenceCount: number; banner: null | string; channels: object[]; defaultMessageNotifications: DefaultMessageNotificationLevels; description: null | string; discoverySplash: null | string; emojis: object[]; explicitContentFilter: ExplicitContentFilterLevels; features: GuildFeatures[]; icon: null | string; iconHash: null | string; id: string; joinedAt: string; large: boolean; maxMembers: number; maxPresences: null | number; maxStageVideoChannelUsers: number; maxVideoChannelUsers: number; memberCount: number; members: object[]; mfaLevel: MfaLevels; name: string; nsfwLevel: GuildNsfwLevel; owner: boolean; ownerId: string; permissions: string; preferredLocale: string; premiumProgressBarEnabled: boolean; premiumSubscriptionCount: number; premiumTier: PremiumTiers; presences: object[]; publicUpdatesChannelId: null | string; roles: object[]; rulesChannelId: null | string; safetyAlertsChannelId: null | string; soundboardSounds: object[]; splash: null | string; stageInstances: object[]; stickers: object[]; systemChannelFlags: SystemChannelFlags; systemChannelId: null | string; threads: object[]; unavailable: boolean; vanityUrlCode: null | string; verificationLevel: VerificationLevels; voiceStates: object[]; welcomeScreen: { description: null | string; welcomeChannels: object[]; }; widgetChannelId: null | string; widgetEnabled: boolean; }; guildId: string; icon: null | string; id: string; installParams: { permissions: string; scopes: OAuth2Scope[]; }; integrationTypesConfig: { 0: { oauth2InstallParams: { permissions: ...; scopes: ...; }; }; 1: { oauth2InstallParams: { permissions: ...; scopes: ...; }; }; }; interactionsEndpointUrl: null | string; name: string; owner: { accentColor: number; avatar: null | string; avatarDecorationData: { asset: string; skuId: string; }; banner: string; bot: boolean; discriminator: string; email: null | string; flags: number; globalName: null | string; id: string; locale: string; mfaEnabled: boolean; premiumType: PremiumTypes; publicFlags: number; system: boolean; username: string; verified: boolean; }; primarySkuId: string; privacyPolicyUrl: string; redirectUris: string[]; roleConnectionsVerificationUrl: null | string; rpcOrigins: string[]; slug: string; tags: string[]; team: null | { icon: null | string; id: string; members: object[]; name: string; ownerUserId: string; }; termsOfServiceUrl: string; verifyKey: string; }; applicationId: string; attachments: object[]; author: { accentColor: number; avatar: null | string; avatarDecorationData: { asset: string; skuId: string; }; banner: string; bot: boolean; discriminator: string; email: null | string; flags: number; globalName: null | string; id: string; locale: string; mfaEnabled: boolean; premiumType: PremiumTypes; publicFlags: number; system: boolean; username: string; verified: boolean; }; call: { endedTimestamp: string; participants: string[]; }; channelId: string; components: ({ components: ({ channelTypes: ... | ...; customId: string; defaultValues: ... | ...; disabled: ... | ... | ...; maxValues: ... | ...; minValues: ... | ...; options: ... | ...; placeholder: ... | ...; type: ... | ... | ... | ... | ...; } | { customId: ... | ...; disabled: ... | ... | ...; emoji: ... | ...; label: ... | ...; skuId: ... | ...; style: ButtonStyles; type: Button; url: ... | ...; } | { customId: string; label: string; maxLength: ... | ...; minLength: ... | ...; placeholder: ... | ...; required: ... | ... | ...; style: TextStyles; type: InputText; value: ... | ...; })[]; type: ActionRow; } | { channelTypes: ChannelTypes[]; customId: string; defaultValues: object[]; disabled: boolean; maxValues: number; minValues: number; options: object[]; placeholder: string; type: SelectMenu | SelectMenuUsers | SelectMenuRoles | SelectMenuUsersAndRoles | SelectMenuChannels; } | { customId: string; disabled: boolean; emoji: { animated: boolean; id: string; name: string; }; label: string; skuId: string; style: ButtonStyles; type: Button; url: string; } | { customId: string; label: string; maxLength: number; minLength: number; placeholder: string; required: boolean; style: TextStyles; type: InputText; value: string; })[]; content: string; editedTimestamp: null | string; embeds: object[]; flags: MessageFlags; guildId: string; id: string; interaction: { id: string; member: { avatar: string; avatarDecorationData: null | { asset: string; skuId: string; }; banner: string; communicationDisabledUntil: null | string; deaf: boolean; flags: number; joinedAt: string; mute: boolean; nick: null | string; pending: boolean; permissions: string; premiumSince: null | string; roles: string[]; user: { accentColor: number; avatar: null | string; avatarDecorationData: { asset: ...; skuId: ...; }; banner: string; bot: boolean; discriminator: string; email: null | string; flags: number; globalName: null | string; id: string; locale: string; mfaEnabled: boolean; premiumType: PremiumTypes; publicFlags: number; system: boolean; username: string; verified: boolean; }; }; name: string; type: InteractionTypes; user: { accentColor: number; avatar: null | string; avatarDecorationData: { asset: string; skuId: string; }; banner: string; bot: boolean; discriminator: string; email: null | string; flags: number; globalName: null | string; id: string; locale: string; mfaEnabled: boolean; premiumType: PremiumTypes; publicFlags: number; system: boolean; username: string; verified: boolean; }; }; interactionMetadata: { authorizingIntegrationOwners: { 0: string; 1: string; }; id: string; originalResponseMessageId: string; targetMessageId: string; targetUser: { accentColor: number; avatar: null | string; avatarDecorationData: { asset: string; skuId: string; }; banner: string; bot: boolean; discriminator: string; email: null | string; flags: number; globalName: null | string; id: string; locale: string; mfaEnabled: boolean; premiumType: PremiumTypes; publicFlags: number; system: boolean; username: string; verified: boolean; }; type: InteractionTypes; user: { accentColor: number; avatar: null | string; avatarDecorationData: { asset: string; skuId: string; }; banner: string; bot: boolean; discriminator: string; email: null | string; flags: number; globalName: null | string; id: string; locale: string; mfaEnabled: boolean; premiumType: PremiumTypes; publicFlags: number; system: boolean; username: string; verified: boolean; }; } | { authorizingIntegrationOwners: { 0: string; 1: string; }; id: string; interactedMessageId: string; originalResponseMessageId: string; type: InteractionTypes; user: { accentColor: number; avatar: null | string; avatarDecorationData: { asset: string; skuId: string; }; banner: string; bot: boolean; discriminator: string; email: null | string; flags: number; globalName: null | string; id: string; locale: string; mfaEnabled: boolean; premiumType: PremiumTypes; publicFlags: number; system: boolean; username: string; verified: boolean; }; } | { authorizingIntegrationOwners: { 0: string; 1: string; }; id: string; originalResponseMessageId: string; triggeringInteractionMetadata: { id: string; type: InteractionTypes; user: { username: string; globalName: string | null; locale?: string | undefined; flags?: number | undefined; premiumType?: PremiumTypes | undefined; ... 11 more ...; avatarDecorationData?: { ...; } | undefined; }; authorizingIntegrationOwners: { ...; }; originalResponseMessageI...; type: InteractionTypes; user: { accentColor: number; avatar: null | string; avatarDecorationData: { asset: string; skuId: string; }; banner: string; bot: boolean; discriminator: string; email: null | string; flags: number; globalName: null | string; id: string; locale: string; mfaEnabled: boolean; premiumType: PremiumTypes; publicFlags: number; system: boolean; username: string; verified: boolean; }; }; member: { avatar: string; avatarDecorationData: null | { asset: string; skuId: string; }; banner: string; communicationDisabledUntil: null | string; deaf: boolean; flags: number; joinedAt: string; mute: boolean; nick: null | string; pending: boolean; permissions: string; premiumSince: null | string; roles: string[]; user: { accentColor: number; avatar: null | string; avatarDecorationData: { asset: string; skuId: string; }; banner: string; bot: boolean; discriminator: string; email: null | string; flags: number; globalName: null | string; id: string; locale: string; mfaEnabled: boolean; premiumType: PremiumTypes; publicFlags: number; system: boolean; username: string; verified: boolean; }; }; mentionChannels: object[]; mentionEveryone: boolean; mentionRoles: string[]; mentions: object[]; messageReference: { channelId: string; failIfNotExists: boolean; guildId: string; messageId: string; type: DiscordMessageReferenceType; }; messageSnapshots: object[]; nonce: string | number; pinned: boolean; poll: { allowMultiselect: boolean; answers: object[]; expiry: null | string; layoutType: Default; question: { emoji: { animated: boolean; available: boolean; id: string; managed: boolean; name: string; requireColons: boolean; roles: string[]; user: { accentColor: ... | ...; avatar: ... | ...; avatarDecorationData: ... | ...; banner: ... | ...; bot: ... | ... | ...; discriminator: string; email: ... | ... | ...; flags: ... | ...; globalName: ... | ...; id: string; locale: ... | ...; mfaEnabled: ... | ... | ...; premiumType: ... | ...; publicFlags: ... | ...; system: ... | ... | ...; username: string; verified: ... | ... | ...; }; }; text: string; }; results: { answerCounts: object[]; isFinalized: boolean; }; }; position: number; reactions: object[]; referencedMessage: { id: string; channelId: string; guildId?: string | undefined; author: { username: string; globalName: string | null; locale?: string | undefined; flags?: number | undefined; premiumType?: PremiumTypes | undefined; ... 11 more ...; avatarDecorationData?: { ...; } | undefined; }; ... 31 more ...; call?: { ...; } | un...; stickerItems: object[]; stickers: object[]; thread: { applicationId: string; appliedTags: string[]; availableTags: object[]; bitrate: number; defaultAutoArchiveDuration: number; defaultForumLayout: ForumLayout; defaultReactionEmoji: null | { emojiId: string; emojiName: null | string; }; defaultSortOrder: null | SortOrderTypes; defaultThreadRateLimitPerUser: number; flags: ChannelFlags; guildId: string; icon: string; id: string; lastMessageId: null | string; lastPinTimestamp: null | string; managed: boolean; member: { flags: number; id: string; joinTimestamp: string; userId: string; }; memberCount: number; messageCount: number; name: string; newlyCreated: boolean; nsfw: boolean; ownerId: string; parentId: null | string; permissionOverwrites: object[]; permissions: string; position: number; rateLimitPerUser: number; recipients: object[]; rtcRegion: null | string; threadMetadata: { archived: boolean; archiveTimestamp: string; autoArchiveDuration: 60 | 1440 | 4320 | 10080; createTimestamp: null | string; invitable: boolean; locked: boolean; }; topic: null | string; totalMessageSent: number; type: ChannelTypes; userLimit: number; videoQualityMode: VideoQualityModes; }; timestamp: string; tts: boolean; type: MessageTypes; webhookId: string; }>

Defined in: packages/rest/dist/types/types.d.ts:2478

Immediately ends the poll.

Parameters

channelId

The ID of the channel in which the message with the poll lives

messageId

The ID of the message in which the poll lives

Returns

The message with the expired poll

Remarks

You cannot end polls from other users.

Fires a Message Update gateway event

exchangeToken()

exchangeToken: (clientId, clientSecret, options) => Promise<{ accessToken: string; expiresIn: number; guild: { afkChannelId: null | string; afkTimeout: number; applicationId: null | string; approximateMemberCount: number; approximatePresenceCount: number; banner: null | string; channels: object[]; defaultMessageNotifications: DefaultMessageNotificationLevels; description: null | string; discoverySplash: null | string; emojis: object[]; explicitContentFilter: ExplicitContentFilterLevels; features: GuildFeatures[]; icon: null | string; iconHash: null | string; id: string; joinedAt: string; large: boolean; maxMembers: number; maxPresences: null | number; maxStageVideoChannelUsers: number; maxVideoChannelUsers: number; memberCount: number; members: object[]; mfaLevel: MfaLevels; name: string; nsfwLevel: GuildNsfwLevel; owner: boolean; ownerId: string; permissions: string; preferredLocale: string; premiumProgressBarEnabled: boolean; premiumSubscriptionCount: number; premiumTier: PremiumTiers; presences: object[]; publicUpdatesChannelId: null | string; roles: object[]; rulesChannelId: null | string; safetyAlertsChannelId: null | string; soundboardSounds: object[]; splash: null | string; stageInstances: object[]; stickers: object[]; systemChannelFlags: SystemChannelFlags; systemChannelId: null | string; threads: object[]; unavailable: boolean; vanityUrlCode: null | string; verificationLevel: VerificationLevels; voiceStates: object[]; welcomeScreen: { description: null | string; welcomeChannels: object[]; }; widgetChannelId: null | string; widgetEnabled: boolean; }; refreshToken: string; scope: string; tokenType: string; webhook: { applicationId: null | string; avatar: null | string; channelId: string; guildId: string; id: string; name: null | string; sourceChannel: { applicationId: string; appliedTags: string[]; availableTags: object[]; bitrate: number; defaultAutoArchiveDuration: number; defaultForumLayout: ForumLayout; defaultReactionEmoji: null | { emojiId: string; emojiName: null | string; }; defaultSortOrder: null | SortOrderTypes; defaultThreadRateLimitPerUser: number; flags: ChannelFlags; guildId: string; icon: string; id: string; lastMessageId: null | string; lastPinTimestamp: null | string; managed: boolean; member: { flags: number; id: string; joinTimestamp: string; userId: string; }; memberCount: number; messageCount: number; name: string; newlyCreated: boolean; nsfw: boolean; ownerId: string; parentId: null | string; permissionOverwrites: object[]; permissions: string; position: number; rateLimitPerUser: number; recipients: object[]; rtcRegion: null | string; threadMetadata: { archived: boolean; archiveTimestamp: string; autoArchiveDuration: 60 | 1440 | 4320 | 10080; createTimestamp: null | string; invitable: boolean; locked: boolean; }; topic: null | string; totalMessageSent: number; type: ChannelTypes; userLimit: number; videoQualityMode: VideoQualityModes; }; sourceGuild: { afkChannelId: null | string; afkTimeout: number; applicationId: null | string; approximateMemberCount: number; approximatePresenceCount: number; banner: null | string; channels: object[]; defaultMessageNotifications: DefaultMessageNotificationLevels; description: null | string; discoverySplash: null | string; emojis: object[]; explicitContentFilter: ExplicitContentFilterLevels; features: GuildFeatures[]; icon: null | string; iconHash: null | string; id: string; joinedAt: string; large: boolean; maxMembers: number; maxPresences: null | number; maxStageVideoChannelUsers: number; maxVideoChannelUsers: number; memberCount: number; members: object[]; mfaLevel: MfaLevels; name: string; nsfwLevel: GuildNsfwLevel; owner: boolean; ownerId: string; permissions: string; preferredLocale: string; premiumProgressBarEnabled: boolean; premiumSubscriptionCount: number; premiumTier: PremiumTiers; presences: object[]; publicUpdatesChannelId: null | string; roles: object[]; rulesChannelId: null | string; safetyAlertsChannelId: null | string; soundboardSounds: object[]; splash: null | string; stageInstances: object[]; stickers: object[]; systemChannelFlags: SystemChannelFlags; systemChannelId: null | string; threads: object[]; unavailable: boolean; vanityUrlCode: null | string; verificationLevel: VerificationLevels; voiceStates: object[]; welcomeScreen: { description: null | string; welcomeChannels: object[]; }; widgetChannelId: null | string; widgetEnabled: boolean; }; token: string; type: WebhookTypes; url: string; user: { accentColor: number; avatar: null | string; avatarDecorationData: { asset: string; skuId: string; }; banner: string; bot: boolean; discriminator: string; email: null | string; flags: number; globalName: null | string; id: string; locale: string; mfaEnabled: boolean; premiumType: PremiumTypes; publicFlags: number; system: boolean; username: string; verified: boolean; }; }; }>

Defined in: packages/rest/dist/types/types.d.ts:1411

Exchange the information to get a OAuth2 accessToken token

Parameters

clientId

Camelize<DiscordTokenExchange>

Application's client id

clientSecret

string

application's client secret

options

The options to make the exchange with discord

Returns

Promise<{ accessToken: string; expiresIn: number; guild: { afkChannelId: null | string; afkTimeout: number; applicationId: null | string; approximateMemberCount: number; approximatePresenceCount: number; banner: null | string; channels: object[]; defaultMessageNotifications: DefaultMessageNotificationLevels; description: null | string; discoverySplash: null | string; emojis: object[]; explicitContentFilter: ExplicitContentFilterLevels; features: GuildFeatures[]; icon: null | string; iconHash: null | string; id: string; joinedAt: string; large: boolean; maxMembers: number; maxPresences: null | number; maxStageVideoChannelUsers: number; maxVideoChannelUsers: number; memberCount: number; members: object[]; mfaLevel: MfaLevels; name: string; nsfwLevel: GuildNsfwLevel; owner: boolean; ownerId: string; permissions: string; preferredLocale: string; premiumProgressBarEnabled: boolean; premiumSubscriptionCount: number; premiumTier: PremiumTiers; presences: object[]; publicUpdatesChannelId: null | string; roles: object[]; rulesChannelId: null | string; safetyAlertsChannelId: null | string; soundboardSounds: object[]; splash: null | string; stageInstances: object[]; stickers: object[]; systemChannelFlags: SystemChannelFlags; systemChannelId: null | string; threads: object[]; unavailable: boolean; vanityUrlCode: null | string; verificationLevel: VerificationLevels; voiceStates: object[]; welcomeScreen: { description: null | string; welcomeChannels: object[]; }; widgetChannelId: null | string; widgetEnabled: boolean; }; refreshToken: string; scope: string; tokenType: string; webhook: { applicationId: null | string; avatar: null | string; channelId: string; guildId: string; id: string; name: null | string; sourceChannel: { applicationId: string; appliedTags: string[]; availableTags: object[]; bitrate: number; defaultAutoArchiveDuration: number; defaultForumLayout: ForumLayout; defaultReactionEmoji: null | { emojiId: string; emojiName: null | string; }; defaultSortOrder: null | SortOrderTypes; defaultThreadRateLimitPerUser: number; flags: ChannelFlags; guildId: string; icon: string; id: string; lastMessageId: null | string; lastPinTimestamp: null | string; managed: boolean; member: { flags: number; id: string; joinTimestamp: string; userId: string; }; memberCount: number; messageCount: number; name: string; newlyCreated: boolean; nsfw: boolean; ownerId: string; parentId: null | string; permissionOverwrites: object[]; permissions: string; position: number; rateLimitPerUser: number; recipients: object[]; rtcRegion: null | string; threadMetadata: { archived: boolean; archiveTimestamp: string; autoArchiveDuration: 60 | 1440 | 4320 | 10080; createTimestamp: null | string; invitable: boolean; locked: boolean; }; topic: null | string; totalMessageSent: number; type: ChannelTypes; userLimit: number; videoQualityMode: VideoQualityModes; }; sourceGuild: { afkChannelId: null | string; afkTimeout: number; applicationId: null | string; approximateMemberCount: number; approximatePresenceCount: number; banner: null | string; channels: object[]; defaultMessageNotifications: DefaultMessageNotificationLevels; description: null | string; discoverySplash: null | string; emojis: object[]; explicitContentFilter: ExplicitContentFilterLevels; features: GuildFeatures[]; icon: null | string; iconHash: null | string; id: string; joinedAt: string; large: boolean; maxMembers: number; maxPresences: null | number; maxStageVideoChannelUsers: number; maxVideoChannelUsers: number; memberCount: number; members: object[]; mfaLevel: MfaLevels; name: string; nsfwLevel: GuildNsfwLevel; owner: boolean; ownerId: string; permissions: string; preferredLocale: string; premiumProgressBarEnabled: boolean; premiumSubscriptionCount: number; premiumTier: PremiumTiers; presences: object[]; publicUpdatesChannelId: null | string; roles: object[]; rulesChannelId: null | string; safetyAlertsChannelId: null | string; soundboardSounds: object[]; splash: null | string; stageInstances: object[]; stickers: object[]; systemChannelFlags: SystemChannelFlags; systemChannelId: null | string; threads: object[]; unavailable: boolean; vanityUrlCode: null | string; verificationLevel: VerificationLevels; voiceStates: object[]; welcomeScreen: { description: null | string; welcomeChannels: object[]; }; widgetChannelId: null | string; widgetEnabled: boolean; }; token: string; type: WebhookTypes; url: string; user: { accentColor: number; avatar: null | string; avatarDecorationData: { asset: string; skuId: string; }; banner: string; bot: boolean; discriminator: string; email: null | string; flags: number; globalName: null | string; id: string; locale: string; mfaEnabled: boolean; premiumType: PremiumTypes; publicFlags: number; system: boolean; username: string; verified: boolean; }; }; }>

executeWebhook()

executeWebhook: (webhookId, token, options) => Promise<undefined | { activity: { partyId: string; type: MessageActivityTypes; }; application: { approximateGuildCount: number; approximateUserInstallCount: number; bot: { accentColor: number; avatar: null | string; avatarDecorationData: { asset: string; skuId: string; }; banner: string; bot: boolean; discriminator: string; email: null | string; flags: number; globalName: null | string; id: string; locale: string; mfaEnabled: boolean; premiumType: PremiumTypes; publicFlags: number; system: boolean; username: string; verified: boolean; }; botPublic: boolean; botRequireCodeGrant: boolean; coverImage: string; customInstallUrl: string; description: string; eventWebhooksStatus: DiscordApplicationEventWebhookStatus; eventWebhooksTypes: DiscordWebhookEventType[]; eventWebhooksUrl: null | string; flags: ApplicationFlags; guild: { afkChannelId: null | string; afkTimeout: number; applicationId: null | string; approximateMemberCount: number; approximatePresenceCount: number; banner: null | string; channels: object[]; defaultMessageNotifications: DefaultMessageNotificationLevels; description: null | string; discoverySplash: null | string; emojis: object[]; explicitContentFilter: ExplicitContentFilterLevels; features: GuildFeatures[]; icon: null | string; iconHash: null | string; id: string; joinedAt: string; large: boolean; maxMembers: number; maxPresences: null | number; maxStageVideoChannelUsers: number; maxVideoChannelUsers: number; memberCount: number; members: object[]; mfaLevel: MfaLevels; name: string; nsfwLevel: GuildNsfwLevel; owner: boolean; ownerId: string; permissions: string; preferredLocale: string; premiumProgressBarEnabled: boolean; premiumSubscriptionCount: number; premiumTier: PremiumTiers; presences: object[]; publicUpdatesChannelId: null | string; roles: object[]; rulesChannelId: null | string; safetyAlertsChannelId: null | string; soundboardSounds: object[]; splash: null | string; stageInstances: object[]; stickers: object[]; systemChannelFlags: SystemChannelFlags; systemChannelId: null | string; threads: object[]; unavailable: boolean; vanityUrlCode: null | string; verificationLevel: VerificationLevels; voiceStates: object[]; welcomeScreen: { description: ... | ...; welcomeChannels: ...[]; }; widgetChannelId: null | string; widgetEnabled: boolean; }; guildId: string; icon: null | string; id: string; installParams: { permissions: string; scopes: OAuth2Scope[]; }; integrationTypesConfig: { 0: { oauth2InstallParams: ... | ...; }; 1: { oauth2InstallParams: ... | ...; }; }; interactionsEndpointUrl: null | string; name: string; owner: { accentColor: number; avatar: null | string; avatarDecorationData: { asset: string; skuId: string; }; banner: string; bot: boolean; discriminator: string; email: null | string; flags: number; globalName: null | string; id: string; locale: string; mfaEnabled: boolean; premiumType: PremiumTypes; publicFlags: number; system: boolean; username: string; verified: boolean; }; primarySkuId: string; privacyPolicyUrl: string; redirectUris: string[]; roleConnectionsVerificationUrl: null | string; rpcOrigins: string[]; slug: string; tags: string[]; team: null | { icon: null | string; id: string; members: object[]; name: string; ownerUserId: string; }; termsOfServiceUrl: string; verifyKey: string; }; applicationId: string; attachments: object[]; author: { accentColor: number; avatar: null | string; avatarDecorationData: { asset: string; skuId: string; }; banner: string; bot: boolean; discriminator: string; email: null | string; flags: number; globalName: null | string; id: string; locale: string; mfaEnabled: boolean; premiumType: PremiumTypes; publicFlags: number; system: boolean; username: string; verified: boolean; }; call: { endedTimestamp: string; participants: string[]; }; channelId: string; components: ({ components: ({ channelTypes: ...; customId: ...; defaultValues: ...; disabled: ...; maxValues: ...; minValues: ...; options: ...; placeholder: ...; type: ...; } | { customId: ...; disabled: ...; emoji: ...; label: ...; skuId: ...; style: ...; type: ...; url: ...; } | { customId: ...; label: ...; maxLength: ...; minLength: ...; placeholder: ...; required: ...; style: ...; type: ...; value: ...; })[]; type: ActionRow; } | { channelTypes: ChannelTypes[]; customId: string; defaultValues: object[]; disabled: boolean; maxValues: number; minValues: number; options: object[]; placeholder: string; type: SelectMenu | SelectMenuUsers | SelectMenuRoles | SelectMenuUsersAndRoles | SelectMenuChannels; } | { customId: string; disabled: boolean; emoji: { animated: ... | ... | ...; id: ... | ...; name: ... | ...; }; label: string; skuId: string; style: ButtonStyles; type: Button; url: string; } | { customId: string; label: string; maxLength: number; minLength: number; placeholder: string; required: boolean; style: TextStyles; type: InputText; value: string; })[]; content: string; editedTimestamp: null | string; embeds: object[]; flags: MessageFlags; guildId: string; id: string; interaction: { id: string; member: { avatar: string; avatarDecorationData: null | { asset: string; skuId: string; }; banner: string; communicationDisabledUntil: null | string; deaf: boolean; flags: number; joinedAt: string; mute: boolean; nick: null | string; pending: boolean; permissions: string; premiumSince: null | string; roles: string[]; user: { accentColor: ... | ...; avatar: ... | ...; avatarDecorationData: ... | ...; banner: ... | ...; bot: ... | ... | ...; discriminator: string; email: ... | ... | ...; flags: ... | ...; globalName: ... | ...; id: string; locale: ... | ...; mfaEnabled: ... | ... | ...; premiumType: ... | ...; publicFlags: ... | ...; system: ... | ... | ...; username: string; verified: ... | ... | ...; }; }; name: string; type: InteractionTypes; user: { accentColor: number; avatar: null | string; avatarDecorationData: { asset: string; skuId: string; }; banner: string; bot: boolean; discriminator: string; email: null | string; flags: number; globalName: null | string; id: string; locale: string; mfaEnabled: boolean; premiumType: PremiumTypes; publicFlags: number; system: boolean; username: string; verified: boolean; }; }; interactionMetadata: { authorizingIntegrationOwners: { 0: string; 1: string; }; id: string; originalResponseMessageId: string; targetMessageId: string; targetUser: { accentColor: number; avatar: null | string; avatarDecorationData: { asset: string; skuId: string; }; banner: string; bot: boolean; discriminator: string; email: null | string; flags: number; globalName: null | string; id: string; locale: string; mfaEnabled: boolean; premiumType: PremiumTypes; publicFlags: number; system: boolean; username: string; verified: boolean; }; type: InteractionTypes; user: { accentColor: number; avatar: null | string; avatarDecorationData: { asset: string; skuId: string; }; banner: string; bot: boolean; discriminator: string; email: null | string; flags: number; globalName: null | string; id: string; locale: string; mfaEnabled: boolean; premiumType: PremiumTypes; publicFlags: number; system: boolean; username: string; verified: boolean; }; } | { authorizingIntegrationOwners: { 0: string; 1: string; }; id: string; interactedMessageId: string; originalResponseMessageId: string; type: InteractionTypes; user: { accentColor: number; avatar: null | string; avatarDecorationData: { asset: string; skuId: string; }; banner: string; bot: boolean; discriminator: string; email: null | string; flags: number; globalName: null | string; id: string; locale: string; mfaEnabled: boolean; premiumType: PremiumTypes; publicFlags: number; system: boolean; username: string; verified: boolean; }; } | { authorizingIntegrationOwners: { 0: string; 1: string; }; id: string; originalResponseMessageId: string; triggeringInteractionMetadata: { id: string; type: InteractionTypes; user: { username: string; globalName: string | null; locale?: string | undefined; flags?: number | undefined; premiumType?: PremiumTypes | undefined; ... 11 more ...; avatarDecorationData?: { ...; } | undefined; }; authorizingIntegrationOwners: { ...; }; originalResponseMessageI...; type: InteractionTypes; user: { accentColor: number; avatar: null | string; avatarDecorationData: { asset: string; skuId: string; }; banner: string; bot: boolean; discriminator: string; email: null | string; flags: number; globalName: null | string; id: string; locale: string; mfaEnabled: boolean; premiumType: PremiumTypes; publicFlags: number; system: boolean; username: string; verified: boolean; }; }; member: { avatar: string; avatarDecorationData: null | { asset: string; skuId: string; }; banner: string; communicationDisabledUntil: null | string; deaf: boolean; flags: number; joinedAt: string; mute: boolean; nick: null | string; pending: boolean; permissions: string; premiumSince: null | string; roles: string[]; user: { accentColor: number; avatar: null | string; avatarDecorationData: { asset: string; skuId: string; }; banner: string; bot: boolean; discriminator: string; email: null | string; flags: number; globalName: null | string; id: string; locale: string; mfaEnabled: boolean; premiumType: PremiumTypes; publicFlags: number; system: boolean; username: string; verified: boolean; }; }; mentionChannels: object[]; mentionEveryone: boolean; mentionRoles: string[]; mentions: object[]; messageReference: { channelId: string; failIfNotExists: boolean; guildId: string; messageId: string; type: DiscordMessageReferenceType; }; messageSnapshots: object[]; nonce: string | number; pinned: boolean; poll: { allowMultiselect: boolean; answers: object[]; expiry: null | string; layoutType: Default; question: { emoji: { animated: boolean; available: boolean; id: string; managed: boolean; name: string; requireColons: boolean; roles: ...[]; user: { accentColor: ...; avatar: ...; avatarDecorationData: ...; banner: ...; bot: ...; discriminator: ...; email: ...; flags: ...; globalName: ...; id: ...; locale: ...; mfaEnabled: ...; premiumType: ...; publicFlags: ...; system: ...; username: ...; verified: ...; }; }; text: string; }; results: { answerCounts: object[]; isFinalized: boolean; }; }; position: number; reactions: object[]; referencedMessage: { id: string; channelId: string; guildId?: string | undefined; author: { username: string; globalName: string | null; locale?: string | undefined; flags?: number | undefined; premiumType?: PremiumTypes | undefined; ... 11 more ...; avatarDecorationData?: { ...; } | undefined; }; ... 31 more ...; call?: { ...; } | un...; stickerItems: object[]; stickers: object[]; thread: { applicationId: string; appliedTags: string[]; availableTags: object[]; bitrate: number; defaultAutoArchiveDuration: number; defaultForumLayout: ForumLayout; defaultReactionEmoji: null | { emojiId: string; emojiName: null | string; }; defaultSortOrder: null | SortOrderTypes; defaultThreadRateLimitPerUser: number; flags: ChannelFlags; guildId: string; icon: string; id: string; lastMessageId: null | string; lastPinTimestamp: null | string; managed: boolean; member: { flags: number; id: string; joinTimestamp: string; userId: string; }; memberCount: number; messageCount: number; name: string; newlyCreated: boolean; nsfw: boolean; ownerId: string; parentId: null | string; permissionOverwrites: object[]; permissions: string; position: number; rateLimitPerUser: number; recipients: object[]; rtcRegion: null | string; threadMetadata: { archived: boolean; archiveTimestamp: string; autoArchiveDuration: 60 | 1440 | 4320 | 10080; createTimestamp: null | string; invitable: boolean; locked: boolean; }; topic: null | string; totalMessageSent: number; type: ChannelTypes; userLimit: number; videoQualityMode: VideoQualityModes; }; timestamp: string; tts: boolean; type: MessageTypes; webhookId: string; }>

Defined in: packages/rest/dist/types/types.d.ts:1353

Executes a webhook, causing a message to be posted in the channel configured for the webhook.

Parameters

webhookId

https://discord.com/developers/docs/resources/webhook#execute-webhook

The ID of the webhook to execute.

token

string

The webhook token, used to execute the webhook.

options

ExecuteWebhook

The parameters for the execution of the webhook.

Returns

Promise<undefined | { activity: { partyId: string; type: MessageActivityTypes; }; application: { approximateGuildCount: number; approximateUserInstallCount: number; bot: { accentColor: number; avatar: null | string; avatarDecorationData: { asset: string; skuId: string; }; banner: string; bot: boolean; discriminator: string; email: null | string; flags: number; globalName: null | string; id: string; locale: string; mfaEnabled: boolean; premiumType: PremiumTypes; publicFlags: number; system: boolean; username: string; verified: boolean; }; botPublic: boolean; botRequireCodeGrant: boolean; coverImage: string; customInstallUrl: string; description: string; eventWebhooksStatus: DiscordApplicationEventWebhookStatus; eventWebhooksTypes: DiscordWebhookEventType[]; eventWebhooksUrl: null | string; flags: ApplicationFlags; guild: { afkChannelId: null | string; afkTimeout: number; applicationId: null | string; approximateMemberCount: number; approximatePresenceCount: number; banner: null | string; channels: object[]; defaultMessageNotifications: DefaultMessageNotificationLevels; description: null | string; discoverySplash: null | string; emojis: object[]; explicitContentFilter: ExplicitContentFilterLevels; features: GuildFeatures[]; icon: null | string; iconHash: null | string; id: string; joinedAt: string; large: boolean; maxMembers: number; maxPresences: null | number; maxStageVideoChannelUsers: number; maxVideoChannelUsers: number; memberCount: number; members: object[]; mfaLevel: MfaLevels; name: string; nsfwLevel: GuildNsfwLevel; owner: boolean; ownerId: string; permissions: string; preferredLocale: string; premiumProgressBarEnabled: boolean; premiumSubscriptionCount: number; premiumTier: PremiumTiers; presences: object[]; publicUpdatesChannelId: null | string; roles: object[]; rulesChannelId: null | string; safetyAlertsChannelId: null | string; soundboardSounds: object[]; splash: null | string; stageInstances: object[]; stickers: object[]; systemChannelFlags: SystemChannelFlags; systemChannelId: null | string; threads: object[]; unavailable: boolean; vanityUrlCode: null | string; verificationLevel: VerificationLevels; voiceStates: object[]; welcomeScreen: { description: ... | ...; welcomeChannels: ...[]; }; widgetChannelId: null | string; widgetEnabled: boolean; }; guildId: string; icon: null | string; id: string; installParams: { permissions: string; scopes: OAuth2Scope[]; }; integrationTypesConfig: { 0: { oauth2InstallParams: ... | ...; }; 1: { oauth2InstallParams: ... | ...; }; }; interactionsEndpointUrl: null | string; name: string; owner: { accentColor: number; avatar: null | string; avatarDecorationData: { asset: string; skuId: string; }; banner: string; bot: boolean; discriminator: string; email: null | string; flags: number; globalName: null | string; id: string; locale: string; mfaEnabled: boolean; premiumType: PremiumTypes; publicFlags: number; system: boolean; username: string; verified: boolean; }; primarySkuId: string; privacyPolicyUrl: string; redirectUris: string[]; roleConnectionsVerificationUrl: null | string; rpcOrigins: string[]; slug: string; tags: string[]; team: null | { icon: null | string; id: string; members: object[]; name: string; ownerUserId: string; }; termsOfServiceUrl: string; verifyKey: string; }; applicationId: string; attachments: object[]; author: { accentColor: number; avatar: null | string; avatarDecorationData: { asset: string; skuId: string; }; banner: string; bot: boolean; discriminator: string; email: null | string; flags: number; globalName: null | string; id: string; locale: string; mfaEnabled: boolean; premiumType: PremiumTypes; publicFlags: number; system: boolean; username: string; verified: boolean; }; call: { endedTimestamp: string; participants: string[]; }; channelId: string; components: ({ components: ({ channelTypes: ...; customId: ...; defaultValues: ...; disabled: ...; maxValues: ...; minValues: ...; options: ...; placeholder: ...; type: ...; } | { customId: ...; disabled: ...; emoji: ...; label: ...; skuId: ...; style: ...; type: ...; url: ...; } | { customId: ...; label: ...; maxLength: ...; minLength: ...; placeholder: ...; required: ...; style: ...; type: ...; value: ...; })[]; type: ActionRow; } | { channelTypes: ChannelTypes[]; customId: string; defaultValues: object[]; disabled: boolean; maxValues: number; minValues: number; options: object[]; placeholder: string; type: SelectMenu | SelectMenuUsers | SelectMenuRoles | SelectMenuUsersAndRoles | SelectMenuChannels; } | { customId: string; disabled: boolean; emoji: { animated: ... | ... | ...; id: ... | ...; name: ... | ...; }; label: string; skuId: string; style: ButtonStyles; type: Button; url: string; } | { customId: string; label: string; maxLength: number; minLength: number; placeholder: string; required: boolean; style: TextStyles; type: InputText; value: string; })[]; content: string; editedTimestamp: null | string; embeds: object[]; flags: MessageFlags; guildId: string; id: string; interaction: { id: string; member: { avatar: string; avatarDecorationData: null | { asset: string; skuId: string; }; banner: string; communicationDisabledUntil: null | string; deaf: boolean; flags: number; joinedAt: string; mute: boolean; nick: null | string; pending: boolean; permissions: string; premiumSince: null | string; roles: string[]; user: { accentColor: ... | ...; avatar: ... | ...; avatarDecorationData: ... | ...; banner: ... | ...; bot: ... | ... | ...; discriminator: string; email: ... | ... | ...; flags: ... | ...; globalName: ... | ...; id: string; locale: ... | ...; mfaEnabled: ... | ... | ...; premiumType: ... | ...; publicFlags: ... | ...; system: ... | ... | ...; username: string; verified: ... | ... | ...; }; }; name: string; type: InteractionTypes; user: { accentColor: number; avatar: null | string; avatarDecorationData: { asset: string; skuId: string; }; banner: string; bot: boolean; discriminator: string; email: null | string; flags: number; globalName: null | string; id: string; locale: string; mfaEnabled: boolean; premiumType: PremiumTypes; publicFlags: number; system: boolean; username: string; verified: boolean; }; }; interactionMetadata: { authorizingIntegrationOwners: { 0: string; 1: string; }; id: string; originalResponseMessageId: string; targetMessageId: string; targetUser: { accentColor: number; avatar: null | string; avatarDecorationData: { asset: string; skuId: string; }; banner: string; bot: boolean; discriminator: string; email: null | string; flags: number; globalName: null | string; id: string; locale: string; mfaEnabled: boolean; premiumType: PremiumTypes; publicFlags: number; system: boolean; username: string; verified: boolean; }; type: InteractionTypes; user: { accentColor: number; avatar: null | string; avatarDecorationData: { asset: string; skuId: string; }; banner: string; bot: boolean; discriminator: string; email: null | string; flags: number; globalName: null | string; id: string; locale: string; mfaEnabled: boolean; premiumType: PremiumTypes; publicFlags: number; system: boolean; username: string; verified: boolean; }; } | { authorizingIntegrationOwners: { 0: string; 1: string; }; id: string; interactedMessageId: string; originalResponseMessageId: string; type: InteractionTypes; user: { accentColor: number; avatar: null | string; avatarDecorationData: { asset: string; skuId: string; }; banner: string; bot: boolean; discriminator: string; email: null | string; flags: number; globalName: null | string; id: string; locale: string; mfaEnabled: boolean; premiumType: PremiumTypes; publicFlags: number; system: boolean; username: string; verified: boolean; }; } | { authorizingIntegrationOwners: { 0: string; 1: string; }; id: string; originalResponseMessageId: string; triggeringInteractionMetadata: { id: string; type: InteractionTypes; user: { username: string; globalName: string | null; locale?: string | undefined; flags?: number | undefined; premiumType?: PremiumTypes | undefined; ... 11 more ...; avatarDecorationData?: { ...; } | undefined; }; authorizingIntegrationOwners: { ...; }; originalResponseMessageI...; type: InteractionTypes; user: { accentColor: number; avatar: null | string; avatarDecorationData: { asset: string; skuId: string; }; banner: string; bot: boolean; discriminator: string; email: null | string; flags: number; globalName: null | string; id: string; locale: string; mfaEnabled: boolean; premiumType: PremiumTypes; publicFlags: number; system: boolean; username: string; verified: boolean; }; }; member: { avatar: string; avatarDecorationData: null | { asset: string; skuId: string; }; banner: string; communicationDisabledUntil: null | string; deaf: boolean; flags: number; joinedAt: string; mute: boolean; nick: null | string; pending: boolean; permissions: string; premiumSince: null | string; roles: string[]; user: { accentColor: number; avatar: null | string; avatarDecorationData: { asset: string; skuId: string; }; banner: string; bot: boolean; discriminator: string; email: null | string; flags: number; globalName: null | string; id: string; locale: string; mfaEnabled: boolean; premiumType: PremiumTypes; publicFlags: number; system: boolean; username: string; verified: boolean; }; }; mentionChannels: object[]; mentionEveryone: boolean; mentionRoles: string[]; mentions: object[]; messageReference: { channelId: string; failIfNotExists: boolean; guildId: string; messageId: string; type: DiscordMessageReferenceType; }; messageSnapshots: object[]; nonce: string | number; pinned: boolean; poll: { allowMultiselect: boolean; answers: object[]; expiry: null | string; layoutType: Default; question: { emoji: { animated: boolean; available: boolean; id: string; managed: boolean; name: string; requireColons: boolean; roles: ...[]; user: { accentColor: ...; avatar: ...; avatarDecorationData: ...; banner: ...; bot: ...; discriminator: ...; email: ...; flags: ...; globalName: ...; id: ...; locale: ...; mfaEnabled: ...; premiumType: ...; publicFlags: ...; system: ...; username: ...; verified: ...; }; }; text: string; }; results: { answerCounts: object[]; isFinalized: boolean; }; }; position: number; reactions: object[]; referencedMessage: { id: string; channelId: string; guildId?: string | undefined; author: { username: string; globalName: string | null; locale?: string | undefined; flags?: number | undefined; premiumType?: PremiumTypes | undefined; ... 11 more ...; avatarDecorationData?: { ...; } | undefined; }; ... 31 more ...; call?: { ...; } | un...; stickerItems: object[]; stickers: object[]; thread: { applicationId: string; appliedTags: string[]; availableTags: object[]; bitrate: number; defaultAutoArchiveDuration: number; defaultForumLayout: ForumLayout; defaultReactionEmoji: null | { emojiId: string; emojiName: null | string; }; defaultSortOrder: null | SortOrderTypes; defaultThreadRateLimitPerUser: number; flags: ChannelFlags; guildId: string; icon: string; id: string; lastMessageId: null | string; lastPinTimestamp: null | string; managed: boolean; member: { flags: number; id: string; joinTimestamp: string; userId: string; }; memberCount: number; messageCount: number; name: string; newlyCreated: boolean; nsfw: boolean; ownerId: string; parentId: null | string; permissionOverwrites: object[]; permissions: string; position: number; rateLimitPerUser: number; recipients: object[]; rtcRegion: null | string; threadMetadata: { archived: boolean; archiveTimestamp: string; autoArchiveDuration: 60 | 1440 | 4320 | 10080; createTimestamp: null | string; invitable: boolean; locked: boolean; }; topic: null | string; totalMessageSent: number; type: ChannelTypes; userLimit: number; videoQualityMode: VideoQualityModes; }; timestamp: string; tts: boolean; type: MessageTypes; webhookId: string; }>

An instance of the created DiscordMessage, or undefined if the wait property of the options object parameter is set to false.

Remarks

If the webhook channel is a forum channel, you must provide a value for either threadId or threadName.

See

followAnnouncement()

followAnnouncement: (sourceChannelId, targetChannelId, reason?) => Promise<{ channelId: string; webhookId: string; }>

Defined in: packages/rest/dist/types/types.d.ts:1369

Follows an announcement channel, allowing messages posted within it to be cross-posted into the target channel.

Parameters

sourceChannelId

The ID of the announcement channel to follow.

targetChannelId

https://discord.com/developers/docs/resources/channel#follow-announcement-channel

The ID of the target channel - the channel to cross-post to.

reason?

string

An optional reason for the action, to be included in the audit log.

Returns

Promise<{ channelId: string; webhookId: string; }>

An instance of DiscordFollowedChannel.

Remarks

Requires the MANAGE_WEBHOOKS permission in the target channel.

Fires a Webhooks Update gateway event.

See

get()

get: <T>(url, options?) => Promise<Camelize<T>>

Defined in: packages/rest/dist/types/types.d.ts:122

Make a get request to the api

Type Parameters

• T = void

Parameters

url

string

options?

Omit<MakeRequestOptions, "body">

Returns

Promise<Camelize<T>>

getActiveThreads()

getActiveThreads: (guildId) => Promise<{ members: object[]; threads: object[]; }>

Defined in: packages/rest/dist/types/types.d.ts:1383

Gets the list of all active threads for a guild.

Parameters

guildId

https://discord.com/developers/docs/resources/guild#list-active-guild-threads

The ID of the guild to get the threads of.

Returns

Promise<{ members: object[]; threads: object[]; }>

An instance of DiscordActiveThreads.

Remarks

Returns both public and private threads.

Threads are ordered by the id property in descending order.

See

getApplicationActivityInstance()

getApplicationActivityInstance: (applicationId, instanceId) => Promise<{ applicationId: string; instanceId: string; launchId: string; location: { channelId: string; guildId: null | string; id: string; kind: DiscordActivityLocationKind; }; users: string[]; }>

Defined in: packages/rest/dist/types/types.d.ts:2658

Returns a serialized activity instance, if it exists. Useful for preventing unwanted activity sessions.

Parameters

applicationId

The ID of the application

instanceId

string

The ID of the activity instance

Returns

Promise<{ applicationId: string; instanceId: string; launchId: string; location: { channelId: string; guildId: null | string; id: string; kind: DiscordActivityLocationKind; }; users: string[]; }>

getApplicationCommandPermission()

getApplicationCommandPermission: (guildId, commandId, options?) => Promise<{ applicationId: string; guildId: string; id: string; permissions: object[]; }>

Defined in: packages/rest/dist/types/types.d.ts:1433

Gets the permissions of a guild application command.

Parameters

guildId

The ID of the guild the command is registered in.

commandId

GetApplicationCommandPermissionOptions

The ID of the command to get the permissions of.

options?

The OAuth2 related optional parameters for the endpoint

Returns

Promise<{ applicationId: string; guildId: string; id: string; permissions: object[]; }>

An instance of DiscordGuildApplicationCommandPermissions.

Remarks

Then specifying the options object the access token passed-in requires the OAuth2 scope applications.commands.permissions.update

See

https://discord.com/developers/docs/interactions/application-commands#get-application-command-permissions

getApplicationCommandPermissions()

getApplicationCommandPermissions: (guildId, options?) => Promise<object[]>

Defined in: packages/rest/dist/types/types.d.ts:1446

Gets the permissions of all application commands registered in a guild by the ID of the guild and optionally an external application.

Parameters

guildId

GetApplicationCommandPermissionOptions

The ID of the guild to get the permissions objects of.

options?

The OAuth2 related optional parameters for the endpoint

Returns

Promise<object[]>

A collection of DiscordGuildApplicationCommandPermissions objects assorted by command ID.

Remarks

Then specifying the options object the access token passed-in requires the OAuth2 scope applications.commands.permissions.update

See

https://discord.com/developers/docs/interactions/application-commands#get-guild-application-command-permissions

getApplicationEmoji()

getApplicationEmoji: (emojiId) => Promise<{ animated: boolean; available: boolean; id: string; managed: boolean; name: string; requireColons: boolean; roles: string[]; user: { accentColor: number; avatar: null | string; avatarDecorationData: { asset: string; skuId: string; }; banner: string; bot: boolean; discriminator: string; email: null | string; flags: number; globalName: null | string; id: string; locale: string; mfaEnabled: boolean; premiumType: PremiumTypes; publicFlags: number; system: boolean; username: string; verified: boolean; }; }>

Defined in: packages/rest/dist/types/types.d.ts:1619

Gets an application emoji by its ID.

Parameters

emojiId

https://discord.com/developers/docs/resources/emoji#get-application-emoji

The ID of the emoji to get.

Returns

An instance of DiscordEmoji.

Remarks

Always includes the user object for the team member that uploaded the emoji from the app's settings, or for the bot user if uploaded using the API.

See

getApplicationEmojis()

getApplicationEmojis: () => Promise<{ items: object[]; }>

Defined in: packages/rest/dist/types/types.d.ts:1642

Gets the list of emojis for an application.

Returns

Promise<{ items: object[]; }>

An object with the array of DiscordEmoji objects.

Remarks

Always includes the user object for the team member that uploaded the emoji from the app's settings, or for the bot user if uploaded using the API.

See

https://discord.com/developers/docs/resources/emoji#list-application-emojis

getApplicationInfo()

getApplicationInfo: () => Promise<{ approximateGuildCount: number; approximateUserInstallCount: number; bot: { accentColor: number; avatar: null | string; avatarDecorationData: { asset: string; skuId: string; }; banner: string; bot: boolean; discriminator: string; email: null | string; flags: number; globalName: null | string; id: string; locale: string; mfaEnabled: boolean; premiumType: PremiumTypes; publicFlags: number; system: boolean; username: string; verified: boolean; }; botPublic: boolean; botRequireCodeGrant: boolean; coverImage: string; customInstallUrl: string; description: string; eventWebhooksStatus: DiscordApplicationEventWebhookStatus; eventWebhooksTypes: DiscordWebhookEventType[]; eventWebhooksUrl: null | string; flags: ApplicationFlags; guild: { afkChannelId: null | string; afkTimeout: number; applicationId: null | string; approximateMemberCount: number; approximatePresenceCount: number; banner: null | string; channels: object[]; defaultMessageNotifications: DefaultMessageNotificationLevels; description: null | string; discoverySplash: null | string; emojis: object[]; explicitContentFilter: ExplicitContentFilterLevels; features: GuildFeatures[]; icon: null | string; iconHash: null | string; id: string; joinedAt: string; large: boolean; maxMembers: number; maxPresences: null | number; maxStageVideoChannelUsers: number; maxVideoChannelUsers: number; memberCount: number; members: object[]; mfaLevel: MfaLevels; name: string; nsfwLevel: GuildNsfwLevel; owner: boolean; ownerId: string; permissions: string; preferredLocale: string; premiumProgressBarEnabled: boolean; premiumSubscriptionCount: number; premiumTier: PremiumTiers; presences: object[]; publicUpdatesChannelId: null | string; roles: object[]; rulesChannelId: null | string; safetyAlertsChannelId: null | string; soundboardSounds: object[]; splash: null | string; stageInstances: object[]; stickers: object[]; systemChannelFlags: SystemChannelFlags; systemChannelId: null | string; threads: object[]; unavailable: boolean; vanityUrlCode: null | string; verificationLevel: VerificationLevels; voiceStates: object[]; welcomeScreen: { description: null | string; welcomeChannels: object[]; }; widgetChannelId: null | string; widgetEnabled: boolean; }; guildId: string; icon: null | string; id: string; installParams: { permissions: string; scopes: OAuth2Scope[]; }; integrationTypesConfig: { 0: { oauth2InstallParams: { permissions: string; scopes: OAuth2Scope[]; }; }; 1: { oauth2InstallParams: { permissions: string; scopes: OAuth2Scope[]; }; }; }; interactionsEndpointUrl: null | string; name: string; owner: { accentColor: number; avatar: null | string; avatarDecorationData: { asset: string; skuId: string; }; banner: string; bot: boolean; discriminator: string; email: null | string; flags: number; globalName: null | string; id: string; locale: string; mfaEnabled: boolean; premiumType: PremiumTypes; publicFlags: number; system: boolean; username: string; verified: boolean; }; primarySkuId: string; privacyPolicyUrl: string; redirectUris: string[]; roleConnectionsVerificationUrl: null | string; rpcOrigins: string[]; slug: string; tags: string[]; team: null | { icon: null | string; id: string; members: object[]; name: string; ownerUserId: string; }; termsOfServiceUrl: string; verifyKey: string; }>

Defined in: packages/rest/dist/types/types.d.ts:1385

Get the applications info

Returns

getAuditLog()

getAuditLog: (guildId, options?) => Promise<{ applicationCommands: object[]; auditLogEntries: object[]; autoModerationRules: object[]; guildScheduledEvents: object[]; integrations: object[]; threads: object[]; users: object[]; webhooks: ({ applicationId: null | string; avatar: null | string; channelId: string; guildId: string; id: string; name: null | string; sourceChannel: { applicationId: string; appliedTags: string[]; availableTags: object[]; bitrate: number; defaultAutoArchiveDuration: number; defaultForumLayout: ForumLayout; defaultReactionEmoji: null | { emojiId: string; emojiName: ... | ...; }; defaultSortOrder: null | SortOrderTypes; defaultThreadRateLimitPerUser: number; flags: ChannelFlags; guildId: string; icon: string; id: string; lastMessageId: null | string; lastPinTimestamp: null | string; managed: boolean; member: { flags: number; id: string; joinTimestamp: string; userId: string; }; memberCount: number; messageCount: number; name: string; newlyCreated: boolean; nsfw: boolean; ownerId: string; parentId: null | string; permissionOverwrites: object[]; permissions: string; position: number; rateLimitPerUser: number; recipients: object[]; rtcRegion: null | string; threadMetadata: { archived: boolean; archiveTimestamp: string; autoArchiveDuration: ... | ... | ... | ...; createTimestamp: ... | ... | ...; invitable: ... | ... | ...; locked: boolean; }; topic: null | string; totalMessageSent: number; type: ChannelTypes; userLimit: number; videoQualityMode: VideoQualityModes; }; sourceGuild: { afkChannelId: null | string; afkTimeout: number; applicationId: null | string; approximateMemberCount: number; approximatePresenceCount: number; banner: null | string; channels: object[]; defaultMessageNotifications: DefaultMessageNotificationLevels; description: null | string; discoverySplash: null | string; emojis: object[]; explicitContentFilter: ExplicitContentFilterLevels; features: GuildFeatures[]; icon: null | string; iconHash: null | string; id: string; joinedAt: string; large: boolean; maxMembers: number; maxPresences: null | number; maxStageVideoChannelUsers: number; maxVideoChannelUsers: number; memberCount: number; members: object[]; mfaLevel: MfaLevels; name: string; nsfwLevel: GuildNsfwLevel; owner: boolean; ownerId: string; permissions: string; preferredLocale: string; premiumProgressBarEnabled: boolean; premiumSubscriptionCount: number; premiumTier: PremiumTiers; presences: object[]; publicUpdatesChannelId: null | string; roles: object[]; rulesChannelId: null | string; safetyAlertsChannelId: null | string; soundboardSounds: object[]; splash: null | string; stageInstances: object[]; stickers: object[]; systemChannelFlags: SystemChannelFlags; systemChannelId: null | string; threads: object[]; unavailable: boolean; vanityUrlCode: null | string; verificationLevel: VerificationLevels; voiceStates: object[]; welcomeScreen: { description: ... | ...; welcomeChannels: ...[]; }; widgetChannelId: null | string; widgetEnabled: boolean; }; token: string; type: WebhookTypes; url: string; user: { accentColor: number; avatar: null | string; avatarDecorationData: { asset: string; skuId: string; }; banner: string; bot: boolean; discriminator: string; email: null | string; flags: number; globalName: null | string; id: string; locale: string; mfaEnabled: boolean; premiumType: PremiumTypes; publicFlags: number; system: boolean; username: string; verified: boolean; }; } | { applicationId: null | string; avatar: null | string; channelId: null | string; guildId: null | string; id: string; name: null | string; sourceChannel: { applicationId: string; appliedTags: string[]; availableTags: object[]; bitrate: number; defaultAutoArchiveDuration: number; defaultForumLayout: ForumLayout; defaultReactionEmoji: null | { emojiId: string; emojiName: ... | ...; }; defaultSortOrder: null | SortOrderTypes; defaultThreadRateLimitPerUser: number; flags: ChannelFlags; guildId: string; icon: string; id: string; lastMessageId: null | string; lastPinTimestamp: null | string; managed: boolean; member: { flags: number; id: string; joinTimestamp: string; userId: string; }; memberCount: number; messageCount: number; name: string; newlyCreated: boolean; nsfw: boolean; ownerId: string; parentId: null | string; permissionOverwrites: object[]; permissions: string; position: number; rateLimitPerUser: number; recipients: object[]; rtcRegion: null | string; threadMetadata: { archived: boolean; archiveTimestamp: string; autoArchiveDuration: ... | ... | ... | ...; createTimestamp: ... | ... | ...; invitable: ... | ... | ...; locked: boolean; }; topic: null | string; totalMessageSent: number; type: ChannelTypes; userLimit: number; videoQualityMode: VideoQualityModes; }; sourceGuild: { afkChannelId: null | string; afkTimeout: number; applicationId: null | string; approximateMemberCount: number; approximatePresenceCount: number; banner: null | string; channels: object[]; defaultMessageNotifications: DefaultMessageNotificationLevels; description: null | string; discoverySplash: null | string; emojis: object[]; explicitContentFilter: ExplicitContentFilterLevels; features: GuildFeatures[]; icon: null | string; iconHash: null | string; id: string; joinedAt: string; large: boolean; maxMembers: number; maxPresences: null | number; maxStageVideoChannelUsers: number; maxVideoChannelUsers: number; memberCount: number; members: object[]; mfaLevel: MfaLevels; name: string; nsfwLevel: GuildNsfwLevel; owner: boolean; ownerId: string; permissions: string; preferredLocale: string; premiumProgressBarEnabled: boolean; premiumSubscriptionCount: number; premiumTier: PremiumTiers; presences: object[]; publicUpdatesChannelId: null | string; roles: object[]; rulesChannelId: null | string; safetyAlertsChannelId: null | string; soundboardSounds: object[]; splash: null | string; stageInstances: object[]; stickers: object[]; systemChannelFlags: SystemChannelFlags; systemChannelId: null | string; threads: object[]; unavailable: boolean; vanityUrlCode: null | string; verificationLevel: VerificationLevels; voiceStates: object[]; welcomeScreen: { description: ... | ...; welcomeChannels: ...[]; }; widgetChannelId: null | string; widgetEnabled: boolean; }; token: string; type: Application; url: string; user: { accentColor: number; avatar: null | string; avatarDecorationData: { asset: string; skuId: string; }; banner: string; bot: boolean; discriminator: string; email: null | string; flags: number; globalName: null | string; id: string; locale: string; mfaEnabled: boolean; premiumType: PremiumTypes; publicFlags: number; system: boolean; username: string; verified: boolean; }; })[]; }>

Defined in: packages/rest/dist/types/types.d.ts:1459

Gets a guild's audit log.

Parameters

guildId

https://discord.com/developers/docs/resources/audit-log#get-guild-audit-log

The ID of the guild to get the audit log of.

options?

GetGuildAuditLog

The parameters for the fetching of the audit log.

Returns

Promise<{ applicationCommands: object[]; auditLogEntries: object[]; autoModerationRules: object[]; guildScheduledEvents: object[]; integrations: object[]; threads: object[]; users: object[]; webhooks: ({ applicationId: null | string; avatar: null | string; channelId: string; guildId: string; id: string; name: null | string; sourceChannel: { applicationId: string; appliedTags: string[]; availableTags: object[]; bitrate: number; defaultAutoArchiveDuration: number; defaultForumLayout: ForumLayout; defaultReactionEmoji: null | { emojiId: string; emojiName: ... | ...; }; defaultSortOrder: null | SortOrderTypes; defaultThreadRateLimitPerUser: number; flags: ChannelFlags; guildId: string; icon: string; id: string; lastMessageId: null | string; lastPinTimestamp: null | string; managed: boolean; member: { flags: number; id: string; joinTimestamp: string; userId: string; }; memberCount: number; messageCount: number; name: string; newlyCreated: boolean; nsfw: boolean; ownerId: string; parentId: null | string; permissionOverwrites: object[]; permissions: string; position: number; rateLimitPerUser: number; recipients: object[]; rtcRegion: null | string; threadMetadata: { archived: boolean; archiveTimestamp: string; autoArchiveDuration: ... | ... | ... | ...; createTimestamp: ... | ... | ...; invitable: ... | ... | ...; locked: boolean; }; topic: null | string; totalMessageSent: number; type: ChannelTypes; userLimit: number; videoQualityMode: VideoQualityModes; }; sourceGuild: { afkChannelId: null | string; afkTimeout: number; applicationId: null | string; approximateMemberCount: number; approximatePresenceCount: number; banner: null | string; channels: object[]; defaultMessageNotifications: DefaultMessageNotificationLevels; description: null | string; discoverySplash: null | string; emojis: object[]; explicitContentFilter: ExplicitContentFilterLevels; features: GuildFeatures[]; icon: null | string; iconHash: null | string; id: string; joinedAt: string; large: boolean; maxMembers: number; maxPresences: null | number; maxStageVideoChannelUsers: number; maxVideoChannelUsers: number; memberCount: number; members: object[]; mfaLevel: MfaLevels; name: string; nsfwLevel: GuildNsfwLevel; owner: boolean; ownerId: string; permissions: string; preferredLocale: string; premiumProgressBarEnabled: boolean; premiumSubscriptionCount: number; premiumTier: PremiumTiers; presences: object[]; publicUpdatesChannelId: null | string; roles: object[]; rulesChannelId: null | string; safetyAlertsChannelId: null | string; soundboardSounds: object[]; splash: null | string; stageInstances: object[]; stickers: object[]; systemChannelFlags: SystemChannelFlags; systemChannelId: null | string; threads: object[]; unavailable: boolean; vanityUrlCode: null | string; verificationLevel: VerificationLevels; voiceStates: object[]; welcomeScreen: { description: ... | ...; welcomeChannels: ...[]; }; widgetChannelId: null | string; widgetEnabled: boolean; }; token: string; type: WebhookTypes; url: string; user: { accentColor: number; avatar: null | string; avatarDecorationData: { asset: string; skuId: string; }; banner: string; bot: boolean; discriminator: string; email: null | string; flags: number; globalName: null | string; id: string; locale: string; mfaEnabled: boolean; premiumType: PremiumTypes; publicFlags: number; system: boolean; username: string; verified: boolean; }; } | { applicationId: null | string; avatar: null | string; channelId: null | string; guildId: null | string; id: string; name: null | string; sourceChannel: { applicationId: string; appliedTags: string[]; availableTags: object[]; bitrate: number; defaultAutoArchiveDuration: number; defaultForumLayout: ForumLayout; defaultReactionEmoji: null | { emojiId: string; emojiName: ... | ...; }; defaultSortOrder: null | SortOrderTypes; defaultThreadRateLimitPerUser: number; flags: ChannelFlags; guildId: string; icon: string; id: string; lastMessageId: null | string; lastPinTimestamp: null | string; managed: boolean; member: { flags: number; id: string; joinTimestamp: string; userId: string; }; memberCount: number; messageCount: number; name: string; newlyCreated: boolean; nsfw: boolean; ownerId: string; parentId: null | string; permissionOverwrites: object[]; permissions: string; position: number; rateLimitPerUser: number; recipients: object[]; rtcRegion: null | string; threadMetadata: { archived: boolean; archiveTimestamp: string; autoArchiveDuration: ... | ... | ... | ...; createTimestamp: ... | ... | ...; invitable: ... | ... | ...; locked: boolean; }; topic: null | string; totalMessageSent: number; type: ChannelTypes; userLimit: number; videoQualityMode: VideoQualityModes; }; sourceGuild: { afkChannelId: null | string; afkTimeout: number; applicationId: null | string; approximateMemberCount: number; approximatePresenceCount: number; banner: null | string; channels: object[]; defaultMessageNotifications: DefaultMessageNotificationLevels; description: null | string; discoverySplash: null | string; emojis: object[]; explicitContentFilter: ExplicitContentFilterLevels; features: GuildFeatures[]; icon: null | string; iconHash: null | string; id: string; joinedAt: string; large: boolean; maxMembers: number; maxPresences: null | number; maxStageVideoChannelUsers: number; maxVideoChannelUsers: number; memberCount: number; members: object[]; mfaLevel: MfaLevels; name: string; nsfwLevel: GuildNsfwLevel; owner: boolean; ownerId: string; permissions: string; preferredLocale: string; premiumProgressBarEnabled: boolean; premiumSubscriptionCount: number; premiumTier: PremiumTiers; presences: object[]; publicUpdatesChannelId: null | string; roles: object[]; rulesChannelId: null | string; safetyAlertsChannelId: null | string; soundboardSounds: object[]; splash: null | string; stageInstances: object[]; stickers: object[]; systemChannelFlags: SystemChannelFlags; systemChannelId: null | string; threads: object[]; unavailable: boolean; vanityUrlCode: null | string; verificationLevel: VerificationLevels; voiceStates: object[]; welcomeScreen: { description: ... | ...; welcomeChannels: ...[]; }; widgetChannelId: null | string; widgetEnabled: boolean; }; token: string; type: Application; url: string; user: { accentColor: number; avatar: null | string; avatarDecorationData: { asset: string; skuId: string; }; banner: string; bot: boolean; discriminator: string; email: null | string; flags: number; globalName: null | string; id: string; locale: string; mfaEnabled: boolean; premiumType: PremiumTypes; publicFlags: number; system: boolean; username: string; verified: boolean; }; })[]; }>

An instance of DiscordAuditLog.

Remarks

Requires the VIEW_AUDIT_LOG permission.

See

getAutomodRule()

getAutomodRule: (guildId, ruleId) => Promise<{ actions: object[]; creatorId: string; enabled: boolean; eventType: AutoModerationEventTypes; exemptChannels: string[]; exemptRoles: string[]; guildId: string; id: string; name: string; triggerMetadata: { allowList: string[]; keywordFilter: string[]; mentionRaidProtectionEnabled: boolean; mentionTotalLimit: number; presets: DiscordAutoModerationRuleTriggerMetadataPresets[]; regexPatterns: string[]; }; triggerType: AutoModerationTriggerTypes; }>

Defined in: packages/rest/dist/types/types.d.ts:1472

Gets an automod rule by its ID.

Parameters

guildId

The ID of the guild to get the rule of.

ruleId

https://discord.com/developers/docs/resources/auto-moderation#get-auto-moderation-rule

The ID of the rule to get.

Returns

An instance of DiscordAutoModerationRule.

Remarks

Requires the MANAGE_GUILD permission.

See

getAutomodRules()

getAutomodRules: (guildId) => Promise<object[]>

Defined in: packages/rest/dist/types/types.d.ts:1484

Gets the list of automod rules for a guild.

Parameters

guildId

https://discord.com/developers/docs/resources/auto-moderation#list-auto-moderation-rules-for-guild

The ID of the guild to get the rules from.

Returns

Promise<object[]>

A collection of DiscordAutoModerationRule objects assorted by rule ID.

Remarks

Requires the MANAGE_GUILD permission.

See

getAvailableVoiceRegions()

getAvailableVoiceRegions: () => Promise<object[]>

Defined in: packages/rest/dist/types/types.d.ts:1490

Gets the list of available voice regions.

Returns

Promise<object[]>

A collection of DiscordVoiceRegion objects assorted by voice region ID.

getBan()

getBan: (guildId, userId) => Promise<{ reason: null | string; user: { accentColor: number; avatar: null | string; avatarDecorationData: { asset: string; skuId: string; }; banner: string; bot: boolean; discriminator: string; email: null | string; flags: number; globalName: null | string; id: string; locale: string; mfaEnabled: boolean; premiumType: PremiumTypes; publicFlags: number; system: boolean; username: string; verified: boolean; }; }>

Defined in: packages/rest/dist/types/types.d.ts:1503

Gets a ban by user ID.

Parameters

guildId

The ID of the guild to get the ban from.

userId

https://discord.com/developers/docs/resources/guild#get-guild-ban

The ID of the user to get the ban for.

Returns

Promise<{ reason: null | string; user: { accentColor: number; avatar: null | string; avatarDecorationData: { asset: string; skuId: string; }; banner: string; bot: boolean; discriminator: string; email: null | string; flags: number; globalName: null | string; id: string; locale: string; mfaEnabled: boolean; premiumType: PremiumTypes; publicFlags: number; system: boolean; username: string; verified: boolean; }; }>

An instance of DiscordBan.

Remarks

Requires the BAN_MEMBERS permission.

See

getBans()

getBans: (guildId, options?) => Promise<object[]>

Defined in: packages/rest/dist/types/types.d.ts:1518

Gets the list of bans for a guild.

Parameters

guildId

https://discord.com/developers/docs/resources/guild#get-guild-bans

The ID of the guild to get the list of bans for.

options?

GetBans

The parameters for the fetching of the list of bans.

Returns

Promise<object[]>

A collection of DiscordBan objects assorted by user ID.

Remarks

Requires the BAN_MEMBERS permission.

Users are ordered by their IDs in ascending order.

See

getChannel()

getChannel: (channelId) => Promise<{ applicationId: string; appliedTags: string[]; availableTags: object[]; bitrate: number; defaultAutoArchiveDuration: number; defaultForumLayout: ForumLayout; defaultReactionEmoji: null | { emojiId: string; emojiName: null | string; }; defaultSortOrder: null | SortOrderTypes; defaultThreadRateLimitPerUser: number; flags: ChannelFlags; guildId: string; icon: string; id: string; lastMessageId: null | string; lastPinTimestamp: null | string; managed: boolean; member: { flags: number; id: string; joinTimestamp: string; userId: string; }; memberCount: number; messageCount: number; name: string; newlyCreated: boolean; nsfw: boolean; ownerId: string; parentId: null | string; permissionOverwrites: object[]; permissions: string; position: number; rateLimitPerUser: number; recipients: object[]; rtcRegion: null | string; threadMetadata: { archived: boolean; archiveTimestamp: string; autoArchiveDuration: 60 | 1440 | 4320 | 10080; createTimestamp: null | string; invitable: boolean; locked: boolean; }; topic: null | string; totalMessageSent: number; type: ChannelTypes; userLimit: number; videoQualityMode: VideoQualityModes; }>

Defined in: packages/rest/dist/types/types.d.ts:1530

Gets a channel by its ID.

Parameters

channelId

https://discord.com/developers/docs/resources/channel#get-channel

The ID of the channel to get.

Returns

An instance of DiscordChannel.

Remarks

If the channel is a thread, a DiscordThreadMember object is included in the result.

See

getChannelInvites()

getChannelInvites: (channelId) => Promise<object[]>

Defined in: packages/rest/dist/types/types.d.ts:1544

Gets the list of invites for a channel.

Parameters

channelId

https://discord.com/developers/docs/resources/channel#get-channel-invites

The ID of the channel to get the invites of.

Returns

Promise<object[]>

A collection of DiscordInviteMetadata objects assorted by invite code.

Remarks

Requires the MANAGE_CHANNELS permission.

Only usable for guild channels.

See

getChannels()

getChannels: (guildId) => Promise<object[]>

Defined in: packages/rest/dist/types/types.d.ts:1556

Gets the list of channels for a guild.

Parameters

guildId

https://discord.com/developers/docs/resources/guild#get-guild-channels

The ID of the guild to get the channels of.

Returns

Promise<object[]>

A collection of DiscordChannel objects assorted by channel ID.

Remarks

Excludes threads.

See

getChannelWebhooks()

getChannelWebhooks: (channelId) => Promise<Camelize<DiscordWebhook>[]>

Defined in: packages/rest/dist/types/types.d.ts:1568

Gets a list of webhooks for a channel.

Parameters

channelId

https://discord.com/developers/docs/resources/webhook#get-channel-webhooks

The ID of the channel which to get the webhooks of.

Returns

Promise<Camelize<DiscordWebhook>[]>

A collection of DiscordWebhook objects assorted by webhook ID.

Remarks

Requires the MANAGE_WEBHOOKS permission.

See

getCurrentAuthenticationInfo()

getCurrentAuthenticationInfo: (bearerToken) => Promise<{ application: { approximateGuildCount: number; approximateUserInstallCount: number; bot: { accentColor: number; avatar: null | string; avatarDecorationData: { asset: string; skuId: string; }; banner: string; bot: boolean; discriminator: string; email: null | string; flags: number; globalName: null | string; id: string; locale: string; mfaEnabled: boolean; premiumType: PremiumTypes; publicFlags: number; system: boolean; username: string; verified: boolean; }; botPublic: boolean; botRequireCodeGrant: boolean; coverImage: string; customInstallUrl: string; description: string; eventWebhooksStatus: DiscordApplicationEventWebhookStatus; eventWebhooksTypes: DiscordWebhookEventType[]; eventWebhooksUrl: null | string; flags: ApplicationFlags; guild: { afkChannelId: null | string; afkTimeout: number; applicationId: null | string; approximateMemberCount: number; approximatePresenceCount: number; banner: null | string; channels: object[]; defaultMessageNotifications: DefaultMessageNotificationLevels; description: null | string; discoverySplash: null | string; emojis: object[]; explicitContentFilter: ExplicitContentFilterLevels; features: GuildFeatures[]; icon: null | string; iconHash: null | string; id: string; joinedAt: string; large: boolean; maxMembers: number; maxPresences: null | number; maxStageVideoChannelUsers: number; maxVideoChannelUsers: number; memberCount: number; members: object[]; mfaLevel: MfaLevels; name: string; nsfwLevel: GuildNsfwLevel; owner: boolean; ownerId: string; permissions: string; preferredLocale: string; premiumProgressBarEnabled: boolean; premiumSubscriptionCount: number; premiumTier: PremiumTiers; presences: object[]; publicUpdatesChannelId: null | string; roles: object[]; rulesChannelId: null | string; safetyAlertsChannelId: null | string; soundboardSounds: object[]; splash: null | string; stageInstances: object[]; stickers: object[]; systemChannelFlags: SystemChannelFlags; systemChannelId: null | string; threads: object[]; unavailable: boolean; vanityUrlCode: null | string; verificationLevel: VerificationLevels; voiceStates: object[]; welcomeScreen: { description: null | string; welcomeChannels: object[]; }; widgetChannelId: null | string; widgetEnabled: boolean; }; guildId: string; icon: null | string; id: string; installParams: { permissions: string; scopes: OAuth2Scope[]; }; integrationTypesConfig: { 0: { oauth2InstallParams: { permissions: string; scopes: ...[]; }; }; 1: { oauth2InstallParams: { permissions: string; scopes: ...[]; }; }; }; interactionsEndpointUrl: null | string; name: string; owner: { accentColor: number; avatar: null | string; avatarDecorationData: { asset: string; skuId: string; }; banner: string; bot: boolean; discriminator: string; email: null | string; flags: number; globalName: null | string; id: string; locale: string; mfaEnabled: boolean; premiumType: PremiumTypes; publicFlags: number; system: boolean; username: string; verified: boolean; }; primarySkuId: string; privacyPolicyUrl: string; redirectUris: string[]; roleConnectionsVerificationUrl: null | string; rpcOrigins: string[]; slug: string; tags: string[]; team: null | { icon: null | string; id: string; members: object[]; name: string; ownerUserId: string; }; termsOfServiceUrl: string; verifyKey: string; }; expires: string; scopes: OAuth2Scope[]; user: { accentColor: number; avatar: null | string; avatarDecorationData: { asset: string; skuId: string; }; banner: string; bot: boolean; discriminator: string; email: null | string; flags: number; globalName: null | string; id: string; locale: string; mfaEnabled: boolean; premiumType: PremiumTypes; publicFlags: number; system: boolean; username: string; verified: boolean; }; }>

Defined in: packages/rest/dist/types/types.d.ts:1403

Get the current authentication info for the authenticated user

Parameters

bearerToken

string

Any OAuth2 derived access token

Returns

Promise<{ application: { approximateGuildCount: number; approximateUserInstallCount: number; bot: { accentColor: number; avatar: null | string; avatarDecorationData: { asset: string; skuId: string; }; banner: string; bot: boolean; discriminator: string; email: null | string; flags: number; globalName: null | string; id: string; locale: string; mfaEnabled: boolean; premiumType: PremiumTypes; publicFlags: number; system: boolean; username: string; verified: boolean; }; botPublic: boolean; botRequireCodeGrant: boolean; coverImage: string; customInstallUrl: string; description: string; eventWebhooksStatus: DiscordApplicationEventWebhookStatus; eventWebhooksTypes: DiscordWebhookEventType[]; eventWebhooksUrl: null | string; flags: ApplicationFlags; guild: { afkChannelId: null | string; afkTimeout: number; applicationId: null | string; approximateMemberCount: number; approximatePresenceCount: number; banner: null | string; channels: object[]; defaultMessageNotifications: DefaultMessageNotificationLevels; description: null | string; discoverySplash: null | string; emojis: object[]; explicitContentFilter: ExplicitContentFilterLevels; features: GuildFeatures[]; icon: null | string; iconHash: null | string; id: string; joinedAt: string; large: boolean; maxMembers: number; maxPresences: null | number; maxStageVideoChannelUsers: number; maxVideoChannelUsers: number; memberCount: number; members: object[]; mfaLevel: MfaLevels; name: string; nsfwLevel: GuildNsfwLevel; owner: boolean; ownerId: string; permissions: string; preferredLocale: string; premiumProgressBarEnabled: boolean; premiumSubscriptionCount: number; premiumTier: PremiumTiers; presences: object[]; publicUpdatesChannelId: null | string; roles: object[]; rulesChannelId: null | string; safetyAlertsChannelId: null | string; soundboardSounds: object[]; splash: null | string; stageInstances: object[]; stickers: object[]; systemChannelFlags: SystemChannelFlags; systemChannelId: null | string; threads: object[]; unavailable: boolean; vanityUrlCode: null | string; verificationLevel: VerificationLevels; voiceStates: object[]; welcomeScreen: { description: null | string; welcomeChannels: object[]; }; widgetChannelId: null | string; widgetEnabled: boolean; }; guildId: string; icon: null | string; id: string; installParams: { permissions: string; scopes: OAuth2Scope[]; }; integrationTypesConfig: { 0: { oauth2InstallParams: { permissions: string; scopes: ...[]; }; }; 1: { oauth2InstallParams: { permissions: string; scopes: ...[]; }; }; }; interactionsEndpointUrl: null | string; name: string; owner: { accentColor: number; avatar: null | string; avatarDecorationData: { asset: string; skuId: string; }; banner: string; bot: boolean; discriminator: string; email: null | string; flags: number; globalName: null | string; id: string; locale: string; mfaEnabled: boolean; premiumType: PremiumTypes; publicFlags: number; system: boolean; username: string; verified: boolean; }; primarySkuId: string; privacyPolicyUrl: string; redirectUris: string[]; roleConnectionsVerificationUrl: null | string; rpcOrigins: string[]; slug: string; tags: string[]; team: null | { icon: null | string; id: string; members: object[]; name: string; ownerUserId: string; }; termsOfServiceUrl: string; verifyKey: string; }; expires: string; scopes: OAuth2Scope[]; user: { accentColor: number; avatar: null | string; avatarDecorationData: { asset: string; skuId: string; }; banner: string; bot: boolean; discriminator: string; email: null | string; flags: number; globalName: null | string; id: string; locale: string; mfaEnabled: boolean; premiumType: PremiumTypes; publicFlags: number; system: boolean; username: string; verified: boolean; }; }>

An instance of DiscordCurrentAuthorization

Remarks

The user object is not defined if the scopes do not include identify. In the user object, if defined, the email is not included if the scopes do not include email

getCurrentMember()

getCurrentMember: (guildId, bearerToken) => Promise<{ avatar: string; avatarDecorationData: null | { asset: string; skuId: string; }; banner: string; communicationDisabledUntil: null | string; deaf: boolean; flags: number; joinedAt: string; mute: boolean; nick: null | string; pending: boolean; permissions: string; premiumSince: null | string; roles: string[]; user: { accentColor: number; avatar: null | string; avatarDecorationData: { asset: string; skuId: string; }; banner: string; bot: boolean; discriminator: string; email: null | string; flags: number; globalName: null | string; id: string; locale: string; mfaEnabled: boolean; premiumType: PremiumTypes; publicFlags: number; system: boolean; username: string; verified: boolean; }; }>

Defined in: packages/rest/dist/types/types.d.ts:2632

Gets the current member object.

Parameters

guildId

https://discord.com/developers/docs/resources/user#get-current-user-guild-member

The ID of the guild to get the member object for.

bearerToken

string

The access token of the user

Returns

An instance of DiscordMemberWithUser.

Remarks

The access tokens needs the guilds.members.read scope

See

getCurrentUser()

getCurrentUser: (bearerToken) => Promise<{ accentColor: number; avatar: null | string; avatarDecorationData: { asset: string; skuId: string; }; banner: string; bot: boolean; discriminator: string; email: null | string; flags: number; globalName: null | string; id: string; locale: string; mfaEnabled: boolean; premiumType: PremiumTypes; publicFlags: number; system: boolean; username: string; verified: boolean; }>

Defined in: packages/rest/dist/types/types.d.ts:2130

Get the current user data.

Parameters

bearerToken

string

The access token of the user

Returns

Remarks

This requires the identify scope.

To get the mail this also requires the email scope

getDmChannel()

getDmChannel: (userId) => Promise<{ applicationId: string; appliedTags: string[]; availableTags: object[]; bitrate: number; defaultAutoArchiveDuration: number; defaultForumLayout: ForumLayout; defaultReactionEmoji: null | { emojiId: string; emojiName: null | string; }; defaultSortOrder: null | SortOrderTypes; defaultThreadRateLimitPerUser: number; flags: ChannelFlags; guildId: string; icon: string; id: string; lastMessageId: null | string; lastPinTimestamp: null | string; managed: boolean; member: { flags: number; id: string; joinTimestamp: string; userId: string; }; memberCount: number; messageCount: number; name: string; newlyCreated: boolean; nsfw: boolean; ownerId: string; parentId: null | string; permissionOverwrites: object[]; permissions: string; position: number; rateLimitPerUser: number; recipients: object[]; rtcRegion: null | string; threadMetadata: { archived: boolean; archiveTimestamp: string; autoArchiveDuration: 60 | 1440 | 4320 | 10080; createTimestamp: null | string; invitable: boolean; locked: boolean; }; topic: null | string; totalMessageSent: number; type: ChannelTypes; userLimit: number; videoQualityMode: VideoQualityModes; }>

Defined in: packages/rest/dist/types/types.d.ts:1577

Gets or creates a DM channel with a user.

Parameters

userId

https://discord.com/developers/docs/resources/user#create-dm

The ID of the user to create the DM channel with.

Returns

An instance of DiscordChannel.

See

getEmoji()

getEmoji: (guildId, emojiId) => Promise<{ animated: boolean; available: boolean; id: string; managed: boolean; name: string; requireColons: boolean; roles: string[]; user: { accentColor: number; avatar: null | string; avatarDecorationData: { asset: string; skuId: string; }; banner: string; bot: boolean; discriminator: string; email: null | string; flags: number; globalName: null | string; id: string; locale: string; mfaEnabled: boolean; premiumType: PremiumTypes; publicFlags: number; system: boolean; username: string; verified: boolean; }; }>

Defined in: packages/rest/dist/types/types.d.ts:1607

Gets an emoji by its ID.

Parameters

guildId

The ID of the guild from which to get the emoji.

emojiId

https://discord.com/developers/docs/resources/emoji#get-guild-emoji

The ID of the emoji to get.

Returns

An instance of DiscordEmoji.

Remarks

Includes the user field if the bot has the MANAGE_GUILD_EXPRESSIONS permission, or if the bot created the emoji and has the the CREATE_GUILD_EXPRESSIONS permission.

See

getEmojis()

getEmojis: (guildId) => Promise<object[]>

Defined in: packages/rest/dist/types/types.d.ts:1631

Gets the list of emojis for a guild.

Parameters

guildId

https://discord.com/developers/docs/resources/emoji#list-guild-emojis

The ID of the guild which to get the emojis of.

Returns

Promise<object[]>

A collection of DiscordEmoji objects assorted by emoji ID.

Remarks

Includes user fields if the bot has the CREATE_GUILD_EXPRESSIONS or MANAGE_GUILD_EXPRESSIONS permission.

See

getEntitlement()

getEntitlement: (applicationId, entitlementId) => Promise<{ applicationId: string; consumed: boolean; deleted: boolean; endsAt: null | string; guildId: string; id: string; skuId: string; startsAt: null | string; type: DiscordEntitlementType; userId: string; }>

Defined in: packages/rest/dist/types/types.d.ts:2797

Returns an entitlement.

Parameters

applicationId

The id of the application to get the entitlement

entitlementId

The id of the entitlement to get

Returns

Promise<{ applicationId: string; consumed: boolean; deleted: boolean; endsAt: null | string; guildId: string; id: string; skuId: string; startsAt: null | string; type: DiscordEntitlementType; userId: string; }>

getFollowupMessage()

getFollowupMessage: (token, messageId) => Promise<{ activity: { partyId: string; type: MessageActivityTypes; }; application: { approximateGuildCount: number; approximateUserInstallCount: number; bot: { accentColor: number; avatar: null | string; avatarDecorationData: { asset: string; skuId: string; }; banner: string; bot: boolean; discriminator: string; email: null | string; flags: number; globalName: null | string; id: string; locale: string; mfaEnabled: boolean; premiumType: PremiumTypes; publicFlags: number; system: boolean; username: string; verified: boolean; }; botPublic: boolean; botRequireCodeGrant: boolean; coverImage: string; customInstallUrl: string; description: string; eventWebhooksStatus: DiscordApplicationEventWebhookStatus; eventWebhooksTypes: DiscordWebhookEventType[]; eventWebhooksUrl: null | string; flags: ApplicationFlags; guild: { afkChannelId: null | string; afkTimeout: number; applicationId: null | string; approximateMemberCount: number; approximatePresenceCount: number; banner: null | string; channels: object[]; defaultMessageNotifications: DefaultMessageNotificationLevels; description: null | string; discoverySplash: null | string; emojis: object[]; explicitContentFilter: ExplicitContentFilterLevels; features: GuildFeatures[]; icon: null | string; iconHash: null | string; id: string; joinedAt: string; large: boolean; maxMembers: number; maxPresences: null | number; maxStageVideoChannelUsers: number; maxVideoChannelUsers: number; memberCount: number; members: object[]; mfaLevel: MfaLevels; name: string; nsfwLevel: GuildNsfwLevel; owner: boolean; ownerId: string; permissions: string; preferredLocale: string; premiumProgressBarEnabled: boolean; premiumSubscriptionCount: number; premiumTier: PremiumTiers; presences: object[]; publicUpdatesChannelId: null | string; roles: object[]; rulesChannelId: null | string; safetyAlertsChannelId: null | string; soundboardSounds: object[]; splash: null | string; stageInstances: object[]; stickers: object[]; systemChannelFlags: SystemChannelFlags; systemChannelId: null | string; threads: object[]; unavailable: boolean; vanityUrlCode: null | string; verificationLevel: VerificationLevels; voiceStates: object[]; welcomeScreen: { description: null | string; welcomeChannels: object[]; }; widgetChannelId: null | string; widgetEnabled: boolean; }; guildId: string; icon: null | string; id: string; installParams: { permissions: string; scopes: OAuth2Scope[]; }; integrationTypesConfig: { 0: { oauth2InstallParams: { permissions: ...; scopes: ...; }; }; 1: { oauth2InstallParams: { permissions: ...; scopes: ...; }; }; }; interactionsEndpointUrl: null | string; name: string; owner: { accentColor: number; avatar: null | string; avatarDecorationData: { asset: string; skuId: string; }; banner: string; bot: boolean; discriminator: string; email: null | string; flags: number; globalName: null | string; id: string; locale: string; mfaEnabled: boolean; premiumType: PremiumTypes; publicFlags: number; system: boolean; username: string; verified: boolean; }; primarySkuId: string; privacyPolicyUrl: string; redirectUris: string[]; roleConnectionsVerificationUrl: null | string; rpcOrigins: string[]; slug: string; tags: string[]; team: null | { icon: null | string; id: string; members: object[]; name: string; ownerUserId: string; }; termsOfServiceUrl: string; verifyKey: string; }; applicationId: string; attachments: object[]; author: { accentColor: number; avatar: null | string; avatarDecorationData: { asset: string; skuId: string; }; banner: string; bot: boolean; discriminator: string; email: null | string; flags: number; globalName: null | string; id: string; locale: string; mfaEnabled: boolean; premiumType: PremiumTypes; publicFlags: number; system: boolean; username: string; verified: boolean; }; call: { endedTimestamp: string; participants: string[]; }; channelId: string; components: ({ components: ({ channelTypes: ... | ...; customId: string; defaultValues: ... | ...; disabled: ... | ... | ...; maxValues: ... | ...; minValues: ... | ...; options: ... | ...; placeholder: ... | ...; type: ... | ... | ... | ... | ...; } | { customId: ... | ...; disabled: ... | ... | ...; emoji: ... | ...; label: ... | ...; skuId: ... | ...; style: ButtonStyles; type: Button; url: ... | ...; } | { customId: string; label: string; maxLength: ... | ...; minLength: ... | ...; placeholder: ... | ...; required: ... | ... | ...; style: TextStyles; type: InputText; value: ... | ...; })[]; type: ActionRow; } | { channelTypes: ChannelTypes[]; customId: string; defaultValues: object[]; disabled: boolean; maxValues: number; minValues: number; options: object[]; placeholder: string; type: SelectMenu | SelectMenuUsers | SelectMenuRoles | SelectMenuUsersAndRoles | SelectMenuChannels; } | { customId: string; disabled: boolean; emoji: { animated: boolean; id: string; name: string; }; label: string; skuId: string; style: ButtonStyles; type: Button; url: string; } | { customId: string; label: string; maxLength: number; minLength: number; placeholder: string; required: boolean; style: TextStyles; type: InputText; value: string; })[]; content: string; editedTimestamp: null | string; embeds: object[]; flags: MessageFlags; guildId: string; id: string; interaction: { id: string; member: { avatar: string; avatarDecorationData: null | { asset: string; skuId: string; }; banner: string; communicationDisabledUntil: null | string; deaf: boolean; flags: number; joinedAt: string; mute: boolean; nick: null | string; pending: boolean; permissions: string; premiumSince: null | string; roles: string[]; user: { accentColor: number; avatar: null | string; avatarDecorationData: { asset: ...; skuId: ...; }; banner: string; bot: boolean; discriminator: string; email: null | string; flags: number; globalName: null | string; id: string; locale: string; mfaEnabled: boolean; premiumType: PremiumTypes; publicFlags: number; system: boolean; username: string; verified: boolean; }; }; name: string; type: InteractionTypes; user: { accentColor: number; avatar: null | string; avatarDecorationData: { asset: string; skuId: string; }; banner: string; bot: boolean; discriminator: string; email: null | string; flags: number; globalName: null | string; id: string; locale: string; mfaEnabled: boolean; premiumType: PremiumTypes; publicFlags: number; system: boolean; username: string; verified: boolean; }; }; interactionMetadata: { authorizingIntegrationOwners: { 0: string; 1: string; }; id: string; originalResponseMessageId: string; targetMessageId: string; targetUser: { accentColor: number; avatar: null | string; avatarDecorationData: { asset: string; skuId: string; }; banner: string; bot: boolean; discriminator: string; email: null | string; flags: number; globalName: null | string; id: string; locale: string; mfaEnabled: boolean; premiumType: PremiumTypes; publicFlags: number; system: boolean; username: string; verified: boolean; }; type: InteractionTypes; user: { accentColor: number; avatar: null | string; avatarDecorationData: { asset: string; skuId: string; }; banner: string; bot: boolean; discriminator: string; email: null | string; flags: number; globalName: null | string; id: string; locale: string; mfaEnabled: boolean; premiumType: PremiumTypes; publicFlags: number; system: boolean; username: string; verified: boolean; }; } | { authorizingIntegrationOwners: { 0: string; 1: string; }; id: string; interactedMessageId: string; originalResponseMessageId: string; type: InteractionTypes; user: { accentColor: number; avatar: null | string; avatarDecorationData: { asset: string; skuId: string; }; banner: string; bot: boolean; discriminator: string; email: null | string; flags: number; globalName: null | string; id: string; locale: string; mfaEnabled: boolean; premiumType: PremiumTypes; publicFlags: number; system: boolean; username: string; verified: boolean; }; } | { authorizingIntegrationOwners: { 0: string; 1: string; }; id: string; originalResponseMessageId: string; triggeringInteractionMetadata: { id: string; type: InteractionTypes; user: { username: string; globalName: string | null; locale?: string | undefined; flags?: number | undefined; premiumType?: PremiumTypes | undefined; ... 11 more ...; avatarDecorationData?: { ...; } | undefined; }; authorizingIntegrationOwners: { ...; }; originalResponseMessageI...; type: InteractionTypes; user: { accentColor: number; avatar: null | string; avatarDecorationData: { asset: string; skuId: string; }; banner: string; bot: boolean; discriminator: string; email: null | string; flags: number; globalName: null | string; id: string; locale: string; mfaEnabled: boolean; premiumType: PremiumTypes; publicFlags: number; system: boolean; username: string; verified: boolean; }; }; member: { avatar: string; avatarDecorationData: null | { asset: string; skuId: string; }; banner: string; communicationDisabledUntil: null | string; deaf: boolean; flags: number; joinedAt: string; mute: boolean; nick: null | string; pending: boolean; permissions: string; premiumSince: null | string; roles: string[]; user: { accentColor: number; avatar: null | string; avatarDecorationData: { asset: string; skuId: string; }; banner: string; bot: boolean; discriminator: string; email: null | string; flags: number; globalName: null | string; id: string; locale: string; mfaEnabled: boolean; premiumType: PremiumTypes; publicFlags: number; system: boolean; username: string; verified: boolean; }; }; mentionChannels: object[]; mentionEveryone: boolean; mentionRoles: string[]; mentions: object[]; messageReference: { channelId: string; failIfNotExists: boolean; guildId: string; messageId: string; type: DiscordMessageReferenceType; }; messageSnapshots: object[]; nonce: string | number; pinned: boolean; poll: { allowMultiselect: boolean; answers: object[]; expiry: null | string; layoutType: Default; question: { emoji: { animated: boolean; available: boolean; id: string; managed: boolean; name: string; requireColons: boolean; roles: string[]; user: { accentColor: ... | ...; avatar: ... | ...; avatarDecorationData: ... | ...; banner: ... | ...; bot: ... | ... | ...; discriminator: string; email: ... | ... | ...; flags: ... | ...; globalName: ... | ...; id: string; locale: ... | ...; mfaEnabled: ... | ... | ...; premiumType: ... | ...; publicFlags: ... | ...; system: ... | ... | ...; username: string; verified: ... | ... | ...; }; }; text: string; }; results: { answerCounts: object[]; isFinalized: boolean; }; }; position: number; reactions: object[]; referencedMessage: { id: string; channelId: string; guildId?: string | undefined; author: { username: string; globalName: string | null; locale?: string | undefined; flags?: number | undefined; premiumType?: PremiumTypes | undefined; ... 11 more ...; avatarDecorationData?: { ...; } | undefined; }; ... 31 more ...; call?: { ...; } | un...; stickerItems: object[]; stickers: object[]; thread: { applicationId: string; appliedTags: string[]; availableTags: object[]; bitrate: number; defaultAutoArchiveDuration: number; defaultForumLayout: ForumLayout; defaultReactionEmoji: null | { emojiId: string; emojiName: null | string; }; defaultSortOrder: null | SortOrderTypes; defaultThreadRateLimitPerUser: number; flags: ChannelFlags; guildId: string; icon: string; id: string; lastMessageId: null | string; lastPinTimestamp: null | string; managed: boolean; member: { flags: number; id: string; joinTimestamp: string; userId: string; }; memberCount: number; messageCount: number; name: string; newlyCreated: boolean; nsfw: boolean; ownerId: string; parentId: null | string; permissionOverwrites: object[]; permissions: string; position: number; rateLimitPerUser: number; recipients: object[]; rtcRegion: null | string; threadMetadata: { archived: boolean; archiveTimestamp: string; autoArchiveDuration: 60 | 1440 | 4320 | 10080; createTimestamp: null | string; invitable: boolean; locked: boolean; }; topic: null | string; totalMessageSent: number; type: ChannelTypes; userLimit: number; videoQualityMode: VideoQualityModes; }; timestamp: string; tts: boolean; type: MessageTypes; webhookId: string; }>

Defined in: packages/rest/dist/types/types.d.ts:1661

Gets a follow-up message to an interaction by the ID of the message.

Parameters

token

string

The interaction token to use, provided in the original interaction.

messageId

https://discord.com/developers/docs/interactions/receiving-and-responding#get-followup-message

The ID of the message to get.

Returns

An instance of DiscordMessage.

Remarks

Unlike getMessage(), this endpoint allows the bot user to act without:

Needing to be able to see the contents of the channel that the message is in. (READ_MESSAGES permission.)
Requiring the MESSAGE_CONTENT intent.

Does not support ephemeral follow-up messages due to these being stateless.

See

getGatewayBot()

getGatewayBot: () => Promise<{ sessionStartLimit: { maxConcurrency: number; remaining: number; resetAfter: number; total: number; }; shards: number; url: string; }>

Defined in: packages/rest/dist/types/types.d.ts:1663

Get the bots Gateway metadata that can help during the operation of large or sharded bots.

Returns

Promise<{ sessionStartLimit: { maxConcurrency: number; remaining: number; resetAfter: number; total: number; }; shards: number; url: string; }>

getGlobalApplicationCommand()

getGlobalApplicationCommand: (commandId) => Promise<{ applicationId: string; contexts: null | DiscordInteractionContextType[]; defaultMemberPermissions: null | string; description: string; descriptionLocalizations: null | { bg: string; cs: string; da: string; de: string; el: string; en-GB: string; en-US: string; es-419: string; es-ES: string; fi: string; fr: string; hi: string; hr: string; hu: string; id: string; it: string; ja: string; ko: string; lt: string; nl: string; no: string; pl: string; pt-BR: string; ro: string; ru: string; sv-SE: string; th: string; tr: string; uk: string; vi: string; zh-CN: string; zh-TW: string; }; dmPermission: boolean; guildId: string; handler: DiscordInteractionEntryPointCommandHandlerType; id: string; integrationTypes: DiscordApplicationIntegrationType[]; name: string; nameLocalizations: null | { bg: string; cs: string; da: string; de: string; el: string; en-GB: string; en-US: string; es-419: string; es-ES: string; fi: string; fr: string; hi: string; hr: string; hu: string; id: string; it: string; ja: string; ko: string; lt: string; nl: string; no: string; pl: string; pt-BR: string; ro: string; ru: string; sv-SE: string; th: string; tr: string; uk: string; vi: string; zh-CN: string; zh-TW: string; }; nsfw: boolean; options: object[]; type: ApplicationCommandTypes; version: string; }>

Defined in: packages/rest/dist/types/types.d.ts:1672

Gets a global application command by its ID.

Parameters

commandId

https://discord.com/developers/docs/interactions/application-commands#get-global-application-command

The ID of the command to get.

Returns

An instance of DiscordApplicationCommand.

See

getGlobalApplicationCommands()

getGlobalApplicationCommands: () => Promise<object[]>

Defined in: packages/rest/dist/types/types.d.ts:1680

Gets the list of your bot's global application commands.

Returns

Promise<object[]>

A collection of DiscordApplicationCommand objects assorted by command ID.

See

https://discord.com/developers/docs/interactions/application-commands#get-global-application-commands

getGroupDmChannel()

getGroupDmChannel: (options) => Promise<{ applicationId: string; appliedTags: string[]; availableTags: object[]; bitrate: number; defaultAutoArchiveDuration: number; defaultForumLayout: ForumLayout; defaultReactionEmoji: null | { emojiId: string; emojiName: null | string; }; defaultSortOrder: null | SortOrderTypes; defaultThreadRateLimitPerUser: number; flags: ChannelFlags; guildId: string; icon: string; id: string; lastMessageId: null | string; lastPinTimestamp: null | string; managed: boolean; member: { flags: number; id: string; joinTimestamp: string; userId: string; }; memberCount: number; messageCount: number; name: string; newlyCreated: boolean; nsfw: boolean; ownerId: string; parentId: null | string; permissionOverwrites: object[]; permissions: string; position: number; rateLimitPerUser: number; recipients: object[]; rtcRegion: null | string; threadMetadata: { archived: boolean; archiveTimestamp: string; autoArchiveDuration: 60 | 1440 | 4320 | 10080; createTimestamp: null | string; invitable: boolean; locked: boolean; }; topic: null | string; totalMessageSent: number; type: ChannelTypes; userLimit: number; videoQualityMode: VideoQualityModes; }>

Defined in: packages/rest/dist/types/types.d.ts:1593

Create a new group DM channel with multiple users.

Parameters

options

GetGroupDmOptions

The options for create a new group dm

Returns

An instance of DiscordChannel.

Remarks

The access tokens require to have the gdm.join scope

This endpoint is limited to 10 active group DMs.

Fires a Channel create gateway event.

See

https://discord.com/developers/docs/resources/user#create-group-dm

getGuild()

getGuild: (guildId, options?) => Promise<{ afkChannelId: null | string; afkTimeout: number; applicationId: null | string; approximateMemberCount: number; approximatePresenceCount: number; banner: null | string; channels: object[]; defaultMessageNotifications: DefaultMessageNotificationLevels; description: null | string; discoverySplash: null | string; emojis: object[]; explicitContentFilter: ExplicitContentFilterLevels; features: GuildFeatures[]; icon: null | string; iconHash: null | string; id: string; joinedAt: string; large: boolean; maxMembers: number; maxPresences: null | number; maxStageVideoChannelUsers: number; maxVideoChannelUsers: number; memberCount: number; members: object[]; mfaLevel: MfaLevels; name: string; nsfwLevel: GuildNsfwLevel; owner: boolean; ownerId: string; permissions: string; preferredLocale: string; premiumProgressBarEnabled: boolean; premiumSubscriptionCount: number; premiumTier: PremiumTiers; presences: object[]; publicUpdatesChannelId: null | string; roles: object[]; rulesChannelId: null | string; safetyAlertsChannelId: null | string; soundboardSounds: object[]; splash: null | string; stageInstances: object[]; stickers: object[]; systemChannelFlags: SystemChannelFlags; systemChannelId: null | string; threads: object[]; unavailable: boolean; vanityUrlCode: null | string; verificationLevel: VerificationLevels; voiceStates: object[]; welcomeScreen: { description: null | string; welcomeChannels: object[]; }; widgetChannelId: null | string; widgetEnabled: boolean; }>

Defined in: packages/rest/dist/types/types.d.ts:1690

Gets a guild by its ID.

Parameters

guildId

https://discord.com/developers/docs/resources/guild#get-guild

The ID of the guild to get.

options?

The parameters for the fetching of the guild.

counts

boolean

Returns

An instance of DiscordGuild.

See

getGuildApplicationCommand()

getGuildApplicationCommand: (commandId, guildId) => Promise<{ applicationId: string; contexts: null | DiscordInteractionContextType[]; defaultMemberPermissions: null | string; description: string; descriptionLocalizations: null | { bg: string; cs: string; da: string; de: string; el: string; en-GB: string; en-US: string; es-419: string; es-ES: string; fi: string; fr: string; hi: string; hr: string; hu: string; id: string; it: string; ja: string; ko: string; lt: string; nl: string; no: string; pl: string; pt-BR: string; ro: string; ru: string; sv-SE: string; th: string; tr: string; uk: string; vi: string; zh-CN: string; zh-TW: string; }; dmPermission: boolean; guildId: string; handler: DiscordInteractionEntryPointCommandHandlerType; id: string; integrationTypes: DiscordApplicationIntegrationType[]; name: string; nameLocalizations: null | { bg: string; cs: string; da: string; de: string; el: string; en-GB: string; en-US: string; es-419: string; es-ES: string; fi: string; fr: string; hi: string; hr: string; hu: string; id: string; it: string; ja: string; ko: string; lt: string; nl: string; no: string; pl: string; pt-BR: string; ro: string; ru: string; sv-SE: string; th: string; tr: string; uk: string; vi: string; zh-CN: string; zh-TW: string; }; nsfw: boolean; options: object[]; type: ApplicationCommandTypes; version: string; }>

Defined in: packages/rest/dist/types/types.d.ts:1715

Gets a guild application command by its ID.

Parameters

commandId

The ID of the command to get.

guildId

https://discord.com/developers/docs/interactions/application-commands#get-guild-application-command

The ID of the guild the command is registered in.

Returns

An instance of DiscordApplicationCommand.

See

getGuildApplicationCommands()

getGuildApplicationCommands: (guildId) => Promise<object[]>

Defined in: packages/rest/dist/types/types.d.ts:1724

Gets the list of application commands registered by your bot in a guild.

Parameters

guildId

https://discord.com/developers/docs/interactions/application-commands#get-global-application-commandss

The ID of the guild the commands are registered in.

Returns

Promise<object[]>

A collection of DiscordApplicationCommand objects assorted by command ID.

See

getGuildOnboarding()

getGuildOnboarding: (guildId) => Promise<{ defaultChannelIds: string[]; enabled: boolean; guildId: string; mode: DiscordGuildOnboardingMode; prompts: object[]; }>

Defined in: packages/rest/dist/types/types.d.ts:2767

Get the guild onboarding

Parameters

guildId

The guild to get the onboarding from

Returns

Promise<{ defaultChannelIds: string[]; enabled: boolean; guildId: string; mode: DiscordGuildOnboardingMode; prompts: object[]; }>

getGuildPreview()

getGuildPreview: (guildId) => Promise<{ approximateMemberCount: number; approximatePresenceCount: number; description: null | string; discoverySplash: null | string; emojis: object[]; features: GuildFeatures[]; icon: null | string; id: string; name: string; splash: null | string; stickers: object[]; }>

Defined in: packages/rest/dist/types/types.d.ts:1736

Gets the preview of a guild by a guild's ID.

Parameters

guildId

https://discord.com/developers/docs/resources/guild#get-guild-preview

The ID of the guild to get the preview of.

Returns

Promise<{ approximateMemberCount: number; approximatePresenceCount: number; description: null | string; discoverySplash: null | string; emojis: object[]; features: GuildFeatures[]; icon: null | string; id: string; name: string; splash: null | string; stickers: object[]; }>

An instance of DiscordGuildPreview.

Remarks

If the bot user is not in the guild, the guild must be discoverable.

See

getGuilds()

getGuilds: (bearerToken?, options?) => Promise<Partial<{ afkChannelId: null | string; afkTimeout: number; applicationId: null | string; approximateMemberCount: number; approximatePresenceCount: number; banner: null | string; channels: object[]; defaultMessageNotifications: DefaultMessageNotificationLevels; description: null | string; discoverySplash: null | string; emojis: object[]; explicitContentFilter: ExplicitContentFilterLevels; features: GuildFeatures[]; icon: null | string; iconHash: null | string; id: string; joinedAt: string; large: boolean; maxMembers: number; maxPresences: null | number; maxStageVideoChannelUsers: number; maxVideoChannelUsers: number; memberCount: number; members: object[]; mfaLevel: MfaLevels; name: string; nsfwLevel: GuildNsfwLevel; owner: boolean; ownerId: string; permissions: string; preferredLocale: string; premiumProgressBarEnabled: boolean; premiumSubscriptionCount: number; premiumTier: PremiumTiers; presences: object[]; publicUpdatesChannelId: null | string; roles: object[]; rulesChannelId: null | string; safetyAlertsChannelId: null | string; soundboardSounds: object[]; splash: null | string; stageInstances: object[]; stickers: object[]; systemChannelFlags: SystemChannelFlags; systemChannelId: null | string; threads: object[]; unavailable: boolean; vanityUrlCode: null | string; verificationLevel: VerificationLevels; voiceStates: object[]; welcomeScreen: { description: null | string; welcomeChannels: object[]; }; widgetChannelId: null | string; widgetEnabled: boolean; }>[]>

Defined in: packages/rest/dist/types/types.d.ts:1705

Get the user guilds.

Parameters

bearerToken?

string

The access token of the user, if unspecified the bot token is used instead

options?

GetUserGuilds

The parameters for the fetching of the guild.

Returns

Promise<Partial<{ afkChannelId: null | string; afkTimeout: number; applicationId: null | string; approximateMemberCount: number; approximatePresenceCount: number; banner: null | string; channels: object[]; defaultMessageNotifications: DefaultMessageNotificationLevels; description: null | string; discoverySplash: null | string; emojis: object[]; explicitContentFilter: ExplicitContentFilterLevels; features: GuildFeatures[]; icon: null | string; iconHash: null | string; id: string; joinedAt: string; large: boolean; maxMembers: number; maxPresences: null | number; maxStageVideoChannelUsers: number; maxVideoChannelUsers: number; memberCount: number; members: object[]; mfaLevel: MfaLevels; name: string; nsfwLevel: GuildNsfwLevel; owner: boolean; ownerId: string; permissions: string; preferredLocale: string; premiumProgressBarEnabled: boolean; premiumSubscriptionCount: number; premiumTier: PremiumTiers; presences: object[]; publicUpdatesChannelId: null | string; roles: object[]; rulesChannelId: null | string; safetyAlertsChannelId: null | string; soundboardSounds: object[]; splash: null | string; stageInstances: object[]; stickers: object[]; systemChannelFlags: SystemChannelFlags; systemChannelId: null | string; threads: object[]; unavailable: boolean; vanityUrlCode: null | string; verificationLevel: VerificationLevels; voiceStates: object[]; welcomeScreen: { description: null | string; welcomeChannels: object[]; }; widgetChannelId: null | string; widgetEnabled: boolean; }>[]>

An array of partial DiscordGuild.

Remarks

If used with an access token, the token needs to have the guilds scope

See

https://discord.com/developers/docs/resources/user#get-current-user-guilds

getGuildSoundboardSound()

getGuildSoundboardSound: (guildId, soundId) => Promise<{ available: boolean; emojiId: null | string; emojiName: null | string; guildId: string; name: string; soundId: string; user: { accentColor: number; avatar: null | string; avatarDecorationData: { asset: string; skuId: string; }; banner: string; bot: boolean; discriminator: string; email: null | string; flags: number; globalName: null | string; id: string; locale: string; mfaEnabled: boolean; premiumType: PremiumTypes; publicFlags: number; system: boolean; username: string; verified: boolean; }; volume: number; }>

Defined in: packages/rest/dist/types/types.d.ts:2875

Returns a soundboard sound object for the given sound id.

Parameters

guildId

The guild to get the sounds from

soundId

The sound id

Returns

Remarks

Includes user fields if the bot has the CREATE_GUILD_EXPRESSIONS or MANAGE_GUILD_EXPRESSIONS permission.

getGuildSticker()

getGuildSticker: (guildId, stickerId) => Promise<{ available: boolean; description: string; formatType: StickerFormatTypes; guildId: string; id: string; name: string; packId: string; sortValue: number; tags: string; type: StickerTypes; user: { accentColor: number; avatar: null | string; avatarDecorationData: { asset: string; skuId: string; }; banner: string; bot: boolean; discriminator: string; email: null | string; flags: number; globalName: null | string; id: string; locale: string; mfaEnabled: boolean; premiumType: PremiumTypes; publicFlags: number; system: boolean; username: string; verified: boolean; }; }>

Defined in: packages/rest/dist/types/types.d.ts:1748

Returns a sticker object for the given guild and sticker IDs.

Parameters

guildId

The ID of the guild to get

stickerId

The ID of the sticker to get

Returns

https://discord.com/developers/docs/resources/sticker#get-guild-sticker

Remarks

Includes the user field if the bot has the CREATE_GUILD_EXPRESSIONS or MANAGE_GUILD_EXPRESSIONS permission.

See

getGuildStickers()

getGuildStickers: (guildId) => Promise<object[]>

Defined in: packages/rest/dist/types/types.d.ts:1759

Returns an array of sticker objects for the given guild.

Parameters

guildId

https://discord.com/developers/docs/resources/sticker#list-guild-stickers

The ID of the guild to get

Returns

Promise<object[]>

A collection of DiscordSticker objects assorted by sticker ID.

Remarks

Includes user fields if the bot has the CREATE_GUILD_EXPRESSIONS or MANAGE_GUILD_EXPRESSIONS permission.

See

getGuildTemplate()

getGuildTemplate: (templateCode) => Promise<{ code: string; createdAt: string; creator: { accentColor: number; avatar: null | string; avatarDecorationData: { asset: string; skuId: string; }; banner: string; bot: boolean; discriminator: string; email: null | string; flags: number; globalName: null | string; id: string; locale: string; mfaEnabled: boolean; premiumType: PremiumTypes; publicFlags: number; system: boolean; username: string; verified: boolean; }; creatorId: string; description: null | string; isDirty: null | boolean; name: string; serializedSourceGuild: { afkChannelId: null | number; afkTimeout: number; applicationId: null | string; approximateMemberCount: number; approximatePresenceCount: number; banner: null | string; channels: object[]; defaultMessageNotifications: DefaultMessageNotificationLevels; description: null | string; discoverySplash: null | string; emojis: object[]; explicitContentFilter: ExplicitContentFilterLevels; features: GuildFeatures[]; icon: null | string; iconHash: null | string; id: string; joinedAt: string; large: boolean; maxMembers: number; maxPresences: null | number; maxStageVideoChannelUsers: number; maxVideoChannelUsers: number; memberCount: number; members: object[]; mfaLevel: MfaLevels; name: string; nsfwLevel: GuildNsfwLevel; owner: boolean; ownerId: string; permissions: string; preferredLocale: string; premiumProgressBarEnabled: boolean; premiumSubscriptionCount: number; premiumTier: PremiumTiers; presences: object[]; publicUpdatesChannelId: null | string; roles: object[]; rulesChannelId: null | string; safetyAlertsChannelId: null | string; soundboardSounds: object[]; splash: null | string; stageInstances: object[]; stickers: object[]; systemChannelFlags: SystemChannelFlags; systemChannelId: null | number; threads: object[]; unavailable: boolean; vanityUrlCode: null | string; verificationLevel: VerificationLevels; voiceStates: object[]; welcomeScreen: { description: null | string; welcomeChannels: object[]; }; widgetChannelId: null | string; widgetEnabled: boolean; }; sourceGuildId: string; updatedAt: string; usageCount: number; }>

Defined in: packages/rest/dist/types/types.d.ts:1771

Gets a template by its code.

Parameters

templateCode

string

The code of the template to get.

Returns

An instance of DiscordTemplate.

Remarks

Requires the MANAGE_GUILD permission.

See

https://discord.com/developers/docs/resources/guild-template#get-guild-template

getGuildTemplates()

getGuildTemplates: (guildId) => Promise<object[]>

Defined in: packages/rest/dist/types/types.d.ts:1783

Gets the list of templates for a guild.

Parameters

guildId

https://discord.com/developers/docs/resources/guild-template#get-guild-templates

The ID of the guild to get the list of templates for.

Returns

Promise<object[]>

A collection of DiscordTemplate objects assorted by template code.

Remarks

Requires the MANAGE_GUILD permission.

See

getGuildWebhooks()

getGuildWebhooks: (guildId) => Promise<Camelize<DiscordWebhook>[]>

Defined in: packages/rest/dist/types/types.d.ts:1795

Gets the list of webhooks for a guild.

Parameters

guildId

https://discord.com/developers/docs/resources/webhook#get-guild-webhooks

The ID of the guild to get the list of webhooks for.

Returns

Promise<Camelize<DiscordWebhook>[]>

A collection of DiscordWebhook objects assorted by webhook ID.

Remarks

Requires the MANAGE_WEBHOOKS permission.

See

getIntegrations()

getIntegrations: (guildId) => Promise<object[]>

Defined in: packages/rest/dist/types/types.d.ts:1807

Gets the list of integrations attached to a guild.

Parameters

guildId

https://discord.com/developers/docs/resources/guild#get-guild-integrations

The ID of the guild to get the list of integrations from.

Returns

Promise<object[]>

A collection of DiscordIntegration objects assorted by integration ID.

Remarks

Requires the MANAGE_GUILD permission.

See

getInvite()

getInvite: (inviteCode, options?) => Promise<{ approximateMemberCount: number; approximatePresenceCount: number; channel: null | { applicationId: string; appliedTags: string[]; availableTags: object[]; bitrate: number; defaultAutoArchiveDuration: number; defaultForumLayout: ForumLayout; defaultReactionEmoji: null | { emojiId: string; emojiName: null | string; }; defaultSortOrder: null | SortOrderTypes; defaultThreadRateLimitPerUser: number; flags: ChannelFlags; guildId: string; icon: string; id: string; lastMessageId: null | string; lastPinTimestamp: null | string; managed: boolean; member: { flags: number; id: string; joinTimestamp: string; userId: string; }; memberCount: number; messageCount: number; name: string; newlyCreated: boolean; nsfw: boolean; ownerId: string; parentId: null | string; permissionOverwrites: object[]; permissions: string; position: number; rateLimitPerUser: number; recipients: object[]; rtcRegion: null | string; threadMetadata: { archived: boolean; archiveTimestamp: string; autoArchiveDuration: 60 | 1440 | 4320 | 10080; createTimestamp: null | string; invitable: boolean; locked: boolean; }; topic: null | string; totalMessageSent: number; type: ChannelTypes; userLimit: number; videoQualityMode: VideoQualityModes; }; code: string; createdAt: string; expiresAt: null | string; guild: { afkChannelId: null | string; afkTimeout: number; applicationId: null | string; approximateMemberCount: number; approximatePresenceCount: number; banner: null | string; channels: object[]; defaultMessageNotifications: DefaultMessageNotificationLevels; description: null | string; discoverySplash: null | string; emojis: object[]; explicitContentFilter: ExplicitContentFilterLevels; features: GuildFeatures[]; icon: null | string; iconHash: null | string; id: string; joinedAt: string; large: boolean; maxMembers: number; maxPresences: null | number; maxStageVideoChannelUsers: number; maxVideoChannelUsers: number; memberCount: number; members: object[]; mfaLevel: MfaLevels; name: string; nsfwLevel: GuildNsfwLevel; owner: boolean; ownerId: string; permissions: string; preferredLocale: string; premiumProgressBarEnabled: boolean; premiumSubscriptionCount: number; premiumTier: PremiumTiers; presences: object[]; publicUpdatesChannelId: null | string; roles: object[]; rulesChannelId: null | string; safetyAlertsChannelId: null | string; soundboardSounds: object[]; splash: null | string; stageInstances: object[]; stickers: object[]; systemChannelFlags: SystemChannelFlags; systemChannelId: null | string; threads: object[]; unavailable: boolean; vanityUrlCode: null | string; verificationLevel: VerificationLevels; voiceStates: object[]; welcomeScreen: { description: null | string; welcomeChannels: object[]; }; widgetChannelId: null | string; widgetEnabled: boolean; }; guildScheduledEvent: { channelId: null | string; creator: { accentColor: number; avatar: null | string; avatarDecorationData: { asset: string; skuId: string; }; banner: string; bot: boolean; discriminator: string; email: null | string; flags: number; globalName: null | string; id: string; locale: string; mfaEnabled: boolean; premiumType: PremiumTypes; publicFlags: number; system: boolean; username: string; verified: boolean; }; creatorId: null | string; description: string; entityId: null | string; entityMetadata: null | { location: string; }; entityType: ScheduledEventEntityType; guildId: string; id: string; image: null | string; name: string; privacyLevel: GuildOnly; recurrenceRule: null | { byMonth: null | DiscordScheduledEventRecurrenceRuleMonth[]; byMonthDay: null | number[]; byNWeekday: null | object[]; byWeekday: null | DiscordScheduledEventRecurrenceRuleWeekday[]; byYearDay: null | number[]; count: null | number; end: null | string; frequency: DiscordScheduledEventRecurrenceRuleFrequency; interval: number; start: string; }; scheduledEndTime: null | string; scheduledStartTime: string; status: ScheduledEventStatus; userCount: number; }; inviter: { accentColor: number; avatar: null | string; avatarDecorationData: { asset: string; skuId: string; }; banner: string; bot: boolean; discriminator: string; email: null | string; flags: number; globalName: null | string; id: string; locale: string; mfaEnabled: boolean; premiumType: PremiumTypes; publicFlags: number; system: boolean; username: string; verified: boolean; }; maxAge: number; maxUses: number; stageInstance: { members: object[]; participantCount: number; speakerCount: number; topic: string; }; targetApplication: { approximateGuildCount: number; approximateUserInstallCount: number; bot: { accentColor: number; avatar: null | string; avatarDecorationData: { asset: string; skuId: string; }; banner: string; bot: boolean; discriminator: string; email: null | string; flags: number; globalName: null | string; id: string; locale: string; mfaEnabled: boolean; premiumType: PremiumTypes; publicFlags: number; system: boolean; username: string; verified: boolean; }; botPublic: boolean; botRequireCodeGrant: boolean; coverImage: string; customInstallUrl: string; description: string; eventWebhooksStatus: DiscordApplicationEventWebhookStatus; eventWebhooksTypes: DiscordWebhookEventType[]; eventWebhooksUrl: null | string; flags: ApplicationFlags; guild: { afkChannelId: null | string; afkTimeout: number; applicationId: null | string; approximateMemberCount: number; approximatePresenceCount: number; banner: null | string; channels: object[]; defaultMessageNotifications: DefaultMessageNotificationLevels; description: null | string; discoverySplash: null | string; emojis: object[]; explicitContentFilter: ExplicitContentFilterLevels; features: GuildFeatures[]; icon: null | string; iconHash: null | string; id: string; joinedAt: string; large: boolean; maxMembers: number; maxPresences: null | number; maxStageVideoChannelUsers: number; maxVideoChannelUsers: number; memberCount: number; members: object[]; mfaLevel: MfaLevels; name: string; nsfwLevel: GuildNsfwLevel; owner: boolean; ownerId: string; permissions: string; preferredLocale: string; premiumProgressBarEnabled: boolean; premiumSubscriptionCount: number; premiumTier: PremiumTiers; presences: object[]; publicUpdatesChannelId: null | string; roles: object[]; rulesChannelId: null | string; safetyAlertsChannelId: null | string; soundboardSounds: object[]; splash: null | string; stageInstances: object[]; stickers: object[]; systemChannelFlags: SystemChannelFlags; systemChannelId: null | string; threads: object[]; unavailable: boolean; vanityUrlCode: null | string; verificationLevel: VerificationLevels; voiceStates: object[]; welcomeScreen: { description: null | string; welcomeChannels: object[]; }; widgetChannelId: null | string; widgetEnabled: boolean; }; guildId: string; icon: null | string; id: string; installParams: { permissions: string; scopes: OAuth2Scope[]; }; integrationTypesConfig: { 0: { oauth2InstallParams: { permissions: ...; scopes: ...; }; }; 1: { oauth2InstallParams: { permissions: ...; scopes: ...; }; }; }; interactionsEndpointUrl: null | string; name: string; owner: { accentColor: number; avatar: null | string; avatarDecorationData: { asset: string; skuId: string; }; banner: string; bot: boolean; discriminator: string; email: null | string; flags: number; globalName: null | string; id: string; locale: string; mfaEnabled: boolean; premiumType: PremiumTypes; publicFlags: number; system: boolean; username: string; verified: boolean; }; primarySkuId: string; privacyPolicyUrl: string; redirectUris: string[]; roleConnectionsVerificationUrl: null | string; rpcOrigins: string[]; slug: string; tags: string[]; team: null | { icon: null | string; id: string; members: object[]; name: string; ownerUserId: string; }; termsOfServiceUrl: string; verifyKey: string; }; targetType: TargetTypes; targetUser: { accentColor: number; avatar: null | string; avatarDecorationData: { asset: string; skuId: string; }; banner: string; bot: boolean; discriminator: string; email: null | string; flags: number; globalName: null | string; id: string; locale: string; mfaEnabled: boolean; premiumType: PremiumTypes; publicFlags: number; system: boolean; username: string; verified: boolean; }; temporary: boolean; type: DiscordInviteType; uses: number; }>

Defined in: packages/rest/dist/types/types.d.ts:1817

Gets an invite to a channel by its invite code.

Parameters

inviteCode

string

The invite code of the invite to get.

options?

GetInvite

The parameters for the fetching of the invite.

Returns

Promise<{ approximateMemberCount: number; approximatePresenceCount: number; channel: null | { applicationId: string; appliedTags: string[]; availableTags: object[]; bitrate: number; defaultAutoArchiveDuration: number; defaultForumLayout: ForumLayout; defaultReactionEmoji: null | { emojiId: string; emojiName: null | string; }; defaultSortOrder: null | SortOrderTypes; defaultThreadRateLimitPerUser: number; flags: ChannelFlags; guildId: string; icon: string; id: string; lastMessageId: null | string; lastPinTimestamp: null | string; managed: boolean; member: { flags: number; id: string; joinTimestamp: string; userId: string; }; memberCount: number; messageCount: number; name: string; newlyCreated: boolean; nsfw: boolean; ownerId: string; parentId: null | string; permissionOverwrites: object[]; permissions: string; position: number; rateLimitPerUser: number; recipients: object[]; rtcRegion: null | string; threadMetadata: { archived: boolean; archiveTimestamp: string; autoArchiveDuration: 60 | 1440 | 4320 | 10080; createTimestamp: null | string; invitable: boolean; locked: boolean; }; topic: null | string; totalMessageSent: number; type: ChannelTypes; userLimit: number; videoQualityMode: VideoQualityModes; }; code: string; createdAt: string; expiresAt: null | string; guild: { afkChannelId: null | string; afkTimeout: number; applicationId: null | string; approximateMemberCount: number; approximatePresenceCount: number; banner: null | string; channels: object[]; defaultMessageNotifications: DefaultMessageNotificationLevels; description: null | string; discoverySplash: null | string; emojis: object[]; explicitContentFilter: ExplicitContentFilterLevels; features: GuildFeatures[]; icon: null | string; iconHash: null | string; id: string; joinedAt: string; large: boolean; maxMembers: number; maxPresences: null | number; maxStageVideoChannelUsers: number; maxVideoChannelUsers: number; memberCount: number; members: object[]; mfaLevel: MfaLevels; name: string; nsfwLevel: GuildNsfwLevel; owner: boolean; ownerId: string; permissions: string; preferredLocale: string; premiumProgressBarEnabled: boolean; premiumSubscriptionCount: number; premiumTier: PremiumTiers; presences: object[]; publicUpdatesChannelId: null | string; roles: object[]; rulesChannelId: null | string; safetyAlertsChannelId: null | string; soundboardSounds: object[]; splash: null | string; stageInstances: object[]; stickers: object[]; systemChannelFlags: SystemChannelFlags; systemChannelId: null | string; threads: object[]; unavailable: boolean; vanityUrlCode: null | string; verificationLevel: VerificationLevels; voiceStates: object[]; welcomeScreen: { description: null | string; welcomeChannels: object[]; }; widgetChannelId: null | string; widgetEnabled: boolean; }; guildScheduledEvent: { channelId: null | string; creator: { accentColor: number; avatar: null | string; avatarDecorationData: { asset: string; skuId: string; }; banner: string; bot: boolean; discriminator: string; email: null | string; flags: number; globalName: null | string; id: string; locale: string; mfaEnabled: boolean; premiumType: PremiumTypes; publicFlags: number; system: boolean; username: string; verified: boolean; }; creatorId: null | string; description: string; entityId: null | string; entityMetadata: null | { location: string; }; entityType: ScheduledEventEntityType; guildId: string; id: string; image: null | string; name: string; privacyLevel: GuildOnly; recurrenceRule: null | { byMonth: null | DiscordScheduledEventRecurrenceRuleMonth[]; byMonthDay: null | number[]; byNWeekday: null | object[]; byWeekday: null | DiscordScheduledEventRecurrenceRuleWeekday[]; byYearDay: null | number[]; count: null | number; end: null | string; frequency: DiscordScheduledEventRecurrenceRuleFrequency; interval: number; start: string; }; scheduledEndTime: null | string; scheduledStartTime: string; status: ScheduledEventStatus; userCount: number; }; inviter: { accentColor: number; avatar: null | string; avatarDecorationData: { asset: string; skuId: string; }; banner: string; bot: boolean; discriminator: string; email: null | string; flags: number; globalName: null | string; id: string; locale: string; mfaEnabled: boolean; premiumType: PremiumTypes; publicFlags: number; system: boolean; username: string; verified: boolean; }; maxAge: number; maxUses: number; stageInstance: { members: object[]; participantCount: number; speakerCount: number; topic: string; }; targetApplication: { approximateGuildCount: number; approximateUserInstallCount: number; bot: { accentColor: number; avatar: null | string; avatarDecorationData: { asset: string; skuId: string; }; banner: string; bot: boolean; discriminator: string; email: null | string; flags: number; globalName: null | string; id: string; locale: string; mfaEnabled: boolean; premiumType: PremiumTypes; publicFlags: number; system: boolean; username: string; verified: boolean; }; botPublic: boolean; botRequireCodeGrant: boolean; coverImage: string; customInstallUrl: string; description: string; eventWebhooksStatus: DiscordApplicationEventWebhookStatus; eventWebhooksTypes: DiscordWebhookEventType[]; eventWebhooksUrl: null | string; flags: ApplicationFlags; guild: { afkChannelId: null | string; afkTimeout: number; applicationId: null | string; approximateMemberCount: number; approximatePresenceCount: number; banner: null | string; channels: object[]; defaultMessageNotifications: DefaultMessageNotificationLevels; description: null | string; discoverySplash: null | string; emojis: object[]; explicitContentFilter: ExplicitContentFilterLevels; features: GuildFeatures[]; icon: null | string; iconHash: null | string; id: string; joinedAt: string; large: boolean; maxMembers: number; maxPresences: null | number; maxStageVideoChannelUsers: number; maxVideoChannelUsers: number; memberCount: number; members: object[]; mfaLevel: MfaLevels; name: string; nsfwLevel: GuildNsfwLevel; owner: boolean; ownerId: string; permissions: string; preferredLocale: string; premiumProgressBarEnabled: boolean; premiumSubscriptionCount: number; premiumTier: PremiumTiers; presences: object[]; publicUpdatesChannelId: null | string; roles: object[]; rulesChannelId: null | string; safetyAlertsChannelId: null | string; soundboardSounds: object[]; splash: null | string; stageInstances: object[]; stickers: object[]; systemChannelFlags: SystemChannelFlags; systemChannelId: null | string; threads: object[]; unavailable: boolean; vanityUrlCode: null | string; verificationLevel: VerificationLevels; voiceStates: object[]; welcomeScreen: { description: null | string; welcomeChannels: object[]; }; widgetChannelId: null | string; widgetEnabled: boolean; }; guildId: string; icon: null | string; id: string; installParams: { permissions: string; scopes: OAuth2Scope[]; }; integrationTypesConfig: { 0: { oauth2InstallParams: { permissions: ...; scopes: ...; }; }; 1: { oauth2InstallParams: { permissions: ...; scopes: ...; }; }; }; interactionsEndpointUrl: null | string; name: string; owner: { accentColor: number; avatar: null | string; avatarDecorationData: { asset: string; skuId: string; }; banner: string; bot: boolean; discriminator: string; email: null | string; flags: number; globalName: null | string; id: string; locale: string; mfaEnabled: boolean; premiumType: PremiumTypes; publicFlags: number; system: boolean; username: string; verified: boolean; }; primarySkuId: string; privacyPolicyUrl: string; redirectUris: string[]; roleConnectionsVerificationUrl: null | string; rpcOrigins: string[]; slug: string; tags: string[]; team: null | { icon: null | string; id: string; members: object[]; name: string; ownerUserId: string; }; termsOfServiceUrl: string; verifyKey: string; }; targetType: TargetTypes; targetUser: { accentColor: number; avatar: null | string; avatarDecorationData: { asset: string; skuId: string; }; banner: string; bot: boolean; discriminator: string; email: null | string; flags: number; globalName: null | string; id: string; locale: string; mfaEnabled: boolean; premiumType: PremiumTypes; publicFlags: number; system: boolean; username: string; verified: boolean; }; temporary: boolean; type: DiscordInviteType; uses: number; }>

An instance of DiscordInviteMetadata.

See

https://discord.com/developers/docs/resources/invite#get-invite

getInvites()

getInvites: (guildId) => Promise<object[]>

Defined in: packages/rest/dist/types/types.d.ts:1829

Gets the list of invites for a guild.

Parameters

guildId

https://discord.com/developers/docs/resources/invite#get-invites

The ID of the guild to get the invites from.

Returns

Promise<object[]>

A collection of DiscordInviteMetadata objects assorted by invite code.

Remarks

Requires the MANAGE_GUILD permission.

See

getMember()

getMember: (guildId, userId) => Promise<{ avatar: string; avatarDecorationData: null | { asset: string; skuId: string; }; banner: string; communicationDisabledUntil: null | string; deaf: boolean; flags: number; joinedAt: string; mute: boolean; nick: null | string; pending: boolean; permissions: string; premiumSince: null | string; roles: string[]; user: { accentColor: number; avatar: null | string; avatarDecorationData: { asset: string; skuId: string; }; banner: string; bot: boolean; discriminator: string; email: null | string; flags: number; globalName: null | string; id: string; locale: string; mfaEnabled: boolean; premiumType: PremiumTypes; publicFlags: number; system: boolean; username: string; verified: boolean; }; }>

Defined in: packages/rest/dist/types/types.d.ts:2619

Gets the member object by user ID.

Parameters

guildId

The ID of the guild to get the member object for.

userId

https://discord.com/developers/docs/resources/guild#get-guild-member

The ID of the user to get the member object for.

Returns

An instance of DiscordMemberWithUser.

See

getMembers()

getMembers: (guildId, options) => Promise<object[]>

Defined in: packages/rest/dist/types/types.d.ts:2651

Gets the list of members for a guild.

Parameters

guildId

The ID of the guild to get the list of members for.

options

ListGuildMembers

The parameters for the fetching of the members.

Returns

Promise<object[]>

A collection of DiscordMemberWithUser objects assorted by user ID.

Remarks

Requires the GUILD_MEMBERS intent.

⚠️ It is not recommended to use this endpoint with very large bots. Instead, opt to use fetchMembers(): REST communication only permits 50 requests to be made per second, while gateways allow for up to 120 requests per minute per shard. For more information, read https://discord.com/developers/docs/topics/rate-limits#rate-limits.

See

getMessage()

getMessage: (channelId, messageId) => Promise<{ activity: { partyId: string; type: MessageActivityTypes; }; application: { approximateGuildCount: number; approximateUserInstallCount: number; bot: { accentColor: number; avatar: null | string; avatarDecorationData: { asset: string; skuId: string; }; banner: string; bot: boolean; discriminator: string; email: null | string; flags: number; globalName: null | string; id: string; locale: string; mfaEnabled: boolean; premiumType: PremiumTypes; publicFlags: number; system: boolean; username: string; verified: boolean; }; botPublic: boolean; botRequireCodeGrant: boolean; coverImage: string; customInstallUrl: string; description: string; eventWebhooksStatus: DiscordApplicationEventWebhookStatus; eventWebhooksTypes: DiscordWebhookEventType[]; eventWebhooksUrl: null | string; flags: ApplicationFlags; guild: { afkChannelId: null | string; afkTimeout: number; applicationId: null | string; approximateMemberCount: number; approximatePresenceCount: number; banner: null | string; channels: object[]; defaultMessageNotifications: DefaultMessageNotificationLevels; description: null | string; discoverySplash: null | string; emojis: object[]; explicitContentFilter: ExplicitContentFilterLevels; features: GuildFeatures[]; icon: null | string; iconHash: null | string; id: string; joinedAt: string; large: boolean; maxMembers: number; maxPresences: null | number; maxStageVideoChannelUsers: number; maxVideoChannelUsers: number; memberCount: number; members: object[]; mfaLevel: MfaLevels; name: string; nsfwLevel: GuildNsfwLevel; owner: boolean; ownerId: string; permissions: string; preferredLocale: string; premiumProgressBarEnabled: boolean; premiumSubscriptionCount: number; premiumTier: PremiumTiers; presences: object[]; publicUpdatesChannelId: null | string; roles: object[]; rulesChannelId: null | string; safetyAlertsChannelId: null | string; soundboardSounds: object[]; splash: null | string; stageInstances: object[]; stickers: object[]; systemChannelFlags: SystemChannelFlags; systemChannelId: null | string; threads: object[]; unavailable: boolean; vanityUrlCode: null | string; verificationLevel: VerificationLevels; voiceStates: object[]; welcomeScreen: { description: null | string; welcomeChannels: object[]; }; widgetChannelId: null | string; widgetEnabled: boolean; }; guildId: string; icon: null | string; id: string; installParams: { permissions: string; scopes: OAuth2Scope[]; }; integrationTypesConfig: { 0: { oauth2InstallParams: { permissions: ...; scopes: ...; }; }; 1: { oauth2InstallParams: { permissions: ...; scopes: ...; }; }; }; interactionsEndpointUrl: null | string; name: string; owner: { accentColor: number; avatar: null | string; avatarDecorationData: { asset: string; skuId: string; }; banner: string; bot: boolean; discriminator: string; email: null | string; flags: number; globalName: null | string; id: string; locale: string; mfaEnabled: boolean; premiumType: PremiumTypes; publicFlags: number; system: boolean; username: string; verified: boolean; }; primarySkuId: string; privacyPolicyUrl: string; redirectUris: string[]; roleConnectionsVerificationUrl: null | string; rpcOrigins: string[]; slug: string; tags: string[]; team: null | { icon: null | string; id: string; members: object[]; name: string; ownerUserId: string; }; termsOfServiceUrl: string; verifyKey: string; }; applicationId: string; attachments: object[]; author: { accentColor: number; avatar: null | string; avatarDecorationData: { asset: string; skuId: string; }; banner: string; bot: boolean; discriminator: string; email: null | string; flags: number; globalName: null | string; id: string; locale: string; mfaEnabled: boolean; premiumType: PremiumTypes; publicFlags: number; system: boolean; username: string; verified: boolean; }; call: { endedTimestamp: string; participants: string[]; }; channelId: string; components: ({ components: ({ channelTypes: ... | ...; customId: string; defaultValues: ... | ...; disabled: ... | ... | ...; maxValues: ... | ...; minValues: ... | ...; options: ... | ...; placeholder: ... | ...; type: ... | ... | ... | ... | ...; } | { customId: ... | ...; disabled: ... | ... | ...; emoji: ... | ...; label: ... | ...; skuId: ... | ...; style: ButtonStyles; type: Button; url: ... | ...; } | { customId: string; label: string; maxLength: ... | ...; minLength: ... | ...; placeholder: ... | ...; required: ... | ... | ...; style: TextStyles; type: InputText; value: ... | ...; })[]; type: ActionRow; } | { channelTypes: ChannelTypes[]; customId: string; defaultValues: object[]; disabled: boolean; maxValues: number; minValues: number; options: object[]; placeholder: string; type: SelectMenu | SelectMenuUsers | SelectMenuRoles | SelectMenuUsersAndRoles | SelectMenuChannels; } | { customId: string; disabled: boolean; emoji: { animated: boolean; id: string; name: string; }; label: string; skuId: string; style: ButtonStyles; type: Button; url: string; } | { customId: string; label: string; maxLength: number; minLength: number; placeholder: string; required: boolean; style: TextStyles; type: InputText; value: string; })[]; content: string; editedTimestamp: null | string; embeds: object[]; flags: MessageFlags; guildId: string; id: string; interaction: { id: string; member: { avatar: string; avatarDecorationData: null | { asset: string; skuId: string; }; banner: string; communicationDisabledUntil: null | string; deaf: boolean; flags: number; joinedAt: string; mute: boolean; nick: null | string; pending: boolean; permissions: string; premiumSince: null | string; roles: string[]; user: { accentColor: number; avatar: null | string; avatarDecorationData: { asset: ...; skuId: ...; }; banner: string; bot: boolean; discriminator: string; email: null | string; flags: number; globalName: null | string; id: string; locale: string; mfaEnabled: boolean; premiumType: PremiumTypes; publicFlags: number; system: boolean; username: string; verified: boolean; }; }; name: string; type: InteractionTypes; user: { accentColor: number; avatar: null | string; avatarDecorationData: { asset: string; skuId: string; }; banner: string; bot: boolean; discriminator: string; email: null | string; flags: number; globalName: null | string; id: string; locale: string; mfaEnabled: boolean; premiumType: PremiumTypes; publicFlags: number; system: boolean; username: string; verified: boolean; }; }; interactionMetadata: { authorizingIntegrationOwners: { 0: string; 1: string; }; id: string; originalResponseMessageId: string; targetMessageId: string; targetUser: { accentColor: number; avatar: null | string; avatarDecorationData: { asset: string; skuId: string; }; banner: string; bot: boolean; discriminator: string; email: null | string; flags: number; globalName: null | string; id: string; locale: string; mfaEnabled: boolean; premiumType: PremiumTypes; publicFlags: number; system: boolean; username: string; verified: boolean; }; type: InteractionTypes; user: { accentColor: number; avatar: null | string; avatarDecorationData: { asset: string; skuId: string; }; banner: string; bot: boolean; discriminator: string; email: null | string; flags: number; globalName: null | string; id: string; locale: string; mfaEnabled: boolean; premiumType: PremiumTypes; publicFlags: number; system: boolean; username: string; verified: boolean; }; } | { authorizingIntegrationOwners: { 0: string; 1: string; }; id: string; interactedMessageId: string; originalResponseMessageId: string; type: InteractionTypes; user: { accentColor: number; avatar: null | string; avatarDecorationData: { asset: string; skuId: string; }; banner: string; bot: boolean; discriminator: string; email: null | string; flags: number; globalName: null | string; id: string; locale: string; mfaEnabled: boolean; premiumType: PremiumTypes; publicFlags: number; system: boolean; username: string; verified: boolean; }; } | { authorizingIntegrationOwners: { 0: string; 1: string; }; id: string; originalResponseMessageId: string; triggeringInteractionMetadata: { id: string; type: InteractionTypes; user: { username: string; globalName: string | null; locale?: string | undefined; flags?: number | undefined; premiumType?: PremiumTypes | undefined; ... 11 more ...; avatarDecorationData?: { ...; } | undefined; }; authorizingIntegrationOwners: { ...; }; originalResponseMessageI...; type: InteractionTypes; user: { accentColor: number; avatar: null | string; avatarDecorationData: { asset: string; skuId: string; }; banner: string; bot: boolean; discriminator: string; email: null | string; flags: number; globalName: null | string; id: string; locale: string; mfaEnabled: boolean; premiumType: PremiumTypes; publicFlags: number; system: boolean; username: string; verified: boolean; }; }; member: { avatar: string; avatarDecorationData: null | { asset: string; skuId: string; }; banner: string; communicationDisabledUntil: null | string; deaf: boolean; flags: number; joinedAt: string; mute: boolean; nick: null | string; pending: boolean; permissions: string; premiumSince: null | string; roles: string[]; user: { accentColor: number; avatar: null | string; avatarDecorationData: { asset: string; skuId: string; }; banner: string; bot: boolean; discriminator: string; email: null | string; flags: number; globalName: null | string; id: string; locale: string; mfaEnabled: boolean; premiumType: PremiumTypes; publicFlags: number; system: boolean; username: string; verified: boolean; }; }; mentionChannels: object[]; mentionEveryone: boolean; mentionRoles: string[]; mentions: object[]; messageReference: { channelId: string; failIfNotExists: boolean; guildId: string; messageId: string; type: DiscordMessageReferenceType; }; messageSnapshots: object[]; nonce: string | number; pinned: boolean; poll: { allowMultiselect: boolean; answers: object[]; expiry: null | string; layoutType: Default; question: { emoji: { animated: boolean; available: boolean; id: string; managed: boolean; name: string; requireColons: boolean; roles: string[]; user: { accentColor: ... | ...; avatar: ... | ...; avatarDecorationData: ... | ...; banner: ... | ...; bot: ... | ... | ...; discriminator: string; email: ... | ... | ...; flags: ... | ...; globalName: ... | ...; id: string; locale: ... | ...; mfaEnabled: ... | ... | ...; premiumType: ... | ...; publicFlags: ... | ...; system: ... | ... | ...; username: string; verified: ... | ... | ...; }; }; text: string; }; results: { answerCounts: object[]; isFinalized: boolean; }; }; position: number; reactions: object[]; referencedMessage: { id: string; channelId: string; guildId?: string | undefined; author: { username: string; globalName: string | null; locale?: string | undefined; flags?: number | undefined; premiumType?: PremiumTypes | undefined; ... 11 more ...; avatarDecorationData?: { ...; } | undefined; }; ... 31 more ...; call?: { ...; } | un...; stickerItems: object[]; stickers: object[]; thread: { applicationId: string; appliedTags: string[]; availableTags: object[]; bitrate: number; defaultAutoArchiveDuration: number; defaultForumLayout: ForumLayout; defaultReactionEmoji: null | { emojiId: string; emojiName: null | string; }; defaultSortOrder: null | SortOrderTypes; defaultThreadRateLimitPerUser: number; flags: ChannelFlags; guildId: string; icon: string; id: string; lastMessageId: null | string; lastPinTimestamp: null | string; managed: boolean; member: { flags: number; id: string; joinTimestamp: string; userId: string; }; memberCount: number; messageCount: number; name: string; newlyCreated: boolean; nsfw: boolean; ownerId: string; parentId: null | string; permissionOverwrites: object[]; permissions: string; position: number; rateLimitPerUser: number; recipients: object[]; rtcRegion: null | string; threadMetadata: { archived: boolean; archiveTimestamp: string; autoArchiveDuration: 60 | 1440 | 4320 | 10080; createTimestamp: null | string; invitable: boolean; locked: boolean; }; topic: null | string; totalMessageSent: number; type: ChannelTypes; userLimit: number; videoQualityMode: VideoQualityModes; }; timestamp: string; tts: boolean; type: MessageTypes; webhookId: string; }>

Defined in: packages/rest/dist/types/types.d.ts:1845

Gets a message from a channel by the ID of the message.

Parameters

channelId

The ID of the channel from which to get the message.

messageId

https://discord.com/developers/docs/resources/channel#get-channel-message

The ID of the message to get.

Returns

An instance of DiscordMessage.

Remarks

Requires that the bot user be able to see the contents of the channel in which the message was posted.

If getting a message from a guild channel:

Requires the READ_MESSAGE_HISTORY permission.

See

getMessages()

getMessages: (channelId, options?) => Promise<object[]>

Defined in: packages/rest/dist/types/types.d.ts:1861

Gets multiple messages from a channel.

Parameters

channelId

https://discord.com/developers/docs/resources/channel#get-channel-messages

The ID of the channel from which to get the messages.

options?

GetMessagesOptions

The parameters for the fetching of the messages.

Returns

Promise<object[]>

A collection of DiscordMessage objects assorted by message ID.

Remarks

Requires that the bot user be able to see the contents of the channel in which the messages were posted.

If getting a messages from a guild channel:

Requires the READ_MESSAGE_HISTORY permission.

See

getOriginalInteractionResponse()

getOriginalInteractionResponse: (token) => Promise<{ activity: { partyId: string; type: MessageActivityTypes; }; application: { approximateGuildCount: number; approximateUserInstallCount: number; bot: { accentColor: number; avatar: null | string; avatarDecorationData: { asset: string; skuId: string; }; banner: string; bot: boolean; discriminator: string; email: null | string; flags: number; globalName: null | string; id: string; locale: string; mfaEnabled: boolean; premiumType: PremiumTypes; publicFlags: number; system: boolean; username: string; verified: boolean; }; botPublic: boolean; botRequireCodeGrant: boolean; coverImage: string; customInstallUrl: string; description: string; eventWebhooksStatus: DiscordApplicationEventWebhookStatus; eventWebhooksTypes: DiscordWebhookEventType[]; eventWebhooksUrl: null | string; flags: ApplicationFlags; guild: { afkChannelId: null | string; afkTimeout: number; applicationId: null | string; approximateMemberCount: number; approximatePresenceCount: number; banner: null | string; channels: object[]; defaultMessageNotifications: DefaultMessageNotificationLevels; description: null | string; discoverySplash: null | string; emojis: object[]; explicitContentFilter: ExplicitContentFilterLevels; features: GuildFeatures[]; icon: null | string; iconHash: null | string; id: string; joinedAt: string; large: boolean; maxMembers: number; maxPresences: null | number; maxStageVideoChannelUsers: number; maxVideoChannelUsers: number; memberCount: number; members: object[]; mfaLevel: MfaLevels; name: string; nsfwLevel: GuildNsfwLevel; owner: boolean; ownerId: string; permissions: string; preferredLocale: string; premiumProgressBarEnabled: boolean; premiumSubscriptionCount: number; premiumTier: PremiumTiers; presences: object[]; publicUpdatesChannelId: null | string; roles: object[]; rulesChannelId: null | string; safetyAlertsChannelId: null | string; soundboardSounds: object[]; splash: null | string; stageInstances: object[]; stickers: object[]; systemChannelFlags: SystemChannelFlags; systemChannelId: null | string; threads: object[]; unavailable: boolean; vanityUrlCode: null | string; verificationLevel: VerificationLevels; voiceStates: object[]; welcomeScreen: { description: null | string; welcomeChannels: object[]; }; widgetChannelId: null | string; widgetEnabled: boolean; }; guildId: string; icon: null | string; id: string; installParams: { permissions: string; scopes: OAuth2Scope[]; }; integrationTypesConfig: { 0: { oauth2InstallParams: { permissions: ...; scopes: ...; }; }; 1: { oauth2InstallParams: { permissions: ...; scopes: ...; }; }; }; interactionsEndpointUrl: null | string; name: string; owner: { accentColor: number; avatar: null | string; avatarDecorationData: { asset: string; skuId: string; }; banner: string; bot: boolean; discriminator: string; email: null | string; flags: number; globalName: null | string; id: string; locale: string; mfaEnabled: boolean; premiumType: PremiumTypes; publicFlags: number; system: boolean; username: string; verified: boolean; }; primarySkuId: string; privacyPolicyUrl: string; redirectUris: string[]; roleConnectionsVerificationUrl: null | string; rpcOrigins: string[]; slug: string; tags: string[]; team: null | { icon: null | string; id: string; members: object[]; name: string; ownerUserId: string; }; termsOfServiceUrl: string; verifyKey: string; }; applicationId: string; attachments: object[]; author: { accentColor: number; avatar: null | string; avatarDecorationData: { asset: string; skuId: string; }; banner: string; bot: boolean; discriminator: string; email: null | string; flags: number; globalName: null | string; id: string; locale: string; mfaEnabled: boolean; premiumType: PremiumTypes; publicFlags: number; system: boolean; username: string; verified: boolean; }; call: { endedTimestamp: string; participants: string[]; }; channelId: string; components: ({ components: ({ channelTypes: ... | ...; customId: string; defaultValues: ... | ...; disabled: ... | ... | ...; maxValues: ... | ...; minValues: ... | ...; options: ... | ...; placeholder: ... | ...; type: ... | ... | ... | ... | ...; } | { customId: ... | ...; disabled: ... | ... | ...; emoji: ... | ...; label: ... | ...; skuId: ... | ...; style: ButtonStyles; type: Button; url: ... | ...; } | { customId: string; label: string; maxLength: ... | ...; minLength: ... | ...; placeholder: ... | ...; required: ... | ... | ...; style: TextStyles; type: InputText; value: ... | ...; })[]; type: ActionRow; } | { channelTypes: ChannelTypes[]; customId: string; defaultValues: object[]; disabled: boolean; maxValues: number; minValues: number; options: object[]; placeholder: string; type: SelectMenu | SelectMenuUsers | SelectMenuRoles | SelectMenuUsersAndRoles | SelectMenuChannels; } | { customId: string; disabled: boolean; emoji: { animated: boolean; id: string; name: string; }; label: string; skuId: string; style: ButtonStyles; type: Button; url: string; } | { customId: string; label: string; maxLength: number; minLength: number; placeholder: string; required: boolean; style: TextStyles; type: InputText; value: string; })[]; content: string; editedTimestamp: null | string; embeds: object[]; flags: MessageFlags; guildId: string; id: string; interaction: { id: string; member: { avatar: string; avatarDecorationData: null | { asset: string; skuId: string; }; banner: string; communicationDisabledUntil: null | string; deaf: boolean; flags: number; joinedAt: string; mute: boolean; nick: null | string; pending: boolean; permissions: string; premiumSince: null | string; roles: string[]; user: { accentColor: number; avatar: null | string; avatarDecorationData: { asset: ...; skuId: ...; }; banner: string; bot: boolean; discriminator: string; email: null | string; flags: number; globalName: null | string; id: string; locale: string; mfaEnabled: boolean; premiumType: PremiumTypes; publicFlags: number; system: boolean; username: string; verified: boolean; }; }; name: string; type: InteractionTypes; user: { accentColor: number; avatar: null | string; avatarDecorationData: { asset: string; skuId: string; }; banner: string; bot: boolean; discriminator: string; email: null | string; flags: number; globalName: null | string; id: string; locale: string; mfaEnabled: boolean; premiumType: PremiumTypes; publicFlags: number; system: boolean; username: string; verified: boolean; }; }; interactionMetadata: { authorizingIntegrationOwners: { 0: string; 1: string; }; id: string; originalResponseMessageId: string; targetMessageId: string; targetUser: { accentColor: number; avatar: null | string; avatarDecorationData: { asset: string; skuId: string; }; banner: string; bot: boolean; discriminator: string; email: null | string; flags: number; globalName: null | string; id: string; locale: string; mfaEnabled: boolean; premiumType: PremiumTypes; publicFlags: number; system: boolean; username: string; verified: boolean; }; type: InteractionTypes; user: { accentColor: number; avatar: null | string; avatarDecorationData: { asset: string; skuId: string; }; banner: string; bot: boolean; discriminator: string; email: null | string; flags: number; globalName: null | string; id: string; locale: string; mfaEnabled: boolean; premiumType: PremiumTypes; publicFlags: number; system: boolean; username: string; verified: boolean; }; } | { authorizingIntegrationOwners: { 0: string; 1: string; }; id: string; interactedMessageId: string; originalResponseMessageId: string; type: InteractionTypes; user: { accentColor: number; avatar: null | string; avatarDecorationData: { asset: string; skuId: string; }; banner: string; bot: boolean; discriminator: string; email: null | string; flags: number; globalName: null | string; id: string; locale: string; mfaEnabled: boolean; premiumType: PremiumTypes; publicFlags: number; system: boolean; username: string; verified: boolean; }; } | { authorizingIntegrationOwners: { 0: string; 1: string; }; id: string; originalResponseMessageId: string; triggeringInteractionMetadata: { id: string; type: InteractionTypes; user: { username: string; globalName: string | null; locale?: string | undefined; flags?: number | undefined; premiumType?: PremiumTypes | undefined; ... 11 more ...; avatarDecorationData?: { ...; } | undefined; }; authorizingIntegrationOwners: { ...; }; originalResponseMessageI...; type: InteractionTypes; user: { accentColor: number; avatar: null | string; avatarDecorationData: { asset: string; skuId: string; }; banner: string; bot: boolean; discriminator: string; email: null | string; flags: number; globalName: null | string; id: string; locale: string; mfaEnabled: boolean; premiumType: PremiumTypes; publicFlags: number; system: boolean; username: string; verified: boolean; }; }; member: { avatar: string; avatarDecorationData: null | { asset: string; skuId: string; }; banner: string; communicationDisabledUntil: null | string; deaf: boolean; flags: number; joinedAt: string; mute: boolean; nick: null | string; pending: boolean; permissions: string; premiumSince: null | string; roles: string[]; user: { accentColor: number; avatar: null | string; avatarDecorationData: { asset: string; skuId: string; }; banner: string; bot: boolean; discriminator: string; email: null | string; flags: number; globalName: null | string; id: string; locale: string; mfaEnabled: boolean; premiumType: PremiumTypes; publicFlags: number; system: boolean; username: string; verified: boolean; }; }; mentionChannels: object[]; mentionEveryone: boolean; mentionRoles: string[]; mentions: object[]; messageReference: { channelId: string; failIfNotExists: boolean; guildId: string; messageId: string; type: DiscordMessageReferenceType; }; messageSnapshots: object[]; nonce: string | number; pinned: boolean; poll: { allowMultiselect: boolean; answers: object[]; expiry: null | string; layoutType: Default; question: { emoji: { animated: boolean; available: boolean; id: string; managed: boolean; name: string; requireColons: boolean; roles: string[]; user: { accentColor: ... | ...; avatar: ... | ...; avatarDecorationData: ... | ...; banner: ... | ...; bot: ... | ... | ...; discriminator: string; email: ... | ... | ...; flags: ... | ...; globalName: ... | ...; id: string; locale: ... | ...; mfaEnabled: ... | ... | ...; premiumType: ... | ...; publicFlags: ... | ...; system: ... | ... | ...; username: string; verified: ... | ... | ...; }; }; text: string; }; results: { answerCounts: object[]; isFinalized: boolean; }; }; position: number; reactions: object[]; referencedMessage: { id: string; channelId: string; guildId?: string | undefined; author: { username: string; globalName: string | null; locale?: string | undefined; flags?: number | undefined; premiumType?: PremiumTypes | undefined; ... 11 more ...; avatarDecorationData?: { ...; } | undefined; }; ... 31 more ...; call?: { ...; } | un...; stickerItems: object[]; stickers: object[]; thread: { applicationId: string; appliedTags: string[]; availableTags: object[]; bitrate: number; defaultAutoArchiveDuration: number; defaultForumLayout: ForumLayout; defaultReactionEmoji: null | { emojiId: string; emojiName: null | string; }; defaultSortOrder: null | SortOrderTypes; defaultThreadRateLimitPerUser: number; flags: ChannelFlags; guildId: string; icon: string; id: string; lastMessageId: null | string; lastPinTimestamp: null | string; managed: boolean; member: { flags: number; id: string; joinTimestamp: string; userId: string; }; memberCount: number; messageCount: number; name: string; newlyCreated: boolean; nsfw: boolean; ownerId: string; parentId: null | string; permissionOverwrites: object[]; permissions: string; position: number; rateLimitPerUser: number; recipients: object[]; rtcRegion: null | string; threadMetadata: { archived: boolean; archiveTimestamp: string; autoArchiveDuration: 60 | 1440 | 4320 | 10080; createTimestamp: null | string; invitable: boolean; locked: boolean; }; topic: null | string; totalMessageSent: number; type: ChannelTypes; userLimit: number; videoQualityMode: VideoQualityModes; }; timestamp: string; tts: boolean; type: MessageTypes; webhookId: string; }>

Defined in: packages/rest/dist/types/types.d.ts:1893

Gets the initial message response to an interaction.

Parameters

token

string

The interaction token to use, provided in the original interaction.

Returns

An instance of DiscordMessage.

Remarks

Unlike getMessage(), this endpoint allows the bot user to act without:

Needing to be able to see the contents of the channel that the message is in. (READ_MESSAGES permission.)
Requiring the MESSAGE_CONTENT intent.

Does not support ephemeral follow-up messages due to these being stateless.

See

https://discord.com/developers/docs/interactions/receiving-and-responding#get-original-interaction-response

getOwnVoiceState()

getOwnVoiceState: (guildId) => Promise<{ channelId: null | string; deaf: boolean; guildId: string; member: { avatar: string; avatarDecorationData: null | { asset: string; skuId: string; }; banner: string; communicationDisabledUntil: null | string; deaf: boolean; flags: number; joinedAt: string; mute: boolean; nick: null | string; pending: boolean; permissions: string; premiumSince: null | string; roles: string[]; user: { accentColor: number; avatar: null | string; avatarDecorationData: { asset: string; skuId: string; }; banner: string; bot: boolean; discriminator: string; email: null | string; flags: number; globalName: null | string; id: string; locale: string; mfaEnabled: boolean; premiumType: PremiumTypes; publicFlags: number; system: boolean; username: string; verified: boolean; }; }; mute: boolean; requestToSpeakTimestamp: null | string; selfDeaf: boolean; selfMute: boolean; selfStream: boolean; selfVideo: boolean; sessionId: string; suppress: boolean; userId: string; }>

Defined in: packages/rest/dist/types/types.d.ts:2058

Returns the current user's voice state in the guild.

Parameters

guildId

https://discord.com/developers/docs/resources/voice#get-current-user-voice-state

The ID of the guild to get the voice state from.

Returns

Promise<{ channelId: null | string; deaf: boolean; guildId: string; member: { avatar: string; avatarDecorationData: null | { asset: string; skuId: string; }; banner: string; communicationDisabledUntil: null | string; deaf: boolean; flags: number; joinedAt: string; mute: boolean; nick: null | string; pending: boolean; permissions: string; premiumSince: null | string; roles: string[]; user: { accentColor: number; avatar: null | string; avatarDecorationData: { asset: string; skuId: string; }; banner: string; bot: boolean; discriminator: string; email: null | string; flags: number; globalName: null | string; id: string; locale: string; mfaEnabled: boolean; premiumType: PremiumTypes; publicFlags: number; system: boolean; username: string; verified: boolean; }; }; mute: boolean; requestToSpeakTimestamp: null | string; selfDeaf: boolean; selfMute: boolean; selfStream: boolean; selfVideo: boolean; sessionId: string; suppress: boolean; userId: string; }>

An instance of DiscordVoiceState.

See

getPinnedMessages()

getPinnedMessages: (channelId) => Promise<object[]>

Defined in: packages/rest/dist/types/types.d.ts:1908

Gets the pinned messages for a channel.

Parameters

channelId

https://discord.com/developers/docs/resources/channel#get-pinned-messages

The ID of the channel to get the pinned messages for.

Returns

Promise<object[]>

A collection of DiscordMessage objects assorted by message ID.

Remarks

Requires that the bot user be able to see the contents of the channel in which the messages were posted.

If getting a message from a guild channel:

Requires the READ_MESSAGE_HISTORY permission.

See

getPollAnswerVoters()

getPollAnswerVoters: (channelId, messageId, answerId, options?) => Promise<{ users: object[]; }>

Defined in: packages/rest/dist/types/types.d.ts:2465

Get a list of users that voted for this specific answer.

Parameters

channelId

The ID of the channel in which the message with the poll lives

messageId

The ID of the message in which the poll lives

answerId

number

The ID of the answer to get the users that voted that answer

options?

GetPollAnswerVotes

The options for the request

Returns

Promise<{ users: object[]; }>

The list of users that voted for the specific answer.

getPrivateArchivedThreads()

getPrivateArchivedThreads: (channelId, options?) => Promise<{ hasMore: boolean; members: object[]; threads: object[]; }>

Defined in: packages/rest/dist/types/types.d.ts:1926

Gets the list of private archived threads for a channel.

Parameters

channelId

https://discord.com/developers/docs/resources/channel#list-private-archived-threads

The ID of the channel to get the archived threads for.

options?

ListArchivedThreads

The parameters for the fetching of threads.

Returns

Promise<{ hasMore: boolean; members: object[]; threads: object[]; }>

An instance of DiscordArchivedThreads.

Remarks

Requires the READ_MESSAGE_HISTORY permission. Requires the MANAGE_THREADS permission.

Returns threads of type ChannelTypes.GuildPrivateThread.

Threads are ordered by the archive_timestamp property included in the metadata of the object in descending order.

See

getPrivateJoinedArchivedThreads()

getPrivateJoinedArchivedThreads: (channelId, options?) => Promise<{ hasMore: boolean; members: object[]; threads: object[]; }>

Defined in: packages/rest/dist/types/types.d.ts:1943

Gets the list of private archived threads the bot is a member of for a channel.

Parameters

channelId

https://discord.com/developers/docs/resources/channel#list-joined-private-archived-threads

The ID of the channel to get the archived threads for.

options?

ListArchivedThreads

The parameters for the fetching of threads.

Returns

Promise<{ hasMore: boolean; members: object[]; threads: object[]; }>

An instance of DiscordArchivedThreads.

Remarks

Requires the READ_MESSAGE_HISTORY permission.

Returns threads of type ChannelTypes.GuildPrivateThread.

Threads are ordered by the id property in descending order.

See

getPruneCount()

getPruneCount: (guildId, options?) => Promise<{ pruned: number; }>

Defined in: packages/rest/dist/types/types.d.ts:1956

Gets the number of members that would be kicked from a guild during pruning.

Parameters

guildId

GetGuildPruneCountQuery

The ID of the guild to get the prune count of.

options?

The parameters for the fetching of the prune count.

Returns

Promise<{ pruned: number; }>

A number indicating the number of members that would be kicked.

Remarks

Requires the MANAGE_GUILD and KICK_MEMBERS permissions.

See

https://discord.com/developers/docs/resources/guild#get-guild-prune-count

getPublicArchivedThreads()

getPublicArchivedThreads: (channelId, options?) => Promise<{ hasMore: boolean; members: object[]; threads: object[]; }>

Defined in: packages/rest/dist/types/types.d.ts:1974

Gets the list of public archived threads for a channel.

Parameters

channelId

https://discord.com/developers/docs/resources/channel#list-public-archived-threads

The ID of the channel to get the archived threads for.

options?

ListArchivedThreads

The parameters for the fetching of threads.

Returns

Promise<{ hasMore: boolean; members: object[]; threads: object[]; }>

An instance of DiscordArchivedThreads.

Remarks

Requires the READ_MESSAGE_HISTORY permission.

If called on a channel of type ChannelTypes.GuildText, returns threads of type ChannelTypes.GuildPublicThread. If called on a channel of type ChannelTypes.GuildNews, returns threads of type ChannelTypes.GuildNewsThread.

Threads are ordered by the archive_timestamp property included in the metadata of the object in descending order.

See

getReactions()

getReactions: (channelId, messageId, reaction, options?) => Promise<object[]>

Defined in: packages/rest/dist/types/types.d.ts:2111

Gets the list of users that reacted with an emoji to a message.

Parameters

channelId

The ID of the channel the message to get the users for is in.

messageId

https://discord.com/developers/docs/resources/channel#get-reactions

The ID of the message to get the users for.

reaction

string

The reaction for which to get the users.

options?

GetReactions

The parameters for the fetching of the users.

Returns

Promise<object[]>

A collection of DiscordUser objects assorted by user ID.

See

getRole()

getRole: (guildId, roleId) => Promise<{ color: number; flags: RoleFlags; hoist: boolean; icon: string; id: string; managed: boolean; mentionable: boolean; name: string; permissions: string; position: number; tags: { availableForPurchase: null; botId: string; guildConnections: null; integrationId: string; premiumSubscriber: null; subscriptionListingId: string; }; unicodeEmoji: string; }>

Defined in: packages/rest/dist/types/types.d.ts:1996

Gets a role by id for a guild.

Parameters

guildId

The ID of the guild to get role for.

roleId

https://discord.com/developers/docs/resources/guild#get-guild-role

The ID of the role.

Returns

A DiscordRole object.

See

getRoles()

getRoles: (guildId) => Promise<object[]>

Defined in: packages/rest/dist/types/types.d.ts:1986

Gets the list of roles for a guild.

Parameters

guildId

https://discord.com/developers/docs/resources/guild#get-guild-roles

The ID of the guild to get the list of roles for.

Returns

Promise<object[]>

A collection of DiscordRole objects assorted by role ID.

Remarks

⚠️ This endpoint should be used sparingly due to DiscordRole objects already being included in guild payloads.

See

getScheduledEvent()

getScheduledEvent: (guildId, eventId, options?) => Promise<{ channelId: null | string; creator: { accentColor: number; avatar: null | string; avatarDecorationData: { asset: string; skuId: string; }; banner: string; bot: boolean; discriminator: string; email: null | string; flags: number; globalName: null | string; id: string; locale: string; mfaEnabled: boolean; premiumType: PremiumTypes; publicFlags: number; system: boolean; username: string; verified: boolean; }; creatorId: null | string; description: string; entityId: null | string; entityMetadata: null | { location: string; }; entityType: ScheduledEventEntityType; guildId: string; id: string; image: null | string; name: string; privacyLevel: GuildOnly; recurrenceRule: null | { byMonth: null | DiscordScheduledEventRecurrenceRuleMonth[]; byMonthDay: null | number[]; byNWeekday: null | object[]; byWeekday: null | DiscordScheduledEventRecurrenceRuleWeekday[]; byYearDay: null | number[]; count: null | number; end: null | string; frequency: DiscordScheduledEventRecurrenceRuleFrequency; interval: number; start: string; }; scheduledEndTime: null | string; scheduledStartTime: string; status: ScheduledEventStatus; userCount: number; }>

Defined in: packages/rest/dist/types/types.d.ts:2007

Gets a scheduled event by its ID.

Parameters

guildId

The ID of the guild to get the scheduled event from.

eventId

https://discord.com/developers/docs/resources/guild-scheduled-event#get-guild-scheduled-event

The ID of the scheduled event to get.

options?

The parameters for the fetching of the scheduled event.

withUserCount

boolean

Returns

An instance of DiscordScheduledEvent.

See

getScheduledEvents()

getScheduledEvents: (guildId, options?) => Promise<object[]>

Defined in: packages/rest/dist/types/types.d.ts:2019

Gets the list of scheduled events for a guild.

Parameters

guildId

https://discord.com/developers/docs/resources/guild-scheduled-event#list-scheduled-events-for-guild

The ID of the guild to get the scheduled events from.

options?

GetScheduledEvents

The parameters for the fetching of the scheduled events.

Returns

Promise<object[]>

A collection of DiscordScheduledEvent objects assorted by event ID.

See

getScheduledEventUsers()

getScheduledEventUsers: (guildId, eventId, options?) => Promise<object[]>

Defined in: packages/rest/dist/types/types.d.ts:2035

Gets the list of subscribers to a scheduled event from a guild.

Parameters

guildId

The ID of the guild to get the subscribers to the scheduled event from.

eventId

https://discord.com/developers/docs/resources/guild-scheduled-event#get-guild-scheduled-event-users

The ID of the scheduled event to get the subscribers of.

options?

GetScheduledEventUsers

The parameters for the fetching of the subscribers.

Returns

Promise<object[]>

A collection of DiscordUser objects assorted by user ID.

Remarks

Requires the MANAGE_EVENTS permission.

Users are ordered by their IDs in ascending order.

See

getSessionInfo()

getSessionInfo: () => Promise<{ sessionStartLimit: { maxConcurrency: number; remaining: number; resetAfter: number; total: number; }; shards: number; url: string; }>

Defined in: packages/rest/dist/types/types.d.ts:2040

Get the bots Gateway metadata that can help during the operation of large or sharded bots.

Returns

Promise<{ sessionStartLimit: { maxConcurrency: number; remaining: number; resetAfter: number; total: number; }; shards: number; url: string; }>

getStageInstance()

getStageInstance: (channelId) => Promise<{ channelId: string; guildId: string; guildScheduledEventId: string; id: string; topic: string; }>

Defined in: packages/rest/dist/types/types.d.ts:2049

Gets the stage instance associated with a stage channel, if one exists.

Parameters

channelId

https://discord.com/developers/docs/resources/stage-instance#get-stage-instance

The ID of the stage channel the stage instance is associated with.

Returns

Promise<{ channelId: string; guildId: string; guildScheduledEventId: string; id: string; topic: string; }>

An instance of DiscordStageInstance.

See

getSticker()

getSticker: (stickerId) => Promise<{ available: boolean; description: string; formatType: StickerFormatTypes; guildId: string; id: string; name: string; packId: string; sortValue: number; tags: string; type: StickerTypes; user: { accentColor: number; avatar: null | string; avatarDecorationData: { asset: string; skuId: string; }; banner: string; bot: boolean; discriminator: string; email: null | string; flags: number; globalName: null | string; id: string; locale: string; mfaEnabled: boolean; premiumType: PremiumTypes; publicFlags: number; system: boolean; username: string; verified: boolean; }; }>

Defined in: packages/rest/dist/types/types.d.ts:2077

Returns a sticker object for the given sticker ID.

Parameters

stickerId

The ID of the sticker to get

Returns

https://discord.com/developers/docs/resources/sticker#get-sticker

See

getStickerPack()

getStickerPack: (stickerPackId) => Promise<{ bannerAssetId: string; coverStickerId: string; description: string; id: string; name: string; skuId: string; stickers: object[]; }>

Defined in: packages/rest/dist/types/types.d.ts:1869

Returns a sticker pack for the given ID.

Parameters

stickerPackId

https://discord.com/developers/docs/resources/sticker#get-sticker-pack

Returns

Promise<{ bannerAssetId: string; coverStickerId: string; description: string; id: string; name: string; skuId: string; stickers: object[]; }>

A DiscordStickerPack object.

See

getStickerPacks()

getStickerPacks: () => Promise<object[]>

Defined in: packages/rest/dist/types/types.d.ts:1877

Returns the list of sticker packs available.

Returns

Promise<object[]>

A collection of DiscordStickerPack objects assorted by sticker ID.

See

https://discord.com/developers/docs/resources/sticker#list-sticker-packs

getSubscription()

getSubscription: (skuId, subscriptionId) => Promise<{ canceledAt: null | string; country: string; currentPeriodEnd: string; currentPeriodStart: string; entitlementIds: string[]; id: string; renewalSkuIds: null | string[]; skuIds: string[]; status: DiscordSubscriptionStatus; userId: string; }>

Defined in: packages/rest/dist/types/types.d.ts:2840

Get a subscription by its ID.

Parameters

skuId

The id of the sku of get the subscriptions for

subscriptionId

Returns

Promise<{ canceledAt: null | string; country: string; currentPeriodEnd: string; currentPeriodStart: string; entitlementIds: string[]; id: string; renewalSkuIds: null | string[]; skuIds: string[]; status: DiscordSubscriptionStatus; userId: string; }>

getThreadMember()

getThreadMember: (channelId, userId) => Promise<{ flags: number; id: string; joinTimestamp: string; userId: string; }>

Defined in: packages/rest/dist/types/types.d.ts:2087

Gets a thread member by their user ID.

Parameters

channelId

The ID of the thread to get the thread member of.

userId

https://discord.com/developers/docs/resources/channel#get-thread-member

The user ID of the thread member to get.

Returns

Promise<{ flags: number; id: string; joinTimestamp: string; userId: string; }>

An instance of DiscordThreadMember.

See

getThreadMembers()

getThreadMembers: (channelId) => Promise<object[]>

Defined in: packages/rest/dist/types/types.d.ts:2099

Gets the list of thread members for a thread.

Parameters

channelId

https://discord.com/developers/docs/resources/channel#list-thread-members

The ID of the thread to get the thread members of.

Returns

Promise<object[]>

A collection of DiscordThreadMember assorted by user ID.

Remarks

Requires the application to have the GUILD_MEMBERS privileged intent enabled.

See

getUser()

getUser: (id) => Promise<{ accentColor: number; avatar: null | string; avatarDecorationData: { asset: string; skuId: string; }; banner: string; bot: boolean; discriminator: string; email: null | string; flags: number; globalName: null | string; id: string; locale: string; mfaEnabled: boolean; premiumType: PremiumTypes; publicFlags: number; system: boolean; username: string; verified: boolean; }>

Defined in: packages/rest/dist/types/types.d.ts:2118

Get a user's data from the api

Parameters

id

The user's id

Returns

getUserApplicationRoleConnection()

getUserApplicationRoleConnection: (bearerToken, applicationId) => Promise<{ metadata: {}; platformName: null | string; platformUsername: null | string; }>

Defined in: packages/rest/dist/types/types.d.ts:2153

Get the current user application role connection for the application.

Parameters

bearerToken

string

The access token of the user

applicationId

https://discord.com/developers/docs/resources/user#get-user-application-role-connection

The id of the application to get the role connection

Returns

Promise<{ metadata: {}; platformName: null | string; platformUsername: null | string; }>

Remarks

The access token requires the role_connections.write scope.

See

getUserConnections()

getUserConnections: (bearerToken) => Promise<object[]>

Defined in: packages/rest/dist/types/types.d.ts:2140

Get the current user connections.

Parameters

bearerToken

string

The access token of the user

Returns

Promise<object[]>

Remarks

This requires the connections scope.

getUserVoiceState()

getUserVoiceState: (guildId, userId) => Promise<{ channelId: null | string; deaf: boolean; guildId: string; member: { avatar: string; avatarDecorationData: null | { asset: string; skuId: string; }; banner: string; communicationDisabledUntil: null | string; deaf: boolean; flags: number; joinedAt: string; mute: boolean; nick: null | string; pending: boolean; permissions: string; premiumSince: null | string; roles: string[]; user: { accentColor: number; avatar: null | string; avatarDecorationData: { asset: string; skuId: string; }; banner: string; bot: boolean; discriminator: string; email: null | string; flags: number; globalName: null | string; id: string; locale: string; mfaEnabled: boolean; premiumType: PremiumTypes; publicFlags: number; system: boolean; username: string; verified: boolean; }; }; mute: boolean; requestToSpeakTimestamp: null | string; selfDeaf: boolean; selfMute: boolean; selfStream: boolean; selfVideo: boolean; sessionId: string; suppress: boolean; userId: string; }>

Defined in: packages/rest/dist/types/types.d.ts:2068

Returns the specified user's voice state in the guild.

Parameters

guildId

The ID of the guild to get the voice state from.

userId

https://discord.com/developers/docs/resources/voice#get-user-voice-state

The ID of the user to get the voice state from

Returns

An instance of DiscordVoiceState.

See

getVanityUrl()

getVanityUrl: (guildId) => Promise<{ code: null | string; uses: number; }>

Defined in: packages/rest/dist/types/types.d.ts:2167

Gets information about the vanity url of a guild.

Parameters

guildId

https://discord.com/developers/docs/resources/guild#get-guild-vanity-url

The ID of the guild to get the vanity url information for.

Returns

Promise<{ code: null | string; uses: number; }>

An instance of DiscordVanityUrl.

Remarks

Requires the MANAGE_GUILD permission.

The code property will be null if the guild does not have a set vanity url.

See

getVoiceRegions()

getVoiceRegions: (guildId) => Promise<object[]>

Defined in: packages/rest/dist/types/types.d.ts:2176

Gets the list of voice regions for a guild.

Parameters

guildId

https://discord.com/developers/docs/resources/guild#get-guild-voice-regions

The ID of the guild to get the voice regions for.

Returns

Promise<object[]>

A collection of DiscordVoiceRegion objects assorted by voice region ID.

See

getWebhook()

getWebhook: (webhookId) => Promise<Camelize<DiscordWebhook>>

Defined in: packages/rest/dist/types/types.d.ts:2188

Gets a webhook by its ID.

Parameters

webhookId

https://discord.com/developers/docs/resources/webhook#get-webhook

The ID of the webhook to get.

Returns

Promise<Camelize<DiscordWebhook>>

An instance of DiscordWebhook.

Remarks

Requires the MANAGE_WEBHOOKS permission unless the application making the request owns the webhook.

See

getWebhookMessage()

getWebhookMessage: (webhookId, token, messageId, options?) => Promise<{ activity: { partyId: string; type: MessageActivityTypes; }; application: { approximateGuildCount: number; approximateUserInstallCount: number; bot: { accentColor: number; avatar: null | string; avatarDecorationData: { asset: string; skuId: string; }; banner: string; bot: boolean; discriminator: string; email: null | string; flags: number; globalName: null | string; id: string; locale: string; mfaEnabled: boolean; premiumType: PremiumTypes; publicFlags: number; system: boolean; username: string; verified: boolean; }; botPublic: boolean; botRequireCodeGrant: boolean; coverImage: string; customInstallUrl: string; description: string; eventWebhooksStatus: DiscordApplicationEventWebhookStatus; eventWebhooksTypes: DiscordWebhookEventType[]; eventWebhooksUrl: null | string; flags: ApplicationFlags; guild: { afkChannelId: null | string; afkTimeout: number; applicationId: null | string; approximateMemberCount: number; approximatePresenceCount: number; banner: null | string; channels: object[]; defaultMessageNotifications: DefaultMessageNotificationLevels; description: null | string; discoverySplash: null | string; emojis: object[]; explicitContentFilter: ExplicitContentFilterLevels; features: GuildFeatures[]; icon: null | string; iconHash: null | string; id: string; joinedAt: string; large: boolean; maxMembers: number; maxPresences: null | number; maxStageVideoChannelUsers: number; maxVideoChannelUsers: number; memberCount: number; members: object[]; mfaLevel: MfaLevels; name: string; nsfwLevel: GuildNsfwLevel; owner: boolean; ownerId: string; permissions: string; preferredLocale: string; premiumProgressBarEnabled: boolean; premiumSubscriptionCount: number; premiumTier: PremiumTiers; presences: object[]; publicUpdatesChannelId: null | string; roles: object[]; rulesChannelId: null | string; safetyAlertsChannelId: null | string; soundboardSounds: object[]; splash: null | string; stageInstances: object[]; stickers: object[]; systemChannelFlags: SystemChannelFlags; systemChannelId: null | string; threads: object[]; unavailable: boolean; vanityUrlCode: null | string; verificationLevel: VerificationLevels; voiceStates: object[]; welcomeScreen: { description: null | string; welcomeChannels: object[]; }; widgetChannelId: null | string; widgetEnabled: boolean; }; guildId: string; icon: null | string; id: string; installParams: { permissions: string; scopes: OAuth2Scope[]; }; integrationTypesConfig: { 0: { oauth2InstallParams: { permissions: ...; scopes: ...; }; }; 1: { oauth2InstallParams: { permissions: ...; scopes: ...; }; }; }; interactionsEndpointUrl: null | string; name: string; owner: { accentColor: number; avatar: null | string; avatarDecorationData: { asset: string; skuId: string; }; banner: string; bot: boolean; discriminator: string; email: null | string; flags: number; globalName: null | string; id: string; locale: string; mfaEnabled: boolean; premiumType: PremiumTypes; publicFlags: number; system: boolean; username: string; verified: boolean; }; primarySkuId: string; privacyPolicyUrl: string; redirectUris: string[]; roleConnectionsVerificationUrl: null | string; rpcOrigins: string[]; slug: string; tags: string[]; team: null | { icon: null | string; id: string; members: object[]; name: string; ownerUserId: string; }; termsOfServiceUrl: string; verifyKey: string; }; applicationId: string; attachments: object[]; author: { accentColor: number; avatar: null | string; avatarDecorationData: { asset: string; skuId: string; }; banner: string; bot: boolean; discriminator: string; email: null | string; flags: number; globalName: null | string; id: string; locale: string; mfaEnabled: boolean; premiumType: PremiumTypes; publicFlags: number; system: boolean; username: string; verified: boolean; }; call: { endedTimestamp: string; participants: string[]; }; channelId: string; components: ({ components: ({ channelTypes: ... | ...; customId: string; defaultValues: ... | ...; disabled: ... | ... | ...; maxValues: ... | ...; minValues: ... | ...; options: ... | ...; placeholder: ... | ...; type: ... | ... | ... | ... | ...; } | { customId: ... | ...; disabled: ... | ... | ...; emoji: ... | ...; label: ... | ...; skuId: ... | ...; style: ButtonStyles; type: Button; url: ... | ...; } | { customId: string; label: string; maxLength: ... | ...; minLength: ... | ...; placeholder: ... | ...; required: ... | ... | ...; style: TextStyles; type: InputText; value: ... | ...; })[]; type: ActionRow; } | { channelTypes: ChannelTypes[]; customId: string; defaultValues: object[]; disabled: boolean; maxValues: number; minValues: number; options: object[]; placeholder: string; type: SelectMenu | SelectMenuUsers | SelectMenuRoles | SelectMenuUsersAndRoles | SelectMenuChannels; } | { customId: string; disabled: boolean; emoji: { animated: boolean; id: string; name: string; }; label: string; skuId: string; style: ButtonStyles; type: Button; url: string; } | { customId: string; label: string; maxLength: number; minLength: number; placeholder: string; required: boolean; style: TextStyles; type: InputText; value: string; })[]; content: string; editedTimestamp: null | string; embeds: object[]; flags: MessageFlags; guildId: string; id: string; interaction: { id: string; member: { avatar: string; avatarDecorationData: null | { asset: string; skuId: string; }; banner: string; communicationDisabledUntil: null | string; deaf: boolean; flags: number; joinedAt: string; mute: boolean; nick: null | string; pending: boolean; permissions: string; premiumSince: null | string; roles: string[]; user: { accentColor: number; avatar: null | string; avatarDecorationData: { asset: ...; skuId: ...; }; banner: string; bot: boolean; discriminator: string; email: null | string; flags: number; globalName: null | string; id: string; locale: string; mfaEnabled: boolean; premiumType: PremiumTypes; publicFlags: number; system: boolean; username: string; verified: boolean; }; }; name: string; type: InteractionTypes; user: { accentColor: number; avatar: null | string; avatarDecorationData: { asset: string; skuId: string; }; banner: string; bot: boolean; discriminator: string; email: null | string; flags: number; globalName: null | string; id: string; locale: string; mfaEnabled: boolean; premiumType: PremiumTypes; publicFlags: number; system: boolean; username: string; verified: boolean; }; }; interactionMetadata: { authorizingIntegrationOwners: { 0: string; 1: string; }; id: string; originalResponseMessageId: string; targetMessageId: string; targetUser: { accentColor: number; avatar: null | string; avatarDecorationData: { asset: string; skuId: string; }; banner: string; bot: boolean; discriminator: string; email: null | string; flags: number; globalName: null | string; id: string; locale: string; mfaEnabled: boolean; premiumType: PremiumTypes; publicFlags: number; system: boolean; username: string; verified: boolean; }; type: InteractionTypes; user: { accentColor: number; avatar: null | string; avatarDecorationData: { asset: string; skuId: string; }; banner: string; bot: boolean; discriminator: string; email: null | string; flags: number; globalName: null | string; id: string; locale: string; mfaEnabled: boolean; premiumType: PremiumTypes; publicFlags: number; system: boolean; username: string; verified: boolean; }; } | { authorizingIntegrationOwners: { 0: string; 1: string; }; id: string; interactedMessageId: string; originalResponseMessageId: string; type: InteractionTypes; user: { accentColor: number; avatar: null | string; avatarDecorationData: { asset: string; skuId: string; }; banner: string; bot: boolean; discriminator: string; email: null | string; flags: number; globalName: null | string; id: string; locale: string; mfaEnabled: boolean; premiumType: PremiumTypes; publicFlags: number; system: boolean; username: string; verified: boolean; }; } | { authorizingIntegrationOwners: { 0: string; 1: string; }; id: string; originalResponseMessageId: string; triggeringInteractionMetadata: { id: string; type: InteractionTypes; user: { username: string; globalName: string | null; locale?: string | undefined; flags?: number | undefined; premiumType?: PremiumTypes | undefined; ... 11 more ...; avatarDecorationData?: { ...; } | undefined; }; authorizingIntegrationOwners: { ...; }; originalResponseMessageI...; type: InteractionTypes; user: { accentColor: number; avatar: null | string; avatarDecorationData: { asset: string; skuId: string; }; banner: string; bot: boolean; discriminator: string; email: null | string; flags: number; globalName: null | string; id: string; locale: string; mfaEnabled: boolean; premiumType: PremiumTypes; publicFlags: number; system: boolean; username: string; verified: boolean; }; }; member: { avatar: string; avatarDecorationData: null | { asset: string; skuId: string; }; banner: string; communicationDisabledUntil: null | string; deaf: boolean; flags: number; joinedAt: string; mute: boolean; nick: null | string; pending: boolean; permissions: string; premiumSince: null | string; roles: string[]; user: { accentColor: number; avatar: null | string; avatarDecorationData: { asset: string; skuId: string; }; banner: string; bot: boolean; discriminator: string; email: null | string; flags: number; globalName: null | string; id: string; locale: string; mfaEnabled: boolean; premiumType: PremiumTypes; publicFlags: number; system: boolean; username: string; verified: boolean; }; }; mentionChannels: object[]; mentionEveryone: boolean; mentionRoles: string[]; mentions: object[]; messageReference: { channelId: string; failIfNotExists: boolean; guildId: string; messageId: string; type: DiscordMessageReferenceType; }; messageSnapshots: object[]; nonce: string | number; pinned: boolean; poll: { allowMultiselect: boolean; answers: object[]; expiry: null | string; layoutType: Default; question: { emoji: { animated: boolean; available: boolean; id: string; managed: boolean; name: string; requireColons: boolean; roles: string[]; user: { accentColor: ... | ...; avatar: ... | ...; avatarDecorationData: ... | ...; banner: ... | ...; bot: ... | ... | ...; discriminator: string; email: ... | ... | ...; flags: ... | ...; globalName: ... | ...; id: string; locale: ... | ...; mfaEnabled: ... | ... | ...; premiumType: ... | ...; publicFlags: ... | ...; system: ... | ... | ...; username: string; verified: ... | ... | ...; }; }; text: string; }; results: { answerCounts: object[]; isFinalized: boolean; }; }; position: number; reactions: object[]; referencedMessage: { id: string; channelId: string; guildId?: string | undefined; author: { username: string; globalName: string | null; locale?: string | undefined; flags?: number | undefined; premiumType?: PremiumTypes | undefined; ... 11 more ...; avatarDecorationData?: { ...; } | undefined; }; ... 31 more ...; call?: { ...; } | un...; stickerItems: object[]; stickers: object[]; thread: { applicationId: string; appliedTags: string[]; availableTags: object[]; bitrate: number; defaultAutoArchiveDuration: number; defaultForumLayout: ForumLayout; defaultReactionEmoji: null | { emojiId: string; emojiName: null | string; }; defaultSortOrder: null | SortOrderTypes; defaultThreadRateLimitPerUser: number; flags: ChannelFlags; guildId: string; icon: string; id: string; lastMessageId: null | string; lastPinTimestamp: null | string; managed: boolean; member: { flags: number; id: string; joinTimestamp: string; userId: string; }; memberCount: number; messageCount: number; name: string; newlyCreated: boolean; nsfw: boolean; ownerId: string; parentId: null | string; permissionOverwrites: object[]; permissions: string; position: number; rateLimitPerUser: number; recipients: object[]; rtcRegion: null | string; threadMetadata: { archived: boolean; archiveTimestamp: string; autoArchiveDuration: 60 | 1440 | 4320 | 10080; createTimestamp: null | string; invitable: boolean; locked: boolean; }; topic: null | string; totalMessageSent: number; type: ChannelTypes; userLimit: number; videoQualityMode: VideoQualityModes; }; timestamp: string; tts: boolean; type: MessageTypes; webhookId: string; }>

Defined in: packages/rest/dist/types/types.d.ts:2200

Gets a webhook message by its ID.

Parameters

webhookId

The ID of the webhook to get a message of.

token

string

The webhook token, used to get webhook messages.

messageId

GetWebhookMessageOptions

the ID of the webhook message to get.

options?

The parameters for the fetching of the message.

Returns

An instance of DiscordMessage.

See

https://discord.com/developers/docs/resources/webhook#get-webhook-message

getWebhookWithToken()

getWebhookWithToken: (webhookId, token) => Promise<Camelize<DiscordWebhook>>

Defined in: packages/rest/dist/types/types.d.ts:2210

Gets a webhook using the webhook token, thereby bypassing the need for authentication + permissions.

Parameters

webhookId

https://discord.com/developers/docs/resources/webhook#get-webhook-with-token

The ID of the webhook to get.

token

string

The webhook token, used to get the webhook.

Returns

Promise<Camelize<DiscordWebhook>>

An instance of DiscordWebhook.

See

getWelcomeScreen()

getWelcomeScreen: (guildId) => Promise<{ description: null | string; welcomeChannels: object[]; }>

Defined in: packages/rest/dist/types/types.d.ts:2223

Gets the welcome screen for a guild.

Parameters

guildId

https://discord.com/developers/docs/resources/guild#get-guild-welcome-screen

The ID of the guild to get the welcome screen for.

Returns

Promise<{ description: null | string; welcomeChannels: object[]; }>

An instance of DiscordWelcomeScreen.

Remarks

If the welcome screen is not enabled:

Requires the MANAGE_GUILD permission.

See

getWidget()

getWidget: (guildId) => Promise<{ channels: object[]; id: string; instantInvite: string; members: object[]; name: string; presenceCount: number; }>

Defined in: packages/rest/dist/types/types.d.ts:2235

Gets the guild widget by guild ID.

Parameters

guildId

https://discord.com/developers/docs/resources/guild#get-guild-widget

The ID of the guild to get the widget of.

Returns

Promise<{ channels: object[]; id: string; instantInvite: string; members: object[]; name: string; presenceCount: number; }>

An instance of DiscordGuildWidget.

Remarks

Fires an INVITE_CREATED Gateway event when an invite channel is defined and a new Invite is generated.

See

getWidgetSettings()

getWidgetSettings: (guildId) => Promise<{ channelId: null | string; enabled: boolean; }>

Defined in: packages/rest/dist/types/types.d.ts:2247

Gets the settings of a guild's widget.

Parameters

guildId

https://discord.com/developers/docs/resources/guild#get-guild-widget-settings

The ID of the guild to get the widget of.

Returns

Promise<{ channelId: null | string; enabled: boolean; }>

An instance of DiscordGuildWidgetSettings.

Remarks

Requires the MANAGE_GUILD permission.

See

globallyRateLimited

globallyRateLimited: boolean

Defined in: packages/rest/dist/types/types.d.ts:83

Whether or not the manager is rate limited globally across all requests. Defaults to false.

invalidBucket

invalidBucket: InvalidRequestBucket

Defined in: packages/rest/dist/types/types.d.ts:93

The bucket for handling any invalid requests.

isProxied

isProxied: boolean

Defined in: packages/rest/dist/types/types.d.ts:73

true if the baseUrl does not start with https://discord.com/api.

Mostly used only for intern functions.

joinThread()

joinThread: (channelId) => Promise<void>

Defined in: packages/rest/dist/types/types.d.ts:2260

Adds the bot user to a thread.

Parameters

channelId

https://discord.com/developers/docs/resources/channel#join-thread

The ID of the thread to add the bot user to.

Returns

Promise<void>

Remarks

Requires the thread not be archived.

Fires a Thread Members Update gateway event.

See

kickMember()

kickMember: (guildId, userId, reason?) => Promise<void>

Defined in: packages/rest/dist/types/types.d.ts:2674

Kicks a member from a guild.

Parameters

guildId

The ID of the guild to kick the member from.

userId

https://discord.com/developers/docs/resources/guild#remove-guild-member

The user ID of the member to kick from the guild.

reason?

string

An optional reason for the action, to be included in the audit log.

Returns

Promise<void>

Remarks

Requires the KICK_MEMBERS permission.

Fires a Guild Member Remove gateway event.

See

leaveGuild()

leaveGuild: (guildId) => Promise<void>

Defined in: packages/rest/dist/types/types.d.ts:2271

Leaves a guild.

Parameters

guildId

https://discord.com/developers/docs/resources/user#leave-guild

The ID of the guild to leave.

Returns

Promise<void>

Remarks

Fires a Guild Delete event.

See

leaveThread()

leaveThread: (channelId) => Promise<void>

Defined in: packages/rest/dist/types/types.d.ts:2284

Removes the bot user from a thread.

Parameters

channelId

https://discord.com/developers/docs/resources/channel#leave-thread

The ID of the thread to remove the bot user from.

Returns

Promise<void>

Remarks

Requires the thread not be archived.

Fires a Thread Members Update gateway event.

See

listDefaultSoundboardSounds()

listDefaultSoundboardSounds: () => Promise<object[]>

Defined in: packages/rest/dist/types/types.d.ts:2854

Returns an array of soundboard sound objects that can be used by all users.

Returns

Promise<object[]>

listEntitlements()

listEntitlements: (applicationId, options?) => Promise<object[]>

Defined in: packages/rest/dist/types/types.d.ts:2790

Returns all entitlements for a given app, active and expired.

Parameters

applicationId

The id of the application to get the entitlements

options?

GetEntitlements

The optional query params for the endpoint

Returns

Promise<object[]>

listGuildSoundboardSounds()

listGuildSoundboardSounds: (guildId) => Promise<{ items: object[]; }>

Defined in: packages/rest/dist/types/types.d.ts:2863

Returns a list of the guild's soundboard sounds.

Parameters

guildId

The guild to get the sounds from

Returns

Promise<{ items: object[]; }>

Remarks

Includes user fields if the bot has the CREATE_GUILD_EXPRESSIONS or MANAGE_GUILD_EXPRESSIONS permission.

listSkus()

listSkus: (applicationId) => Promise<object[]>

Defined in: packages/rest/dist/types/types.d.ts:2828

Returns all SKUs for a given application

Parameters

applicationId

The id of the application to get the SKUs

Returns

Promise<object[]>

listSubscriptions()

listSubscriptions: (skuId, options?) => Promise<object[]>

Defined in: packages/rest/dist/types/types.d.ts:2834

Returns all subscriptions containing the SKU, filtered by user.

Parameters

skuId

ListSkuSubscriptionsOptions

The id of the sku of get the subscriptions for

options?

Returns

Promise<object[]>

logger

logger: Pick<{ debug: (...args) => void; error: (...args) => void; fatal: (...args) => void; info: (...args) => void; log: (level, ...args) => void; setDepth: (level) => void; setLevel: (level) => void; warn: (...args) => void; }, "debug" | "info" | "warn" | "error" | "fatal">

Defined in: packages/rest/dist/types/types.d.ts:97

The logger to use for the rest manager

makeRequest()

makeRequest: <T>(method, url, options?) => Promise<T>

Defined in: packages/rest/dist/types/types.d.ts:118

Make a request to be sent to the api.

Type Parameters

• T = unknown

Parameters

method

RequestMethods

url

string

options?

Returns

Promise<T>

maxRetryCount

maxRetryCount: number

Defined in: packages/rest/dist/types/types.d.ts:81

The maximum amount of times a request should be retried. Defaults to Infinity

modifyGuildSoundboardSound()

modifyGuildSoundboardSound: (guildId, soundId, options, reason?) => Promise<{ available: boolean; emojiId: null | string; emojiName: null | string; guildId: string; name: string; soundId: string; user: { accentColor: number; avatar: null | string; avatarDecorationData: { asset: string; skuId: string; }; banner: string; bot: boolean; discriminator: string; email: null | string; flags: number; globalName: null | string; id: string; locale: string; mfaEnabled: boolean; premiumType: PremiumTypes; publicFlags: number; system: boolean; username: string; verified: boolean; }; volume: number; }>

Defined in: packages/rest/dist/types/types.d.ts:2903

Modify the given soundboard sound.

Parameters

guildId

The guild to create the sounds in

soundId

ModifyGuildSoundboardSound

The sound id to update

options

The options to update the sound

reason?

string

The audit log reason

Returns

Remarks

Fires a Guild Soundboard Sound Update Gateway event.

For sounds created by the current user, requires either the CREATE_GUILD_EXPRESSIONS or MANAGE_GUILD_EXPRESSIONS permission. For other sounds, requires the MANAGE_GUILD_EXPRESSIONS permission.

patch()

patch: <T>(url, options?) => Promise<Camelize<T>>

Defined in: packages/rest/dist/types/types.d.ts:130

Make a patch request to the api.

Type Parameters

• T = void

Parameters

url

string

options?

Returns

Promise<Camelize<T>>

pinMessage()

pinMessage: (channelId, messageId, reason?) => Promise<void>

Defined in: packages/rest/dist/types/types.d.ts:2693

Pins a message in a channel.

Parameters

channelId

The ID of the channel where the message is to be pinned.

messageId

https://discord.com/developers/docs/resources/channel#pin-message

The ID of the message to pin.

reason?

string

An optional reason for the action, to be included in the audit log.

Returns

Promise<void>

Remarks

Requires that the bot user be able to see the contents of the channel in which the messages were posted.

Requires the MANAGE_MESSAGES permission.

⚠️ There can only be at max 50 messages pinned in a channel.

Fires a Channel Pins Update event.

See

post()

post: <T>(url, options?) => Promise<Camelize<T>>

Defined in: packages/rest/dist/types/types.d.ts:124

Make a post request to the api.

Type Parameters

• T = void

Parameters

url

string

options?

Returns

Promise<Camelize<T>>

preferSnakeCase()

preferSnakeCase: (enabled) => RestManager

Defined in: packages/rest/dist/types/types.d.ts:101

Whether or not the rest manager should keep objects in raw snake case from discord.

Parameters

enabled

boolean

Returns

RestManager

processHeaders()

processHeaders: (url, headers, identifier) => undefined | string

Defined in: packages/rest/dist/types/types.d.ts:112

Processes the rate limit headers and determines if it needs to be rate limited and returns the bucket id if available

Parameters

url

string

headers

Headers

identifier

string

Returns

undefined | string

processingRateLimitedPaths

processingRateLimitedPaths: boolean

Defined in: packages/rest/dist/types/types.d.ts:85

Whether or not the rate limited paths are being processed to allow requests to be made once time is up. Defaults to false.

processRateLimitedPaths()

processRateLimitedPaths: () => void

Defined in: packages/rest/dist/types/types.d.ts:110

This will create a infinite loop running in 1 seconds using tail recursion to keep rate limits clean. When a rate limit resets, this will remove it so the queue can proceed.

Returns

void

processRequest()

processRequest: (request) => Promise<void>

Defined in: packages/rest/dist/types/types.d.ts:120

Takes a request and processes it into a queue.

Parameters

request

SendRequestOptions

Returns

Promise<void>

pruneMembers()

pruneMembers: (guildId, options, reason?) => Promise<{ pruned: null | number; }>

Defined in: packages/rest/dist/types/types.d.ts:2714

Initiates the process of pruning inactive members.

Parameters

guildId

https://discord.com/developers/docs/resources/guild#begin-guild-prune

The ID of the guild to prune the members of.

options

BeginGuildPrune

The parameters for the pruning of members.

reason?

string

An optional reason for the action, to be included in the audit log.

Returns

Promise<{ pruned: null | number; }>

A number indicating how many members were pruned.

Remarks

Requires the MANAGE_GUILD and KICK_MEMBERS permissions.

❗ Requests to this endpoint will time out for large guilds. To prevent this from happening, set the BeginGuildPrune.computePruneCount property of the options object parameter to false. This will begin the process of pruning, and immediately return undefined, rather than wait for the process to complete before returning the actual count of members that have been kicked.

⚠️ By default, this process will not remove members with a role. To include the members who have a particular subset of roles, specify the role(s) in the includeRoles property of the options object parameter.

Fires a Guild Member Remove gateway event for every member kicked.

See

publishMessage()

publishMessage: (channelId, messageId) => Promise<{ activity: { partyId: string; type: MessageActivityTypes; }; application: { approximateGuildCount: number; approximateUserInstallCount: number; bot: { accentColor: number; avatar: null | string; avatarDecorationData: { asset: string; skuId: string; }; banner: string; bot: boolean; discriminator: string; email: null | string; flags: number; globalName: null | string; id: string; locale: string; mfaEnabled: boolean; premiumType: PremiumTypes; publicFlags: number; system: boolean; username: string; verified: boolean; }; botPublic: boolean; botRequireCodeGrant: boolean; coverImage: string; customInstallUrl: string; description: string; eventWebhooksStatus: DiscordApplicationEventWebhookStatus; eventWebhooksTypes: DiscordWebhookEventType[]; eventWebhooksUrl: null | string; flags: ApplicationFlags; guild: { afkChannelId: null | string; afkTimeout: number; applicationId: null | string; approximateMemberCount: number; approximatePresenceCount: number; banner: null | string; channels: object[]; defaultMessageNotifications: DefaultMessageNotificationLevels; description: null | string; discoverySplash: null | string; emojis: object[]; explicitContentFilter: ExplicitContentFilterLevels; features: GuildFeatures[]; icon: null | string; iconHash: null | string; id: string; joinedAt: string; large: boolean; maxMembers: number; maxPresences: null | number; maxStageVideoChannelUsers: number; maxVideoChannelUsers: number; memberCount: number; members: object[]; mfaLevel: MfaLevels; name: string; nsfwLevel: GuildNsfwLevel; owner: boolean; ownerId: string; permissions: string; preferredLocale: string; premiumProgressBarEnabled: boolean; premiumSubscriptionCount: number; premiumTier: PremiumTiers; presences: object[]; publicUpdatesChannelId: null | string; roles: object[]; rulesChannelId: null | string; safetyAlertsChannelId: null | string; soundboardSounds: object[]; splash: null | string; stageInstances: object[]; stickers: object[]; systemChannelFlags: SystemChannelFlags; systemChannelId: null | string; threads: object[]; unavailable: boolean; vanityUrlCode: null | string; verificationLevel: VerificationLevels; voiceStates: object[]; welcomeScreen: { description: null | string; welcomeChannels: object[]; }; widgetChannelId: null | string; widgetEnabled: boolean; }; guildId: string; icon: null | string; id: string; installParams: { permissions: string; scopes: OAuth2Scope[]; }; integrationTypesConfig: { 0: { oauth2InstallParams: { permissions: ...; scopes: ...; }; }; 1: { oauth2InstallParams: { permissions: ...; scopes: ...; }; }; }; interactionsEndpointUrl: null | string; name: string; owner: { accentColor: number; avatar: null | string; avatarDecorationData: { asset: string; skuId: string; }; banner: string; bot: boolean; discriminator: string; email: null | string; flags: number; globalName: null | string; id: string; locale: string; mfaEnabled: boolean; premiumType: PremiumTypes; publicFlags: number; system: boolean; username: string; verified: boolean; }; primarySkuId: string; privacyPolicyUrl: string; redirectUris: string[]; roleConnectionsVerificationUrl: null | string; rpcOrigins: string[]; slug: string; tags: string[]; team: null | { icon: null | string; id: string; members: object[]; name: string; ownerUserId: string; }; termsOfServiceUrl: string; verifyKey: string; }; applicationId: string; attachments: object[]; author: { accentColor: number; avatar: null | string; avatarDecorationData: { asset: string; skuId: string; }; banner: string; bot: boolean; discriminator: string; email: null | string; flags: number; globalName: null | string; id: string; locale: string; mfaEnabled: boolean; premiumType: PremiumTypes; publicFlags: number; system: boolean; username: string; verified: boolean; }; call: { endedTimestamp: string; participants: string[]; }; channelId: string; components: ({ components: ({ channelTypes: ... | ...; customId: string; defaultValues: ... | ...; disabled: ... | ... | ...; maxValues: ... | ...; minValues: ... | ...; options: ... | ...; placeholder: ... | ...; type: ... | ... | ... | ... | ...; } | { customId: ... | ...; disabled: ... | ... | ...; emoji: ... | ...; label: ... | ...; skuId: ... | ...; style: ButtonStyles; type: Button; url: ... | ...; } | { customId: string; label: string; maxLength: ... | ...; minLength: ... | ...; placeholder: ... | ...; required: ... | ... | ...; style: TextStyles; type: InputText; value: ... | ...; })[]; type: ActionRow; } | { channelTypes: ChannelTypes[]; customId: string; defaultValues: object[]; disabled: boolean; maxValues: number; minValues: number; options: object[]; placeholder: string; type: SelectMenu | SelectMenuUsers | SelectMenuRoles | SelectMenuUsersAndRoles | SelectMenuChannels; } | { customId: string; disabled: boolean; emoji: { animated: boolean; id: string; name: string; }; label: string; skuId: string; style: ButtonStyles; type: Button; url: string; } | { customId: string; label: string; maxLength: number; minLength: number; placeholder: string; required: boolean; style: TextStyles; type: InputText; value: string; })[]; content: string; editedTimestamp: null | string; embeds: object[]; flags: MessageFlags; guildId: string; id: string; interaction: { id: string; member: { avatar: string; avatarDecorationData: null | { asset: string; skuId: string; }; banner: string; communicationDisabledUntil: null | string; deaf: boolean; flags: number; joinedAt: string; mute: boolean; nick: null | string; pending: boolean; permissions: string; premiumSince: null | string; roles: string[]; user: { accentColor: number; avatar: null | string; avatarDecorationData: { asset: ...; skuId: ...; }; banner: string; bot: boolean; discriminator: string; email: null | string; flags: number; globalName: null | string; id: string; locale: string; mfaEnabled: boolean; premiumType: PremiumTypes; publicFlags: number; system: boolean; username: string; verified: boolean; }; }; name: string; type: InteractionTypes; user: { accentColor: number; avatar: null | string; avatarDecorationData: { asset: string; skuId: string; }; banner: string; bot: boolean; discriminator: string; email: null | string; flags: number; globalName: null | string; id: string; locale: string; mfaEnabled: boolean; premiumType: PremiumTypes; publicFlags: number; system: boolean; username: string; verified: boolean; }; }; interactionMetadata: { authorizingIntegrationOwners: { 0: string; 1: string; }; id: string; originalResponseMessageId: string; targetMessageId: string; targetUser: { accentColor: number; avatar: null | string; avatarDecorationData: { asset: string; skuId: string; }; banner: string; bot: boolean; discriminator: string; email: null | string; flags: number; globalName: null | string; id: string; locale: string; mfaEnabled: boolean; premiumType: PremiumTypes; publicFlags: number; system: boolean; username: string; verified: boolean; }; type: InteractionTypes; user: { accentColor: number; avatar: null | string; avatarDecorationData: { asset: string; skuId: string; }; banner: string; bot: boolean; discriminator: string; email: null | string; flags: number; globalName: null | string; id: string; locale: string; mfaEnabled: boolean; premiumType: PremiumTypes; publicFlags: number; system: boolean; username: string; verified: boolean; }; } | { authorizingIntegrationOwners: { 0: string; 1: string; }; id: string; interactedMessageId: string; originalResponseMessageId: string; type: InteractionTypes; user: { accentColor: number; avatar: null | string; avatarDecorationData: { asset: string; skuId: string; }; banner: string; bot: boolean; discriminator: string; email: null | string; flags: number; globalName: null | string; id: string; locale: string; mfaEnabled: boolean; premiumType: PremiumTypes; publicFlags: number; system: boolean; username: string; verified: boolean; }; } | { authorizingIntegrationOwners: { 0: string; 1: string; }; id: string; originalResponseMessageId: string; triggeringInteractionMetadata: { id: string; type: InteractionTypes; user: { username: string; globalName: string | null; locale?: string | undefined; flags?: number | undefined; premiumType?: PremiumTypes | undefined; ... 11 more ...; avatarDecorationData?: { ...; } | undefined; }; authorizingIntegrationOwners: { ...; }; originalResponseMessageI...; type: InteractionTypes; user: { accentColor: number; avatar: null | string; avatarDecorationData: { asset: string; skuId: string; }; banner: string; bot: boolean; discriminator: string; email: null | string; flags: number; globalName: null | string; id: string; locale: string; mfaEnabled: boolean; premiumType: PremiumTypes; publicFlags: number; system: boolean; username: string; verified: boolean; }; }; member: { avatar: string; avatarDecorationData: null | { asset: string; skuId: string; }; banner: string; communicationDisabledUntil: null | string; deaf: boolean; flags: number; joinedAt: string; mute: boolean; nick: null | string; pending: boolean; permissions: string; premiumSince: null | string; roles: string[]; user: { accentColor: number; avatar: null | string; avatarDecorationData: { asset: string; skuId: string; }; banner: string; bot: boolean; discriminator: string; email: null | string; flags: number; globalName: null | string; id: string; locale: string; mfaEnabled: boolean; premiumType: PremiumTypes; publicFlags: number; system: boolean; username: string; verified: boolean; }; }; mentionChannels: object[]; mentionEveryone: boolean; mentionRoles: string[]; mentions: object[]; messageReference: { channelId: string; failIfNotExists: boolean; guildId: string; messageId: string; type: DiscordMessageReferenceType; }; messageSnapshots: object[]; nonce: string | number; pinned: boolean; poll: { allowMultiselect: boolean; answers: object[]; expiry: null | string; layoutType: Default; question: { emoji: { animated: boolean; available: boolean; id: string; managed: boolean; name: string; requireColons: boolean; roles: string[]; user: { accentColor: ... | ...; avatar: ... | ...; avatarDecorationData: ... | ...; banner: ... | ...; bot: ... | ... | ...; discriminator: string; email: ... | ... | ...; flags: ... | ...; globalName: ... | ...; id: string; locale: ... | ...; mfaEnabled: ... | ... | ...; premiumType: ... | ...; publicFlags: ... | ...; system: ... | ... | ...; username: string; verified: ... | ... | ...; }; }; text: string; }; results: { answerCounts: object[]; isFinalized: boolean; }; }; position: number; reactions: object[]; referencedMessage: { id: string; channelId: string; guildId?: string | undefined; author: { username: string; globalName: string | null; locale?: string | undefined; flags?: number | undefined; premiumType?: PremiumTypes | undefined; ... 11 more ...; avatarDecorationData?: { ...; } | undefined; }; ... 31 more ...; call?: { ...; } | un...; stickerItems: object[]; stickers: object[]; thread: { applicationId: string; appliedTags: string[]; availableTags: object[]; bitrate: number; defaultAutoArchiveDuration: number; defaultForumLayout: ForumLayout; defaultReactionEmoji: null | { emojiId: string; emojiName: null | string; }; defaultSortOrder: null | SortOrderTypes; defaultThreadRateLimitPerUser: number; flags: ChannelFlags; guildId: string; icon: string; id: string; lastMessageId: null | string; lastPinTimestamp: null | string; managed: boolean; member: { flags: number; id: string; joinTimestamp: string; userId: string; }; memberCount: number; messageCount: number; name: string; newlyCreated: boolean; nsfw: boolean; ownerId: string; parentId: null | string; permissionOverwrites: object[]; permissions: string; position: number; rateLimitPerUser: number; recipients: object[]; rtcRegion: null | string; threadMetadata: { archived: boolean; archiveTimestamp: string; autoArchiveDuration: 60 | 1440 | 4320 | 10080; createTimestamp: null | string; invitable: boolean; locked: boolean; }; topic: null | string; totalMessageSent: number; type: ChannelTypes; userLimit: number; videoQualityMode: VideoQualityModes; }; timestamp: string; tts: boolean; type: MessageTypes; webhookId: string; }>

Defined in: packages/rest/dist/types/types.d.ts:2302

Cross-posts a message posted in an announcement channel to subscribed channels.

Parameters

channelId

The ID of the announcement channel.

messageId

https://discord.com/developers/docs/resources/channel#crosspost-message

The ID of the message to cross-post.

Returns

An instance of the cross-posted DiscordMessage.

Remarks

Requires the SEND_MESSAGES permission.

If not cross-posting own message:

Requires the MANAGE_MESSAGES permission.

Fires a Message Create event in the guilds the subscribed channels are in.

See

put()

put: <T>(url, options?) => Promise<Camelize<T>>

Defined in: packages/rest/dist/types/types.d.ts:126

Make a put request to the api.

Type Parameters

• T = void

Parameters

url

string

options?

Returns

Promise<Camelize<T>>

queues

queues: Map<string, Queue>

Defined in: packages/rest/dist/types/types.d.ts:89

The queues that hold all the requests to be processed.

rateLimitedPaths

rateLimitedPaths: Map<string, RestRateLimitedPath>

Defined in: packages/rest/dist/types/types.d.ts:91

The paths that are currently rate limited.

removeDmRecipient()

removeDmRecipient: (channelId, userId) => Promise<void>

Defined in: packages/rest/dist/types/types.d.ts:2344

Removes a member from a Group DM.

Parameters

channelId

The ID of the channel to remove the recipient user of.

userId

https://discord.com/developers/docs/resources/channel#group-dm-remove-recipient

The user ID of the user to remove.

Returns

Promise<void>

See

removeRole()

removeRole: (guildId, userId, roleId, reason?) => Promise<void>

Defined in: packages/rest/dist/types/types.d.ts:2318

Removes a role from a member.

Parameters

guildId

The ID of the guild the member to remove the role from is in.

userId

The user ID of the member to remove the role from.

roleId

https://discord.com/developers/docs/resources/guild#remove-guild-member-role

The ID of the role to remove from the member.

reason?

string

An optional reason for the action, to be included in the audit log.

Returns

Promise<void>

Remarks

Requires the MANAGE_ROLES permission.

Fires a Guild Member Update gateway event.

See

removeThreadMember()

removeThreadMember: (channelId, userId) => Promise<void>

Defined in: packages/rest/dist/types/types.d.ts:2335

Removes a member from a thread.

Parameters

channelId

The ID of the thread to remove the thread member of.

userId

https://discord.com/developers/docs/resources/channel#remove-thread-member

The user ID of the thread member to remove.

Returns

Promise<void>

Remarks

If the thread is of type ChannelTypes.GuildPrivateThread, requires to be the creator of the thread. Otherwise, requires the MANAGE_THREADS permission.

Requires the thread not be archived.

Fires a Thread Members Update gateway event.

See

revokeToken()

revokeToken: (clientId, clientSecret, options) => Promise<void>

Defined in: packages/rest/dist/types/types.d.ts:1419

Revoke an access_token

Parameters

clientId

Application's client id

clientSecret

string

application's client secret

options

The options to revoke the access_token

token

string

tokenTypeHint

"access_token" | "refresh_token"

Returns

Promise<void>

routes

routes: RestRoutes

Defined in: packages/rest/dist/types/types.d.ts:95

The routes that are available for this manager.

searchMembers()

searchMembers: (guildId, query, options?) => Promise<object[]>

Defined in: packages/rest/dist/types/types.d.ts:2728

Gets the list of members whose usernames or nicknames start with a provided string.

Parameters

guildId

https://discord.com/developers/docs/resources/guild#search-guild-members

The ID of the guild to search in.

query

string

The string to match usernames or nicknames against.

options?

Omit<SearchMembers, "query">

The parameters for searching through the members.

Returns

Promise<object[]>

A collection of DiscordMember objects assorted by user ID.

See

sendFollowupMessage()

sendFollowupMessage: (token, options) => Promise<{ activity: { partyId: string; type: MessageActivityTypes; }; application: { approximateGuildCount: number; approximateUserInstallCount: number; bot: { accentColor: number; avatar: null | string; avatarDecorationData: { asset: string; skuId: string; }; banner: string; bot: boolean; discriminator: string; email: null | string; flags: number; globalName: null | string; id: string; locale: string; mfaEnabled: boolean; premiumType: PremiumTypes; publicFlags: number; system: boolean; username: string; verified: boolean; }; botPublic: boolean; botRequireCodeGrant: boolean; coverImage: string; customInstallUrl: string; description: string; eventWebhooksStatus: DiscordApplicationEventWebhookStatus; eventWebhooksTypes: DiscordWebhookEventType[]; eventWebhooksUrl: null | string; flags: ApplicationFlags; guild: { afkChannelId: null | string; afkTimeout: number; applicationId: null | string; approximateMemberCount: number; approximatePresenceCount: number; banner: null | string; channels: object[]; defaultMessageNotifications: DefaultMessageNotificationLevels; description: null | string; discoverySplash: null | string; emojis: object[]; explicitContentFilter: ExplicitContentFilterLevels; features: GuildFeatures[]; icon: null | string; iconHash: null | string; id: string; joinedAt: string; large: boolean; maxMembers: number; maxPresences: null | number; maxStageVideoChannelUsers: number; maxVideoChannelUsers: number; memberCount: number; members: object[]; mfaLevel: MfaLevels; name: string; nsfwLevel: GuildNsfwLevel; owner: boolean; ownerId: string; permissions: string; preferredLocale: string; premiumProgressBarEnabled: boolean; premiumSubscriptionCount: number; premiumTier: PremiumTiers; presences: object[]; publicUpdatesChannelId: null | string; roles: object[]; rulesChannelId: null | string; safetyAlertsChannelId: null | string; soundboardSounds: object[]; splash: null | string; stageInstances: object[]; stickers: object[]; systemChannelFlags: SystemChannelFlags; systemChannelId: null | string; threads: object[]; unavailable: boolean; vanityUrlCode: null | string; verificationLevel: VerificationLevels; voiceStates: object[]; welcomeScreen: { description: null | string; welcomeChannels: object[]; }; widgetChannelId: null | string; widgetEnabled: boolean; }; guildId: string; icon: null | string; id: string; installParams: { permissions: string; scopes: OAuth2Scope[]; }; integrationTypesConfig: { 0: { oauth2InstallParams: { permissions: ...; scopes: ...; }; }; 1: { oauth2InstallParams: { permissions: ...; scopes: ...; }; }; }; interactionsEndpointUrl: null | string; name: string; owner: { accentColor: number; avatar: null | string; avatarDecorationData: { asset: string; skuId: string; }; banner: string; bot: boolean; discriminator: string; email: null | string; flags: number; globalName: null | string; id: string; locale: string; mfaEnabled: boolean; premiumType: PremiumTypes; publicFlags: number; system: boolean; username: string; verified: boolean; }; primarySkuId: string; privacyPolicyUrl: string; redirectUris: string[]; roleConnectionsVerificationUrl: null | string; rpcOrigins: string[]; slug: string; tags: string[]; team: null | { icon: null | string; id: string; members: object[]; name: string; ownerUserId: string; }; termsOfServiceUrl: string; verifyKey: string; }; applicationId: string; attachments: object[]; author: { accentColor: number; avatar: null | string; avatarDecorationData: { asset: string; skuId: string; }; banner: string; bot: boolean; discriminator: string; email: null | string; flags: number; globalName: null | string; id: string; locale: string; mfaEnabled: boolean; premiumType: PremiumTypes; publicFlags: number; system: boolean; username: string; verified: boolean; }; call: { endedTimestamp: string; participants: string[]; }; channelId: string; components: ({ components: ({ channelTypes: ... | ...; customId: string; defaultValues: ... | ...; disabled: ... | ... | ...; maxValues: ... | ...; minValues: ... | ...; options: ... | ...; placeholder: ... | ...; type: ... | ... | ... | ... | ...; } | { customId: ... | ...; disabled: ... | ... | ...; emoji: ... | ...; label: ... | ...; skuId: ... | ...; style: ButtonStyles; type: Button; url: ... | ...; } | { customId: string; label: string; maxLength: ... | ...; minLength: ... | ...; placeholder: ... | ...; required: ... | ... | ...; style: TextStyles; type: InputText; value: ... | ...; })[]; type: ActionRow; } | { channelTypes: ChannelTypes[]; customId: string; defaultValues: object[]; disabled: boolean; maxValues: number; minValues: number; options: object[]; placeholder: string; type: SelectMenu | SelectMenuUsers | SelectMenuRoles | SelectMenuUsersAndRoles | SelectMenuChannels; } | { customId: string; disabled: boolean; emoji: { animated: boolean; id: string; name: string; }; label: string; skuId: string; style: ButtonStyles; type: Button; url: string; } | { customId: string; label: string; maxLength: number; minLength: number; placeholder: string; required: boolean; style: TextStyles; type: InputText; value: string; })[]; content: string; editedTimestamp: null | string; embeds: object[]; flags: MessageFlags; guildId: string; id: string; interaction: { id: string; member: { avatar: string; avatarDecorationData: null | { asset: string; skuId: string; }; banner: string; communicationDisabledUntil: null | string; deaf: boolean; flags: number; joinedAt: string; mute: boolean; nick: null | string; pending: boolean; permissions: string; premiumSince: null | string; roles: string[]; user: { accentColor: number; avatar: null | string; avatarDecorationData: { asset: ...; skuId: ...; }; banner: string; bot: boolean; discriminator: string; email: null | string; flags: number; globalName: null | string; id: string; locale: string; mfaEnabled: boolean; premiumType: PremiumTypes; publicFlags: number; system: boolean; username: string; verified: boolean; }; }; name: string; type: InteractionTypes; user: { accentColor: number; avatar: null | string; avatarDecorationData: { asset: string; skuId: string; }; banner: string; bot: boolean; discriminator: string; email: null | string; flags: number; globalName: null | string; id: string; locale: string; mfaEnabled: boolean; premiumType: PremiumTypes; publicFlags: number; system: boolean; username: string; verified: boolean; }; }; interactionMetadata: { authorizingIntegrationOwners: { 0: string; 1: string; }; id: string; originalResponseMessageId: string; targetMessageId: string; targetUser: { accentColor: number; avatar: null | string; avatarDecorationData: { asset: string; skuId: string; }; banner: string; bot: boolean; discriminator: string; email: null | string; flags: number; globalName: null | string; id: string; locale: string; mfaEnabled: boolean; premiumType: PremiumTypes; publicFlags: number; system: boolean; username: string; verified: boolean; }; type: InteractionTypes; user: { accentColor: number; avatar: null | string; avatarDecorationData: { asset: string; skuId: string; }; banner: string; bot: boolean; discriminator: string; email: null | string; flags: number; globalName: null | string; id: string; locale: string; mfaEnabled: boolean; premiumType: PremiumTypes; publicFlags: number; system: boolean; username: string; verified: boolean; }; } | { authorizingIntegrationOwners: { 0: string; 1: string; }; id: string; interactedMessageId: string; originalResponseMessageId: string; type: InteractionTypes; user: { accentColor: number; avatar: null | string; avatarDecorationData: { asset: string; skuId: string; }; banner: string; bot: boolean; discriminator: string; email: null | string; flags: number; globalName: null | string; id: string; locale: string; mfaEnabled: boolean; premiumType: PremiumTypes; publicFlags: number; system: boolean; username: string; verified: boolean; }; } | { authorizingIntegrationOwners: { 0: string; 1: string; }; id: string; originalResponseMessageId: string; triggeringInteractionMetadata: { id: string; type: InteractionTypes; user: { username: string; globalName: string | null; locale?: string | undefined; flags?: number | undefined; premiumType?: PremiumTypes | undefined; ... 11 more ...; avatarDecorationData?: { ...; } | undefined; }; authorizingIntegrationOwners: { ...; }; originalResponseMessageI...; type: InteractionTypes; user: { accentColor: number; avatar: null | string; avatarDecorationData: { asset: string; skuId: string; }; banner: string; bot: boolean; discriminator: string; email: null | string; flags: number; globalName: null | string; id: string; locale: string; mfaEnabled: boolean; premiumType: PremiumTypes; publicFlags: number; system: boolean; username: string; verified: boolean; }; }; member: { avatar: string; avatarDecorationData: null | { asset: string; skuId: string; }; banner: string; communicationDisabledUntil: null | string; deaf: boolean; flags: number; joinedAt: string; mute: boolean; nick: null | string; pending: boolean; permissions: string; premiumSince: null | string; roles: string[]; user: { accentColor: number; avatar: null | string; avatarDecorationData: { asset: string; skuId: string; }; banner: string; bot: boolean; discriminator: string; email: null | string; flags: number; globalName: null | string; id: string; locale: string; mfaEnabled: boolean; premiumType: PremiumTypes; publicFlags: number; system: boolean; username: string; verified: boolean; }; }; mentionChannels: object[]; mentionEveryone: boolean; mentionRoles: string[]; mentions: object[]; messageReference: { channelId: string; failIfNotExists: boolean; guildId: string; messageId: string; type: DiscordMessageReferenceType; }; messageSnapshots: object[]; nonce: string | number; pinned: boolean; poll: { allowMultiselect: boolean; answers: object[]; expiry: null | string; layoutType: Default; question: { emoji: { animated: boolean; available: boolean; id: string; managed: boolean; name: string; requireColons: boolean; roles: string[]; user: { accentColor: ... | ...; avatar: ... | ...; avatarDecorationData: ... | ...; banner: ... | ...; bot: ... | ... | ...; discriminator: string; email: ... | ... | ...; flags: ... | ...; globalName: ... | ...; id: string; locale: ... | ...; mfaEnabled: ... | ... | ...; premiumType: ... | ...; publicFlags: ... | ...; system: ... | ... | ...; username: string; verified: ... | ... | ...; }; }; text: string; }; results: { answerCounts: object[]; isFinalized: boolean; }; }; position: number; reactions: object[]; referencedMessage: { id: string; channelId: string; guildId?: string | undefined; author: { username: string; globalName: string | null; locale?: string | undefined; flags?: number | undefined; premiumType?: PremiumTypes | undefined; ... 11 more ...; avatarDecorationData?: { ...; } | undefined; }; ... 31 more ...; call?: { ...; } | un...; stickerItems: object[]; stickers: object[]; thread: { applicationId: string; appliedTags: string[]; availableTags: object[]; bitrate: number; defaultAutoArchiveDuration: number; defaultForumLayout: ForumLayout; defaultReactionEmoji: null | { emojiId: string; emojiName: null | string; }; defaultSortOrder: null | SortOrderTypes; defaultThreadRateLimitPerUser: number; flags: ChannelFlags; guildId: string; icon: string; id: string; lastMessageId: null | string; lastPinTimestamp: null | string; managed: boolean; member: { flags: number; id: string; joinTimestamp: string; userId: string; }; memberCount: number; messageCount: number; name: string; newlyCreated: boolean; nsfw: boolean; ownerId: string; parentId: null | string; permissionOverwrites: object[]; permissions: string; position: number; rateLimitPerUser: number; recipients: object[]; rtcRegion: null | string; threadMetadata: { archived: boolean; archiveTimestamp: string; autoArchiveDuration: 60 | 1440 | 4320 | 10080; createTimestamp: null | string; invitable: boolean; locked: boolean; }; topic: null | string; totalMessageSent: number; type: ChannelTypes; userLimit: number; videoQualityMode: VideoQualityModes; }; timestamp: string; tts: boolean; type: MessageTypes; webhookId: string; }>

Defined in: packages/rest/dist/types/types.d.ts:2395

Sends a follow-up message to an interaction.

Parameters

token

string

The interaction token to use, provided in the original interaction.

options

InteractionCallbackData

The parameters for the creation of the message.

Returns

An instance of the created DiscordMessage.

Remarks

⚠️ Interaction tokens are only valid for 15 minutes.

By default, mentions are suppressed. To enable mentions, pass a mention object with the callback data.

Unlike sendMessage(), this endpoint allows the bot user to act without:

Needing to be able to see the contents of the channel that the message is in. (READ_MESSAGES permission.)
Requiring the MESSAGE_CONTENT intent.

Apps are limited to 5 followup messages per interaction if it was initiated from a user-installed app and isn't installed in the server You can check if it was initiated from a user-installed app that isn't installed in the server by checking if authorizingIntegrationOwners only contains UserInstall.

Fires a Message Create event.

See

https://discord.com/developers/docs/interactions/receiving-and-responding#create-followup-message

sendInteractionResponse()

sendInteractionResponse: (interactionId, token, options, params?) => Promise<void | { interaction: { activityInstanceId: string; id: string; responseMessageEphemeral: boolean; responseMessageId: string; responseMessageLoading: boolean; type: InteractionTypes; }; resource: { activityInstance: { id: string; }; message: { activity: { partyId: ... | ...; type: MessageActivityTypes; }; application: { approximateGuildCount: ... | ...; approximateUserInstallCount: ... | ...; bot: ... | ...; botPublic: ... | ... | ...; botRequireCodeGrant: ... | ... | ...; coverImage: ... | ...; customInstallUrl: ... | ...; description: ... | ...; eventWebhooksStatus: ... | ...; eventWebhooksTypes: ... | ...; eventWebhooksUrl: ... | ... | ...; flags: ... | ...; guild: ... | ...; guildId: ... | ...; icon: ... | ... | ...; id: ... | ...; installParams: ... | ...; integrationTypesConfig: ... | ...; interactionsEndpointUrl: ... | ... | ...; name: ... | ...; owner: ... | ...; primarySkuId: ... | ...; privacyPolicyUrl: ... | ...; redirectUris: ... | ...; roleConnectionsVerificationUrl: ... | ... | ...; rpcOrigins: ... | ...; slug: ... | ...; tags: ... | ...; team: ... | ... | ...; termsOfServiceUrl: ... | ...; verifyKey: ... | ...; }; applicationId: string; attachments: object[]; author: { accentColor: number; avatar: null | string; avatarDecorationData: { asset: ...; skuId: ...; }; banner: string; bot: boolean; discriminator: string; email: null | string; flags: number; globalName: null | string; id: string; locale: string; mfaEnabled: boolean; premiumType: PremiumTypes; publicFlags: number; system: boolean; username: string; verified: boolean; }; call: { endedTimestamp: string; participants: ...[]; }; channelId: string; components: (... | ... | ... | ...)[]; content: string; editedTimestamp: null | string; embeds: object[]; flags: MessageFlags; guildId: string; id: string; interaction: { id: string; member: ... | ...; name: string; type: InteractionTypes; user: { accentColor: ...; avatar: ...; avatarDecorationData: ...; banner: ...; bot: ...; discriminator: ...; email: ...; flags: ...; globalName: ...; id: ...; locale: ...; mfaEnabled: ...; premiumType: ...; publicFlags: ...; system: ...; username: ...; verified: ...; }; }; interactionMetadata: { authorizingIntegrationOwners: { 0: ...; 1: ...; }; id: string; originalResponseMessageId: ... | ...; targetMessageId: ... | ...; targetUser: ... | ...; type: InteractionTypes; user: { accentColor: ...; avatar: ...; avatarDecorationData: ...; banner: ...; bot: ...; discriminator: ...; email: ...; flags: ...; globalName: ...; id: ...; locale: ...; mfaEnabled: ...; premiumType: ...; publicFlags: ...; system: ...; username: ...; verified: ...; }; } | { authorizingIntegrationOwners: { 0: ...; 1: ...; }; id: string; interactedMessageId: ... | ...; originalResponseMessageId: ... | ...; type: InteractionTypes; user: { accentColor: ...; avatar: ...; avatarDecorationData: ...; banner: ...; bot: ...; discriminator: ...; email: ...; flags: ...; globalName: ...; id: ...; locale: ...; mfaEnabled: ...; premiumType: ...; publicFlags: ...; system: ...; username: ...; verified: ...; }; } | { authorizingIntegrationOwners: { 0: ...; 1: ...; }; id: string; originalResponseMessageId: ... | ...; triggeringInteractionMetadata: { id: string; type: InteractionTypes; user: { username: string; globalName: string | null; locale?: string | undefined; flags?: number | undefined; premiumType?: PremiumTypes | undefined; ... 11 more ...; avatarDecorationData?: { ...; } | undefined; }; authorizingIntegrationOwners: { ...; }; originalResponseMessageI...; type: InteractionTypes; user: { accentColor: ...; avatar: ...; avatarDecorationData: ...; banner: ...; bot: ...; discriminator: ...; email: ...; flags: ...; globalName: ...; id: ...; locale: ...; mfaEnabled: ...; premiumType: ...; publicFlags: ...; system: ...; username: ...; verified: ...; }; }; member: { avatar: ... | ...; avatarDecorationData: ... | ... | ...; banner: ... | ...; communicationDisabledUntil: ... | ... | ...; deaf: ... | ... | ...; flags: number; joinedAt: string; mute: ... | ... | ...; nick: ... | ... | ...; pending: ... | ... | ...; permissions: ... | ...; premiumSince: ... | ... | ...; roles: ...[]; user: ... | ...; }; mentionChannels: object[]; mentionEveryone: boolean; mentionRoles: string[]; mentions: object[]; messageReference: { channelId: ... | ...; failIfNotExists: boolean; guildId: ... | ...; messageId: ... | ...; type: ... | ...; }; messageSnapshots: object[]; nonce: string | number; pinned: boolean; poll: { allowMultiselect: boolean; answers: ...[]; expiry: ... | ...; layoutType: Default; question: { emoji: ...; text: ...; }; results: ... | ...; }; position: number; reactions: object[]; referencedMessage: { id: string; channelId: string; guildId?: string | undefined; author: { username: string; globalName: string | null; locale?: string | undefined; flags?: number | undefined; premiumType?: PremiumTypes | undefined; ... 11 more ...; avatarDecorationData?: { ...; } | undefined; }; ... 31 more ...; call?: { ...; } | un...; stickerItems: object[]; stickers: object[]; thread: { applicationId: ... | ...; appliedTags: ... | ...; availableTags: ... | ...; bitrate: ... | ...; defaultAutoArchiveDuration: ... | ...; defaultForumLayout: ... | ...; defaultReactionEmoji: ... | ... | ...; defaultSortOrder: ... | ... | ...; defaultThreadRateLimitPerUser: ... | ...; flags: ... | ...; guildId: ... | ...; icon: ... | ...; id: string; lastMessageId: ... | ... | ...; lastPinTimestamp: ... | ... | ...; managed: ... | ... | ...; member: { flags: ...; id: ...; joinTimestamp: ...; userId: ...; }; memberCount: ... | ...; messageCount: ... | ...; name: ... | ...; newlyCreated: ... | ... | ...; nsfw: ... | ... | ...; ownerId: ... | ...; parentId: ... | ... | ...; permissionOverwrites: ... | ...; permissions: ... | ...; position: ... | ...; rateLimitPerUser: ... | ...; recipients: ... | ...; rtcRegion: ... | ... | ...; threadMetadata: ... | ...; topic: ... | ... | ...; totalMessageSent: ... | ...; type: ChannelTypes; userLimit: ... | ...; videoQualityMode: ... | ...; }; timestamp: string; tts: boolean; type: MessageTypes; webhookId: string; }; type: InteractionResponseTypes; }; }>

Defined in: packages/rest/dist/types/types.d.ts:2418

Sends a response to an interaction.

Parameters

interactionId

InteractionCallbackOptions

The ID of the interaction to respond to.

token

string

The interaction token to use, provided in the original interaction.

options

InteractionResponse

The parameters for the creation of the message.

params?

The query parameters for the response of the callback

Returns

Promise<void | { interaction: { activityInstanceId: string; id: string; responseMessageEphemeral: boolean; responseMessageId: string; responseMessageLoading: boolean; type: InteractionTypes; }; resource: { activityInstance: { id: string; }; message: { activity: { partyId: ... | ...; type: MessageActivityTypes; }; application: { approximateGuildCount: ... | ...; approximateUserInstallCount: ... | ...; bot: ... | ...; botPublic: ... | ... | ...; botRequireCodeGrant: ... | ... | ...; coverImage: ... | ...; customInstallUrl: ... | ...; description: ... | ...; eventWebhooksStatus: ... | ...; eventWebhooksTypes: ... | ...; eventWebhooksUrl: ... | ... | ...; flags: ... | ...; guild: ... | ...; guildId: ... | ...; icon: ... | ... | ...; id: ... | ...; installParams: ... | ...; integrationTypesConfig: ... | ...; interactionsEndpointUrl: ... | ... | ...; name: ... | ...; owner: ... | ...; primarySkuId: ... | ...; privacyPolicyUrl: ... | ...; redirectUris: ... | ...; roleConnectionsVerificationUrl: ... | ... | ...; rpcOrigins: ... | ...; slug: ... | ...; tags: ... | ...; team: ... | ... | ...; termsOfServiceUrl: ... | ...; verifyKey: ... | ...; }; applicationId: string; attachments: object[]; author: { accentColor: number; avatar: null | string; avatarDecorationData: { asset: ...; skuId: ...; }; banner: string; bot: boolean; discriminator: string; email: null | string; flags: number; globalName: null | string; id: string; locale: string; mfaEnabled: boolean; premiumType: PremiumTypes; publicFlags: number; system: boolean; username: string; verified: boolean; }; call: { endedTimestamp: string; participants: ...[]; }; channelId: string; components: (... | ... | ... | ...)[]; content: string; editedTimestamp: null | string; embeds: object[]; flags: MessageFlags; guildId: string; id: string; interaction: { id: string; member: ... | ...; name: string; type: InteractionTypes; user: { accentColor: ...; avatar: ...; avatarDecorationData: ...; banner: ...; bot: ...; discriminator: ...; email: ...; flags: ...; globalName: ...; id: ...; locale: ...; mfaEnabled: ...; premiumType: ...; publicFlags: ...; system: ...; username: ...; verified: ...; }; }; interactionMetadata: { authorizingIntegrationOwners: { 0: ...; 1: ...; }; id: string; originalResponseMessageId: ... | ...; targetMessageId: ... | ...; targetUser: ... | ...; type: InteractionTypes; user: { accentColor: ...; avatar: ...; avatarDecorationData: ...; banner: ...; bot: ...; discriminator: ...; email: ...; flags: ...; globalName: ...; id: ...; locale: ...; mfaEnabled: ...; premiumType: ...; publicFlags: ...; system: ...; username: ...; verified: ...; }; } | { authorizingIntegrationOwners: { 0: ...; 1: ...; }; id: string; interactedMessageId: ... | ...; originalResponseMessageId: ... | ...; type: InteractionTypes; user: { accentColor: ...; avatar: ...; avatarDecorationData: ...; banner: ...; bot: ...; discriminator: ...; email: ...; flags: ...; globalName: ...; id: ...; locale: ...; mfaEnabled: ...; premiumType: ...; publicFlags: ...; system: ...; username: ...; verified: ...; }; } | { authorizingIntegrationOwners: { 0: ...; 1: ...; }; id: string; originalResponseMessageId: ... | ...; triggeringInteractionMetadata: { id: string; type: InteractionTypes; user: { username: string; globalName: string | null; locale?: string | undefined; flags?: number | undefined; premiumType?: PremiumTypes | undefined; ... 11 more ...; avatarDecorationData?: { ...; } | undefined; }; authorizingIntegrationOwners: { ...; }; originalResponseMessageI...; type: InteractionTypes; user: { accentColor: ...; avatar: ...; avatarDecorationData: ...; banner: ...; bot: ...; discriminator: ...; email: ...; flags: ...; globalName: ...; id: ...; locale: ...; mfaEnabled: ...; premiumType: ...; publicFlags: ...; system: ...; username: ...; verified: ...; }; }; member: { avatar: ... | ...; avatarDecorationData: ... | ... | ...; banner: ... | ...; communicationDisabledUntil: ... | ... | ...; deaf: ... | ... | ...; flags: number; joinedAt: string; mute: ... | ... | ...; nick: ... | ... | ...; pending: ... | ... | ...; permissions: ... | ...; premiumSince: ... | ... | ...; roles: ...[]; user: ... | ...; }; mentionChannels: object[]; mentionEveryone: boolean; mentionRoles: string[]; mentions: object[]; messageReference: { channelId: ... | ...; failIfNotExists: boolean; guildId: ... | ...; messageId: ... | ...; type: ... | ...; }; messageSnapshots: object[]; nonce: string | number; pinned: boolean; poll: { allowMultiselect: boolean; answers: ...[]; expiry: ... | ...; layoutType: Default; question: { emoji: ...; text: ...; }; results: ... | ...; }; position: number; reactions: object[]; referencedMessage: { id: string; channelId: string; guildId?: string | undefined; author: { username: string; globalName: string | null; locale?: string | undefined; flags?: number | undefined; premiumType?: PremiumTypes | undefined; ... 11 more ...; avatarDecorationData?: { ...; } | undefined; }; ... 31 more ...; call?: { ...; } | un...; stickerItems: object[]; stickers: object[]; thread: { applicationId: ... | ...; appliedTags: ... | ...; availableTags: ... | ...; bitrate: ... | ...; defaultAutoArchiveDuration: ... | ...; defaultForumLayout: ... | ...; defaultReactionEmoji: ... | ... | ...; defaultSortOrder: ... | ... | ...; defaultThreadRateLimitPerUser: ... | ...; flags: ... | ...; guildId: ... | ...; icon: ... | ...; id: string; lastMessageId: ... | ... | ...; lastPinTimestamp: ... | ... | ...; managed: ... | ... | ...; member: { flags: ...; id: ...; joinTimestamp: ...; userId: ...; }; memberCount: ... | ...; messageCount: ... | ...; name: ... | ...; newlyCreated: ... | ... | ...; nsfw: ... | ... | ...; ownerId: ... | ...; parentId: ... | ... | ...; permissionOverwrites: ... | ...; permissions: ... | ...; position: ... | ...; rateLimitPerUser: ... | ...; recipients: ... | ...; rtcRegion: ... | ... | ...; threadMetadata: ... | ...; topic: ... | ... | ...; totalMessageSent: ... | ...; type: ChannelTypes; userLimit: ... | ...; videoQualityMode: ... | ...; }; timestamp: string; tts: boolean; type: MessageTypes; webhookId: string; }; type: InteractionResponseTypes; }; }>

Nothing or the DiscordInteractionCallbackResponse if withResponse param is true

Remarks

⚠️ Interaction tokens are only valid for 15 minutes.

By default, mentions are suppressed. To enable mentions, pass a mention object with the callback data.

Unlike sendMessage(), this endpoint allows the bot user to act without:

Needing to be able to see the contents of the channel that the message is in. (READ_MESSAGES permission.)
Requiring the MESSAGE_CONTENT intent.

Fires a Message Create event.

See

https://discord.com/developers/docs/interactions/receiving-and-responding#create-interaction-response

sendMessage()

sendMessage: (channelId, options) => Promise<{ activity: { partyId: string; type: MessageActivityTypes; }; application: { approximateGuildCount: number; approximateUserInstallCount: number; bot: { accentColor: number; avatar: null | string; avatarDecorationData: { asset: string; skuId: string; }; banner: string; bot: boolean; discriminator: string; email: null | string; flags: number; globalName: null | string; id: string; locale: string; mfaEnabled: boolean; premiumType: PremiumTypes; publicFlags: number; system: boolean; username: string; verified: boolean; }; botPublic: boolean; botRequireCodeGrant: boolean; coverImage: string; customInstallUrl: string; description: string; eventWebhooksStatus: DiscordApplicationEventWebhookStatus; eventWebhooksTypes: DiscordWebhookEventType[]; eventWebhooksUrl: null | string; flags: ApplicationFlags; guild: { afkChannelId: null | string; afkTimeout: number; applicationId: null | string; approximateMemberCount: number; approximatePresenceCount: number; banner: null | string; channels: object[]; defaultMessageNotifications: DefaultMessageNotificationLevels; description: null | string; discoverySplash: null | string; emojis: object[]; explicitContentFilter: ExplicitContentFilterLevels; features: GuildFeatures[]; icon: null | string; iconHash: null | string; id: string; joinedAt: string; large: boolean; maxMembers: number; maxPresences: null | number; maxStageVideoChannelUsers: number; maxVideoChannelUsers: number; memberCount: number; members: object[]; mfaLevel: MfaLevels; name: string; nsfwLevel: GuildNsfwLevel; owner: boolean; ownerId: string; permissions: string; preferredLocale: string; premiumProgressBarEnabled: boolean; premiumSubscriptionCount: number; premiumTier: PremiumTiers; presences: object[]; publicUpdatesChannelId: null | string; roles: object[]; rulesChannelId: null | string; safetyAlertsChannelId: null | string; soundboardSounds: object[]; splash: null | string; stageInstances: object[]; stickers: object[]; systemChannelFlags: SystemChannelFlags; systemChannelId: null | string; threads: object[]; unavailable: boolean; vanityUrlCode: null | string; verificationLevel: VerificationLevels; voiceStates: object[]; welcomeScreen: { description: null | string; welcomeChannels: object[]; }; widgetChannelId: null | string; widgetEnabled: boolean; }; guildId: string; icon: null | string; id: string; installParams: { permissions: string; scopes: OAuth2Scope[]; }; integrationTypesConfig: { 0: { oauth2InstallParams: { permissions: ...; scopes: ...; }; }; 1: { oauth2InstallParams: { permissions: ...; scopes: ...; }; }; }; interactionsEndpointUrl: null | string; name: string; owner: { accentColor: number; avatar: null | string; avatarDecorationData: { asset: string; skuId: string; }; banner: string; bot: boolean; discriminator: string; email: null | string; flags: number; globalName: null | string; id: string; locale: string; mfaEnabled: boolean; premiumType: PremiumTypes; publicFlags: number; system: boolean; username: string; verified: boolean; }; primarySkuId: string; privacyPolicyUrl: string; redirectUris: string[]; roleConnectionsVerificationUrl: null | string; rpcOrigins: string[]; slug: string; tags: string[]; team: null | { icon: null | string; id: string; members: object[]; name: string; ownerUserId: string; }; termsOfServiceUrl: string; verifyKey: string; }; applicationId: string; attachments: object[]; author: { accentColor: number; avatar: null | string; avatarDecorationData: { asset: string; skuId: string; }; banner: string; bot: boolean; discriminator: string; email: null | string; flags: number; globalName: null | string; id: string; locale: string; mfaEnabled: boolean; premiumType: PremiumTypes; publicFlags: number; system: boolean; username: string; verified: boolean; }; call: { endedTimestamp: string; participants: string[]; }; channelId: string; components: ({ components: ({ channelTypes: ... | ...; customId: string; defaultValues: ... | ...; disabled: ... | ... | ...; maxValues: ... | ...; minValues: ... | ...; options: ... | ...; placeholder: ... | ...; type: ... | ... | ... | ... | ...; } | { customId: ... | ...; disabled: ... | ... | ...; emoji: ... | ...; label: ... | ...; skuId: ... | ...; style: ButtonStyles; type: Button; url: ... | ...; } | { customId: string; label: string; maxLength: ... | ...; minLength: ... | ...; placeholder: ... | ...; required: ... | ... | ...; style: TextStyles; type: InputText; value: ... | ...; })[]; type: ActionRow; } | { channelTypes: ChannelTypes[]; customId: string; defaultValues: object[]; disabled: boolean; maxValues: number; minValues: number; options: object[]; placeholder: string; type: SelectMenu | SelectMenuUsers | SelectMenuRoles | SelectMenuUsersAndRoles | SelectMenuChannels; } | { customId: string; disabled: boolean; emoji: { animated: boolean; id: string; name: string; }; label: string; skuId: string; style: ButtonStyles; type: Button; url: string; } | { customId: string; label: string; maxLength: number; minLength: number; placeholder: string; required: boolean; style: TextStyles; type: InputText; value: string; })[]; content: string; editedTimestamp: null | string; embeds: object[]; flags: MessageFlags; guildId: string; id: string; interaction: { id: string; member: { avatar: string; avatarDecorationData: null | { asset: string; skuId: string; }; banner: string; communicationDisabledUntil: null | string; deaf: boolean; flags: number; joinedAt: string; mute: boolean; nick: null | string; pending: boolean; permissions: string; premiumSince: null | string; roles: string[]; user: { accentColor: number; avatar: null | string; avatarDecorationData: { asset: ...; skuId: ...; }; banner: string; bot: boolean; discriminator: string; email: null | string; flags: number; globalName: null | string; id: string; locale: string; mfaEnabled: boolean; premiumType: PremiumTypes; publicFlags: number; system: boolean; username: string; verified: boolean; }; }; name: string; type: InteractionTypes; user: { accentColor: number; avatar: null | string; avatarDecorationData: { asset: string; skuId: string; }; banner: string; bot: boolean; discriminator: string; email: null | string; flags: number; globalName: null | string; id: string; locale: string; mfaEnabled: boolean; premiumType: PremiumTypes; publicFlags: number; system: boolean; username: string; verified: boolean; }; }; interactionMetadata: { authorizingIntegrationOwners: { 0: string; 1: string; }; id: string; originalResponseMessageId: string; targetMessageId: string; targetUser: { accentColor: number; avatar: null | string; avatarDecorationData: { asset: string; skuId: string; }; banner: string; bot: boolean; discriminator: string; email: null | string; flags: number; globalName: null | string; id: string; locale: string; mfaEnabled: boolean; premiumType: PremiumTypes; publicFlags: number; system: boolean; username: string; verified: boolean; }; type: InteractionTypes; user: { accentColor: number; avatar: null | string; avatarDecorationData: { asset: string; skuId: string; }; banner: string; bot: boolean; discriminator: string; email: null | string; flags: number; globalName: null | string; id: string; locale: string; mfaEnabled: boolean; premiumType: PremiumTypes; publicFlags: number; system: boolean; username: string; verified: boolean; }; } | { authorizingIntegrationOwners: { 0: string; 1: string; }; id: string; interactedMessageId: string; originalResponseMessageId: string; type: InteractionTypes; user: { accentColor: number; avatar: null | string; avatarDecorationData: { asset: string; skuId: string; }; banner: string; bot: boolean; discriminator: string; email: null | string; flags: number; globalName: null | string; id: string; locale: string; mfaEnabled: boolean; premiumType: PremiumTypes; publicFlags: number; system: boolean; username: string; verified: boolean; }; } | { authorizingIntegrationOwners: { 0: string; 1: string; }; id: string; originalResponseMessageId: string; triggeringInteractionMetadata: { id: string; type: InteractionTypes; user: { username: string; globalName: string | null; locale?: string | undefined; flags?: number | undefined; premiumType?: PremiumTypes | undefined; ... 11 more ...; avatarDecorationData?: { ...; } | undefined; }; authorizingIntegrationOwners: { ...; }; originalResponseMessageI...; type: InteractionTypes; user: { accentColor: number; avatar: null | string; avatarDecorationData: { asset: string; skuId: string; }; banner: string; bot: boolean; discriminator: string; email: null | string; flags: number; globalName: null | string; id: string; locale: string; mfaEnabled: boolean; premiumType: PremiumTypes; publicFlags: number; system: boolean; username: string; verified: boolean; }; }; member: { avatar: string; avatarDecorationData: null | { asset: string; skuId: string; }; banner: string; communicationDisabledUntil: null | string; deaf: boolean; flags: number; joinedAt: string; mute: boolean; nick: null | string; pending: boolean; permissions: string; premiumSince: null | string; roles: string[]; user: { accentColor: number; avatar: null | string; avatarDecorationData: { asset: string; skuId: string; }; banner: string; bot: boolean; discriminator: string; email: null | string; flags: number; globalName: null | string; id: string; locale: string; mfaEnabled: boolean; premiumType: PremiumTypes; publicFlags: number; system: boolean; username: string; verified: boolean; }; }; mentionChannels: object[]; mentionEveryone: boolean; mentionRoles: string[]; mentions: object[]; messageReference: { channelId: string; failIfNotExists: boolean; guildId: string; messageId: string; type: DiscordMessageReferenceType; }; messageSnapshots: object[]; nonce: string | number; pinned: boolean; poll: { allowMultiselect: boolean; answers: object[]; expiry: null | string; layoutType: Default; question: { emoji: { animated: boolean; available: boolean; id: string; managed: boolean; name: string; requireColons: boolean; roles: string[]; user: { accentColor: ... | ...; avatar: ... | ...; avatarDecorationData: ... | ...; banner: ... | ...; bot: ... | ... | ...; discriminator: string; email: ... | ... | ...; flags: ... | ...; globalName: ... | ...; id: string; locale: ... | ...; mfaEnabled: ... | ... | ...; premiumType: ... | ...; publicFlags: ... | ...; system: ... | ... | ...; username: string; verified: ... | ... | ...; }; }; text: string; }; results: { answerCounts: object[]; isFinalized: boolean; }; }; position: number; reactions: object[]; referencedMessage: { id: string; channelId: string; guildId?: string | undefined; author: { username: string; globalName: string | null; locale?: string | undefined; flags?: number | undefined; premiumType?: PremiumTypes | undefined; ... 11 more ...; avatarDecorationData?: { ...; } | undefined; }; ... 31 more ...; call?: { ...; } | un...; stickerItems: object[]; stickers: object[]; thread: { applicationId: string; appliedTags: string[]; availableTags: object[]; bitrate: number; defaultAutoArchiveDuration: number; defaultForumLayout: ForumLayout; defaultReactionEmoji: null | { emojiId: string; emojiName: null | string; }; defaultSortOrder: null | SortOrderTypes; defaultThreadRateLimitPerUser: number; flags: ChannelFlags; guildId: string; icon: string; id: string; lastMessageId: null | string; lastPinTimestamp: null | string; managed: boolean; member: { flags: number; id: string; joinTimestamp: string; userId: string; }; memberCount: number; messageCount: number; name: string; newlyCreated: boolean; nsfw: boolean; ownerId: string; parentId: null | string; permissionOverwrites: object[]; permissions: string; position: number; rateLimitPerUser: number; recipients: object[]; rtcRegion: null | string; threadMetadata: { archived: boolean; archiveTimestamp: string; autoArchiveDuration: 60 | 1440 | 4320 | 10080; createTimestamp: null | string; invitable: boolean; locked: boolean; }; topic: null | string; totalMessageSent: number; type: ChannelTypes; userLimit: number; videoQualityMode: VideoQualityModes; }; timestamp: string; tts: boolean; type: MessageTypes; webhookId: string; }>

Defined in: packages/rest/dist/types/types.d.ts:2371

Sends a message to a channel.

Parameters

channelId

https://discord.com/developers/docs/resources/channel#create-message

The ID of the channel to send the message in.

options

CreateMessageOptions

The parameters for the creation of the message.

Returns

An instance of the created DiscordMessage.

Remarks

Requires that the bot user be able to see the contents of the channel the message is to be sent in.

If sending a message to a guild channel:

Requires the SEND_MESSAGES permission.

If sending a TTS message:

Requires the SEND_TTS_MESSAGES permission.

If sending a message as a reply to another message:

Requires the READ_MESSAGE_HISTORY permission.
The message being replied to cannot be a system message.

⚠️ The maximum size of a request (accounting for any attachments and message content) for bot users is 8 MiB.

Fires a Message Create gateway event.

See

sendRequest()

sendRequest: (options) => Promise<void>

Defined in: packages/rest/dist/types/types.d.ts:114

Sends a request to the api.

Parameters

options

SendRequestOptions

Returns

Promise<void>

sendSoundboardSound()

sendSoundboardSound: (channelId, options) => Promise<void>

Defined in: packages/rest/dist/types/types.d.ts:2852

Send a soundboard sound to a voice channel the user is connected to.

Parameters

channelId

The id of the voice channel

options

SendSoundboardSound

Returns

Promise<void>

Remarks

Fires a Voice Channel Effect Send Gateway event.

Requires the SPEAK and USE_SOUNDBOARD permissions, and also the USE_EXTERNAL_SOUNDS permission if the sound is from a different server. Additionally, requires the user to be connected to the voice channel, having a voice state without deaf, self_deaf, mute, or suppress enabled.

simplifyUrl()

simplifyUrl: (url, method) => string

Defined in: packages/rest/dist/types/types.d.ts:116

Split a url to separate rate limit buckets based on major/minor parameters.

Parameters

url

string

method

RequestMethods

Returns

string

startThreadWithMessage()

startThreadWithMessage: (channelId, messageId, options, reason?) => Promise<{ applicationId: string; appliedTags: string[]; availableTags: object[]; bitrate: number; defaultAutoArchiveDuration: number; defaultForumLayout: ForumLayout; defaultReactionEmoji: null | { emojiId: string; emojiName: null | string; }; defaultSortOrder: null | SortOrderTypes; defaultThreadRateLimitPerUser: number; flags: ChannelFlags; guildId: string; icon: string; id: string; lastMessageId: null | string; lastPinTimestamp: null | string; managed: boolean; member: { flags: number; id: string; joinTimestamp: string; userId: string; }; memberCount: number; messageCount: number; name: string; newlyCreated: boolean; nsfw: boolean; ownerId: string; parentId: null | string; permissionOverwrites: object[]; permissions: string; position: number; rateLimitPerUser: number; recipients: object[]; rtcRegion: null | string; threadMetadata: { archived: boolean; archiveTimestamp: string; autoArchiveDuration: 60 | 1440 | 4320 | 10080; createTimestamp: null | string; invitable: boolean; locked: boolean; }; topic: null | string; totalMessageSent: number; type: ChannelTypes; userLimit: number; videoQualityMode: VideoQualityModes; }>

Defined in: packages/rest/dist/types/types.d.ts:2439

Creates a thread, using an existing message as its point of origin.

Parameters

channelId

The ID of the channel in which to create the thread.

messageId

https://discord.com/developers/docs/resources/channel#start-thread-from-message

The ID of the message to use as the thread's point of origin.

options

StartThreadWithMessage

The parameters to use for the creation of the thread.

reason?

string

An optional reason for the action, to be included in the audit log.

Returns

An instance of the created DiscordChannel.

Remarks

If called on a channel of type ChannelTypes.GuildText, creates a ChannelTypes.GuildPublicThread. If called on a channel of type ChannelTypes.GuildNews, creates a ChannelTypes.GuildNewsThread. Does not work on channels of type ChannelTypes.GuildForum.

The ID of the created thread will be the same as the ID of the source message.

Fires a Thread Create gateway event.

See

startThreadWithoutMessage()

startThreadWithoutMessage: (channelId, options, reason?) => Promise<{ applicationId: string; appliedTags: string[]; availableTags: object[]; bitrate: number; defaultAutoArchiveDuration: number; defaultForumLayout: ForumLayout; defaultReactionEmoji: null | { emojiId: string; emojiName: null | string; }; defaultSortOrder: null | SortOrderTypes; defaultThreadRateLimitPerUser: number; flags: ChannelFlags; guildId: string; icon: string; id: string; lastMessageId: null | string; lastPinTimestamp: null | string; managed: boolean; member: { flags: number; id: string; joinTimestamp: string; userId: string; }; memberCount: number; messageCount: number; name: string; newlyCreated: boolean; nsfw: boolean; ownerId: string; parentId: null | string; permissionOverwrites: object[]; permissions: string; position: number; rateLimitPerUser: number; recipients: object[]; rtcRegion: null | string; threadMetadata: { archived: boolean; archiveTimestamp: string; autoArchiveDuration: 60 | 1440 | 4320 | 10080; createTimestamp: null | string; invitable: boolean; locked: boolean; }; topic: null | string; totalMessageSent: number; type: ChannelTypes; userLimit: number; videoQualityMode: VideoQualityModes; }>

Defined in: packages/rest/dist/types/types.d.ts:2455

Creates a thread without using a message as the thread's point of origin.

Parameters

channelId

StartThreadWithoutMessage

The ID of the channel in which to create the thread.

options

The parameters to use for the creation of the thread.

reason?

string

An optional reason for the action, to be included in the audit log.

Returns

An instance of the created Thread.

Remarks

Creating a private thread requires the server to be boosted.

Fires a Thread Create gateway event.

See

https://discord.com/developers/docs/resources/channel#start-thread-without-message

syncGuildTemplate()

syncGuildTemplate: (guildId) => Promise<{ code: string; createdAt: string; creator: { accentColor: number; avatar: null | string; avatarDecorationData: { asset: string; skuId: string; }; banner: string; bot: boolean; discriminator: string; email: null | string; flags: number; globalName: null | string; id: string; locale: string; mfaEnabled: boolean; premiumType: PremiumTypes; publicFlags: number; system: boolean; username: string; verified: boolean; }; creatorId: string; description: null | string; isDirty: null | boolean; name: string; serializedSourceGuild: { afkChannelId: null | number; afkTimeout: number; applicationId: null | string; approximateMemberCount: number; approximatePresenceCount: number; banner: null | string; channels: object[]; defaultMessageNotifications: DefaultMessageNotificationLevels; description: null | string; discoverySplash: null | string; emojis: object[]; explicitContentFilter: ExplicitContentFilterLevels; features: GuildFeatures[]; icon: null | string; iconHash: null | string; id: string; joinedAt: string; large: boolean; maxMembers: number; maxPresences: null | number; maxStageVideoChannelUsers: number; maxVideoChannelUsers: number; memberCount: number; members: object[]; mfaLevel: MfaLevels; name: string; nsfwLevel: GuildNsfwLevel; owner: boolean; ownerId: string; permissions: string; preferredLocale: string; premiumProgressBarEnabled: boolean; premiumSubscriptionCount: number; premiumTier: PremiumTiers; presences: object[]; publicUpdatesChannelId: null | string; roles: object[]; rulesChannelId: null | string; safetyAlertsChannelId: null | string; soundboardSounds: object[]; splash: null | string; stageInstances: object[]; stickers: object[]; systemChannelFlags: SystemChannelFlags; systemChannelId: null | number; threads: object[]; unavailable: boolean; vanityUrlCode: null | string; verificationLevel: VerificationLevels; voiceStates: object[]; welcomeScreen: { description: null | string; welcomeChannels: object[]; }; widgetChannelId: null | string; widgetEnabled: boolean; }; sourceGuildId: string; updatedAt: string; usageCount: number; }>

Defined in: packages/rest/dist/types/types.d.ts:2492

Synchronises a template with the current state of a guild.

Parameters

guildId

https://discord.com/developers/docs/resources/guild-template#get-guild-templates

The ID of the guild to synchronise a template of.

Returns

An instance of the edited DiscordTemplate.

Remarks

Requires the MANAGE_GUILD permission.

Fires a Guild Update gateway event.

See

token

token: string

Defined in: packages/rest/dist/types/types.d.ts:57

The bot token which will be used to make requests.

triggerTypingIndicator()

triggerTypingIndicator: (channelId) => Promise<void>

Defined in: packages/rest/dist/types/types.d.ts:2507

Triggers a typing indicator for the specified channel, which expires after 10 seconds.

Parameters

channelId

https://discord.com/developers/docs/resources/channel#trigger-typing-indicator

The ID of the channel in which to trigger the typing indicator.

Returns

Promise<void>

Remarks

Generally bots should not use this route. However, if a bot is responding to a command and expects the computation to take a few seconds, this endpoint may be called to let the user know that the bot is processing their message.

Fires a Typing Start gateway event.

See

unbanMember()

unbanMember: (guildId, userId, reason?) => Promise<void>

Defined in: packages/rest/dist/types/types.d.ts:2744

Unbans a user from a guild.

Parameters

guildId

The ID of the guild to unban the user in.

userId

https://discord.com/developers/docs/resources/guild#remove-guild-ban

The ID of the user to unban.

reason?

string

An optional reason for the action, to be included in the audit log.

Returns

Promise<void>

Remarks

Requires the BAN_MEMBERS permission.

Fires a Guild Ban Remove gateway event.

See

unpinMessage()

unpinMessage: (channelId, messageId, reason?) => Promise<void>

Defined in: packages/rest/dist/types/types.d.ts:2761

Unpins a pinned message in a channel.

Parameters

channelId

The ID of the channel where the message is pinned.

messageId

https://discord.com/developers/docs/resources/channel#unpin-message

The ID of the message to unpin.

reason?

string

An optional reason for the action, to be included in the audit log.

Returns

Promise<void>

Remarks

Requires that the bot user be able to see the contents of the channel in which the messages were posted.

Requires the MANAGE_MESSAGES permission.

Fires a Channel Pins Update event.

See

updateBearerTokenEndpoint?

optional updateBearerTokenEndpoint: string

Defined in: packages/rest/dist/types/types.d.ts:79

The endpoint to use for updateTokenQueues when working with a rest proxy

updateTokenQueues()

updateTokenQueues: (oldToken, newToken) => Promise<void>

Defined in: packages/rest/dist/types/types.d.ts:104

Parameters

oldToken

string

newToken

string

Returns

Promise<void>

upsertGlobalApplicationCommands()

upsertGlobalApplicationCommands: (commands, options?) => Promise<object[]>

Defined in: packages/rest/dist/types/types.d.ts:2525

Re-registers the list of global application commands, overwriting the previous commands completely.

Parameters

commands

CreateApplicationCommand[]

The list of commands to use to overwrite the previous list.

options?

UpsertGlobalApplicationCommandOptions

Additional options for the endpoint.

Returns

Promise<object[]>

A collection of DiscordApplicationCommand objects assorted by command ID.

Remarks

❗ Commands that are not present in the commands array will be deleted.

⚠️ Commands that do not already exist will count towards the daily limit of 200 new commands.

When using the bearer token the token needs the applications.commands.update scope and must be a Client grant token. You will be able to update only your own application commands

See

https://discord.com/developers/docs/interactions/application-commands#bulk-overwrite-global-application-commands

upsertGuildApplicationCommands()

upsertGuildApplicationCommands: (guildId, commands, options?) => Promise<object[]>

Defined in: packages/rest/dist/types/types.d.ts:2544

Re-registers the list of application commands registered in a guild, overwriting the previous commands completely.

Parameters

guildId