Preview environment

interface RoutesDeclarations

export interface RoutesDeclarations

applicationCommand(
applicationId: Snowflake
commandId: Snowflake
) : `/applications/${string}/commands/${string}`

Route for: - GET /applications/{application.id}/commands/{command.id} - PATCH /applications/{application.id}/commands/{command.id} - DELETE /applications/{application.id}/commands/{command.id}

applicationCommandPermissions(
applicationId: Snowflake
guildId: Snowflake
commandId: Snowflake
) : `/applications/${string}/guilds/${string}/commands/${string}/permissions`

Route for: - GET /applications/{application.id}/guilds/{guild.id}/commands/{command.id}/permissions - PUT /applications/{application.id}/guilds/{guild.id}/commands/{command.id}/permissions

applicationCommands(
applicationId: Snowflake
) : `/applications/${string}/commands`

Route for: - GET /applications/{application.id}/commands - PUT /applications/{application.id}/commands - POST /applications/{application.id}/commands

applicationEmoji(
applicationId: Snowflake
emojiId: Snowflake
) : `/applications/${string}/emojis/${string}`

Route for: - GET /applications/{application.id}/emojis/{emoji.id} - PATCH /applications/{application.id}/emojis/{emoji.id} - DELETE /applications/{application.id}/emojis/{emoji.id}

applicationEmojis(
applicationId: Snowflake
) : `/applications/${string}/emojis`

Route for: - GET /applications/{application.id}/emojis - POST /applications/{application.id}/emojis

applicationGuildCommand(
applicationId: Snowflake
guildId: Snowflake
commandId: Snowflake
) : `/applications/${string}/guilds/${string}/commands/${string}`

Route for: - GET /applications/{application.id}/guilds/{guild.id}/commands/{command.id} - PATCH /applications/{application.id}/guilds/{guild.id}/commands/{command.id} - DELETE /applications/{application.id}/guilds/{guild.id}/commands/{command.id}

applicationGuildCommands(
applicationId: Snowflake
guildId: Snowflake
) : `/applications/${string}/guilds/${string}/commands`

Route for: - GET /applications/{application.id}/guilds/{guild.id}/commands - PUT /applications/{application.id}/guilds/{guild.id}/commands - POST /applications/{application.id}/guilds/{guild.id}/commands

applicationRoleConnectionMetadata(
applicationId: Snowflake
) : `/applications/${string}/role-connections/metadata`

Route for: - GET /applications/{application.id}/role-connections/metadata - PUT /applications/{application.id}/role-connections/metadata

channel(
channelId: Snowflake
) : `/channels/${string}`

Route for: - GET /channels/{channel.id} - PATCH /channels/{channel.id} - DELETE /channels/{channel.id}

channelBulkDelete(
channelId: Snowflake
) : `/channels/${string}/messages/bulk-delete`

Route for: - POST /channels/{channel.id}/messages/bulk-delete

channelFollowers(
channelId: Snowflake
) : `/channels/${string}/followers`

Route for: - POST /channels/{channel.id}/followers

channelInvites(
channelId: Snowflake
) : `/channels/${string}/invites`

Route for: - GET /channels/{channel.id}/invites - POST /channels/{channel.id}/invites

channelJoinedArchivedThreads(
channelId: Snowflake
) : `/channels/${string}/users/@me/threads/archived/private`

Route for: - GET /channels/{channel.id}/users/@me/threads/archived/private

channelMessage(
channelId: Snowflake
messageId: Snowflake
) : `/channels/${string}/messages/${string}`

Route for: - GET /channels/{channel.id}/messages/{message.id} - PATCH /channels/{channel.id}/messages/{message.id} - DELETE /channels/{channel.id}/messages/{message.id}

channelMessageAllReactions(
channelId: Snowflake
messageId: Snowflake
) : `/channels/${string}/messages/${string}/reactions`

Route for: - DELETE /channels/{channel.id}/messages/{message.id}/reactions

channelMessageCrosspost(
channelId: Snowflake
messageId: Snowflake
) : `/channels/${string}/messages/${string}/crosspost`

Route for: - POST /channels/{channel.id}/messages/{message.id}/crosspost

channelMessageOwnReaction(
channelId: Snowflake
messageId: Snowflake
emoji: string
) : `/channels/${string}/messages/${string}/reactions/${string}/@me`

