Discord

Retrieves messages from a specified discord channel. this endpoint allows you to fetch the message history or recent messages for a given channel, which is useful for displaying chat logs, implementing search functionality, or syncing messages across different platforms. the endpoint returns a list of message objects, likely in reverse chronological order (newest first). it should be used when you need to access the content of messages in a specific channel, such as for moderation purposes, data analysis, or creating chat archives. note that this endpoint may have rate limits and pagination to manage large message volumes, so it’s important to handle these aspects in your implementation. the endpoint does not provide real-time updates; for live message tracking, consider using discord’s websocket api instead.

Action Parameters

Action Response

Retrieves all roles defined within a specific discord guild (server). this endpoint is used to fetch comprehensive information about the role hierarchy and permissions structure of a given server. it provides details on each role, including their names, colors, positions in the hierarchy, and associated permissions. this tool is essential for applications that need to understand or manage the permission structure of a discord server, such as moderation bots or server management tools. it should be used when you need a complete overview of a guild’s roles, but it won’t provide information about which users have which roles.

Action Parameters

Action Response

Retrieves detailed information about a specific ban for a user in a discord guild. this endpoint allows developers to fetch the ban status and related details for a particular user within a specific guild (server). it’s useful for moderators and administrators to review ban information, such as the reason for the ban and when it was implemented. the endpoint should be used when there’s a need to verify or inspect an existing ban, but it cannot be used to create, modify, or remove bans. it’s important to note that this endpoint only provides information if the specified user is actually banned from the guild; if the user is not banned, it may return an error or an empty response.

Action Parameters

Action Response

This endpoint allows you to modify the attributes of an existing role within a discord guild (server). it is used to update various properties of a role, such as its name, permissions, color, and display settings. the endpoint is particularly useful for bot developers who need to programmatically manage roles in discord servers. to use this endpoint, you must specify both the guild id and role id in the url path. the request body can contain any combination of the modifiable attributes, allowing for partial updates. any attributes not included or set to null will remain unchanged. it’s important to note that this endpoint can only modify existing roles; it cannot create new roles or delete existing ones. also, be cautious when modifying role permissions, as this can significantly impact user access within the guild.

Action Parameters

Action Response

Retrieves the welcome screen configuration for a specified discord guild (server). this endpoint is used to fetch the current settings and content of the welcome screen, which is displayed to new members when they join a community server. it’s particularly useful for bot developers or server managers who need to programmatically access or display welcome screen information. the endpoint should be used when you need to view or verify the current welcome screen setup for a guild. note that this endpoint only works for guilds that have the community feature enabled and have set up a welcome screen. it will not provide welcome screen data for guilds that don’t meet these criteria.

Action Parameters

Action Response

This endpoint allows you to edit an existing discord application command within a specific guild. it provides the ability to modify various aspects of the command, including its name, description, options, and permissions. use this endpoint to update or refine a guild-specific command’s functionality, localization, or access controls. be cautious about making drastic changes to existing commands, as it may confuse users familiar with the previous version.

Action Parameters

Action Response

Retrieves a specific message from a discord channel. this endpoint allows you to fetch detailed information about a single message, including its content, author, timestamp, and any attachments or embeds. it’s particularly useful for bot development, message logging, or implementing features that require analysis or manipulation of specific messages. the endpoint should be used when you need to access or verify the contents of a particular message within a channel. it does not provide information about other messages in the channel or modify the message in any way. note that you must have the necessary permissions to view the message in the specified channel.

Action Parameters

Action Response

Creates a new guild (server) in discord with customizable settings. this endpoint allows you to set up a guild with specific roles, channels, moderation settings, and other configurations. use this when you need to programmatically create a new community or workspace within discord. the created guild will be owned by the authenticated user. note that while many parameters are optional, providing more details will result in a more complete and ready-to-use guild structure. be aware of rate limits and the maximum number of guilds a user can create, which may vary based on account type and status.

Action Parameters

Action Response

Creates a new custom emoji for a specific discord guild (server). this endpoint allows you to upload an image and set a name for the emoji, which can then be used within the guild’s text channels and reactions. optionally, you can restrict the emoji’s usage to specific roles. use this when you want to add new custom emojis to enrich communication within your discord community. the created emoji will be immediately available for use after successful creation. note that guilds have limits on the number of custom emojis they can have, which depends on the guild’s boost level. ensure that your application handles potential rate limits or emoji limit errors gracefully.

Action Parameters

Action Response

Removes a specified user from a thread within a discord channel. this endpoint is used to manage thread membership by forcibly removing a user from the thread conversation. it should be used when a user needs to be excluded from a thread, such as for moderation purposes or when their participation is no longer required. the endpoint does not provide any information about the removed user or the thread status after the operation. it’s important to note that this action may have implications on the user’s ability to view or participate in the thread, depending on the channel and thread settings.

Action Parameters

Action Response

Retrieves detailed information about a specific emoji from a discord guild (server). this endpoint allows developers to fetch the properties and metadata of a custom emoji, such as its name, image url, and creation date. it should be used when you need to access or display information about a particular emoji within a guild’s context. the endpoint is useful for applications that manage emojis, display emoji details, or need to verify an emoji’s existence and properties. note that this endpoint only retrieves data for custom emojis created within the specified guild and does not provide information about standard unicode emojis.

Action Parameters

Action Response

Retrieves a list of connected accounts for the authenticated user on discord. this endpoint allows developers to access information about external services or platforms that the user has linked to their discord account. it should be used when an application needs to gather data about a user’s connected accounts, such as for displaying integrated services or syncing information across platforms. the endpoint returns details of various connections, which may include services like twitch, youtube, or other social media platforms. it’s important to note that this endpoint only provides information about existing connections and does not allow for adding or modifying connections. the data returned is specific to the authenticated user and requires proper authentication to access.

Action Parameters

Action Response

Removes the authenticated user’s reaction (emoji) from a specific message in a discord channel. this endpoint is used when a user wants to undo their reaction to a message. it’s particularly useful in situations where a user wants to change their reaction or remove it entirely. the endpoint only affects the authenticated user’s own reaction and cannot be used to remove other users’ reactions. it’s important to note that this action is irreversible, and once a reaction is removed, it cannot be automatically restored - the user would need to add the reaction again if desired.

Action Parameters

Action Response

Creates a new role within a specified discord guild (server). this endpoint allows for the customization of various role properties, including name, permissions, color, and display options. it’s particularly useful for programmatically managing server structures, implementing role-based access control, or creating specialized roles for events or categories. the created role can be assigned to users to grant them specific permissions and visual distinctions within the guild. note that while all parameters are optional, providing values for key properties like name and permissions is recommended for immediate role utility. be mindful of permission settings to maintain server security.

Action Parameters

Action Response

Retrieves a list of guilds (servers) that the authenticated user is a member of on discord. this endpoint provides essential information about each guild, such as its id, name, and the user’s role within it. it’s particularly useful for applications that need to display or manage a user’s server list, or to check a user’s membership status across multiple servers. the endpoint returns only basic guild information and does not include detailed data like channel lists or member rosters. be aware that for users who are members of many guilds, the response may be paginated, and additional requests might be necessary to fetch the complete list.(DEPRECATED use list_my_guilds)

Action Parameters

Action Response

Deletes a specific auto-moderation rule from a discord guild (server). this endpoint should be used when you want to permanently remove an existing auto-moderation rule from a guild’s settings. it’s particularly useful for updating a guild’s moderation strategy or removing outdated or unnecessary rules. the deletion is irreversible, so it should be used with caution. this endpoint only deletes the rule; it does not provide information about the rule before deletion or allow for retrieving deleted rules.

Action Parameters

Action Response

The editwebhookmessage endpoint allows you to modify an existing message sent through a discord webhook. use this to update content, add embeds, change attachments, or include interactive components. it supports partial updates, letting you modify specific elements without affecting others. be aware of rate limits and maximum limits for content length, embeds, attachments, and components.

Action Parameters

Action Response

Retrieves the permissions for application commands in a specific guild (server). this endpoint allows developers to fetch the current permission settings for all application commands associated with their application in a particular guild. it’s useful for auditing or verifying the current state of command permissions before making changes or troubleshooting access issues. the endpoint returns a list of permissions, likely including details such as which roles or users have access to each command. this tool should be used when you need to check the existing permissions for your application’s commands in a guild, but it cannot be used to modify these permissions directly. note that the response will only include permissions for commands that have been explicitly set at the guild level, not global permissions or default settings.

Action Parameters

Action Response

Creates a new guild (server) in discord with customizable settings. this endpoint allows you to set up a guild with specific roles, channels, moderation settings, and other configurations. use this when you need to programmatically create a new community or workspace within discord. the created guild will be owned by the authenticated user. note that while many parameters are optional, providing more details will result in a more complete and ready-to-use guild structure. be aware of rate limits and the maximum number of guilds a user can create, which may vary based on account type and status.(DEPRECATED use create_guild)

Action Parameters

Action Response

Retrieves all active invites for a specified discord guild (server). this endpoint allows developers to fetch a comprehensive list of current invitations to join the guild, including details such as the invite codes, creators, and expiration times. it’s particularly useful for guild management, analytics, or creating invite management features within applications. the endpoint should be used when an overview of all active guild invites is needed, such as for moderation purposes or tracking invite usage. note that this endpoint only returns active invites; expired or revoked invites will not be included in the response. the user making the request must have sufficient permissions within the guild to view invites.

Action Parameters

Action Response

Retrieves detailed information about the current authenticated application. this endpoint allows developers to access various attributes and settings of their discord application or bot. it’s particularly useful for self-inspection, verifying application details, or dynamically adjusting application behavior based on its current configuration. the endpoint returns comprehensive data about the application, which may include its name, description, icon, bot user information, and other relevant metadata. while specific return fields are not detailed in the schema, developers can expect a rich set of application-related information. this endpoint should be used when an application needs to introspect its own properties or verify its current state within the discord ecosystem.

Action Parameters

Action Response

Modifies the widget settings for a specific discord guild (server). this endpoint allows you to enable or disable the guild widget and set the channel where the widget invite will direct new users. the guild widget is a customizable interface that provides information about the guild and can be used to attract new members. use this endpoint when you need to update the widget configuration, such as changing its visibility or the designated invite channel. it’s particularly useful for guild administrators who want to manage their server’s public presence or control how new members join through the widget. note that this endpoint only modifies widget settings and does not create or delete the widget itself.

Action Parameters

Action Response