Route for: - PUT /channels/{channel.id}/messages/{message.id}/reactions/{emoji}/@me - DELETE /channels/{channel.id}/messages/{message.id}/reactions/{emoji}/@me**Note**: You need to URL encode the emoji yourself

channelMessageReaction(
channelId: Snowflake
messageId: Snowflake
emoji: string
) : `/channels/${string}/messages/${string}/reactions/${string}`

Route for: - GET /channels/{channel.id}/messages/{message.id}/reactions/{emoji} - DELETE /channels/{channel.id}/messages/{message.id}/reactions/{emoji}**Note**: You need to URL encode the emoji yourself

channelMessages(
channelId: Snowflake
) : `/channels/${string}/messages`

Route for: - GET /channels/{channel.id}/messages - POST /channels/{channel.id}/messages

channelMessagesPin(
channelId: Snowflake
messageId: Snowflake
) : `/channels/${string}/messages/pins/${string}`

Route for: - PUT /channels/{channel.id}/messages/pins/{message.id} - DELETE /channels/{channel.id}/messages/pins/{message.id}

channelMessagesPins(
channelId: Snowflake
) : `/channels/${string}/messages/pins`

Route for: - GET /channels/{channel.id}/messages/pins

channelMessageUserReaction(
channelId: Snowflake
messageId: Snowflake
emoji: string
userId: Snowflake
) : `/channels/${string}/messages/${string}/reactions/${string}/${string}`

Route for: - DELETE /channels/{channel.id}/messages/{message.id}/reactions/{emoji}/{user.id}**Note**: You need to URL encode the emoji yourself

channelPermission(
channelId: Snowflake
overwriteId: Snowflake
) : `/channels/${string}/permissions/${string}`

Route for: - PUT /channels/{channel.id}/permissions/{overwrite.id} - DELETE /channels/{channel.id}/permissions/{overwrite.id}

deprecated
channelPin(
channelId: Snowflake
messageId: Snowflake
) : `/channels/${string}/pins/${string}`

Route for: - PUT /channels/{channel.id}/pins/{message.id} - DELETE /channels/{channel.id}/pins/{message.id}

deprecated
channelPins(
channelId: Snowflake
) : `/channels/${string}/pins`

Route for: - GET /channels/{channel.id}/pins

channelRecipient(
channelId: Snowflake
userId: Snowflake
) : `/channels/${string}/recipients/${string}`

Route for: - PUT /channels/{channel.id}/recipients/{user.id} - DELETE /channels/{channel.id}/recipients/{user.id}

channelThreads(
channelId: Snowflake
archivedStatus: 'private' | 'public'
) : `/channels/${string}/threads/archived/private` | `/channels/${string}/threads/archived/public`

Route for: - GET /channels/{channel.id}/threads/archived/public - GET /channels/{channel.id}/threads/archived/private

channelTyping(
channelId: Snowflake
) : `/channels/${string}/typing`

Route for: - POST /channels/{channel.id}/typing

channelWebhooks(
channelId: Snowflake
) : `/channels/${string}/webhooks`

Route for: - GET /channels/{channel.id}/webhooks - POST /channels/{channel.id}/webhooks

consumeEntitlement(
applicationId: Snowflake
entitlementId: Snowflake
) : `/applications/${string}/entitlements/${string}/consume`

Route for: - POST /applications/{application.id}/entitlements/{entitlement.id}/consume

currentApplication() : "/applications/@me"

Route for: - GET /applications/@me - PATCH /applications/@me

entitlement(
applicationId: Snowflake
entitlementId: Snowflake
) : `/applications/${string}/entitlements/${string}`

Route for: - GET /applications/{application.id}/entitlements/{entitlement.id} - DELETE /applications/{application.id}/entitlements/{entitlement.id}

entitlements(
applicationId: Snowflake
) : `/applications/${string}/entitlements`

Route for: - GET /applications/{application.id}/entitlements - POST /applications/{application.id}/entitlements

expirePoll(
channelId: Snowflake
messageId: Snowflake
) : `/channels/${string}/polls/${string}/expire`

Route for: - POST /channels/{channel.id}/polls/{message.id}/expire

gateway() : "/gateway"

Route for: - GET /gateway

gatewayBot() : "/gateway/bot"

Route for: - GET /gateway/bot

guild(
guildId: Snowflake
) : `/guilds/${string}`

Route for: - GET /guilds/{guild.id} - PATCH /guilds/{guild.id} - DELETE /guilds/{guild.id} (**deprecated**)

guildActiveThreads(
guildId: Snowflake
) : `/guilds/${string}/threads/active`

Route for: - GET /guilds/{guild.id}/threads/active

guildApplicationCommandsPermissions(
applicationId: Snowflake
guildId: Snowflake
) : `/applications/${string}/guilds/${string}/commands/permissions`

Route for: - GET /applications/{application.id}/guilds/{guild.id}/commands/permissions - PUT /applications/{application.id}/guilds/{guild.id}/commands/permissions

guildAuditLog(
guildId: Snowflake
) : `/guilds/${string}/audit-logs`

Route for: - GET /guilds/{guild.id}/audit-logs

guildAutoModerationRule(
guildId: Snowflake
ruleId: Snowflake
) : `/guilds/${string}/auto-moderation/rules/${string}`

Routes for: - GET /guilds/{guild.id}/auto-moderation/rules/{rule.id} - PATCH /guilds/{guild.id}/auto-moderation/rules/{rule.id} - DELETE /guilds/{guild.id}/auto-moderation/rules/{rule.id}

guildAutoModerationRules(
guildId: Snowflake
) : `/guilds/${string}/auto-moderation/rules`

Route for: - GET /guilds/{guild.id}/auto-moderation/rules - POST /guilds/{guild.id}/auto-moderation/rules

guildBan(
guildId: Snowflake
userId: Snowflake
) : `/guilds/${string}/bans/${string}`

Route for: - GET /guilds/{guild.id}/bans/{user.id} - PUT /guilds/{guild.id}/bans/{user.id} - DELETE /guilds/{guild.id}/bans/{user.id}

guildBans(
guildId: Snowflake
) : `/guilds/${string}/bans`

Route for: - GET /guilds/{guild.id}/bans

guildBulkBan(
guildId: Snowflake
) : `/guilds/${string}/bulk-ban`

Route for: - POST /guilds/{guild.id}/bulk-ban

guildChannels(
guildId: Snowflake
) : `/guilds/${string}/channels`

Route for: - GET /guilds/{guild.id}/channels - POST /guilds/{guild.id}/channels - PATCH /guilds/{guild.id}/channels

deprecated
guildCurrentMemberNickname(
guildId: Snowflake
) : `/guilds/${string}/members/@me/nick`

Route for: - PATCH /guilds/{guild.id}/members/@me/nick

guildEmoji(
guildId: Snowflake
emojiId: Snowflake
) : `/guilds/${string}/emojis/${string}`

Route for: - GET /guilds/{guild.id}/emojis/{emoji.id} - PATCH /guilds/{guild.id}/emojis/{emoji.id} - DELETE /guilds/{guild.id}/emojis/{emoji.id}

guildEmojis(
guildId: Snowflake
) : `/guilds/${string}/emojis`

Route for: - GET /guilds/{guild.id}/emojis - POST /guilds/{guild.id}/emojis

guildIncidentActions(
guildId: Snowflake
) : `/guilds/${string}/incident-actions`

Route for: - PUT /guilds/${guild.id}/incident-actions

guildIntegration(
guildId: Snowflake
integrationId: Snowflake
) : `/guilds/${string}/integrations/${string}`

Route for: - DELETE /guilds/{guild.id}/integrations/{integration.id}

guildIntegrations(
guildId: Snowflake
) : `/guilds/${string}/integrations`

Route for: - GET /guilds/{guild.id}/integrations

guildInvites(
guildId: Snowflake
) : `/guilds/${string}/invites`

Route for: - GET /guilds/{guild.id}/invites

guildMember(
guildId: Snowflake
userId?: Snowflake | '@me'
) : `/guilds/${string}/members/${string}`

Route for: - GET /guilds/{guild.id}/members/{user.id} - PUT /guilds/{guild.id}/members/{user.id} - PATCH /guilds/{guild.id}/members/@me - PATCH /guilds/{guild.id}/members/{user.id} - DELETE /guilds/{guild.id}/members/{user.id}

guildMemberRole(
guildId: Snowflake
memberId: Snowflake
roleId: Snowflake
) : `/guilds/${string}/members/${string}/roles/${string}`