Updates an existing scheduled event in a discord guild. this endpoint allows modifying various attributes of a scheduled event, such as its status, name, description, timing, and associated metadata. it’s particularly useful for managing the lifecycle of events, changing event details, or adjusting schedules. the endpoint provides flexibility in updating different types of events (stage instances, voice events, or external events) with type-specific fields. use this endpoint when you need to make changes to an existing event rather than creating a new one or when transitioning an event through its lifecycle stages (e.g., from scheduled to active to completed).

Action Parameters

Action Response

Edits an existing message in a specific discord channel. this endpoint allows you to modify various aspects of a message, including its text content, embeds, components, and attachments. it’s useful for updating bot-sent messages with new information, correcting errors, or adding interactive elements after the initial message was sent. you can selectively update specific parts of the message by including only the fields you want to change. omitted fields will remain unchanged. to remove content, embeds, or components, set their respective fields to null or an empty array. note that you can only edit messages sent by your bot or application. there are rate limits on editing messages, so avoid excessive edits. some message properties, like the author, cannot be changed using this endpoint.

Action Parameters

Action Response

Creates a new custom sticker for a specific discord guild. this endpoint allows guild administrators or users with appropriate permissions to upload and add new stickers to their guild’s collection. the sticker can be used by members in chat messages to express emotions or add visual flair. use this endpoint when you want to programmatically add new stickers to a guild, such as for custom integrations or automated sticker management systems. note that there are limits on the number of stickers a guild can have based on various factors like boost level.

Action Parameters

Action Response

This endpoint executes a github webhook, processing various github events and sending corresponding notifications to a discord channel. it serves as a bridge between github and discord, allowing real-time updates about repository activities to be relayed to discord users. the webhook can handle a wide range of github events, including but not limited to pushes, pull requests, issues, comments, and releases. the endpoint should be used when you want to set up automated notifications in discord for github repository events. it’s particularly useful for development teams who want to stay informed about project updates, code reviews, and discussions without leaving their discord environment. while this webhook provides comprehensive event data, it’s important to note that it doesn’t allow for direct interaction with github from discord. it’s a one-way communication channel from github to discord. additionally, the webhook payload has a maximum size limit, which might affect extremely large events or comments.

Action Parameters

Action Response

The search guild members endpoint allows you to search for members within a specific discord guild (server) based on their username or nickname. this get request is useful for finding particular users in a guild, especially in large communities where manual searching might be impractical. the endpoint returns a list of guild member objects whose username or nickname starts with the provided search string. it’s particularly beneficial for bots and applications that need to manage or interact with specific guild members efficiently. note that this endpoint may have limitations on the number of results returned and could be subject to rate limiting. for more accurate and faster results, consider using the newer elasticsearch-based endpoint ‘/guilds/{guild_id}/members-search’ if available.

Action Parameters

Action Response

Updates the current user’s discord profile, allowing modifications to the username and avatar. this endpoint should be used when a user wants to change their display name or profile picture within the discord platform. it’s particularly useful for users who want to refresh their online identity or maintain consistency across different servers. the endpoint only updates the specified fields, leaving other profile information unchanged. note that changing the username too frequently may be subject to rate limiting, and inappropriate avatars may be removed by discord moderators. this endpoint does not handle other account settings such as email or password changes.

Action Parameters

Action Response

Removes a specific user’s reaction from a message in a discord channel. this endpoint is used to programmatically delete a single emoji reaction made by a particular user on a given message. it’s useful for moderation purposes, cleaning up reactions, or managing user interactions within a discord bot or application. the operation is idempotent, meaning repeated calls with the same parameters will not cause errors or additional side effects if the reaction has already been removed.

Action Parameters

Action Response

Creates a new thread from an existing message in a discord channel. this endpoint allows you to start a focused discussion based on a specific message, organizing conversations within busy channels. the new thread will be associated with the original message and appear in the channel’s thread list. use this when you want to branch off a conversation from the main channel into a more specific topic. the thread can have its own set of permissions, auto-archive duration, and rate limiting. note that you must have the necessary permissions in the channel to create a thread, and the original message must still be visible in the channel.

Action Parameters

Action Response

Retrieves a list of users who have reacted to a specific message with a particular emoji in a discord channel. this endpoint allows you to fetch detailed information about reactions on a message, which is useful for analyzing user engagement, creating interactive features, or gathering metrics on content popularity. it should be used when you need to know who reacted to a message with a specific emoji, such as for implementing reaction-based features or moderating content based on reactions. the endpoint is limited to retrieving reactions for a single emoji at a time and does not provide information about other reactions on the message or the message content itself.

Action Parameters

Action Response

Retrieves a specific message from a discord channel. this endpoint allows you to fetch detailed information about a single message, including its content, author, timestamp, and any attachments or embeds. it’s particularly useful for bot development, message logging, or implementing features that require analysis or manipulation of specific messages. the endpoint should be used when you need to access or verify the contents of a particular message within a channel. it does not provide information about other messages in the channel or modify the message in any way. note that you must have the necessary permissions to view the message in the specified channel.(DEPRECATED use get_message)

Action Parameters

Action Response

Creates a new channel within a specified discord guild (server). this endpoint allows for the creation of various channel types, including text channels, voice channels, categories, announcement channels, stage channels, directory channels, and forum channels. it provides extensive customization options for each channel type, such as setting permissions, configuring voice settings, and defining forum-specific parameters. use this endpoint when you need to programmatically add new channels to a guild, organize existing channels, or set up specialized channels like forums or announcement channels. note that the creation of channels is subject to the permissions of the authenticated user in the guild, and some options may only be applicable to specific channel types.

Action Parameters

Action Response

Adds a user to a thread within a specified discord channel. this endpoint is used to include a user in an existing thread, allowing them to participate in the discussion. it should be used when you want to bring a user into a thread conversation, either to involve them in an ongoing discussion or to grant them access to a private thread. the endpoint is particularly useful for managing thread membership programmatically, such as when implementing custom thread management features or automating user inclusion in relevant discussions. note that this action may be subject to permission checks, and the user being added must have access to the parent channel.

Action Parameters

Action Response

Updates the properties of an existing discord application. this endpoint allows you to modify various aspects of your application, including its description, visual elements, team affiliation, interaction endpoints, and installation parameters. use this when you need to change or update any details of your discord application after its initial creation. it’s particularly useful for maintaining up-to-date application information, adjusting its appearance, or modifying its behavior. note that some fields, like the application type, have specific constraints, and others, like the icon and cover image, require base64-encoded strings.

Action Parameters

Action Response

This endpoint allows you to execute a discord webhook, enabling you to send messages, embeds, and interactive components to a specific discord channel. it’s useful for integrating external services with discord, sending automated notifications, or creating custom bot-like interactions without a full bot implementation. the webhook can be customized with a username and avatar, and supports thread interactions. use this when you need to push information to discord channels programmatically, especially for notifications, updates, or interactive messages. note that webhook usage is subject to discord’s rate limits, and the webhook url should be kept secure as it bypasses normal authentication.

Action Parameters

Action Response

Retrieves the authenticated user’s profile information using discord’s oauth2 system. this endpoint returns essential details about the user, such as their identity, associated guilds, and potentially other account-related information. it should be used when an application needs to access the current user’s data after successful oauth2 authentication. the endpoint is particularly useful for personalization, user management, and integration of discord user data into third-party applications. note that the specific data returned may depend on the oauth2 scopes granted during the authentication process.(DEPRECATED use get_my_oauth2_authorization)

Action Parameters

Action Response

Retrieves detailed information about a specific discord user based on their unique user id. this endpoint allows developers to access public user data, which may include the user’s username, avatar, account creation date, and other relevant information. it’s particularly useful for applications that need to display user profiles, manage user interactions, or integrate discord user data into their services. the endpoint should be used when specific user details are required, but it will not provide information about the user’s activities, messages, or server memberships. note that some user information may be limited based on privacy settings or if the user has restricted access to their profile.(DEPRECATED use get_user)

Action Parameters

Action Response

This endpoint allows you to modify an existing sticker within a specific discord guild. it enables partial updates to the sticker’s properties, including its name, tags, and description. use this endpoint when you need to update sticker information without creating a new sticker or replacing it entirely. the changes are applied immediately, and only the provided fields will be updated, leaving others unchanged. note that this endpoint requires appropriate permissions within the guild to modify stickers.

Action Parameters

Action Response

Removes the authenticated user from a specified guild (server) on discord. this endpoint should be used when a user wants to voluntarily leave a guild they are currently a member of. it’s important to note that this action is immediate and irreversible without a new invitation. the endpoint does not provide any additional functionality such as transferring ownership or managing other users. use this endpoint cautiously, as leaving a guild may result in loss of access to the guild’s content, roles, and permissions. this action cannot be used to remove other users from a guild; it only affects the authenticated user.

Action Parameters

Action Response

Retrieves detailed information about a specific discord guild (server) using its unique identifier. this endpoint allows developers to fetch comprehensive data about a guild, including its name, features, member count, channel list, roles, and other server-specific settings. it’s particularly useful when you need to display guild information in a bot or third-party application, or when you need to verify certain guild properties. the endpoint should be used when detailed, up-to-date information about a particular guild is required. it does not modify any guild data and is read-only. note that the amount and type of information returned may depend on the permissions of the authenticated user making the request.

Action Parameters

Action Response

Retrieves a list of members for a specified discord guild (server). this endpoint allows developers to fetch detailed information about the users who are part of a particular guild. it’s useful for various purposes such as member management, analytics, or displaying member information within a bot or application. the endpoint returns member data which typically includes user ids, usernames, roles, and join dates. it’s important to note that this endpoint may not return all members for very large guilds due to discord’s optimization practices. in such cases, pagination might be necessary, though the details are not provided in this schema. use this endpoint when you need to access member information for a specific guild, but be mindful of rate limits and the potential need for pagination in large guilds.

Action Parameters

Action Response

Retrieves a list of connected accounts for the authenticated user on discord. this endpoint allows developers to access information about external services or platforms that the user has linked to their discord account. it should be used when an application needs to gather data about a user’s connected accounts, such as for displaying integrated services or syncing information across platforms. the endpoint returns details of various connections, which may include services like twitch, youtube, or other social media platforms. it’s important to note that this endpoint only provides information about existing connections and does not allow for adding or modifying connections. the data returned is specific to the authenticated user and requires proper authentication to access.(DEPRECATED use list_my_connections)

Action Parameters

Action Response