Route for: - PUT /guilds/{guild.id}/members/{user.id}/roles/{role.id} - DELETE /guilds/{guild.id}/members/{user.id}/roles/{role.id}

guildMembers(
guildId: Snowflake
) : `/guilds/${string}/members`

Route for: - GET /guilds/{guild.id}/members

guildMembersSearch(
guildId: Snowflake
) : `/guilds/${string}/members/search`

Route for: - GET /guilds/{guild.id}/members/search

guildMemberVerification(
guildId: Snowflake
) : `/guilds/${string}/member-verification`

Route for: - GET /guilds/{guild.id}/member-verification - PATCH /guilds/{guild.id}/member-verification https://github.com/discord/discord-api-docs/pull/2547

guildMFA(
guildId: Snowflake
) : `/guilds/${string}/mfa`

Route for: - POST /guilds/{guild.id}/mfa

guildOnboarding(
guildId: Snowflake
) : `/guilds/${string}/onboarding`

Route for: - GET /guilds/{guild.id}/onboarding - PUT /guilds/{guild.id}/onboarding

guildPreview(
guildId: Snowflake
) : `/guilds/${string}/preview`

Route for: - GET /guilds/{guild.id}/preview

guildPrune(
guildId: Snowflake
) : `/guilds/${string}/prune`

Route for: - GET /guilds/{guild.id}/prune - POST /guilds/{guild.id}/prune

guildRole(
guildId: Snowflake
roleId: Snowflake
) : `/guilds/${string}/roles/${string}`

Route for: - GET /guilds/{guild.id}/roles/{role.id} - PATCH /guilds/{guild.id}/roles/{role.id} - DELETE /guilds/{guild.id}/roles/{role.id}

guildRoles(
guildId: Snowflake
) : `/guilds/${string}/roles`

Route for: - GET /guilds/{guild.id}/roles - POST /guilds/{guild.id}/roles - PATCH /guilds/{guild.id}/roles

deprecated
guilds() : "/guilds"

Route for: - POST /guilds

guildScheduledEvent(
guildId: Snowflake
guildScheduledEventId: Snowflake
) : `/guilds/${string}/scheduled-events/${string}`

Route for: - GET /guilds/{guild.id}/scheduled-events/{guildScheduledEvent.id} - PATCH /guilds/{guild.id}/scheduled-events/{guildScheduledEvent.id} - DELETE /guilds/{guild.id}/scheduled-events/{guildScheduledEvent.id}

guildScheduledEvents(
guildId: Snowflake
) : `/guilds/${string}/scheduled-events`

Route for: - GET /guilds/{guild.id}/scheduled-events - POST /guilds/{guild.id}/scheduled-events

guildScheduledEventUsers(
guildId: Snowflake
guildScheduledEventId: Snowflake
) : `/guilds/${string}/scheduled-events/${string}/users`

Route for: - GET /guilds/{guild.id}/scheduled-events/{guildScheduledEvent.id}/users

guildSoundboardSound(
guildId: Snowflake
soundId: Snowflake
) : `/guilds/${string}/soundboard-sounds/${string}`

Route for: - GET /guilds/{guild.id}/soundboard-sounds/{sound.id} - PATCH /guilds/{guild.id}/soundboard-sounds/{sound.id} - DELETE /guilds/{guild.id}/soundboard-sounds/{sound.id}

guildSoundboardSounds(
guildId: Snowflake
) : `/guilds/${string}/soundboard-sounds`

Route for: - GET /guilds/{guild.id}/soundboard-sounds - POST /guilds/{guild.id}/soundboard-sounds

guildSticker(
guildId: Snowflake
stickerId: Snowflake
) : `/guilds/${string}/stickers/${string}`

Route for: - GET /guilds/{guild.id}/stickers/{sticker.id} - PATCH /guilds/{guild.id}/stickers/{sticker.id} - DELETE /guilds/{guild.id}/stickers/{sticker.id}

guildStickers(
guildId: Snowflake
) : `/guilds/${string}/stickers`

Route for: - GET /guilds/{guild.id}/stickers - POST /guilds/{guild.id}/stickers

guildTemplate(
guildId: Snowflake
code: string
) : `/guilds/${string}/templates/${string}`

Route for: - PUT /guilds/{guild.id}/templates/{template.code} - PATCH /guilds/{guild.id}/templates/{template.code} - DELETE /guilds/{guild.id}/templates/{template.code}

guildTemplates(
guildId: Snowflake
) : `/guilds/${string}/templates`

Route for: - GET /guilds/{guild.id}/templates - POST /guilds/{guild.id}/templates

guildVanityUrl(
guildId: Snowflake
) : `/guilds/${string}/vanity-url`

Route for: - GET /guilds/{guild.id}/vanity-url

guildVoiceRegions(
guildId: Snowflake
) : `/guilds/${string}/regions`

Route for: - GET /guilds/{guild.id}/regions

guildVoiceState(
guildId: Snowflake
userId?: Snowflake | '@me'
) : `/guilds/${string}/voice-states/${string}`

Route for: - GET /guilds/{guild.id}/voice-states/@me - GET /guilds/{guild.id}/voice-states/{user.id} - PATCH /guilds/{guild.id}/voice-states/@me - PATCH /guilds/{guild.id}/voice-states/{user.id}

guildWebhooks(
guildId: Snowflake
) : `/guilds/${string}/webhooks`

Route for: - GET /guilds/{guild.id}/webhooks

guildWelcomeScreen(
guildId: Snowflake
) : `/guilds/${string}/welcome-screen`

Route for: - GET /guilds/{guild.id}/welcome-screen - PATCH /guilds/{guild.id}/welcome-screen

guildWidgetImage(
guildId: Snowflake
) : `/guilds/${string}/widget.png`

Route for: - GET /guilds/{guild.id}/widget.png

guildWidgetJSON(
guildId: Snowflake
) : `/guilds/${string}/widget.json`

Route for: - GET /guilds/{guild.id}/widget.json

guildWidgetSettings(
guildId: Snowflake
) : `/guilds/${string}/widget`

Route for: - GET /guilds/{guild.id}/widget - PATCH /guilds/{guild.id}/widget

interactionCallback(
interactionId: Snowflake
interactionToken: string
) : `/interactions/${string}/${string}/callback`

Route for: - POST /interactions/{interaction.id}/{interaction.token}/callback

invite(
code: string
) : `/invites/${string}`

Route for: - GET /invites/{invite.code} - DELETE /invites/{invite.code}

deprecated
nitroStickerPacks() : "/sticker-packs"

Route for: - GET /sticker-packs

oauth2Authorization() : "/oauth2/authorize"

Route for: - GET /oauth2/authorize

oauth2CurrentApplication() : "/oauth2/applications/@me"

Route for: - GET /oauth2/applications/@me

oauth2CurrentAuthorization() : "/oauth2/@me"

Route for: - GET /oauth2/@me

oauth2TokenExchange() : "/oauth2/token"

Route for: - POST /oauth2/token

oauth2TokenRevocation() : "/oauth2/token/revoke"

Route for: - POST /oauth2/token/revoke

pollAnswerVoters(
channelId: Snowflake
messageId: Snowflake
answerId: number
) : `/channels/${string}/polls/${string}/answers/${number}`

Route for: - GET /channels/{channel.id}/polls/{message.id}/answers/{answer_id}

sendSoundboardSound(
channelId: Snowflake
) : `/channels/${string}/send-soundboard-sound`

Route for: - POST /channels/{channel.id}/send-soundboard-sound

skus(
applicationId: Snowflake
) : `/applications/${string}/skus`

Route for: - GET /applications/{application.id}/skus

skuSubscription(
skuId: Snowflake
subscriptionId: Snowflake
) : `/skus/${string}/subscriptions/${string}`

Route for: - GET /skus/{sku.id}/subscriptions/{subscription.id}

skuSubscriptions(
skuId: Snowflake
) : `/skus/${string}/subscriptions`

Route for: - GET /skus/{sku.id}/subscriptions

soundboardDefaultSounds() : "/soundboard-default-sounds"

Route for: - GET /soundboard-default-sounds

stageInstance(
channelId: Snowflake
) : `/stage-instances/${string}`

Route for: - GET /stage-instances/{channel.id} - PATCH /stage-instances/{channel.id} - DELETE /stage-instances/{channel.id}

stageInstances() : "/stage-instances"

Route for: - POST /stage-instances