Adds a specific role to a member within a discord guild (server). this endpoint is used to assign additional permissions or status to a user by giving them a predefined role. it’s particularly useful for automated role management, such as assigning roles based on user actions or time spent in the server. the operation requires the guild id, user id, and role id to be specified in the url path. this endpoint should be used when you need to programmatically update a user’s roles without manual intervention. note that the user must already be a member of the guild, and the role must exist within the guild for the operation to succeed. the endpoint doesn’t return the updated member object, so you may need to fetch the member’s information separately to confirm the role addition.

Action Parameters

Action Response

Retrieves a list of available voice regions for a specific discord guild (server). this endpoint should be used when setting up or managing voice channels within a guild to determine which voice server locations are available for optimizing voice quality and reducing latency. the returned information can help in choosing the most suitable region for the guild’s voice channels based on the geographical distribution of its members. this endpoint does not modify any guild settings; it only provides information about available options. it’s particularly useful for large or geographically diverse communities where voice quality is a priority.

Action Parameters

Action Response

Deletes a specific application command from a discord guild (server). this endpoint is used to remove a previously registered slash command, user command, or message command associated with your application in a particular guild. it’s particularly useful for managing your application’s command list, especially when you want to remove outdated or unnecessary commands. the deletion is permanent and cannot be undone, so use this endpoint with caution. this operation helps in maintaining a clean and relevant set of commands for your discord bot or application within a specific server.

Action Parameters

Action Response

Adds the authenticated user to a thread within a specified discord channel. this endpoint should be used when a user wants to join a thread they are not currently a member of. it allows users to participate in thread discussions and receive notifications for that thread. the endpoint is particularly useful for joining archived threads or threads in channels where the user doesn’t have automatic thread join permissions. note that this endpoint may fail if the thread is at maximum capacity or if the user doesn’t have permission to join the thread. it’s important to handle potential errors gracefully in your application.

Action Parameters

Action Response

Retrieves a list of archived private threads within a specified discord channel. this endpoint is used to access private conversations that have been moved to an archived state, making them less prominent but still accessible. it’s particularly useful for managing and reviewing past discussions in community servers or team collaborations. the endpoint returns archived private threads sorted by their archive timestamp in descending order, providing the most recently archived threads first. use this when you need to access historical private conversations or when implementing thread management features in your discord integration. note that this endpoint only retrieves private threads, not public ones, and access is restricted to users with appropriate permissions in the channel.

Action Parameters

Action Response

Retrieves a list of all webhooks associated with a specific discord channel. this endpoint allows developers to fetch detailed information about existing webhooks for a given channel, including their ids, names, avatars, and token (if available). it’s useful for managing and auditing webhook configurations within a discord server. the endpoint should be used when you need to review or manage the webhooks set up for a particular channel, such as for debugging, updating, or removing webhooks. it does not create new webhooks or modify existing ones. note that this endpoint only returns webhooks for the specified channel and does not provide information about webhooks in other channels or server-wide webhooks.

Action Parameters

Action Response

Retrieves detailed information about a specific scheduled event within a discord guild. this endpoint allows developers to fetch comprehensive data about a particular event, including its name, description, start and end times, location (if applicable), and current status. it’s useful for displaying event information in applications, tracking event details, or syncing event data with external calendars. the endpoint should be used when up-to-date information about a specific guild event is needed. it does not modify the event or provide information about event attendees. note that the response will only include publicly available information about the event, and access may be restricted based on the bot’s permissions within the guild.

Action Parameters

Action Response

Creates a new global command for a discord application. this endpoint allows developers to define custom slash commands or context menu commands that users can interact with. the created command will be available in all guilds the application has the applications.commands scope authorized, as well as in dms. use this to expand your application’s functionality by adding new ways for users to interact with your bot or app. be mindful of rate limits and the global command limit per application. after creation, it may take up to an hour for commands to be available to users.

Action Parameters

Action Response

This endpoint allows you to modify the nickname of the currently authenticated user within a specific discord guild (server). it’s used when a user wants to change their display name in a particular server without affecting their global username. the nickname is limited to 32 characters and can be set to null to remove it entirely. this operation is useful for personalizing a user’s identity within different communities or for role-playing purposes. note that the ability to change nicknames may be restricted by server permissions, and some servers may have policies about nickname content.

Action Parameters

Action Response

Deletes a specific invite from a discord server using its unique invite code. this endpoint should be used when you want to revoke access to a server through a particular invite link, effectively preventing new users from joining via that invite. it’s particularly useful for managing server access, removing expired or unwanted invites, or controlling the number of active invites. the deletion is permanent and cannot be undone, so use this endpoint cautiously. it does not affect users who have already joined the server using this invite.

Action Parameters

Action Response

Retrieves a list of integration objects for a specified discord guild. this endpoint is used to fetch information about all third-party services, bots, or applications that have been integrated with the guild. it’s particularly useful for guild administrators or bot developers who need to manage or audit the external services connected to a discord server. the endpoint requires the manage guild permission and should be used when you need a comprehensive overview of a guild’s integrations. note that this endpoint only provides integration data and does not allow for modifying or adding new integrations.

Action Parameters

Action Response

Deletes a specific role from a discord guild. this endpoint permanently removes the role identified by the role id from the guild specified by the guild id. it should be used when you need to completely remove a role from a guild’s hierarchy, including all associated permissions and assignments. this action is irreversible, so it should be used with caution. the endpoint is particularly useful for cleaning up outdated roles or restructuring a guild’s permission system. it does not provide any information about the deleted role or affect other roles in the guild.

Action Parameters

Action Response

This endpoint allows you to modify various settings of a discord guild (server). it provides extensive control over guild configuration, including name, description, moderation settings, channel assignments, and feature toggles. use this endpoint when you need to update one or more guild settings programmatically. the endpoint is particularly useful for bot developers and server management tools that need to automate guild configuration changes. note that some parameters may require specific guild features to be enabled, and certain modifications (like transferring ownership) may require additional permissions. be cautious when modifying critical settings like verification levels or system channels, as these changes can significantly impact the guild’s functionality and user experience.

Action Parameters

Action Response

Deletes a custom emoji from a specified discord guild (server). this endpoint is used to permanently remove a custom emoji, freeing up space for new emojis if the guild has reached its emoji limit. it should be used when server administrators or users with the manage guild expressions permission want to remove outdated or unwanted custom emojis. the operation is irreversible, so caution should be exercised when using this endpoint. note that this endpoint cannot be used to delete default discord emojis or emojis from other servers.

Action Parameters

Action Response

Retrieves detailed information about the current oauth2 application authenticated with discord. this endpoint allows developers to access metadata and settings for their application, such as the app’s name, icon, description, and other relevant details. it’s particularly useful for applications that need to verify their own identity or fetch up-to-date configuration information. the endpoint should be used when an application needs to self-inspect or update its own information dynamically. note that this endpoint only provides information about the authenticated application and cannot be used to query details of other discord applications.

Action Parameters

Action Response

Retrieves detailed information about a specific application command within a discord guild. this endpoint allows developers to fetch the properties and configuration of a command that has been registered for their application in a particular server. it’s useful for inspecting command settings, verifying command existence, or retrieving command details for modification purposes. the endpoint requires the application id, guild id, and command id to be specified in the path, ensuring precise targeting of the desired command. this tool should be used when needing to review or validate the current state of a specific command in a guild, but it does not modify the command or return a list of all commands.

Action Parameters

Action Response

Retrieves a list of available sticker packs on the discord platform. this endpoint provides information about collections of stickers that users can access and use in their discord messages. it’s useful for applications that want to display or manage sticker packs within their interface. the endpoint returns details about official discord sticker packs, which may include pack names, descriptions, banner images, and the stickers contained within each pack. note that this endpoint likely does not include custom or user-created sticker packs, focusing instead on the standard packs available to all discord users.

Action Parameters

Action Response

Retrieves a list of all guild templates associated with a specific discord guild (server). this endpoint allows developers to fetch pre-configured server setups that can be used to create new guilds quickly. it’s particularly useful for retrieving templates created by guild administrators to standardize new server creation or to offer as starting points for community expansion. the endpoint returns all templates for the specified guild, providing details such as template code, name, description, and usage statistics. use this when you need to display available templates for a guild or before creating a new guild based on a template. note that this endpoint only retrieves templates; it does not create or modify them.

Action Parameters

Action Response

This endpoint allows you to update the properties of an existing discord webhook. it can be used to modify the webhook’s name, avatar, or the channel it’s associated with. this is particularly useful for maintaining and adjusting webhooks as your discord server evolves. the endpoint accepts partial updates, meaning you can provide only the fields you want to change. keep in mind that this operation directly modifies the webhook, so use it carefully to avoid unintended changes to your integrations.

Action Parameters

Action Response

Removes a user (recipient) from a specific discord channel. this endpoint is used to manage channel membership by removing individual users. it’s particularly useful for administrative purposes, such as removing inactive members or managing private channel access. the operation is irreversible and will immediately revoke the user’s access to the channel. this endpoint should be used cautiously, as it affects user access and channel composition. it does not provide any feedback on the success of the operation, so additional verification may be necessary after calling this endpoint.

Action Parameters

Action Response

Deletes a specific scheduled event from a discord guild. this endpoint should be used when you want to permanently remove a scheduled event from a guild’s calendar. it requires the guild id and the scheduled event id to precisely target the event for deletion. this action is irreversible, so it should be used with caution. the endpoint is particularly useful for cleaning up past events, canceling upcoming events, or managing the guild’s event list. note that this operation likely requires appropriate permissions within the guild to execute successfully.

Action Parameters

Action Response

Updates a user’s voice state within a specific discord guild (server). this endpoint allows for modifying a user’s suppression status and changing their voice channel. it can be used to programmatically mute/unmute users or move them between voice channels. the endpoint is particularly useful for bot applications that need to manage voice states, such as moderation bots or music bots. note that this endpoint only updates the specified properties; any unspecified properties will remain unchanged. also, be aware that using this endpoint may be subject to discord’s rate limits and requires appropriate permissions within the guild.

Action Parameters

Action Response

Retrieves a list of all commands registered for a specific application within a particular discord guild. this endpoint is used to fetch the available slash commands, context menu commands, or any other type of application command that has been set up for the application in the specified guild. it’s particularly useful for developers who need to manage, update, or simply view the current set of commands their application offers in a guild. the endpoint should be used when you need to audit your application’s commands, prepare for updates, or troubleshoot command-related issues. it does not provide information about command permissions or usage statistics; it only returns the command definitions themselves.

Action Parameters

Action Response

Updates the onboarding configuration for a specified discord guild (server). this endpoint allows server administrators to customize the onboarding experience for new members by defining prompts, setting default channels, and controlling the overall onboarding process. it can be used to create an interactive and guided introduction to the server, helping new members understand the community structure and rules. the endpoint supports advanced customization options, including multiple-choice questions, role assignments, and channel suggestions. however, it’s important to note the limitations on the number of prompts, options, and default channels that can be configured.

Action Parameters

Action Response

Deletes a specific sticker from a discord guild (server). this endpoint allows guild administrators or users with the appropriate permissions to permanently remove a custom sticker from their server. use this when you want to delete outdated, inappropriate, or unused stickers from your guild. once deleted, the sticker cannot be recovered and will no longer be available for use in the guild. this operation is irreversible, so it should be used with caution. the endpoint requires both the guild id and the sticker id to ensure precise removal of the intended sticker.

Action Parameters

Action Response

Updates an existing guild template in discord. this endpoint allows you to modify the name and/or description of a specific template within a guild. use this when you need to refine or adjust the metadata of a guild template without creating a new one. the endpoint is particularly useful for maintaining up-to-date and accurate template information as your server evolves. note that this operation only affects the template itself and does not impact any guilds that may have been created from this template previously. be aware that you can only update templates for guilds where you have the necessary permissions.

Action Parameters

Action Response

Retrieves the number of members that would be removed from a specified discord guild (server) in a prune operation. this endpoint is used to estimate the impact of a prune action before actually performing it. it calculates how many inactive members would be removed based on the specified inactivity period and role criteria. this tool is particularly useful for large guild management and cleanup operations, helping administrators make informed decisions about member pruning. it does not actually remove any members; it only provides a count. use this endpoint when planning guild maintenance or when you need to assess the potential impact of a prune operation on your guild’s member count.

Action Parameters

Action Response

Retrieves all webhooks associated with a specific discord guild (server). this endpoint allows developers to fetch a comprehensive list of webhooks that have been created within the specified guild. it’s particularly useful for managing and auditing webhook integrations, such as those used for automated messaging or external service connections. the endpoint should be used when you need to review, manage, or gather information about existing webhooks in a guild. it does not create, modify, or delete webhooks; it only provides read access to the current webhook configuration. the response typically includes details such as the webhook’s id, name, channel id, and other relevant metadata for each webhook in the guild.

Action Parameters

Action Response

Retrieves a list of archived private threads in a specific channel that the current user has participated in. this endpoint is useful for accessing historical private conversations within a discord server. it should be used when a user needs to review or reference past private discussions that are no longer active. the endpoint only returns threads that the user was a part of and does not provide access to other users’ private threads. note that this endpoint specifically targets archived threads, meaning it won’t return active or unarchived private threads.

Action Parameters

Action Response

Retrieves the audit logs for a specified discord guild (server). this endpoint allows you to fetch a list of recent actions performed within the guild, such as message deletions, member kicks, bans, or role changes. it’s essential for server moderation, tracking administrative actions, and maintaining accountability within a discord community. the endpoint requires the ‘view audit log’ permission and should be used when detailed information about recent guild actions is needed. it does not provide real-time updates; for live monitoring, consider using the ‘guildauditlogentrycreate’ gateway event instead.

Action Parameters

Action Response

This endpoint creates a new application command for a specific guild (server) in discord. it allows developers to define custom slash commands, user commands, or message commands that can be used within the specified guild. the command can have various options, including subcommands and arguments, with support for different data types and localization. use this endpoint when you want to add new interactive functionality to your discord bot or application within a particular server. note that created commands will be available immediately, but may take up to an hour to be displayed to users due to caching. the endpoint is subject to rate limits, and there’s a maximum of 100 application commands per guild.

Action Parameters

Action Response

This endpoint creates a new auto moderation rule for a specific discord guild. it allows server administrators to set up automated content moderation based on various triggers and actions. the rule can be configured to respond to different types of events, such as message sending or member updates, and can perform actions like blocking messages, flagging content, or temporarily disabling user communication. this tool is essential for maintaining a safe and controlled environment within a discord server by automatically enforcing community guidelines and moderating user-generated content.

Action Parameters

Action Response

Deletes a specific message from a discord channel. this endpoint should be used when you need to remove a particular message, either for moderation purposes or to clean up outdated information. it’s important to note that this action is irreversible, and once a message is deleted, it cannot be recovered. the endpoint requires both the channel id and the message id to accurately target the specific message for deletion. use this endpoint with caution, as it permanently removes content from the conversation history.

Action Parameters

Action Response

Creates a new webhook for a specified discord channel. this endpoint allows you to set up an automated way to send messages to a discord channel from external applications or services. the webhook can be customized with a name and an optional avatar. use this endpoint when you need to integrate external services with discord or automate message posting to a specific channel. the created webhook will provide a unique url that can be used to send messages to the channel without requiring a bot token. note that webhook creation is subject to discord’s rate limits and server permissions, so ensure you have the necessary rights to create webhooks in the specified channel.

Action Parameters

Action Response

Removes a specific emoji reaction from a message in a discord channel. this endpoint allows for precise control over message reactions, enabling the deletion of a particular emoji reaction associated with a specific message. it should be used when you need to programmatically remove reactions, such as for moderation purposes or managing bot-added reactions. the endpoint is particularly useful for cleaning up reactions or removing inappropriate content. note that this operation is irreversible, and you must have the necessary permissions in the discord server to remove reactions.

Action Parameters

Action Response

Creates a new guild template for the specified discord guild. this endpoint allows users to create a snapshot of the current guild’s settings, roles, and channels, which can be used as a blueprint for creating new guilds quickly. the template includes the guild’s structure but not its content. use this when you want to save the current guild configuration for future use or to share with others for easy replication of your guild setup. the created template can be accessed and managed using other template-related endpoints.

Action Parameters

Action Response

Retrieves detailed information about a specific sticker within a discord guild (server). this endpoint is used to fetch the properties and metadata of a single sticker, such as its name, description, format type, and associated emoji. it’s particularly useful for applications that need to display or manage custom stickers within a guild. the endpoint should be used when you need comprehensive information about a specific sticker, rather than a list of all stickers in a guild. note that this endpoint likely requires appropriate permissions to access the guild and its sticker data.

Action Parameters

Action Response

Initiates a prune operation to remove inactive members from a discord guild. this endpoint allows server administrators to automatically remove members who have not been active for a specified number of days. the prune can be customized to target specific roles and can optionally calculate the number of affected members before execution. use this endpoint to maintain an active community by removing dormant accounts. exercise caution, as this action permanently removes members from the guild. it’s recommended to use the compute prune count option first to assess the impact before performing the actual prune.

Action Parameters

Action Response

Retrieves the role connection information for the authenticated user in relation to a specific discord application. this endpoint allows developers to fetch details about how a user’s discord account is linked to roles within the application, which is crucial for managing permissions and access control. it should be used when an application needs to verify or update a user’s role connections, such as during authentication processes or when syncing external service permissions with discord roles. the endpoint provides only the role connection data for the specified application and does not return general user information or role connections for other applications.

Action Parameters

Action Response

Retrieves the websocket url and additional metadata required for a bot to connect to discord’s gateway. this endpoint is essential for bot developers who need to establish a real-time connection to receive events and updates from discord. it provides the necessary information to initiate a websocket connection, including the gateway url and recommendations for sharding. use this endpoint before connecting your bot to the gateway to ensure you have the most up-to-date connection information. note that this endpoint is specifically for bots and should not be used for user accounts or other types of integrations.

Action Parameters

Action Response

This endpoint allows you to create and send a new message in a specified discord channel. it supports various content types including plain text, rich embeds, interactive components, stickers, and file attachments. the message can be customized with allowed mentions, flags, and text-to-speech options. it’s primarily used for sending messages programmatically, such as bot responses or automated notifications. the endpoint is versatile, allowing for simple text messages or complex, interactive content with multiple embeds and components. however, it’s important to note the various limitations on content length, number of embeds, and attachments to ensure the message adheres to discord’s guidelines.

Action Parameters

Action Response

Retrieves information about a specific user’s membership in a thread within a discord channel. this endpoint allows you to fetch details such as the user’s thread permissions, join timestamp, and other relevant information. use this when you need to check a user’s status or rights within a particular thread. it’s particularly useful for moderation purposes or when implementing thread-specific features in your application. the endpoint does not modify any data and only provides read-only access to thread member information.

Action Parameters

Action Response

Retrieves a specific message that was previously sent through a discord webhook. this endpoint allows developers to fetch the content and metadata of a single message using its unique identifier. it’s particularly useful for verifying message delivery, auditing webhook activity, or retrieving specific information from past webhook interactions. the endpoint requires the webhook’s id and token for authentication, ensuring that only authorized parties can access the message data. use this when you need to confirm the content of a sent message or when you want to review or process specific webhook messages programmatically.

Action Parameters

Action Response

Retrieves the role connection metadata for a specific discord application. this endpoint is used to fetch information about how the application integrates with discord’s role system, including any custom requirements or verifications set up for role assignments. it’s particularly useful for developers managing applications that utilize discord’s linked roles feature. the retrieved metadata can include details about the conditions users must meet to be granted certain roles within discord servers where the application is integrated. this endpoint should be used when setting up or managing role connections for a discord application, or when needing to verify the current role connection configuration. it does not modify any data and is intended for read-only operations.

Action Parameters

Action Response

Retrieves detailed information about a specific discord guild template using its unique code. this endpoint allows developers to fetch the pre-configured settings, name, and description of a guild template, which can be used to quickly create new guilds with predefined structures. it’s particularly useful when you need to review or validate a template’s contents before creating a guild based on it. the endpoint returns comprehensive data about the template but does not create or modify any guilds. use this when you need to display template information to users or verify template details programmatically.

Action Parameters

Action Response

Retrieves detailed information about the current authenticated application. this endpoint allows developers to access various attributes and settings of their discord application or bot. it’s particularly useful for self-inspection, verifying application details, or dynamically adjusting application behavior based on its current configuration. the endpoint returns comprehensive data about the application, which may include its name, description, icon, bot user information, and other relevant metadata. while specific return fields are not detailed in the schema, developers can expect a rich set of application-related information. this endpoint should be used when an application needs to introspect its own properties or verify its current state within the discord ecosystem.(DEPRECATED use get_my_application)