sticker(
stickerId: Snowflake
) : `/stickers/${string}`

Route for: - GET /stickers/{sticker.id}

stickerPack(
packId: Snowflake
) : `/sticker-packs/${string}`

Route for: - GET /sticker-packs/{pack.id}

stickerPacks() : "/sticker-packs"

Route for: - GET /sticker-packs

template(
code: string
) : `/guilds/templates/${string}`

Route for: - GET /guilds/templates/{template.code} - POST /guilds/templates/{template.code} (**deprecated**)

threadMembers(
threadId: Snowflake
userId?: Snowflake | '@me'
) : `/channels/${Snowflake}/thread-members/${Snowflake | '@me'}` | `/channels/${Snowflake}/thread-members`

Route for: - GET /channels/{thread.id}/thread-members - GET /channels/{thread.id}/thread-members/{user.id} - PUT /channels/{thread.id}/thread-members/@me - PUT /channels/{thread.id}/thread-members/{user.id} - DELETE /channels/{thread.id}/thread-members/@me - DELETE /channels/{thread.id}/thread-members/{user.id}

threads(
parentId: Snowflake
messageId?: Snowflake
) : `/channels/${Snowflake}/messages/${Snowflake}/threads` | `/channels/${Snowflake}/threads`

Route for: - POST /channels/{channel.id}/threads - POST /channels/{channel.id}/messages/{message.id}/threads

user(
userId?: Snowflake | '@me'
) : `/users/${string}`

Route for: - GET /users/@me - GET /users/{user.id} - PATCH /users/@me

userApplicationRoleConnection(
applicationId: Snowflake
) : `/users/@me/applications/${string}/role-connection`

Route for: - GET /users/@me/applications/{application.id}/role-connection - PUT /users/@me/applications/{application.id}/role-connection

userChannels() : "/users/@me/channels"

Route for: - POST /users/@me/channels

userConnections() : "/users/@me/connections"

Route for: - GET /users/@me/connections

userGuild(
guildId: Snowflake
) : `/users/@me/guilds/${string}`

Route for: - DELETE /users/@me/guilds/{guild.id}

userGuildMember(
guildId: Snowflake
) : `/users/@me/guilds/${string}/member`

Route for: - GET /users/@me/guilds/{guild.id}/member

userGuilds() : "/users/@me/guilds"

Route for: - GET /users/@me/guilds

voiceRegions() : "/voice/regions"

Route for: - GET /voice/regions

webhook(
webhookId: Snowflake
webhookToken?: string
) : `/webhooks/${Snowflake}/${string}` | `/webhooks/${Snowflake}`

Route for: - GET /webhooks/{webhook.id} - GET /webhooks/{webhook.id}/{webhook.token} - PATCH /webhooks/{webhook.id} - PATCH /webhooks/{webhook.id}/{webhook.token} - DELETE /webhooks/{webhook.id} - DELETE /webhooks/{webhook.id}/{webhook.token} - POST /webhooks/{webhook.id}/{webhook.token}- POST /webhooks/{application.id}/{interaction.token}

webhookMessage(
webhookId: Snowflake
webhookToken: string
messageId?: Snowflake | '@original'
) : `/webhooks/${string}/${string}/messages/${string}`

Route for: - GET /webhooks/{webhook.id}/{webhook.token}/messages/@original - GET /webhooks/{webhook.id}/{webhook.token}/messages/{message.id} - PATCH /webhooks/{webhook.id}/{webhook.token}/messages/@original - PATCH /webhooks/{webhook.id}/{webhook.token}/messages/{message.id} - DELETE /webhooks/{webhook.id}/{webhook.token}/messages/@original - DELETE /webhooks/{webhook.id}/{webhook.token}/messages/{message.id}- PATCH /webhooks/{application.id}/{interaction.token}/messages/@original - PATCH /webhooks/{application.id}/{interaction.token}/messages/{message.id} - DELETE /webhooks/{application.id}/{interaction.token}/messages/{message.id}

webhookPlatform(
webhookId: Snowflake
webhookToken: string
platform: 'github' | 'slack'
) : `/webhooks/${string}/${string}/github` | `/webhooks/${string}/${string}/slack`

Route for: - POST /webhooks/{webhook.id}/{webhook.token}/github - POST /webhooks/{webhook.id}/{webhook.token}/slack