Action Parameters

Action Response

Retrieves a list of currently active threads within a specified discord guild. this endpoint is useful for obtaining an up-to-date view of ongoing discussions and conversations in a server. it should be used when you need to display or manage active threads, such as for moderation purposes or to provide users with a list of current conversations they can join. the endpoint only returns threads that are currently active and visible to guild members; it does not include archived or hidden threads. this tool is particularly helpful for applications that need to monitor or interact with real-time guild activity.

Action Parameters

Action Response

Removes the current authenticated user from a specified thread in discord. this endpoint allows a user to leave a thread they are currently a member of, effectively unsubscribing them from further notifications and removing their ability to view or participate in the thread if it’s private. it should be used when a user no longer wishes to be part of a specific thread conversation. this action is irreversible, but the user can rejoin the thread later if it’s public or if they’re re-added by a thread member with appropriate permissions. the endpoint doesn’t provide any information about the thread or other members; it simply performs the leave action.

Action Parameters

Action Response

Retrieves detailed information about a specific discord webhook using its unique identifier. this endpoint allows developers to fetch the current configuration and status of a webhook, including its name, channel association, and other relevant details. it’s particularly useful for verifying webhook settings, troubleshooting integration issues, or gathering data for webhook management tasks. the endpoint provides a snapshot of the webhook’s properties at the time of the request, but does not include historical data or usage statistics. use this when you need to confirm a webhook’s existence, check its current setup, or gather information for updating webhook configurations.

Action Parameters

Action Response

Crossposts a message to all channels that have been set up to receive announcements from the source channel. this endpoint allows you to publish a message from an announcement channel to its followers, effectively distributing the content to multiple channels simultaneously. it should be used when you want to broadcast important information, updates, or announcements to a wider audience across different servers or channels. this operation is typically restricted to messages in announcement channels and requires appropriate permissions. note that a message can only be crossposted once, and attempting to crosspost an already crossposted message will result in an error.

Action Parameters

Action Response

Retrieves a list of scheduled events for a specific discord guild (server). this endpoint allows developers to fetch information about upcoming or ongoing events within a server, which can include activities like voice channel meetings, external events, or any other scheduled community gatherings. it’s particularly useful for applications that need to display or manage server events, create event reminders, or analyze community engagement. the endpoint returns details such as event names, descriptions, start times, and other relevant information. it should be used when you need to present users with an overview of a guild’s planned activities or integrate event management features into your discord-related application. note that this endpoint only provides information about events that have been scheduled through discord’s event system and may not include informal or externally managed events.

Action Parameters

Action Response

Retrieves a list of all active invites for a specific discord channel. this endpoint allows developers to gather information about existing invites, including details such as the invite code, creator, expiration time, and usage statistics. it’s particularly useful for managing channel access, tracking invite usage, or implementing invite-based features within a discord bot or application. the endpoint returns invite objects for the specified channel, providing a comprehensive view of how users can join the channel. note that this endpoint only returns information about existing invites and does not create new invites or modify existing ones.

Action Parameters

Action Response

Creates a new thread within a specified discord channel. this endpoint allows for the creation of various thread types (public, private, or announcement) with customizable settings such as auto-archive duration, rate limits, and initial messages. it’s particularly useful for organizing discussions, creating focused conversation spaces, or starting new topics within a channel. the thread can be initialized with a rich message including embeds, components, and attachments. use this endpoint when you need to programmatically create new discussion threads or topic-specific conversations in a discord server.

Action Parameters

Action Response

Retrieves detailed information about a specific discord webhook. this endpoint allows you to fetch the current state and configuration of a webhook, including its name, avatar, channel id, and guild id. use this when you need to verify a webhook’s settings or before making changes to ensure you have the most up-to-date information. the endpoint requires both the webhook’s unique id and its associated token for authentication. it’s important to note that this endpoint only provides information about the webhook itself and does not return any message history or usage statistics.

Action Parameters

Action Response

Adds a recipient (user) to a discord channel, specifically designed for managing group direct messages (dms). this endpoint allows you to include a new user in an existing group dm or potentially add a user to other types of channels. it requires the channel id and user id to be specified in the path, with optional parameters for user authentication and nickname customization. use this endpoint when you need to programmatically add users to group conversations or channels in discord applications.

Action Parameters

Action Response

Removes a specific role from a guild member in discord. this endpoint is used to modify a user’s roles within a server, specifically by removing a designated role. it’s particularly useful for managing permissions and access levels within a guild. the operation is performed by specifying the guild id, user id, and role id in the url path. this tool should be used when you need to revoke certain privileges or change a member’s status within a guild. it’s important to note that this action is immediate and irreversible through this call alone - to undo it, you would need to add the role back using a separate api call. the endpoint doesn’t return the updated member object, so if you need to confirm the new role configuration, you’ll need to fetch the member’s details separately after this operation.

Action Parameters

Action Response

Retrieves all auto moderation rules configured for a specific discord guild (server). this endpoint allows developers to fetch the current set of automated content moderation rules that have been set up to maintain community standards within the specified guild. it should be used when you need to review, audit, or display the existing auto moderation configuration for a server. the endpoint returns information about various rule types, such as keyword filters, spam detection, and mention limits, along with their associated actions and exemptions. it does not modify any existing rules or create new ones; it is purely for retrieving current rule configurations.

Action Parameters

Action Response

Retrieves detailed information about a specific auto-moderation rule within a discord guild. this endpoint allows developers to fetch the configuration and settings of an individual rule, including its trigger type, actions, exempt roles and channels, and enabled status. it should be used when you need to review or audit the settings of a particular auto-moderation rule. the endpoint is particularly useful for debugging rule behavior, verifying rule settings, or displaying rule details in a management interface. note that this endpoint only retrieves information and does not modify the rule in any way.

Action Parameters

Action Response

This endpoint allows you to add a new member to a discord guild (server) or update an existing member’s information. it provides functionality to set or modify a member’s nickname, role assignments, voice channel status (mute/deaf), and other flags within the guild. this tool should be used when you need to programmatically add users to a guild or update their guild-specific properties. it’s particularly useful for automating member management tasks or integrating discord guild operations into external applications. note that this endpoint requires proper authorization and an oauth2 access token for the user being added or modified. be aware that some changes, like role assignments, may have significant impacts on the member’s permissions within the guild.

Action Parameters

Action Response

Creates a new stage instance in a discord server. this endpoint allows you to set up a stage for live audio conversations or presentations within a specified channel. use this when you want to initiate a structured audio event, such as a q&a session, panel discussion, or live performance. the stage instance can be customized with a topic, privacy settings, and optional association with a scheduled event. it’s particularly useful for managing large-scale audio events in discord communities. note that this endpoint requires appropriate permissions in the server where the stage instance is being created.

Action Parameters

Action Response

Retrieves detailed information about a discord invite using its unique invite code. this endpoint allows developers to fetch data about an invite, including the associated guild (server), channel, and potentially additional details such as approximate member counts, online member counts, and expiration date. it’s particularly useful when you need to validate an invite or display information about it before a user decides to join a server. the endpoint does not actually join the user to the server; it only provides information about the invite. keep in mind that some invite details may be limited based on the permissions of the requesting user or bot.

Action Parameters

Action Response

Deletes an existing stage instance associated with a specific channel in a discord server. this endpoint is used to end and remove a live stage, effectively concluding the audio event or activity. it should be called when you want to terminate a stage instance, such as when an event has concluded or needs to be canceled. the deletion is permanent and cannot be undone, so use this endpoint with caution. this tool is particularly useful for automating the lifecycle management of stage events in discord servers.

Action Parameters

Action Response

Retrieves a list of emoji objects for the specified guild (server) in discord. this endpoint allows developers to access all custom emojis that have been uploaded to a particular guild. it’s useful for applications that need to display or manage guild-specific emojis, such as emoji pickers or moderation tools. the endpoint returns both static and animated emojis associated with the guild. note that this endpoint only provides information about custom emojis and does not include standard unicode emojis or those from discord nitro.

Action Parameters

Action Response

Adds a reaction to a specific message in a discord channel. this endpoint allows users or bots to add an emoji reaction to a particular message, identified by its channel and message ids. it’s commonly used to provide quick feedback, show agreement, or participate in polls within discord conversations. the reaction is added on behalf of the authenticated user or bot (indicated by ‘@me’ in the endpoint). this tool should be used when you want to programmatically add reactions to messages, such as for automated responses or interactive bot features. it’s important to note that this endpoint only adds the reaction and does not provide any information about existing reactions on the message.

Action Parameters

Action Response

Adds a follower to a specific discord channel. this endpoint allows you to create a follower relationship between two channels, enabling content from one channel to be automatically shared with another. it’s particularly useful for content creators or community managers who want to distribute updates across multiple channels or servers. the follower relationship is established using webhooks, which allows for real-time notifications and content sharing. this endpoint should be used when you want to expand the reach of a channel’s content or create a network of interconnected channels. it’s important to note that both channels must be within servers where the authenticated user has appropriate permissions. the endpoint doesn’t provide information about existing followers or allow for bulk following operations.

Action Parameters

Action Response

Retrieves the authenticated user’s profile information using discord’s oauth2 system. this endpoint returns essential details about the user, such as their identity, associated guilds, and potentially other account-related information. it should be used when an application needs to access the current user’s data after successful oauth2 authentication. the endpoint is particularly useful for personalization, user management, and integration of discord user data into third-party applications. note that the specific data returned may depend on the oauth2 scopes granted during the authentication process.

Action Parameters

Action Response

Retrieves a list of archived public threads from a specified discord channel. this endpoint is used to access threads that are no longer active but remain viewable for reference purposes. it’s particularly useful for reviewing past discussions or retrieving information from older, inactive threads. the endpoint only returns public threads, which are visible to all members with access to the parent channel. it does not provide access to archived private threads or active threads. use this endpoint when you need to browse or search through historical public discussions within a specific channel.

Action Parameters

Action Response

Edits a previously sent webhook message. this endpoint allows you to update various aspects of an existing message, including its content, embeds, components, and attachments. it’s particularly useful for updating dynamic content or interactive elements in a discord channel without sending a new message. the endpoint supports partial updates, meaning you only need to include the fields you want to modify. unchanged fields will retain their current values. note that this endpoint can only edit messages originally sent by the same webhook, and it cannot be used to edit messages sent by users or bots.

Action Parameters

Action Response

Retrieves detailed information about the currently authenticated user on discord. this endpoint should be used when an application needs to access the profile data of the user who has authorized the application. it returns comprehensive user information, including username, discriminator, avatar, email (if authorized), and other relevant account details. this endpoint is essential for personalizing user experiences within discord applications and should be called when initializing a user session or when up-to-date user information is required. note that the endpoint does not provide information about the user’s guilds or relationships; separate endpoints exist for those purposes.

Action Parameters

Action Response

Deletes a specific message that was previously sent through a discord webhook. this endpoint allows for the removal of individual messages from a channel, providing control over content posted via webhooks. it should be used when you need to remove or retract a message sent by your application through a webhook, such as correcting mistakes or removing outdated information. the operation is permanent and cannot be undone, so use it cautiously. note that this endpoint can only delete messages sent by the webhook itself, not messages from other users or bots.

Action Parameters

Action Response

Creates a new invite for a specific discord channel. this endpoint allows you to generate customizable invite links that can be used to add new members to a server through the specified channel. the invite can be configured with various parameters to control its behavior, such as expiration time, usage limits, and special targets like streams or embedded applications. use this endpoint when you need to programmatically create invites for automated user onboarding, event management, or integration with external systems. note that some parameters may require elevated permissions, and the effectiveness of certain options (like temporary membership) depends on the server’s settings and the invitee’s roles.

Action Parameters

Action Response

Updates or creates a permission overwrite for a specific role or member in a discord channel. this endpoint allows for fine-grained control over channel-specific permissions, enabling customization of access and actions within a discord server. it should be used when modifying existing permission overwrites or creating new ones for roles or members in a channel. the endpoint accepts bitwise permission values for allowing and denying specific actions, providing granular control over user capabilities. it’s important to note that this operation will overwrite any existing permissions for the specified role or member in the channel, so care should be taken to include all desired permissions in the request.

Action Parameters

Action Response

The bulkbanusers endpoint allows server administrators to ban multiple users from a discord guild (server) simultaneously. this powerful moderation tool is designed for efficiently managing large-scale infractions or cleaning up a server from unwanted users. it can ban up to 200 users in a single request and optionally delete their recent messages. this endpoint should be used when there’s a need to remove multiple problematic users quickly, such as during a raid or when cleaning up after a spam attack. it’s important to note that this action is irreversible and should be used with caution. the endpoint doesn’t provide information about the success of individual bans within the bulk request.

Action Parameters

Action Response

Creates a new direct message channel or retrieves an existing one between the authenticated user and specified recipient(s). this endpoint is used to initiate private conversations or group chats on discord. it supports creating one-on-one dms by providing a single recipient id, or group dms by using access tokens for multiple recipients. the endpoint also allows setting custom nicknames for users in the channel. use this when a user wants to start a new conversation or access an existing dm channel. note that this endpoint doesn’t send a message; it only creates or retrieves the channel object.

Action Parameters

Action Response

This endpoint allows you to modify an existing custom emoji in a discord guild (server). it can be used to update the emoji’s name or adjust which roles have permission to use it. the endpoint is particularly useful for managing emoji access control or rebranding existing emojis without creating new ones. it’s important to note that this endpoint only modifies existing emojis and cannot be used to create new ones or delete existing emojis. the changes applied through this endpoint are immediate and affect all future uses of the emoji within the guild.

Action Parameters

Action Response

Retrieves detailed information about a specific member within a discord guild. this endpoint allows developers to fetch comprehensive data about a user’s membership in a particular server, including their roles, permissions, nickname, and join date. it’s particularly useful for bot developers and applications that need to manage guild members or make decisions based on a member’s status and attributes. the endpoint should be used when detailed, up-to-date information about a specific guild member is required. it will not provide information about the user’s activities in other guilds or their global discord account details. keep in mind that the bot or application must have the necessary permissions within the guild to access this information.

Action Parameters

Action Response

Retrieves the oauth2 public keys used for verifying access tokens issued by discord. this endpoint is crucial for implementing secure token validation in applications that integrate with discord’s oauth2 authentication system. it should be used when setting up or updating an application’s authentication process to ensure proper verification of discord-issued tokens. the endpoint returns a set of public keys in json web key (jwk) format, which can be used to verify the signatures of discord’s json web tokens (jwts). note that the keys may be rotated periodically, so applications should be prepared to handle multiple keys and update their key cache as needed.(DEPRECATED use get_public_keys)

Action Parameters

Action Response

Retrieves the original message sent through a specific discord webhook. this endpoint is used to fetch the initial content and metadata of a message that was posted to a discord channel via a webhook. it’s particularly useful for verifying the content of automated messages or for auditing purposes. the endpoint only returns data for the original message and cannot be used to retrieve subsequent edits or responses. use this when you need to review or confirm the exact content of a webhook-sent message in its original form.

Action Parameters

Action Response

Deletes a specific command from a discord application. this endpoint is used to permanently remove a command that is no longer needed or has become obsolete. it’s particularly useful for maintaining a clean and relevant set of commands for your discord bot or application. the deletion is irreversible, so use this endpoint with caution. it should be called when you want to completely remove a command’s functionality from your application, such as during updates or when phasing out features. this operation does not affect other commands or the application’s overall functionality.

Action Parameters

Action Response

This endpoint allows you to pin a specific message in a discord channel. pinning a message keeps it at the top of the channel, making it easily accessible to all users. this is useful for highlighting important information, announcements, or frequently referenced content within a channel. the endpoint requires the channel id and message id to identify the exact message to be pinned. it’s important to note that there is a limit to the number of pinned messages per channel, typically set to 50. if this limit is reached, you may need to unpin an existing message before pinning a new one. this endpoint should be used when you want to emphasize a particular message for long-term visibility in a channel.

Action Parameters

Action Response

Retrieves a list of all channels within a specified discord guild (server). this endpoint allows developers to fetch comprehensive information about the structure and organization of a guild’s communication channels. it should be used when an application needs to display, analyze, or manage the channel layout of a particular guild. the endpoint returns details for all channel types, including text, voice, and category channels, providing a complete overview of the guild’s communication setup. note that this endpoint does not return the content of the channels, only their structural information. the user must have the necessary permissions to view the channels in the specified guild.

Action Parameters

Action Response

Removes a ban for a user from a specific guild (server) in discord. this endpoint is used to lift an existing ban, allowing the user to rejoin the guild if they choose. it’s typically used by guild administrators or moderators as part of the moderation process, such as when a banned user’s punishment period has ended or if the ban was placed in error. the endpoint requires only the guild id and the user id, making it a straightforward operation for unbanning. note that this action only removes the ban; it does not automatically add the user back to the guild or restore their previous roles and permissions.

Action Parameters

Action Response

Retrieves the widget information for a specified discord guild (server). this endpoint allows developers to fetch the current widget settings and data associated with a particular guild, which can be used to display guild information on external websites or applications. the widget typically includes details such as the guild’s name, icon, member count, and available voice channels. use this endpoint when you need to access or display a guild’s public information without requiring full access to the guild’s data. it’s particularly useful for creating embeddable widgets or for applications that need to showcase basic guild information. note that this endpoint only returns data if the guild has the widget feature enabled in its settings.

Action Parameters

Action Response

Retrieves detailed information about a specific discord channel using its unique identifier. this endpoint allows developers to fetch various properties of a channel, such as its name, type (text, voice, or video), associated permissions, and other relevant metadata. it should be used when an application needs to display or work with up-to-date channel information. the endpoint is particularly useful for bots and applications that need to dynamically interact with or manage discord channels. note that this endpoint only provides channel details and does not return message content or member lists directly.

Action Parameters

Action Response

Updates an existing guild template for a specified discord server (guild). this endpoint allows you to modify the pre-configured settings of a template, which may include roles, channels, and permissions. use this when you need to change the structure or settings of an existing template to better suit your guild’s needs. it’s particularly useful for server administrators who want to refine their guild templates over time based on community feedback or changing requirements. note that this endpoint only updates the template; it does not create a new guild from the template or apply the changes to existing guilds.

Action Parameters

Action Response

Retrieves detailed information about a specific command associated with a discord application. this endpoint allows developers to fetch the current configuration and properties of an existing command, such as its name, description, options, and permissions. it’s particularly useful when you need to verify the current state of a command or gather information for updating or managing application commands. the endpoint should be used when you need to inspect or troubleshoot a specific command within your discord application. it does not create, modify, or delete commands; it only provides read-only access to command data.

Action Parameters

Action Response

Retrieves a list of members participating in a thread within a specific discord channel. this endpoint is used to fetch information about users who have joined or been added to a thread, providing insights into thread participation and activity. it’s particularly useful for moderators or bots that need to monitor thread engagement or perform actions based on thread membership. the endpoint returns details about thread members, which may include their user ids, join timestamps, and other relevant information. use this endpoint when you need to track thread participation or gather data about user involvement in specific discussions within a discord server.

Action Parameters

Action Response

Deletes a specific discord webhook using its unique identifier. this endpoint permanently removes the webhook, terminating any integrations or automated messages associated with it. use this when you want to discontinue a webhook’s functionality or clean up unused webhooks. it’s important to note that this action is irreversible, and once deleted, the webhook cannot be recovered. this endpoint should be used cautiously, ensuring that the webhook is no longer needed before deletion.

Action Parameters

Action Response

Deletes a guild (server) from discord permanently. this endpoint should be used with extreme caution as it will remove all data associated with the guild, including channels, roles, and messages. it is an irreversible action that can only be performed by the guild owner. this operation is typically used when a community needs to be completely shut down or when cleaning up test servers. it should not be used for temporary removals or as a moderation tool. be aware that this action cannot be undone, and all guild data will be lost upon deletion.

Action Parameters

Action Response

The bulkdeletemessages endpoint allows for the deletion of multiple messages simultaneously within a specified discord channel. this endpoint is particularly useful for cleaning up large amounts of messages efficiently, such as during moderation tasks or channel maintenance. it should be used when you need to remove multiple messages at once, saving time compared to deleting messages individually. the endpoint requires a minimum of 2 and a maximum of 100 unique message ids to be provided. it’s important to note that this operation may not be immediate, and the api will return a successful response even if the deletion is still in progress. be cautious when using this endpoint, as deleted messages cannot be recovered. this bulk delete function is limited to messages that are less than two weeks old. for deleting older messages, you’ll need to use individual delete requests for each message.

Action Parameters

Action Response

Modifies an existing discord channel by updating its properties. this endpoint allows you to change various aspects of a channel, such as its name, type, permissions, and settings. it can be used to customize channels for different purposes, manage channel organization, or adjust channel-specific features. the endpoint is flexible, allowing partial updates by only specifying the properties you want to change. it supports modifications for different channel types, including text channels, voice channels, categories, and forum channels. when using this endpoint, be cautious about changing critical properties like channel type or permissions, as it may affect user access and channel functionality. note that some properties are only applicable to specific channel types, and attempting to set incompatible properties may result in errors.

Action Parameters

Action Response

Retrieves the vanity url information for a specified discord guild (server). this endpoint allows you to fetch details about a guild’s custom invite link, including the vanity url code and the number of times it has been used. it’s particularly useful for server administrators or bots that need to monitor or manage the guild’s invitation system. the endpoint should be used when you need to check the current status of a guild’s vanity url or track its usage. note that not all guilds have vanity urls; this feature is typically available only for servers that meet certain criteria or have specific features enabled.

Action Parameters

Action Response

This endpoint bans a specified user from a discord guild (server) and optionally deletes their recent messages. it allows moderators to remove problematic users and clean up their content in one action. the ban is permanent until manually lifted. use this endpoint when you need to immediately remove a user’s access to a guild and optionally purge their recent message history. it’s particularly useful for handling severe rule violations or spam incidents. note that this action requires appropriate permissions and should be used judiciously as it significantly impacts the targeted user’s ability to interact with the guild.

Action Parameters

Action Response

Updates the welcome screen configuration for a specified discord guild. this endpoint allows server administrators to customize the welcome experience for new members by modifying the welcome screen’s description, enabling or disabling the feature, and configuring up to five welcome channels. each welcome channel can be customized with a description and an optional emoji. use this endpoint to create an engaging first impression for new guild members and guide them to important channels or information within the community.

Action Parameters

Action Response

Retrieves detailed information about the authenticated user’s membership in a specific discord guild (server). this endpoint allows developers to fetch member-specific data such as roles, nickname, join date, and other relevant information for the current user within the specified guild. it should be used when an application needs to access or display the user’s status and details within a particular discord server. this endpoint is particularly useful for applications that manage user interactions across multiple guilds or need to verify a user’s membership status. note that this endpoint only provides information for the authenticated user and cannot be used to fetch member details for other users.

Action Parameters

Action Response

This endpoint allows you to send messages to a discord channel using a slack-compatible webhook format. it supports simple text messages as well as rich content with attachments, custom usernames, and icons. use this endpoint when you want to integrate external services or applications with discord, leveraging the familiar slack webhook format. it’s particularly useful for sending notifications, updates, or formatted reports to a discord channel. the endpoint accepts various content types, including json, form-urlencoded, and multipart form data, providing flexibility in how you structure your requests. keep in mind the character limits for text fields and the maximum number of attachments to ensure your messages are delivered successfully.

Action Parameters

Action Response

Triggers a typing indicator in a specified discord channel, indicating that the bot or application is currently typing a message. this endpoint is used to simulate the typing status typically shown when a user is composing a message. it’s particularly useful for creating a more natural, human-like interaction in bot responses or when the bot is processing a lengthy operation before sending a message. the typing indicator typically lasts for 10 seconds or until a message is sent, whichever comes first. this endpoint should be used sparingly and in conjunction with actual message sending to avoid misleading users. note that repeatedly triggering this endpoint without sending a message may be considered api abuse.

Action Parameters

Action Response

Modifies an existing application command for a discord bot. this endpoint allows you to update various properties of a command, including its name, description, options, and permissions. use this when you need to change the behavior or appearance of an existing command without creating a new one. the endpoint requires the application id and command id to identify the specific command to be edited. you can update the command’s name, description, options (parameters), default member permissions, and dm availability. this is particularly useful for refining command functionality, fixing errors, or adapting to new features without disrupting the user experience. note that some properties, like the command type, cannot be changed after creation. always ensure that the updated command adheres to discord’s guidelines and doesn’t introduce breaking changes for existing users.

Action Parameters

Action Response

Deletes a specific integration from a discord guild. this endpoint is used to remove an external service or bot integration that has been previously added to the server. it should be used when an integration is no longer needed or causing issues within the guild. the deletion is permanent and cannot be undone, so it should be used with caution. this operation requires appropriate permissions within the guild to manage integrations.

Action Parameters

Action Response

Deletes the original message sent by a specific webhook in a discord channel. this endpoint is used to remove the initial content posted by a webhook, which can be useful for cleaning up outdated information or correcting errors in automated messages. it specifically targets the first message sent by the webhook, not any subsequent edits or additional messages. this operation is permanent and cannot be undone, so it should be used with caution. the endpoint requires both the webhook id and token for authentication and to precisely identify the message to be deleted.

Action Parameters

Action Response

This endpoint allows you to send a response to a discord interaction. it’s used to reply to various types of interactions, such as slash commands, message components, or modals. the response can be immediate or deferred, and can include messages, embeds, components, or modals. use this endpoint when you need to acknowledge an interaction or provide a response to user input. it’s particularly useful for creating interactive bot experiences, handling command inputs, or updating messages based on user actions. the endpoint is versatile, supporting different response types, but it’s important to match the response type with the interaction context. for example, you can’t respond with a modal to a message component interaction. also, note that some response types have time limits (e.g., initial responses must be sent within 3 seconds) and content restrictions (e.g., message length limits).

Action Parameters

Action Response

Retrieves the json representation of a discord guild’s widget. this endpoint allows developers to fetch publicly available information about a specific guild that can be embedded or displayed on external websites or applications. the widget typically includes details such as the guild’s name, member count, and possibly a list of online members or voice channels. this tool is useful for creating promotional materials for discord servers or integrating discord community information into third-party applications. it should be used when you need to display up-to-date information about a discord guild without requiring users to be logged in or have direct access to the server. note that the guild must have the widget feature enabled for this endpoint to return data, and the information provided is limited to what the guild administrators have chosen to make public.

Action Parameters

Action Response

Updates the role connection metadata for a discord user’s external platform integration with a specific application. this endpoint allows you to set or modify the platform name, username, and custom metadata associated with the integration. use this when you need to update the user’s role connection information after changes in their external platform status or to sync data between the platforms. it’s particularly useful for applications that manage user roles based on their activity or status on external platforms.

Action Parameters

Action Response

Retrieves all pinned messages from a specified discord channel. this endpoint is used to fetch important messages that have been pinned by users or moderators for easy reference. it’s particularly useful for accessing key information, announcements, or rules that are prominently displayed in a channel. the endpoint returns an array of message objects representing the pinned content, allowing developers to display or process these highlighted messages within their applications. use this endpoint when you need to access or display the most crucial information from a discord channel. note that the number of pinned messages is limited per channel, and this endpoint will only return currently pinned messages, not a historical record of previously pinned content.

Action Parameters

Action Response

Retrieves the websocket url required to connect to discord’s gateway. this endpoint is essential for applications that need real-time communication with discord, such as bots or interactive clients. the gateway allows clients to receive events and updates from discord without the need for constant polling. use this endpoint to obtain the websocket url before establishing a connection to receive real-time events like messages, presence updates, and other discord state changes. note that while this endpoint provides the connection url, actual websocket connection handling, including authentication and event processing, must be implemented separately.

Action Parameters

Action Response

Removes a member from a specified discord guild (server). this endpoint allows you to programmatically kick a user from a server, effectively ending their membership. it should be used when you need to remove a user from a guild, either for moderation purposes or as part of automated server management. this action is permanent and will require the user to be re-invited if they wish to rejoin the guild. note that this endpoint requires appropriate permissions to execute, typically reserved for guild administrators or bots with member management capabilities. the operation is immediate and cannot be undone through the api.

Action Parameters

Action Response

Deletes a specific channel from a discord server. this endpoint permanently removes the channel and all its associated content, including messages, pins, and any other data. it should be used with caution as the action is irreversible. this operation is typically performed for channel management, such as removing obsolete or unwanted channels from a server. the endpoint requires appropriate permissions to execute, and it’s crucial to verify the correct channel id before deletion to avoid unintended data loss. note that this action may affect server organization and user access to information previously contained in the deleted channel.

Action Parameters

Action Response

Retrieves the permissions configured for a specific application command within a discord guild. this endpoint allows developers to check which roles or users have permission to use a particular command in a given server. it’s useful for auditing command access, troubleshooting permission issues, or verifying that command restrictions are properly set up. the endpoint returns detailed permission information, which may include allowed and disallowed roles or users for the specified command. this tool should be used when you need to inspect or validate the current permission settings for a command in a specific guild context. it does not modify permissions; it only provides read access to the existing configuration.

Action Parameters

Action Response

Retrieves all commands registered for a specific discord application. this endpoint allows developers to fetch a list of all slash commands associated with their bot or application. it’s useful for managing, auditing, or displaying the available commands for an application. the endpoint returns an array of command objects, each containing details such as the command name, description, and options. use this when you need to review, update, or sync your application’s command list with discord’s servers. note that this endpoint only retrieves global commands and does not include guild-specific commands.

Action Parameters

Action Response

Updates the current user’s voice state in a specific discord guild. this endpoint allows for modifying various aspects of a user’s voice presence, including their speaking request status, audio suppression, and the voice channel they’re connected to. it’s particularly useful for managing user interactions in stage channels or for programmatically moving users between voice channels. the endpoint should be used when you need to programmatically adjust a user’s voice settings or location within a guild’s voice channels. it’s important to note that this endpoint only affects the current user (the bot or application making the request) and cannot be used to modify other users’ voice states. also, some parameters may have different effects depending on the type of voice channel (e.g., regular voice channel vs. stage channel).

Action Parameters

Action Response

Retrieves the onboarding information for a specific discord guild (server). this endpoint provides details about the guild’s onboarding process, including welcome screens, default channels, and other initial setup configurations. it’s particularly useful for understanding how new members are introduced to the guild and what information or options they’re presented with upon joining. this endpoint should be used when you need to review or analyze a guild’s current onboarding settings, potentially for improving user experience or troubleshooting issues with new member integration. note that this endpoint only retrieves information and does not allow modifications to the onboarding process.

Action Parameters

Action Response

Updates the settings of a discord application. this endpoint allows developers to modify various aspects of their application, including its description, visual elements, team association, interaction endpoints, and installation parameters. it’s particularly useful for maintaining and evolving an application’s presence and functionality within the discord ecosystem. the endpoint accepts partial updates, meaning you only need to include the fields you want to change. use this when you need to adjust your application’s configuration, update its appearance, or modify its interaction and installation settings. note that some changes may affect how users interact with or perceive your application, so use this endpoint judiciously. keep in mind that certain fields have specific format requirements or limitations, such as character limits for descriptions and url formats for endpoints.

Action Parameters

Action Response

This endpoint modifies an existing auto-moderation rule for a discord guild. it allows updating various aspects of the rule, including its name, event type, actions, and trigger settings. use it to fine-tune moderation strategies or adjust rule sensitivity. be cautious of potential impacts on user experience and ensure alignment with server policies. note that this endpoint requires the existing rule’s id.

Action Parameters

Action Response

Retrieves a list of available voice regions for discord servers. this endpoint provides information about the geographic locations where voice channels can be hosted, allowing server administrators to optimize voice quality and reduce latency for their users. use this endpoint when setting up new voice channels, troubleshooting voice connection issues, or planning server infrastructure. the returned data typically includes region identifiers, names, and potentially other relevant details for each available voice region. note that while this endpoint lists all possible regions, the actual availability might depend on the server’s location and discord’s current infrastructure.

Action Parameters

Action Response

Retrieves users interested in a specific scheduled event within a discord guild. useful for event organizers to track attendance and engagement. supports pagination and optional inclusion of guild member data. requires guild id and event id. may need permissions and be subject to rate limits.

Action Parameters

Action Response

Retrieves detailed information about a specific stage instance in a discord server. this endpoint allows you to fetch the current state and configuration of a stage instance associated with a particular channel. use this when you need to access up-to-date information about an ongoing stage event, such as its topic, privacy level, or discovery status. the endpoint is particularly useful for applications that need to monitor or manage stage events programmatically. note that this endpoint only provides information about existing stage instances and cannot be used to create, modify, or delete them.

Action Parameters

Action Response

Retrieves detailed information about a specific discord user based on their unique user id. this endpoint allows developers to access public user data, which may include the user’s username, avatar, account creation date, and other relevant information. it’s particularly useful for applications that need to display user profiles, manage user interactions, or integrate discord user data into their services. the endpoint should be used when specific user details are required, but it will not provide information about the user’s activities, messages, or server memberships. note that some user information may be limited based on privacy settings or if the user has restricted access to their profile.

Action Parameters

Action Response

Retrieves detailed information about a specific discord application. this endpoint allows developers to fetch comprehensive data about their application, including its name, description, icon, bot user details (if applicable), and other relevant settings. use this endpoint when you need to access or verify your application’s current configuration on the discord platform. it’s particularly useful for applications that need to dynamically adjust their behavior based on their current settings or for debugging purposes. note that this endpoint only provides read access to the application details and cannot be used to modify the application.

Action Parameters

Action Response

Creates a new scheduled event in a discord guild. this endpoint allows you to set up various types of events, including external events, stage instances, and voice events. the created event will be visible to guild members and can include details such as name, description, start and end times, and location (for external events). use this endpoint when you want to programmatically create and manage events for your discord community. the event’s visibility is limited to guild members only, and the structure of the request varies based on the type of event being created.

Action Parameters

Action Response

Retrieves a preview of a discord guild (server) based on its id. this endpoint allows users or bots to fetch basic information about a guild without being a member, such as the guild’s name, description, approximate member count, and icon. it’s particularly useful for discovering new guilds, making decisions about joining a guild, or for bots to gather information about guilds they’re not part of. the preview only includes public information and is subject to the guild having enabled the preview feature. this endpoint should not be used to fetch detailed or sensitive guild information, as it only provides a limited subset of guild data.

Action Parameters

Action Response

Removes a specific pinned message from a discord channel. this endpoint is used to unpin a previously pinned message, making it no longer appear in the channel’s pinned messages list. it’s particularly useful for managing important information in a channel by removing outdated or no longer relevant pinned content. the operation is irreversible, so use it cautiously. this tool should be used when you need to declutter pinned messages or remove sensitive information from the pinned section. it will not delete the message from the channel entirely, only remove its pinned status.

Action Parameters

Action Response

Retrieves the new member welcome screen settings for a specified discord guild (server). this endpoint allows developers to fetch the current configuration of the welcome screen that new members see when joining the guild. it provides information about the customized welcome message, any specific instructions or guidelines for new members, and potentially the enabled/disabled status of the welcome screen feature. use this endpoint when you need to view or check the existing welcome screen setup, such as before making modifications or for informational purposes. it does not modify the welcome screen settings; for that, you would need to use a separate update endpoint. the response likely includes details about the welcome message content, any customizable elements like suggested channels or roles, and possibly information about membership screening if it’s enabled for the guild.

Action Parameters

Action Response

Retrieves detailed information about the current oauth2 application authenticated with discord. this endpoint allows developers to access metadata and settings for their application, such as the app’s name, icon, description, and other relevant details. it’s particularly useful for applications that need to verify their own identity or fetch up-to-date configuration information. the endpoint should be used when an application needs to self-inspect or update its own information dynamically. note that this endpoint only provides information about the authenticated application and cannot be used to query details of other discord applications.(DEPRECATED use get_my_oauth2_application)

Action Parameters

Action Response

Retrieves a list of banned users for a specified discord guild (server). this endpoint allows server administrators or authorized bots to fetch information about all users who have been banned from the guild. it’s useful for reviewing moderation actions, auditing ban lists, or implementing custom moderation tools. the endpoint returns details about each banned user, likely including their user id, username, and the reason for the ban if provided. use this endpoint when you need to review or manage the ban list for a guild, but note that it requires appropriate permissions to access this sensitive information.

Action Parameters

Action Response

Deletes a specific discord webhook using its unique identifier and associated token. this endpoint permanently removes the webhook from the discord system, preventing any further messages from being sent through it. use this endpoint when you no longer need the webhook, such as when decommissioning integrations or cleaning up unused resources. once deleted, the webhook cannot be recovered, and any attempts to use the deleted webhook’s url will fail. this operation is irreversible, so ensure you have the correct webhook id and token before proceeding with the deletion.

Action Parameters

Action Response

The modifyguildmember endpoint allows you to update various attributes of a specific member within a discord guild (server). this powerful tool enables fine-grained control over a member’s settings, including their nickname, role assignments, voice channel status, and temporary communication restrictions. use this endpoint when you need to programmatically manage member properties, such as assigning roles, moving users between voice channels, or imposing time-outs. it’s particularly useful for moderation bots or applications that need to automate member management tasks. the endpoint requires the guild id and user id as path parameters, and accepts a json body with the attributes to be modified. note that this endpoint can only modify attributes that the authorized bot or application has permission to change, and some modifications may require specific permissions within the guild.

Action Parameters

Action Response

Retrieves detailed information about the currently authenticated user on discord. this endpoint should be used when an application needs to access the profile data of the user who has authorized the application. it returns comprehensive user information, including username, discriminator, avatar, email (if authorized), and other relevant account details. this endpoint is essential for personalizing user experiences within discord applications and should be called when initializing a user session or when up-to-date user information is required. note that the endpoint does not provide information about the user’s guilds or relationships; separate endpoints exist for those purposes.(DEPRECATED use get_my_user)

Action Parameters

Action Response

Deletes a specific permission overwrite for a discord channel. this endpoint is used to remove custom permissions that have been set for a particular user or role within a channel. it’s particularly useful when you want to reset a user’s or role’s permissions to the default channel or category permissions. the operation is irreversible, so it should be used with caution. this tool doesn’t return the deleted overwrite data; it simply removes the specified overwrite. it’s important to note that this action may immediately affect the target user’s or role’s ability to interact with the channel, depending on the overwrite that was removed.

Action Parameters

Action Response

Updates an existing discord webhook by modifying its name and/or avatar. this endpoint allows you to customize the appearance of a webhook without changing its functionality or destination. use this when you need to rebrand a webhook or update its visual representation within discord channels. the endpoint requires the webhook’s unique id and token for authentication and targeting. you can update the name, the avatar, or both in a single request. note that this operation only modifies the specified fields and does not affect other properties or the webhook’s configured destination.

Action Parameters

Action Response

Deletes all reactions from a specific message in a discord channel. this endpoint removes every emoji reaction that has been added to the message, effectively clearing its reaction list. it should be used when you want to remove all user interactions in the form of emoji reactions from a particular message. this action is useful for moderation purposes or when refreshing the state of a message. the endpoint requires ‘manage messages’ permission and affects all users’ reactions, not just the bot’s. it does not delete the message itself, only the associated reactions.

Action Parameters

Action Response

Deletes a specific guild template from a discord server. this endpoint is used to permanently remove a template that is no longer needed or has become outdated. it’s particularly useful for server administrators who want to manage their template inventory, ensuring only relevant and up-to-date templates are available. the deletion is irreversible, so it should be used with caution. this tool doesn’t provide any confirmation or return the deleted template’s details, it simply removes the specified template from the system.

Action Parameters

Action Response

Retrieves a list of guilds (servers) that the authenticated user is a member of on discord. this endpoint provides essential information about each guild, such as its id, name, and the user’s role within it. it’s particularly useful for applications that need to display or manage a user’s server list, or to check a user’s membership status across multiple servers. the endpoint returns only basic guild information and does not include detailed data like channel lists or member rosters. be aware that for users who are members of many guilds, the response may be paginated, and additional requests might be necessary to fetch the complete list.

Action Parameters

Action Response

Retrieves a list of all custom stickers for a specific discord guild (server). this endpoint allows developers to fetch detailed information about the stickers available in a particular guild, including their names, descriptions, tags, and image data. it’s useful for applications that need to display or manage guild-specific stickers, such as sticker browsers or management tools. the endpoint returns only the stickers created for the specified guild and does not include global discord stickers. use this when you need to list, display, or check the availability of custom stickers within a guild. note that this endpoint does not create, modify, or delete stickers; it’s purely for retrieval purposes.

Action Parameters

Action Response

Retrieves the oauth2 public keys used for verifying access tokens issued by discord. this endpoint is crucial for implementing secure token validation in applications that integrate with discord’s oauth2 authentication system. it should be used when setting up or updating an application’s authentication process to ensure proper verification of discord-issued tokens. the endpoint returns a set of public keys in json web key (jwk) format, which can be used to verify the signatures of discord’s json web tokens (jwts). note that the keys may be rotated periodically, so applications should be prepared to handle multiple keys and update their key cache as needed.

Action Parameters

Action Response