From 8e82316651cae3b7a728d867d6cdb9bc9e429984 Mon Sep 17 00:00:00 2001 From: GeniusTimo Date: Sat, 19 Apr 2025 20:14:08 +0200 Subject: [PATCH 01/20] Updated several links Removed duplicate/trailing hash in URLs, duplicate parentheses and unnecessary backslashes --- docs/activities/development-guides.mdx | 2 +- .../2017-07-24-new-feature-audit-logs.md | 2 +- ...1-23-deprecation-accept-invite-endpoint.md | 2 +- .../2019-08-12-more-precise-rate-limits.md | 2 +- ...0-12-15-slash-commands-and-interactions.md | 2 +- ...21-05-26-buttons-and-message-components.md | 2 +- .../2021-06-30-select-menu-components.md | 2 +- ...on-custom-message-action-metadata-field.md | 2 +- ...m-app-subscriptions-available-in-the-us.md | 2 +- docs/developer-tools/community-resources.mdx | 2 +- docs/events/gateway-events.mdx | 4 +- docs/events/gateway.mdx | 2 +- docs/interactions/application-commands.mdx | 10 +-- docs/interactions/message-components.md | 4 +- .../interactions/receiving-and-responding.mdx | 18 +++--- .../application-role-connection-metadata.md | 2 +- docs/resources/auto-moderation.md | 2 +- docs/resources/guild-scheduled-event.mdx | 2 +- docs/resources/message.md | 12 ++-- docs/resources/user.md | 2 +- .../rich-presence/using-with-the-game-sdk.mdx | 2 +- docs/topics/oauth2.md | 62 +++++++++---------- docs/topics/opcodes-and-status-codes.md | 2 +- 23 files changed, 72 insertions(+), 72 deletions(-) diff --git a/docs/activities/development-guides.mdx b/docs/activities/development-guides.mdx index 9a378c06d6..bad8ad4d00 100644 --- a/docs/activities/development-guides.mdx +++ b/docs/activities/development-guides.mdx @@ -186,7 +186,7 @@ The flow for setting up your production application is very similar: 1. If not made yet, create a new application. 2. Enable Activities for your app. 3. Set up the application's [URL Mapping](/docs/activities/development-guides#url-mapping). The URL for your application's html should be set to the `/` route. -4. Follow the instructions for [Launching your Application from the Discord Client](/docs/activities/development-guides#launch-your-application-from-the-discord-client)). Application URL Override should not be enabled. +4. Follow the instructions for [Launching your Application from the Discord Client](/docs/activities/development-guides#launch-your-application-from-the-discord-client). Application URL Override should not be enabled. This application now uses the same configuration it will use once it is fully published ✨. ![application-test-mode-prod](images/activities/application-test-mode-prod.gif) diff --git a/docs/change-log/2017-07-24-new-feature-audit-logs.md b/docs/change-log/2017-07-24-new-feature-audit-logs.md index 20adb712b5..97ea39fb13 100644 --- a/docs/change-log/2017-07-24-new-feature-audit-logs.md +++ b/docs/change-log/2017-07-24-new-feature-audit-logs.md @@ -3,4 +3,4 @@ title: "New Feature: Audit Logs" date: "2017-07-24" --- -Audit logs are here! Well, they've been here all along, but now we've got [documentation](/docs/resources/audit-log#) about them. Check it out, but remember: with great power comes great responsibility. +Audit logs are here! Well, they've been here all along, but now we've got [documentation](/docs/resources/audit-log) about them. Check it out, but remember: with great power comes great responsibility. diff --git a/docs/change-log/2018-01-23-deprecation-accept-invite-endpoint.md b/docs/change-log/2018-01-23-deprecation-accept-invite-endpoint.md index bbe90eb48f..2a7a136698 100644 --- a/docs/change-log/2018-01-23-deprecation-accept-invite-endpoint.md +++ b/docs/change-log/2018-01-23-deprecation-accept-invite-endpoint.md @@ -3,4 +3,4 @@ title: "Deprecation: Accept Invite Endpoint" date: "2018-01-23" --- -The [Accept Invite](/docs/resources/invite#) endpoint is deprecated starting today, and will be discontinued on March 23, 2018. The [Add Guild Member](/docs/resources/guild#add-guild-member) endpoint should be used in its place. +The [Accept Invite](/docs/resources/invite) endpoint is deprecated starting today, and will be discontinued on March 23, 2018. The [Add Guild Member](/docs/resources/guild#add-guild-member) endpoint should be used in its place. diff --git a/docs/change-log/2019-08-12-more-precise-rate-limits.md b/docs/change-log/2019-08-12-more-precise-rate-limits.md index 84e96dd6f2..266c53cf19 100644 --- a/docs/change-log/2019-08-12-more-precise-rate-limits.md +++ b/docs/change-log/2019-08-12-more-precise-rate-limits.md @@ -3,4 +3,4 @@ title: "More Precise Rate Limits" date: "2019-08-12" --- -You can now get more precise rate limit reset times, via a new request header. Check out the [rate limits](/docs/topics/rate-limits#) documentation for more information. +You can now get more precise rate limit reset times, via a new request header. Check out the [rate limits](/docs/topics/rate-limits) documentation for more information. diff --git a/docs/change-log/2020-12-15-slash-commands-and-interactions.md b/docs/change-log/2020-12-15-slash-commands-and-interactions.md index 3c0dd62836..a04de4e9d7 100644 --- a/docs/change-log/2020-12-15-slash-commands-and-interactions.md +++ b/docs/change-log/2020-12-15-slash-commands-and-interactions.md @@ -3,7 +3,7 @@ title: "Slash Commands and Interactions" date: "2020-12-15" --- -Slash Commands are here! There's a *lot* to cover, so go check out specific documentation under [Slash Commands](/docs/interactions/application-commands#). +Slash Commands are here! There's a *lot* to cover, so go check out specific documentation under [Slash Commands](/docs/interactions/application-commands). Slash Commands include some new features for webhooks as well: diff --git a/docs/change-log/2021-05-26-buttons-and-message-components.md b/docs/change-log/2021-05-26-buttons-and-message-components.md index 108ad7ec88..32de1895a4 100644 --- a/docs/change-log/2021-05-26-buttons-and-message-components.md +++ b/docs/change-log/2021-05-26-buttons-and-message-components.md @@ -5,7 +5,7 @@ date: "2021-05-26" Message components are now available with our first two components: a layout-based `ActionRow` and...buttons! -You can now include buttons on messages sent by your app, whether they're bot messages or responses to interactions. [Learn more about message components](/docs/interactions/message-components#). +You can now include buttons on messages sent by your app, whether they're bot messages or responses to interactions. [Learn more about message components](/docs/interactions/message-components). The addition of message components means new fields and response types: diff --git a/docs/change-log/2021-06-30-select-menu-components.md b/docs/change-log/2021-06-30-select-menu-components.md index f5f035cacc..250dacfeae 100644 --- a/docs/change-log/2021-06-30-select-menu-components.md +++ b/docs/change-log/2021-06-30-select-menu-components.md @@ -5,4 +5,4 @@ date: "2021-06-30" Select Menus are now part of the components API! They're the greatest thing since the invention of buttons yesterday. Select menus allow you to offer users a choice of one or many options in a friendly UI-based way. -Select menus can be used like other [message components](/docs/interactions/message-components#). Learn all the specifics in the [documentation](/docs/interactions/message-components#select-menus). +Select menus can be used like other [message components](/docs/interactions/message-components). Learn all the specifics in the [documentation](/docs/interactions/message-components#select-menus). diff --git a/docs/change-log/2023-02-24-add-auto-moderation-custom-message-action-metadata-field.md b/docs/change-log/2023-02-24-add-auto-moderation-custom-message-action-metadata-field.md index 4aaf655a63..3aef9a6d87 100644 --- a/docs/change-log/2023-02-24-add-auto-moderation-custom-message-action-metadata-field.md +++ b/docs/change-log/2023-02-24-add-auto-moderation-custom-message-action-metadata-field.md @@ -3,4 +3,4 @@ title: "Add Auto Moderation custom_message Action Metadata Field" date: "2023-02-24" --- -Add new `custom_message` [action metadata](/docs/resources/auto-moderation#auto-moderation-action-object-action-metadata) for the `BLOCK_MESSAGE` [action type](/docs/resources/auto-moderation#auto-moderation-action-object-action-types)). You can now specify a custom string for every Auto Moderation rule that will be shown to members whenever the rule blocks their message. This can be used as an additional explanation for why a message was blocked and as a chance to help members understand your server's rules and guidelines. +Add new `custom_message` [action metadata](/docs/resources/auto-moderation#auto-moderation-action-object-action-metadata) for the `BLOCK_MESSAGE` [action type](/docs/resources/auto-moderation#auto-moderation-action-object-action-types). You can now specify a custom string for every Auto Moderation rule that will be shown to members whenever the rule blocks their message. This can be used as an additional explanation for why a message was blocked and as a chance to help members understand your server's rules and guidelines. diff --git a/docs/change-log/2023-09-26-premium-app-subscriptions-available-in-the-us.md b/docs/change-log/2023-09-26-premium-app-subscriptions-available-in-the-us.md index fa0aaaddfc..ac26f16d98 100644 --- a/docs/change-log/2023-09-26-premium-app-subscriptions-available-in-the-us.md +++ b/docs/change-log/2023-09-26-premium-app-subscriptions-available-in-the-us.md @@ -17,6 +17,6 @@ Starting today, eligible US-based developers can monetize their verified apps wi * [Delete Test Entitlement](/docs/resources/entitlement#delete-test-entitlement) `DELETE /applications//entitlements/` * [Gateway Events](/docs/events/gateway-events#entitlements) for working with entitlements: `ENTITLEMENT_CREATE`, `ENTITLEMENT_UPDATE`, `ENTITLEMENT_DELETE` * New [`PREMIUM_REQUIRED (10)` interaction response type](/docs/interactions/receiving-and-responding#interaction-response-object-interaction-callback-type) is available to prompt users to upgrade -* New `entitlements` field, which is an array of [entitlement](/docs/resources/entitlement#) objects, available in interaction data payloads when [receiving and responding to interactions](/docs/interactions/receiving-and-responding#interaction-object-interaction-structure) +* New `entitlements` field, which is an array of [entitlement](/docs/resources/entitlement) objects, available in interaction data payloads when [receiving and responding to interactions](/docs/interactions/receiving-and-responding#interaction-object-interaction-structure) To learn more about eligibility details and how to enable monetization for your app, check out the [Monetization Overview](/docs/monetization/overview). diff --git a/docs/developer-tools/community-resources.mdx b/docs/developer-tools/community-resources.mdx index 2160307f24..649cb16a32 100644 --- a/docs/developer-tools/community-resources.mdx +++ b/docs/developer-tools/community-resources.mdx @@ -37,7 +37,7 @@ Discord does not maintain official SDKs. The following table is an inexhaustive ## Interactions -[Interactions](/docs/interactions/receiving-and-responding#) are the great, new way of making a Discord bot. The following open-source libraries provide help for the security and authentication checks that are mandatory if you are receiving Interactions via outgoing webhook. They also include some types for the Interactions data models. +[Interactions](/docs/interactions/receiving-and-responding) are the great, new way of making a Discord bot. The following open-source libraries provide help for the security and authentication checks that are mandatory if you are receiving Interactions via outgoing webhook. They also include some types for the Interactions data models. - C# - [Discord.Net.Rest](https://github.com/discord-net/Discord.Net) diff --git a/docs/events/gateway-events.mdx b/docs/events/gateway-events.mdx index 1052eeb55a..3a613d010c 100644 --- a/docs/events/gateway-events.mdx +++ b/docs/events/gateway-events.mdx @@ -350,7 +350,7 @@ Receive events are Gateway events encapsulated in an [event payload](/docs/event | [Integration Create](/docs/events/gateway-events#integration-create) | Guild integration was created | | [Integration Update](/docs/events/gateway-events#integration-update) | Guild integration was updated | | [Integration Delete](/docs/events/gateway-events#integration-delete) | Guild integration was deleted | -| [Interaction Create](/docs/events/gateway-events#interaction-create) | User used an interaction, such as an [Application Command](/docs/interactions/application-commands#) | +| [Interaction Create](/docs/events/gateway-events#interaction-create) | User used an interaction, such as an [Application Command](/docs/interactions/application-commands) | | [Invite Create](/docs/events/gateway-events#invite-create) | Invite to a channel was created | | [Invite Delete](/docs/events/gateway-events#invite-delete) | Invite to a channel was deleted | | [Message Create](/docs/events/gateway-events#message-create) | Message was created | @@ -1364,7 +1364,7 @@ Sent when a guild channel's webhook is created, updated, or deleted. #### Interaction Create -Sent when a user uses an [Application Command](/docs/interactions/application-commands#) or [Message Component](/docs/interactions/message-components). Inner payload is an [Interaction](/docs/interactions/receiving-and-responding#interaction-object-interaction-structure). +Sent when a user uses an [Application Command](/docs/interactions/application-commands) or [Message Component](/docs/interactions/message-components). Inner payload is an [Interaction](/docs/interactions/receiving-and-responding#interaction-object-interaction-structure). ### Stage Instances diff --git a/docs/events/gateway.mdx b/docs/events/gateway.mdx index abe9c4794d..5abf08e629 100644 --- a/docs/events/gateway.mdx +++ b/docs/events/gateway.mdx @@ -52,7 +52,7 @@ Receiving a Gateway event from Discord (like when [a reaction is added to a mess While some events are sent to your app automatically, most events require your app to define intents when [Identifying](/docs/events/gateway#identifying). Intents are bitwise values that can be ORed (`|`) to indicate which events (or groups of events) you want Discord to send your app. A list of intents and their corresponding events are listed in the [intents section](/docs/events/gateway#gateway-intents). -When receiving events, you can also configure *how* events will be sent to your app, like the [encoding and compression](/docs/events/gateway#encoding-and-compression), or whether [sharding should be enabled](/docs/events/gateway#sharding)). +When receiving events, you can also configure *how* events will be sent to your app, like the [encoding and compression](/docs/events/gateway#encoding-and-compression), or whether [sharding should be enabled](/docs/events/gateway#sharding). All events that your app can receive via a connection are in the [Gateway event documentation](/docs/events/gateway-events#receive-events). diff --git a/docs/interactions/application-commands.mdx b/docs/interactions/application-commands.mdx index 5ed6de7678..b1bc43d376 100644 --- a/docs/interactions/application-commands.mdx +++ b/docs/interactions/application-commands.mdx @@ -117,7 +117,7 @@ Details about Entry Point command handler types are in the [Entry Point handlers ## Authorizing Your Application -Application commands do not depend on a bot user in the guild; they use the [interactions](/docs/interactions/receiving-and-responding#) model. To create commands in a guild, your app must be authorized with the `applications.commands` scope which can be used independently, but is also automatically included with the `bot` scope. +Application commands do not depend on a bot user in the guild; they use the [interactions](/docs/interactions/receiving-and-responding) model. To create commands in a guild, your app must be authorized with the `applications.commands` scope which can be used independently, but is also automatically included with the `bot` scope. When requesting this scope, we "shortcut" the OAuth2 flow similar to adding a bot. You don't need to complete the flow, exchange for a token, or any of that. @@ -293,9 +293,9 @@ Application command permissions allow your app to enable or disable commands for > warn > Command permissions can only be updated using a [Bearer token](/docs/topics/oauth2#client-credentials-grant). Authenticating with a bot token will result in an error. -A command's current permissions can be retrieved using the [`GET /applications/\{application.id}/guilds/\{guild.id}/commands/\{command.id}/permissions`](/docs/interactions/application-commands#get-application-command-permissions) endpoint. The response will include an array called `permissions` with associated IDs and permission types. +A command's current permissions can be retrieved using the [`GET /applications/{application.id}/guilds/{guild.id}/commands/{command.id}/permissions`](/docs/interactions/application-commands#get-application-command-permissions) endpoint. The response will include an array called `permissions` with associated IDs and permission types. -Command permissions can be updated with the [`PUT /applications/\{application.id}/guilds/\{guild.id}/commands/\{command.id}/permissions`](/docs/interactions/application-commands#edit-application-command-permissions) endpoint. To call the endpoint, apps must use a Bearer token that's authorized with the [`applications.commands.permissions.update`](/docs/topics/oauth2#shared-resources-oauth2-scopes) scope from a user with sufficient permissions. For their permissions to be considered sufficient, all of the following must be true for **the authenticating user** (not your app or bot user): +Command permissions can be updated with the [`PUT /applications/{application.id}/guilds/{guild.id}/commands/{command.id}/permissions`](/docs/interactions/application-commands#edit-application-command-permissions) endpoint. To call the endpoint, apps must use a Bearer token that's authorized with the [`applications.commands.permissions.update`](/docs/topics/oauth2#shared-resources-oauth2-scopes) scope from a user with sufficient permissions. For their permissions to be considered sufficient, all of the following must be true for **the authenticating user** (not your app or bot user): - Has [permission to Manage Guild and Manage Roles](/docs/topics/permissions) in the guild where the command is being edited - Has the ability to run the command being edited - Has permission to manage the resources that will be affected (roles, users, and/or channels depending on the [permission types](/docs/interactions/application-commands#application-command-permissions-object-application-command-permission-type)) @@ -997,12 +997,12 @@ For the Entry Point command to be visible to users, an app must have [Activities When a user invokes an app's Entry Point command, the value of [`handler`](/docs/interactions/application-commands#application-command-object-application-command-structure) will determine how the interaction is handled: -- For `APP_HANDLER` (`1`), the app is responsible for [responding to the interaction](/docs/interactions/receiving-and-responding#responding-to-an-interaction). It can respond by launching the app's associated Activity using the `LAUNCH_ACTIVITY` (type `12`) [interaction callback type](/docs/interactions/receiving-and-responding##interaction-response-object-interaction-callback-type), or take another action (like sending a follow-up message in channel). +- For `APP_HANDLER` (`1`), the app is responsible for [responding to the interaction](/docs/interactions/receiving-and-responding#responding-to-an-interaction). It can respond by launching the app's associated Activity using the `LAUNCH_ACTIVITY` (type `12`) [interaction callback type](/docs/interactions/receiving-and-responding#interaction-response-object-interaction-callback-type), or take another action (like sending a follow-up message in channel). - For `DISCORD_LAUNCH_ACTIVITY` (`2`), Discord will handle the interaction automatically by launching the associated Activity and sending a message to the channel where it was launched. ### Default Entry Point command -When you enable Activities, an Entry Point command (named "Launch") is automatically created for your app with `DISCORD_LAUNCH_ACTIVITY` (`2`) set as the [Entry Point handler](/docs/interactions/application-commands#entry-point-handlers). You can retrieve details for the automatically-created command, like its ID, by calling the [Get Global Application Commands](/docs/interactions/application-commands##get-global-application-commands) endpoint and looking for the "Launch" command. +When you enable Activities, an Entry Point command (named "Launch") is automatically created for your app with `DISCORD_LAUNCH_ACTIVITY` (`2`) set as the [Entry Point handler](/docs/interactions/application-commands#entry-point-handlers). You can retrieve details for the automatically-created command, like its ID, by calling the [Get Global Application Commands](/docs/interactions/application-commands#get-global-application-commands) endpoint and looking for the "Launch" command. Details about updating or replacing the default Entry Point command is in the [Setting Up an Entry Point Command guide](/docs/activities/development-guides#setting-up-an-entry-point-command). diff --git a/docs/interactions/message-components.md b/docs/interactions/message-components.md index 5eab856122..f514b84d16 100644 --- a/docs/interactions/message-components.md +++ b/docs/interactions/message-components.md @@ -6,7 +6,7 @@ There are several different types of components; this documentation will outline ## What is a Component -Components are a field on the [message object](/docs/resources/message#message-object), so you can use them whether you're sending messages or responding to a [slash command](/docs/interactions/application-commands#) or other interaction. +Components are a field on the [message object](/docs/resources/message#message-object), so you can use them whether you're sending messages or responding to a [slash command](/docs/interactions/application-commands) or other interaction. ### Component Object @@ -315,7 +315,7 @@ The payloads for the select menu components are detailed in the [select menu str |-----------------------|---------------------------------------------------------------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | type | integer | [Type](/docs/interactions/message-components#component-object-component-types) of select menu component (text: `3`, user: `5`, role: `6`, mentionable: `7`, channels: `8`) | | custom_id | string | ID for the select menu; max 100 characters | -| options?\* | array of [select options](/docs/interactions/message-components#select-menu-object-select-option-structure) | Specified choices in a select menu (only required and available for string selects (type `3`); max 25 | +| options?\* | array of [select options](/docs/interactions/message-components#select-menu-object-select-option-structure) | Specified choices in a select menu (only required and available for string selects (type `3`)); max 25 | | channel_types?\*\* | array of [channel types](/docs/resources/channel#channel-object-channel-types) | List of channel types to include in the channel select component (type `8`) | | placeholder? | string | Placeholder text if nothing is selected; max 150 characters | | default_values?\*\*\* | array of [default value objects](/docs/interactions/message-components#select-menu-object-select-default-value-structure) | List of default values for auto-populated select menu components; number of default values must be in the range defined by `min_values` and `max_values` | diff --git a/docs/interactions/receiving-and-responding.mdx b/docs/interactions/receiving-and-responding.mdx index 74ffea6a00..ce6f299f28 100644 --- a/docs/interactions/receiving-and-responding.mdx +++ b/docs/interactions/receiving-and-responding.mdx @@ -10,7 +10,7 @@ For [Slash Commands](/docs/interactions/application-commands#slash-commands), it For [User Commands](/docs/interactions/application-commands#user-commands) and [Message Commands](/docs/interactions/application-commands#message-commands), it includes the resolved user or message on which the action was taken. -For [Message Components](/docs/interactions/message-components#) it includes identifying information about the component that was used. It will also include some metadata about how the interaction was triggered: the `guild_id`, `channel`, `member` and other fields. You can find all the values in our data models below. +For [Message Components](/docs/interactions/message-components) it includes identifying information about the component that was used. It will also include some metadata about how the interaction was triggered: the `guild_id`, `channel`, `member` and other fields. You can find all the values in our data models below. ### Interaction Object @@ -159,7 +159,7 @@ All options have names, and an option can either be a parameter and input value- This is sent on the [message object](/docs/resources/message#message-object) when the message is a response to an Interaction without an existing message. > info -> This means responses to [Message Components](/docs/interactions/message-components#) do not include this property, instead including a [message reference](/docs/resources/message#message-reference-structure) object as components _always_ exist on preexisting messages. +> This means responses to [Message Components](/docs/interactions/message-components) do not include this property, instead including a [message reference](/docs/resources/message#message-reference-structure) object as components _always_ exist on preexisting messages. ###### Message Interaction Structure @@ -229,7 +229,7 @@ There are a number of ways you can respond to an interaction: | PREMIUM_REQUIRED | 10 | [**Deprecated**](/docs/change-log#premium-apps-new-premium-button-style-deep-linking-url-schemes); respond to an interaction with an upgrade button, only available for apps with [monetization](/docs/monetization/overview) enabled | | LAUNCH_ACTIVITY | 12 | Launch the Activity associated with the app. Only available for apps with [Activities](/docs/activities/overview) enabled | -\* Only valid for [component-based](/docs/interactions/message-components#) interactions +\* Only valid for [component-based](/docs/interactions/message-components) interactions \*\* Not available for `MODAL_SUBMIT` and `PING` interactions. @@ -247,7 +247,7 @@ Not all message fields are currently supported. | embeds? | array of [embeds](/docs/resources/message#embed-object) | Supports up to 10 embeds | | allowed_mentions? | [allowed mentions](/docs/resources/message#allowed-mentions-object) | [Allowed mentions](/docs/resources/message#allowed-mentions-object) object | | flags? \* | integer | [Message flags](/docs/resources/message#message-object-message-flags) combined as a [bitfield](https://en.wikipedia.org/wiki/Bit_field) (only `SUPPRESS_EMBEDS`, `EPHEMERAL`, and `SUPPRESS_NOTIFICATIONS` can be set) | -| components? | array of [components](/docs/interactions/message-components#) | Message components | +| components? | array of [components](/docs/interactions/message-components) | Message components | | attachments? \*\* | array of partial [attachment](/docs/resources/message#attachment-object) objects | Attachment objects with filename and description | | poll? | [poll](/docs/resources/poll#poll-create-request-object) request object | Details about the poll | @@ -266,11 +266,11 @@ Not all message fields are currently supported. > warn > Support for components in modals is currently limited to type 4 (Text Input). -| Field | Type | Description | -|------------|---------------------------------------------------------------|----------------------------------------------------------------| -| custom_id | string | Developer-defined identifier for the modal, max 100 characters | -| title | string | Title of the popup modal, max 45 characters | -| components | array of [components](/docs/interactions/message-components#) | Between 1 and 5 (inclusive) components that make up the modal | +| Field | Type | Description | +|------------|--------------------------------------------------------------|----------------------------------------------------------------| +| custom_id | string | Developer-defined identifier for the modal, max 100 characters | +| title | string | Title of the popup modal, max 45 characters | +| components | array of [components](/docs/interactions/message-components) | Between 1 and 5 (inclusive) components that make up the modal | > warn > If your application responds with user data, you should use [`allowed_mentions`](/docs/resources/message#allowed-mentions-object) to filter which mentions in the content actually ping. diff --git a/docs/resources/application-role-connection-metadata.md b/docs/resources/application-role-connection-metadata.md index 6d5b356b67..2c482fa488 100644 --- a/docs/resources/application-role-connection-metadata.md +++ b/docs/resources/application-role-connection-metadata.md @@ -1,6 +1,6 @@ # Application Role Connection Metadata -A representation of role connection metadata for an [application](/docs/resources/application#). +A representation of role connection metadata for an [application](/docs/resources/application). When a guild has added a bot and that bot has configured its [`role_connections_verification_url`](/docs/resources/application#application-object) (in the developer portal), the application will render as a potential verification method in the guild's role verification configuration. diff --git a/docs/resources/auto-moderation.md b/docs/resources/auto-moderation.md index 0436d6c9e1..90714af288 100644 --- a/docs/resources/auto-moderation.md +++ b/docs/resources/auto-moderation.md @@ -1,6 +1,6 @@ # Auto Moderation -Auto Moderation is a feature which allows each [guild](/docs/resources/guild#) to set up rules that trigger based on some criteria. For example, a rule can trigger whenever a message contains a specific keyword. +Auto Moderation is a feature which allows each [guild](/docs/resources/guild) to set up rules that trigger based on some criteria. For example, a rule can trigger whenever a message contains a specific keyword. Rules can be configured to automatically execute actions whenever they trigger. For example, if a user tries to send a message which contains a certain keyword, a rule can trigger and block the message before it is sent. diff --git a/docs/resources/guild-scheduled-event.mdx b/docs/resources/guild-scheduled-event.mdx index 82c6a5870c..6cc73f4f73 100644 --- a/docs/resources/guild-scheduled-event.mdx +++ b/docs/resources/guild-scheduled-event.mdx @@ -1,6 +1,6 @@ # Guild Scheduled Event -A representation of a scheduled event in a [guild](/docs/resources/guild#). +A representation of a scheduled event in a [guild](/docs/resources/guild). ### Guild Scheduled Event Object diff --git a/docs/resources/message.md b/docs/resources/message.md index d2472deec6..0944ceb0a3 100644 --- a/docs/resources/message.md +++ b/docs/resources/message.md @@ -38,13 +38,13 @@ Represents a message sent in a channel within Discord. | type | integer | [type of message](/docs/resources/message#message-object-message-types) | | activity? | [message activity](/docs/resources/message#message-object-message-activity-structure) object | sent with Rich Presence-related chat embeds | | application? | partial [application](/docs/resources/application#application-object) object | sent with Rich Presence-related chat embeds | -| application_id? | snowflake | if the message is an [Interaction](/docs/interactions/receiving-and-responding#) or application-owned webhook, this is the id of the application | +| application_id? | snowflake | if the message is an [Interaction](/docs/interactions/receiving-and-responding) or application-owned webhook, this is the id of the application | | flags? | integer | [message flags](/docs/resources/message#message-object-message-flags) combined as a [bitfield](https://en.wikipedia.org/wiki/Bit_field) | | message_reference? | [message reference](/docs/resources/message#message-reference-structure) object | data showing the source of a crosspost, channel follow add, pin, or reply message | | message_snapshots? \[5\] | array of [message snapshot](/docs/resources/message#message-snapshot-object) objects | the message associated with the `message_reference`. This is a minimal subset of fields in a message (e.g. `author` is excluded.) | | referenced_message? \[4\] | ?[message object](/docs/resources/message#message-object) | the message associated with the message_reference | -| interaction_metadata? | [message interaction metadata object](/docs/resources/message#message-interaction-metadata-object) | Sent if the message is sent as a result of an [interaction](/docs/interactions/receiving-and-responding#) | -| interaction? | [message interaction object](/docs/interactions/receiving-and-responding#message-interaction-object-message-interaction-structure) | **Deprecated in favor of `interaction_metadata`**; sent if the message is a response to an [interaction](/docs/interactions/receiving-and-responding#) | +| interaction_metadata? | [message interaction metadata object](/docs/resources/message#message-interaction-metadata-object) | Sent if the message is sent as a result of an [interaction](/docs/interactions/receiving-and-responding) | +| interaction? | [message interaction object](/docs/interactions/receiving-and-responding#message-interaction-object-message-interaction-structure) | **Deprecated in favor of `interaction_metadata`**; sent if the message is a response to an [interaction](/docs/interactions/receiving-and-responding) | | thread? | [channel](/docs/resources/channel#channel-object) object | the thread that was started from this message, includes [thread member](/docs/resources/channel#thread-member-object) object | | components? \[2\] | array of [message components](/docs/interactions/message-components#component-object) | sent if the message contains components like buttons, action rows, or other interactive components | | sticker_items? | array of [message sticker item objects](/docs/resources/sticker#sticker-item-object) | sent if the message contains stickers | @@ -258,7 +258,7 @@ One of [Application Command Interaction Metadata](/docs/resources/message#messag | type | [interaction type](/docs/interactions/receiving-and-responding#interaction-object-interaction-type) | Type of interaction | | user | [user](/docs/resources/user#user-object) object | User who triggered the interaction | | authorizing_integration_owners | dictionary with keys of [application integration types](/docs/resources/application#application-object-application-integration-types) | IDs for installation context(s) related to an interaction. Details in [Authorizing Integration Owners Object](/docs/interactions/receiving-and-responding#interaction-object-authorizing-integration-owners-object) | -| original_response_message_id? | snowflake | ID of the original response message, present only on [follow-up messages](/docs/interactions/receiving-and-responding#) | +| original_response_message_id? | snowflake | ID of the original response message, present only on [follow-up messages](/docs/interactions/receiving-and-responding) | | target_user? | [user](/docs/resources/user#user-object) object | The user the command was run on, present only on [user command](/docs/interactions/application-commands#user-commands) interactions | | target_message_id? | snowflake | The ID of the message the command was run on, present only on [message command](/docs/interactions/application-commands#message-commands) interactions. The original response message will also have `message_reference` and `referenced_message` pointing to this message. | @@ -271,7 +271,7 @@ One of [Application Command Interaction Metadata](/docs/resources/message#messag | type | [interaction type](/docs/interactions/receiving-and-responding#interaction-object-interaction-type) | Type of interaction | | user | [user](/docs/resources/user#user-object) object | User who triggered the interaction | | authorizing_integration_owners | dictionary with keys of [application integration types](/docs/resources/application#application-object-application-integration-types) | IDs for installation context(s) related to an interaction. Details in [Authorizing Integration Owners Object](/docs/interactions/receiving-and-responding#interaction-object-authorizing-integration-owners-object) | -| original_response_message_id? | snowflake | ID of the original response message, present only on [follow-up messages](/docs/interactions/receiving-and-responding#) | +| original_response_message_id? | snowflake | ID of the original response message, present only on [follow-up messages](/docs/interactions/receiving-and-responding) | | interacted_message_id | snowflake | ID of the message that contained the interactive component | @@ -283,7 +283,7 @@ One of [Application Command Interaction Metadata](/docs/resources/message#messag | type | [interaction type](/docs/interactions/receiving-and-responding#interaction-object-interaction-type) | Type of interaction | | user | [user](/docs/resources/user#user-object) object | User who triggered the interaction | | authorizing_integration_owners | dictionary with keys of [application integration types](/docs/resources/application#application-object-application-integration-types) | IDs for installation context(s) related to an interaction. Details in [Authorizing Integration Owners Object](/docs/interactions/receiving-and-responding#interaction-object-authorizing-integration-owners-object) | -| original_response_message_id? | snowflake | ID of the original response message, present only on [follow-up messages](/docs/interactions/receiving-and-responding#) | +| original_response_message_id? | snowflake | ID of the original response message, present only on [follow-up messages](/docs/interactions/receiving-and-responding) | | triggering_interaction_metadata | [Application Command Interaction Metadata](/docs/resources/message#message-interaction-metadata-object-application-command-interaction-metadata-structure) or [Message Component Interaction Metadata](/docs/resources/message#message-interaction-metadata-object-message-component-interaction-metadata-structure) object | Metadata for the interaction that was used to open the modal | diff --git a/docs/resources/user.md b/docs/resources/user.md index 5d59a58233..be41cc0ca9 100644 --- a/docs/resources/user.md +++ b/docs/resources/user.md @@ -82,7 +82,7 @@ There are other rules and restrictions not shared here for the sake of spam and | `1 << 7` | HYPESQUAD_ONLINE_HOUSE_2 | House Brilliance Member | | `1 << 8` | HYPESQUAD_ONLINE_HOUSE_3 | House Balance Member | | `1 << 9` | PREMIUM_EARLY_SUPPORTER | Early Nitro Supporter | -| `1 << 10` | TEAM_PSEUDO_USER | User is a [team](/docs/topics/teams#) | +| `1 << 10` | TEAM_PSEUDO_USER | User is a [team](/docs/topics/teams) | | `1 << 14` | BUG_HUNTER_LEVEL_2 | Bug Hunter Level 2 | | `1 << 16` | VERIFIED_BOT | Verified Bot | | `1 << 17` | VERIFIED_DEVELOPER | Early Verified Bot Developer | diff --git a/docs/rich-presence/using-with-the-game-sdk.mdx b/docs/rich-presence/using-with-the-game-sdk.mdx index 1be5e836c4..d07beee4c9 100644 --- a/docs/rich-presence/using-with-the-game-sdk.mdx +++ b/docs/rich-presence/using-with-the-game-sdk.mdx @@ -223,4 +223,4 @@ Yes! In addition to uploading an asset and specifying its name, you can also spe #### Q: OK—I've got it working! Now, how do I make my integration look _awesome_? -I'm happy ~~we preempted your question~~ you asked! Check out our [Rich Presence Best Practices](/docs/rich-presence/best-practices#) guide for a rundown on how to make your integration the best that it can be! +I'm happy ~~we preempted your question~~ you asked! Check out our [Rich Presence Best Practices](/docs/rich-presence/best-practices) guide for a rundown on how to make your integration the best that it can be! diff --git a/docs/topics/oauth2.md b/docs/topics/oauth2.md index 608b82d380..500ec64cca 100644 --- a/docs/topics/oauth2.md +++ b/docs/topics/oauth2.md @@ -21,36 +21,36 @@ The first step in implementing OAuth2 is [registering a developer application](h These are a list of all the OAuth2 scopes that Discord supports. Some scopes require approval from Discord to use. Requesting them from a user without approval from Discord may cause errors or undocumented behavior in the OAuth2 flow. -| Name | Description | -|------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| activities.read | allows your app to fetch data from a user's "Now Playing/Recently Played" list — not currently available for apps | -| activities.write | allows your app to update a user's activity - not currently available for apps (NOT REQUIRED FOR [GAMESDK ACTIVITY MANAGER](/docs/developer-tools/game-sdk#activities)) | -| applications.builds.read | allows your app to read build data for a user's applications | -| applications.builds.upload | allows your app to upload/update builds for a user's applications - requires Discord approval | -| applications.commands | allows your app to add [commands](/docs/interactions/application-commands#) to a guild - included by default with the `bot` scope | -| applications.commands.update | allows your app to update its [commands](/docs/interactions/application-commands#) using a Bearer token - [client credentials grant](/docs/topics/oauth2#client-credentials-grant) only | -| applications.commands.permissions.update | allows your app to update [permissions for its commands](/docs/interactions/application-commands#permissions) in a guild a user has permissions to | -| applications.entitlements | allows your app to read entitlements for a user's applications | -| applications.store.update | allows your app to read and update store data (SKUs, store listings, achievements, etc.) for a user's applications | -| bot | for oauth2 bots, this puts the bot in the user's selected guild by default | -| connections | allows [/users/@me/connections](/docs/resources/user#get-current-user-connections) to return linked third-party accounts | -| dm_channels.read | allows your app to see information about the user's DMs and group DMs - requires Discord approval | -| email | enables [/users/@me](/docs/resources/user#get-current-user) to return an `email` | -| gdm.join | allows your app to [join users to a group dm](/docs/resources/channel#group-dm-add-recipient) | -| guilds | allows [/users/@me/guilds](/docs/resources/user#get-current-user-guilds) to return basic information about all of a user's guilds | -| guilds.join | allows [/guilds/{guild.id}/members/{user.id}](/docs/resources/guild#add-guild-member) to be used for joining users to a guild | -| guilds.members.read | allows [/users/@me/guilds/{guild.id}/member](/docs/resources/user#get-current-user-guild-member) to return a user's member information in a guild | -| identify | allows [/users/@me](/docs/resources/user#get-current-user) without `email` | -| messages.read | for local rpc server api access, this allows you to read messages from all client channels (otherwise restricted to channels/guilds your app creates) | -| relationships.read | allows your app to know a user's friends and implicit relationships - requires Discord approval | -| role_connections.write | allows your app to update a user's connection and metadata for the app | -| rpc | for local rpc server access, this allows you to control a user's local Discord client - requires Discord approval | -| rpc.activities.write | for local rpc server access, this allows you to update a user's activity - requires Discord approval | -| rpc.notifications.read | for local rpc server access, this allows you to receive notifications pushed out to the user - requires Discord approval | -| rpc.voice.read | for local rpc server access, this allows you to read a user's voice settings and listen for voice events - requires Discord approval | -| rpc.voice.write | for local rpc server access, this allows you to update a user's voice settings - requires Discord approval | -| voice | allows your app to connect to voice on user's behalf and see all the voice members - requires Discord approval | -| webhook.incoming | this generates a webhook that is returned in the oauth token response for authorization code grants | +| Name | Description | +|------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| activities.read | allows your app to fetch data from a user's "Now Playing/Recently Played" list — not currently available for apps | +| activities.write | allows your app to update a user's activity - not currently available for apps (NOT REQUIRED FOR [GAMESDK ACTIVITY MANAGER](/docs/developer-tools/game-sdk#activities)) | +| applications.builds.read | allows your app to read build data for a user's applications | +| applications.builds.upload | allows your app to upload/update builds for a user's applications - requires Discord approval | +| applications.commands | allows your app to add [commands](/docs/interactions/application-commands) to a guild - included by default with the `bot` scope | +| applications.commands.update | allows your app to update its [commands](/docs/interactions/application-commands) using a Bearer token - [client credentials grant](/docs/topics/oauth2#client-credentials-grant) only | +| applications.commands.permissions.update | allows your app to update [permissions for its commands](/docs/interactions/application-commands#permissions) in a guild a user has permissions to | +| applications.entitlements | allows your app to read entitlements for a user's applications | +| applications.store.update | allows your app to read and update store data (SKUs, store listings, achievements, etc.) for a user's applications | +| bot | for oauth2 bots, this puts the bot in the user's selected guild by default | +| connections | allows [/users/@me/connections](/docs/resources/user#get-current-user-connections) to return linked third-party accounts | +| dm_channels.read | allows your app to see information about the user's DMs and group DMs - requires Discord approval | +| email | enables [/users/@me](/docs/resources/user#get-current-user) to return an `email` | +| gdm.join | allows your app to [join users to a group dm](/docs/resources/channel#group-dm-add-recipient) | +| guilds | allows [/users/@me/guilds](/docs/resources/user#get-current-user-guilds) to return basic information about all of a user's guilds | +| guilds.join | allows [/guilds/{guild.id}/members/{user.id}](/docs/resources/guild#add-guild-member) to be used for joining users to a guild | +| guilds.members.read | allows [/users/@me/guilds/{guild.id}/member](/docs/resources/user#get-current-user-guild-member) to return a user's member information in a guild | +| identify | allows [/users/@me](/docs/resources/user#get-current-user) without `email` | +| messages.read | for local rpc server api access, this allows you to read messages from all client channels (otherwise restricted to channels/guilds your app creates) | +| relationships.read | allows your app to know a user's friends and implicit relationships - requires Discord approval | +| role_connections.write | allows your app to update a user's connection and metadata for the app | +| rpc | for local rpc server access, this allows you to control a user's local Discord client - requires Discord approval | +| rpc.activities.write | for local rpc server access, this allows you to update a user's activity - requires Discord approval | +| rpc.notifications.read | for local rpc server access, this allows you to receive notifications pushed out to the user - requires Discord approval | +| rpc.voice.read | for local rpc server access, this allows you to read a user's voice settings and listen for voice events - requires Discord approval | +| rpc.voice.write | for local rpc server access, this allows you to update a user's voice settings - requires Discord approval | +| voice | allows your app to connect to voice on user's behalf and see all the voice members - requires Discord approval | +| webhook.incoming | this generates a webhook that is returned in the oauth token response for authorization code grants | > info > In order to add a user to a guild, your bot has to already belong to that guild. @@ -284,7 +284,7 @@ Bot authorization is a special server-less and callback-less OAuth2 flow that ma |----------------------|-----------------------------------------------------------------------| | client_id | your app's client id | | scope | needs to include `bot` for the bot flow | -| permissions | the [permissions](/docs/topics/permissions#) you're requesting | +| permissions | the [permissions](/docs/topics/permissions) you're requesting | | guild_id | pre-fills the dropdown picker with a guild for the user | | disable_guild_select | `true` or `false`—disallows the user from changing the guild dropdown | diff --git a/docs/topics/opcodes-and-status-codes.md b/docs/topics/opcodes-and-status-codes.md index ef641b3966..74ce2e707e 100644 --- a/docs/topics/opcodes-and-status-codes.md +++ b/docs/topics/opcodes-and-status-codes.md @@ -357,7 +357,7 @@ Along with the HTTP error code, our API can also return more detailed error code ## RPC -RPC is the [local Discord server](/docs/topics/rpc#) running on localhost. Access to the RPC server requires approval from Discord. +RPC is the [local Discord server](/docs/topics/rpc) running on localhost. Access to the RPC server requires approval from Discord. ###### RPC Error Codes From f8de1cc2b82d07fc0c727a4c321af06faa258d3d Mon Sep 17 00:00:00 2001 From: GeniusTimo Date: Sat, 19 Apr 2025 20:23:19 +0200 Subject: [PATCH 02/20] Reverted a62c908953da8cd224d0904f4c06a9adb0b0290c for 2021-11-23-guild-scheduled-events.md --- docs/change-log/2021-11-23-guild-scheduled-events.md | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/docs/change-log/2021-11-23-guild-scheduled-events.md b/docs/change-log/2021-11-23-guild-scheduled-events.md index 9e78bbf0da..f2dd642e49 100644 --- a/docs/change-log/2021-11-23-guild-scheduled-events.md +++ b/docs/change-log/2021-11-23-guild-scheduled-events.md @@ -7,11 +7,11 @@ date: "2021-11-23" #### Nov 18, 2021 -* Breaking change for return type for `GET /guilds/{guild.id}/scheduled-events/{guild-scheduled-event.id}/users` -* Add `with_user_count` query param for `GET /guilds/{guild.id}/scheduled-events/{guild-scheduled-event.id}` -* Return additional `creator` field by default in response for `GET /guilds/{guild.id}/scheduled-events/{guild-scheduled-event.id}` +* Breaking change for return type for `GET /guilds/{guild.id}/scheduled-events/{guild_scheduled_event.id}/users` +* Add `with_user_count` query param for `GET /guilds/{guild.id}/scheduled-events/{guild_scheduled_event.id}` +* Return additional `creator` field by default in response for `GET /guilds/{guild.id}/scheduled-events/{guild_scheduled_event.id}` * More details and clarification for the guild scheduled events feature. -* Document support for `before` and `after` query params for `GET /guilds/{guild.id}/scheduled-events/{guild-scheduled-event.id}/users` +* Document support for `before` and `after` query params for `GET /guilds/{guild.id}/scheduled-events/{guild_scheduled_event.id}/users` #### Nov 15, 2021 From fe1e87af2a4075c5fb14e409bb1ce5eac53dc7cc Mon Sep 17 00:00:00 2001 From: GeniusTimo Date: Sat, 19 Apr 2025 20:50:35 +0200 Subject: [PATCH 03/20] [WIP] Added placeholder for links within the request paths The regular expression `[|]{2}FIXME[|]{2}([^|]+)[|]{2}([^|]+)[|]{2}` should be used to replace the placeholders To get back to the previous state use `{$1$2}` as replacement pattern, but those were broken --- docs/interactions/application-commands.mdx | 32 +++---- .../interactions/receiving-and-responding.mdx | 16 ++-- .../application-role-connection-metadata.md | 4 +- docs/resources/application.md | 2 +- docs/resources/audit-log.md | 2 +- docs/resources/auto-moderation.md | 10 +- docs/resources/channel.md | 52 +++++------ docs/resources/emoji.md | 20 ++-- docs/resources/entitlement.md | 10 +- docs/resources/guild-scheduled-event.mdx | 12 +-- docs/resources/guild-template.md | 14 +-- docs/resources/guild.md | 92 +++++++++---------- docs/resources/invite.md | 4 +- docs/resources/lobby.md | 16 ++-- docs/resources/message.md | 26 +++--- docs/resources/poll.md | 4 +- docs/resources/sku.md | 2 +- docs/resources/soundboard.md | 12 +-- docs/resources/stage-instance.md | 6 +- docs/resources/sticker.md | 14 +-- docs/resources/subscription.md | 6 +- docs/resources/user.md | 10 +- docs/resources/voice.md | 8 +- docs/resources/webhook.md | 30 +++--- 24 files changed, 202 insertions(+), 202 deletions(-) diff --git a/docs/interactions/application-commands.mdx b/docs/interactions/application-commands.mdx index b1bc43d376..1fd42aaade 100644 --- a/docs/interactions/application-commands.mdx +++ b/docs/interactions/application-commands.mdx @@ -1138,7 +1138,7 @@ Details about accessing and using age-restricted commands is in [the Help Center > info > For authorization, all endpoints take either a [bot token](/docs/reference#authentication) or [client credentials token](/docs/topics/oauth2#client-credentials-grant) for your application -## Get Global Application Commands % GET /applications/\{application.id/docs/resources/application#application-object\}/commands +## Get Global Application Commands % GET /applications/||FIXME||application.id||/docs/resources/application#application-object||/commands > warn > The objects returned by this endpoint may be augmented with [additional fields if localization is active](/docs/interactions/application-commands#retrieving-localized-commands). @@ -1151,7 +1151,7 @@ Fetch all of the global commands for your application. Returns an array of [appl |---------------------|--------------------------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | with_localizations? | [boolean](/docs/reference#boolean-query-strings) | Whether to include full localization dictionaries (`name_localizations` and `description_localizations`) in the returned objects, instead of the `name_localized` and `description_localized` fields. Default `false`. | -## Create Global Application Command % POST /applications/\{application.id/docs/resources/application#application-object\}/commands +## Create Global Application Command % POST /applications/||FIXME||application.id||/docs/resources/application#application-object||/commands > warn > Creating a command with the same name as an existing command for your application will overwrite the old command. @@ -1175,11 +1175,11 @@ Create a new global command. Returns `201` if a command with the same name does | type? | one of [application command type](/docs/interactions/application-commands#application-command-object-application-command-types) | Type of command, defaults `1` if not set | | nsfw? | boolean | Indicates whether the command is [age-restricted](/docs/interactions/application-commands#agerestricted-commands) | -## Get Global Application Command % GET /applications/\{application.id/docs/resources/application#application-object\}/commands/\{command.id/docs/interactions/application-commands#application-command-object\} +## Get Global Application Command % GET /applications/||FIXME||application.id||/docs/resources/application#application-object||/commands/||FIXME||command.id||/docs/interactions/application-commands#application-command-object|| Fetch a global command for your application. Returns an [application command](/docs/interactions/application-commands#application-command-object) object. -## Edit Global Application Command % PATCH /applications/\{application.id/docs/resources/application#application-object\}/commands/\{command.id/docs/interactions/application-commands#application-command-object\} +## Edit Global Application Command % PATCH /applications/||FIXME||application.id||/docs/resources/application#application-object||/commands/||FIXME||command.id||/docs/interactions/application-commands#application-command-object|| > info > All parameters for this endpoint are optional. @@ -1202,18 +1202,18 @@ Edit a global command. Returns `200` and an [application command](/docs/interact | contexts? | list of [interaction context types](/docs/interactions/receiving-and-responding#interaction-object-interaction-context-types) | [Interaction context(s)](/docs/interactions/receiving-and-responding#interaction-object-interaction-context-types) where the command can be used | | nsfw? | boolean | Indicates whether the command is [age-restricted](/docs/interactions/application-commands#agerestricted-commands) | -## Delete Global Application Command % DELETE /applications/\{application.id/docs/resources/application#application-object\}/commands/\{command.id/docs/interactions/application-commands#application-command-object\} +## Delete Global Application Command % DELETE /applications/||FIXME||application.id||/docs/resources/application#application-object||/commands/||FIXME||command.id||/docs/interactions/application-commands#application-command-object|| Deletes a global command. Returns `204 No Content` on success. -## Bulk Overwrite Global Application Commands % PUT /applications/\{application.id/docs/resources/application#application-object\}/commands +## Bulk Overwrite Global Application Commands % PUT /applications/||FIXME||application.id||/docs/resources/application#application-object||/commands Takes a list of application commands, overwriting the existing global command list for this application. Returns `200` and a list of [application command](/docs/interactions/application-commands#application-command-object) objects. Commands that do not already exist will count toward daily application command create limits. > danger > This will overwrite **all** types of application commands: slash commands, user commands, and message commands. -## Get Guild Application Commands % GET /applications/\{application.id/docs/resources/application#application-object\}/guilds/\{guild.id/docs/resources/guild#guild-object\}/commands +## Get Guild Application Commands % GET /applications/||FIXME||application.id||/docs/resources/application#application-object||/guilds/||FIXME||guild.id||/docs/resources/guild#guild-object||/commands > warn > The objects returned by this endpoint may be augmented with [additional fields if localization is active](/docs/interactions/application-commands#retrieving-localized-commands). @@ -1226,7 +1226,7 @@ Fetch all of the guild commands for your application for a specific guild. Retur |---------------------|--------------------------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | with_localizations? | [boolean](/docs/reference#boolean-query-strings) | Whether to include full localization dictionaries (`name_localizations` and `description_localizations`) in the returned objects, instead of the `name_localized` and `description_localized` fields. Default `false`. | -## Create Guild Application Command % POST /applications/\{application.id/docs/resources/application#application-object\}/guilds/\{guild.id/docs/resources/guild#guild-object\}/commands +## Create Guild Application Command % POST /applications/||FIXME||application.id||/docs/resources/application#application-object||/guilds/||FIXME||guild.id||/docs/resources/guild#guild-object||/commands > danger > Creating a command with the same name as an existing command for your application will overwrite the old command. @@ -1247,11 +1247,11 @@ Create a new guild command. New guild commands will be available in the guild im | type? | one of [application command type](/docs/interactions/application-commands#application-command-object-application-command-types) | Type of command, defaults `1` if not set | | nsfw? | boolean | Indicates whether the command is [age-restricted](/docs/interactions/application-commands#agerestricted-commands) | -## Get Guild Application Command % GET /applications/\{application.id/docs/resources/application#application-object}/guilds/\{guild.id/docs/resources/guild#guild-object\}/commands/\{command.id/docs/interactions/application-commands#application-command-object\} +## Get Guild Application Command % GET /applications/||FIXME||application.id||/docs/resources/application#application-object||/guilds/||FIXME||guild.id||/docs/resources/guild#guild-object||/commands/||FIXME||command.id||/docs/interactions/application-commands#application-command-object|| Fetch a guild command for your application. Returns an [application command](/docs/interactions/application-commands#application-command-object) object. -## Edit Guild Application Command % PATCH /applications/\{application.id/docs/resources/application#application-object}/guilds/\{guild.id/docs/resources/guild#guild-object\}/commands/\{command.id/docs/interactions/application-commands#application-command-object\} +## Edit Guild Application Command % PATCH /applications/||FIXME||application.id||/docs/resources/application#application-object||/guilds/||FIXME||guild.id||/docs/resources/guild#guild-object||/commands/||FIXME||command.id||/docs/interactions/application-commands#application-command-object|| > info > All parameters for this endpoint are optional. @@ -1271,11 +1271,11 @@ Edit a guild command. Updates for guild commands will be available immediately. | default_permission? | boolean | Replaced by `default_member_permissions` and will be deprecated in the future. Indicates whether the command is enabled by default when the app is added to a guild. Defaults to `true` | | nsfw? | boolean | Indicates whether the command is [age-restricted](/docs/interactions/application-commands#agerestricted-commands) | -## Delete Guild Application Command % DELETE /applications/\{application.id/docs/resources/application#application-object\}/guilds/\{guild.id/docs/resources/guild#guild-object\}/commands/\{command.id/docs/interactions/application-commands#application-command-object\} +## Delete Guild Application Command % DELETE /applications/||FIXME||application.id||/docs/resources/application#application-object||/guilds/||FIXME||guild.id||/docs/resources/guild#guild-object||/commands/||FIXME||command.id||/docs/interactions/application-commands#application-command-object|| Delete a guild command. Returns `204 No Content` on success. -## Bulk Overwrite Guild Application Commands % PUT /applications/\{application.id/docs/resources/application#application-object\}/guilds/\{guild.id/docs/resources/guild#guild-object\}/commands +## Bulk Overwrite Guild Application Commands % PUT /applications/||FIXME||application.id||/docs/resources/application#application-object||/guilds/||FIXME||guild.id||/docs/resources/guild#guild-object||/commands Takes a list of application commands, overwriting the existing command list for this application for the targeted guild. Returns `200` and a list of [application command](/docs/interactions/application-commands#application-command-object) objects. @@ -1300,15 +1300,15 @@ Takes a list of application commands, overwriting the existing command list for | type? | one of [application command type](/docs/interactions/application-commands#application-command-object-application-command-types) | Type of command, defaults `1` if not set | | nsfw? | boolean | Indicates whether the command is [age-restricted](/docs/interactions/application-commands#agerestricted-commands) | -## Get Guild Application Command Permissions % GET /applications/\{application.id/docs/resources/application#application-object\}/guilds/\{guild.id/docs/resources/guild#guild-object\}/commands/permissions +## Get Guild Application Command Permissions % GET /applications/||FIXME||application.id||/docs/resources/application#application-object||/guilds/||FIXME||guild.id||/docs/resources/guild#guild-object||/commands/permissions Fetches permissions for all commands for your application in a guild. Returns an array of [guild application command permissions](/docs/interactions/application-commands#application-command-permissions-object-guild-application-command-permissions-structure) objects. -## Get Application Command Permissions % GET /applications/\{application.id/docs/resources/application#application-object}/guilds/\{guild.id/docs/resources/guild#guild-object\}/commands/\{command.id/docs/interactions/application-commands#application-command-object\}/permissions +## Get Application Command Permissions % GET /applications/||FIXME||application.id||/docs/resources/application#application-object||/guilds/||FIXME||guild.id||/docs/resources/guild#guild-object||/commands/||FIXME||command.id||/docs/interactions/application-commands#application-command-object||/permissions Fetches permissions for a specific command for your application in a guild. Returns a [guild application command permissions](/docs/interactions/application-commands#application-command-permissions-object-guild-application-command-permissions-structure) object. -## Edit Application Command Permissions % PUT /applications/\{application.id/docs/resources/application#application-object\}/guilds/\{guild.id/docs/resources/guild#guild-object\}/commands/\{command.id/docs/interactions/application-commands#application-command-object\}/permissions +## Edit Application Command Permissions % PUT /applications/||FIXME||application.id||/docs/resources/application#application-object||/guilds/||FIXME||guild.id||/docs/resources/guild#guild-object||/commands/||FIXME||command.id||/docs/interactions/application-commands#application-command-object||/permissions > warn > This endpoint will overwrite existing permissions for the command in that guild @@ -1329,7 +1329,7 @@ You can add up to 100 permission overwrites for a command. |-------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------------------------------------| | permissions | array of [application command permissions](/docs/interactions/application-commands#application-command-permissions-object-application-command-permissions-structure) | Permissions for the command in the guild | -## Batch Edit Application Command Permissions % PUT /applications/\{application.id/docs/resources/application#application-object\}/guilds/\{guild.id/docs/resources/guild#guild-object\}/commands/permissions +## Batch Edit Application Command Permissions % PUT /applications/||FIXME||application.id||/docs/resources/application#application-object||/guilds/||FIXME||guild.id||/docs/resources/guild#guild-object||/commands/permissions > danger > This endpoint has been disabled with [updates to command permissions (Permissions v2)](/docs/change-log#updated-command-permissions). Instead, you can [edit each application command permissions](/docs/interactions/application-commands#edit-application-command-permissions) (though you should be careful to handle any potential [rate limits](/docs/topics/rate-limits)). diff --git a/docs/interactions/receiving-and-responding.mdx b/docs/interactions/receiving-and-responding.mdx index ce6f299f28..b69ff9d7db 100644 --- a/docs/interactions/receiving-and-responding.mdx +++ b/docs/interactions/receiving-and-responding.mdx @@ -380,7 +380,7 @@ Interaction tokens are valid for **15 minutes**, meaning you can respond to an i > info > The endpoints below are not bound to the application's [Global Rate Limit](/docs/topics/rate-limits#global-rate-limit). -## Create Interaction Response % POST /interactions/\{interaction.id/docs/interactions/receiving-and-responding#interaction-object\}/\{interaction.token/docs/interactions/receiving-and-responding#interaction-object\}/callback +## Create Interaction Response % POST /interactions/||FIXME||interaction.id||/docs/interactions/receiving-and-responding#interaction-object||/||FIXME||interaction.token||/docs/interactions/receiving-and-responding#interaction-object||/callback Create a response to an Interaction. Body is an [interaction response](/docs/interactions/receiving-and-responding#interaction-response-object). Returns `204` unless `with_response` is set to `true` which returns `200` with the body as [interaction callback response](/docs/interactions/receiving-and-responding#interaction-callback-interaction-callback-response-object). @@ -393,19 +393,19 @@ This endpoint also supports file attachments similar to the webhook endpoints. R | with_response? | [boolean](/docs/reference#boolean-query-strings) | Whether to include an [interaction callback object](/docs/interactions/receiving-and-responding#interaction-callback-interaction-callback-response-object) as the response | -## Get Original Interaction Response % GET /webhooks/\{application.id/docs/resources/application#application-object\}/\{interaction.token/docs/interactions/receiving-and-responding#interaction-object\}/messages/@original +## Get Original Interaction Response % GET /webhooks/||FIXME||application.id||/docs/resources/application#application-object||/||FIXME||interaction.token||/docs/interactions/receiving-and-responding#interaction-object||/messages/@original Returns the initial Interaction response. Functions the same as [Get Webhook Message](/docs/resources/webhook#get-webhook-message). -## Edit Original Interaction Response % PATCH /webhooks/\{application.id/docs/resources/application#application-object\}/\{interaction.token/docs/interactions/receiving-and-responding#interaction-object\}/messages/@original +## Edit Original Interaction Response % PATCH /webhooks/||FIXME||application.id||/docs/resources/application#application-object||/||FIXME||interaction.token||/docs/interactions/receiving-and-responding#interaction-object||/messages/@original Edits the initial Interaction response. Functions the same as [Edit Webhook Message](/docs/resources/webhook#edit-webhook-message). -## Delete Original Interaction Response % DELETE /webhooks/\{application.id/docs/resources/application#application-object\}/\{interaction.token/docs/interactions/receiving-and-responding#interaction-object\}/messages/@original +## Delete Original Interaction Response % DELETE /webhooks/||FIXME||application.id||/docs/resources/application#application-object||/||FIXME||interaction.token||/docs/interactions/receiving-and-responding#interaction-object||/messages/@original Deletes the initial Interaction response. Returns `204 No Content` on success. -## Create Followup Message % POST /webhooks/\{application.id/docs/resources/application#application-object\}/\{interaction.token/docs/interactions/receiving-and-responding#interaction-object\} +## Create Followup Message % POST /webhooks/||FIXME||application.id||/docs/resources/application#application-object||/||FIXME||interaction.token||/docs/interactions/receiving-and-responding#interaction-object|| > info > Apps are limited to 5 followup messages per interaction if it was initiated from a user-installed app and isn't installed in the server (meaning the [authorizing integration owners object](/docs/interactions/receiving-and-responding#interaction-object-authorizing-integration-owners-object) only contains `USER_INSTALL`) @@ -414,14 +414,14 @@ Create a followup message for an Interaction. Functions the same as [Execute Web When using this endpoint directly after responding to an interaction with `DEFERRED_CHANNEL_MESSAGE_WITH_SOURCE`, this endpoint will function as [Edit Original Interaction Response](/docs/interactions/receiving-and-responding#edit-original-interaction-response) for backwards compatibility. In this case, no new message will be created, and the loading message will be edited instead. The ephemeral flag will be ignored, and the value you provided in the initial defer response will be preserved, as an existing message's ephemeral state cannot be changed. This behavior is deprecated, and you should use the Edit Original Interaction Response endpoint in this case instead. -## Get Followup Message % GET /webhooks/\{application.id/docs/resources/application#application-object\}/\{interaction.token/docs/interactions/receiving-and-responding#interaction-object\}/messages/\{message.id/docs/resources/channel#message-object\} +## Get Followup Message % GET /webhooks/||FIXME||application.id||/docs/resources/application#application-object||/||FIXME||interaction.token||/docs/interactions/receiving-and-responding#interaction-object||/messages/||FIXME||message.id||/docs/resources/channel#message-object|| Returns a followup message for an Interaction. Functions the same as [Get Webhook Message](/docs/resources/webhook#get-webhook-message). -## Edit Followup Message % PATCH /webhooks/\{application.id/docs/resources/application#application-object\}/\{interaction.token/docs/interactions/receiving-and-responding#interaction-object\}/messages/\{message.id/docs/resources/channel#message-object\} +## Edit Followup Message % PATCH /webhooks/||FIXME||application.id||/docs/resources/application#application-object||/||FIXME||interaction.token||/docs/interactions/receiving-and-responding#interaction-object||/messages/||FIXME||message.id||/docs/resources/channel#message-object|| Edits a followup message for an Interaction. Functions the same as [Edit Webhook Message](/docs/resources/webhook#edit-webhook-message). -## Delete Followup Message % DELETE /webhooks/\{application.id/docs/resources/application#application-object\}/\{interaction.token/docs/interactions/receiving-and-responding#interaction-object\}/messages/\{message.id/docs/resources/channel#message-object\} +## Delete Followup Message % DELETE /webhooks/||FIXME||application.id||/docs/resources/application#application-object||/||FIXME||interaction.token||/docs/interactions/receiving-and-responding#interaction-object||/messages/||FIXME||message.id||/docs/resources/channel#message-object|| Deletes a followup message for an Interaction. Returns `204 No Content` on success. diff --git a/docs/resources/application-role-connection-metadata.md b/docs/resources/application-role-connection-metadata.md index 2c482fa488..1aee5e4865 100644 --- a/docs/resources/application-role-connection-metadata.md +++ b/docs/resources/application-role-connection-metadata.md @@ -37,11 +37,11 @@ When a user connects their account using the bot's [`role_connections_verificati > info > Each metadata type offers a comparison operation that allows guilds to configure role requirements based on metadata values stored by the bot. Bots specify a `metadata value` for each user and guilds specify the required `guild's configured value` within the guild role settings. -## Get Application Role Connection Metadata Records % GET /applications/{application.id/docs/resources/application#application-object}/role-connections/metadata +## Get Application Role Connection Metadata Records % GET /applications/||FIXME||application.id||/docs/resources/application#application-object||/role-connections/metadata Returns a list of [application role connection metadata](/docs/resources/application-role-connection-metadata#application-role-connection-metadata-object) objects for the given application. -## Update Application Role Connection Metadata Records % PUT /applications/{application.id/docs/resources/application#application-object}/role-connections/metadata +## Update Application Role Connection Metadata Records % PUT /applications/||FIXME||application.id||/docs/resources/application#application-object||/role-connections/metadata Updates and returns a list of [application role connection metadata](/docs/resources/application-role-connection-metadata#application-role-connection-metadata-object) objects for the given application. diff --git a/docs/resources/application.md b/docs/resources/application.md index 1626cb5173..70725d2cac 100644 --- a/docs/resources/application.md +++ b/docs/resources/application.md @@ -256,7 +256,7 @@ Edit properties of the app associated with the requesting bot user. Only propert \*\* To update an Interactions endpoint URL via the API, the URL must be valid according to the [Receiving an Interaction](/docs/interactions/receiving-and-responding#receiving-an-interaction) documentation. -## Get Application Activity Instance % GET /applications/{application.id/docs/resources/application#application-object}/activity-instances/{instance_id} +## Get Application Activity Instance % GET /applications/||FIXME||application.id||/docs/resources/application#application-object||/activity-instances/{instance_id} Returns a serialized activity instance, if it exists. Useful for [preventing unwanted activity sessions](/docs/activities/development-guides#preventing-unwanted-activity-sessions). diff --git a/docs/resources/audit-log.md b/docs/resources/audit-log.md index 4f8b3beb2c..d1279c4628 100644 --- a/docs/resources/audit-log.md +++ b/docs/resources/audit-log.md @@ -194,7 +194,7 @@ For most objects, the change keys may be any field on the changed object. The fo | [Partial Role](/docs/topics/permissions#role-object) | `$add` and `$remove` as keys | `new_value` is an array of objects that contain the role `id` and `name` | | [Webhook](/docs/resources/webhook#webhook-object) | `avatar_hash` key (instead of `avatar`) | | -## Get Guild Audit Log % GET /guilds/{guild.id/docs/resources/guild#guild-object}/audit-logs +## Get Guild Audit Log % GET /guilds/||FIXME||guild.id||/docs/resources/guild#guild-object||/audit-logs Returns an [audit log](/docs/resources/audit-log#audit-log-object) object for the guild. Requires the [`VIEW_AUDIT_LOG`](/docs/topics/permissions#permissions-bitwise-permission-flags) permission. diff --git a/docs/resources/auto-moderation.md b/docs/resources/auto-moderation.md index 90714af288..37eaad09b5 100644 --- a/docs/resources/auto-moderation.md +++ b/docs/resources/auto-moderation.md @@ -198,21 +198,21 @@ value of [action type](/docs/resources/auto-moderation#auto-moderation-action-ob Users are required to have the `MANAGE_GUILD` permission to access all Auto Moderation resources. Some [action types](/docs/resources/auto-moderation#auto-moderation-action-object-action-types) require additional permissions, e.g. the `TIMEOUT` action type requires an additional `MODERATE_MEMBERS` permission. -## List Auto Moderation Rules for Guild % GET /guilds/{guild.id/docs/resources/guild#guild-object}/auto-moderation/rules +## List Auto Moderation Rules for Guild % GET /guilds/||FIXME||guild.id||/docs/resources/guild#guild-object||/auto-moderation/rules Get a list of all rules currently configured for the guild. Returns a list of [auto moderation rule](/docs/resources/auto-moderation#auto-moderation-rule-object) objects for the given guild. > info > This endpoint requires the `MANAGE_GUILD` [permission](/docs/resources/auto-moderation#auto-moderation-permission-requirements). -## Get Auto Moderation Rule % GET /guilds/{guild.id/docs/resources/guild#guild-object}/auto-moderation/rules/{auto_moderation_rule.id/docs/resources/auto-moderation#auto-moderation-rule-object} +## Get Auto Moderation Rule % GET /guilds/||FIXME||guild.id||/docs/resources/guild#guild-object||/auto-moderation/rules/||FIXME||auto_moderation_rule.id||/docs/resources/auto-moderation#auto-moderation-rule-object|| Get a single rule. Returns an [auto moderation rule](/docs/resources/auto-moderation#auto-moderation-rule-object) object. > info > This endpoint requires the `MANAGE_GUILD` [permission](/docs/resources/auto-moderation#auto-moderation-permission-requirements). -## Create Auto Moderation Rule % POST /guilds/{guild.id/docs/resources/guild#guild-object}/auto-moderation/rules +## Create Auto Moderation Rule % POST /guilds/||FIXME||guild.id||/docs/resources/guild#guild-object||/auto-moderation/rules Create a new rule. Returns an [auto moderation rule](/docs/resources/auto-moderation#auto-moderation-rule-object) on success. Fires an [Auto Moderation Rule Create](/docs/events/gateway-events#auto-moderation-rule-create) Gateway event. @@ -241,7 +241,7 @@ Create a new rule. Returns an [auto moderation rule](/docs/resources/auto-modera > See [Trigger Types](/docs/resources/auto-moderation#auto-moderation-rule-object-trigger-types) for limits on how many rules of each trigger type can be created per guild. -## Modify Auto Moderation Rule % PATCH /guilds/{guild.id/docs/resources/guild#guild-object}/auto-moderation/rules/{auto_moderation_rule.id/docs/resources/auto-moderation#auto-moderation-rule-object} +## Modify Auto Moderation Rule % PATCH /guilds/||FIXME||guild.id||/docs/resources/guild#guild-object||/auto-moderation/rules/||FIXME||auto_moderation_rule.id||/docs/resources/auto-moderation#auto-moderation-rule-object|| Modify an existing rule. Returns an [auto moderation rule](/docs/resources/auto-moderation#auto-moderation-rule-object) on success. Fires an [Auto Moderation Rule Update](/docs/events/gateway-events#auto-moderation-rule-update) Gateway event. @@ -268,7 +268,7 @@ Modify an existing rule. Returns an [auto moderation rule](/docs/resources/auto- \* Can be omitted based on `trigger_type`. See the `Associated Trigger Types` column in [trigger metadata](/docs/resources/auto-moderation#auto-moderation-rule-object-trigger-metadata) to understand which `trigger_type` values require `trigger_metadata` to be set. -## Delete Auto Moderation Rule % DELETE /guilds/{guild.id/docs/resources/guild#guild-object}/auto-moderation/rules/{auto_moderation_rule.id/docs/resources/auto-moderation#auto-moderation-rule-object} +## Delete Auto Moderation Rule % DELETE /guilds/||FIXME||guild.id||/docs/resources/guild#guild-object||/auto-moderation/rules/||FIXME||auto_moderation_rule.id||/docs/resources/auto-moderation#auto-moderation-rule-object|| Delete a rule. Returns a `204` on success. Fires an [Auto Moderation Rule Delete](/docs/events/gateway-events#auto-moderation-rule-delete) Gateway event. diff --git a/docs/resources/channel.md b/docs/resources/channel.md index 9174426f82..93c1f43fa9 100644 --- a/docs/resources/channel.md +++ b/docs/resources/channel.md @@ -343,11 +343,11 @@ An object that represents a tag that is able to be applied to a thread in a `GUI \* At most one of `emoji_id` and `emoji_name` may be set to a non-null value. -## Get Channel % GET /channels/{channel.id/docs/resources/channel#channel-object} +## Get Channel % GET /channels/||FIXME||channel.id||/docs/resources/channel#channel-object|| Get a channel by ID. Returns a [channel](/docs/resources/channel#channel-object) object. If the channel is a thread, a [thread member](/docs/resources/channel#thread-member-object) object is included in the returned result. -## Modify Channel % PATCH /channels/{channel.id/docs/resources/channel#channel-object} +## Modify Channel % PATCH /channels/||FIXME||channel.id||/docs/resources/channel#channel-object|| Update a channel's settings. Returns a [channel](/docs/resources/channel#channel-object) on success, and a 400 BAD REQUEST on invalid parameters. @@ -413,7 +413,7 @@ Otherwise, requires the `MANAGE_THREADS` permission. Fires a [Thread Update](/do | flags? | integer | [channel flags](/docs/resources/channel#channel-object-channel-flags) combined as a [bitfield](https://en.wikipedia.org/wiki/Bit_field); `PINNED` can only be set for threads in forum and media channels | | applied_tags? | array of snowflakes | the IDs of the set of tags that have been applied to a thread in a `GUILD_FORUM` or a `GUILD_MEDIA` channel; limited to 5 | -## Delete/Close Channel % DELETE /channels/{channel.id/docs/resources/channel#channel-object} +## Delete/Close Channel % DELETE /channels/||FIXME||channel.id||/docs/resources/channel#channel-object|| Delete a channel, or close a private message. Requires the `MANAGE_CHANNELS` permission for the guild, or `MANAGE_THREADS` if the channel is a thread. Deleting a category does not delete its child channels; they will have their `parent_id` removed and a [Channel Update](/docs/events/gateway-events#channel-update) Gateway event will fire for each of them. Returns a [channel](/docs/resources/channel#channel-object) object on success. Fires a [Channel Delete](/docs/events/gateway-events#channel-delete) Gateway event (or [Thread Delete](/docs/events/gateway-events#thread-delete) if the channel was a thread). @@ -426,7 +426,7 @@ Delete a channel, or close a private message. Requires the `MANAGE_CHANNELS` per > info > This endpoint supports the `X-Audit-Log-Reason` header. -## Edit Channel Permissions % PUT /channels/{channel.id/docs/resources/channel#channel-object}/permissions/{overwrite.id/docs/resources/channel#overwrite-object} +## Edit Channel Permissions % PUT /channels/||FIXME||channel.id||/docs/resources/channel#channel-object||/permissions/||FIXME||overwrite.id||/docs/resources/channel#overwrite-object|| Edit the channel permission overwrites for a user or role in a channel. Only usable for guild channels. Requires the `MANAGE_ROLES` permission. Only permissions your bot has in the guild or parent channel (if applicable) can be allowed/denied (unless your bot has a `MANAGE_ROLES` overwrite in the channel). Returns a 204 empty response on success. Fires a [Channel Update](/docs/events/gateway-events#channel-update) Gateway event. For more information about permissions, see [permissions](/docs/topics/permissions#permissions). @@ -441,11 +441,11 @@ Edit the channel permission overwrites for a user or role in a channel. Only usa | deny? | string? | the bitwise value of all disallowed permissions (default `"0"`) | | type | integer | 0 for a role or 1 for a member | -## Get Channel Invites % GET /channels/{channel.id/docs/resources/channel#channel-object}/invites +## Get Channel Invites % GET /channels/||FIXME||channel.id||/docs/resources/channel#channel-object||/invites Returns a list of [invite](/docs/resources/invite#invite-object) objects (with [invite metadata](/docs/resources/invite#invite-metadata-object)) for the channel. Only usable for guild channels. Requires the `MANAGE_CHANNELS` permission. -## Create Channel Invite % POST /channels/{channel.id/docs/resources/channel#channel-object}/invites +## Create Channel Invite % POST /channels/||FIXME||channel.id||/docs/resources/channel#channel-object||/invites Create a new [invite](/docs/resources/invite#invite-object) object for the channel. Only usable for guild channels. Requires the `CREATE_INSTANT_INVITE` permission. All JSON parameters for this route are optional, however the request body is not. If you are not sending any fields, you still have to send an empty JSON object (`{}`). Returns an [invite](/docs/resources/invite#invite-object) object. Fires an [Invite Create](/docs/events/gateway-events#invite-create) Gateway event. @@ -464,14 +464,14 @@ Create a new [invite](/docs/resources/invite#invite-object) object for the chann | target_user_id | snowflake | the id of the user whose stream to display for this invite, required if `target_type` is 1, the user must be streaming in the channel | | | target_application_id | snowflake | the id of the embedded application to open for this invite, required if `target_type` is 2, the application must have the `EMBEDDED` flag | | -## Delete Channel Permission % DELETE /channels/{channel.id/docs/resources/channel#channel-object}/permissions/{overwrite.id/docs/resources/channel#overwrite-object} +## Delete Channel Permission % DELETE /channels/||FIXME||channel.id||/docs/resources/channel#channel-object||/permissions/||FIXME||overwrite.id||/docs/resources/channel#overwrite-object|| Delete a channel permission overwrite for a user or role in a channel. Only usable for guild channels. Requires the `MANAGE_ROLES` permission. Returns a 204 empty response on success. Fires a [Channel Update](/docs/events/gateway-events#channel-update) Gateway event. For more information about permissions, see [permissions](/docs/topics/permissions#permissions) > info > This endpoint supports the `X-Audit-Log-Reason` header. -## Follow Announcement Channel % POST /channels/{channel.id/docs/resources/channel#channel-object}/followers +## Follow Announcement Channel % POST /channels/||FIXME||channel.id||/docs/resources/channel#channel-object||/followers Follow an Announcement Channel to send messages to a target channel. Requires the `MANAGE_WEBHOOKS` permission in the target channel. Returns a [followed channel](/docs/resources/channel#followed-channel-object) object. Fires a [Webhooks Update](/docs/events/gateway-events#webhooks-update) Gateway event for the target channel. @@ -484,17 +484,17 @@ Follow an Announcement Channel to send messages to a target channel. Requires th |--------------------|-----------|----------------------| | webhook_channel_id | snowflake | id of target channel | -## Trigger Typing Indicator % POST /channels/{channel.id/docs/resources/channel#channel-object}/typing +## Trigger Typing Indicator % POST /channels/||FIXME||channel.id||/docs/resources/channel#channel-object||/typing Post a typing indicator for the specified channel, which expires after 10 seconds. Returns a 204 empty response on success. Fires a [Typing Start](/docs/events/gateway-events#typing-start) Gateway event. Generally bots should **not** use this route. However, if a bot is responding to a command and expects the computation to take a few seconds, this endpoint may be called to let the user know that the bot is processing their message. -## Get Pinned Messages % GET /channels/{channel.id/docs/resources/channel#channel-object}/pins +## Get Pinned Messages % GET /channels/||FIXME||channel.id||/docs/resources/channel#channel-object||/pins Returns all pinned messages in the channel as an array of [message](/docs/resources/message#message-object) objects. -## Pin Message % PUT /channels/{channel.id/docs/resources/channel#channel-object}/pins/{message.id/docs/resources/message#message-object} +## Pin Message % PUT /channels/||FIXME||channel.id||/docs/resources/channel#channel-object||/pins/||FIXME||message.id||/docs/resources/message#message-object|| Pin a message in a channel. Requires the `MANAGE_MESSAGES` permission. Returns a 204 empty response on success. Fires a [Channel Pins Update](/docs/events/gateway-events#channel-pins-update) Gateway event. @@ -504,14 +504,14 @@ Pin a message in a channel. Requires the `MANAGE_MESSAGES` permission. Returns a > info > This endpoint supports the `X-Audit-Log-Reason` header. -## Unpin Message % DELETE /channels/{channel.id/docs/resources/channel#channel-object}/pins/{message.id/docs/resources/message#message-object} +## Unpin Message % DELETE /channels/||FIXME||channel.id||/docs/resources/channel#channel-object||/pins/||FIXME||message.id||/docs/resources/message#message-object|| Unpin a message in a channel. Requires the `MANAGE_MESSAGES` permission. Returns a 204 empty response on success. Fires a [Channel Pins Update](/docs/events/gateway-events#channel-pins-update) Gateway event. > info > This endpoint supports the `X-Audit-Log-Reason` header. -## Group DM Add Recipient % PUT /channels/{channel.id/docs/resources/channel#channel-object}/recipients/{user.id/docs/resources/user#user-object} +## Group DM Add Recipient % PUT /channels/||FIXME||channel.id||/docs/resources/channel#channel-object||/recipients/||FIXME||user.id||/docs/resources/user#user-object|| Adds a recipient to a Group DM using their access token. @@ -522,11 +522,11 @@ Adds a recipient to a Group DM using their access token. | access_token | string | access token of a user that has granted your app the `gdm.join` scope | | nick | string | nickname of the user being added | -## Group DM Remove Recipient % DELETE /channels/{channel.id/docs/resources/channel#channel-object}/recipients/{user.id/docs/resources/user#user-object} +## Group DM Remove Recipient % DELETE /channels/||FIXME||channel.id||/docs/resources/channel#channel-object||/recipients/||FIXME||user.id||/docs/resources/user#user-object|| Removes a recipient from a Group DM. -## Start Thread from Message % POST /channels/{channel.id/docs/resources/channel#channel-object}/messages/{message.id/docs/resources/message#message-object}/threads +## Start Thread from Message % POST /channels/||FIXME||channel.id||/docs/resources/channel#channel-object||/messages/||FIXME||message.id||/docs/resources/message#message-object||/threads Creates a new thread from an existing message. Returns a [channel](/docs/resources/channel#channel-object) on success, and a 400 BAD REQUEST on invalid parameters. Fires a [Thread Create](/docs/events/gateway-events#thread-create) and a [Message Update](/docs/events/gateway-events#message-update) Gateway event. @@ -543,7 +543,7 @@ When called on a `GUILD_TEXT` channel, creates a `PUBLIC_THREAD`. When called on | auto_archive_duration? | integer | the thread will stop showing in the channel list after `auto_archive_duration` minutes of inactivity, can be set to: 60, 1440, 4320, 10080 | | rate_limit_per_user? | ?integer | amount of seconds a user has to wait before sending another message (0-21600) | -## Start Thread without Message % POST /channels/{channel.id/docs/resources/channel#channel-object}/threads +## Start Thread without Message % POST /channels/||FIXME||channel.id||/docs/resources/channel#channel-object||/threads Creates a new thread that is not connected to an existing message. Returns a [channel](/docs/resources/channel#channel-object) on success, and a 400 BAD REQUEST on invalid parameters. Fires a [Thread Create](/docs/events/gateway-events#thread-create) Gateway event. @@ -562,7 +562,7 @@ Creates a new thread that is not connected to an existing message. Returns a [ch \* `type` currently defaults to `PRIVATE_THREAD` in order to match the behavior when thread documentation was first published. In a future API version this will be changed to be a required field, with no default. -## Start Thread in Forum or Media Channel % POST /channels/{channel.id/docs/resources/channel#channel-object}/threads +## Start Thread in Forum or Media Channel % POST /channels/||FIXME||channel.id||/docs/resources/channel#channel-object||/threads Creates a new thread in a forum or a media channel, and sends a message within the created thread. Returns a [channel](/docs/resources/channel#channel-object), with a nested [message](/docs/resources/message#message-object) object, on success, and a 400 BAD REQUEST on invalid parameters. Fires a [Thread Create](/docs/events/gateway-events#thread-create) and [Message Create](/docs/events/gateway-events#message-create) Gateway event. @@ -611,23 +611,23 @@ Creates a new thread in a forum or a media channel, and sends a message within t \* At least one of `content`, `embeds`, `sticker_ids`, `components`, or `files[n]` is required. -## Join Thread % PUT /channels/{channel.id/docs/resources/channel#channel-object}/thread-members/@me +## Join Thread % PUT /channels/||FIXME||channel.id||/docs/resources/channel#channel-object||/thread-members/@me Adds the current user to a thread. Also requires the thread is not archived. Returns a 204 empty response on success. Fires a [Thread Members Update](/docs/events/gateway-events#thread-members-update) and a [Thread Create](/docs/events/gateway-events#thread-create) Gateway event. -## Add Thread Member % PUT /channels/{channel.id/docs/resources/channel#channel-object}/thread-members/{user.id/docs/resources/user#user-object} +## Add Thread Member % PUT /channels/||FIXME||channel.id||/docs/resources/channel#channel-object||/thread-members/||FIXME||user.id||/docs/resources/user#user-object|| Adds another member to a thread. Requires the ability to send messages in the thread. Also requires the thread is not archived. Returns a 204 empty response if the member is successfully added or was already a member of the thread. Fires a [Thread Members Update](/docs/events/gateway-events#thread-members-update) Gateway event. -## Leave Thread % DELETE /channels/{channel.id/docs/resources/channel#channel-object}/thread-members/@me +## Leave Thread % DELETE /channels/||FIXME||channel.id||/docs/resources/channel#channel-object||/thread-members/@me Removes the current user from a thread. Also requires the thread is not archived. Returns a 204 empty response on success. Fires a [Thread Members Update](/docs/events/gateway-events#thread-members-update) Gateway event. -## Remove Thread Member % DELETE /channels/{channel.id/docs/resources/channel#channel-object}/thread-members/{user.id/docs/resources/user#user-object} +## Remove Thread Member % DELETE /channels/||FIXME||channel.id||/docs/resources/channel#channel-object||/thread-members/||FIXME||user.id||/docs/resources/user#user-object|| Removes another member from a thread. Requires the `MANAGE_THREADS` permission, or the creator of the thread if it is a `PRIVATE_THREAD`. Also requires the thread is not archived. Returns a 204 empty response on success. Fires a [Thread Members Update](/docs/events/gateway-events#thread-members-update) Gateway event. -## Get Thread Member % GET /channels/{channel.id/docs/resources/channel#channel-object}/thread-members/{user.id/docs/resources/user#user-object} +## Get Thread Member % GET /channels/||FIXME||channel.id||/docs/resources/channel#channel-object||/thread-members/||FIXME||user.id||/docs/resources/user#user-object|| Returns a [thread member](/docs/resources/channel#thread-member-object) object for the specified user if they are a member of the thread, returns a 404 response otherwise. @@ -639,7 +639,7 @@ When `with_member` is set to `true`, the thread member object will include a `me |--------------|--------------------------------------------------|-------------------------------------------------------------------------------------------------------------| | with_member? | [boolean](/docs/reference#boolean-query-strings) | Whether to include a [guild member](/docs/resources/guild#guild-member-object) object for the thread member | -## List Thread Members % GET /channels/{channel.id/docs/resources/channel#channel-object}/thread-members +## List Thread Members % GET /channels/||FIXME||channel.id||/docs/resources/channel#channel-object||/thread-members > warn > Starting in API v11, this endpoint will always return paginated results. Paginated results can be enabled before API v11 by setting `with_member` to `true`. Read [the changelog](/docs/change-log#thread-member-details-and-pagination) for details. @@ -659,7 +659,7 @@ When `with_member` is set to `true`, the results will be paginated and each thre | after? | snowflake | Get thread members after this user ID | | limit? | integer | Max number of thread members to return (1-100). Defaults to 100. | -## List Public Archived Threads % GET /channels/{channel.id/docs/resources/channel#channel-object}/threads/archived/public +## List Public Archived Threads % GET /channels/||FIXME||channel.id||/docs/resources/channel#channel-object||/threads/archived/public Returns archived threads in the channel that are public. When called on a `GUILD_TEXT` channel, returns threads of [type](/docs/resources/channel#channel-object-channel-types) `PUBLIC_THREAD`. When called on a `GUILD_ANNOUNCEMENT` channel returns threads of [type](/docs/resources/channel#channel-object-channel-types) `ANNOUNCEMENT_THREAD`. Threads are ordered by `archive_timestamp`, in descending order. Requires the `READ_MESSAGE_HISTORY` permission. @@ -678,7 +678,7 @@ Returns archived threads in the channel that are public. When called on a `GUILD | members | array of [thread members](/docs/resources/channel#thread-member-object) objects | a thread member object for each returned thread the current user has joined | | has_more | boolean | whether there are potentially additional threads that could be returned on a subsequent call | -## List Private Archived Threads % GET /channels/{channel.id/docs/resources/channel#channel-object}/threads/archived/private +## List Private Archived Threads % GET /channels/||FIXME||channel.id||/docs/resources/channel#channel-object||/threads/archived/private Returns archived threads in the channel that are of [type](/docs/resources/channel#channel-object-channel-types) `PRIVATE_THREAD`. Threads are ordered by `archive_timestamp`, in descending order. Requires both the `READ_MESSAGE_HISTORY` and `MANAGE_THREADS` permissions. @@ -697,7 +697,7 @@ Returns archived threads in the channel that are of [type](/docs/resources/chann | members | array of [thread members](/docs/resources/channel#thread-member-object) objects | a thread member object for each returned thread the current user has joined | | has_more | boolean | whether there are potentially additional threads that could be returned on a subsequent call | -## List Joined Private Archived Threads % GET /channels/{channel.id/docs/resources/channel#channel-object}/users/@me/threads/archived/private +## List Joined Private Archived Threads % GET /channels/||FIXME||channel.id||/docs/resources/channel#channel-object||/users/@me/threads/archived/private Returns archived threads in the channel that are of [type](/docs/resources/channel#channel-object-channel-types) `PRIVATE_THREAD`, and the user has joined. Threads are ordered by their `id`, in descending order. Requires the `READ_MESSAGE_HISTORY` permission. diff --git a/docs/resources/emoji.md b/docs/resources/emoji.md index c38fc345bf..5033e0e0d9 100644 --- a/docs/resources/emoji.md +++ b/docs/resources/emoji.md @@ -88,15 +88,15 @@ The `user` field of an app emoji object represents the team member that uploaded } ``` -## List Guild Emojis % GET /guilds/{guild.id/docs/resources/guild#guild-object}/emojis +## List Guild Emojis % GET /guilds/||FIXME||guild.id||/docs/resources/guild#guild-object||/emojis Returns a list of [emoji](/docs/resources/emoji#emoji-object) objects for the given guild. Includes `user` fields if the bot has the `CREATE_GUILD_EXPRESSIONS` or `MANAGE_GUILD_EXPRESSIONS` permission. -## Get Guild Emoji % GET /guilds/{guild.id/docs/resources/guild#guild-object}/emojis/{emoji.id/docs/resources/emoji#emoji-object} +## Get Guild Emoji % GET /guilds/||FIXME||guild.id||/docs/resources/guild#guild-object||/emojis/||FIXME||emoji.id||/docs/resources/emoji#emoji-object|| Returns an [emoji](/docs/resources/emoji#emoji-object) object for the given guild and emoji IDs. Includes the `user` field if the bot has the `MANAGE_GUILD_EXPRESSIONS` permission, or if the bot created the emoji and has the the `CREATE_GUILD_EXPRESSIONS` permission. -## Create Guild Emoji % POST /guilds/{guild.id/docs/resources/guild#guild-object}/emojis +## Create Guild Emoji % POST /guilds/||FIXME||guild.id||/docs/resources/guild#guild-object||/emojis Create a new emoji for the guild. Requires the `CREATE_GUILD_EXPRESSIONS` permission. Returns the new [emoji](/docs/resources/emoji#emoji-object) object on success. Fires a [Guild Emojis Update](/docs/events/gateway-events#guild-emojis-update) Gateway event. @@ -114,7 +114,7 @@ Create a new emoji for the guild. Requires the `CREATE_GUILD_EXPRESSIONS` permis | image | [image data](/docs/reference#image-data) | the 128x128 emoji image | | roles | array of snowflakes | roles allowed to use this emoji | -## Modify Guild Emoji % PATCH /guilds/{guild.id/docs/resources/guild#guild-object}/emojis/{emoji.id/docs/resources/emoji#emoji-object} +## Modify Guild Emoji % PATCH /guilds/||FIXME||guild.id||/docs/resources/guild#guild-object||/emojis/||FIXME||emoji.id||/docs/resources/emoji#emoji-object|| Modify the given emoji. For emojis created by the current user, requires either the `CREATE_GUILD_EXPRESSIONS` or `MANAGE_GUILD_EXPRESSIONS` permission. For other emojis, requires the `MANAGE_GUILD_EXPRESSIONS` permission. Returns the updated [emoji](/docs/resources/emoji#emoji-object) object on success. Fires a [Guild Emojis Update](/docs/events/gateway-events#guild-emojis-update) Gateway event. @@ -131,14 +131,14 @@ Modify the given emoji. For emojis created by the current user, requires either | name | string | name of the emoji | | roles | ?array of snowflakes | roles allowed to use this emoji | -## Delete Guild Emoji % DELETE /guilds/{guild.id/docs/resources/guild#guild-object}/emojis/{emoji.id/docs/resources/emoji#emoji-object} +## Delete Guild Emoji % DELETE /guilds/||FIXME||guild.id||/docs/resources/guild#guild-object||/emojis/||FIXME||emoji.id||/docs/resources/emoji#emoji-object|| Delete the given emoji. For emojis created by the current user, requires either the `CREATE_GUILD_EXPRESSIONS` or `MANAGE_GUILD_EXPRESSIONS` permission. For other emojis, requires the `MANAGE_GUILD_EXPRESSIONS` permission. Returns `204 No Content` on success. Fires a [Guild Emojis Update](/docs/events/gateway-events#guild-emojis-update) Gateway event. > info > This endpoint supports the `X-Audit-Log-Reason` header. -## List Application Emojis % GET /applications/{application.id/docs/resources/application#application-object}/emojis +## List Application Emojis % GET /applications/||FIXME||application.id||/docs/resources/application#application-object||/emojis Returns an object containing a list of [emoji](/docs/resources/emoji#emoji-object) objects for the given application under the `items` key. Includes a `user` object for the team member that uploaded the emoji from the app's settings, or for the bot user if uploaded using the API. @@ -164,11 +164,11 @@ Returns an object containing a list of [emoji](/docs/resources/emoji#emoji-objec } ``` -## Get Application Emoji % GET /applications/{application.id/docs/resources/application#application-object}/emojis/{emoji.id/docs/resources/emoji#emoji-object} +## Get Application Emoji % GET /applications/||FIXME||application.id||/docs/resources/application#application-object||/emojis/||FIXME||emoji.id||/docs/resources/emoji#emoji-object|| Returns an [emoji](/docs/resources/emoji#emoji-object) object for the given application and emoji IDs. Includes the `user` field. -## Create Application Emoji % POST /applications/{application.id/docs/resources/application#application-object}/emojis +## Create Application Emoji % POST /applications/||FIXME||application.id||/docs/resources/application#application-object||/emojis Create a new emoji for the application. Returns the new [emoji](/docs/resources/emoji#emoji-object) object on success. @@ -182,7 +182,7 @@ Create a new emoji for the application. Returns the new [emoji](/docs/resources/ | name | string | name of the emoji | | image | [image data](/docs/reference#image-data) | the 128x128 emoji image | -## Modify Application Emoji % PATCH /applications/{application.id/docs/resources/application#application-object}/emojis/{emoji.id/docs/resources/emoji#emoji-object} +## Modify Application Emoji % PATCH /applications/||FIXME||application.id||/docs/resources/application#application-object||/emojis/||FIXME||emoji.id||/docs/resources/emoji#emoji-object|| Modify the given emoji. Returns the updated [emoji](/docs/resources/emoji#emoji-object) object on success. @@ -192,6 +192,6 @@ Modify the given emoji. Returns the updated [emoji](/docs/resources/emoji#emoji- |-------|--------|-------------------| | name | string | name of the emoji | -## Delete Application Emoji % DELETE /applications/{application.id/docs/resources/application#application-object}/emojis/{emoji.id/docs/resources/emoji#emoji-object} +## Delete Application Emoji % DELETE /applications/||FIXME||application.id||/docs/resources/application#application-object||/emojis/||FIXME||emoji.id||/docs/resources/emoji#emoji-object|| Delete the given emoji. Returns `204 No Content` on success. diff --git a/docs/resources/entitlement.md b/docs/resources/entitlement.md index 7e2ff0a84e..c5874ad9d5 100644 --- a/docs/resources/entitlement.md +++ b/docs/resources/entitlement.md @@ -58,7 +58,7 @@ Refer to the [Monetization Overview](/docs/monetization/overview) for more infor | PREMIUM_PURCHASE | 7 | Entitlement was claimed by user for free as a Nitro Subscriber | | APPLICATION_SUBSCRIPTION | 8 | Entitlement was purchased as an app subscription | -## List Entitlements % GET /applications/{application.id/docs/resources/application#application-object}/entitlements +## List Entitlements % GET /applications/||FIXME||application.id||/docs/resources/application#application-object||/entitlements Returns all entitlements for a given app, active and expired. @@ -95,7 +95,7 @@ Returns all entitlements for a given app, active and expired. ] ``` -## Get Entitlement % GET /applications/{application.id#DOS_RESOURCES_APPLICATION/application-object}/entitlements/{entitlement.id/docs/resources/entitlement#entitlement-object} +## Get Entitlement % GET /applications/||FIXME||application.id||/docs/resources/application#application-object||/entitlements/||FIXME||entitlement.id||/docs/resources/entitlement#entitlement-object|| Returns an entitlement. @@ -117,13 +117,13 @@ Returns an entitlement. } ``` -## Consume an Entitlement % POST /applications/{application.id/docs/resources/application#application-object}/entitlements/{entitlement.id/docs/resources/entitlement#entitlement-object}/consume +## Consume an Entitlement % POST /applications/||FIXME||application.id||/docs/resources/application#application-object||/entitlements/||FIXME||entitlement.id||/docs/resources/entitlement#entitlement-object||/consume For One-Time Purchase consumable SKUs, marks a given entitlement for the user as consumed. The entitlement will have `consumed: true` when using [List Entitlements](/docs/resources/entitlement#list-entitlements). Returns a `204 No Content` on success. -## Create Test Entitlement % POST /applications/{application.id/docs/resources/application#application-object}/entitlements +## Create Test Entitlement % POST /applications/||FIXME||application.id||/docs/resources/application#application-object||/entitlements Creates a test entitlement to a given SKU for a given guild or user. Discord will act as though that user or guild has entitlement to your premium offering. @@ -147,7 +147,7 @@ After creating a test entitlement, you'll need to reload your Discord client. Af } ``` -## Delete Test Entitlement % DELETE /applications/{application.id/docs/resources/application#application-object}/entitlements/{entitlement.id/docs/resources/entitlement#entitlement-object} +## Delete Test Entitlement % DELETE /applications/||FIXME||application.id||/docs/resources/application#application-object||/entitlements/||FIXME||entitlement.id||/docs/resources/entitlement#entitlement-object|| Deletes a currently-active test entitlement. Discord will act as though that user or guild _no longer has_ entitlement to your premium offering. diff --git a/docs/resources/guild-scheduled-event.mdx b/docs/resources/guild-scheduled-event.mdx index 6cc73f4f73..33abdb25a2 100644 --- a/docs/resources/guild-scheduled-event.mdx +++ b/docs/resources/guild-scheduled-event.mdx @@ -259,7 +259,7 @@ by_month_day = [24] | NOVEMBER | 11 | | DECEMBER | 12 | -## List Scheduled Events for Guild % GET /guilds/\{guild.id/docs/resources/guild#guild-object\}/scheduled-events +## List Scheduled Events for Guild % GET /guilds/||FIXME||guild.id||/docs/resources/guild#guild-object||/scheduled-events Returns a list of [guild scheduled event](/docs/resources/guild-scheduled-event#guild-scheduled-event-object) objects for the given guild. @@ -269,7 +269,7 @@ Returns a list of [guild scheduled event](/docs/resources/guild-scheduled-event# |------------------|--------------------------------------------------|--------------------------------------------------| | with_user_count? | [boolean](/docs/reference#boolean-query-strings) | include number of users subscribed to each event | -## Create Guild Scheduled Event % POST /guilds/\{guild.id/docs/resources/guild#guild-object\}/scheduled-events +## Create Guild Scheduled Event % POST /guilds/||FIXME||guild.id||/docs/resources/guild#guild-object||/scheduled-events Create a guild scheduled event in the guild. Returns a [guild scheduled event](/docs/resources/guild-scheduled-event#guild-scheduled-event-object) object on success. Fires a [Guild Scheduled Event Create](/docs/events/gateway-events#guild-scheduled-event-create) Gateway event. @@ -299,7 +299,7 @@ Create a guild scheduled event in the guild. Returns a [guild scheduled event](/ \*\* Required for events with `'entity_type': EXTERNAL` -## Get Guild Scheduled Event % GET /guilds/\{guild.id/docs/resources/guild#guild-object\}/scheduled-events/\{guild-scheduled-event.id/docs/resources/guild-scheduled-event#guild-scheduled-event-object\} +## Get Guild Scheduled Event % GET /guilds/||FIXME||guild.id||/docs/resources/guild#guild-object||/scheduled-events/||FIXME||guild_scheduled_event.id||/docs/resources/guild-scheduled-event#guild-scheduled-event-object|| Get a guild scheduled event. Returns a [guild scheduled event](/docs/resources/guild-scheduled-event#guild-scheduled-event-object) object on success. @@ -309,7 +309,7 @@ Get a guild scheduled event. Returns a [guild scheduled event](/docs/resources/g |------------------|--------------------------------------------------|--------------------------------------------------| | with_user_count? | [boolean](/docs/reference#boolean-query-strings) | include number of users subscribed to this event | -## Modify Guild Scheduled Event % PATCH /guilds/\{guild.id/docs/resources/guild#guild-object\}/scheduled-events/\{guild-scheduled-event.id/docs/resources/guild-scheduled-event#guild-scheduled-event-object\} +## Modify Guild Scheduled Event % PATCH /guilds/||FIXME||guild.id||/docs/resources/guild#guild-object||/scheduled-events/||FIXME||guild_scheduled_event.id||/docs/resources/guild-scheduled-event#guild-scheduled-event-object|| Modify a guild scheduled event. Returns the modified [guild scheduled event](/docs/resources/guild-scheduled-event#guild-scheduled-event-object) object on success. Fires a [Guild Scheduled Event Update](/docs/events/gateway-events#guild-scheduled-event-update) Gateway event. @@ -348,11 +348,11 @@ Modify a guild scheduled event. Returns the modified [guild scheduled event](/do - `entity_metadata` with a `location` field must be provided - `scheduled_end_time` must be provided -## Delete Guild Scheduled Event % DELETE /guilds/\{guild.id/docs/resources/guild#guild-object\}/scheduled-events/\{guild-scheduled-event.id/docs/resources/guild-scheduled-event#guild-scheduled-event-object\} +## Delete Guild Scheduled Event % DELETE /guilds/||FIXME||guild.id||/docs/resources/guild#guild-object||/scheduled-events/||FIXME||guild_scheduled_event.id||/docs/resources/guild-scheduled-event#guild-scheduled-event-object|| Delete a guild scheduled event. Returns a `204` on success. Fires a [Guild Scheduled Event Delete](/docs/events/gateway-events#guild-scheduled-event-delete) Gateway event. -## Get Guild Scheduled Event Users % GET /guilds/\{guild.id/docs/resources/guild#guild-object\}/scheduled-events/\{guild-scheduled-event.id/docs/resources/guild-scheduled-event#guild-scheduled-event-object\}/users +## Get Guild Scheduled Event Users % GET /guilds/||FIXME||guild.id||/docs/resources/guild#guild-object||/scheduled-events/||FIXME||guild_scheduled_event.id||/docs/resources/guild-scheduled-event#guild-scheduled-event-object||/users Get a list of guild scheduled event users subscribed to a guild scheduled event. Returns a list of [guild scheduled event user](/docs/resources/guild-scheduled-event#guild-scheduled-event-user-object) objects on success. Guild member data, if it exists, is included if the `with_member` query parameter is set. diff --git a/docs/resources/guild-template.md b/docs/resources/guild-template.md index 0f867e7fd5..19a842a04b 100644 --- a/docs/resources/guild-template.md +++ b/docs/resources/guild-template.md @@ -99,11 +99,11 @@ Represents a code that when used, creates a guild based on a snapshot of an exis } ``` -## Get Guild Template % GET /guilds/templates/{template.code/docs/resources/guild-template#guild-template-object} +## Get Guild Template % GET /guilds/templates/||FIXME||template.code||/docs/resources/guild-template#guild-template-object|| Returns a [guild template](/docs/resources/guild-template#guild-template-object) object for the given code. -## Create Guild from Guild Template % POST /guilds/templates/{template.code/docs/resources/guild-template#guild-template-object} +## Create Guild from Guild Template % POST /guilds/templates/||FIXME||template.code||/docs/resources/guild-template#guild-template-object|| Create a new guild based on a template. Returns a [guild](/docs/resources/guild#guild-object) object on success. Fires a [Guild Create](/docs/events/gateway-events#guild-create) Gateway event. @@ -117,11 +117,11 @@ Create a new guild based on a template. Returns a [guild](/docs/resources/guild# | name | string | name of the guild (2-100 characters) | | icon? | [image data](/docs/reference#image-data) | base64 128x128 image for the guild icon | -## Get Guild Templates % GET /guilds/{guild.id/docs/resources/guild#guild-object}/templates +## Get Guild Templates % GET /guilds/||FIXME||guild.id||/docs/resources/guild#guild-object||/templates Returns an array of [guild template](/docs/resources/guild-template#guild-template-object) objects. Requires the `MANAGE_GUILD` permission. -## Create Guild Template % POST /guilds/{guild.id/docs/resources/guild#guild-object}/templates +## Create Guild Template % POST /guilds/||FIXME||guild.id||/docs/resources/guild#guild-object||/templates Creates a template for the guild. Requires the `MANAGE_GUILD` permission. Returns the created [guild template](/docs/resources/guild-template#guild-template-object) object on success. @@ -132,11 +132,11 @@ Creates a template for the guild. Requires the `MANAGE_GUILD` permission. Return | name | string | name of the template (1-100 characters) | | description? | ?string | description for the template (0-120 characters) | -## Sync Guild Template % PUT /guilds/{guild.id/docs/resources/guild#guild-object}/templates/{template.code/docs/resources/guild-template#guild-template-object} +## Sync Guild Template % PUT /guilds/||FIXME||guild.id||/docs/resources/guild#guild-object||/templates/||FIXME||template.code||/docs/resources/guild-template#guild-template-object|| Syncs the template to the guild's current state. Requires the `MANAGE_GUILD` permission. Returns the [guild template](/docs/resources/guild-template#guild-template-object) object on success. -## Modify Guild Template % PATCH /guilds/{guild.id/docs/resources/guild#guild-object}/templates/{template.code/docs/resources/guild-template#guild-template-object} +## Modify Guild Template % PATCH /guilds/||FIXME||guild.id||/docs/resources/guild#guild-object||/templates/||FIXME||template.code||/docs/resources/guild-template#guild-template-object|| Modifies the template's metadata. Requires the `MANAGE_GUILD` permission. Returns the [guild template](/docs/resources/guild-template#guild-template-object) object on success. @@ -147,6 +147,6 @@ Modifies the template's metadata. Requires the `MANAGE_GUILD` permission. Return | name? | string | name of the template (1-100 characters) | | description? | ?string | description for the template (0-120 characters) | -## Delete Guild Template % DELETE /guilds/{guild.id/docs/resources/guild#guild-object}/templates/{template.code/docs/resources/guild-template#guild-template-object} +## Delete Guild Template % DELETE /guilds/||FIXME||guild.id||/docs/resources/guild#guild-object||/templates/||FIXME||template.code||/docs/resources/guild-template#guild-template-object|| Deletes the template. Requires the `MANAGE_GUILD` permission. Returns the deleted [guild template](/docs/resources/guild-template#guild-template-object) object on success. diff --git a/docs/resources/guild.md b/docs/resources/guild.md index fc84f33d22..5315462a8a 100644 --- a/docs/resources/guild.md +++ b/docs/resources/guild.md @@ -749,7 +749,7 @@ Create a new guild. Returns a [guild](/docs/resources/guild#guild-object) object } ``` -## Get Guild % GET /guilds/{guild.id/docs/resources/guild#guild-object} +## Get Guild % GET /guilds/||FIXME||guild.id||/docs/resources/guild#guild-object|| Returns the [guild](/docs/resources/guild#guild-object) object for the given id. If `with_counts` is set to `true`, this endpoint will also return `approximate_member_count` and `approximate_presence_count` for the guild. @@ -830,12 +830,12 @@ Returns the [guild](/docs/resources/guild#guild-object) object for the given id. } ``` -## Get Guild Preview % GET /guilds/{guild.id/docs/resources/guild#guild-object}/preview +## Get Guild Preview % GET /guilds/||FIXME||guild.id||/docs/resources/guild#guild-object||/preview Returns the [guild preview](/docs/resources/guild#guild-preview-object) object for the given id. If the user is not in the guild, then the guild must be [discoverable](/docs/resources/guild#guild-object-guild-features). -## Modify Guild % PATCH /guilds/{guild.id/docs/resources/guild#guild-object} +## Modify Guild % PATCH /guilds/||FIXME||guild.id||/docs/resources/guild#guild-object|| Modify a guild's settings. Requires the `MANAGE_GUILD` permission. Returns the updated [guild](/docs/resources/guild#guild-object) object on success. Fires a [Guild Update](/docs/events/gateway-events#guild-update) Gateway event. @@ -874,15 +874,15 @@ Modify a guild's settings. Requires the `MANAGE_GUILD` permission. Returns the u | premium_progress_bar_enabled | boolean | whether the guild's boost progress bar should be enabled | | safety_alerts_channel_id | ?snowflake | the id of the channel where admins and moderators of Community guilds receive safety alerts from Discord | -## Delete Guild % DELETE /guilds/{guild.id/docs/resources/guild#guild-object} +## Delete Guild % DELETE /guilds/||FIXME||guild.id||/docs/resources/guild#guild-object|| Delete a guild permanently. User must be owner. Returns `204 No Content` on success. Fires a [Guild Delete](/docs/events/gateway-events#guild-delete) Gateway event. -## Get Guild Channels % GET /guilds/{guild.id/docs/resources/guild#guild-object}/channels +## Get Guild Channels % GET /guilds/||FIXME||guild.id||/docs/resources/guild#guild-object||/channels Returns a list of guild [channel](/docs/resources/channel#channel-object) objects. Does not include threads. -## Create Guild Channel % POST /guilds/{guild.id/docs/resources/guild#guild-object}/channels +## Create Guild Channel % POST /guilds/||FIXME||guild.id||/docs/resources/guild#guild-object||/channels Create a new [channel](/docs/resources/channel#channel-object) object for the guild. Requires the `MANAGE_CHANNELS` permission. If setting permission overwrites, only permissions your bot has in the guild can be allowed/denied. Setting `MANAGE_ROLES` permission in channels is only possible for guild administrators. Returns the new [channel](/docs/resources/channel#channel-object) object on success. Fires a [Channel Create](/docs/events/gateway-events#channel-create) Gateway event. @@ -919,7 +919,7 @@ Create a new [channel](/docs/resources/channel#channel-object) object for the gu \*\* In each overwrite object, the `allow` and `deny` keys can be omitted or set to `null`, which both default to `"0"`. -## Modify Guild Channel Positions % PATCH /guilds/{guild.id/docs/resources/guild#guild-object}/channels +## Modify Guild Channel Positions % PATCH /guilds/||FIXME||guild.id||/docs/resources/guild#guild-object||/channels Modify the positions of a set of [channel](/docs/resources/channel#channel-object) objects for the guild. Requires `MANAGE_CHANNELS` permission. Returns a 204 empty response on success. Fires multiple [Channel Update](/docs/events/gateway-events#channel-update) Gateway events. @@ -937,7 +937,7 @@ This endpoint takes a JSON array of parameters in the following format: | lock_permissions? | ?boolean | syncs the permission overwrites with the new parent, if moving to a new category | | parent_id? | ?snowflake | the new parent ID for the channel that is moved | -## List Active Guild Threads % GET /guilds/{guild.id/docs/resources/guild#guild-object}/threads/active +## List Active Guild Threads % GET /guilds/||FIXME||guild.id||/docs/resources/guild#guild-object||/threads/active Returns all active threads in the guild, including public and private threads. Threads are ordered by their `id`, in descending order. @@ -948,11 +948,11 @@ Returns all active threads in the guild, including public and private threads. T | threads | array of [channel](/docs/resources/channel#channel-object) objects | the active threads | | members | array of [thread members](/docs/resources/channel#thread-member-object) objects | a thread member object for each returned thread the current user has joined | -## Get Guild Member % GET /guilds/{guild.id/docs/resources/guild#guild-object}/members/{user.id/docs/resources/user#user-object} +## Get Guild Member % GET /guilds/||FIXME||guild.id||/docs/resources/guild#guild-object||/members/||FIXME||user.id||/docs/resources/user#user-object|| Returns a [guild member](/docs/resources/guild#guild-member-object) object for the specified user. -## List Guild Members % GET /guilds/{guild.id/docs/resources/guild#guild-object}/members +## List Guild Members % GET /guilds/||FIXME||guild.id||/docs/resources/guild#guild-object||/members Returns a list of [guild member](/docs/resources/guild#guild-member-object) objects that are members of the guild. @@ -969,7 +969,7 @@ Returns a list of [guild member](/docs/resources/guild#guild-member-object) obje | limit | integer | max number of members to return (1-1000) | 1 | | after | snowflake | the highest user id in the previous page | 0 | -## Search Guild Members % GET /guilds/{guild.id/docs/resources/guild#guild-object}/members/search +## Search Guild Members % GET /guilds/||FIXME||guild.id||/docs/resources/guild#guild-object||/members/search Returns a list of [guild member](/docs/resources/guild#guild-member-object) objects whose username or nickname starts with a provided string. @@ -983,7 +983,7 @@ Returns a list of [guild member](/docs/resources/guild#guild-member-object) obje | query | string | Query string to match username(s) and nickname(s) against. | | | limit | integer | max number of members to return (1-1000) | 1 | -## Add Guild Member % PUT /guilds/{guild.id/docs/resources/guild#guild-object}/members/{user.id/docs/resources/user#user-object} +## Add Guild Member % PUT /guilds/||FIXME||guild.id||/docs/resources/guild#guild-object||/members/||FIXME||user.id||/docs/resources/user#user-object|| Adds a user to the guild, provided you have a valid oauth2 access token for the user with the `guilds.join` scope. Returns a 201 Created with the [guild member](/docs/resources/guild#guild-member-object) as the body, or 204 No Content if the user is already a member of the guild. Fires a [Guild Member Add](/docs/events/gateway-events#guild-member-add) Gateway event. @@ -1006,7 +1006,7 @@ For guilds with [Membership Screening](/docs/resources/guild#membership-screenin | deaf | boolean | whether the user is deafened in voice channels | DEAFEN_MEMBERS | -## Modify Guild Member % PATCH /guilds/{guild.id/docs/resources/guild#guild-object}/members/{user.id/docs/resources/user#user-object} +## Modify Guild Member % PATCH /guilds/||FIXME||guild.id||/docs/resources/guild#guild-object||/members/||FIXME||user.id||/docs/resources/user#user-object|| Modify attributes of a [guild member](/docs/resources/guild#guild-member-object). Returns a 200 OK with the [guild member](/docs/resources/guild#guild-member-object) as the body. Fires a [Guild Member Update](/docs/events/gateway-events#guild-member-update) Gateway event. If the `channel_id` is set to null, this will force the target user to be disconnected from voice. @@ -1028,7 +1028,7 @@ Modify attributes of a [guild member](/docs/resources/guild#guild-member-object) | communication_disabled_until | ISO8601 timestamp | when the user's [timeout](https://support.discord.com/hc/en-us/articles/4413305239191-Time-Out-FAQ) will expire and the user will be able to communicate in the guild again (up to 28 days in the future), set to null to remove timeout. Will throw a 403 error if the user has the ADMINISTRATOR permission or is the owner of the guild | MODERATE_MEMBERS | | flags | integer | [guild member flags](/docs/resources/guild#guild-member-object-guild-member-flags) | MANAGE_GUILD or MANAGE_ROLES or (MODERATE_MEMBERS and KICK_MEMBERS and BAN_MEMBERS) | -## Modify Current Member % PATCH /guilds/{guild.id/docs/resources/guild#guild-object}/members/@me +## Modify Current Member % PATCH /guilds/||FIXME||guild.id||/docs/resources/guild#guild-object||/members/@me Modifies the current member in a guild. Returns a 200 with the updated member object on success. Fires a [Guild Member Update](/docs/events/gateway-events#guild-member-update) Gateway event. @@ -1041,7 +1041,7 @@ Modifies the current member in a guild. Returns a 200 with the updated member ob |-------|---------|---------------------------------|-----------------| | nick? | ?string | value to set user's nickname to | CHANGE_NICKNAME | -## Modify Current User Nick % PATCH /guilds/{guild.id/docs/resources/guild#guild-object}/members/@me/nick +## Modify Current User Nick % PATCH /guilds/||FIXME||guild.id||/docs/resources/guild#guild-object||/members/@me/nick > danger > Deprecated in favor of [Modify Current Member](/docs/resources/guild#modify-current-member). @@ -1057,28 +1057,28 @@ Modifies the nickname of the current user in a guild. Returns a 200 with the nic |-------|---------|---------------------------------|-----------------| | nick? | ?string | value to set user's nickname to | CHANGE_NICKNAME | -## Add Guild Member Role % PUT /guilds/{guild.id/docs/resources/guild#guild-object}/members/{user.id/docs/resources/user#user-object}/roles/{role.id/docs/topics/permissions#role-object} +## Add Guild Member Role % PUT /guilds/||FIXME||guild.id||/docs/resources/guild#guild-object||/members/||FIXME||user.id||/docs/resources/user#user-object||/roles/||FIXME||role.id||/docs/topics/permissions#role-object|| Adds a role to a [guild member](/docs/resources/guild#guild-member-object). Requires the `MANAGE_ROLES` permission. Returns a 204 empty response on success. Fires a [Guild Member Update](/docs/events/gateway-events#guild-member-update) Gateway event. > info > This endpoint supports the `X-Audit-Log-Reason` header. -## Remove Guild Member Role % DELETE /guilds/{guild.id/docs/resources/guild#guild-object}/members/{user.id/docs/resources/user#user-object}/roles/{role.id/docs/topics/permissions#role-object} +## Remove Guild Member Role % DELETE /guilds/||FIXME||guild.id||/docs/resources/guild#guild-object||/members/||FIXME||user.id||/docs/resources/user#user-object||/roles/||FIXME||role.id||/docs/topics/permissions#role-object|| Removes a role from a [guild member](/docs/resources/guild#guild-member-object). Requires the `MANAGE_ROLES` permission. Returns a 204 empty response on success. Fires a [Guild Member Update](/docs/events/gateway-events#guild-member-update) Gateway event. > info > This endpoint supports the `X-Audit-Log-Reason` header. -## Remove Guild Member % DELETE /guilds/{guild.id/docs/resources/guild#guild-object}/members/{user.id/docs/resources/user#user-object} +## Remove Guild Member % DELETE /guilds/||FIXME||guild.id||/docs/resources/guild#guild-object||/members/||FIXME||user.id||/docs/resources/user#user-object|| Remove a member from a guild. Requires `KICK_MEMBERS` permission. Returns a 204 empty response on success. Fires a [Guild Member Remove](/docs/events/gateway-events#guild-member-remove) Gateway event. > info > This endpoint supports the `X-Audit-Log-Reason` header. -## Get Guild Bans % GET /guilds/{guild.id/docs/resources/guild#guild-object}/bans +## Get Guild Bans % GET /guilds/||FIXME||guild.id||/docs/resources/guild#guild-object||/bans Returns a list of [ban](/docs/resources/guild#ban-object) objects for the users banned from this guild. Requires the `BAN_MEMBERS` permission. @@ -1092,11 +1092,11 @@ Returns a list of [ban](/docs/resources/guild#ban-object) objects for the users \* Provide a user id to `before` and `after` for pagination. Users will always be returned in ascending order by `user.id`. If both `before` and `after` are provided, only `before` is respected. -## Get Guild Ban % GET /guilds/{guild.id/docs/resources/guild#guild-object}/bans/{user.id/docs/resources/user#user-object} +## Get Guild Ban % GET /guilds/||FIXME||guild.id||/docs/resources/guild#guild-object||/bans/||FIXME||user.id||/docs/resources/user#user-object|| Returns a [ban](/docs/resources/guild#ban-object) object for the given user or a 404 not found if the ban cannot be found. Requires the `BAN_MEMBERS` permission. -## Create Guild Ban % PUT /guilds/{guild.id/docs/resources/guild#guild-object}/bans/{user.id/docs/resources/user#user-object} +## Create Guild Ban % PUT /guilds/||FIXME||guild.id||/docs/resources/guild#guild-object||/bans/||FIXME||user.id||/docs/resources/user#user-object|| Create a guild ban, and optionally delete previous messages sent by the banned user. Requires the `BAN_MEMBERS` permission. Returns a 204 empty response on success. Fires a [Guild Ban Add](/docs/events/gateway-events#guild-ban-add) Gateway event. @@ -1110,14 +1110,14 @@ Create a guild ban, and optionally delete previous messages sent by the banned u | delete_message_days? | integer | number of days to delete messages for (0-7) (deprecated) | 0 | | delete_message_seconds? | integer | number of seconds to delete messages for, between 0 and 604800 (7 days) | 0 | -## Remove Guild Ban % DELETE /guilds/{guild.id/docs/resources/guild#guild-object}/bans/{user.id/docs/resources/user#user-object} +## Remove Guild Ban % DELETE /guilds/||FIXME||guild.id||/docs/resources/guild#guild-object||/bans/||FIXME||user.id||/docs/resources/user#user-object|| Remove the ban for a user. Requires the `BAN_MEMBERS` permissions. Returns a 204 empty response on success. Fires a [Guild Ban Remove](/docs/events/gateway-events#guild-ban-remove) Gateway event. > info > This endpoint supports the `X-Audit-Log-Reason` header. -## Bulk Guild Ban % POST /guilds/{guild.id/docs/resources/guild#guild-object}/bulk-ban +## Bulk Guild Ban % POST /guilds/||FIXME||guild.id||/docs/resources/guild#guild-object||/bulk-ban Ban up to 200 users from a guild, and optionally delete previous messages sent by the banned users. Requires both the `BAN_MEMBERS` and `MANAGE_GUILD` permissions. Returns a 200 response on success, including the fields `banned_users` with the IDs of the banned users and `failed_users` with IDs that could not be banned or were already banned. @@ -1143,15 +1143,15 @@ On success, this endpoint returns a 200 success response with the following body > info > If none of the users could be banned, an error response code `500000: Failed to ban users` is returned instead. -## Get Guild Roles % GET /guilds/{guild.id/docs/resources/guild#guild-object}/roles +## Get Guild Roles % GET /guilds/||FIXME||guild.id||/docs/resources/guild#guild-object||/roles Returns a list of [role](/docs/topics/permissions#role-object) objects for the guild. -## Get Guild Role % GET /guilds/{guild.id/docs/resources/guild#guild-object}/roles/{role.id/docs/topics/permissions#role-object} +## Get Guild Role % GET /guilds/||FIXME||guild.id||/docs/resources/guild#guild-object||/roles/||FIXME||role.id||/docs/topics/permissions#role-object|| Returns a [role](/docs/topics/permissions#role-object) object for the specified role. -## Create Guild Role % POST /guilds/{guild.id/docs/resources/guild#guild-object}/roles +## Create Guild Role % POST /guilds/||FIXME||guild.id||/docs/resources/guild#guild-object||/roles Create a new [role](/docs/topics/permissions#role-object) for the guild. Requires the `MANAGE_ROLES` permission. Returns the new [role](/docs/topics/permissions#role-object) object on success. Fires a [Guild Role Create](/docs/events/gateway-events#guild-role-create) Gateway event. All JSON params are optional. @@ -1170,7 +1170,7 @@ Create a new [role](/docs/topics/permissions#role-object) for the guild. Require | unicode_emoji | ?string | the role's unicode emoji as a [standard emoji](/docs/reference#message-formatting) (if the guild has the `ROLE_ICONS` feature) | null | | mentionable | boolean | whether the role should be mentionable | false | -## Modify Guild Role Positions % PATCH /guilds/{guild.id/docs/resources/guild#guild-object}/roles +## Modify Guild Role Positions % PATCH /guilds/||FIXME||guild.id||/docs/resources/guild#guild-object||/roles Modify the positions of a set of [role](/docs/topics/permissions#role-object) objects for the guild. Requires the `MANAGE_ROLES` permission. Returns a list of all of the guild's [role](/docs/topics/permissions#role-object) objects on success. Fires multiple [Guild Role Update](/docs/events/gateway-events#guild-role-update) Gateway events. @@ -1186,7 +1186,7 @@ This endpoint takes a JSON array of parameters in the following format: | id | snowflake | role | | position? | ?integer | sorting position of the role (roles with the same position are sorted by id) | -## Modify Guild Role % PATCH /guilds/{guild.id/docs/resources/guild#guild-object}/roles/{role.id/docs/topics/permissions#role-object} +## Modify Guild Role % PATCH /guilds/||FIXME||guild.id||/docs/resources/guild#guild-object||/roles/||FIXME||role.id||/docs/topics/permissions#role-object|| Modify a guild role. Requires the `MANAGE_ROLES` permission. Returns the updated [role](/docs/topics/permissions#role-object) on success. Fires a [Guild Role Update](/docs/events/gateway-events#guild-role-update) Gateway event. @@ -1208,7 +1208,7 @@ Modify a guild role. Requires the `MANAGE_ROLES` permission. Returns the updated | unicode_emoji | string | the role's unicode emoji as a [standard emoji](/docs/reference#message-formatting) (if the guild has the `ROLE_ICONS` feature) | | mentionable | boolean | whether the role should be mentionable | -## Modify Guild MFA Level % POST /guilds/{guild.id/docs/resources/guild#guild-object}/mfa +## Modify Guild MFA Level % POST /guilds/||FIXME||guild.id||/docs/resources/guild#guild-object||/mfa Modify a guild's MFA level. Requires guild ownership. Returns the updated [level](/docs/resources/guild#guild-object-mfa-level) on success. Fires a [Guild Update](/docs/events/gateway-events#guild-update) Gateway event. @@ -1221,14 +1221,14 @@ Modify a guild's MFA level. Requires guild ownership. Returns the updated [level |-------|---------|-----------------------------------------------------------| | level | integer | [MFA level](/docs/resources/guild#guild-object-mfa-level) | -## Delete Guild Role % DELETE /guilds/{guild.id/docs/resources/guild#guild-object}/roles/{role.id/docs/topics/permissions#role-object} +## Delete Guild Role % DELETE /guilds/||FIXME||guild.id||/docs/resources/guild#guild-object||/roles/||FIXME||role.id||/docs/topics/permissions#role-object|| Delete a guild role. Requires the `MANAGE_ROLES` permission. Returns a 204 empty response on success. Fires a [Guild Role Delete](/docs/events/gateway-events#guild-role-delete) Gateway event. > info > This endpoint supports the `X-Audit-Log-Reason` header. -## Get Guild Prune Count % GET /guilds/{guild.id/docs/resources/guild#guild-object}/prune +## Get Guild Prune Count % GET /guilds/||FIXME||guild.id||/docs/resources/guild#guild-object||/prune Returns an object with one `pruned` key indicating the number of members that would be removed in a prune operation. Requires the `MANAGE_GUILD` and `KICK_MEMBERS` permissions. @@ -1241,7 +1241,7 @@ By default, prune will not remove users with roles. You can optionally include s | days | integer | number of days to count prune for (1-30) | 7 | | include_roles | string; comma-delimited array of snowflakes | role(s) to include | none | -## Begin Guild Prune % POST /guilds/{guild.id/docs/resources/guild#guild-object}/prune +## Begin Guild Prune % POST /guilds/||FIXME||guild.id||/docs/resources/guild#guild-object||/prune Begin a prune operation. Requires the `MANAGE_GUILD` and `KICK_MEMBERS` permissions. Returns an object with one `pruned` key indicating the number of members that were removed in the prune operation. For large guilds it's recommended to set the `compute_prune_count` option to `false`, forcing `pruned` to `null`. Fires multiple [Guild Member Remove](/docs/events/gateway-events#guild-member-remove) Gateway events. @@ -1259,44 +1259,44 @@ By default, prune will not remove users with roles. You can optionally include s | include_roles | array of snowflakes | role(s) to include | none | | reason? | string | reason for the prune (deprecated) | | -## Get Guild Voice Regions % GET /guilds/{guild.id/docs/resources/guild#guild-object}/regions +## Get Guild Voice Regions % GET /guilds/||FIXME||guild.id||/docs/resources/guild#guild-object||/regions Returns a list of [voice region](/docs/resources/voice#voice-region-object) objects for the guild. Unlike the similar `/voice` route, this returns VIP servers when the guild is VIP-enabled. -## Get Guild Invites % GET /guilds/{guild.id/docs/resources/guild#guild-object}/invites +## Get Guild Invites % GET /guilds/||FIXME||guild.id||/docs/resources/guild#guild-object||/invites Returns a list of [invite](/docs/resources/invite#invite-object) objects (with [invite metadata](/docs/resources/invite#invite-metadata-object)) for the guild. Requires the `MANAGE_GUILD` permission. -## Get Guild Integrations % GET /guilds/{guild.id/docs/resources/guild#guild-object}/integrations +## Get Guild Integrations % GET /guilds/||FIXME||guild.id||/docs/resources/guild#guild-object||/integrations Returns a list of [integration](/docs/resources/guild#integration-object) objects for the guild. Requires the `MANAGE_GUILD` permission. > info > This endpoint returns a maximum of 50 integrations. If a guild has more integrations, they cannot be accessed. -## Delete Guild Integration % DELETE /guilds/{guild.id/docs/resources/guild#guild-object}/integrations/{integration.id/docs/resources/guild#integration-object} +## Delete Guild Integration % DELETE /guilds/||FIXME||guild.id||/docs/resources/guild#guild-object||/integrations/||FIXME||integration.id||/docs/resources/guild#integration-object|| Delete the attached [integration](/docs/resources/guild#integration-object) object for the guild. Deletes any associated webhooks and kicks the associated bot if there is one. Requires the `MANAGE_GUILD` permission. Returns a 204 empty response on success. Fires [Guild Integrations Update](/docs/events/gateway-events#guild-integrations-update) and [Integration Delete](/docs/events/gateway-events#integration-delete) Gateway events. > info > This endpoint supports the `X-Audit-Log-Reason` header. -## Get Guild Widget Settings % GET /guilds/{guild.id/docs/resources/guild#guild-object}/widget +## Get Guild Widget Settings % GET /guilds/||FIXME||guild.id||/docs/resources/guild#guild-object||/widget Returns a [guild widget settings](/docs/resources/guild#guild-widget-settings-object) object. Requires the `MANAGE_GUILD` permission. -## Modify Guild Widget % PATCH /guilds/{guild.id/docs/resources/guild#guild-object}/widget +## Modify Guild Widget % PATCH /guilds/||FIXME||guild.id||/docs/resources/guild#guild-object||/widget Modify a [guild widget settings](/docs/resources/guild#guild-widget-settings-object) object for the guild. All attributes may be passed in with JSON and modified. Requires the `MANAGE_GUILD` permission. Returns the updated [guild widget settings](/docs/resources/guild#guild-widget-settings-object) object. Fires a [Guild Update](/docs/events/gateway-events#guild-update) Gateway event. > info > This endpoint supports the `X-Audit-Log-Reason` header. -## Get Guild Widget % GET /guilds/{guild.id/docs/resources/guild#guild-object}/widget.json +## Get Guild Widget % GET /guilds/||FIXME||guild.id||/docs/resources/guild#guild-object||/widget.json Returns the [widget](/docs/resources/guild#guild-widget-object) for the guild. Fires an [Invite Create](/docs/events/gateway-events#invite-create) Gateway event when an invite channel is defined and a new [Invite](/docs/resources/invite#invite-object) is generated. -## Get Guild Vanity URL % GET /guilds/{guild.id/docs/resources/guild#guild-object}/vanity-url +## Get Guild Vanity URL % GET /guilds/||FIXME||guild.id||/docs/resources/guild#guild-object||/vanity-url Returns a partial [invite](/docs/resources/invite#invite-object) object for guilds with that feature enabled. Requires the `MANAGE_GUILD` permission. `code` will be null if a vanity url for the guild is not set. @@ -1312,7 +1312,7 @@ Returns a partial [invite](/docs/resources/invite#invite-object) object for guil } ``` -## Get Guild Widget Image % GET /guilds/{guild.id/docs/resources/guild#guild-object}/widget.png +## Get Guild Widget Image % GET /guilds/||FIXME||guild.id||/docs/resources/guild#guild-object||/widget.png Returns a PNG image widget for the guild. Requires no permissions or authentication. @@ -1335,11 +1335,11 @@ Returns a PNG image widget for the guild. Requires no permissions or authenticat | banner3 | large image with guild icon, name and online count. In the footer, Discord logo on the left and "Chat Now" on the right | [Example](https://discord.com/api/guilds/81384788765712384/widget.png?style=banner3) | | banner4 | large Discord logo at the top of the widget. Guild icon, name and online count in the middle portion of the widget and a "JOIN MY SERVER" button at the bottom | [Example](https://discord.com/api/guilds/81384788765712384/widget.png?style=banner4) | -## Get Guild Welcome Screen % GET /guilds/{guild.id/docs/resources/guild#guild-object}/welcome-screen +## Get Guild Welcome Screen % GET /guilds/||FIXME||guild.id||/docs/resources/guild#guild-object||/welcome-screen Returns the [Welcome Screen](/docs/resources/guild#welcome-screen-object) object for the guild. If the welcome screen is not enabled, the `MANAGE_GUILD` permission is required. -## Modify Guild Welcome Screen % PATCH /guilds/{guild.id/docs/resources/guild#guild-object}/welcome-screen +## Modify Guild Welcome Screen % PATCH /guilds/||FIXME||guild.id||/docs/resources/guild#guild-object||/welcome-screen Modify the guild's [Welcome Screen](/docs/resources/guild#welcome-screen-object). Requires the `MANAGE_GUILD` permission. Returns the updated [Welcome Screen](/docs/resources/guild#welcome-screen-object) object. May fire a [Guild Update](/docs/events/gateway-events#guild-update) Gateway event. @@ -1357,11 +1357,11 @@ Modify the guild's [Welcome Screen](/docs/resources/guild#welcome-screen-object) | welcome_channels | array of [welcome screen channel](/docs/resources/guild#welcome-screen-object-welcome-screen-channel-structure) objects | channels linked in the welcome screen and their display options | | description | string | the server description to show in the welcome screen | -## Get Guild Onboarding % GET /guilds/{guild.id/docs/resources/guild#guild-object}/onboarding +## Get Guild Onboarding % GET /guilds/||FIXME||guild.id||/docs/resources/guild#guild-object||/onboarding Returns the [Onboarding](/docs/resources/guild#guild-onboarding-object) object for the guild. -## Modify Guild Onboarding % PUT /guilds/{guild.id/docs/resources/guild#guild-object}/onboarding +## Modify Guild Onboarding % PUT /guilds/||FIXME||guild.id||/docs/resources/guild#guild-object||/onboarding Modifies the onboarding configuration of the guild. Returns a 200 with the [Onboarding](/docs/resources/guild#guild-onboarding-object) object for the guild. Requires the `MANAGE_GUILD` and `MANAGE_ROLES` permissions. @@ -1380,7 +1380,7 @@ Modifies the onboarding configuration of the guild. Returns a 200 with the [Onbo | enabled | boolean | Whether onboarding is enabled in the guild | | mode | [onboarding mode](/docs/resources/guild#guild-onboarding-object-onboarding-mode) | Current mode of onboarding | -## Modify Guild Incident Actions % PUT /guilds/{guild.id/docs/resources/guild#guild-object}/incident-actions +## Modify Guild Incident Actions % PUT /guilds/||FIXME||guild.id||/docs/resources/guild#guild-object||/incident-actions Modifies the incident actions of the guild. Returns a 200 with the [Incidents Data](/docs/resources/guild#incidents-data-object) object for the guild. Requires the `MANAGE_GUILD` permission. diff --git a/docs/resources/invite.md b/docs/resources/invite.md index 02ffbd7400..c61f625ad9 100644 --- a/docs/resources/invite.md +++ b/docs/resources/invite.md @@ -144,7 +144,7 @@ Extra information about an invite, will extend the [invite](/docs/resources/invi } ``` -## Get Invite % GET /invites/{invite.code/docs/resources/invite#invite-object} +## Get Invite % GET /invites/||FIXME||invite.code||/docs/resources/invite#invite-object|| Returns an [invite](/docs/resources/invite#invite-object) object for the given code. @@ -156,7 +156,7 @@ Returns an [invite](/docs/resources/invite#invite-object) object for the given c | with_expiration? | [boolean](/docs/reference#boolean-query-strings) | whether the invite should contain the expiration date | | guild_scheduled_event_id? | snowflake | the guild scheduled event to include with the invite | -## Delete Invite % DELETE /invites/{invite.code/docs/resources/invite#invite-object} +## Delete Invite % DELETE /invites/||FIXME||invite.code||/docs/resources/invite#invite-object|| Delete an invite. Requires the `MANAGE_CHANNELS` permission on the channel this invite belongs to, or `MANAGE_GUILD` to remove any invite across the guild. Returns an [invite](/docs/resources/invite#invite-object) object on success. Fires an [Invite Delete](/docs/events/gateway-events#invite-delete) Gateway event. diff --git a/docs/resources/lobby.md b/docs/resources/lobby.md index 54bdf41a89..547b1700fa 100644 --- a/docs/resources/lobby.md +++ b/docs/resources/lobby.md @@ -81,11 +81,11 @@ Returns a [lobby](/docs/resources/lobby#lobby-object) object. | metadata? | ?dict | optional dictionary of string key/value pairs. The max total length is 1000. | | flags? | integer | [lobby member flags](/docs/resources/lobby#lobby-member-object-lobby-member-flags) combined as a [bitfield](https://en.wikipedia.org/wiki/Bit_field) | -## Get Lobby % GET /lobbies/{lobby.id/docs/resources/lobby#lobby-object} +## Get Lobby % GET /lobbies/||FIXME||lobby.id||/docs/resources/lobby#lobby-object|| Returns a [lobby](/docs/resources/lobby#lobby-object) object for the specified lobby id, if it exists. -## Modify Lobby % PATCH /lobbies/{lobby.id/docs/resources/lobby#lobby-object} +## Modify Lobby % PATCH /lobbies/||FIXME||lobby.id||/docs/resources/lobby#lobby-object|| Modifies the specified lobby with new values, if provided. @@ -99,7 +99,7 @@ Returns the updated [lobby](/docs/resources/lobby#lobby-object) object. | members? | array of [lobby member](/docs/resources/lobby#lobby-member-object) objects | optional array of up to 25 users to replace the lobby members with. If provided, lobby members not in this list will be removed from the lobby. | | idle_timeout_seconds? | integer | seconds to wait before shutting down a lobby after it becomes idle. Value can be between 5 and 604800 (7 days). See [`LobbyHandle`] for more details on this behavior. | -## Delete Lobby % DELETE /lobbies/{lobby.id/docs/resources/lobby#lobby-object} +## Delete Lobby % DELETE /lobbies/||FIXME||lobby.id||/docs/resources/lobby#lobby-object|| Deletes the specified lobby if it exists. @@ -107,7 +107,7 @@ It is safe to call even if the lobby is already deleted as well. Returns nothing. -## Add a Member to a Lobby % PUT /lobbies/{lobby.id/docs/resources/lobby#lobby-object}/members/{user.id/docs/resources/user#user-object} +## Add a Member to a Lobby % PUT /lobbies/||FIXME||lobby.id||/docs/resources/lobby#lobby-object||/members/||FIXME||user.id||/docs/resources/user#user-object|| Adds the provided user to the specified lobby. If called when the user is already a member of the lobby will update fields such as metadata on that user instead. @@ -120,13 +120,13 @@ Returns the [lobby member](/docs/resources/lobby#lobby-member-object) object. | metadata? | ?dict | optional dictionary of string key/value pairs. The max total length is 1000. | | flags? | integer | [lobby member flags](/docs/resources/lobby#lobby-member-object-lobby-member-flags) combined as a [bitfield](https://en.wikipedia.org/wiki/Bit_field) | -## Remove a Member from a Lobby % DELETE /lobbies/{lobby.id/docs/resources/lobby#lobby-object}/members/{user.id/docs/resources/user#user-object} +## Remove a Member from a Lobby % DELETE /lobbies/||FIXME||lobby.id||/docs/resources/lobby#lobby-object||/members/||FIXME||user.id||/docs/resources/user#user-object|| Removes the provided user from the specified lobby. It is safe to call this even if the user is no longer a member of the lobby, but will fail if the lobby does not exist. Returns nothing. -## Leave Lobby % DELETE /lobbies/{lobby.id/docs/resources/lobby#lobby-object}/members/@me +## Leave Lobby % DELETE /lobbies/||FIXME||lobby.id||/docs/resources/lobby#lobby-object||/members/@me Removes the current user from the specified lobby. It is safe to call this even if the user is no longer a member of the lobby, but will fail if the lobby does not exist. @@ -134,7 +134,7 @@ Uses `Bearer` token for authorization. Returns nothing. -## Link Channel to Lobby % PATCH /lobbies/{lobby.id/docs/resources/lobby#lobby-object}/channel-linking +## Link Channel to Lobby % PATCH /lobbies/||FIXME||lobby.id||/docs/resources/lobby#lobby-object||/channel-linking Links an existing text channel to a lobby. See [Linked Channels](/docs/discord-social-sdk/development-guides/linked-channels) for more information. @@ -148,7 +148,7 @@ Returns a [lobby](/docs/resources/lobby#lobby-object) object with a linked chann |-------------|-----------|------------------------------------------------------------------------------------------------------------------------| | channel_id? | snowflake | the id of the channel to link to the lobby. If not provided, will unlink any currently linked channels from the lobby. | -## Unlink Channel from Lobby % PATCH /lobbies/{lobby.id/docs/resources/lobby#lobby-object}/channel-linking +## Unlink Channel from Lobby % PATCH /lobbies/||FIXME||lobby.id||/docs/resources/lobby#lobby-object||/channel-linking Unlinks any currently linked channels from the specified lobby. diff --git a/docs/resources/message.md b/docs/resources/message.md index 0944ceb0a3..153f9f9bb2 100644 --- a/docs/resources/message.md +++ b/docs/resources/message.md @@ -729,7 +729,7 @@ user 125 in the content. | total_months_subscribed | integer | the cumulative number of months that the user has been subscribed for | | is_renewal | boolean | whether this notification is for a renewal rather than a new purchase | -## Get Channel Messages % GET /channels/{channel.id/docs/resources/channel#channel-object}/messages +## Get Channel Messages % GET /channels/||FIXME||channel.id||/docs/resources/channel#channel-object||/messages Retrieves the messages in a channel. Returns an array of [message](/docs/resources/message#message-object) objects on success. @@ -749,13 +749,13 @@ If the current user is missing the `READ_MESSAGE_HISTORY` permission in the chan | after? | snowflake | Get messages after this message ID | absent | | limit? | integer | Max number of messages to return (1-100) | 50 | -## Get Channel Message % GET /channels/{channel.id/docs/resources/channel#channel-object}/messages/{message.id/docs/resources/message#message-object} +## Get Channel Message % GET /channels/||FIXME||channel.id||/docs/resources/channel#channel-object||/messages/||FIXME||message.id||/docs/resources/message#message-object|| Retrieves a specific message in the channel. Returns a [message](/docs/resources/message#message-object) object on success. If operating on a guild channel, this endpoint requires the current user to have the `VIEW_CHANNEL` and `READ_MESSAGE_HISTORY` permissions. If the channel is a voice channel, they must _also_ have the `CONNECT` permission. -## Create Message % POST /channels/{channel.id/docs/resources/channel#channel-object}/messages +## Create Message % POST /channels/||FIXME||channel.id||/docs/resources/channel#channel-object||/messages > warn > Discord may strip certain characters from message content, like invalid unicode characters or characters which cause unexpected message formatting. If you are passing user-generated strings into message content, consider sanitizing the data to prevent unexpected behavior and using `allowed_mentions` to prevent unexpected mentions. @@ -815,28 +815,28 @@ Files must be attached using a `multipart/form-data` body as described in [Uploa Examples for file uploads are available in [Uploading Files](/docs/reference#uploading-files). -## Crosspost Message % POST /channels/{channel.id/docs/resources/channel#channel-object}/messages/{message.id/docs/resources/message#message-object}/crosspost +## Crosspost Message % POST /channels/||FIXME||channel.id||/docs/resources/channel#channel-object||/messages/||FIXME||message.id||/docs/resources/message#message-object||/crosspost Crosspost a message in an Announcement Channel to following channels. This endpoint requires the `SEND_MESSAGES` permission, if the current user sent the message, or additionally the `MANAGE_MESSAGES` permission, for all other messages, to be present for the current user. Returns a [message](/docs/resources/message#message-object) object. Fires a [Message Update](/docs/events/gateway-events#message-update) Gateway event. -## Create Reaction % PUT /channels/{channel.id/docs/resources/channel#channel-object}/messages/{message.id/docs/resources/message#message-object}/reactions/{emoji/docs/resources/emoji#emoji-object}/@me +## Create Reaction % PUT /channels/||FIXME||channel.id||/docs/resources/channel#channel-object||/messages/||FIXME||message.id||/docs/resources/message#message-object||/reactions/||FIXME||emoji.id||/docs/resources/emoji#emoji-object||/@me Create a reaction for the message. This endpoint requires the `READ_MESSAGE_HISTORY` permission to be present on the current user. Additionally, if nobody else has reacted to the message using this emoji, this endpoint requires the `ADD_REACTIONS` permission to be present on the current user. Returns a 204 empty response on success. Fires a [Message Reaction Add](/docs/events/gateway-events#message-reaction-add) Gateway event. The `emoji` must be [URL Encoded](https://en.wikipedia.org/wiki/Percent-encoding) or the request will fail with `10014: Unknown Emoji`. To use custom emoji, you must encode it in the format `name:id` with the emoji name and emoji id. -## Delete Own Reaction % DELETE /channels/{channel.id/docs/resources/channel#channel-object}/messages/{message.id/docs/resources/message#message-object}/reactions/{emoji/docs/resources/emoji#emoji-object}/@me +## Delete Own Reaction % DELETE /channels/||FIXME||channel.id||/docs/resources/channel#channel-object||/messages/||FIXME||message.id||/docs/resources/message#message-object||/reactions/||FIXME||emoji.id||/docs/resources/emoji#emoji-object||/@me Delete a reaction the current user has made for the message. Returns a 204 empty response on success. Fires a [Message Reaction Remove](/docs/events/gateway-events#message-reaction-remove) Gateway event. The `emoji` must be [URL Encoded](https://en.wikipedia.org/wiki/Percent-encoding) or the request will fail with `10014: Unknown Emoji`. To use custom emoji, you must encode it in the format `name:id` with the emoji name and emoji id. -## Delete User Reaction % DELETE /channels/{channel.id/docs/resources/channel#channel-object}/messages/{message.id/docs/resources/message#message-object}/reactions/{emoji/docs/resources/emoji#emoji-object}/{user.id/docs/resources/user#user-object} +## Delete User Reaction % DELETE /channels/||FIXME||channel.id||/docs/resources/channel#channel-object||/messages/||FIXME||message.id||/docs/resources/message#message-object||/reactions/||FIXME||emoji.id||/docs/resources/emoji#emoji-object||/||FIXME||user.id||/docs/resources/user#user-object|| Deletes another user's reaction. This endpoint requires the `MANAGE_MESSAGES` permission to be present on the current user. Returns a 204 empty response on success. Fires a [Message Reaction Remove](/docs/events/gateway-events#message-reaction-remove) Gateway event. The `emoji` must be [URL Encoded](https://en.wikipedia.org/wiki/Percent-encoding) or the request will fail with `10014: Unknown Emoji`. To use custom emoji, you must encode it in the format `name:id` with the emoji name and emoji id. -## Get Reactions % GET /channels/{channel.id/docs/resources/channel#channel-object}/messages/{message.id/docs/resources/message#message-object}/reactions/{emoji/docs/resources/emoji#emoji-object} +## Get Reactions % GET /channels/||FIXME||channel.id||/docs/resources/channel#channel-object||/messages/||FIXME||message.id||/docs/resources/message#message-object||/reactions/||FIXME||emoji.id||/docs/resources/emoji#emoji-object|| Get a list of users that reacted with this emoji. Returns an array of [user](/docs/resources/user#user-object) objects on success. The `emoji` must be [URL Encoded](https://en.wikipedia.org/wiki/Percent-encoding) or the request will fail with `10014: Unknown Emoji`. To use custom emoji, you must encode it in the format `name:id` with the emoji name and emoji id. @@ -856,16 +856,16 @@ The `emoji` must be [URL Encoded](https://en.wikipedia.org/wiki/Percent-encoding | NORMAL | 0 | | BURST | 1 | -## Delete All Reactions % DELETE /channels/{channel.id/docs/resources/channel#channel-object}/messages/{message.id/docs/resources/message#message-object}/reactions +## Delete All Reactions % DELETE /channels/||FIXME||channel.id||/docs/resources/channel#channel-object||/messages/||FIXME||message.id||/docs/resources/message#message-object||/reactions Deletes all reactions on a message. This endpoint requires the `MANAGE_MESSAGES` permission to be present on the current user. Fires a [Message Reaction Remove All](/docs/events/gateway-events#message-reaction-remove-all) Gateway event. -## Delete All Reactions for Emoji % DELETE /channels/{channel.id/docs/resources/channel#channel-object}/messages/{message.id/docs/resources/message#message-object}/reactions/{emoji/docs/resources/emoji#emoji-object} +## Delete All Reactions for Emoji % DELETE /channels/||FIXME||channel.id||/docs/resources/channel#channel-object||/messages/||FIXME||message.id||/docs/resources/message#message-object||/reactions/||FIXME||emoji.id||/docs/resources/emoji#emoji-object|| Deletes all the reactions for a given emoji on a message. This endpoint requires the `MANAGE_MESSAGES` permission to be present on the current user. Fires a [Message Reaction Remove Emoji](/docs/events/gateway-events#message-reaction-remove-emoji) Gateway event. The `emoji` must be [URL Encoded](https://en.wikipedia.org/wiki/Percent-encoding) or the request will fail with `10014: Unknown Emoji`. To use custom emoji, you must encode it in the format `name:id` with the emoji name and emoji id. -## Edit Message % PATCH /channels/{channel.id/docs/resources/channel#channel-object}/messages/{message.id/docs/resources/message#message-object} +## Edit Message % PATCH /channels/||FIXME||channel.id||/docs/resources/channel#channel-object||/messages/||FIXME||message.id||/docs/resources/message#message-object|| Edit a previously sent message. The fields `content`, `embeds`, and `flags` can be edited by the original message author. Other users can only edit `flags` and only if they have the `MANAGE_MESSAGES` permission in the corresponding channel. When specifying flags, ensure to include all previously set flags/bits in addition to ones that you are modifying. Only `flags` documented in the table below may be modified by users (unsupported flag changes are currently ignored without error). @@ -895,14 +895,14 @@ Any provided files will be **appended** to the message. To remove or replace fil | payload_json | string | JSON-encoded body of non-file params (multipart/form-data only). See [Uploading Files](/docs/reference#uploading-files) | | attachments | array of [attachment](/docs/resources/message#attachment-object) objects | Attached files to keep and possible descriptions for new files. See [Uploading Files](/docs/reference#uploading-files) | -## Delete Message % DELETE /channels/{channel.id/docs/resources/channel#channel-object}/messages/{message.id/docs/resources/message#message-object} +## Delete Message % DELETE /channels/||FIXME||channel.id||/docs/resources/channel#channel-object||/messages/||FIXME||message.id||/docs/resources/message#message-object|| Delete a message. If operating on a guild channel and trying to delete a message that was not sent by the current user, this endpoint requires the `MANAGE_MESSAGES` permission. Returns a 204 empty response on success. Fires a [Message Delete](/docs/events/gateway-events#message-delete) Gateway event. > info > This endpoint supports the `X-Audit-Log-Reason` header. -## Bulk Delete Messages % POST /channels/{channel.id/docs/resources/channel#channel-object}/messages/bulk-delete +## Bulk Delete Messages % POST /channels/||FIXME||channel.id||/docs/resources/channel#channel-object||/messages/bulk-delete Delete multiple messages in a single request. This endpoint can only be used on guild channels and requires the `MANAGE_MESSAGES` permission. Returns a 204 empty response on success. Fires a [Message Delete Bulk](/docs/events/gateway-events#message-delete-bulk) Gateway event. diff --git a/docs/resources/poll.md b/docs/resources/poll.md index ac6580d244..60e03852c3 100644 --- a/docs/resources/poll.md +++ b/docs/resources/poll.md @@ -123,7 +123,7 @@ For creating a poll, see [Create Message](/docs/resources/message#create-message Apps are not allowed to vote on polls. No rights! :) -## Get Answer Voters % GET /channels/{channel.id/docs/resources/channel#channel-object}/polls/{message.id/docs/resources/message#message-object}/answers/{answer_id/docs/resources/poll#poll-answer-object} +## Get Answer Voters % GET /channels/||FIXME||channel.id||/docs/resources/channel#channel-object||/polls/||FIXME||message.id||/docs/resources/message#message-object||/answers/||FIXME||answer_id||/docs/resources/poll#poll-answer-object|| Get a list of users that voted for this specific answer. @@ -140,7 +140,7 @@ Get a list of users that voted for this specific answer. |-------|---------------------------------------------------|---------------------------------| | users | array of [user](/docs/resources/user#user-object) | Users who voted for this answer | -## End Poll % POST /channels/{channel.id/docs/resources/channel#channel-object}/polls/{message.id/docs/resources/message#message-object}/expire +## End Poll % POST /channels/||FIXME||channel.id||/docs/resources/channel#channel-object||/polls/||FIXME||message.id||/docs/resources/message#message-object||/expire Immediately ends the poll. You cannot end polls from other users. diff --git a/docs/resources/sku.md b/docs/resources/sku.md index 376d7f157c..417947265e 100644 --- a/docs/resources/sku.md +++ b/docs/resources/sku.md @@ -65,7 +65,7 @@ The `flags` field can be used to differentiate user and server subscriptions wit | GUILD_SUBSCRIPTION | `1 << 7` | Recurring SKU that can be purchased by a user and applied to a single server. Grants access to every user in that server. | | USER_SUBSCRIPTION | `1 << 8` | Recurring SKU purchased by a user for themselves. Grants access to the purchasing user in every server. | -## List SKUs % GET /applications/{application.id/docs/resources/application#application-object}/skus +## List SKUs % GET /applications/||FIXME||application.id||/docs/resources/application#application-object||/skus Returns all SKUs for a given application. diff --git a/docs/resources/soundboard.md b/docs/resources/soundboard.md index 9ba06d792b..7987f67c70 100644 --- a/docs/resources/soundboard.md +++ b/docs/resources/soundboard.md @@ -60,7 +60,7 @@ A soundboard sound can be retrieved in MP3 or Ogg format at the URL: https://cdn.discordapp.com/soundboard-sounds/{sound_id} ``` -## Send Soundboard Sound % POST /channels/{channel.id/docs/resources/channel#channel-object}/send-soundboard-sound +## Send Soundboard Sound % POST /channels/||FIXME||channel.id||/docs/resources/channel#channel-object||/send-soundboard-sound Send a soundboard sound to a voice channel the user is connected to. Fires a [Voice Channel Effect Send](/docs/events/gateway-events#voice-channel-effect-send) Gateway event. @@ -77,7 +77,7 @@ Requires the `SPEAK` and `USE_SOUNDBOARD` permissions, and also the `USE_EXTERNA Returns an array of [soundboard sound](/docs/resources/soundboard#soundboard-sound-object) objects that can be used by all users. -## List Guild Soundboard Sounds % GET /guilds/{guild.id/docs/resources/guild#guild-object}/soundboard-sounds +## List Guild Soundboard Sounds % GET /guilds/||FIXME||guild.id||/docs/resources/guild#guild-object||/soundboard-sounds Returns a list of the guild's soundboard sounds. Includes `user` fields if the bot has the `CREATE_GUILD_EXPRESSIONS` or `MANAGE_GUILD_EXPRESSIONS` permission. @@ -87,11 +87,11 @@ Returns a list of the guild's soundboard sounds. Includes `user` fields if the b |-------|-----------------------------------------------------------------------------------------| | items | array of [soundboard sound](/docs/resources/soundboard#soundboard-sound-object) objects | -## Get Guild Soundboard Sound % GET /guilds/{guild.id/docs/resources/guild#guild-object}/soundboard-sounds/{sound.id/docs/resources/soundboard#soundboard-sound-object} +## Get Guild Soundboard Sound % GET /guilds/||FIXME||guild.id||/docs/resources/guild#guild-object||/soundboard-sounds/||FIXME||sound.id||/docs/resources/soundboard#soundboard-sound-object|| Returns a [soundboard sound](/docs/resources/soundboard#soundboard-sound-object) object for the given sound id. Includes the `user` field if the bot has the `CREATE_GUILD_EXPRESSIONS` or `MANAGE_GUILD_EXPRESSIONS` permission. -## Create Guild Soundboard Sound % POST /guilds/{guild.id/docs/resources/guild#guild-object}/soundboard-sounds +## Create Guild Soundboard Sound % POST /guilds/||FIXME||guild.id||/docs/resources/guild#guild-object||/soundboard-sounds Create a new soundboard sound for the guild. Requires the `CREATE_GUILD_EXPRESSIONS` permission. Returns the new [soundboard sound](/docs/resources/soundboard#soundboard-sound-object) object on success. Fires a [Guild Soundboard Sound Create](/docs/events/gateway-events#guild-soundboard-sound-create) Gateway event. @@ -111,7 +111,7 @@ Create a new soundboard sound for the guild. Requires the `CREATE_GUILD_EXPRESSI | emoji_id? | ?snowflake | the id of the custom emoji for the soundboard sound | | emoji_name? | ?string | the unicode character of a standard emoji for the soundboard sound | -## Modify Guild Soundboard Sound % PATCH /guilds/{guild.id/docs/resources/guild#guild-object}/soundboard-sounds/{sound.id/docs/resources/soundboard#soundboard-sound-object} +## Modify Guild Soundboard Sound % PATCH /guilds/||FIXME||guild.id||/docs/resources/guild#guild-object||/soundboard-sounds/||FIXME||sound.id||/docs/resources/soundboard#soundboard-sound-object|| Modify the given soundboard sound. For sounds created by the current user, requires either the `CREATE_GUILD_EXPRESSIONS` or `MANAGE_GUILD_EXPRESSIONS` permission. For other sounds, requires the `MANAGE_GUILD_EXPRESSIONS` permission. Returns the updated [soundboard sound](/docs/resources/soundboard#soundboard-sound-object) object on success. Fires a [Guild Soundboard Sound Update](/docs/events/gateway-events#guild-soundboard-sound-update) Gateway event. @@ -130,7 +130,7 @@ Modify the given soundboard sound. For sounds created by the current user, requi | emoji_id | ?snowflake | the id of the custom emoji for the soundboard sound | | emoji_name | ?string | the unicode character of a standard emoji for the soundboard sound | -## Delete Guild Soundboard Sound % DELETE /guilds/{guild.id/docs/resources/guild#guild-object}/soundboard-sounds/{sound.id/docs/resources/soundboard#soundboard-sound-object} +## Delete Guild Soundboard Sound % DELETE /guilds/||FIXME||guild.id||/docs/resources/guild#guild-object||/soundboard-sounds/||FIXME||sound.id||/docs/resources/soundboard#soundboard-sound-object|| Delete the given soundboard sound. For sounds created by the current user, requires either the `CREATE_GUILD_EXPRESSIONS` or `MANAGE_GUILD_EXPRESSIONS` permission. For other sounds, requires the `MANAGE_GUILD_EXPRESSIONS` permission. Returns `204 No Content` on success. Fires a [Guild Soundboard Sound Delete](/docs/events/gateway-events#guild-soundboard-sound-delete) Gateway event. diff --git a/docs/resources/stage-instance.md b/docs/resources/stage-instance.md index 0b19c99001..46d577063a 100644 --- a/docs/resources/stage-instance.md +++ b/docs/resources/stage-instance.md @@ -82,11 +82,11 @@ Requires the user to be a moderator of the Stage channel. \* The stage moderator must have the `MENTION_EVERYONE` permission for this notification to be sent. -## Get Stage Instance % GET /stage-instances/{channel.id/docs/resources/channel#channel-object} +## Get Stage Instance % GET /stage-instances/||FIXME||channel.id||/docs/resources/channel#channel-object|| Gets the stage instance associated with the Stage channel, if it exists. -## Modify Stage Instance % PATCH /stage-instances/{channel.id/docs/resources/channel#channel-object} +## Modify Stage Instance % PATCH /stage-instances/||FIXME||channel.id||/docs/resources/channel#channel-object|| Updates fields of an existing Stage instance. Returns the updated [Stage instance](/docs/resources/stage-instance#stage-instance-object-stage-instance-structure). Fires a [Stage Instance Update](/docs/events/gateway-events#stage-instance-update) Gateway event. @@ -102,7 +102,7 @@ Requires the user to be a moderator of the Stage channel. | topic? | string | The topic of the Stage instance (1-120 characters) | | privacy_level? | integer | The [privacy level](/docs/resources/stage-instance#stage-instance-object-privacy-level) of the Stage instance | -## Delete Stage Instance % DELETE /stage-instances/{channel.id/docs/resources/channel#channel-object} +## Delete Stage Instance % DELETE /stage-instances/||FIXME||channel.id||/docs/resources/channel#channel-object|| Deletes the Stage instance. Returns `204 No Content`. Fires a [Stage Instance Delete](/docs/events/gateway-events#stage-instance-delete) Gateway event. diff --git a/docs/resources/sticker.md b/docs/resources/sticker.md index eba6d9ab53..55a97a604c 100644 --- a/docs/resources/sticker.md +++ b/docs/resources/sticker.md @@ -100,7 +100,7 @@ Represents a pack of standard stickers. } ``` -## Get Sticker % GET /stickers/{sticker.id/docs/resources/sticker#sticker-object} +## Get Sticker % GET /stickers/||FIXME||sticker.id||/docs/resources/sticker#sticker-object|| Returns a [sticker](/docs/resources/sticker#sticker-object) object for the given sticker ID. @@ -114,19 +114,19 @@ Returns a list of available sticker packs. |---------------|------------------------------------------------------------------------------| | sticker_packs | array of [sticker pack](/docs/resources/sticker#sticker-pack-object) objects | -## Get Sticker Pack % GET /sticker-packs/{pack.id/docs/resources/sticker#sticker-pack-object} +## Get Sticker Pack % GET /sticker-packs/||FIXME||pack.id||/docs/resources/sticker#sticker-pack-object|| Returns a [sticker pack](/docs/resources/sticker#sticker-pack-object) object for the given sticker pack ID. -## List Guild Stickers % GET /guilds/{guild.id/docs/resources/guild#guild-object}/stickers +## List Guild Stickers % GET /guilds/||FIXME||guild.id||/docs/resources/guild#guild-object||/stickers Returns an array of [sticker](/docs/resources/sticker#sticker-object) objects for the given guild. Includes `user` fields if the bot has the `CREATE_GUILD_EXPRESSIONS` or `MANAGE_GUILD_EXPRESSIONS` permission. -## Get Guild Sticker % GET /guilds/{guild.id/docs/resources/guild#guild-object}/stickers/{sticker.id/docs/resources/sticker#sticker-object} +## Get Guild Sticker % GET /guilds/||FIXME||guild.id||/docs/resources/guild#guild-object||/stickers/||FIXME||sticker.id||/docs/resources/sticker#sticker-object|| Returns a [sticker](/docs/resources/sticker#sticker-object) object for the given guild and sticker IDs. Includes the `user` field if the bot has the `CREATE_GUILD_EXPRESSIONS` or `MANAGE_GUILD_EXPRESSIONS` permission. -## Create Guild Sticker % POST /guilds/{guild.id/docs/resources/guild#guild-object}/stickers +## Create Guild Sticker % POST /guilds/||FIXME||guild.id||/docs/resources/guild#guild-object||/stickers Create a new sticker for the guild. Send a `multipart/form-data` body. Requires the `CREATE_GUILD_EXPRESSIONS` permission. Returns the new [sticker](/docs/resources/sticker#sticker-object) object on success. Fires a [Guild Stickers Update](/docs/events/gateway-events#guild-stickers-update) Gateway event. @@ -150,7 +150,7 @@ Every guilds has five free sticker slots by default, and each Boost level will g | tags | string | autocomplete/suggestion tags for the sticker (max 200 characters) | | file | file contents | the sticker file to upload, must be a PNG, APNG, GIF, or Lottie JSON file, max 512 KiB | -## Modify Guild Sticker % PATCH /guilds/{guild.id/docs/resources/guild#guild-object}/stickers/{sticker.id/docs/resources/sticker#sticker-object} +## Modify Guild Sticker % PATCH /guilds/||FIXME||guild.id||/docs/resources/guild#guild-object||/stickers/||FIXME||sticker.id||/docs/resources/sticker#sticker-object|| Modify the given sticker. For stickers created by the current user, requires either the `CREATE_GUILD_EXPRESSIONS` or `MANAGE_GUILD_EXPRESSIONS` permission. For other stickers, requires the `MANAGE_GUILD_EXPRESSIONS` permission. Returns the updated [sticker](/docs/resources/sticker#sticker-object) object on success. Fires a [Guild Stickers Update](/docs/events/gateway-events#guild-stickers-update) Gateway event. @@ -168,7 +168,7 @@ Modify the given sticker. For stickers created by the current user, requires eit | description | ?string | description of the sticker (2-100 characters) | | tags | string | autocomplete/suggestion tags for the sticker (max 200 characters) | -## Delete Guild Sticker % DELETE /guilds/{guild.id/docs/resources/guild#guild-object}/stickers/{sticker.id/docs/resources/sticker#sticker-object} +## Delete Guild Sticker % DELETE /guilds/||FIXME||guild.id||/docs/resources/guild#guild-object||/stickers/||FIXME||sticker.id||/docs/resources/sticker#sticker-object|| Delete the given sticker. For stickers created by the current user, requires either the `CREATE_GUILD_EXPRESSIONS` or `MANAGE_GUILD_EXPRESSIONS` permission. For other stickers, requires the `MANAGE_GUILD_EXPRESSIONS` permission. Returns `204 No Content` on success. Fires a [Guild Stickers Update](/docs/events/gateway-events#guild-stickers-update) Gateway event. diff --git a/docs/resources/subscription.md b/docs/resources/subscription.md index 6e7f233866..6c460b3f4e 100644 --- a/docs/resources/subscription.md +++ b/docs/resources/subscription.md @@ -59,7 +59,7 @@ Some examples of this behavior include: - While a failed payment is being retried, the subscription would remain `ACTIVE` until it succeeds or our system determines the payment is not recoverable. - A refund or chargeback during the current period would make the subscription `INACTIVE`. -## List SKU Subscriptions % GET /skus/{sku.id/docs/resources/sku#sku-object}/subscriptions +## List SKU Subscriptions % GET /skus/||FIXME||sku.id||/docs/resources/sku#sku-object||/subscriptions Returns all subscriptions containing the SKU, filtered by user. Returns a list of [subscription](/docs/resources/subscription#subscription-object) objects. @@ -72,6 +72,6 @@ Returns all subscriptions containing the SKU, filtered by user. Returns a list o | limit? | integer | Number of results to return (1-100) | 50 | | user_id? | snowflake | User ID for which to return subscriptions. Required except for OAuth queries. | absent | -## Get SKU Subscription % GET /skus/{sku.id/docs/resources/sku#sku-object}/subscriptions/{subscription.id#DOCS_MONETIZATION_SUBSCRIPTIONS/subscription-object} +## Get SKU Subscription % GET /skus/||FIXME||sku.id||/docs/resources/sku#sku-object||/subscriptions/||FIXME||subscription.id||/docs/resources/subscription#subscription-object|| -Get a subscription by its ID. Returns a [subscription](/docs/resources/subscription#subscription-object) object. \ No newline at end of file +Get a subscription by its ID. Returns a [subscription](/docs/resources/subscription#subscription-object) object. diff --git a/docs/resources/user.md b/docs/resources/user.md index be41cc0ca9..c6832b3387 100644 --- a/docs/resources/user.md +++ b/docs/resources/user.md @@ -187,7 +187,7 @@ The role connection object that an application has attached to a user. Returns the [user](/docs/resources/user#user-object) object of the requester's account. For OAuth2, this requires the `identify` scope, which will return the object _without_ an email, and optionally the `email` scope, which returns the object _with_ an email if the user has one. -## Get User % GET /users/{user.id/docs/resources/user#user-object} +## Get User % GET /users/||FIXME||user.id||/docs/resources/user#user-object|| Returns a [user](/docs/resources/user#user-object) object for a given user ID. @@ -238,11 +238,11 @@ Returns a list of partial [guild](/docs/resources/guild#guild-object) objects th | limit | integer | max number of guilds to return (1-200) | false | 200 | | with_counts | [boolean](/docs/reference#boolean-query-strings) | include approximate member and presence counts in response | false | false | -## Get Current User Guild Member % GET /users/@me/guilds/{guild.id/docs/resources/guild#guild-object}/member +## Get Current User Guild Member % GET /users/@me/guilds/||FIXME||guild.id||/docs/resources/guild#guild-object||/member Returns a [guild member](/docs/resources/guild#guild-member-object) object for the current user. Requires the `guilds.members.read` OAuth2 scope. -## Leave Guild % DELETE /users/@me/guilds/{guild.id/docs/resources/guild#guild-object} +## Leave Guild % DELETE /users/@me/guilds/||FIXME||guild.id||/docs/resources/guild#guild-object|| Leave a guild. Returns a 204 empty response on success. Fires a [Guild Delete](/docs/events/gateway-events#guild-delete) Gateway event and a [Guild Member Remove](/docs/events/gateway-events#guild-member-remove) Gateway event. @@ -277,11 +277,11 @@ Create a new group DM channel with multiple users. Returns a [DM channel](/docs/ Returns a list of [connection](/docs/resources/user#connection-object) objects. Requires the `connections` OAuth2 scope. -## Get Current User Application Role Connection % GET /users/@me/applications/{application.id/docs/resources/application#application-object}/role-connection +## Get Current User Application Role Connection % GET /users/@me/applications/||FIXME||application.id||/docs/resources/application#application-object||/role-connection Returns the [application role connection](/docs/resources/user#application-role-connection-object) for the user. Requires an OAuth2 access token with `role_connections.write` scope for the application specified in the path. -## Update Current User Application Role Connection % PUT /users/@me/applications/{application.id/docs/resources/application#application-object}/role-connection +## Update Current User Application Role Connection % PUT /users/@me/applications/||FIXME||application.id||/docs/resources/application#application-object||/role-connection Updates and returns the [application role connection](/docs/resources/user#application-role-connection-object) for the user. Requires an OAuth2 access token with `role_connections.write` scope for the application specified in the path. diff --git a/docs/resources/voice.md b/docs/resources/voice.md index 1e392f6d4c..63b1426386 100644 --- a/docs/resources/voice.md +++ b/docs/resources/voice.md @@ -58,15 +58,15 @@ Used to represent a user's voice connection status. Returns an array of [voice region](/docs/resources/voice#voice-region-object) objects that can be used when setting a voice or stage channel's [`rtc_region`](/docs/resources/channel#channel-object-channel-structure). -## Get Current User Voice State % GET /guilds/{guild.id/docs/resources/guild#guild-object}/voice-states/@me +## Get Current User Voice State % GET /guilds/||FIXME||guild.id||/docs/resources/guild#guild-object||/voice-states/@me Returns the current user's [voice state](/docs/resources/voice#voice-state-object) in the guild. -## Get User Voice State % GET /guilds/{guild.id/docs/resources/guild#guild-object}/voice-states/{user.id/docs/resources/user#user-object} +## Get User Voice State % GET /guilds/||FIXME||guild.id||/docs/resources/guild#guild-object||/voice-states/||FIXME||user.id||/docs/resources/user#user-object|| Returns the specified user's [voice state](/docs/resources/voice#voice-state-object) in the guild. -## Modify Current User Voice State % PATCH /guilds/{guild.id/docs/resources/guild#guild-object}/voice-states/@me +## Modify Current User Voice State % PATCH /guilds/||FIXME||guild.id||/docs/resources/guild#guild-object||/voice-states/@me Updates the current user's voice state. Returns `204 No Content` on success. Fires a [Voice State Update](/docs/events/gateway-events#voice-state-update) Gateway event. @@ -88,7 +88,7 @@ There are currently several caveats for this endpoint: - You must have the `REQUEST_TO_SPEAK` permission to request to speak. You can always clear your own request to speak. - You are able to set `request_to_speak_timestamp` to any present or future time. -## Modify User Voice State % PATCH /guilds/{guild.id/docs/resources/guild#guild-object}/voice-states/{user.id/docs/resources/user#user-object} +## Modify User Voice State % PATCH /guilds/||FIXME||guild.id||/docs/resources/guild#guild-object||/voice-states/||FIXME||user.id||/docs/resources/user#user-object|| Updates another user's voice state. Fires a [Voice State Update](/docs/events/gateway-events#voice-state-update) Gateway event. diff --git a/docs/resources/webhook.md b/docs/resources/webhook.md index 379037f609..7106857d14 100644 --- a/docs/resources/webhook.md +++ b/docs/resources/webhook.md @@ -108,7 +108,7 @@ Used to represent a webhook. } ``` -## Create Webhook % POST /channels/{channel.id/docs/resources/channel#channel-object}/webhooks +## Create Webhook % POST /channels/||FIXME||channel.id||/docs/resources/channel#channel-object||/webhooks Creates a new webhook and returns a [webhook](/docs/resources/webhook#webhook-object) object on success. Requires the `MANAGE_WEBHOOKS` permission. Fires a [Webhooks Update](/docs/events/gateway-events#webhooks-update) Gateway event. @@ -127,26 +127,26 @@ An error will be returned if a webhook name (`name`) is not valid. A webhook nam | name | string | name of the webhook (1-80 characters) | | avatar? | ?[image data](/docs/reference#image-data) | image for the default webhook avatar | -## Get Channel Webhooks % GET /channels/{channel.id/docs/resources/channel#channel-object}/webhooks +## Get Channel Webhooks % GET /channels/||FIXME||channel.id||/docs/resources/channel#channel-object||/webhooks Returns a list of channel [webhook](/docs/resources/webhook#webhook-object) objects. Requires the `MANAGE_WEBHOOKS` permission. -## Get Guild Webhooks % GET /guilds/{guild.id/docs/resources/guild#guild-object}/webhooks +## Get Guild Webhooks % GET /guilds/||FIXME||guild.id||/docs/resources/guild#guild-object||/webhooks Returns a list of guild [webhook](/docs/resources/webhook#webhook-object) objects. Requires the `MANAGE_WEBHOOKS` permission. -## Get Webhook % GET /webhooks/{webhook.id/docs/resources/webhook#webhook-object} +## Get Webhook % GET /webhooks/||FIXME||webhook.id||/docs/resources/webhook#webhook-object|| Returns the new [webhook](/docs/resources/webhook#webhook-object) object for the given id. This request requires the `MANAGE_WEBHOOKS` permission unless the application making the request owns the webhook. [(see: webhook.application_id)](/docs/resources/webhook#webhook-object) -## Get Webhook with Token % GET /webhooks/{webhook.id/docs/resources/webhook#webhook-object}/{webhook.token/docs/resources/webhook#webhook-object} +## Get Webhook with Token % GET /webhooks/||FIXME||webhook.id||/docs/resources/webhook#webhook-object||/||FIXME||webhook.token||/docs/resources/webhook#webhook-object|| Same as above, except this call does not require authentication and returns no user in the webhook object. -## Modify Webhook % PATCH /webhooks/{webhook.id/docs/resources/webhook#webhook-object} +## Modify Webhook % PATCH /webhooks/||FIXME||webhook.id||/docs/resources/webhook#webhook-object|| Modify a webhook. Requires the `MANAGE_WEBHOOKS` permission. Returns the updated [webhook](/docs/resources/webhook#webhook-object) object on success. Fires a [Webhooks Update](/docs/events/gateway-events#webhooks-update) Gateway event. @@ -164,22 +164,22 @@ Modify a webhook. Requires the `MANAGE_WEBHOOKS` permission. Returns the updated | avatar | ?[image data](/docs/reference#image-data) | image for the default webhook avatar | | channel_id | snowflake | the new channel id this webhook should be moved to | -## Modify Webhook with Token % PATCH /webhooks/{webhook.id/docs/resources/webhook#webhook-object}/{webhook.token/docs/resources/webhook#webhook-object} +## Modify Webhook with Token % PATCH /webhooks/||FIXME||webhook.id||/docs/resources/webhook#webhook-object||/||FIXME||webhook.token||/docs/resources/webhook#webhook-object|| Same as above, except this call does not require authentication, does not accept a `channel_id` parameter in the body, and does not return a user in the webhook object. -## Delete Webhook % DELETE /webhooks/{webhook.id/docs/resources/webhook#webhook-object} +## Delete Webhook % DELETE /webhooks/||FIXME||webhook.id||/docs/resources/webhook#webhook-object|| Delete a webhook permanently. Requires the `MANAGE_WEBHOOKS` permission. Returns a `204 No Content` response on success. Fires a [Webhooks Update](/docs/events/gateway-events#webhooks-update) Gateway event. > info > This endpoint supports the `X-Audit-Log-Reason` header. -## Delete Webhook with Token % DELETE /webhooks/{webhook.id/docs/resources/webhook#webhook-object}/{webhook.token/docs/resources/webhook#webhook-object} +## Delete Webhook with Token % DELETE /webhooks/||FIXME||webhook.id||/docs/resources/webhook#webhook-object||/||FIXME||webhook.token||/docs/resources/webhook#webhook-object|| Same as above, except this call does not require authentication. -## Execute Webhook % POST /webhooks/{webhook.id/docs/resources/webhook#webhook-object}/{webhook.token/docs/resources/webhook#webhook-object} +## Execute Webhook % POST /webhooks/||FIXME||webhook.id||/docs/resources/webhook#webhook-object||/||FIXME||webhook.token||/docs/resources/webhook#webhook-object|| Refer to [Uploading Files](/docs/reference#uploading-files) for details on attachments and `multipart/form-data` requests. Returns a message or `204 No Content` depending on the `wait` query parameter. @@ -226,7 +226,7 @@ Refer to [Uploading Files](/docs/reference#uploading-files) for details on attac > info > For the webhook embed objects, you can set every field except `type` (it will be `rich` regardless of if you try to set it), `provider`, `video`, and any `height`, `width`, or `proxy_url` values for images. -## Execute Slack-Compatible Webhook % POST /webhooks/{webhook.id/docs/resources/webhook#webhook-object}/{webhook.token/docs/resources/webhook#webhook-object}/slack +## Execute Slack-Compatible Webhook % POST /webhooks/||FIXME||webhook.id||/docs/resources/webhook#webhook-object||/||FIXME||webhook.token||/docs/resources/webhook#webhook-object||/slack Refer to [Slack's documentation](https://api.slack.com/incoming-webhooks) for more information. We do not support Slack's `channel`, `icon_emoji`, `mrkdwn`, or `mrkdwn_in` properties. @@ -237,7 +237,7 @@ Refer to [Slack's documentation](https://api.slack.com/incoming-webhooks) for mo | thread_id | snowflake | id of the thread to send the message in | false | | wait | [boolean](/docs/reference#boolean-query-strings) | waits for server confirmation of message send before response (defaults to `true`; when `false` a message that is not saved does not return an error) | false | -## Execute GitHub-Compatible Webhook % POST /webhooks/{webhook.id/docs/resources/webhook#webhook-object}/{webhook.token/docs/resources/webhook#webhook-object}/github +## Execute GitHub-Compatible Webhook % POST /webhooks/||FIXME||webhook.id||/docs/resources/webhook#webhook-object||/||FIXME||webhook.token||/docs/resources/webhook#webhook-object||/github [Add a new webhook](https://support.discord.com/hc/en-us/articles/228383668-Intro-to-Webhooks) to your GitHub repo (in the repo's settings), and use this endpoint as the "Payload URL." You can choose what events your Discord channel receives by choosing the "Let me select individual events" option and selecting individual events for the new webhook you're configuring. The supported [events](https://docs.github.com/en/webhooks/webhook-events-and-payloads) are `commit_comment`, `create`, `delete`, `fork`, `issue_comment`, `issues`, `member`, `public`, `pull_request`, `pull_request_review`, `pull_request_review_comment`, `push`, `release`, `watch`, `check_run`, `check_suite`, `discussion`, and `discussion_comment`. @@ -248,7 +248,7 @@ Refer to [Slack's documentation](https://api.slack.com/incoming-webhooks) for mo | thread_id | snowflake | id of the thread to send the message in | false | | wait | [boolean](/docs/reference#boolean-query-strings) | waits for server confirmation of message send before response (defaults to `true`; when `false` a message that is not saved does not return an error) | false | -## Get Webhook Message % GET /webhooks/{webhook.id/docs/resources/webhook#webhook-object}/{webhook.token/docs/resources/webhook#webhook-object}/messages/{message.id/docs/resources/message#message-object} +## Get Webhook Message % GET /webhooks/||FIXME||webhook.id||/docs/resources/webhook#webhook-object||/||FIXME||webhook.token||/docs/resources/webhook#webhook-object||/messages/||FIXME||message.id||/docs/resources/message#message-object|| Returns a previously-sent webhook message from the same token. Returns a [message](/docs/resources/message#message-object) object on success. @@ -258,7 +258,7 @@ Returns a previously-sent webhook message from the same token. Returns a [messag |-----------|-----------|------------------------------------|----------| | thread_id | snowflake | id of the thread the message is in | false | -## Edit Webhook Message % PATCH /webhooks/{webhook.id/docs/resources/webhook#webhook-object}/{webhook.token/docs/resources/webhook#webhook-object}/messages/{message.id/docs/resources/message#message-object} +## Edit Webhook Message % PATCH /webhooks/||FIXME||webhook.id||/docs/resources/webhook#webhook-object||/||FIXME||webhook.token||/docs/resources/webhook#webhook-object||/messages/||FIXME||message.id||/docs/resources/message#message-object|| Edits a previously-sent webhook message from the same token. Returns a [message](/docs/resources/message#message-object) object on success. @@ -299,7 +299,7 @@ Any provided files will be **appended** to the message. To remove or replace fil \*\*\* Polls can only be added when editing a deferred interaction response. -## Delete Webhook Message % DELETE /webhooks/{webhook.id/docs/resources/webhook#webhook-object}/{webhook.token/docs/resources/webhook#webhook-object}/messages/{message.id/docs/resources/message#message-object} +## Delete Webhook Message % DELETE /webhooks/||FIXME||webhook.id||/docs/resources/webhook#webhook-object||/||FIXME||webhook.token||/docs/resources/webhook#webhook-object||/messages/||FIXME||message.id||/docs/resources/message#message-object|| Deletes a message that was created by the webhook. Returns a `204 No Content` response on success. From 31e6ccfb52eb3095deefd7400821affef135f128 Mon Sep 17 00:00:00 2001 From: GeniusTimo Date: Sat, 19 Apr 2025 21:32:27 +0200 Subject: [PATCH 04/20] Updated absolute to relative links Those links got skipped by the check links script --- docs/activities/development-guides.mdx | 6 +++--- .../2023-10-17-global-rate-limit-added-to-discord.com.md | 4 ++-- docs/change-log/2025-04-11-incentivized-links.md | 4 ++-- docs/reference.mdx | 2 +- docs/tutorials/configuring-app-metadata-for-linked-roles.md | 4 ++-- 5 files changed, 10 insertions(+), 10 deletions(-) diff --git a/docs/activities/development-guides.mdx b/docs/activities/development-guides.mdx index bad8ad4d00..b1c0d8787f 100644 --- a/docs/activities/development-guides.mdx +++ b/docs/activities/development-guides.mdx @@ -354,7 +354,7 @@ Users will see a modal inside the Discord app notifying them whether or not they ### Open Invite Dialog -Getting an Application Channel Invite, as outlined in [these docs](https://discord.com/developers/docs/resources/invite#get-invite), is not granted by any OAuth scopes. Nonetheless, the `openInviteDialog` command is available via the SDK. This command opens the Application Channel Invite UI within the discord client without requiring additional OAuth scopes. +Getting an Application Channel Invite, as outlined in [these docs](/docs/resources/invite#get-invite), is not granted by any OAuth scopes. Nonetheless, the `openInviteDialog` command is available via the SDK. This command opens the Application Channel Invite UI within the discord client without requiring additional OAuth scopes. This command returns an error when called from DM (Direct Message) contexts, so should only be called in Guild Voice or Text Channels. Similarly, this command returns an error if the user has invalid permissions for the channel, so using `getChannelPermissions` (requires OAuth scope `'guilds.members.read'`) is highly recommended. @@ -821,7 +821,7 @@ discordSdk.unsubscribe(Events.ACTIVITY_INSTANCE_PARTICIPANTS_UPDATE, updateParti ### Render Avatars and Names -Check out detailed documentation on where and how Discord stores common image assets [here](https://discord.com/developers/docs/reference#image-formatting-cdn-endpoints). +Check out detailed documentation on where and how Discord stores common image assets [here](/docs/reference#image-formatting-cdn-endpoints). Here's a basic example for retrieving a user's avatar and username @@ -1157,7 +1157,7 @@ All assets loaded by your application will respect [cache headers](https://devel ### Handling Rate Limits -Be sure network requests made by your application's client and server will be able to respect Discord API's rate limiting [as described here](https://discord.com/developers/docs/topics/rate-limits). +Be sure network requests made by your application's client and server will be able to respect Discord API's rate limiting [as described here](/docs/topics/rate-limits). See [this implementation in the Activity Starter project](https://github.com/discord/embedded-app-sdk-examples/blob/main/discord-activity-starter/packages/server/src/utils.ts) for an example of how to respect the `retry_after` header when you receive a 429 error. diff --git a/docs/change-log/2023-10-17-global-rate-limit-added-to-discord.com.md b/docs/change-log/2023-10-17-global-rate-limit-added-to-discord.com.md index d481a5b8b9..5a2123a8ba 100644 --- a/docs/change-log/2023-10-17-global-rate-limit-added-to-discord.com.md +++ b/docs/change-log/2023-10-17-global-rate-limit-added-to-discord.com.md @@ -9,7 +9,7 @@ To limit impact on your app, please make sure you are making calls to `discord.c This does **not** apply for `cdn.discordapp.com`. -Refer to the [API Reference](https://discord.com/developers/docs/reference) for more info on which url(s) to use when building on the REST API +Refer to the [API Reference](/docs/reference) for more info on which url(s) to use when building on the REST API -* [February 14, 2022 Change Log](https://discord.com/developers/docs/change-log#feb-14-2022): Requests to v10 and higher will no longer be supported on `discordapp.com` (this does not affect `cdn.discordapp.com`) +* [February 14, 2022 Change Log](/docs/change-log#api-v10): Requests to v10 and higher will no longer be supported on `discordapp.com` (this does not affect `cdn.discordapp.com`) * [May 4, 2020 #api-announcements](https://discord.com/channels/613425648685547541/697138785317814292/706944540971630662) diff --git a/docs/change-log/2025-04-11-incentivized-links.md b/docs/change-log/2025-04-11-incentivized-links.md index ff0f17fa62..c1e27de1be 100644 --- a/docs/change-log/2025-04-11-incentivized-links.md +++ b/docs/change-log/2025-04-11-incentivized-links.md @@ -13,6 +13,6 @@ Custom Incentivized Links are used to customize how your incentivized link embed - shareLink will now let you attach custom params to links you share about your game using `custom_id`. - Removed `referrer_id` from shareLink API. Any uses of `referrer_id` should be moved over to use `custom_id` instead. Passing `referrer_id` to shareLink will silently fail. -Learn more about [creating and managing Custom Incentivized Links](https://discord.com/developers/docs/activities/development-guides#creating-and-managing-custom-incentivized-links) and [how to generate them from within your activity](https://discord.com/developers/docs/activities/development-guides#generating-a-custom-link-within-your-activity) with the shareLink API. +Learn more about [creating and managing Custom Incentivized Links](/docs/activities/development-guides#creating-and-managing-custom-incentivized-links) and [how to generate them from within your activity](/docs/activities/development-guides#generating-a-custom-link-within-your-activity) with the shareLink API. -The Embedded App SDK is available via [npm](https://www.npmjs.com/package/@discord/embedded-app-sdk) and [GitHub](https://github.com/discord/embedded-app-sdk). You can check out our [installation guide and reference](https://discord.com/developers/docs/developer-tools/embedded-app-sdk) to get started with it! \ No newline at end of file +The Embedded App SDK is available via [npm](https://www.npmjs.com/package/@discord/embedded-app-sdk) and [GitHub](https://github.com/discord/embedded-app-sdk). You can check out our [installation guide and reference](/docs/developer-tools/embedded-app-sdk) to get started with it! diff --git a/docs/reference.mdx b/docs/reference.mdx index fc1fae4404..f38b9cad2e 100644 --- a/docs/reference.mdx +++ b/docs/reference.mdx @@ -13,7 +13,7 @@ https://discord.com/api > danger > Some API and Gateway versions are now non-functioning, and are labeled as discontinued in the table below for posterity. Trying to use these versions will fail and return 400 Bad Request. -Discord exposes different versions of our API[.](https://c.tenor.com/BuZl66EegkgAAAAC/westworld-dolores.gif) You should specify which version to use by including it in the request path like `https://discord.com/api/v{version_number}`. Omitting the version number from the route will route requests to the current default version (marked below). You can find the change log for the newest API version [here](https://discord.com/developers/docs/change-log). +Discord exposes different versions of our API[.](https://c.tenor.com/BuZl66EegkgAAAAC/westworld-dolores.gif) You should specify which version to use by including it in the request path like `https://discord.com/api/v{version_number}`. Omitting the version number from the route will route requests to the current default version (marked below). You can find the change log for the newest API version [here](/docs/change-log). ###### API Versions diff --git a/docs/tutorials/configuring-app-metadata-for-linked-roles.md b/docs/tutorials/configuring-app-metadata-for-linked-roles.md index 93deeeeaf9..3f277b1fb4 100644 --- a/docs/tutorials/configuring-app-metadata-for-linked-roles.md +++ b/docs/tutorials/configuring-app-metadata-for-linked-roles.md @@ -34,7 +34,7 @@ Apps need approval from installing users to perform actions inside of Discord. S - After the scope is selected, you should see a **Generated URL** which can be used to install your app > info -> See a list of all [OAuth2 scopes](https://discord.com/developers/docs/topics/oauth2#shared-resources-oauth2-scopes), or read more on [user permissions](https://discord.com/developers/docs/topics/permissions) in the documentation. +> See a list of all [OAuth2 scopes](/docs/topics/oauth2#shared-resources-oauth2-scopes), or read more on [user permissions](/docs/topics/permissions) in the documentation. ### Installing your app @@ -169,7 +169,7 @@ Finally, create a new private channel, and add the new linked role. ### Token storage -This app largely relies on Discord's [OAuth2](https://discord.com/developers/docs/topics/oauth2) implementation to obtain access tokens. This model of user based authentication relies on storing refresh tokens, and using them to acquire access tokens. The example code in [`src/storage.js`](https://github.com/discord/linked-roles-sample/blob/main/src/storage.js) uses in-memory storage to manage these tokens, but for any production deployment a database with persistent storage should be used. +This app largely relies on Discord's [OAuth2](/docs/topics/oauth2) implementation to obtain access tokens. This model of user based authentication relies on storing refresh tokens, and using them to acquire access tokens. The example code in [`src/storage.js`](https://github.com/discord/linked-roles-sample/blob/main/src/storage.js) uses in-memory storage to manage these tokens, but for any production deployment a database with persistent storage should be used. ### Advanced examples From 424e81e536de3d772b380cad42c80b03e89c9e0e Mon Sep 17 00:00:00 2001 From: GeniusTimo Date: Sat, 19 Apr 2025 21:32:53 +0200 Subject: [PATCH 05/20] Updated the invite link to the Discord Developers Server --- docs/change-log.mdx | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/change-log.mdx b/docs/change-log.mdx index 3bb9c66ef7..8ae836c14e 100644 --- a/docs/change-log.mdx +++ b/docs/change-log.mdx @@ -4,6 +4,6 @@ showTOC: false # Change Log -Discover the latest updates, new features, and bug fixes on the Discord Developer Platform. To join in on the conversation, join the [Discord Developers Server](https://discord.com/invite/discord-developers). +Discover the latest updates, new features, and bug fixes on the Discord Developer Platform. To join in on the conversation, join the [Discord Developers Server](https://discord.gg/discord-developers). From 7286784fc574cff1455fe70c910e09a00e0e15ba Mon Sep 17 00:00:00 2001 From: GeniusTimo Date: Sat, 19 Apr 2025 21:35:06 +0200 Subject: [PATCH 06/20] Fixed table indentation --- docs/interactions/message-components.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/interactions/message-components.md b/docs/interactions/message-components.md index f514b84d16..89c798fe32 100644 --- a/docs/interactions/message-components.md +++ b/docs/interactions/message-components.md @@ -315,7 +315,7 @@ The payloads for the select menu components are detailed in the [select menu str |-----------------------|---------------------------------------------------------------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | type | integer | [Type](/docs/interactions/message-components#component-object-component-types) of select menu component (text: `3`, user: `5`, role: `6`, mentionable: `7`, channels: `8`) | | custom_id | string | ID for the select menu; max 100 characters | -| options?\* | array of [select options](/docs/interactions/message-components#select-menu-object-select-option-structure) | Specified choices in a select menu (only required and available for string selects (type `3`)); max 25 | +| options?\* | array of [select options](/docs/interactions/message-components#select-menu-object-select-option-structure) | Specified choices in a select menu (only required and available for string selects (type `3`)); max 25 | | channel_types?\*\* | array of [channel types](/docs/resources/channel#channel-object-channel-types) | List of channel types to include in the channel select component (type `8`) | | placeholder? | string | Placeholder text if nothing is selected; max 150 characters | | default_values?\*\*\* | array of [default value objects](/docs/interactions/message-components#select-menu-object-select-default-value-structure) | List of default values for auto-populated select menu components; number of default values must be in the range defined by `min_values` and `max_values` | From 8f71342600ed16f7c1302b4809e0c9aa8580d2de Mon Sep 17 00:00:00 2001 From: GeniusTimo Date: Sun, 20 Apr 2025 12:13:24 +0200 Subject: [PATCH 07/20] Changed protocol to https where appropriate --- docs/activities/development-guides.mdx | 2 +- ...cord-activities-developer-preview-of-the-embedded-app-sdk.md | 2 +- docs/change-log/2024-08-26-entry-point-commands.md | 2 +- .../change-log/2025-03-17-introducing-the-discord-social-sdk.md | 2 +- docs/quick-start/getting-started.mdx | 2 +- 5 files changed, 5 insertions(+), 5 deletions(-) diff --git a/docs/activities/development-guides.mdx b/docs/activities/development-guides.mdx index b1c0d8787f..9fb885ad1c 100644 --- a/docs/activities/development-guides.mdx +++ b/docs/activities/development-guides.mdx @@ -442,7 +442,7 @@ User Experience An [Entry Point command](/docs/interactions/application-commands#entry-point-commands) is required for users to be able to launch your Activity from the [App Launcher menu](https://support.discord.com/hc/articles/21334461140375-Using-Apps-on-Discord#h_01HRQSA6C8TRHS722P1H3HW1TV) in Discord. -When you enable Activities in your [app's settings](http://discord.com/developers/applications), a [default Entry Point command](/docs/interactions/application-commands#default-entry-point-command) is automatically created for your app. The default Entry Point command will use the `DISCORD_LAUNCH_ACTIVITY` (`2`) [handler type](/docs/interactions/application-commands#application-command-object-entry-point-command-handler-types), which means that Discord automatically launches your Activity for the user and posts a follow-up message into the channel where it was launched from. +When you enable Activities in your [app's settings](https://discord.com/developers/applications), a [default Entry Point command](/docs/interactions/application-commands#default-entry-point-command) is automatically created for your app. The default Entry Point command will use the `DISCORD_LAUNCH_ACTIVITY` (`2`) [handler type](/docs/interactions/application-commands#application-command-object-entry-point-command-handler-types), which means that Discord automatically launches your Activity for the user and posts a follow-up message into the channel where it was launched from. If you want to handle sending messages yourself, you can update the handler to be `APP_HANDLER` (`1`). Details about Entry Point command handlers is in the [Entry Point command documentation](/docs/interactions/application-commands#entry-point-handlers). diff --git a/docs/change-log/2024-03-18-discord-activities-developer-preview-of-the-embedded-app-sdk.md b/docs/change-log/2024-03-18-discord-activities-developer-preview-of-the-embedded-app-sdk.md index 0895b7fa8a..ecc7fce7d0 100644 --- a/docs/change-log/2024-03-18-discord-activities-developer-preview-of-the-embedded-app-sdk.md +++ b/docs/change-log/2024-03-18-discord-activities-developer-preview-of-the-embedded-app-sdk.md @@ -11,7 +11,7 @@ Discord Developers can now build Activities! Activities are interactive, multiplayer experiences that run in an iframe in Discord. In order to make the communication between your experience and Discord, we've introduced the Embedded App SDK to assist in communicating between your app and the Discord client. * New [Discord Activities](/docs/activities/overview) developer docs with a tutorial, code samples, development guides, and design principles. -* The Embedded App SDK is now available via [npm](https://npmjs.com/package/@discord/embedded-app-sdk) and [GitHub](http://github.com/discord/embedded-app-sdk). +* The Embedded App SDK is now available via [npm](https://npmjs.com/package/@discord/embedded-app-sdk) and [GitHub](https://github.com/discord/embedded-app-sdk). * The [Embedded App SDK Reference](/docs/developer-tools/embedded-app-sdk) is now available. To learn more about how to get started building your own Activity, check out the [Activities Overview](/docs/activities/overview). diff --git a/docs/change-log/2024-08-26-entry-point-commands.md b/docs/change-log/2024-08-26-entry-point-commands.md index 99bf9f853a..44702fe659 100644 --- a/docs/change-log/2024-08-26-entry-point-commands.md +++ b/docs/change-log/2024-08-26-entry-point-commands.md @@ -16,4 +16,4 @@ More details about Entry Point commands can be found in the [Application Command ### Default Entry Point Commands -Starting today, when you enable Activities in your [app's settings](http://discord.com/developers/applications), a [default Entry Point command](/docs/interactions/application-commands#default-entry-point-command) called "Launch" will automatically be created for your app. This can be customized or deleted like other commands if you want to update the name or handler type. \ No newline at end of file +Starting today, when you enable Activities in your [app's settings](https://discord.com/developers/applications), a [default Entry Point command](/docs/interactions/application-commands#default-entry-point-command) called "Launch" will automatically be created for your app. This can be customized or deleted like other commands if you want to update the name or handler type. \ No newline at end of file diff --git a/docs/change-log/2025-03-17-introducing-the-discord-social-sdk.md b/docs/change-log/2025-03-17-introducing-the-discord-social-sdk.md index 4da78fc441..c5aa71bdb9 100644 --- a/docs/change-log/2025-03-17-introducing-the-discord-social-sdk.md +++ b/docs/change-log/2025-03-17-introducing-the-discord-social-sdk.md @@ -29,7 +29,7 @@ New resources are available in the Developer Portal to help you get started with - [Getting Started Guides](/docs/discord-social-sdk/getting-started) for C++, Unity and Unreal Engine. - [Development Guides](/docs/discord-social-sdk/development-guides) for building your game's social features. - [Design Guidelines](/docs/discord-social-sdk/design-guidelines) for designing your game's social features. -- [SDK Reference](http://discord.com/developers/docs/social-sdk/index.html) is now available. +- [SDK Reference](https://discord.com/developers/docs/social-sdk/index.html) is now available. - The Discord Social SDK binaries are available for download in the Developer Portal after enabling the Discord Social SDK for your application. To learn more about building with the Discord Social SDK, check out the [Discord Social SDK Overview](/docs/discord-social-sdk/overview). diff --git a/docs/quick-start/getting-started.mdx b/docs/quick-start/getting-started.mdx index 8d9af3fc0d..6ee1b3e0d1 100644 --- a/docs/quick-start/getting-started.mdx +++ b/docs/quick-start/getting-started.mdx @@ -279,7 +279,7 @@ Click **Save Changes** and ensure your endpoint is successfully verified. > If you have troubles verifying your endpoint, make sure both ngrok and your app are running on the same port, and that you've copied the ngrok URL correctly The verification is handled automatically by the sample app in two ways: -- It uses the `PUBLIC_KEY` and [discord-interactions package](https://github.com/discord/discord-interactions-js#usage) with a wrapper function (imported from `utils.js`) that makes it conform to [Express's `verify` interface](http://expressjs.com/en/5x/api.html#express.json). This is run on every incoming request to your app. +- It uses the `PUBLIC_KEY` and [discord-interactions package](https://github.com/discord/discord-interactions-js#usage) with a wrapper function (imported from `utils.js`) that makes it conform to [Express's `verify` interface](https://expressjs.com/en/5x/api.html#express.json). This is run on every incoming request to your app. - It responds to incoming `PING` requests. You can learn more about preparing your app to receive interactions in [the interactions documentation](/docs/interactions/overview#preparing-for-interactions). From 65ed3d2bc401d10317a876d285d34a85ca2345af Mon Sep 17 00:00:00 2001 From: GeniusTimo Date: Sun, 20 Apr 2025 13:12:29 +0200 Subject: [PATCH 08/20] Updated Help Center links to improve maintainability --- README.md | 2 +- docs/activities/development-guides.mdx | 4 ++-- .../2018-02-05-enhancement-new-message-properties.md | 2 +- ...9-05-29-added-info-around-nitro-boosting-experiment.md | 2 +- docs/change-log/2022-02-14-api-v10.md | 2 +- .../2022-09-01-message-content-is-a-privileged-intent.md | 2 +- docs/change-log/2022-09-14-forum-channels-release.md | 2 +- docs/change-log/2023-05-03-unique-usernames-on-discord.md | 4 ++-- ...2024-06-27-user-installed-apps-general-availability.md | 2 +- .../2024-09-26-activities-general-availability.md | 2 +- .../2025-04-15-deprecating-guild-createion-by-apps.md | 2 +- docs/developer-tools/game-sdk.mdx | 2 +- docs/discord-social-sdk/design-guidelines/signing-in.mdx | 2 +- .../development-guides/account-linking-with-discord.mdx | 2 +- .../development-guides/managing-game-invites.mdx | 4 ++-- docs/discovery/best-practices.md | 6 +++--- docs/discovery/enabling-discovery.mdx | 4 ++-- docs/events/gateway-events.mdx | 4 ++-- docs/events/gateway.mdx | 4 ++-- docs/interactions/application-commands.mdx | 4 ++-- docs/intro.mdx | 2 +- docs/monetization/enabling-monetization.mdx | 6 +++--- docs/quick-start/getting-started.mdx | 4 ++-- docs/reference.mdx | 2 +- docs/resources/channel.md | 4 ++-- docs/resources/guild.md | 8 ++++---- docs/resources/user.md | 4 ++-- docs/resources/webhook.md | 2 +- docs/topics/oauth2.md | 4 ++-- docs/topics/teams.md | 2 +- docs/topics/threads.md | 2 +- docs/tutorials/upgrading-to-application-commands.md | 6 +++--- 32 files changed, 52 insertions(+), 52 deletions(-) diff --git a/README.md b/README.md index 62e6492bdf..809bce8188 100644 --- a/README.md +++ b/README.md @@ -20,4 +20,4 @@ The [Unofficial Discord API server](https://discord.gg/discord-api) is a common ## License -Except as otherwise noted, the Discord API Documentation and other content in this repository is licensed under the Creative Commons Attribution-ShareAlike 4.0 License (see [LICENSE](https://github.com/discord/discord-api-docs/blob/main/LICENSE)), and code samples in this repository are licensed under the MIT License (see [LICENSE-CODE](https://github.com/discord/discord-api-docs/blob/main/LICENSE-CODE)). These licenses do not grant you rights to use any of Discord’s trademarks or other brand features. Please see the [Discord Developer Terms of Service](https://support-dev.discord.com/hc/articles/8562894815383-Discord-Developer-Terms-of-Service) for more information about use of Discord’s brand features and APIs. +Except as otherwise noted, the Discord API Documentation and other content in this repository is licensed under the Creative Commons Attribution-ShareAlike 4.0 License (see [LICENSE](https://github.com/discord/discord-api-docs/blob/main/LICENSE)), and code samples in this repository are licensed under the MIT License (see [LICENSE-CODE](https://github.com/discord/discord-api-docs/blob/main/LICENSE-CODE)). These licenses do not grant you rights to use any of Discord’s trademarks or other brand features. Please see the [Discord Developer Terms of Service](https://support-dev.discord.com/hc/en-us/articles/8562894815383) for more information about use of Discord’s brand features and APIs. diff --git a/docs/activities/development-guides.mdx b/docs/activities/development-guides.mdx index 9fb885ad1c..12092d8213 100644 --- a/docs/activities/development-guides.mdx +++ b/docs/activities/development-guides.mdx @@ -265,7 +265,7 @@ By default, the SDK will send any console `log`, `warn`, `error`, `info`, and `d #### Viewing Logs on Desktop -Desktop logs are viewable through the console tab inside a browser's Developer Tools. See the [Troubleshooting Console Log Errors](https://support.discord.com/hc/en-us/articles/115001239472-Troubleshooting-Console-Log-Errors) support article for more information. +Desktop logs are viewable through the console tab inside a browser's Developer Tools. See the [Troubleshooting Console Log Errors](https://support.discord.com/hc/en-us/articles/115001239472) support article for more information. The Public Test Build (PTB) Discord client also allows inspecting your logs from the `View -> Developer -> Toggle Developer Tools` menu. It can be downloaded at [https://discord.com/downloads](https://discord.com/downloads). @@ -440,7 +440,7 @@ User Experience ### Setting Up an Entry Point Command -An [Entry Point command](/docs/interactions/application-commands#entry-point-commands) is required for users to be able to launch your Activity from the [App Launcher menu](https://support.discord.com/hc/articles/21334461140375-Using-Apps-on-Discord#h_01HRQSA6C8TRHS722P1H3HW1TV) in Discord. +An [Entry Point command](/docs/interactions/application-commands#entry-point-commands) is required for users to be able to launch your Activity from the [App Launcher menu](https://support-apps.discord.com/hc/en-us/articles/26593412574359#h_01J8JFFXHTHT2XP9C1NYPSZR0T) in Discord. When you enable Activities in your [app's settings](https://discord.com/developers/applications), a [default Entry Point command](/docs/interactions/application-commands#default-entry-point-command) is automatically created for your app. The default Entry Point command will use the `DISCORD_LAUNCH_ACTIVITY` (`2`) [handler type](/docs/interactions/application-commands#application-command-object-entry-point-command-handler-types), which means that Discord automatically launches your Activity for the user and posts a follow-up message into the channel where it was launched from. diff --git a/docs/change-log/2018-02-05-enhancement-new-message-properties.md b/docs/change-log/2018-02-05-enhancement-new-message-properties.md index 07b2deed88..873798515e 100644 --- a/docs/change-log/2018-02-05-enhancement-new-message-properties.md +++ b/docs/change-log/2018-02-05-enhancement-new-message-properties.md @@ -3,4 +3,4 @@ title: "Enhancement: New Message Properties" date: "2018-02-05" --- -Additional `activity` and `application` fields—as well as corresponding object documentation—have been added to the [Message](/docs/resources/message#message-object) object in support of our newly-released [Spotify integration](https://support.discord.com/hc/en-us/articles/360000167212-Discord-Spotify-Connection) and previous Rich Presence enhancements. +Additional `activity` and `application` fields—as well as corresponding object documentation—have been added to the [Message](/docs/resources/message#message-object) object in support of our newly-released [Spotify integration](https://support.discord.com/hc/en-us/articles/360000167212) and previous Rich Presence enhancements. diff --git a/docs/change-log/2019-05-29-added-info-around-nitro-boosting-experiment.md b/docs/change-log/2019-05-29-added-info-around-nitro-boosting-experiment.md index 07fe17274a..2102a0cd42 100644 --- a/docs/change-log/2019-05-29-added-info-around-nitro-boosting-experiment.md +++ b/docs/change-log/2019-05-29-added-info-around-nitro-boosting-experiment.md @@ -3,4 +3,4 @@ title: "Added Info Around Nitro Boosting Experiment" date: "2019-05-29" --- -Additional information has been documented to support [Server Nitro Boosting](https://support.discord.com/hc/en-us/articles/360028038352-Server-Boosting). This includes the addition of a few [message types](/docs/resources/message#message-object-message-types), as well as some [new fields on guilds](/docs/resources/guild#guild-object-premium-tier). Please note that this feature is currently under experimentation, and these fields may be subject to change. +Additional information has been documented to support [Server Nitro Boosting](https://support.discord.com/hc/en-us/articles/360028038352). This includes the addition of a few [message types](/docs/resources/message#message-object-message-types), as well as some [new fields on guilds](/docs/resources/guild#guild-object-premium-tier). Please note that this feature is currently under experimentation, and these fields may be subject to change. diff --git a/docs/change-log/2022-02-14-api-v10.md b/docs/change-log/2022-02-14-api-v10.md index cb647a2452..649ffbf1c7 100644 --- a/docs/change-log/2022-02-14-api-v10.md +++ b/docs/change-log/2022-02-14-api-v10.md @@ -16,5 +16,5 @@ date: "2022-02-14" #### Upcoming changes * API v6 and v7 will be decommissioned **in early 2023** -* `MESSAGE_CONTENT` is becoming a privileged intent for verified bots in 75+ servers **on August 31, 2022**. Read details in [the FAQ](https://support-dev.discord.com/hc/en-us/articles/4404772028055-Message-Content-Privileged-Intent-FAQ) or follow [the guide](/docs/tutorials/upgrading-to-application-commands) on updating your app. +* `MESSAGE_CONTENT` is becoming a privileged intent for verified bots in 75+ servers **on August 31, 2022**. Read details in [the FAQ](https://support-dev.discord.com/hc/en-us/articles/4404772028055) or follow [the guide](/docs/tutorials/upgrading-to-application-commands) on updating your app. * The `summary` field for applications will be removed in the next API version (v11) diff --git a/docs/change-log/2022-09-01-message-content-is-a-privileged-intent.md b/docs/change-log/2022-09-01-message-content-is-a-privileged-intent.md index 871f445f18..3bac1a5d14 100644 --- a/docs/change-log/2022-09-01-message-content-is-a-privileged-intent.md +++ b/docs/change-log/2022-09-01-message-content-is-a-privileged-intent.md @@ -4,7 +4,7 @@ date: "2022-09-01" breaking: true --- -As of today, [message content](/docs/events/gateway#message-content-intent) is a privileged intent for all verified apps *and* apps eligible for verification. More details about why it's becoming a privileged intent and how to apply for it is in the [Help Center FAQ](https://support-dev.discord.com/hc/articles/4404772028055-Message-Content-Privileged-Intent-FAQ). +As of today, [message content](/docs/events/gateway#message-content-intent) is a privileged intent for all verified apps *and* apps eligible for verification. More details about why it's becoming a privileged intent and how to apply for it is in the [Help Center FAQ](https://support-dev.discord.com/hc/en-us/articles/4404772028055). Any app that does not have the message content intent configured in its app's settings within the Developer Portal will receive empty values in fields that expose message content across Discord's APIs (including the `content`, `embeds`, `attachments`, and `components` fields). These restrictions do not apply for messages that a bot or app sends, in DMs that it receives, or in messages in which it is mentioned. diff --git a/docs/change-log/2022-09-14-forum-channels-release.md b/docs/change-log/2022-09-14-forum-channels-release.md index c94ee3f568..934c0135c6 100644 --- a/docs/change-log/2022-09-14-forum-channels-release.md +++ b/docs/change-log/2022-09-14-forum-channels-release.md @@ -5,4 +5,4 @@ date: "2022-09-14" Forum channels ([`GUILD_FORUM` or `15`](/docs/resources/channel#channel-object-channel-types)) have been released to all community servers. `GUILD_FORUM` channels are a new channel type that only supports threads, which display differently than in text (`GUILD_TEXT`) channels. -Check out the [forums topic](/docs/topics/threads#forums) for more information on the relevant APIs and technical details, and the [Forums FAQ](https://support.discord.com/hc/en-us/articles/6208479917079-Forum-Channels-FAQ#h_01G69FJQWTWN88HFEHK7Z6X79N) for more about the feature. +Check out the [forums topic](/docs/topics/threads#forums) for more information on the relevant APIs and technical details, and the [Forums FAQ](https://support.discord.com/hc/en-us/articles/6208479917079#h_01JAZAWCX4DXYK26BKT49DXMAQ) for more about the feature. diff --git a/docs/change-log/2023-05-03-unique-usernames-on-discord.md b/docs/change-log/2023-05-03-unique-usernames-on-discord.md index 2ed79e2567..2c05a66ec7 100644 --- a/docs/change-log/2023-05-03-unique-usernames-on-discord.md +++ b/docs/change-log/2023-05-03-unique-usernames-on-discord.md @@ -4,9 +4,9 @@ date: "2023-05-03" --- > warn -> Bot users will stay on the legacy username system for now. More details can be found on the [Developer Help Center article](https://dis.gd/app-usernames). +> Bot users will stay on the legacy username system for now. More details can be found on the [Developer Help Center article](https://support-dev.discord.com/hc/en-us/articles/13667755828631). -Discord’s username system is changing. Discriminators are being removed and new, unique usernames and display names are being introduced. You can read more details about how changes to the username system affects non-bot users in the [general Help Center article](https://dis.gd/usernames). To learn how it impacts bot users specifically, you can read the [Developer Help Center article](https://dis.gd/app-usernames). +Discord’s username system is changing. Discriminators are being removed and new, unique usernames and display names are being introduced. You can read more details about how changes to the username system affects non-bot users in the [general Help Center article](https://support.discord.com/hc/en-us/articles/12620128861463). To learn how it impacts bot users specifically, you can read the [Developer Help Center article](https://support-dev.discord.com/hc/en-us/articles/13667755828631). This changelog focuses only on the technical changes to be aware of to update your app's code. diff --git a/docs/change-log/2024-06-27-user-installed-apps-general-availability.md b/docs/change-log/2024-06-27-user-installed-apps-general-availability.md index 86923c9485..b122b6925d 100644 --- a/docs/change-log/2024-06-27-user-installed-apps-general-availability.md +++ b/docs/change-log/2024-06-27-user-installed-apps-general-availability.md @@ -21,7 +21,7 @@ With this update, there are a few API and behavioral updates for user-installed A new [`USE_EXTERNAL_APPS` (`1 << 50`) permission](/docs/topics/permissions#permissions-bitwise-permission-flags) was added, and is enabled for servers by default. The new permission lets modmins control whether user-installed apps can post public replies in a server. If `Use External Apps` is disabled and your app is *not* installed to the server, your app’s responses will be ephemeral for the end user. -Read more in the [Moderating Apps on Discord Help Center article](https://support.discord.com/hc/en-us/articles/23957313048343-Moderating-Apps-on-Discord#h_01HZQQQEADYVN2CM4AX4EZGKHM). +Read more in the [Moderating Apps on Discord Help Center article](https://support-apps.discord.com/hc/en-us/articles/26501864012951#h_01HZQQQEADYVN2CM4AX4EZGKHM). ###### Updated Defaults for New Apps diff --git a/docs/change-log/2024-09-26-activities-general-availability.md b/docs/change-log/2024-09-26-activities-general-availability.md index b74444e6ad..73caefc1ab 100644 --- a/docs/change-log/2024-09-26-activities-general-availability.md +++ b/docs/change-log/2024-09-26-activities-general-availability.md @@ -7,7 +7,7 @@ topics: - "Premium Apps" --- -Following up on [the rollout of the App Launcher](https://discord.com/blog/discover-more-ways-to-play-with-apps-now-anywhere-on-discord), we’re excited to announce that [Activities](/docs/activities/overview) are now generally available for developers. In addition to API stability, this means that apps with Activities can now be [verified](https://support-dev.discord.com/hc/en-us/articles/23926564536471-How-Do-I-Get-My-App-Verified), [discoverable](/docs/discovery/enabling-discovery) in the App Directory, and [implement monetization](/docs/monetization/overview). +Following up on [the rollout of the App Launcher](https://discord.com/blog/discover-more-ways-to-play-with-apps-now-anywhere-on-discord), we’re excited to announce that [Activities](/docs/activities/overview) are now generally available for developers. In addition to API stability, this means that apps with Activities can now be [verified](https://support-dev.discord.com/hc/en-us/articles/23926564536471), [discoverable](/docs/discovery/enabling-discovery) in the App Directory, and [implement monetization](/docs/monetization/overview). ### Recent API Updates diff --git a/docs/change-log/2025-04-15-deprecating-guild-createion-by-apps.md b/docs/change-log/2025-04-15-deprecating-guild-createion-by-apps.md index 1203567e8c..18ce33b7f1 100644 --- a/docs/change-log/2025-04-15-deprecating-guild-createion-by-apps.md +++ b/docs/change-log/2025-04-15-deprecating-guild-createion-by-apps.md @@ -26,4 +26,4 @@ If your app is affected, you will receive a migration plan via Discord System DM We understand this change may affect some legitimate use cases. If you have questions or believe your application requires continued access to guild creation functionality, please contact us through -the [Developer Support portal](https://support-dev.discord.com/hc). \ No newline at end of file +the [Developer Support portal](https://support-dev.discord.com/hc/en-us). \ No newline at end of file diff --git a/docs/developer-tools/game-sdk.mdx b/docs/developer-tools/game-sdk.mdx index a20a23885b..2c5cd8188f 100644 --- a/docs/developer-tools/game-sdk.mdx +++ b/docs/developer-tools/game-sdk.mdx @@ -1137,7 +1137,7 @@ activityManager.UpdateActivity(activity, (result) => ## Overlay > warn -> The overlay is only supported on Windows for DirectX or OpenGL games. Linux, Mac, and games using Vulkan are not supported. [Click here for more info.](https://support.discord.com/hc/en-us/articles/217659737-Games-Overlay-101) +> The overlay is only supported on Windows for DirectX or OpenGL games. Linux, Mac, and games using Vulkan are not supported. [Click here for more info.](https://support.discord.com/hc/en-us/articles/217659737) Discord comes with an awesome built-in overlay, and you may want to make use of it for your game. This manager will help you do just that! It gives you the current state of the overlay for the user, and allows you to update that state. diff --git a/docs/discord-social-sdk/design-guidelines/signing-in.mdx b/docs/discord-social-sdk/design-guidelines/signing-in.mdx index b098200d26..d5f7d424f1 100644 --- a/docs/discord-social-sdk/design-guidelines/signing-in.mdx +++ b/docs/discord-social-sdk/design-guidelines/signing-in.mdx @@ -29,7 +29,7 @@ A player can also proceed **without** connecting their Discord and continue onwa ## Overlay Authorization -Discord's [Overlay](https://support.discord.com/hc/en-us/articles/217659737-Game-Overlay-101) feature can be used to enable authorization without ever leaving the game. This is available for games who support the feature. +Discord's [Overlay](https://support.discord.com/hc/en-us/articles/217659737) feature can be used to enable authorization without ever leaving the game. This is available for games who support the feature. ![Overlay Authorization](images/social-sdk/design-guidelines/SigningIn-05.png) diff --git a/docs/discord-social-sdk/development-guides/account-linking-with-discord.mdx b/docs/discord-social-sdk/development-guides/account-linking-with-discord.mdx index d1c2307c18..7110bed47b 100644 --- a/docs/discord-social-sdk/development-guides/account-linking-with-discord.mdx +++ b/docs/discord-social-sdk/development-guides/account-linking-with-discord.mdx @@ -45,7 +45,7 @@ OAuth2 is the standard authentication flow that allows users to sign in using th ### OAuth2 using the Discord Social SDK -- If the Discord client has [overlay support](https://support.discord.com/hc/en-us/articles/217659737-Game-Overlay-101) (Windows only), the OAuth2 login modal appears in your game instead of opening a browser. +- If the Discord client has [overlay support](https://support.discord.com/hc/en-us/articles/217659737) (Windows only), the OAuth2 login modal appears in your game instead of opening a browser. - The SDK automatically handles redirects, simplifying the authentication flow. - Some security measures, such as CSRF protection, are built-in, but you should always follow best practices to secure your app. diff --git a/docs/discord-social-sdk/development-guides/managing-game-invites.mdx b/docs/discord-social-sdk/development-guides/managing-game-invites.mdx index dc76ce4d06..24a2b796f2 100644 --- a/docs/discord-social-sdk/development-guides/managing-game-invites.mdx +++ b/docs/discord-social-sdk/development-guides/managing-game-invites.mdx @@ -184,7 +184,7 @@ Game invites can be sent in two ways: ### Sending Game Invites in the Discord Client -Users can send game invites directly through the Discord client. This feature is described in detail in the [Game Invites help center article](https://support.discord.com/hc/en-us/articles/115001557452-Game-Invites). +Users can send game invites directly through the Discord client. This feature is described in detail in the [Game Invites help center article](https://support.discord.com/hc/en-us/articles/115001557452). ### Sending Game Invites in the SDK @@ -209,7 +209,7 @@ Game invites can also be received in two ways: ### Receiving Game Invites in the Discord Client -Users can receive game invites directly in their DMs. This feature is described in detail in the [Game Invites help center article](https://support.discord.com/hc/en-us/articles/115001557452-Game-Invites). +Users can receive game invites directly in their DMs. This feature is described in detail in the [Game Invites help center article](https://support.discord.com/hc/en-us/articles/115001557452). ### Receiving Game Invites in the SDK diff --git a/docs/discovery/best-practices.md b/docs/discovery/best-practices.md index 16c5821a86..c30392e5f4 100644 --- a/docs/discovery/best-practices.md +++ b/docs/discovery/best-practices.md @@ -77,7 +77,7 @@ Think of up to five words that describe your app and add them as tags (see image Your app’s support server is a paramount part of your App Product Page. It’s important to ensure your app has a dedicated server and channel for communication between your app’s users and its developers and maintainers. > info -> If your support server isn't [discoverable](https://support.discord.com/hc/en-us/articles/360030843331-Enabling-Server-Discovery), be sure to include an invite link in the "links" section of your App Directory Product Page. +> If your support server isn't [discoverable](https://support.discord.com/hc/en-us/articles/360030843331), be sure to include an invite link in the "links" section of your App Directory Product Page. Some ways you can successfully use your support server includes: @@ -91,8 +91,8 @@ For general best practices on how to run a server, check out our [Community page ### Final checks to make sure you’re ready to go -Before you can click the final “Enable Discovery” button, ensure that your App Directory Product Page complies with the rest of Discord’s Directory eligibility criteria, [app content requirements](https://support-dev.discord.com/hc/en-us/articles/9489299950487-App-Directory-App-Content-Requirements-Policy) and Developer [Terms of Service](https://support-dev.discord.com/hc/en-us/articles/8562894815383) and [Policy](https://support-dev.discord.com/hc/en-us/articles/8563934450327). +Before you can click the final “Enable Discovery” button, ensure that your App Directory Product Page complies with the rest of Discord’s Directory eligibility criteria, [app content requirements](https://support-dev.discord.com/hc/en-us/articles/9489299950487) and Developer [Terms of Service](https://support-dev.discord.com/hc/en-us/articles/8562894815383) and [Policy](https://support-dev.discord.com/hc/en-us/articles/8563934450327). -For more details about what this information entails, read our [Help Center article on Profile Pages](https://support-dev.discord.com/hc/en-us/articles/6378525413143-App-Directory-App-profile-pages). +For more details about what this information entails, read our [Help Center article on Profile Pages](https://support-dev.discord.com/hc/en-us/articles/6378525413143). Now you're ready to publish your new App Directory profile and watch your app grow! If you haven’t already, join our official [Discord Developers server](https://discord.gg/discord-developers) to receive more information on how to update your apps. Way to go, Discord Developer! diff --git a/docs/discovery/enabling-discovery.mdx b/docs/discovery/enabling-discovery.mdx index cde564641e..ccf695215d 100644 --- a/docs/discovery/enabling-discovery.mdx +++ b/docs/discovery/enabling-discovery.mdx @@ -18,7 +18,7 @@ To see the list of requirements for **App Verification**: 3. Complete the listed App Verification qualification criteria for your app. 4. Once you've completed the requirements, you can submit your app for verification. -For more information on **App Verification**, check out our [Help Center article](https://support-dev.discord.com/hc/en-us/articles/23926564536471-How-Do-I-Get-My-App-Verified). +For more information on **App Verification**, check out our [Help Center article](https://support-dev.discord.com/hc/en-us/articles/23926564536471). ## Step 2: Opt into Discovery @@ -32,7 +32,7 @@ To opt into **Discovery**: 4. Add your app metadata and images under the `Discovery -> Discovery Settings` menu to customize your app's appearance in discovery surfaces. 4. Once you've completed the requirements, you can enable **Discovery** for your app. -For more information on **Discovery**, check out our [Help Center article](https://support-dev.discord.com/hc/en-us/articles/21204493235991-How-Can-Users-Discover-and-Play-My-Activity). +For more information on **Discovery**, check out our [Help Center article](https://support-dev.discord.com/hc/en-us/articles/21204493235991). > info > Once you enable **Discovery**, it may take up to 24 hours for your app to appear in the App Directory and App Launcher. diff --git a/docs/events/gateway-events.mdx b/docs/events/gateway-events.mdx index 3a613d010c..5792e0756b 100644 --- a/docs/events/gateway-events.mdx +++ b/docs/events/gateway-events.mdx @@ -768,11 +768,11 @@ Sent when a guild member is updated. This will also fire when the user object of | avatar | ?string | Member's [guild avatar hash](/docs/reference#image-formatting) | | banner | ?string | Member's [guild banner hash](/docs/reference#image-formatting) | | joined_at | ?ISO8601 timestamp | When the user joined the guild | -| premium_since? | ?ISO8601 timestamp | When the user starting [boosting](https://support.discord.com/hc/en-us/articles/360028038352-Server-Boosting-) the guild | +| premium_since? | ?ISO8601 timestamp | When the user starting [boosting](https://support.discord.com/hc/en-us/articles/360028038352) the guild | | deaf? | boolean | Whether the user is deafened in voice channels | | mute? | boolean | Whether the user is muted in voice channels | | pending? | boolean | Whether the user has not yet passed the guild's [Membership Screening](/docs/resources/guild#membership-screening-object) requirements | -| communication_disabled_until? | ?ISO8601 timestamp | When the user's [timeout](https://support.discord.com/hc/en-us/articles/4413305239191-Time-Out-FAQ) will expire and the user will be able to communicate in the guild again, null or a time in the past if the user is not timed out | +| communication_disabled_until? | ?ISO8601 timestamp | When the user's [timeout](https://support.discord.com/hc/en-us/articles/4413305239191) will expire and the user will be able to communicate in the guild again, null or a time in the past if the user is not timed out | | flags? | integer | [Guild member flags](/docs/resources/guild#guild-member-object-guild-member-flags) represented as a bit set, defaults to 0 | | avatar_decoration_data? | ?[avatar decoration data](/docs/resources/user#avatar-decoration-data-object) | Data for the member's guild avatar decoration | diff --git a/docs/events/gateway.mdx b/docs/events/gateway.mdx index 5abf08e629..116ba4c0e9 100644 --- a/docs/events/gateway.mdx +++ b/docs/events/gateway.mdx @@ -432,7 +432,7 @@ Some intents are defined as "privileged" due to the sensitive nature of the data Apps that qualify for verification **must** be approved for the privileged intent(s) before they can use them. After your app is verified, you can request privileged intents within the app's settings within the Developer Portal. -Before you specify privileged intents in your `IDENTIFY` payload, you must enable the privileged intents your app requires. [Verified apps](https://support-dev.discord.com/hc/en-us/articles/23926564536471-How-Do-I-Get-My-App-Verified) can only use privileged intents *after* they've been approved for them. +Before you specify privileged intents in your `IDENTIFY` payload, you must enable the privileged intents your app requires. [Verified apps](https://support-dev.discord.com/hc/en-us/articles/23926564536471) can only use privileged intents *after* they've been approved for them. > info > Unverified apps can use privileged intents without approval, but still must enable them in their app's settings. If the app's verification status changes, it will then have to apply for the privileged intent(s). @@ -443,7 +443,7 @@ In addition to the gateway restrictions described here, Discord's REST API is al Before using privileged intents, you must enable them in your app's settings. In the [Developer Portal](https://discord.com/developers/applications), you can navigate to your app's settings then toggle the privileged intents on the **Bots** page under the "Privileged Gateway Intents" section. You should only toggle privileged intents that your bot *requires to function*. -If your app qualifies for [verification](https://support-dev.discord.com/hc/en-us/articles/23926564536471-How-Do-I-Get-My-App-Verified), you must first [verify your app](https://support-dev.discord.com/hc/en-us/articles/23926564536471-How-Do-I-Get-My-App-Verified) and request access to these intents during the verification process. If your app is already verified and you need to request additional privileged intents, you can [contact support](https://dis.gd/support). +If your app qualifies for [verification](https://support-dev.discord.com/hc/en-us/articles/23926564536471), you must first [verify your app](https://support-dev.discord.com/hc/en-us/articles/23926564536471) and request access to these intents during the verification process. If your app is already verified and you need to request additional privileged intents, you can [contact support](https://dis.gd/support). #### Gateway Restrictions diff --git a/docs/interactions/application-commands.mdx b/docs/interactions/application-commands.mdx index 1fd42aaade..0e48f5914c 100644 --- a/docs/interactions/application-commands.mdx +++ b/docs/interactions/application-commands.mdx @@ -977,7 +977,7 @@ When someone uses a message command, your application will receive an interactio ## Entry Point Commands -An Entry Point command serves as the primary way for users to open an app's [Activity](/docs/activities/overview) from the [App Launcher](https://support.discord.com/hc/articles/21334461140375-Using-Apps-on-Discord#h_01HRQSA6C8TRHS722P1H3HW1TV). +An Entry Point command serves as the primary way for users to open an app's [Activity](/docs/activities/overview) from the [App Launcher](https://support-apps.discord.com/hc/en-us/articles/26593412574359#h_01J8JFFXHTHT2XP9C1NYPSZR0T). For the Entry Point command to be visible to users, an app must have [Activities](/docs/activities/overview) enabled. ![Entry Point command in App Launcher](images/command-entry-point.png) @@ -1128,7 +1128,7 @@ A command that contains age-restricted content should have the [`nsfw` field](/d ### Using Age-Restricted Commands To use an age-restricted command, a user must be 18 years or older and access the command from either: -- an [age-restricted channel](https://support.discord.com/hc/articles/115000084051-Age-Restricted-Channels-and-Content) or +- an [age-restricted channel](https://support.discord.com/hc/en-us/articles/115000084051) or - a DM with the app *after* [enabling age-restricted commands](https://support.discord.com/hc/en-us/articles/10123937946007) within their User Settings. Details about accessing and using age-restricted commands is in [the Help Center](https://support.discord.com/hc/en-us/articles/10123937946007). diff --git a/docs/intro.mdx b/docs/intro.mdx index 815df361e3..5501c738b8 100644 --- a/docs/intro.mdx +++ b/docs/intro.mdx @@ -81,7 +81,7 @@ Connect with the developer community, report issues, and stay updated with API c Submit API bugs, feature requests, or contribute to the documentation. - + Find articles, FAQs, and reach out to Discord's developer support team. diff --git a/docs/monetization/enabling-monetization.mdx b/docs/monetization/enabling-monetization.mdx index 1a7c18950d..e046df6593 100644 --- a/docs/monetization/enabling-monetization.mdx +++ b/docs/monetization/enabling-monetization.mdx @@ -18,7 +18,7 @@ Once these are complete, you can [create SKUs](/docs/monetization/managing-skus# Before monetization can be enabled, you will need: - A [team](/docs/topics/teams) in the developer portal. If you don't have one, you can [create one on the Teams page](https://discord.com/developers/teams) -- A [verified app](https://support-dev.discord.com/hc/en-us/articles/23926564536471-How-Do-I-Get-My-App-Verified) that is _owned by that team_ +- A [verified app](https://support-dev.discord.com/hc/en-us/articles/23926564536471) that is _owned by that team_ - Your app and team must be eligible for monetization. See the Eligibility Checklist below for details. ## Step 2. Complete the Eligibility Checklist @@ -37,7 +37,7 @@ Before you can start creating SKUs and offering payments in your app, your app a - This document should clearly and accurately describe to users of your app the user data you collect and how you use and share such data with us and third parties, consistent with our Developer Terms of Service and Developer Policy. - App must not contain any harmful or bad language in the name, description, commands, or role connection metadata. - Payouts must be set up with a valid payment method -- Agreement to the [Monetization Terms](https://support.discord.com/hc/articles/5330075836311) and [Discord Developer Policy](https://support-dev.discord.com/hc/en-us/articles/8563934450327-Discord-Developer-Policy). +- Agreement to the [Monetization Terms](https://support.discord.com/hc/en-us/articles/5330075836311) and [Discord Developer Policy](https://support-dev.discord.com/hc/en-us/articles/8563934450327). ## Step 3. Set Up Team Payouts @@ -60,7 +60,7 @@ Let's set up Team Payouts so you can get paid! Discord processes all payouts thr > info > Premium Apps is not currently available outside of these regions. These features will be made available to more regions soon. -For more information, read the [Premium Apps Payouts](https://support-dev.discord.com/hc/articles/17299902720919) Help Center article. +For more information, read the [Premium Apps Payouts](https://support-dev.discord.com/hc/en-us/articles/17299902720919) Help Center article. ## Step 4: Create Your Premium Offering diff --git a/docs/quick-start/getting-started.mdx b/docs/quick-start/getting-started.mdx index 6ee1b3e0d1..5c31ed4eb2 100644 --- a/docs/quick-start/getting-started.mdx +++ b/docs/quick-start/getting-started.mdx @@ -120,7 +120,7 @@ On the left hand sidebar in your app's settings, there's a **Bot** page (where w Intents determine which events Discord will send your app when you're creating a [Gateway API connection](/docs/events/gateway). For example, if you want your app to perform an action when users add a reaction to a message, you can pass the `GUILD_MESSAGE_REACTIONS` (`1 << 10`) intent. -Some intents are [privileged](/docs/events/gateway#privileged-intents), meaning they allow your app to access data that may be considered sensitive (like the contents of messages). Privileged intents can be toggled on the **Bot** page in your app's settings, but they must be approved before you [verify your app](https://support-dev.discord.com/hc/en-us/articles/23926564536471-How-Do-I-Get-My-App-Verified). Standard, non-privileged intents don't require any additional permissions or configurations. +Some intents are [privileged](/docs/events/gateway#privileged-intents), meaning they allow your app to access data that may be considered sensitive (like the contents of messages). Privileged intents can be toggled on the **Bot** page in your app's settings, but they must be approved before you [verify your app](https://support-dev.discord.com/hc/en-us/articles/23926564536471). Standard, non-privileged intents don't require any additional permissions or configurations. More information about intents and a full list of available intents (along with their associated events) is in the [Gateway documentation](/docs/events/gateway#gateway-intents). @@ -173,7 +173,7 @@ See a list of all [OAuth2 scopes](/docs/topics/oauth2#shared-resources-oauth2-sc ### Installing your app > info -> When developing apps, you should build and test on your user account (for user-installable apps) and in a server that isn't actively used by others (for server-installable apps). If you don't have your own server already, you can [create one for free](https://support.discord.com/hc/en-us/articles/204849977-How-do-I-create-a-server-). +> When developing apps, you should build and test on your user account (for user-installable apps) and in a server that isn't actively used by others (for server-installable apps). If you don't have your own server already, you can [create one for free](https://support.discord.com/hc/en-us/articles/204849977). Once you add scopes, copy the URL from the **Install Link** section from before. diff --git a/docs/reference.mdx b/docs/reference.mdx index f38b9cad2e..fd7e0abb75 100644 --- a/docs/reference.mdx +++ b/docs/reference.mdx @@ -397,7 +397,7 @@ https://cdn.discordapp.com/attachments/1012345678900020080/1234567891233211234/m ## Uploading Files > info -> The file upload size limit applies to each file in a request. The default limit is `10 MiB` for all users, but may be higher for users depending on their [Nitro](https://support.discord.com/hc/en-us/articles/115000435108-What-are-Nitro-Nitro-Basic) status or by the server's [Boost Tier](https://support.discord.com/hc/en-us/articles/360028038352-Server-Boosting-FAQ-#h_419c3bd5-addd-4989-b7cf-c7957ef92583). The `attachment_size_limit` value provided [when working with interactions](/docs/interactions/receiving-and-responding#interaction-object-interaction-structure) is calculated as the maximum of these values. +> The file upload size limit applies to each file in a request. The default limit is `10 MiB` for all users, but may be higher for users depending on their [Nitro](https://support.discord.com/hc/en-us/articles/115000435108) status or by the server's [Boost Tier](https://support.discord.com/hc/en-us/articles/360028038352#h_01HGX7DJ33Z5HGWCXJ6NKR2FTZ). The `attachment_size_limit` value provided [when working with interactions](/docs/interactions/receiving-and-responding#interaction-object-interaction-structure) is calculated as the maximum of these values. Some endpoints support file attachments, indicated by the `files[n]` parameter. To add file(s), the standard `application/json` body must be replaced by a `multipart/form-data` body. The JSON message body can optionally be provided using the `payload_json` parameter. diff --git a/docs/resources/channel.md b/docs/resources/channel.md index 93c1f43fa9..06beea0a9e 100644 --- a/docs/resources/channel.md +++ b/docs/resources/channel.md @@ -63,13 +63,13 @@ Represents a guild or DM channel within Discord. | DM | 1 | a direct message between users | | GUILD_VOICE | 2 | a voice channel within a server | | GROUP_DM | 3 | a direct message between multiple users | -| GUILD_CATEGORY | 4 | an [organizational category](https://support.discord.com/hc/en-us/articles/115001580171-Channel-Categories-101) that contains up to 50 channels | +| GUILD_CATEGORY | 4 | an [organizational category](https://support.discord.com/hc/en-us/articles/115001580171) that contains up to 50 channels | | GUILD_ANNOUNCEMENT | 5 | a channel that [users can follow and crosspost into their own server](https://support.discord.com/hc/en-us/articles/360032008192) (formerly news channels) | | ANNOUNCEMENT_THREAD | 10 | a temporary sub-channel within a GUILD_ANNOUNCEMENT channel | | PUBLIC_THREAD | 11 | a temporary sub-channel within a GUILD_TEXT or GUILD_FORUM channel | | PRIVATE_THREAD | 12 | a temporary sub-channel within a GUILD_TEXT channel that is only viewable by those invited and those with the MANAGE_THREADS permission | | GUILD_STAGE_VOICE | 13 | a voice channel for [hosting events with an audience](https://support.discord.com/hc/en-us/articles/1500005513722) | -| GUILD_DIRECTORY | 14 | the channel in a [hub](https://support.discord.com/hc/en-us/articles/4406046651927-Discord-Student-Hubs-FAQ) containing the listed servers | +| GUILD_DIRECTORY | 14 | the channel in a [hub](https://support.discord.com/hc/en-us/articles/4406046651927) containing the listed servers | | GUILD_FORUM | 15 | Channel that can only contain threads | | GUILD_MEDIA | 16 | Channel that can only contain threads, similar to `GUILD_FORUM` channels | diff --git a/docs/resources/guild.md b/docs/resources/guild.md index 5315462a8a..5b9b26af89 100644 --- a/docs/resources/guild.md +++ b/docs/resources/guild.md @@ -357,13 +357,13 @@ A partial [guild](/docs/resources/guild#guild-object) object. Represents an Offl | banner? | ?string | the member's [guild banner hash](/docs/reference#image-formatting) | | roles | array of snowflakes | array of [role](/docs/topics/permissions#role-object) object ids | | joined_at | ISO8601 timestamp | when the user joined the guild | -| premium_since? | ?ISO8601 timestamp | when the user started [boosting](https://support.discord.com/hc/en-us/articles/360028038352-Server-Boosting-) the guild | +| premium_since? | ?ISO8601 timestamp | when the user started [boosting](https://support.discord.com/hc/en-us/articles/360028038352) the guild | | deaf | boolean | whether the user is deafened in voice channels | | mute | boolean | whether the user is muted in voice channels | | flags | integer | [guild member flags](/docs/resources/guild#guild-member-object-guild-member-flags) represented as a bit set, defaults to `0` | | pending? | boolean | whether the user has not yet passed the guild's [Membership Screening](/docs/resources/guild#membership-screening-object) requirements | | permissions? | string | total permissions of the member in the channel, including overwrites, returned when in the interaction object | -| communication_disabled_until? | ?ISO8601 timestamp | when the user's [timeout](https://support.discord.com/hc/en-us/articles/4413305239191-Time-Out-FAQ) will expire and the user will be able to communicate in the guild again, null or a time in the past if the user is not timed out | +| communication_disabled_until? | ?ISO8601 timestamp | when the user's [timeout](https://support.discord.com/hc/en-us/articles/4413305239191) will expire and the user will be able to communicate in the guild again, null or a time in the past if the user is not timed out | | avatar_decoration_data? | ?[avatar decoration data](/docs/resources/user#avatar-decoration-data-object) object | data for the member's guild avatar decoration | > info @@ -543,7 +543,7 @@ A partial [guild](/docs/resources/guild#guild-object) object. Represents an Offl ### Guild Onboarding Object -Represents the [onboarding](https://support.discord.com/hc/en-us/articles/11074987197975-Community-Onboarding-FAQ) flow for a guild. +Represents the [onboarding](https://support.discord.com/hc/en-us/articles/11074987197975) flow for a guild. ###### Guild Onboarding Structure @@ -1025,7 +1025,7 @@ Modify attributes of a [guild member](/docs/resources/guild#guild-member-object) | mute | boolean | whether the user is muted in voice channels. Will throw a 400 error if the user is not in a voice channel | MUTE_MEMBERS | | deaf | boolean | whether the user is deafened in voice channels. Will throw a 400 error if the user is not in a voice channel | DEAFEN_MEMBERS | | channel_id | snowflake | id of channel to move user to (if they are connected to voice) | MOVE_MEMBERS | -| communication_disabled_until | ISO8601 timestamp | when the user's [timeout](https://support.discord.com/hc/en-us/articles/4413305239191-Time-Out-FAQ) will expire and the user will be able to communicate in the guild again (up to 28 days in the future), set to null to remove timeout. Will throw a 403 error if the user has the ADMINISTRATOR permission or is the owner of the guild | MODERATE_MEMBERS | +| communication_disabled_until | ISO8601 timestamp | when the user's [timeout](https://support.discord.com/hc/en-us/articles/4413305239191) will expire and the user will be able to communicate in the guild again (up to 28 days in the future), set to null to remove timeout. Will throw a 403 error if the user has the ADMINISTRATOR permission or is the owner of the guild | MODERATE_MEMBERS | | flags | integer | [guild member flags](/docs/resources/guild#guild-member-object-guild-member-flags) | MANAGE_GUILD or MANAGE_ROLES or (MODERATE_MEMBERS and KICK_MEMBERS and BAN_MEMBERS) | ## Modify Current Member % PATCH /guilds/||FIXME||guild.id||/docs/resources/guild#guild-object||/members/@me diff --git a/docs/resources/user.md b/docs/resources/user.md index c6832b3387..cde86c5d6f 100644 --- a/docs/resources/user.md +++ b/docs/resources/user.md @@ -88,7 +88,7 @@ There are other rules and restrictions not shared here for the sake of spam and | `1 << 17` | VERIFIED_DEVELOPER | Early Verified Bot Developer | | `1 << 18` | CERTIFIED_MODERATOR | Moderator Programs Alumni | | `1 << 19` | BOT_HTTP_INTERACTIONS | Bot uses only [HTTP interactions](/docs/interactions/receiving-and-responding#receiving-an-interaction) and is shown in the online member list | -| `1 << 22` | ACTIVE_DEVELOPER | User is an [Active Developer](https://support-dev.discord.com/hc/articles/10113997751447) | +| `1 << 22` | ACTIVE_DEVELOPER | User is an [Active Developer](https://support-dev.discord.com/hc/en-us/articles/10113997751447) | ###### Premium Types @@ -103,7 +103,7 @@ Premium types denote the level of premium a user has. Visit the [Nitro](https:// ### Avatar Decoration Data Object -The data for the user's [avatar decoration](https://support.discord.com/hc/en-us/articles/13410113109911-Avatar-Decorations). +The data for the user's [avatar decoration](https://support.discord.com/hc/en-us/articles/13410113109911). ###### Avatar Decoration Data Structure diff --git a/docs/resources/webhook.md b/docs/resources/webhook.md index 7106857d14..f4725b3c5f 100644 --- a/docs/resources/webhook.md +++ b/docs/resources/webhook.md @@ -239,7 +239,7 @@ Refer to [Slack's documentation](https://api.slack.com/incoming-webhooks) for mo ## Execute GitHub-Compatible Webhook % POST /webhooks/||FIXME||webhook.id||/docs/resources/webhook#webhook-object||/||FIXME||webhook.token||/docs/resources/webhook#webhook-object||/github -[Add a new webhook](https://support.discord.com/hc/en-us/articles/228383668-Intro-to-Webhooks) to your GitHub repo (in the repo's settings), and use this endpoint as the "Payload URL." You can choose what events your Discord channel receives by choosing the "Let me select individual events" option and selecting individual events for the new webhook you're configuring. The supported [events](https://docs.github.com/en/webhooks/webhook-events-and-payloads) are `commit_comment`, `create`, `delete`, `fork`, `issue_comment`, `issues`, `member`, `public`, `pull_request`, `pull_request_review`, `pull_request_review_comment`, `push`, `release`, `watch`, `check_run`, `check_suite`, `discussion`, and `discussion_comment`. +[Add a new webhook](https://support.discord.com/hc/en-us/articles/228383668) to your GitHub repo (in the repo's settings), and use this endpoint as the "Payload URL." You can choose what events your Discord channel receives by choosing the "Let me select individual events" option and selecting individual events for the new webhook you're configuring. The supported [events](https://docs.github.com/en/webhooks/webhook-events-and-payloads) are `commit_comment`, `create`, `delete`, `fork`, `issue_comment`, `issues`, `member`, `public`, `pull_request`, `pull_request_review`, `pull_request_review_comment`, `push`, `release`, `watch`, `check_run`, `check_suite`, `discussion`, and `discussion_comment`. ###### Query String Params diff --git a/docs/topics/oauth2.md b/docs/topics/oauth2.md index 500ec64cca..aca9e47f30 100644 --- a/docs/topics/oauth2.md +++ b/docs/topics/oauth2.md @@ -265,13 +265,13 @@ Discord's API provides bot users, which are a separate type of user dedicated to ### Bot vs User Accounts > warn -> Developers must abide by the [terms of service](https://support-dev.discord.com/hc/articles/8562894815383-Discord-Developer-Terms-of-Service), which includes refraining from automating standard user accounts (generally called "self-bots") outside of the OAuth2/bot API. +> Developers must abide by the [terms of service](https://support-dev.discord.com/hc/en-us/articles/8562894815383), which includes refraining from automating standard user accounts (generally called "self-bots") outside of the OAuth2/bot API. Bot users have a few differences compared to standard Discord users: 1. Bots are added to guilds through the OAuth2 API, and cannot accept normal invites. 2. Bots cannot have friends or be added to or join Group DMs. -3. [Verified bots](https://support-dev.discord.com/hc/en-us/articles/23926564536471-How-Do-I-Get-My-App-Verified) do not have a maximum number of guilds. +3. [Verified bots](https://support-dev.discord.com/hc/en-us/articles/23926564536471) do not have a maximum number of guilds. 4. Bots have an entirely separate set of [rate limits](/docs/topics/rate-limits#rate-limits). ### Bot Authorization Flow diff --git a/docs/topics/teams.md b/docs/topics/teams.md index 29e573173a..01d3575157 100644 --- a/docs/topics/teams.md +++ b/docs/topics/teams.md @@ -4,7 +4,7 @@ Teams are groups of developers (or other Discord users) who want to collaborate ## Creating a Team -To create or be a member on a team, you must [enable 2FA for your Discord account](https://support.discord.com/hc/en-us/articles/219576828-Setting-up-Two-Factor-Authentication). After you have 2FA enabled, create a team by navigating to the [Teams page](https://discord.com/developers/teams) then clicking the "New Team" button. +To create or be a member on a team, you must [enable 2FA for your Discord account](https://support.discord.com/hc/en-us/articles/219576828). After you have 2FA enabled, create a team by navigating to the [Teams page](https://discord.com/developers/teams) then clicking the "New Team" button. ![Screenshot of the Teams page](images/team-page.png) diff --git a/docs/topics/threads.md b/docs/topics/threads.md index cd9bdff416..e65a664846 100644 --- a/docs/topics/threads.md +++ b/docs/topics/threads.md @@ -200,7 +200,7 @@ A `GUILD_FORUM` (type `15`) channel is similar to a `GUILD_TEXT` channel, except Messages cannot be sent directly in forum channels. > info -> More information about forum channels and how they appear in Discord can be found in the [Forum Channels FAQ](https://support.discord.com/hc/en-us/articles/6208479917079-Forum-Channels-FAQ#h_01G69FJQWTWN88HFEHK7Z6X79N) +> More information about forum channels and how they appear in Discord can be found in the [Forum Channels FAQ](https://support.discord.com/hc/en-us/articles/6208479917079#h_01JAZAWCX4DXYK26BKT49DXMAQ) ## Media Channels diff --git a/docs/tutorials/upgrading-to-application-commands.md b/docs/tutorials/upgrading-to-application-commands.md index e041d18a44..43ad1de316 100644 --- a/docs/tutorials/upgrading-to-application-commands.md +++ b/docs/tutorials/upgrading-to-application-commands.md @@ -4,7 +4,7 @@ sidebar_label: Upgrading to Application Commands # Upgrading Apps to Use Application Commands -As [message content has become a privileged intent](https://support-dev.discord.com/hc/en-us/articles/4404772028055-Message-Content-Privileged-Intent-FAQ) for verified apps, [application commands](/docs/interactions/application-commands) are the primary way Discord users interact with apps. The three types of commands (slash commands, user commands, and message commands) act as entry points into apps, and can be registered globally or for a subset of guilds. +As [message content has become a privileged intent](https://support-dev.discord.com/hc/en-us/articles/4404772028055) for verified apps, [application commands](/docs/interactions/application-commands) are the primary way Discord users interact with apps. The three types of commands (slash commands, user commands, and message commands) act as entry points into apps, and can be registered globally or for a subset of guilds. This guide is intended to provide developers with apps currently using message content with a resource to walk through implementing and designing commands. Throughout the guide, the terms "application commands" and "commands" are used interchangeably. @@ -299,5 +299,5 @@ This can come in the form of a specific command that shows app usage, a message Hopefully this guide was helpful in considering how to design and implement application commands. Below is a couple of follow-up resources you can use: - [Application command documentation](/docs/interactions/application-commands)—I know it's linked a bunch in this guide, but there's a reason! -- Help center article on [message content intent workarounds](https://support-dev.discord.com/hc/en-us/articles/6383579033751-Message-Content-Intent-Alternatives-Workarounds) -- The [DDevs server](https://discord.gg/discord-developers) where you can find API updates, ask questions about developing apps, and connect with other developers +- Help center article on [message content intent alternatives](https://support-dev.discord.com/hc/en-us/articles/6383579033751) +- The official [Discord Developers Server](https://discord.gg/discord-developers) where you can find API updates, ask questions about developing apps, and connect with other developers From 4354cb92eb66add0116beec2483f70aa4f8d7a5d Mon Sep 17 00:00:00 2001 From: GeniusTimo Date: Sun, 20 Apr 2025 13:18:06 +0200 Subject: [PATCH 09/20] Fixed table indentation once again --- docs/events/gateway-events.mdx | 30 +++++++++++----------- docs/resources/channel.md | 4 +-- docs/resources/guild.md | 46 +++++++++++++++++----------------- docs/resources/user.md | 2 +- 4 files changed, 41 insertions(+), 41 deletions(-) diff --git a/docs/events/gateway-events.mdx b/docs/events/gateway-events.mdx index 5792e0756b..6814a0dd51 100644 --- a/docs/events/gateway-events.mdx +++ b/docs/events/gateway-events.mdx @@ -759,22 +759,22 @@ Sent when a guild member is updated. This will also fire when the user object of ###### Guild Member Update Event Fields -| Field | Type | Description | -|-------------------------------|-------------------------------------------------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| guild_id | snowflake | ID of the guild | -| roles | array of snowflakes | User role ids | -| user | a [user](/docs/resources/user#user-object) object | User | -| nick? | ?string | Nickname of the user in the guild | -| avatar | ?string | Member's [guild avatar hash](/docs/reference#image-formatting) | -| banner | ?string | Member's [guild banner hash](/docs/reference#image-formatting) | -| joined_at | ?ISO8601 timestamp | When the user joined the guild | -| premium_since? | ?ISO8601 timestamp | When the user starting [boosting](https://support.discord.com/hc/en-us/articles/360028038352) the guild | -| deaf? | boolean | Whether the user is deafened in voice channels | -| mute? | boolean | Whether the user is muted in voice channels | -| pending? | boolean | Whether the user has not yet passed the guild's [Membership Screening](/docs/resources/guild#membership-screening-object) requirements | +| Field | Type | Description | +|-------------------------------|-------------------------------------------------------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| guild_id | snowflake | ID of the guild | +| roles | array of snowflakes | User role ids | +| user | a [user](/docs/resources/user#user-object) object | User | +| nick? | ?string | Nickname of the user in the guild | +| avatar | ?string | Member's [guild avatar hash](/docs/reference#image-formatting) | +| banner | ?string | Member's [guild banner hash](/docs/reference#image-formatting) | +| joined_at | ?ISO8601 timestamp | When the user joined the guild | +| premium_since? | ?ISO8601 timestamp | When the user starting [boosting](https://support.discord.com/hc/en-us/articles/360028038352) the guild | +| deaf? | boolean | Whether the user is deafened in voice channels | +| mute? | boolean | Whether the user is muted in voice channels | +| pending? | boolean | Whether the user has not yet passed the guild's [Membership Screening](/docs/resources/guild#membership-screening-object) requirements | | communication_disabled_until? | ?ISO8601 timestamp | When the user's [timeout](https://support.discord.com/hc/en-us/articles/4413305239191) will expire and the user will be able to communicate in the guild again, null or a time in the past if the user is not timed out | -| flags? | integer | [Guild member flags](/docs/resources/guild#guild-member-object-guild-member-flags) represented as a bit set, defaults to 0 | -| avatar_decoration_data? | ?[avatar decoration data](/docs/resources/user#avatar-decoration-data-object) | Data for the member's guild avatar decoration | +| flags? | integer | [Guild member flags](/docs/resources/guild#guild-member-object-guild-member-flags) represented as a bit set, defaults to 0 | +| avatar_decoration_data? | ?[avatar decoration data](/docs/resources/user#avatar-decoration-data-object) | Data for the member's guild avatar decoration | #### Guild Members Chunk diff --git a/docs/resources/channel.md b/docs/resources/channel.md index 06beea0a9e..75f56f96f1 100644 --- a/docs/resources/channel.md +++ b/docs/resources/channel.md @@ -63,13 +63,13 @@ Represents a guild or DM channel within Discord. | DM | 1 | a direct message between users | | GUILD_VOICE | 2 | a voice channel within a server | | GROUP_DM | 3 | a direct message between multiple users | -| GUILD_CATEGORY | 4 | an [organizational category](https://support.discord.com/hc/en-us/articles/115001580171) that contains up to 50 channels | +| GUILD_CATEGORY | 4 | an [organizational category](https://support.discord.com/hc/en-us/articles/115001580171) that contains up to 50 channels | | GUILD_ANNOUNCEMENT | 5 | a channel that [users can follow and crosspost into their own server](https://support.discord.com/hc/en-us/articles/360032008192) (formerly news channels) | | ANNOUNCEMENT_THREAD | 10 | a temporary sub-channel within a GUILD_ANNOUNCEMENT channel | | PUBLIC_THREAD | 11 | a temporary sub-channel within a GUILD_TEXT or GUILD_FORUM channel | | PRIVATE_THREAD | 12 | a temporary sub-channel within a GUILD_TEXT channel that is only viewable by those invited and those with the MANAGE_THREADS permission | | GUILD_STAGE_VOICE | 13 | a voice channel for [hosting events with an audience](https://support.discord.com/hc/en-us/articles/1500005513722) | -| GUILD_DIRECTORY | 14 | the channel in a [hub](https://support.discord.com/hc/en-us/articles/4406046651927) containing the listed servers | +| GUILD_DIRECTORY | 14 | the channel in a [hub](https://support.discord.com/hc/en-us/articles/4406046651927) containing the listed servers | | GUILD_FORUM | 15 | Channel that can only contain threads | | GUILD_MEDIA | 16 | Channel that can only contain threads, similar to `GUILD_FORUM` channels | diff --git a/docs/resources/guild.md b/docs/resources/guild.md index 5b9b26af89..533044f2b2 100644 --- a/docs/resources/guild.md +++ b/docs/resources/guild.md @@ -349,22 +349,22 @@ A partial [guild](/docs/resources/guild#guild-object) object. Represents an Offl ###### Guild Member Structure -| Field | Type | Description | -|-------------------------------|--------------------------------------------------------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| user? | [user](/docs/resources/user#user-object) object | the user this guild member represents | -| nick? | ?string | this user's guild nickname | -| avatar? | ?string | the member's [guild avatar hash](/docs/reference#image-formatting) | -| banner? | ?string | the member's [guild banner hash](/docs/reference#image-formatting) | -| roles | array of snowflakes | array of [role](/docs/topics/permissions#role-object) object ids | -| joined_at | ISO8601 timestamp | when the user joined the guild | -| premium_since? | ?ISO8601 timestamp | when the user started [boosting](https://support.discord.com/hc/en-us/articles/360028038352) the guild | -| deaf | boolean | whether the user is deafened in voice channels | -| mute | boolean | whether the user is muted in voice channels | -| flags | integer | [guild member flags](/docs/resources/guild#guild-member-object-guild-member-flags) represented as a bit set, defaults to `0` | -| pending? | boolean | whether the user has not yet passed the guild's [Membership Screening](/docs/resources/guild#membership-screening-object) requirements | -| permissions? | string | total permissions of the member in the channel, including overwrites, returned when in the interaction object | +| Field | Type | Description | +|-------------------------------|--------------------------------------------------------------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| user? | [user](/docs/resources/user#user-object) object | the user this guild member represents | +| nick? | ?string | this user's guild nickname | +| avatar? | ?string | the member's [guild avatar hash](/docs/reference#image-formatting) | +| banner? | ?string | the member's [guild banner hash](/docs/reference#image-formatting) | +| roles | array of snowflakes | array of [role](/docs/topics/permissions#role-object) object ids | +| joined_at | ISO8601 timestamp | when the user joined the guild | +| premium_since? | ?ISO8601 timestamp | when the user started [boosting](https://support.discord.com/hc/en-us/articles/360028038352) the guild | +| deaf | boolean | whether the user is deafened in voice channels | +| mute | boolean | whether the user is muted in voice channels | +| flags | integer | [guild member flags](/docs/resources/guild#guild-member-object-guild-member-flags) represented as a bit set, defaults to `0` | +| pending? | boolean | whether the user has not yet passed the guild's [Membership Screening](/docs/resources/guild#membership-screening-object) requirements | +| permissions? | string | total permissions of the member in the channel, including overwrites, returned when in the interaction object | | communication_disabled_until? | ?ISO8601 timestamp | when the user's [timeout](https://support.discord.com/hc/en-us/articles/4413305239191) will expire and the user will be able to communicate in the guild again, null or a time in the past if the user is not timed out | -| avatar_decoration_data? | ?[avatar decoration data](/docs/resources/user#avatar-decoration-data-object) object | data for the member's guild avatar decoration | +| avatar_decoration_data? | ?[avatar decoration data](/docs/resources/user#avatar-decoration-data-object) object | data for the member's guild avatar decoration | > info > The field `user` won't be included in the member object attached to `MESSAGE_CREATE` and `MESSAGE_UPDATE` gateway events. @@ -1018,15 +1018,15 @@ Modify attributes of a [guild member](/docs/resources/guild#guild-member-object) ###### JSON Params -| Field | Type | Description | Permission | -|------------------------------|---------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------------------------------------------------------------------| -| nick | string | value to set user's nickname to | MANAGE_NICKNAMES | -| roles | array of snowflakes | array of role ids the member is assigned | MANAGE_ROLES | -| mute | boolean | whether the user is muted in voice channels. Will throw a 400 error if the user is not in a voice channel | MUTE_MEMBERS | -| deaf | boolean | whether the user is deafened in voice channels. Will throw a 400 error if the user is not in a voice channel | DEAFEN_MEMBERS | -| channel_id | snowflake | id of channel to move user to (if they are connected to voice) | MOVE_MEMBERS | +| Field | Type | Description | Permission | +|------------------------------|---------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------------------------------------------------------------------| +| nick | string | value to set user's nickname to | MANAGE_NICKNAMES | +| roles | array of snowflakes | array of role ids the member is assigned | MANAGE_ROLES | +| mute | boolean | whether the user is muted in voice channels. Will throw a 400 error if the user is not in a voice channel | MUTE_MEMBERS | +| deaf | boolean | whether the user is deafened in voice channels. Will throw a 400 error if the user is not in a voice channel | DEAFEN_MEMBERS | +| channel_id | snowflake | id of channel to move user to (if they are connected to voice) | MOVE_MEMBERS | | communication_disabled_until | ISO8601 timestamp | when the user's [timeout](https://support.discord.com/hc/en-us/articles/4413305239191) will expire and the user will be able to communicate in the guild again (up to 28 days in the future), set to null to remove timeout. Will throw a 403 error if the user has the ADMINISTRATOR permission or is the owner of the guild | MODERATE_MEMBERS | -| flags | integer | [guild member flags](/docs/resources/guild#guild-member-object-guild-member-flags) | MANAGE_GUILD or MANAGE_ROLES or (MODERATE_MEMBERS and KICK_MEMBERS and BAN_MEMBERS) | +| flags | integer | [guild member flags](/docs/resources/guild#guild-member-object-guild-member-flags) | MANAGE_GUILD or MANAGE_ROLES or (MODERATE_MEMBERS and KICK_MEMBERS and BAN_MEMBERS) | ## Modify Current Member % PATCH /guilds/||FIXME||guild.id||/docs/resources/guild#guild-object||/members/@me diff --git a/docs/resources/user.md b/docs/resources/user.md index cde86c5d6f..461f0c4d28 100644 --- a/docs/resources/user.md +++ b/docs/resources/user.md @@ -88,7 +88,7 @@ There are other rules and restrictions not shared here for the sake of spam and | `1 << 17` | VERIFIED_DEVELOPER | Early Verified Bot Developer | | `1 << 18` | CERTIFIED_MODERATOR | Moderator Programs Alumni | | `1 << 19` | BOT_HTTP_INTERACTIONS | Bot uses only [HTTP interactions](/docs/interactions/receiving-and-responding#receiving-an-interaction) and is shown in the online member list | -| `1 << 22` | ACTIVE_DEVELOPER | User is an [Active Developer](https://support-dev.discord.com/hc/en-us/articles/10113997751447) | +| `1 << 22` | ACTIVE_DEVELOPER | User is an [Active Developer](https://support-dev.discord.com/hc/en-us/articles/10113997751447) | ###### Premium Types From fe1eeaebdf6822e0794ad23287335e60480d5c29 Mon Sep 17 00:00:00 2001 From: GeniusTimo Date: Sun, 20 Apr 2025 14:09:44 +0200 Subject: [PATCH 10/20] Updated links to the developer TOS and policy --- README.md | 2 +- docs/discovery/best-practices.md | 2 +- docs/monetization/enabling-monetization.mdx | 2 +- docs/topics/oauth2.md | 2 +- 4 files changed, 4 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 809bce8188..9923b62dbc 100644 --- a/README.md +++ b/README.md @@ -20,4 +20,4 @@ The [Unofficial Discord API server](https://discord.gg/discord-api) is a common ## License -Except as otherwise noted, the Discord API Documentation and other content in this repository is licensed under the Creative Commons Attribution-ShareAlike 4.0 License (see [LICENSE](https://github.com/discord/discord-api-docs/blob/main/LICENSE)), and code samples in this repository are licensed under the MIT License (see [LICENSE-CODE](https://github.com/discord/discord-api-docs/blob/main/LICENSE-CODE)). These licenses do not grant you rights to use any of Discord’s trademarks or other brand features. Please see the [Discord Developer Terms of Service](https://support-dev.discord.com/hc/en-us/articles/8562894815383) for more information about use of Discord’s brand features and APIs. +Except as otherwise noted, the Discord API Documentation and other content in this repository is licensed under the Creative Commons Attribution-ShareAlike 4.0 License (see [LICENSE](https://github.com/discord/discord-api-docs/blob/main/LICENSE)), and code samples in this repository are licensed under the MIT License (see [LICENSE-CODE](https://github.com/discord/discord-api-docs/blob/main/LICENSE-CODE)). These licenses do not grant you rights to use any of Discord’s trademarks or other brand features. Please see the [Discord Developer Terms of Service](https://dis.gd/discord-developer-terms-of-service) for more information about use of Discord’s brand features and APIs. diff --git a/docs/discovery/best-practices.md b/docs/discovery/best-practices.md index c30392e5f4..9d211b8a53 100644 --- a/docs/discovery/best-practices.md +++ b/docs/discovery/best-practices.md @@ -91,7 +91,7 @@ For general best practices on how to run a server, check out our [Community page ### Final checks to make sure you’re ready to go -Before you can click the final “Enable Discovery” button, ensure that your App Directory Product Page complies with the rest of Discord’s Directory eligibility criteria, [app content requirements](https://support-dev.discord.com/hc/en-us/articles/9489299950487) and Developer [Terms of Service](https://support-dev.discord.com/hc/en-us/articles/8562894815383) and [Policy](https://support-dev.discord.com/hc/en-us/articles/8563934450327). +Before you can click the final “Enable Discovery” button, ensure that your App Directory Product Page complies with the rest of Discord’s Directory eligibility criteria, [app content requirements](https://support-dev.discord.com/hc/en-us/articles/9489299950487) and Developer [Terms of Service](https://dis.gd/discord-developer-terms-of-service) and [Policy](https://dis.gd/discord-developer-policy). For more details about what this information entails, read our [Help Center article on Profile Pages](https://support-dev.discord.com/hc/en-us/articles/6378525413143). diff --git a/docs/monetization/enabling-monetization.mdx b/docs/monetization/enabling-monetization.mdx index e046df6593..4020ae97a1 100644 --- a/docs/monetization/enabling-monetization.mdx +++ b/docs/monetization/enabling-monetization.mdx @@ -37,7 +37,7 @@ Before you can start creating SKUs and offering payments in your app, your app a - This document should clearly and accurately describe to users of your app the user data you collect and how you use and share such data with us and third parties, consistent with our Developer Terms of Service and Developer Policy. - App must not contain any harmful or bad language in the name, description, commands, or role connection metadata. - Payouts must be set up with a valid payment method -- Agreement to the [Monetization Terms](https://support.discord.com/hc/en-us/articles/5330075836311) and [Discord Developer Policy](https://support-dev.discord.com/hc/en-us/articles/8563934450327). +- Agreement to the [Monetization Terms](https://support.discord.com/hc/en-us/articles/5330075836311) and [Discord Developer Policy](https://dis.gd/discord-developer-policy). ## Step 3. Set Up Team Payouts diff --git a/docs/topics/oauth2.md b/docs/topics/oauth2.md index aca9e47f30..7666f13f6a 100644 --- a/docs/topics/oauth2.md +++ b/docs/topics/oauth2.md @@ -265,7 +265,7 @@ Discord's API provides bot users, which are a separate type of user dedicated to ### Bot vs User Accounts > warn -> Developers must abide by the [terms of service](https://support-dev.discord.com/hc/en-us/articles/8562894815383), which includes refraining from automating standard user accounts (generally called "self-bots") outside of the OAuth2/bot API. +> Developers must abide by the [terms of service](https://dis.gd/discord-developer-terms-of-service), which includes refraining from automating standard user accounts (generally called "self-bots") outside of the OAuth2/bot API. Bot users have a few differences compared to standard Discord users: From 59fb320a0b942718a7eb91251e9c240f89bdc488 Mon Sep 17 00:00:00 2001 From: GeniusTimo Date: Tue, 22 Apr 2025 18:43:30 +0200 Subject: [PATCH 11/20] Updated placeholders to new link format --- docs/events/gateway.mdx | 6 +- docs/interactions/application-commands.mdx | 48 ++++-- .../interactions/receiving-and-responding.mdx | 24 ++- ... application-role-connection-metadata.mdx} | 6 +- .../{application.md => application.mdx} | 9 +- .../resources/{audit-log.md => audit-log.mdx} | 3 +- ...auto-moderation.md => auto-moderation.mdx} | 15 +- docs/resources/{channel.md => channel.mdx} | 78 ++++++---- docs/resources/{emoji.md => emoji.mdx} | 30 ++-- .../{entitlement.md => entitlement.mdx} | 15 +- docs/resources/guild-scheduled-event.mdx | 18 ++- .../{guild-template.md => guild-template.mdx} | 21 ++- docs/resources/{guild.md => guild.mdx} | 141 ++++++++++++------ docs/resources/{invite.md => invite.mdx} | 6 +- docs/resources/{lobby.md => lobby.mdx} | 63 ++++---- docs/resources/{message.md => message.mdx} | 39 +++-- docs/resources/{poll.md => poll.mdx} | 6 +- docs/resources/{sku.md => sku.mdx} | 3 +- .../{soundboard.md => soundboard.mdx} | 21 ++- .../{stage-instance.md => stage-instance.mdx} | 12 +- docs/resources/{sticker.md => sticker.mdx} | 24 ++- .../{subscription.md => subscription.mdx} | 6 +- docs/resources/{user.md => user.mdx} | 33 ++-- docs/resources/{voice.md => voice.mdx} | 15 +- docs/resources/{webhook.md => webhook.mdx} | 45 ++++-- docs/topics/{oauth2.md => oauth2.mdx} | 6 +- 26 files changed, 456 insertions(+), 237 deletions(-) rename docs/resources/{application-role-connection-metadata.md => application-role-connection-metadata.mdx} (94%) rename docs/resources/{application.md => application.mdx} (99%) rename docs/resources/{audit-log.md => audit-log.mdx} (99%) rename docs/resources/{auto-moderation.md => auto-moderation.mdx} (95%) rename docs/resources/{channel.md => channel.mdx} (94%) rename docs/resources/{emoji.md => emoji.mdx} (84%) rename docs/resources/{entitlement.md => entitlement.mdx} (89%) rename docs/resources/{guild-template.md => guild-template.mdx} (85%) rename docs/resources/{guild.md => guild.mdx} (94%) rename docs/resources/{invite.md => invite.mdx} (97%) rename docs/resources/{lobby.md => lobby.mdx} (69%) rename docs/resources/{message.md => message.mdx} (97%) rename docs/resources/{poll.md => poll.mdx} (95%) rename docs/resources/{sku.md => sku.mdx} (97%) rename docs/resources/{soundboard.md => soundboard.mdx} (87%) rename docs/resources/{stage-instance.md => stage-instance.mdx} (93%) rename docs/resources/{sticker.md => sticker.mdx} (90%) rename docs/resources/{subscription.md => subscription.mdx} (94%) rename docs/resources/{user.md => user.mdx} (95%) rename docs/resources/{voice.md => voice.mdx} (89%) rename docs/resources/{webhook.md => webhook.mdx} (90%) rename docs/topics/{oauth2.md => oauth2.mdx} (99%) diff --git a/docs/events/gateway.mdx b/docs/events/gateway.mdx index 3e6cc0d0f2..e072e81507 100644 --- a/docs/events/gateway.mdx +++ b/docs/events/gateway.mdx @@ -697,7 +697,8 @@ The [Get Gateway Bot endpoint](/docs/events/gateway#get-gateway-bot) will always The session start limit for these bots will also be increased from 1000 to `max(2000, (guild_count / 1000) * 5)` per day. You also receive an increased `max_concurrency`, the number of [shards you can concurrently start](/docs/events/gateway#session-start-limit-object). -## Get Gateway % GET /gateway +## Get Gateway +/gateway :::info This endpoint does not require authentication. @@ -713,7 +714,8 @@ Returns an object with a valid WSS URL which the app can use when [Connecting](/ } ``` -## Get Gateway Bot % GET /gateway/bot +## Get Gateway Bot +/gateway/bot :::warn This endpoint requires authentication using a valid bot token. diff --git a/docs/interactions/application-commands.mdx b/docs/interactions/application-commands.mdx index 6f607151d1..038ea0d1f5 100644 --- a/docs/interactions/application-commands.mdx +++ b/docs/interactions/application-commands.mdx @@ -1156,7 +1156,8 @@ Details about accessing and using age-restricted commands is in [the Help Center For authorization, all endpoints take either a [bot token](/docs/reference#authentication) or [client credentials token](/docs/topics/oauth2#client-credentials-grant) for your application ::: -## Get Global Application Commands % GET /applications/||FIXME||application.id||/docs/resources/application#application-object||/commands +## Get Global Application Commands +/applications/[\{application.id\}](/docs/resources/application#application-object)/commands :::warn The objects returned by this endpoint may be augmented with [additional fields if localization is active](/docs/interactions/application-commands#retrieving-localized-commands). @@ -1170,7 +1171,8 @@ Fetch all of the global commands for your application. Returns an array of [appl |---------------------|--------------------------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | with_localizations? | [boolean](/docs/reference#boolean-query-strings) | Whether to include full localization dictionaries (`name_localizations` and `description_localizations`) in the returned objects, instead of the `name_localized` and `description_localized` fields. Default `false`. | -## Create Global Application Command % POST /applications/||FIXME||application.id||/docs/resources/application#application-object||/commands +## Create Global Application Command +/applications/[\{application.id\}](/docs/resources/application#application-object)/commands :::warn Creating a command with the same name as an existing command for your application will overwrite the old command. @@ -1195,11 +1197,13 @@ Create a new global command. Returns `201` if a command with the same name does | type? | one of [application command type](/docs/interactions/application-commands#application-command-object-application-command-types) | Type of command, defaults `1` if not set | | nsfw? | boolean | Indicates whether the command is [age-restricted](/docs/interactions/application-commands#agerestricted-commands) | -## Get Global Application Command % GET /applications/||FIXME||application.id||/docs/resources/application#application-object||/commands/||FIXME||command.id||/docs/interactions/application-commands#application-command-object|| +## Get Global Application Command +/applications/[\{application.id\}](/docs/resources/application#application-object)/commands/[\{command.id\}](/docs/interactions/application-commands#application-command-object) Fetch a global command for your application. Returns an [application command](/docs/interactions/application-commands#application-command-object) object. -## Edit Global Application Command % PATCH /applications/||FIXME||application.id||/docs/resources/application#application-object||/commands/||FIXME||command.id||/docs/interactions/application-commands#application-command-object|| +## Edit Global Application Command +/applications/[\{application.id\}](/docs/resources/application#application-object)/commands/[\{command.id\}](/docs/interactions/application-commands#application-command-object) :::info All parameters for this endpoint are optional. @@ -1223,11 +1227,13 @@ Edit a global command. Returns `200` and an [application command](/docs/interact | contexts? | list of [interaction context types](/docs/interactions/receiving-and-responding#interaction-object-interaction-context-types) | [Interaction context(s)](/docs/interactions/receiving-and-responding#interaction-object-interaction-context-types) where the command can be used | | nsfw? | boolean | Indicates whether the command is [age-restricted](/docs/interactions/application-commands#agerestricted-commands) | -## Delete Global Application Command % DELETE /applications/||FIXME||application.id||/docs/resources/application#application-object||/commands/||FIXME||command.id||/docs/interactions/application-commands#application-command-object|| +## Delete Global Application Command +/applications/[\{application.id\}](/docs/resources/application#application-object)/commands/[\{command.id\}](/docs/interactions/application-commands#application-command-object) Deletes a global command. Returns `204 No Content` on success. -## Bulk Overwrite Global Application Commands % PUT /applications/||FIXME||application.id||/docs/resources/application#application-object||/commands +## Bulk Overwrite Global Application Commands +/applications/[\{application.id\}](/docs/resources/application#application-object)/commands Takes a list of application commands, overwriting the existing global command list for this application. Returns `200` and a list of [application command](/docs/interactions/application-commands#application-command-object) objects. Commands that do not already exist will count toward daily application command create limits. @@ -1235,7 +1241,8 @@ Takes a list of application commands, overwriting the existing global command li This will overwrite **all** types of application commands: slash commands, user commands, and message commands. ::: -## Get Guild Application Commands % GET /applications/||FIXME||application.id||/docs/resources/application#application-object||/guilds/||FIXME||guild.id||/docs/resources/guild#guild-object||/commands +## Get Guild Application Commands +/applications/[\{application.id\}](/docs/resources/application#application-object)/guilds/[\{guild.id\}](/docs/resources/guild#guild-object)/commands :::warn The objects returned by this endpoint may be augmented with [additional fields if localization is active](/docs/interactions/application-commands#retrieving-localized-commands). @@ -1249,7 +1256,8 @@ Fetch all of the guild commands for your application for a specific guild. Retur |---------------------|--------------------------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | with_localizations? | [boolean](/docs/reference#boolean-query-strings) | Whether to include full localization dictionaries (`name_localizations` and `description_localizations`) in the returned objects, instead of the `name_localized` and `description_localized` fields. Default `false`. | -## Create Guild Application Command % POST /applications/||FIXME||application.id||/docs/resources/application#application-object||/guilds/||FIXME||guild.id||/docs/resources/guild#guild-object||/commands +## Create Guild Application Command +/applications/[\{application.id\}](/docs/resources/application#application-object)/guilds/[\{guild.id\}](/docs/resources/guild#guild-object)/commands :::danger Creating a command with the same name as an existing command for your application will overwrite the old command. @@ -1271,11 +1279,13 @@ Create a new guild command. New guild commands will be available in the guild im | type? | one of [application command type](/docs/interactions/application-commands#application-command-object-application-command-types) | Type of command, defaults `1` if not set | | nsfw? | boolean | Indicates whether the command is [age-restricted](/docs/interactions/application-commands#agerestricted-commands) | -## Get Guild Application Command % GET /applications/||FIXME||application.id||/docs/resources/application#application-object||/guilds/||FIXME||guild.id||/docs/resources/guild#guild-object||/commands/||FIXME||command.id||/docs/interactions/application-commands#application-command-object|| +## Get Guild Application Command +/applications/[\{application.id\}](/docs/resources/application#application-object)/guilds/[\{guild.id\}](/docs/resources/guild#guild-object)/commands/[\{command.id\}](/docs/interactions/application-commands#application-command-object) Fetch a guild command for your application. Returns an [application command](/docs/interactions/application-commands#application-command-object) object. -## Edit Guild Application Command % PATCH /applications/||FIXME||application.id||/docs/resources/application#application-object||/guilds/||FIXME||guild.id||/docs/resources/guild#guild-object||/commands/||FIXME||command.id||/docs/interactions/application-commands#application-command-object|| +## Edit Guild Application Command +/applications/[\{application.id\}](/docs/resources/application#application-object)/guilds/[\{guild.id\}](/docs/resources/guild#guild-object)/commands/[\{command.id\}](/docs/interactions/application-commands#application-command-object) :::info All parameters for this endpoint are optional. @@ -1296,11 +1306,13 @@ Edit a guild command. Updates for guild commands will be available immediately. | default_permission? | boolean | Replaced by `default_member_permissions` and will be deprecated in the future. Indicates whether the command is enabled by default when the app is added to a guild. Defaults to `true` | | nsfw? | boolean | Indicates whether the command is [age-restricted](/docs/interactions/application-commands#agerestricted-commands) | -## Delete Guild Application Command % DELETE /applications/||FIXME||application.id||/docs/resources/application#application-object||/guilds/||FIXME||guild.id||/docs/resources/guild#guild-object||/commands/||FIXME||command.id||/docs/interactions/application-commands#application-command-object|| +## Delete Guild Application Command +/applications/[\{application.id\}](/docs/resources/application#application-object)/guilds/[\{guild.id\}](/docs/resources/guild#guild-object)/commands/[\{command.id\}](/docs/interactions/application-commands#application-command-object) Delete a guild command. Returns `204 No Content` on success. -## Bulk Overwrite Guild Application Commands % PUT /applications/||FIXME||application.id||/docs/resources/application#application-object||/guilds/||FIXME||guild.id||/docs/resources/guild#guild-object||/commands +## Bulk Overwrite Guild Application Commands +/applications/[\{application.id\}](/docs/resources/application#application-object)/guilds/[\{guild.id\}](/docs/resources/guild#guild-object)/commands Takes a list of application commands, overwriting the existing command list for this application for the targeted guild. Returns `200` and a list of [application command](/docs/interactions/application-commands#application-command-object) objects. @@ -1326,15 +1338,18 @@ This will overwrite **all** types of application commands: slash commands, user | type? | one of [application command type](/docs/interactions/application-commands#application-command-object-application-command-types) | Type of command, defaults `1` if not set | | nsfw? | boolean | Indicates whether the command is [age-restricted](/docs/interactions/application-commands#agerestricted-commands) | -## Get Guild Application Command Permissions % GET /applications/||FIXME||application.id||/docs/resources/application#application-object||/guilds/||FIXME||guild.id||/docs/resources/guild#guild-object||/commands/permissions +## Get Guild Application Command Permissions +/applications/[\{application.id\}](/docs/resources/application#application-object)/guilds/[\{guild.id\}](/docs/resources/guild#guild-object)/commands/permissions Fetches permissions for all commands for your application in a guild. Returns an array of [guild application command permissions](/docs/interactions/application-commands#application-command-permissions-object-guild-application-command-permissions-structure) objects. -## Get Application Command Permissions % GET /applications/||FIXME||application.id||/docs/resources/application#application-object||/guilds/||FIXME||guild.id||/docs/resources/guild#guild-object||/commands/||FIXME||command.id||/docs/interactions/application-commands#application-command-object||/permissions +## Get Application Command Permissions +/applications/[\{application.id\}](/docs/resources/application#application-object)/guilds/[\{guild.id\}](/docs/resources/guild#guild-object)/commands/[\{command.id\}](/docs/interactions/application-commands#application-command-object)/permissions Fetches permissions for a specific command for your application in a guild. Returns a [guild application command permissions](/docs/interactions/application-commands#application-command-permissions-object-guild-application-command-permissions-structure) object. -## Edit Application Command Permissions % PUT /applications/||FIXME||application.id||/docs/resources/application#application-object||/guilds/||FIXME||guild.id||/docs/resources/guild#guild-object||/commands/||FIXME||command.id||/docs/interactions/application-commands#application-command-object||/permissions +## Edit Application Command Permissions +/applications/[\{application.id\}](/docs/resources/application#application-object)/guilds/[\{guild.id\}](/docs/resources/guild#guild-object)/commands/[\{command.id\}](/docs/interactions/application-commands#application-command-object)/permissions :::warn This endpoint will overwrite existing permissions for the command in that guild @@ -1358,7 +1373,8 @@ Deleting or renaming a command will permanently delete all permissions for the c |-------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------------------------------------| | permissions | array of [application command permissions](/docs/interactions/application-commands#application-command-permissions-object-application-command-permissions-structure) | Permissions for the command in the guild | -## Batch Edit Application Command Permissions % PUT /applications/||FIXME||application.id||/docs/resources/application#application-object||/guilds/||FIXME||guild.id||/docs/resources/guild#guild-object||/commands/permissions +## Batch Edit Application Command Permissions +/applications/[\{application.id\}](/docs/resources/application#application-object)/guilds/[\{guild.id\}](/docs/resources/guild#guild-object)/commands/permissions :::danger This endpoint has been disabled with [updates to command permissions (Permissions v2)](/docs/change-log#updated-command-permissions). Instead, you can [edit each application command permissions](/docs/interactions/application-commands#edit-application-command-permissions) (though you should be careful to handle any potential [rate limits](/docs/topics/rate-limits)). diff --git a/docs/interactions/receiving-and-responding.mdx b/docs/interactions/receiving-and-responding.mdx index 78dc770f63..3fc651e578 100644 --- a/docs/interactions/receiving-and-responding.mdx +++ b/docs/interactions/receiving-and-responding.mdx @@ -389,7 +389,8 @@ Interaction tokens are valid for **15 minutes**, meaning you can respond to an i The endpoints below are not bound to the application's [Global Rate Limit](/docs/topics/rate-limits#global-rate-limit). ::: -## Create Interaction Response % POST /interactions/||FIXME||interaction.id||/docs/interactions/receiving-and-responding#interaction-object||/||FIXME||interaction.token||/docs/interactions/receiving-and-responding#interaction-object||/callback +## Create Interaction Response +/interactions/[\{interaction.id\}](/docs/interactions/receiving-and-responding#interaction-object)/[\{interaction.token\}](/docs/interactions/receiving-and-responding#interaction-object)/callback Create a response to an Interaction. Body is an [interaction response](/docs/interactions/receiving-and-responding#interaction-response-object). Returns `204` unless `with_response` is set to `true` which returns `200` with the body as [interaction callback response](/docs/interactions/receiving-and-responding#interaction-callback-interaction-callback-response-object). @@ -402,19 +403,23 @@ This endpoint also supports file attachments similar to the webhook endpoints. R | with_response? | [boolean](/docs/reference#boolean-query-strings) | Whether to include an [interaction callback object](/docs/interactions/receiving-and-responding#interaction-callback-interaction-callback-response-object) as the response | -## Get Original Interaction Response % GET /webhooks/||FIXME||application.id||/docs/resources/application#application-object||/||FIXME||interaction.token||/docs/interactions/receiving-and-responding#interaction-object||/messages/@original +## Get Original Interaction Response +/webhooks/[\{application.id\}](/docs/resources/application#application-object)/[\{interaction.token\}](/docs/interactions/receiving-and-responding#interaction-object)/messages/@original Returns the initial Interaction response. Functions the same as [Get Webhook Message](/docs/resources/webhook#get-webhook-message). -## Edit Original Interaction Response % PATCH /webhooks/||FIXME||application.id||/docs/resources/application#application-object||/||FIXME||interaction.token||/docs/interactions/receiving-and-responding#interaction-object||/messages/@original +## Edit Original Interaction Response +/webhooks/[\{application.id\}](/docs/resources/application#application-object)/[\{interaction.token\}](/docs/interactions/receiving-and-responding#interaction-object)/messages/@original Edits the initial Interaction response. Functions the same as [Edit Webhook Message](/docs/resources/webhook#edit-webhook-message). -## Delete Original Interaction Response % DELETE /webhooks/||FIXME||application.id||/docs/resources/application#application-object||/||FIXME||interaction.token||/docs/interactions/receiving-and-responding#interaction-object||/messages/@original +## Delete Original Interaction Response +/webhooks/[\{application.id\}](/docs/resources/application#application-object)/[\{interaction.token\}](/docs/interactions/receiving-and-responding#interaction-object)/messages/@original Deletes the initial Interaction response. Returns `204 No Content` on success. -## Create Followup Message % POST /webhooks/||FIXME||application.id||/docs/resources/application#application-object||/||FIXME||interaction.token||/docs/interactions/receiving-and-responding#interaction-object|| +## Create Followup Message +/webhooks/[\{application.id\}](/docs/resources/application#application-object)/[\{interaction.token\}](/docs/interactions/receiving-and-responding#interaction-object) :::info Apps are limited to 5 followup messages per interaction if it was initiated from a user-installed app and isn't installed in the server (meaning the [authorizing integration owners object](/docs/interactions/receiving-and-responding#interaction-object-authorizing-integration-owners-object) only contains `USER_INSTALL`) @@ -424,14 +429,17 @@ Create a followup message for an Interaction. Functions the same as [Execute Web When using this endpoint directly after responding to an interaction with `DEFERRED_CHANNEL_MESSAGE_WITH_SOURCE`, this endpoint will function as [Edit Original Interaction Response](/docs/interactions/receiving-and-responding#edit-original-interaction-response) for backwards compatibility. In this case, no new message will be created, and the loading message will be edited instead. The ephemeral flag will be ignored, and the value you provided in the initial defer response will be preserved, as an existing message's ephemeral state cannot be changed. This behavior is deprecated, and you should use the Edit Original Interaction Response endpoint in this case instead. -## Get Followup Message % GET /webhooks/||FIXME||application.id||/docs/resources/application#application-object||/||FIXME||interaction.token||/docs/interactions/receiving-and-responding#interaction-object||/messages/||FIXME||message.id||/docs/resources/channel#message-object|| +## Get Followup Message +/webhooks/[\{application.id\}](/docs/resources/application#application-object)/[\{interaction.token\}](/docs/interactions/receiving-and-responding#interaction-object)/messages/[\{message.id\}](/docs/resources/message#message-object) Returns a followup message for an Interaction. Functions the same as [Get Webhook Message](/docs/resources/webhook#get-webhook-message). -## Edit Followup Message % PATCH /webhooks/||FIXME||application.id||/docs/resources/application#application-object||/||FIXME||interaction.token||/docs/interactions/receiving-and-responding#interaction-object||/messages/||FIXME||message.id||/docs/resources/channel#message-object|| +## Edit Followup Message +/webhooks/[\{application.id\}](/docs/resources/application#application-object)/[\{interaction.token\}](/docs/interactions/receiving-and-responding#interaction-object)/messages/[\{message.id\}](/docs/resources/message#message-object) Edits a followup message for an Interaction. Functions the same as [Edit Webhook Message](/docs/resources/webhook#edit-webhook-message). -## Delete Followup Message % DELETE /webhooks/||FIXME||application.id||/docs/resources/application#application-object||/||FIXME||interaction.token||/docs/interactions/receiving-and-responding#interaction-object||/messages/||FIXME||message.id||/docs/resources/channel#message-object|| +## Delete Followup Message +/webhooks/[\{application.id\}](/docs/resources/application#application-object)/[\{interaction.token\}](/docs/interactions/receiving-and-responding#interaction-object)/messages/[\{message.id\}](/docs/resources/message#message-object) Deletes a followup message for an Interaction. Returns `204 No Content` on success. diff --git a/docs/resources/application-role-connection-metadata.md b/docs/resources/application-role-connection-metadata.mdx similarity index 94% rename from docs/resources/application-role-connection-metadata.md rename to docs/resources/application-role-connection-metadata.mdx index cae7654cb8..04ee162c87 100644 --- a/docs/resources/application-role-connection-metadata.md +++ b/docs/resources/application-role-connection-metadata.mdx @@ -38,11 +38,13 @@ When a user connects their account using the bot's [`role_connections_verificati Each metadata type offers a comparison operation that allows guilds to configure role requirements based on metadata values stored by the bot. Bots specify a `metadata value` for each user and guilds specify the required `guild's configured value` within the guild role settings. ::: -## Get Application Role Connection Metadata Records % GET /applications/||FIXME||application.id||/docs/resources/application#application-object||/role-connections/metadata +## Get Application Role Connection Metadata Records +/applications/[\{application.id\}](/docs/resources/application#application-object)/role-connections/metadata Returns a list of [application role connection metadata](/docs/resources/application-role-connection-metadata#application-role-connection-metadata-object) objects for the given application. -## Update Application Role Connection Metadata Records % PUT /applications/||FIXME||application.id||/docs/resources/application#application-object||/role-connections/metadata +## Update Application Role Connection Metadata Records +/applications/[\{application.id\}](/docs/resources/application#application-object)/role-connections/metadata Updates and returns a list of [application role connection metadata](/docs/resources/application-role-connection-metadata#application-role-connection-metadata-object) objects for the given application. diff --git a/docs/resources/application.md b/docs/resources/application.mdx similarity index 99% rename from docs/resources/application.md rename to docs/resources/application.mdx index 13d409d7a6..16dca25593 100644 --- a/docs/resources/application.md +++ b/docs/resources/application.mdx @@ -226,11 +226,13 @@ You can configure your app's install link in your [app's settings](https://disco The Default Install Settings will appear on the **Installation** page when you have "Discord Provided Link" selected as your install link type. -## Get Current Application % GET /applications/@me +## Get Current Application +/applications/@me Returns the [application](/docs/resources/application#application-object) object associated with the requesting bot user. -## Edit Current Application % PATCH /applications/@me +## Edit Current Application +/applications/@me Edit properties of the app associated with the requesting bot user. Only properties that are passed will be updated. Returns the updated [application](/docs/resources/application#application-object) object on success. @@ -260,7 +262,8 @@ All parameters to this endpoint are optional \*\* To update an Interactions endpoint URL via the API, the URL must be valid according to the [Receiving an Interaction](/docs/interactions/receiving-and-responding#receiving-an-interaction) documentation. -## Get Application Activity Instance % GET /applications/||FIXME||application.id||/docs/resources/application#application-object||/activity-instances/{instance_id} +## Get Application Activity Instance +/applications/[\{application.id\}](/docs/resources/application#application-object)/activity-instances/{instance_id} Returns a serialized activity instance, if it exists. Useful for [preventing unwanted activity sessions](/docs/activities/development-guides#preventing-unwanted-activity-sessions). diff --git a/docs/resources/audit-log.md b/docs/resources/audit-log.mdx similarity index 99% rename from docs/resources/audit-log.md rename to docs/resources/audit-log.mdx index 0b38f968c1..97c56a6c4f 100644 --- a/docs/resources/audit-log.md +++ b/docs/resources/audit-log.mdx @@ -197,7 +197,8 @@ For most objects, the change keys may be any field on the changed object. The fo | [Partial Role](/docs/topics/permissions#role-object) | `$add` and `$remove` as keys | `new_value` is an array of objects that contain the role `id` and `name` | | [Webhook](/docs/resources/webhook#webhook-object) | `avatar_hash` key (instead of `avatar`) | | -## Get Guild Audit Log % GET /guilds/||FIXME||guild.id||/docs/resources/guild#guild-object||/audit-logs +## Get Guild Audit Log +/guilds/[\{guild.id\}](/docs/resources/guild#guild-object)/audit-logs Returns an [audit log](/docs/resources/audit-log#audit-log-object) object for the guild. Requires the [`VIEW_AUDIT_LOG`](/docs/topics/permissions#permissions-bitwise-permission-flags) permission. diff --git a/docs/resources/auto-moderation.md b/docs/resources/auto-moderation.mdx similarity index 95% rename from docs/resources/auto-moderation.md rename to docs/resources/auto-moderation.mdx index 24e4e32000..775c27f8d8 100644 --- a/docs/resources/auto-moderation.md +++ b/docs/resources/auto-moderation.mdx @@ -198,7 +198,8 @@ value of [action type](/docs/resources/auto-moderation#auto-moderation-action-ob Users are required to have the `MANAGE_GUILD` permission to access all Auto Moderation resources. Some [action types](/docs/resources/auto-moderation#auto-moderation-action-object-action-types) require additional permissions, e.g. the `TIMEOUT` action type requires an additional `MODERATE_MEMBERS` permission. -## List Auto Moderation Rules for Guild % GET /guilds/||FIXME||guild.id||/docs/resources/guild#guild-object||/auto-moderation/rules +## List Auto Moderation Rules for Guild +/guilds/[\{guild.id\}](/docs/resources/guild#guild-object)/auto-moderation/rules Get a list of all rules currently configured for the guild. Returns a list of [auto moderation rule](/docs/resources/auto-moderation#auto-moderation-rule-object) objects for the given guild. @@ -206,7 +207,8 @@ Get a list of all rules currently configured for the guild. Returns a list of [a This endpoint requires the `MANAGE_GUILD` [permission](/docs/resources/auto-moderation#auto-moderation-permission-requirements). ::: -## Get Auto Moderation Rule % GET /guilds/||FIXME||guild.id||/docs/resources/guild#guild-object||/auto-moderation/rules/||FIXME||auto_moderation_rule.id||/docs/resources/auto-moderation#auto-moderation-rule-object|| +## Get Auto Moderation Rule +/guilds/[\{guild.id\}](/docs/resources/guild#guild-object)/auto-moderation/rules/[\{auto_moderation_rule.id\}](/docs/resources/auto-moderation#auto-moderation-rule-object) Get a single rule. Returns an [auto moderation rule](/docs/resources/auto-moderation#auto-moderation-rule-object) object. @@ -214,7 +216,8 @@ Get a single rule. Returns an [auto moderation rule](/docs/resources/auto-modera This endpoint requires the `MANAGE_GUILD` [permission](/docs/resources/auto-moderation#auto-moderation-permission-requirements). ::: -## Create Auto Moderation Rule % POST /guilds/||FIXME||guild.id||/docs/resources/guild#guild-object||/auto-moderation/rules +## Create Auto Moderation Rule +/guilds/[\{guild.id\}](/docs/resources/guild#guild-object)/auto-moderation/rules Create a new rule. Returns an [auto moderation rule](/docs/resources/auto-moderation#auto-moderation-rule-object) on success. Fires an [Auto Moderation Rule Create](/docs/events/gateway-events#auto-moderation-rule-create) Gateway event. @@ -246,7 +249,8 @@ See [Trigger Types](/docs/resources/auto-moderation#auto-moderation-rule-object- ::: -## Modify Auto Moderation Rule % PATCH /guilds/||FIXME||guild.id||/docs/resources/guild#guild-object||/auto-moderation/rules/||FIXME||auto_moderation_rule.id||/docs/resources/auto-moderation#auto-moderation-rule-object|| +## Modify Auto Moderation Rule +/guilds/[\{guild.id\}](/docs/resources/guild#guild-object)/auto-moderation/rules/[\{auto_moderation_rule.id\}](/docs/resources/auto-moderation#auto-moderation-rule-object) Modify an existing rule. Returns an [auto moderation rule](/docs/resources/auto-moderation#auto-moderation-rule-object) on success. Fires an [Auto Moderation Rule Update](/docs/events/gateway-events#auto-moderation-rule-update) Gateway event. @@ -276,7 +280,8 @@ This endpoint supports the `X-Audit-Log-Reason` header. \* Can be omitted based on `trigger_type`. See the `Associated Trigger Types` column in [trigger metadata](/docs/resources/auto-moderation#auto-moderation-rule-object-trigger-metadata) to understand which `trigger_type` values require `trigger_metadata` to be set. -## Delete Auto Moderation Rule % DELETE /guilds/||FIXME||guild.id||/docs/resources/guild#guild-object||/auto-moderation/rules/||FIXME||auto_moderation_rule.id||/docs/resources/auto-moderation#auto-moderation-rule-object|| +## Delete Auto Moderation Rule +/guilds/[\{guild.id\}](/docs/resources/guild#guild-object)/auto-moderation/rules/[\{auto_moderation_rule.id\}](/docs/resources/auto-moderation#auto-moderation-rule-object) Delete a rule. Returns a `204` on success. Fires an [Auto Moderation Rule Delete](/docs/events/gateway-events#auto-moderation-rule-delete) Gateway event. diff --git a/docs/resources/channel.md b/docs/resources/channel.mdx similarity index 94% rename from docs/resources/channel.md rename to docs/resources/channel.mdx index f6ca113dac..1eb63f73f5 100644 --- a/docs/resources/channel.md +++ b/docs/resources/channel.mdx @@ -345,11 +345,13 @@ When updating a `GUILD_FORUM` or a `GUILD_MEDIA` channel, tag objects in `availa \* At most one of `emoji_id` and `emoji_name` may be set to a non-null value. -## Get Channel % GET /channels/||FIXME||channel.id||/docs/resources/channel#channel-object|| +## Get Channel +/channels/[\{channel.id\}](/docs/resources/channel#channel-object) Get a channel by ID. Returns a [channel](/docs/resources/channel#channel-object) object. If the channel is a thread, a [thread member](/docs/resources/channel#thread-member-object) object is included in the returned result. -## Modify Channel % PATCH /channels/||FIXME||channel.id||/docs/resources/channel#channel-object|| +## Modify Channel +/channels/[\{channel.id\}](/docs/resources/channel#channel-object) Update a channel's settings. Returns a [channel](/docs/resources/channel#channel-object) on success, and a 400 BAD REQUEST on invalid parameters. @@ -417,7 +419,8 @@ Otherwise, requires the `MANAGE_THREADS` permission. Fires a [Thread Update](/do | flags? | integer | [channel flags](/docs/resources/channel#channel-object-channel-flags) combined as a [bitfield](https://en.wikipedia.org/wiki/Bit_field); `PINNED` can only be set for threads in forum and media channels | | applied_tags? | array of snowflakes | the IDs of the set of tags that have been applied to a thread in a `GUILD_FORUM` or a `GUILD_MEDIA` channel; limited to 5 | -## Delete/Close Channel % DELETE /channels/||FIXME||channel.id||/docs/resources/channel#channel-object|| +## Delete/Close Channel +/channels/[\{channel.id\}](/docs/resources/channel#channel-object) Delete a channel, or close a private message. Requires the `MANAGE_CHANNELS` permission for the guild, or `MANAGE_THREADS` if the channel is a thread. Deleting a category does not delete its child channels; they will have their `parent_id` removed and a [Channel Update](/docs/events/gateway-events#channel-update) Gateway event will fire for each of them. Returns a [channel](/docs/resources/channel#channel-object) object on success. Fires a [Channel Delete](/docs/events/gateway-events#channel-delete) Gateway event (or [Thread Delete](/docs/events/gateway-events#thread-delete) if the channel was a thread). @@ -433,7 +436,8 @@ For Community guilds, the Rules or Guidelines channel and the Community Updates This endpoint supports the `X-Audit-Log-Reason` header. ::: -## Edit Channel Permissions % PUT /channels/||FIXME||channel.id||/docs/resources/channel#channel-object||/permissions/||FIXME||overwrite.id||/docs/resources/channel#overwrite-object|| +## Edit Channel Permissions +/channels/[\{channel.id\}](/docs/resources/channel#channel-object)/permissions/[\{overwrite.id\}](/docs/resources/channel#overwrite-object) Edit the channel permission overwrites for a user or role in a channel. Only usable for guild channels. Requires the `MANAGE_ROLES` permission. Only permissions your bot has in the guild or parent channel (if applicable) can be allowed/denied (unless your bot has a `MANAGE_ROLES` overwrite in the channel). Returns a 204 empty response on success. Fires a [Channel Update](/docs/events/gateway-events#channel-update) Gateway event. For more information about permissions, see [permissions](/docs/topics/permissions#permissions). @@ -449,11 +453,13 @@ This endpoint supports the `X-Audit-Log-Reason` header. | deny? | string? | the bitwise value of all disallowed permissions (default `"0"`) | | type | integer | 0 for a role or 1 for a member | -## Get Channel Invites % GET /channels/||FIXME||channel.id||/docs/resources/channel#channel-object||/invites +## Get Channel Invites +/channels/[\{channel.id\}](/docs/resources/channel#channel-object)/invites Returns a list of [invite](/docs/resources/invite#invite-object) objects (with [invite metadata](/docs/resources/invite#invite-metadata-object)) for the channel. Only usable for guild channels. Requires the `MANAGE_CHANNELS` permission. -## Create Channel Invite % POST /channels/||FIXME||channel.id||/docs/resources/channel#channel-object||/invites +## Create Channel Invite +/channels/[\{channel.id\}](/docs/resources/channel#channel-object)/invites Create a new [invite](/docs/resources/invite#invite-object) object for the channel. Only usable for guild channels. Requires the `CREATE_INSTANT_INVITE` permission. All JSON parameters for this route are optional, however the request body is not. If you are not sending any fields, you still have to send an empty JSON object (`{}`). Returns an [invite](/docs/resources/invite#invite-object) object. Fires an [Invite Create](/docs/events/gateway-events#invite-create) Gateway event. @@ -473,7 +479,8 @@ This endpoint supports the `X-Audit-Log-Reason` header. | target_user_id | snowflake | the id of the user whose stream to display for this invite, required if `target_type` is 1, the user must be streaming in the channel | | | target_application_id | snowflake | the id of the embedded application to open for this invite, required if `target_type` is 2, the application must have the `EMBEDDED` flag | | -## Delete Channel Permission % DELETE /channels/||FIXME||channel.id||/docs/resources/channel#channel-object||/permissions/||FIXME||overwrite.id||/docs/resources/channel#overwrite-object|| +## Delete Channel Permission +/channels/[\{channel.id\}](/docs/resources/channel#channel-object)/permissions/[\{overwrite.id\}](/docs/resources/channel#overwrite-object) Delete a channel permission overwrite for a user or role in a channel. Only usable for guild channels. Requires the `MANAGE_ROLES` permission. Returns a 204 empty response on success. Fires a [Channel Update](/docs/events/gateway-events#channel-update) Gateway event. For more information about permissions, see [permissions](/docs/topics/permissions#permissions) @@ -481,7 +488,8 @@ Delete a channel permission overwrite for a user or role in a channel. Only usab This endpoint supports the `X-Audit-Log-Reason` header. ::: -## Follow Announcement Channel % POST /channels/||FIXME||channel.id||/docs/resources/channel#channel-object||/followers +## Follow Announcement Channel +/channels/[\{channel.id\}](/docs/resources/channel#channel-object)/followers Follow an Announcement Channel to send messages to a target channel. Requires the `MANAGE_WEBHOOKS` permission in the target channel. Returns a [followed channel](/docs/resources/channel#followed-channel-object) object. Fires a [Webhooks Update](/docs/events/gateway-events#webhooks-update) Gateway event for the target channel. @@ -495,17 +503,20 @@ This endpoint supports the `X-Audit-Log-Reason` header. |--------------------|-----------|----------------------| | webhook_channel_id | snowflake | id of target channel | -## Trigger Typing Indicator % POST /channels/||FIXME||channel.id||/docs/resources/channel#channel-object||/typing +## Trigger Typing Indicator +/channels/[\{channel.id\}](/docs/resources/channel#channel-object)/typing Post a typing indicator for the specified channel, which expires after 10 seconds. Returns a 204 empty response on success. Fires a [Typing Start](/docs/events/gateway-events#typing-start) Gateway event. Generally bots should **not** use this route. However, if a bot is responding to a command and expects the computation to take a few seconds, this endpoint may be called to let the user know that the bot is processing their message. -## Get Pinned Messages % GET /channels/||FIXME||channel.id||/docs/resources/channel#channel-object||/pins +## Get Pinned Messages +/channels/[\{channel.id\}](/docs/resources/channel#channel-object)/pins Returns all pinned messages in the channel as an array of [message](/docs/resources/message#message-object) objects. -## Pin Message % PUT /channels/||FIXME||channel.id||/docs/resources/channel#channel-object||/pins/||FIXME||message.id||/docs/resources/message#message-object|| +## Pin Message +/channels/[\{channel.id\}](/docs/resources/channel#channel-object)/pins/[\{message.id\}](/docs/resources/message#message-object) Pin a message in a channel. Requires the `MANAGE_MESSAGES` permission. Returns a 204 empty response on success. Fires a [Channel Pins Update](/docs/events/gateway-events#channel-pins-update) Gateway event. @@ -517,7 +528,8 @@ The max pinned messages is 50. This endpoint supports the `X-Audit-Log-Reason` header. ::: -## Unpin Message % DELETE /channels/||FIXME||channel.id||/docs/resources/channel#channel-object||/pins/||FIXME||message.id||/docs/resources/message#message-object|| +## Unpin Message +/channels/[\{channel.id\}](/docs/resources/channel#channel-object)/pins/[\{message.id\}](/docs/resources/message#message-object) Unpin a message in a channel. Requires the `MANAGE_MESSAGES` permission. Returns a 204 empty response on success. Fires a [Channel Pins Update](/docs/events/gateway-events#channel-pins-update) Gateway event. @@ -525,7 +537,8 @@ Unpin a message in a channel. Requires the `MANAGE_MESSAGES` permission. Returns This endpoint supports the `X-Audit-Log-Reason` header. ::: -## Group DM Add Recipient % PUT /channels/||FIXME||channel.id||/docs/resources/channel#channel-object||/recipients/||FIXME||user.id||/docs/resources/user#user-object|| +## Group DM Add Recipient +/channels/[\{channel.id\}](/docs/resources/channel#channel-object)/recipients/[\{user.id\}](/docs/resources/user#user-object) Adds a recipient to a Group DM using their access token. @@ -536,11 +549,13 @@ Adds a recipient to a Group DM using their access token. | access_token | string | access token of a user that has granted your app the `gdm.join` scope | | nick | string | nickname of the user being added | -## Group DM Remove Recipient % DELETE /channels/||FIXME||channel.id||/docs/resources/channel#channel-object||/recipients/||FIXME||user.id||/docs/resources/user#user-object|| +## Group DM Remove Recipient +/channels/[\{channel.id\}](/docs/resources/channel#channel-object)/recipients/[\{user.id\}](/docs/resources/user#user-object) Removes a recipient from a Group DM. -## Start Thread from Message % POST /channels/||FIXME||channel.id||/docs/resources/channel#channel-object||/messages/||FIXME||message.id||/docs/resources/message#message-object||/threads +## Start Thread from Message +/channels/[\{channel.id\}](/docs/resources/channel#channel-object)/messages/[\{message.id\}](/docs/resources/message#message-object)/threads Creates a new thread from an existing message. Returns a [channel](/docs/resources/channel#channel-object) on success, and a 400 BAD REQUEST on invalid parameters. Fires a [Thread Create](/docs/events/gateway-events#thread-create) and a [Message Update](/docs/events/gateway-events#message-update) Gateway event. @@ -558,7 +573,8 @@ This endpoint supports the `X-Audit-Log-Reason` header. | auto_archive_duration? | integer | the thread will stop showing in the channel list after `auto_archive_duration` minutes of inactivity, can be set to: 60, 1440, 4320, 10080 | | rate_limit_per_user? | ?integer | amount of seconds a user has to wait before sending another message (0-21600) | -## Start Thread without Message % POST /channels/||FIXME||channel.id||/docs/resources/channel#channel-object||/threads +## Start Thread without Message +/channels/[\{channel.id\}](/docs/resources/channel#channel-object)/threads Creates a new thread that is not connected to an existing message. Returns a [channel](/docs/resources/channel#channel-object) on success, and a 400 BAD REQUEST on invalid parameters. Fires a [Thread Create](/docs/events/gateway-events#thread-create) Gateway event. @@ -578,7 +594,8 @@ This endpoint supports the `X-Audit-Log-Reason` header. \* `type` currently defaults to `PRIVATE_THREAD` in order to match the behavior when thread documentation was first published. In a future API version this will be changed to be a required field, with no default. -## Start Thread in Forum or Media Channel % POST /channels/||FIXME||channel.id||/docs/resources/channel#channel-object||/threads +## Start Thread in Forum or Media Channel +/channels/[\{channel.id\}](/docs/resources/channel#channel-object)/threads Creates a new thread in a forum or a media channel, and sends a message within the created thread. Returns a [channel](/docs/resources/channel#channel-object), with a nested [message](/docs/resources/message#message-object) object, on success, and a 400 BAD REQUEST on invalid parameters. Fires a [Thread Create](/docs/events/gateway-events#thread-create) and [Message Create](/docs/events/gateway-events#message-create) Gateway event. @@ -630,23 +647,28 @@ When sending a message, apps must provide a value for **at least one of** `conte \* At least one of `content`, `embeds`, `sticker_ids`, `components`, or `files[n]` is required. -## Join Thread % PUT /channels/||FIXME||channel.id||/docs/resources/channel#channel-object||/thread-members/@me +## Join Thread +/channels/[\{channel.id\}](/docs/resources/channel#channel-object)/thread-members/@me Adds the current user to a thread. Also requires the thread is not archived. Returns a 204 empty response on success. Fires a [Thread Members Update](/docs/events/gateway-events#thread-members-update) and a [Thread Create](/docs/events/gateway-events#thread-create) Gateway event. -## Add Thread Member % PUT /channels/||FIXME||channel.id||/docs/resources/channel#channel-object||/thread-members/||FIXME||user.id||/docs/resources/user#user-object|| +## Add Thread Member +/channels/[\{channel.id\}](/docs/resources/channel#channel-object)/thread-members/[\{user.id\}](/docs/resources/user#user-object) Adds another member to a thread. Requires the ability to send messages in the thread. Also requires the thread is not archived. Returns a 204 empty response if the member is successfully added or was already a member of the thread. Fires a [Thread Members Update](/docs/events/gateway-events#thread-members-update) Gateway event. -## Leave Thread % DELETE /channels/||FIXME||channel.id||/docs/resources/channel#channel-object||/thread-members/@me +## Leave Thread +/channels/[\{channel.id\}](/docs/resources/channel#channel-object)/thread-members/@me Removes the current user from a thread. Also requires the thread is not archived. Returns a 204 empty response on success. Fires a [Thread Members Update](/docs/events/gateway-events#thread-members-update) Gateway event. -## Remove Thread Member % DELETE /channels/||FIXME||channel.id||/docs/resources/channel#channel-object||/thread-members/||FIXME||user.id||/docs/resources/user#user-object|| +## Remove Thread Member +/channels/[\{channel.id\}](/docs/resources/channel#channel-object)/thread-members/[\{user.id\}](/docs/resources/user#user-object) Removes another member from a thread. Requires the `MANAGE_THREADS` permission, or the creator of the thread if it is a `PRIVATE_THREAD`. Also requires the thread is not archived. Returns a 204 empty response on success. Fires a [Thread Members Update](/docs/events/gateway-events#thread-members-update) Gateway event. -## Get Thread Member % GET /channels/||FIXME||channel.id||/docs/resources/channel#channel-object||/thread-members/||FIXME||user.id||/docs/resources/user#user-object|| +## Get Thread Member +/channels/[\{channel.id\}](/docs/resources/channel#channel-object)/thread-members/[\{user.id\}](/docs/resources/user#user-object) Returns a [thread member](/docs/resources/channel#thread-member-object) object for the specified user if they are a member of the thread, returns a 404 response otherwise. @@ -658,7 +680,8 @@ When `with_member` is set to `true`, the thread member object will include a `me |--------------|--------------------------------------------------|-------------------------------------------------------------------------------------------------------------| | with_member? | [boolean](/docs/reference#boolean-query-strings) | Whether to include a [guild member](/docs/resources/guild#guild-member-object) object for the thread member | -## List Thread Members % GET /channels/||FIXME||channel.id||/docs/resources/channel#channel-object||/thread-members +## List Thread Members +/channels/[\{channel.id\}](/docs/resources/channel#channel-object)/thread-members :::warn Starting in API v11, this endpoint will always return paginated results. Paginated results can be enabled before API v11 by setting `with_member` to `true`. Read [the changelog](/docs/change-log#thread-member-details-and-pagination) for details. @@ -680,7 +703,8 @@ This endpoint is restricted according to whether the `GUILD_MEMBERS` [Privileged | after? | snowflake | Get thread members after this user ID | | limit? | integer | Max number of thread members to return (1-100). Defaults to 100. | -## List Public Archived Threads % GET /channels/||FIXME||channel.id||/docs/resources/channel#channel-object||/threads/archived/public +## List Public Archived Threads +/channels/[\{channel.id\}](/docs/resources/channel#channel-object)/threads/archived/public Returns archived threads in the channel that are public. When called on a `GUILD_TEXT` channel, returns threads of [type](/docs/resources/channel#channel-object-channel-types) `PUBLIC_THREAD`. When called on a `GUILD_ANNOUNCEMENT` channel returns threads of [type](/docs/resources/channel#channel-object-channel-types) `ANNOUNCEMENT_THREAD`. Threads are ordered by `archive_timestamp`, in descending order. Requires the `READ_MESSAGE_HISTORY` permission. @@ -699,7 +723,8 @@ Returns archived threads in the channel that are public. When called on a `GUILD | members | array of [thread members](/docs/resources/channel#thread-member-object) objects | a thread member object for each returned thread the current user has joined | | has_more | boolean | whether there are potentially additional threads that could be returned on a subsequent call | -## List Private Archived Threads % GET /channels/||FIXME||channel.id||/docs/resources/channel#channel-object||/threads/archived/private +## List Private Archived Threads +/channels/[\{channel.id\}](/docs/resources/channel#channel-object)/threads/archived/private Returns archived threads in the channel that are of [type](/docs/resources/channel#channel-object-channel-types) `PRIVATE_THREAD`. Threads are ordered by `archive_timestamp`, in descending order. Requires both the `READ_MESSAGE_HISTORY` and `MANAGE_THREADS` permissions. @@ -718,7 +743,8 @@ Returns archived threads in the channel that are of [type](/docs/resources/chann | members | array of [thread members](/docs/resources/channel#thread-member-object) objects | a thread member object for each returned thread the current user has joined | | has_more | boolean | whether there are potentially additional threads that could be returned on a subsequent call | -## List Joined Private Archived Threads % GET /channels/||FIXME||channel.id||/docs/resources/channel#channel-object||/users/@me/threads/archived/private +## List Joined Private Archived Threads +/channels/[\{channel.id\}](/docs/resources/channel#channel-object)/users/@me/threads/archived/private Returns archived threads in the channel that are of [type](/docs/resources/channel#channel-object-channel-types) `PRIVATE_THREAD`, and the user has joined. Threads are ordered by their `id`, in descending order. Requires the `READ_MESSAGE_HISTORY` permission. diff --git a/docs/resources/emoji.md b/docs/resources/emoji.mdx similarity index 84% rename from docs/resources/emoji.md rename to docs/resources/emoji.mdx index 0c3c587a59..d208797721 100644 --- a/docs/resources/emoji.md +++ b/docs/resources/emoji.mdx @@ -89,15 +89,18 @@ The `user` field of an app emoji object represents the team member that uploaded } ``` -## List Guild Emojis % GET /guilds/||FIXME||guild.id||/docs/resources/guild#guild-object||/emojis +## List Guild Emojis +/guilds/[\{guild.id\}](/docs/resources/guild#guild-object)/emojis Returns a list of [emoji](/docs/resources/emoji#emoji-object) objects for the given guild. Includes `user` fields if the bot has the `CREATE_GUILD_EXPRESSIONS` or `MANAGE_GUILD_EXPRESSIONS` permission. -## Get Guild Emoji % GET /guilds/||FIXME||guild.id||/docs/resources/guild#guild-object||/emojis/||FIXME||emoji.id||/docs/resources/emoji#emoji-object|| +## Get Guild Emoji +/guilds/[\{guild.id\}](/docs/resources/guild#guild-object)/emojis/[\{emoji.id\}](/docs/resources/emoji#emoji-object) Returns an [emoji](/docs/resources/emoji#emoji-object) object for the given guild and emoji IDs. Includes the `user` field if the bot has the `MANAGE_GUILD_EXPRESSIONS` permission, or if the bot created the emoji and has the the `CREATE_GUILD_EXPRESSIONS` permission. -## Create Guild Emoji % POST /guilds/||FIXME||guild.id||/docs/resources/guild#guild-object||/emojis +## Create Guild Emoji +/guilds/[\{guild.id\}](/docs/resources/guild#guild-object)/emojis Create a new emoji for the guild. Requires the `CREATE_GUILD_EXPRESSIONS` permission. Returns the new [emoji](/docs/resources/emoji#emoji-object) object on success. Fires a [Guild Emojis Update](/docs/events/gateway-events#guild-emojis-update) Gateway event. @@ -117,7 +120,8 @@ This endpoint supports the `X-Audit-Log-Reason` header. | image | [image data](/docs/reference#image-data) | the 128x128 emoji image | | roles | array of snowflakes | roles allowed to use this emoji | -## Modify Guild Emoji % PATCH /guilds/||FIXME||guild.id||/docs/resources/guild#guild-object||/emojis/||FIXME||emoji.id||/docs/resources/emoji#emoji-object|| +## Modify Guild Emoji +/guilds/[\{guild.id\}](/docs/resources/guild#guild-object)/emojis/[\{emoji.id\}](/docs/resources/emoji#emoji-object) Modify the given emoji. For emojis created by the current user, requires either the `CREATE_GUILD_EXPRESSIONS` or `MANAGE_GUILD_EXPRESSIONS` permission. For other emojis, requires the `MANAGE_GUILD_EXPRESSIONS` permission. Returns the updated [emoji](/docs/resources/emoji#emoji-object) object on success. Fires a [Guild Emojis Update](/docs/events/gateway-events#guild-emojis-update) Gateway event. @@ -136,7 +140,8 @@ This endpoint supports the `X-Audit-Log-Reason` header. | name | string | name of the emoji | | roles | ?array of snowflakes | roles allowed to use this emoji | -## Delete Guild Emoji % DELETE /guilds/||FIXME||guild.id||/docs/resources/guild#guild-object||/emojis/||FIXME||emoji.id||/docs/resources/emoji#emoji-object|| +## Delete Guild Emoji +/guilds/[\{guild.id\}](/docs/resources/guild#guild-object)/emojis/[\{emoji.id\}](/docs/resources/emoji#emoji-object) Delete the given emoji. For emojis created by the current user, requires either the `CREATE_GUILD_EXPRESSIONS` or `MANAGE_GUILD_EXPRESSIONS` permission. For other emojis, requires the `MANAGE_GUILD_EXPRESSIONS` permission. Returns `204 No Content` on success. Fires a [Guild Emojis Update](/docs/events/gateway-events#guild-emojis-update) Gateway event. @@ -144,7 +149,8 @@ Delete the given emoji. For emojis created by the current user, requires either This endpoint supports the `X-Audit-Log-Reason` header. ::: -## List Application Emojis % GET /applications/||FIXME||application.id||/docs/resources/application#application-object||/emojis +## List Application Emojis +/applications/[\{application.id\}](/docs/resources/application#application-object)/emojis Returns an object containing a list of [emoji](/docs/resources/emoji#emoji-object) objects for the given application under the `items` key. Includes a `user` object for the team member that uploaded the emoji from the app's settings, or for the bot user if uploaded using the API. @@ -170,11 +176,13 @@ Returns an object containing a list of [emoji](/docs/resources/emoji#emoji-objec } ``` -## Get Application Emoji % GET /applications/||FIXME||application.id||/docs/resources/application#application-object||/emojis/||FIXME||emoji.id||/docs/resources/emoji#emoji-object|| +## Get Application Emoji +/applications/[\{application.id\}](/docs/resources/application#application-object)/emojis/[\{emoji.id\}](/docs/resources/emoji#emoji-object) Returns an [emoji](/docs/resources/emoji#emoji-object) object for the given application and emoji IDs. Includes the `user` field. -## Create Application Emoji % POST /applications/||FIXME||application.id||/docs/resources/application#application-object||/emojis +## Create Application Emoji +/applications/[\{application.id\}](/docs/resources/application#application-object)/emojis Create a new emoji for the application. Returns the new [emoji](/docs/resources/emoji#emoji-object) object on success. @@ -189,7 +197,8 @@ Emojis and animated emojis have a maximum file size of 256 KiB. Attempting to up | name | string | name of the emoji | | image | [image data](/docs/reference#image-data) | the 128x128 emoji image | -## Modify Application Emoji % PATCH /applications/||FIXME||application.id||/docs/resources/application#application-object||/emojis/||FIXME||emoji.id||/docs/resources/emoji#emoji-object|| +## Modify Application Emoji +/applications/[\{application.id\}](/docs/resources/application#application-object)/emojis/[\{emoji.id\}](/docs/resources/emoji#emoji-object) Modify the given emoji. Returns the updated [emoji](/docs/resources/emoji#emoji-object) object on success. @@ -199,6 +208,7 @@ Modify the given emoji. Returns the updated [emoji](/docs/resources/emoji#emoji- |-------|--------|-------------------| | name | string | name of the emoji | -## Delete Application Emoji % DELETE /applications/||FIXME||application.id||/docs/resources/application#application-object||/emojis/||FIXME||emoji.id||/docs/resources/emoji#emoji-object|| +## Delete Application Emoji +/applications/[\{application.id\}](/docs/resources/application#application-object)/emojis/[\{emoji.id\}](/docs/resources/emoji#emoji-object) Delete the given emoji. Returns `204 No Content` on success. diff --git a/docs/resources/entitlement.md b/docs/resources/entitlement.mdx similarity index 89% rename from docs/resources/entitlement.md rename to docs/resources/entitlement.mdx index c5874ad9d5..9c930a7ec3 100644 --- a/docs/resources/entitlement.md +++ b/docs/resources/entitlement.mdx @@ -58,7 +58,8 @@ Refer to the [Monetization Overview](/docs/monetization/overview) for more infor | PREMIUM_PURCHASE | 7 | Entitlement was claimed by user for free as a Nitro Subscriber | | APPLICATION_SUBSCRIPTION | 8 | Entitlement was purchased as an app subscription | -## List Entitlements % GET /applications/||FIXME||application.id||/docs/resources/application#application-object||/entitlements +## List Entitlements +/applications/[\{application.id\}](/docs/resources/application#application-object)/entitlements Returns all entitlements for a given app, active and expired. @@ -95,7 +96,8 @@ Returns all entitlements for a given app, active and expired. ] ``` -## Get Entitlement % GET /applications/||FIXME||application.id||/docs/resources/application#application-object||/entitlements/||FIXME||entitlement.id||/docs/resources/entitlement#entitlement-object|| +## Get Entitlement +/applications/[\{application.id\}](/docs/resources/application#application-object)/entitlements/[\{entitlement.id\}](/docs/resources/entitlement#entitlement-object) Returns an entitlement. @@ -117,13 +119,15 @@ Returns an entitlement. } ``` -## Consume an Entitlement % POST /applications/||FIXME||application.id||/docs/resources/application#application-object||/entitlements/||FIXME||entitlement.id||/docs/resources/entitlement#entitlement-object||/consume +## Consume an Entitlement +/applications/[\{application.id\}](/docs/resources/application#application-object)/entitlements/[\{entitlement.id\}](/docs/resources/entitlement#entitlement-object)/consume For One-Time Purchase consumable SKUs, marks a given entitlement for the user as consumed. The entitlement will have `consumed: true` when using [List Entitlements](/docs/resources/entitlement#list-entitlements). Returns a `204 No Content` on success. -## Create Test Entitlement % POST /applications/||FIXME||application.id||/docs/resources/application#application-object||/entitlements +## Create Test Entitlement +/applications/[\{application.id\}](/docs/resources/application#application-object)/entitlements Creates a test entitlement to a given SKU for a given guild or user. Discord will act as though that user or guild has entitlement to your premium offering. @@ -147,7 +151,8 @@ After creating a test entitlement, you'll need to reload your Discord client. Af } ``` -## Delete Test Entitlement % DELETE /applications/||FIXME||application.id||/docs/resources/application#application-object||/entitlements/||FIXME||entitlement.id||/docs/resources/entitlement#entitlement-object|| +## Delete Test Entitlement +/applications/[\{application.id\}](/docs/resources/application#application-object)/entitlements/[\{entitlement.id\}](/docs/resources/entitlement#entitlement-object) Deletes a currently-active test entitlement. Discord will act as though that user or guild _no longer has_ entitlement to your premium offering. diff --git a/docs/resources/guild-scheduled-event.mdx b/docs/resources/guild-scheduled-event.mdx index edd30c55e9..d9321bc70c 100644 --- a/docs/resources/guild-scheduled-event.mdx +++ b/docs/resources/guild-scheduled-event.mdx @@ -260,7 +260,8 @@ by_month_day = [24] | NOVEMBER | 11 | | DECEMBER | 12 | -## List Scheduled Events for Guild % GET /guilds/||FIXME||guild.id||/docs/resources/guild#guild-object||/scheduled-events +## List Scheduled Events for Guild +/guilds/[\{guild.id\}](/docs/resources/guild#guild-object)/scheduled-events Returns a list of [guild scheduled event](/docs/resources/guild-scheduled-event#guild-scheduled-event-object) objects for the given guild. @@ -270,7 +271,8 @@ Returns a list of [guild scheduled event](/docs/resources/guild-scheduled-event# |------------------|--------------------------------------------------|--------------------------------------------------| | with_user_count? | [boolean](/docs/reference#boolean-query-strings) | include number of users subscribed to each event | -## Create Guild Scheduled Event % POST /guilds/||FIXME||guild.id||/docs/resources/guild#guild-object||/scheduled-events +## Create Guild Scheduled Event +/guilds/[\{guild.id\}](/docs/resources/guild#guild-object)/scheduled-events Create a guild scheduled event in the guild. Returns a [guild scheduled event](/docs/resources/guild-scheduled-event#guild-scheduled-event-object) object on success. Fires a [Guild Scheduled Event Create](/docs/events/gateway-events#guild-scheduled-event-create) Gateway event. @@ -302,7 +304,8 @@ This endpoint supports the `X-Audit-Log-Reason` header. \*\* Required for events with `'entity_type': EXTERNAL` -## Get Guild Scheduled Event % GET /guilds/||FIXME||guild.id||/docs/resources/guild#guild-object||/scheduled-events/||FIXME||guild_scheduled_event.id||/docs/resources/guild-scheduled-event#guild-scheduled-event-object|| +## Get Guild Scheduled Event +/guilds/[\{guild.id\}](/docs/resources/guild#guild-object)/scheduled-events/[\{guild_scheduled_event.id\}](/docs/resources/guild-scheduled-event#guild-scheduled-event-object) Get a guild scheduled event. Returns a [guild scheduled event](/docs/resources/guild-scheduled-event#guild-scheduled-event-object) object on success. @@ -312,7 +315,8 @@ Get a guild scheduled event. Returns a [guild scheduled event](/docs/resources/g |------------------|--------------------------------------------------|--------------------------------------------------| | with_user_count? | [boolean](/docs/reference#boolean-query-strings) | include number of users subscribed to this event | -## Modify Guild Scheduled Event % PATCH /guilds/||FIXME||guild.id||/docs/resources/guild#guild-object||/scheduled-events/||FIXME||guild_scheduled_event.id||/docs/resources/guild-scheduled-event#guild-scheduled-event-object|| +## Modify Guild Scheduled Event +/guilds/[\{guild.id\}](/docs/resources/guild#guild-object)/scheduled-events/[\{guild_scheduled_event.id\}](/docs/resources/guild-scheduled-event#guild-scheduled-event-object) Modify a guild scheduled event. Returns the modified [guild scheduled event](/docs/resources/guild-scheduled-event#guild-scheduled-event-object) object on success. Fires a [Guild Scheduled Event Update](/docs/events/gateway-events#guild-scheduled-event-update) Gateway event. @@ -355,11 +359,13 @@ All parameters to this endpoint are optional - `entity_metadata` with a `location` field must be provided - `scheduled_end_time` must be provided -## Delete Guild Scheduled Event % DELETE /guilds/||FIXME||guild.id||/docs/resources/guild#guild-object||/scheduled-events/||FIXME||guild_scheduled_event.id||/docs/resources/guild-scheduled-event#guild-scheduled-event-object|| +## Delete Guild Scheduled Event +/guilds/[\{guild.id\}](/docs/resources/guild#guild-object)/scheduled-events/[\{guild_scheduled_event.id\}](/docs/resources/guild-scheduled-event#guild-scheduled-event-object) Delete a guild scheduled event. Returns a `204` on success. Fires a [Guild Scheduled Event Delete](/docs/events/gateway-events#guild-scheduled-event-delete) Gateway event. -## Get Guild Scheduled Event Users % GET /guilds/||FIXME||guild.id||/docs/resources/guild#guild-object||/scheduled-events/||FIXME||guild_scheduled_event.id||/docs/resources/guild-scheduled-event#guild-scheduled-event-object||/users +## Get Guild Scheduled Event Users +/guilds/[\{guild.id\}](/docs/resources/guild#guild-object)/scheduled-events/[\{guild_scheduled_event.id\}](/docs/resources/guild-scheduled-event#guild-scheduled-event-object)/users Get a list of guild scheduled event users subscribed to a guild scheduled event. Returns a list of [guild scheduled event user](/docs/resources/guild-scheduled-event#guild-scheduled-event-user-object) objects on success. Guild member data, if it exists, is included if the `with_member` query parameter is set. diff --git a/docs/resources/guild-template.md b/docs/resources/guild-template.mdx similarity index 85% rename from docs/resources/guild-template.md rename to docs/resources/guild-template.mdx index 289b1bd664..90e139a71a 100644 --- a/docs/resources/guild-template.md +++ b/docs/resources/guild-template.mdx @@ -99,11 +99,13 @@ Represents a code that when used, creates a guild based on a snapshot of an exis } ``` -## Get Guild Template % GET /guilds/templates/||FIXME||template.code||/docs/resources/guild-template#guild-template-object|| +## Get Guild Template +/guilds/templates/[\{template.code\}](/docs/resources/guild-template#guild-template-object) Returns a [guild template](/docs/resources/guild-template#guild-template-object) object for the given code. -## Create Guild from Guild Template % POST /guilds/templates/||FIXME||template.code||/docs/resources/guild-template#guild-template-object|| +## Create Guild from Guild Template +/guilds/templates/[\{template.code\}](/docs/resources/guild-template#guild-template-object) Create a new guild based on a template. Returns a [guild](/docs/resources/guild#guild-object) object on success. Fires a [Guild Create](/docs/events/gateway-events#guild-create) Gateway event. @@ -118,11 +120,13 @@ This endpoint can be used only by bots in less than 10 guilds. | name | string | name of the guild (2-100 characters) | | icon? | [image data](/docs/reference#image-data) | base64 128x128 image for the guild icon | -## Get Guild Templates % GET /guilds/||FIXME||guild.id||/docs/resources/guild#guild-object||/templates +## Get Guild Templates +/guilds/[\{guild.id\}](/docs/resources/guild#guild-object)/templates Returns an array of [guild template](/docs/resources/guild-template#guild-template-object) objects. Requires the `MANAGE_GUILD` permission. -## Create Guild Template % POST /guilds/||FIXME||guild.id||/docs/resources/guild#guild-object||/templates +## Create Guild Template +/guilds/[\{guild.id\}](/docs/resources/guild#guild-object)/templates Creates a template for the guild. Requires the `MANAGE_GUILD` permission. Returns the created [guild template](/docs/resources/guild-template#guild-template-object) object on success. @@ -133,11 +137,13 @@ Creates a template for the guild. Requires the `MANAGE_GUILD` permission. Return | name | string | name of the template (1-100 characters) | | description? | ?string | description for the template (0-120 characters) | -## Sync Guild Template % PUT /guilds/||FIXME||guild.id||/docs/resources/guild#guild-object||/templates/||FIXME||template.code||/docs/resources/guild-template#guild-template-object|| +## Sync Guild Template +/guilds/[\{guild.id\}](/docs/resources/guild#guild-object)/templates/[\{template.code\}](/docs/resources/guild-template#guild-template-object) Syncs the template to the guild's current state. Requires the `MANAGE_GUILD` permission. Returns the [guild template](/docs/resources/guild-template#guild-template-object) object on success. -## Modify Guild Template % PATCH /guilds/||FIXME||guild.id||/docs/resources/guild#guild-object||/templates/||FIXME||template.code||/docs/resources/guild-template#guild-template-object|| +## Modify Guild Template +/guilds/[\{guild.id\}](/docs/resources/guild#guild-object)/templates/[\{template.code\}](/docs/resources/guild-template#guild-template-object) Modifies the template's metadata. Requires the `MANAGE_GUILD` permission. Returns the [guild template](/docs/resources/guild-template#guild-template-object) object on success. @@ -148,6 +154,7 @@ Modifies the template's metadata. Requires the `MANAGE_GUILD` permission. Return | name? | string | name of the template (1-100 characters) | | description? | ?string | description for the template (0-120 characters) | -## Delete Guild Template % DELETE /guilds/||FIXME||guild.id||/docs/resources/guild#guild-object||/templates/||FIXME||template.code||/docs/resources/guild-template#guild-template-object|| +## Delete Guild Template +/guilds/[\{guild.id\}](/docs/resources/guild#guild-object)/templates/[\{template.code\}](/docs/resources/guild-template#guild-template-object) Deletes the template. Requires the `MANAGE_GUILD` permission. Returns the deleted [guild template](/docs/resources/guild-template#guild-template-object) object on success. diff --git a/docs/resources/guild.md b/docs/resources/guild.mdx similarity index 94% rename from docs/resources/guild.md rename to docs/resources/guild.mdx index 6b7f3d5aa5..5b06048f54 100644 --- a/docs/resources/guild.md +++ b/docs/resources/guild.mdx @@ -693,7 +693,8 @@ We are making significant changes to the Membership Screening API specifically r } ``` -## Create Guild % POST /guilds +## Create Guild +/guilds Create a new guild. Returns a [guild](/docs/resources/guild#guild-object) object on success. Fires a [Guild Create](/docs/events/gateway-events#guild-create) Gateway event. @@ -763,7 +764,8 @@ The `region` field is deprecated and is replaced by [channel.rtc_region](/docs/r } ``` -## Get Guild % GET /guilds/||FIXME||guild.id||/docs/resources/guild#guild-object|| +## Get Guild +/guilds/[\{guild.id\}](/docs/resources/guild#guild-object) Returns the [guild](/docs/resources/guild#guild-object) object for the given id. If `with_counts` is set to `true`, this endpoint will also return `approximate_member_count` and `approximate_presence_count` for the guild. @@ -844,12 +846,14 @@ Returns the [guild](/docs/resources/guild#guild-object) object for the given id. } ``` -## Get Guild Preview % GET /guilds/||FIXME||guild.id||/docs/resources/guild#guild-object||/preview +## Get Guild Preview +/guilds/[\{guild.id\}](/docs/resources/guild#guild-object)/preview Returns the [guild preview](/docs/resources/guild#guild-preview-object) object for the given id. If the user is not in the guild, then the guild must be [discoverable](/docs/resources/guild#guild-object-guild-features). -## Modify Guild % PATCH /guilds/||FIXME||guild.id||/docs/resources/guild#guild-object|| +## Modify Guild +/guilds/[\{guild.id\}](/docs/resources/guild#guild-object) Modify a guild's settings. Requires the `MANAGE_GUILD` permission. Returns the updated [guild](/docs/resources/guild#guild-object) object on success. Fires a [Guild Update](/docs/events/gateway-events#guild-update) Gateway event. @@ -891,15 +895,18 @@ Attempting to add or remove the `COMMUNITY` [guild feature](/docs/resources/guil | premium_progress_bar_enabled | boolean | whether the guild's boost progress bar should be enabled | | safety_alerts_channel_id | ?snowflake | the id of the channel where admins and moderators of Community guilds receive safety alerts from Discord | -## Delete Guild % DELETE /guilds/||FIXME||guild.id||/docs/resources/guild#guild-object|| +## Delete Guild +/guilds/[\{guild.id\}](/docs/resources/guild#guild-object) Delete a guild permanently. User must be owner. Returns `204 No Content` on success. Fires a [Guild Delete](/docs/events/gateway-events#guild-delete) Gateway event. -## Get Guild Channels % GET /guilds/||FIXME||guild.id||/docs/resources/guild#guild-object||/channels +## Get Guild Channels +/guilds/[\{guild.id\}](/docs/resources/guild#guild-object)/channels Returns a list of guild [channel](/docs/resources/channel#channel-object) objects. Does not include threads. -## Create Guild Channel % POST /guilds/||FIXME||guild.id||/docs/resources/guild#guild-object||/channels +## Create Guild Channel +/guilds/[\{guild.id\}](/docs/resources/guild#guild-object)/channels Create a new [channel](/docs/resources/channel#channel-object) object for the guild. Requires the `MANAGE_CHANNELS` permission. If setting permission overwrites, only permissions your bot has in the guild can be allowed/denied. Setting `MANAGE_ROLES` permission in channels is only possible for guild administrators. Returns the new [channel](/docs/resources/channel#channel-object) object on success. Fires a [Channel Create](/docs/events/gateway-events#channel-create) Gateway event. @@ -938,7 +945,8 @@ This endpoint supports the `X-Audit-Log-Reason` header. \*\* In each overwrite object, the `allow` and `deny` keys can be omitted or set to `null`, which both default to `"0"`. -## Modify Guild Channel Positions % PATCH /guilds/||FIXME||guild.id||/docs/resources/guild#guild-object||/channels +## Modify Guild Channel Positions +/guilds/[\{guild.id\}](/docs/resources/guild#guild-object)/channels Modify the positions of a set of [channel](/docs/resources/channel#channel-object) objects for the guild. Requires `MANAGE_CHANNELS` permission. Returns a 204 empty response on success. Fires multiple [Channel Update](/docs/events/gateway-events#channel-update) Gateway events. @@ -957,7 +965,8 @@ This endpoint takes a JSON array of parameters in the following format: | lock_permissions? | ?boolean | syncs the permission overwrites with the new parent, if moving to a new category | | parent_id? | ?snowflake | the new parent ID for the channel that is moved | -## List Active Guild Threads % GET /guilds/||FIXME||guild.id||/docs/resources/guild#guild-object||/threads/active +## List Active Guild Threads +/guilds/[\{guild.id\}](/docs/resources/guild#guild-object)/threads/active Returns all active threads in the guild, including public and private threads. Threads are ordered by their `id`, in descending order. @@ -968,11 +977,13 @@ Returns all active threads in the guild, including public and private threads. T | threads | array of [channel](/docs/resources/channel#channel-object) objects | the active threads | | members | array of [thread members](/docs/resources/channel#thread-member-object) objects | a thread member object for each returned thread the current user has joined | -## Get Guild Member % GET /guilds/||FIXME||guild.id||/docs/resources/guild#guild-object||/members/||FIXME||user.id||/docs/resources/user#user-object|| +## Get Guild Member +/guilds/[\{guild.id\}](/docs/resources/guild#guild-object)/members/[\{user.id\}](/docs/resources/user#user-object) Returns a [guild member](/docs/resources/guild#guild-member-object) object for the specified user. -## List Guild Members % GET /guilds/||FIXME||guild.id||/docs/resources/guild#guild-object||/members +## List Guild Members +/guilds/[\{guild.id\}](/docs/resources/guild#guild-object)/members Returns a list of [guild member](/docs/resources/guild#guild-member-object) objects that are members of the guild. @@ -991,7 +1002,8 @@ All parameters to this endpoint are optional | limit | integer | max number of members to return (1-1000) | 1 | | after | snowflake | the highest user id in the previous page | 0 | -## Search Guild Members % GET /guilds/||FIXME||guild.id||/docs/resources/guild#guild-object||/members/search +## Search Guild Members +/guilds/[\{guild.id\}](/docs/resources/guild#guild-object)/members/search Returns a list of [guild member](/docs/resources/guild#guild-member-object) objects whose username or nickname starts with a provided string. @@ -1006,7 +1018,8 @@ All parameters to this endpoint except for `query` are optional | query | string | Query string to match username(s) and nickname(s) against. | | | limit | integer | max number of members to return (1-1000) | 1 | -## Add Guild Member % PUT /guilds/||FIXME||guild.id||/docs/resources/guild#guild-object||/members/||FIXME||user.id||/docs/resources/user#user-object|| +## Add Guild Member +/guilds/[\{guild.id\}](/docs/resources/guild#guild-object)/members/[\{user.id\}](/docs/resources/user#user-object) Adds a user to the guild, provided you have a valid oauth2 access token for the user with the `guilds.join` scope. Returns a 201 Created with the [guild member](/docs/resources/guild#guild-member-object) as the body, or 204 No Content if the user is already a member of the guild. Fires a [Guild Member Add](/docs/events/gateway-events#guild-member-add) Gateway event. @@ -1031,7 +1044,8 @@ The Authorization header must be a Bot token (belonging to the same application | deaf | boolean | whether the user is deafened in voice channels | DEAFEN_MEMBERS | -## Modify Guild Member % PATCH /guilds/||FIXME||guild.id||/docs/resources/guild#guild-object||/members/||FIXME||user.id||/docs/resources/user#user-object|| +## Modify Guild Member +/guilds/[\{guild.id\}](/docs/resources/guild#guild-object)/members/[\{user.id\}](/docs/resources/user#user-object) Modify attributes of a [guild member](/docs/resources/guild#guild-member-object). Returns a 200 OK with the [guild member](/docs/resources/guild#guild-member-object) as the body. Fires a [Guild Member Update](/docs/events/gateway-events#guild-member-update) Gateway event. If the `channel_id` is set to null, this will force the target user to be disconnected from voice. @@ -1055,7 +1069,8 @@ This endpoint supports the `X-Audit-Log-Reason` header. | communication_disabled_until | ISO8601 timestamp | when the user's [timeout](https://support.discord.com/hc/en-us/articles/4413305239191) will expire and the user will be able to communicate in the guild again (up to 28 days in the future), set to null to remove timeout. Will throw a 403 error if the user has the ADMINISTRATOR permission or is the owner of the guild | MODERATE_MEMBERS | | flags | integer | [guild member flags](/docs/resources/guild#guild-member-object-guild-member-flags) | MANAGE_GUILD or MANAGE_ROLES or (MODERATE_MEMBERS and KICK_MEMBERS and BAN_MEMBERS) | -## Modify Current Member % PATCH /guilds/||FIXME||guild.id||/docs/resources/guild#guild-object||/members/@me +## Modify Current Member +/guilds/[\{guild.id\}](/docs/resources/guild#guild-object)/members/@me Modifies the current member in a guild. Returns a 200 with the updated member object on success. Fires a [Guild Member Update](/docs/events/gateway-events#guild-member-update) Gateway event. @@ -1069,7 +1084,8 @@ This endpoint supports the `X-Audit-Log-Reason` header. |-------|---------|---------------------------------|-----------------| | nick? | ?string | value to set user's nickname to | CHANGE_NICKNAME | -## Modify Current User Nick % PATCH /guilds/||FIXME||guild.id||/docs/resources/guild#guild-object||/members/@me/nick +## Modify Current User Nick +/guilds/[\{guild.id\}](/docs/resources/guild#guild-object)/members/@me/nick :::danger Deprecated in favor of [Modify Current Member](/docs/resources/guild#modify-current-member). @@ -1087,7 +1103,8 @@ This endpoint supports the `X-Audit-Log-Reason` header. |-------|---------|---------------------------------|-----------------| | nick? | ?string | value to set user's nickname to | CHANGE_NICKNAME | -## Add Guild Member Role % PUT /guilds/||FIXME||guild.id||/docs/resources/guild#guild-object||/members/||FIXME||user.id||/docs/resources/user#user-object||/roles/||FIXME||role.id||/docs/topics/permissions#role-object|| +## Add Guild Member Role +/guilds/[\{guild.id\}](/docs/resources/guild#guild-object)/members/[\{user.id\}](/docs/resources/user#user-object)/roles/[\{role.id\}](/docs/topics/permissions#role-object) Adds a role to a [guild member](/docs/resources/guild#guild-member-object). Requires the `MANAGE_ROLES` permission. Returns a 204 empty response on success. Fires a [Guild Member Update](/docs/events/gateway-events#guild-member-update) Gateway event. @@ -1095,7 +1112,8 @@ Adds a role to a [guild member](/docs/resources/guild#guild-member-object). Requ This endpoint supports the `X-Audit-Log-Reason` header. ::: -## Remove Guild Member Role % DELETE /guilds/||FIXME||guild.id||/docs/resources/guild#guild-object||/members/||FIXME||user.id||/docs/resources/user#user-object||/roles/||FIXME||role.id||/docs/topics/permissions#role-object|| +## Remove Guild Member Role +/guilds/[\{guild.id\}](/docs/resources/guild#guild-object)/members/[\{user.id\}](/docs/resources/user#user-object)/roles/[\{role.id\}](/docs/topics/permissions#role-object) Removes a role from a [guild member](/docs/resources/guild#guild-member-object). Requires the `MANAGE_ROLES` permission. Returns a 204 empty response on success. Fires a [Guild Member Update](/docs/events/gateway-events#guild-member-update) Gateway event. @@ -1103,7 +1121,8 @@ Removes a role from a [guild member](/docs/resources/guild#guild-member-object). This endpoint supports the `X-Audit-Log-Reason` header. ::: -## Remove Guild Member % DELETE /guilds/||FIXME||guild.id||/docs/resources/guild#guild-object||/members/||FIXME||user.id||/docs/resources/user#user-object|| +## Remove Guild Member +/guilds/[\{guild.id\}](/docs/resources/guild#guild-object)/members/[\{user.id\}](/docs/resources/user#user-object) Remove a member from a guild. Requires `KICK_MEMBERS` permission. Returns a 204 empty response on success. Fires a [Guild Member Remove](/docs/events/gateway-events#guild-member-remove) Gateway event. @@ -1111,7 +1130,8 @@ Remove a member from a guild. Requires `KICK_MEMBERS` permission. Returns a 204 This endpoint supports the `X-Audit-Log-Reason` header. ::: -## Get Guild Bans % GET /guilds/||FIXME||guild.id||/docs/resources/guild#guild-object||/bans +## Get Guild Bans +/guilds/[\{guild.id\}](/docs/resources/guild#guild-object)/bans Returns a list of [ban](/docs/resources/guild#ban-object) objects for the users banned from this guild. Requires the `BAN_MEMBERS` permission. @@ -1125,11 +1145,13 @@ Returns a list of [ban](/docs/resources/guild#ban-object) objects for the users \* Provide a user id to `before` and `after` for pagination. Users will always be returned in ascending order by `user.id`. If both `before` and `after` are provided, only `before` is respected. -## Get Guild Ban % GET /guilds/||FIXME||guild.id||/docs/resources/guild#guild-object||/bans/||FIXME||user.id||/docs/resources/user#user-object|| +## Get Guild Ban +/guilds/[\{guild.id\}](/docs/resources/guild#guild-object)/bans/[\{user.id\}](/docs/resources/user#user-object) Returns a [ban](/docs/resources/guild#ban-object) object for the given user or a 404 not found if the ban cannot be found. Requires the `BAN_MEMBERS` permission. -## Create Guild Ban % PUT /guilds/||FIXME||guild.id||/docs/resources/guild#guild-object||/bans/||FIXME||user.id||/docs/resources/user#user-object|| +## Create Guild Ban +/guilds/[\{guild.id\}](/docs/resources/guild#guild-object)/bans/[\{user.id\}](/docs/resources/user#user-object) Create a guild ban, and optionally delete previous messages sent by the banned user. Requires the `BAN_MEMBERS` permission. Returns a 204 empty response on success. Fires a [Guild Ban Add](/docs/events/gateway-events#guild-ban-add) Gateway event. @@ -1144,7 +1166,8 @@ This endpoint supports the `X-Audit-Log-Reason` header. | delete_message_days? | integer | number of days to delete messages for (0-7) (deprecated) | 0 | | delete_message_seconds? | integer | number of seconds to delete messages for, between 0 and 604800 (7 days) | 0 | -## Remove Guild Ban % DELETE /guilds/||FIXME||guild.id||/docs/resources/guild#guild-object||/bans/||FIXME||user.id||/docs/resources/user#user-object|| +## Remove Guild Ban +/guilds/[\{guild.id\}](/docs/resources/guild#guild-object)/bans/[\{user.id\}](/docs/resources/user#user-object) Remove the ban for a user. Requires the `BAN_MEMBERS` permissions. Returns a 204 empty response on success. Fires a [Guild Ban Remove](/docs/events/gateway-events#guild-ban-remove) Gateway event. @@ -1152,7 +1175,8 @@ Remove the ban for a user. Requires the `BAN_MEMBERS` permissions. Returns a 204 This endpoint supports the `X-Audit-Log-Reason` header. ::: -## Bulk Guild Ban % POST /guilds/||FIXME||guild.id||/docs/resources/guild#guild-object||/bulk-ban +## Bulk Guild Ban +/guilds/[\{guild.id\}](/docs/resources/guild#guild-object)/bulk-ban Ban up to 200 users from a guild, and optionally delete previous messages sent by the banned users. Requires both the `BAN_MEMBERS` and `MANAGE_GUILD` permissions. Returns a 200 response on success, including the fields `banned_users` with the IDs of the banned users and `failed_users` with IDs that could not be banned or were already banned. @@ -1180,15 +1204,18 @@ On success, this endpoint returns a 200 success response with the following body If none of the users could be banned, an error response code `500000: Failed to ban users` is returned instead. ::: -## Get Guild Roles % GET /guilds/||FIXME||guild.id||/docs/resources/guild#guild-object||/roles +## Get Guild Roles +/guilds/[\{guild.id\}](/docs/resources/guild#guild-object)/roles Returns a list of [role](/docs/topics/permissions#role-object) objects for the guild. -## Get Guild Role % GET /guilds/||FIXME||guild.id||/docs/resources/guild#guild-object||/roles/||FIXME||role.id||/docs/topics/permissions#role-object|| +## Get Guild Role +/guilds/[\{guild.id\}](/docs/resources/guild#guild-object)/roles/[\{role.id\}](/docs/topics/permissions#role-object) Returns a [role](/docs/topics/permissions#role-object) object for the specified role. -## Create Guild Role % POST /guilds/||FIXME||guild.id||/docs/resources/guild#guild-object||/roles +## Create Guild Role +/guilds/[\{guild.id\}](/docs/resources/guild#guild-object)/roles Create a new [role](/docs/topics/permissions#role-object) for the guild. Requires the `MANAGE_ROLES` permission. Returns the new [role](/docs/topics/permissions#role-object) object on success. Fires a [Guild Role Create](/docs/events/gateway-events#guild-role-create) Gateway event. All JSON params are optional. @@ -1208,7 +1235,8 @@ This endpoint supports the `X-Audit-Log-Reason` header. | unicode_emoji | ?string | the role's unicode emoji as a [standard emoji](/docs/reference#message-formatting) (if the guild has the `ROLE_ICONS` feature) | null | | mentionable | boolean | whether the role should be mentionable | false | -## Modify Guild Role Positions % PATCH /guilds/||FIXME||guild.id||/docs/resources/guild#guild-object||/roles +## Modify Guild Role Positions +/guilds/[\{guild.id\}](/docs/resources/guild#guild-object)/roles Modify the positions of a set of [role](/docs/topics/permissions#role-object) objects for the guild. Requires the `MANAGE_ROLES` permission. Returns a list of all of the guild's [role](/docs/topics/permissions#role-object) objects on success. Fires multiple [Guild Role Update](/docs/events/gateway-events#guild-role-update) Gateway events. @@ -1225,7 +1253,8 @@ This endpoint takes a JSON array of parameters in the following format: | id | snowflake | role | | position? | ?integer | sorting position of the role (roles with the same position are sorted by id) | -## Modify Guild Role % PATCH /guilds/||FIXME||guild.id||/docs/resources/guild#guild-object||/roles/||FIXME||role.id||/docs/topics/permissions#role-object|| +## Modify Guild Role +/guilds/[\{guild.id\}](/docs/resources/guild#guild-object)/roles/[\{role.id\}](/docs/topics/permissions#role-object) Modify a guild role. Requires the `MANAGE_ROLES` permission. Returns the updated [role](/docs/topics/permissions#role-object) on success. Fires a [Guild Role Update](/docs/events/gateway-events#guild-role-update) Gateway event. @@ -1249,7 +1278,8 @@ This endpoint supports the `X-Audit-Log-Reason` header. | unicode_emoji | string | the role's unicode emoji as a [standard emoji](/docs/reference#message-formatting) (if the guild has the `ROLE_ICONS` feature) | | mentionable | boolean | whether the role should be mentionable | -## Modify Guild MFA Level % POST /guilds/||FIXME||guild.id||/docs/resources/guild#guild-object||/mfa +## Modify Guild MFA Level +/guilds/[\{guild.id\}](/docs/resources/guild#guild-object)/mfa Modify a guild's MFA level. Requires guild ownership. Returns the updated [level](/docs/resources/guild#guild-object-mfa-level) on success. Fires a [Guild Update](/docs/events/gateway-events#guild-update) Gateway event. @@ -1263,7 +1293,8 @@ This endpoint supports the `X-Audit-Log-Reason` header. |-------|---------|-----------------------------------------------------------| | level | integer | [MFA level](/docs/resources/guild#guild-object-mfa-level) | -## Delete Guild Role % DELETE /guilds/||FIXME||guild.id||/docs/resources/guild#guild-object||/roles/||FIXME||role.id||/docs/topics/permissions#role-object|| +## Delete Guild Role +/guilds/[\{guild.id\}](/docs/resources/guild#guild-object)/roles/[\{role.id\}](/docs/topics/permissions#role-object) Delete a guild role. Requires the `MANAGE_ROLES` permission. Returns a 204 empty response on success. Fires a [Guild Role Delete](/docs/events/gateway-events#guild-role-delete) Gateway event. @@ -1271,7 +1302,8 @@ Delete a guild role. Requires the `MANAGE_ROLES` permission. Returns a 204 empty This endpoint supports the `X-Audit-Log-Reason` header. ::: -## Get Guild Prune Count % GET /guilds/||FIXME||guild.id||/docs/resources/guild#guild-object||/prune +## Get Guild Prune Count +/guilds/[\{guild.id\}](/docs/resources/guild#guild-object)/prune Returns an object with one `pruned` key indicating the number of members that would be removed in a prune operation. Requires the `MANAGE_GUILD` and `KICK_MEMBERS` permissions. @@ -1284,7 +1316,8 @@ By default, prune will not remove users with roles. You can optionally include s | days | integer | number of days to count prune for (1-30) | 7 | | include_roles | string; comma-delimited array of snowflakes | role(s) to include | none | -## Begin Guild Prune % POST /guilds/||FIXME||guild.id||/docs/resources/guild#guild-object||/prune +## Begin Guild Prune +/guilds/[\{guild.id\}](/docs/resources/guild#guild-object)/prune Begin a prune operation. Requires the `MANAGE_GUILD` and `KICK_MEMBERS` permissions. Returns an object with one `pruned` key indicating the number of members that were removed in the prune operation. For large guilds it's recommended to set the `compute_prune_count` option to `false`, forcing `pruned` to `null`. Fires multiple [Guild Member Remove](/docs/events/gateway-events#guild-member-remove) Gateway events. @@ -1303,15 +1336,18 @@ This endpoint supports the `X-Audit-Log-Reason` header. | include_roles | array of snowflakes | role(s) to include | none | | reason? | string | reason for the prune (deprecated) | | -## Get Guild Voice Regions % GET /guilds/||FIXME||guild.id||/docs/resources/guild#guild-object||/regions +## Get Guild Voice Regions +/guilds/[\{guild.id\}](/docs/resources/guild#guild-object)/regions Returns a list of [voice region](/docs/resources/voice#voice-region-object) objects for the guild. Unlike the similar `/voice` route, this returns VIP servers when the guild is VIP-enabled. -## Get Guild Invites % GET /guilds/||FIXME||guild.id||/docs/resources/guild#guild-object||/invites +## Get Guild Invites +/guilds/[\{guild.id\}](/docs/resources/guild#guild-object)/invites Returns a list of [invite](/docs/resources/invite#invite-object) objects (with [invite metadata](/docs/resources/invite#invite-metadata-object)) for the guild. Requires the `MANAGE_GUILD` permission. -## Get Guild Integrations % GET /guilds/||FIXME||guild.id||/docs/resources/guild#guild-object||/integrations +## Get Guild Integrations +/guilds/[\{guild.id\}](/docs/resources/guild#guild-object)/integrations Returns a list of [integration](/docs/resources/guild#integration-object) objects for the guild. Requires the `MANAGE_GUILD` permission. @@ -1319,7 +1355,8 @@ Returns a list of [integration](/docs/resources/guild#integration-object) object This endpoint returns a maximum of 50 integrations. If a guild has more integrations, they cannot be accessed. ::: -## Delete Guild Integration % DELETE /guilds/||FIXME||guild.id||/docs/resources/guild#guild-object||/integrations/||FIXME||integration.id||/docs/resources/guild#integration-object|| +## Delete Guild Integration +/guilds/[\{guild.id\}](/docs/resources/guild#guild-object)/integrations/[\{integration.id\}](/docs/resources/guild#integration-object) Delete the attached [integration](/docs/resources/guild#integration-object) object for the guild. Deletes any associated webhooks and kicks the associated bot if there is one. Requires the `MANAGE_GUILD` permission. Returns a 204 empty response on success. Fires [Guild Integrations Update](/docs/events/gateway-events#guild-integrations-update) and [Integration Delete](/docs/events/gateway-events#integration-delete) Gateway events. @@ -1327,11 +1364,13 @@ Delete the attached [integration](/docs/resources/guild#integration-object) obje This endpoint supports the `X-Audit-Log-Reason` header. ::: -## Get Guild Widget Settings % GET /guilds/||FIXME||guild.id||/docs/resources/guild#guild-object||/widget +## Get Guild Widget Settings +/guilds/[\{guild.id\}](/docs/resources/guild#guild-object)/widget Returns a [guild widget settings](/docs/resources/guild#guild-widget-settings-object) object. Requires the `MANAGE_GUILD` permission. -## Modify Guild Widget % PATCH /guilds/||FIXME||guild.id||/docs/resources/guild#guild-object||/widget +## Modify Guild Widget +/guilds/[\{guild.id\}](/docs/resources/guild#guild-object)/widget Modify a [guild widget settings](/docs/resources/guild#guild-widget-settings-object) object for the guild. All attributes may be passed in with JSON and modified. Requires the `MANAGE_GUILD` permission. Returns the updated [guild widget settings](/docs/resources/guild#guild-widget-settings-object) object. Fires a [Guild Update](/docs/events/gateway-events#guild-update) Gateway event. @@ -1339,11 +1378,13 @@ Modify a [guild widget settings](/docs/resources/guild#guild-widget-settings-obj This endpoint supports the `X-Audit-Log-Reason` header. ::: -## Get Guild Widget % GET /guilds/||FIXME||guild.id||/docs/resources/guild#guild-object||/widget.json +## Get Guild Widget +/guilds/[\{guild.id\}](/docs/resources/guild#guild-object)/widget.json Returns the [widget](/docs/resources/guild#guild-widget-object) for the guild. Fires an [Invite Create](/docs/events/gateway-events#invite-create) Gateway event when an invite channel is defined and a new [Invite](/docs/resources/invite#invite-object) is generated. -## Get Guild Vanity URL % GET /guilds/||FIXME||guild.id||/docs/resources/guild#guild-object||/vanity-url +## Get Guild Vanity URL +/guilds/[\{guild.id\}](/docs/resources/guild#guild-object)/vanity-url Returns a partial [invite](/docs/resources/invite#invite-object) object for guilds with that feature enabled. Requires the `MANAGE_GUILD` permission. `code` will be null if a vanity url for the guild is not set. @@ -1360,7 +1401,8 @@ This endpoint is required to get the usage count of the vanity invite, but the i } ``` -## Get Guild Widget Image % GET /guilds/||FIXME||guild.id||/docs/resources/guild#guild-object||/widget.png +## Get Guild Widget Image +/guilds/[\{guild.id\}](/docs/resources/guild#guild-object)/widget.png Returns a PNG image widget for the guild. Requires no permissions or authentication. @@ -1384,11 +1426,13 @@ All parameters to this endpoint are optional. | banner3 | large image with guild icon, name and online count. In the footer, Discord logo on the left and "Chat Now" on the right | [Example](https://discord.com/api/guilds/81384788765712384/widget.png?style=banner3) | | banner4 | large Discord logo at the top of the widget. Guild icon, name and online count in the middle portion of the widget and a "JOIN MY SERVER" button at the bottom | [Example](https://discord.com/api/guilds/81384788765712384/widget.png?style=banner4) | -## Get Guild Welcome Screen % GET /guilds/||FIXME||guild.id||/docs/resources/guild#guild-object||/welcome-screen +## Get Guild Welcome Screen +/guilds/[\{guild.id\}](/docs/resources/guild#guild-object)/welcome-screen Returns the [Welcome Screen](/docs/resources/guild#welcome-screen-object) object for the guild. If the welcome screen is not enabled, the `MANAGE_GUILD` permission is required. -## Modify Guild Welcome Screen % PATCH /guilds/||FIXME||guild.id||/docs/resources/guild#guild-object||/welcome-screen +## Modify Guild Welcome Screen +/guilds/[\{guild.id\}](/docs/resources/guild#guild-object)/welcome-screen Modify the guild's [Welcome Screen](/docs/resources/guild#welcome-screen-object). Requires the `MANAGE_GUILD` permission. Returns the updated [Welcome Screen](/docs/resources/guild#welcome-screen-object) object. May fire a [Guild Update](/docs/events/gateway-events#guild-update) Gateway event. @@ -1408,11 +1452,13 @@ This endpoint supports the `X-Audit-Log-Reason` header. | welcome_channels | array of [welcome screen channel](/docs/resources/guild#welcome-screen-object-welcome-screen-channel-structure) objects | channels linked in the welcome screen and their display options | | description | string | the server description to show in the welcome screen | -## Get Guild Onboarding % GET /guilds/||FIXME||guild.id||/docs/resources/guild#guild-object||/onboarding +## Get Guild Onboarding +/guilds/[\{guild.id\}](/docs/resources/guild#guild-object)/onboarding Returns the [Onboarding](/docs/resources/guild#guild-onboarding-object) object for the guild. -## Modify Guild Onboarding % PUT /guilds/||FIXME||guild.id||/docs/resources/guild#guild-object||/onboarding +## Modify Guild Onboarding +/guilds/[\{guild.id\}](/docs/resources/guild#guild-object)/onboarding Modifies the onboarding configuration of the guild. Returns a 200 with the [Onboarding](/docs/resources/guild#guild-onboarding-object) object for the guild. Requires the `MANAGE_GUILD` and `MANAGE_ROLES` permissions. @@ -1433,7 +1479,8 @@ This endpoint supports the `X-Audit-Log-Reason` header. | enabled | boolean | Whether onboarding is enabled in the guild | | mode | [onboarding mode](/docs/resources/guild#guild-onboarding-object-onboarding-mode) | Current mode of onboarding | -## Modify Guild Incident Actions % PUT /guilds/||FIXME||guild.id||/docs/resources/guild#guild-object||/incident-actions +## Modify Guild Incident Actions +/guilds/[\{guild.id\}](/docs/resources/guild#guild-object)/incident-actions Modifies the incident actions of the guild. Returns a 200 with the [Incidents Data](/docs/resources/guild#incidents-data-object) object for the guild. Requires the `MANAGE_GUILD` permission. diff --git a/docs/resources/invite.md b/docs/resources/invite.mdx similarity index 97% rename from docs/resources/invite.md rename to docs/resources/invite.mdx index 2dd2dcb03e..892d6320b9 100644 --- a/docs/resources/invite.md +++ b/docs/resources/invite.mdx @@ -145,7 +145,8 @@ This is deprecated. } ``` -## Get Invite % GET /invites/||FIXME||invite.code||/docs/resources/invite#invite-object|| +## Get Invite +/invites/[\{invite.code\}](/docs/resources/invite#invite-object) Returns an [invite](/docs/resources/invite#invite-object) object for the given code. @@ -157,7 +158,8 @@ Returns an [invite](/docs/resources/invite#invite-object) object for the given c | with_expiration? | [boolean](/docs/reference#boolean-query-strings) | whether the invite should contain the expiration date | | guild_scheduled_event_id? | snowflake | the guild scheduled event to include with the invite | -## Delete Invite % DELETE /invites/||FIXME||invite.code||/docs/resources/invite#invite-object|| +## Delete Invite +/invites/[\{invite.code\}](/docs/resources/invite#invite-object) Delete an invite. Requires the `MANAGE_CHANNELS` permission on the channel this invite belongs to, or `MANAGE_GUILD` to remove any invite across the guild. Returns an [invite](/docs/resources/invite#invite-object) object on success. Fires an [Invite Delete](/docs/events/gateway-events#invite-delete) Gateway event. diff --git a/docs/resources/lobby.md b/docs/resources/lobby.mdx similarity index 69% rename from docs/resources/lobby.md rename to docs/resources/lobby.mdx index 16aaa3ca7a..6472cf1e75 100644 --- a/docs/resources/lobby.md +++ b/docs/resources/lobby.mdx @@ -14,7 +14,7 @@ Represents a lobby within Discord. See [Managing Lobbies](/docs/discord-social-s |-----------------|----------------------------------------------------------------------------|---------------------------------------------------------------------| | id | snowflake | the id of this channel | | application_id | snowflake | application that created the lobby | -| metadata | ?dict | dictionary of string key/value pairs. The max total length is 1000. | +| metadata | ?dict\ | dictionary of string key/value pairs. The max total length is 1000. | | members | array of [lobby member](/docs/resources/lobby#lobby-member-object) objects | members of the lobby | | linked_channel? | channel object | the guild channel linked to the lobby | @@ -24,11 +24,11 @@ Represents a member of a lobby, including optional metadata and flags. ###### Lobby Member Structure -| Field | Type | Description | -|-----------|-----------------------|------------------------------------------------------------------------------------------------------------------------------------------------------| -| id | snowflake | the id of the user | -| metadata? | ?dict | dictionary of string key/value pairs. The max total length is 1000. | -| flags? | integer | [lobby member flags](/docs/resources/lobby#lobby-member-object-lobby-member-flags) combined as a [bitfield](https://en.wikipedia.org/wiki/Bit_field) | +| Field | Type | Description | +|-----------|-------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------| +| id | snowflake | the id of the user | +| metadata? | ?dict\ | dictionary of string key/value pairs. The max total length is 1000. | +| flags? | integer | [lobby member flags](/docs/resources/lobby#lobby-member-object-lobby-member-flags) combined as a [bitfield](https://en.wikipedia.org/wiki/Bit_field) | ###### Lobby Member Flags @@ -56,7 +56,8 @@ Represents a member of a lobby, including optional metadata and flags. } ``` -## Create Lobby % POST /lobbies +## Create Lobby +/lobbies Creates a new lobby, adding any of the specified members to it, if provided. @@ -70,23 +71,25 @@ Returns a [lobby](/docs/resources/lobby#lobby-object) object. | Field | Type | Description | |-----------------------|----------------------------------------------------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| metadata? | ?dict | optional dictionary of string key/value pairs. The max total length is 1000. | +| metadata? | ?dict\ | optional dictionary of string key/value pairs. The max total length is 1000. | | members? | array of [lobby member](/docs/resources/lobby#lobby-member-object) objects | optional array of up to 25 users to be added to the lobby | | idle_timeout_seconds? | integer | seconds to wait before shutting down a lobby after it becomes idle. Value can be between 5 and 604800 (7 days). See [`LobbyHandle`] for more details on this behavior. | #### Lobby Member JSON Params -| Field | Type | Description | -|-----------|-----------------------|------------------------------------------------------------------------------------------------------------------------------------------------------| -| id | snowflake | Discord user id of the user to add to the lobby | -| metadata? | ?dict | optional dictionary of string key/value pairs. The max total length is 1000. | -| flags? | integer | [lobby member flags](/docs/resources/lobby#lobby-member-object-lobby-member-flags) combined as a [bitfield](https://en.wikipedia.org/wiki/Bit_field) | +| Field | Type | Description | +|-----------|-------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------| +| id | snowflake | Discord user id of the user to add to the lobby | +| metadata? | ?dict\ | optional dictionary of string key/value pairs. The max total length is 1000. | +| flags? | integer | [lobby member flags](/docs/resources/lobby#lobby-member-object-lobby-member-flags) combined as a [bitfield](https://en.wikipedia.org/wiki/Bit_field) | -## Get Lobby % GET /lobbies/||FIXME||lobby.id||/docs/resources/lobby#lobby-object|| +## Get Lobby +/lobbies/[\{lobby.id\}](/docs/resources/lobby#lobby-object) Returns a [lobby](/docs/resources/lobby#lobby-object) object for the specified lobby id, if it exists. -## Modify Lobby % PATCH /lobbies/||FIXME||lobby.id||/docs/resources/lobby#lobby-object|| +## Modify Lobby +/lobbies/[\{lobby.id\}](/docs/resources/lobby#lobby-object) Modifies the specified lobby with new values, if provided. @@ -96,11 +99,12 @@ Returns the updated [lobby](/docs/resources/lobby#lobby-object) object. | Field | Type | Description | |-----------------------|----------------------------------------------------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| metadata? | ?dict | optional dictionary of string key/value pairs. The max total length is 1000. Overwrites any existing metadata. | +| metadata? | ?dict\ | optional dictionary of string key/value pairs. The max total length is 1000. Overwrites any existing metadata. | | members? | array of [lobby member](/docs/resources/lobby#lobby-member-object) objects | optional array of up to 25 users to replace the lobby members with. If provided, lobby members not in this list will be removed from the lobby. | | idle_timeout_seconds? | integer | seconds to wait before shutting down a lobby after it becomes idle. Value can be between 5 and 604800 (7 days). See [`LobbyHandle`] for more details on this behavior. | -## Delete Lobby % DELETE /lobbies/||FIXME||lobby.id||/docs/resources/lobby#lobby-object|| +## Delete Lobby +/lobbies/[\{lobby.id\}](/docs/resources/lobby#lobby-object) Deletes the specified lobby if it exists. @@ -108,7 +112,8 @@ It is safe to call even if the lobby is already deleted as well. Returns nothing. -## Add a Member to a Lobby % PUT /lobbies/||FIXME||lobby.id||/docs/resources/lobby#lobby-object||/members/||FIXME||user.id||/docs/resources/user#user-object|| +## Add a Member to a Lobby +/lobbies/[\{lobby.id\}](/docs/resources/lobby#lobby-object)/members/[\{user.id\}](/docs/resources/user#user-object) Adds the provided user to the specified lobby. If called when the user is already a member of the lobby will update fields such as metadata on that user instead. @@ -116,18 +121,20 @@ Returns the [lobby member](/docs/resources/lobby#lobby-member-object) object. ### JSON Params -| Field | Type | Description | -|-----------|-----------------------|------------------------------------------------------------------------------------------------------------------------------------------------------| -| metadata? | ?dict | optional dictionary of string key/value pairs. The max total length is 1000. | -| flags? | integer | [lobby member flags](/docs/resources/lobby#lobby-member-object-lobby-member-flags) combined as a [bitfield](https://en.wikipedia.org/wiki/Bit_field) | +| Field | Type | Description | +|-----------|-------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------| +| metadata? | ?dict\ | optional dictionary of string key/value pairs. The max total length is 1000. | +| flags? | integer | [lobby member flags](/docs/resources/lobby#lobby-member-object-lobby-member-flags) combined as a [bitfield](https://en.wikipedia.org/wiki/Bit_field) | -## Remove a Member from a Lobby % DELETE /lobbies/||FIXME||lobby.id||/docs/resources/lobby#lobby-object||/members/||FIXME||user.id||/docs/resources/user#user-object|| +## Remove a Member from a Lobby +/lobbies/[\{lobby.id\}](/docs/resources/lobby#lobby-object)/members/[\{user.id\}](/docs/resources/user#user-object) Removes the provided user from the specified lobby. It is safe to call this even if the user is no longer a member of the lobby, but will fail if the lobby does not exist. Returns nothing. -## Leave Lobby % DELETE /lobbies/||FIXME||lobby.id||/docs/resources/lobby#lobby-object||/members/@me +## Leave Lobby +/lobbies/[\{lobby.id\}](/docs/resources/lobby#lobby-object)/members/@me Removes the current user from the specified lobby. It is safe to call this even if the user is no longer a member of the lobby, but will fail if the lobby does not exist. @@ -135,7 +142,8 @@ Uses `Bearer` token for authorization. Returns nothing. -## Link Channel to Lobby % PATCH /lobbies/||FIXME||lobby.id||/docs/resources/lobby#lobby-object||/channel-linking +## Link Channel to Lobby +/lobbies/[\{lobby.id\}](/docs/resources/lobby#lobby-object)/channel-linking Links an existing text channel to a lobby. See [Linked Channels](/docs/discord-social-sdk/development-guides/linked-channels) for more information. @@ -149,7 +157,8 @@ Returns a [lobby](/docs/resources/lobby#lobby-object) object with a linked chann |-------------|-----------|------------------------------------------------------------------------------------------------------------------------| | channel_id? | snowflake | the id of the channel to link to the lobby. If not provided, will unlink any currently linked channels from the lobby. | -## Unlink Channel from Lobby % PATCH /lobbies/||FIXME||lobby.id||/docs/resources/lobby#lobby-object||/channel-linking +## Unlink Channel from Lobby +/lobbies/[\{lobby.id\}](/docs/resources/lobby#lobby-object)/channel-linking Unlinks any currently linked channels from the specified lobby. @@ -159,6 +168,6 @@ Uses `Bearer` token for authorization and user must be a lobby member with `CanL Returns a [lobby](/docs/resources/lobby#lobby-object) object without a linked channel. - +{/* Autogenerated Reference Links */} [`Client::CreateOrJoinLobby`]: https://discord.com/developers/docs/social-sdk/classdiscordpp_1_1Client.html#a8b4e195555ecaa89ccdfc0acd28d3512 [`LobbyHandle`]: https://discord.com/developers/docs/social-sdk/classdiscordpp_1_1LobbyHandle.html#aa3510c347c4c4758bdf9f19caf2a95f3 \ No newline at end of file diff --git a/docs/resources/message.md b/docs/resources/message.mdx similarity index 97% rename from docs/resources/message.md rename to docs/resources/message.mdx index 0e89b28731..8ab9dc68cf 100644 --- a/docs/resources/message.md +++ b/docs/resources/message.mdx @@ -734,7 +734,8 @@ user 125 in the content. | total_months_subscribed | integer | the cumulative number of months that the user has been subscribed for | | is_renewal | boolean | whether this notification is for a renewal rather than a new purchase | -## Get Channel Messages % GET /channels/||FIXME||channel.id||/docs/resources/channel#channel-object||/messages +## Get Channel Messages +/channels/[\{channel.id\}](/docs/resources/channel#channel-object)/messages Retrieves the messages in a channel. Returns an array of [message](/docs/resources/message#message-object) objects on success. @@ -755,13 +756,15 @@ The `before`, `after`, and `around` parameters are mutually exclusive, only one | after? | snowflake | Get messages after this message ID | absent | | limit? | integer | Max number of messages to return (1-100) | 50 | -## Get Channel Message % GET /channels/||FIXME||channel.id||/docs/resources/channel#channel-object||/messages/||FIXME||message.id||/docs/resources/message#message-object|| +## Get Channel Message +/channels/[\{channel.id\}](/docs/resources/channel#channel-object)/messages/[\{message.id\}](/docs/resources/message#message-object) Retrieves a specific message in the channel. Returns a [message](/docs/resources/message#message-object) object on success. If operating on a guild channel, this endpoint requires the current user to have the `VIEW_CHANNEL` and `READ_MESSAGE_HISTORY` permissions. If the channel is a voice channel, they must _also_ have the `CONNECT` permission. -## Create Message % POST /channels/||FIXME||channel.id||/docs/resources/channel#channel-object||/messages +## Create Message +/channels/[\{channel.id\}](/docs/resources/channel#channel-object)/messages :::warn Discord may strip certain characters from message content, like invalid unicode characters or characters which cause unexpected message formatting. If you are passing user-generated strings into message content, consider sanitizing the data to prevent unexpected behavior and using `allowed_mentions` to prevent unexpected mentions. @@ -823,28 +826,33 @@ When creating a message, apps must provide a value for **at least one of** `cont Examples for file uploads are available in [Uploading Files](/docs/reference#uploading-files). -## Crosspost Message % POST /channels/||FIXME||channel.id||/docs/resources/channel#channel-object||/messages/||FIXME||message.id||/docs/resources/message#message-object||/crosspost +## Crosspost Message +/channels/[\{channel.id\}](/docs/resources/channel#channel-object)/messages/[\{message.id\}](/docs/resources/message#message-object)/crosspost Crosspost a message in an Announcement Channel to following channels. This endpoint requires the `SEND_MESSAGES` permission, if the current user sent the message, or additionally the `MANAGE_MESSAGES` permission, for all other messages, to be present for the current user. Returns a [message](/docs/resources/message#message-object) object. Fires a [Message Update](/docs/events/gateway-events#message-update) Gateway event. -## Create Reaction % PUT /channels/||FIXME||channel.id||/docs/resources/channel#channel-object||/messages/||FIXME||message.id||/docs/resources/message#message-object||/reactions/||FIXME||emoji.id||/docs/resources/emoji#emoji-object||/@me +## Create Reaction +/channels/[\{channel.id\}](/docs/resources/channel#channel-object)/messages/[\{message.id\}](/docs/resources/message#message-object)/reactions/[\{emoji.id\}](/docs/resources/emoji#emoji-object)/@me Create a reaction for the message. This endpoint requires the `READ_MESSAGE_HISTORY` permission to be present on the current user. Additionally, if nobody else has reacted to the message using this emoji, this endpoint requires the `ADD_REACTIONS` permission to be present on the current user. Returns a 204 empty response on success. Fires a [Message Reaction Add](/docs/events/gateway-events#message-reaction-add) Gateway event. The `emoji` must be [URL Encoded](https://en.wikipedia.org/wiki/Percent-encoding) or the request will fail with `10014: Unknown Emoji`. To use custom emoji, you must encode it in the format `name:id` with the emoji name and emoji id. -## Delete Own Reaction % DELETE /channels/||FIXME||channel.id||/docs/resources/channel#channel-object||/messages/||FIXME||message.id||/docs/resources/message#message-object||/reactions/||FIXME||emoji.id||/docs/resources/emoji#emoji-object||/@me +## Delete Own Reaction +/channels/[\{channel.id\}](/docs/resources/channel#channel-object)/messages/[\{message.id\}](/docs/resources/message#message-object)/reactions/[\{emoji.id\}](/docs/resources/emoji#emoji-object)/@me Delete a reaction the current user has made for the message. Returns a 204 empty response on success. Fires a [Message Reaction Remove](/docs/events/gateway-events#message-reaction-remove) Gateway event. The `emoji` must be [URL Encoded](https://en.wikipedia.org/wiki/Percent-encoding) or the request will fail with `10014: Unknown Emoji`. To use custom emoji, you must encode it in the format `name:id` with the emoji name and emoji id. -## Delete User Reaction % DELETE /channels/||FIXME||channel.id||/docs/resources/channel#channel-object||/messages/||FIXME||message.id||/docs/resources/message#message-object||/reactions/||FIXME||emoji.id||/docs/resources/emoji#emoji-object||/||FIXME||user.id||/docs/resources/user#user-object|| +## Delete User Reaction +/channels/[\{channel.id\}](/docs/resources/channel#channel-object)/messages/[\{message.id\}](/docs/resources/message#message-object)/reactions/[\{emoji.id\}](/docs/resources/emoji#emoji-object)/[\{user.id\}](/docs/resources/user#user-object) Deletes another user's reaction. This endpoint requires the `MANAGE_MESSAGES` permission to be present on the current user. Returns a 204 empty response on success. Fires a [Message Reaction Remove](/docs/events/gateway-events#message-reaction-remove) Gateway event. The `emoji` must be [URL Encoded](https://en.wikipedia.org/wiki/Percent-encoding) or the request will fail with `10014: Unknown Emoji`. To use custom emoji, you must encode it in the format `name:id` with the emoji name and emoji id. -## Get Reactions % GET /channels/||FIXME||channel.id||/docs/resources/channel#channel-object||/messages/||FIXME||message.id||/docs/resources/message#message-object||/reactions/||FIXME||emoji.id||/docs/resources/emoji#emoji-object|| +## Get Reactions +/channels/[\{channel.id\}](/docs/resources/channel#channel-object)/messages/[\{message.id\}](/docs/resources/message#message-object)/reactions/[\{emoji.id\}](/docs/resources/emoji#emoji-object) Get a list of users that reacted with this emoji. Returns an array of [user](/docs/resources/user#user-object) objects on success. The `emoji` must be [URL Encoded](https://en.wikipedia.org/wiki/Percent-encoding) or the request will fail with `10014: Unknown Emoji`. To use custom emoji, you must encode it in the format `name:id` with the emoji name and emoji id. @@ -864,16 +872,19 @@ The `emoji` must be [URL Encoded](https://en.wikipedia.org/wiki/Percent-encoding | NORMAL | 0 | | BURST | 1 | -## Delete All Reactions % DELETE /channels/||FIXME||channel.id||/docs/resources/channel#channel-object||/messages/||FIXME||message.id||/docs/resources/message#message-object||/reactions +## Delete All Reactions +/channels/[\{channel.id\}](/docs/resources/channel#channel-object)/messages/[\{message.id\}](/docs/resources/message#message-object)/reactions Deletes all reactions on a message. This endpoint requires the `MANAGE_MESSAGES` permission to be present on the current user. Fires a [Message Reaction Remove All](/docs/events/gateway-events#message-reaction-remove-all) Gateway event. -## Delete All Reactions for Emoji % DELETE /channels/||FIXME||channel.id||/docs/resources/channel#channel-object||/messages/||FIXME||message.id||/docs/resources/message#message-object||/reactions/||FIXME||emoji.id||/docs/resources/emoji#emoji-object|| +## Delete All Reactions for Emoji +/channels/[\{channel.id\}](/docs/resources/channel#channel-object)/messages/[\{message.id\}](/docs/resources/message#message-object)/reactions/[\{emoji.id\}](/docs/resources/emoji#emoji-object) Deletes all the reactions for a given emoji on a message. This endpoint requires the `MANAGE_MESSAGES` permission to be present on the current user. Fires a [Message Reaction Remove Emoji](/docs/events/gateway-events#message-reaction-remove-emoji) Gateway event. The `emoji` must be [URL Encoded](https://en.wikipedia.org/wiki/Percent-encoding) or the request will fail with `10014: Unknown Emoji`. To use custom emoji, you must encode it in the format `name:id` with the emoji name and emoji id. -## Edit Message % PATCH /channels/||FIXME||channel.id||/docs/resources/channel#channel-object||/messages/||FIXME||message.id||/docs/resources/message#message-object|| +## Edit Message +/channels/[\{channel.id\}](/docs/resources/channel#channel-object)/messages/[\{message.id\}](/docs/resources/message#message-object) Edit a previously sent message. The fields `content`, `embeds`, and `flags` can be edited by the original message author. Other users can only edit `flags` and only if they have the `MANAGE_MESSAGES` permission in the corresponding channel. When specifying flags, ensure to include all previously set flags/bits in addition to ones that you are modifying. Only `flags` documented in the table below may be modified by users (unsupported flag changes are currently ignored without error). @@ -905,7 +916,8 @@ All parameters to this endpoint are optional and nullable. | payload_json | string | JSON-encoded body of non-file params (multipart/form-data only). See [Uploading Files](/docs/reference#uploading-files) | | attachments | array of [attachment](/docs/resources/message#attachment-object) objects | Attached files to keep and possible descriptions for new files. See [Uploading Files](/docs/reference#uploading-files) | -## Delete Message % DELETE /channels/||FIXME||channel.id||/docs/resources/channel#channel-object||/messages/||FIXME||message.id||/docs/resources/message#message-object|| +## Delete Message +/channels/[\{channel.id\}](/docs/resources/channel#channel-object)/messages/[\{message.id\}](/docs/resources/message#message-object) Delete a message. If operating on a guild channel and trying to delete a message that was not sent by the current user, this endpoint requires the `MANAGE_MESSAGES` permission. Returns a 204 empty response on success. Fires a [Message Delete](/docs/events/gateway-events#message-delete) Gateway event. @@ -913,7 +925,8 @@ Delete a message. If operating on a guild channel and trying to delete a message This endpoint supports the `X-Audit-Log-Reason` header. ::: -## Bulk Delete Messages % POST /channels/||FIXME||channel.id||/docs/resources/channel#channel-object||/messages/bulk-delete +## Bulk Delete Messages +/channels/[\{channel.id\}](/docs/resources/channel#channel-object)/messages/bulk-delete Delete multiple messages in a single request. This endpoint can only be used on guild channels and requires the `MANAGE_MESSAGES` permission. Returns a 204 empty response on success. Fires a [Message Delete Bulk](/docs/events/gateway-events#message-delete-bulk) Gateway event. diff --git a/docs/resources/poll.md b/docs/resources/poll.mdx similarity index 95% rename from docs/resources/poll.md rename to docs/resources/poll.mdx index 60e03852c3..0ae7fbee2e 100644 --- a/docs/resources/poll.md +++ b/docs/resources/poll.mdx @@ -123,7 +123,8 @@ For creating a poll, see [Create Message](/docs/resources/message#create-message Apps are not allowed to vote on polls. No rights! :) -## Get Answer Voters % GET /channels/||FIXME||channel.id||/docs/resources/channel#channel-object||/polls/||FIXME||message.id||/docs/resources/message#message-object||/answers/||FIXME||answer_id||/docs/resources/poll#poll-answer-object|| +## Get Answer Voters +/channels/[\{channel.id\}](/docs/resources/channel#channel-object)/polls/[\{message.id\}](/docs/resources/message#message-object)/answers/[\{answer_id\}](/docs/resources/poll#poll-answer-object) Get a list of users that voted for this specific answer. @@ -140,7 +141,8 @@ Get a list of users that voted for this specific answer. |-------|---------------------------------------------------|---------------------------------| | users | array of [user](/docs/resources/user#user-object) | Users who voted for this answer | -## End Poll % POST /channels/||FIXME||channel.id||/docs/resources/channel#channel-object||/polls/||FIXME||message.id||/docs/resources/message#message-object||/expire +## End Poll +/channels/[\{channel.id\}](/docs/resources/channel#channel-object)/polls/[\{message.id\}](/docs/resources/message#message-object)/expire Immediately ends the poll. You cannot end polls from other users. diff --git a/docs/resources/sku.md b/docs/resources/sku.mdx similarity index 97% rename from docs/resources/sku.md rename to docs/resources/sku.mdx index 70c37ae9bf..8c50dbd15d 100644 --- a/docs/resources/sku.md +++ b/docs/resources/sku.mdx @@ -65,7 +65,8 @@ The `flags` field can be used to differentiate user and server subscriptions wit | GUILD_SUBSCRIPTION | `1 << 7` | Recurring SKU that can be purchased by a user and applied to a single server. Grants access to every user in that server. | | USER_SUBSCRIPTION | `1 << 8` | Recurring SKU purchased by a user for themselves. Grants access to the purchasing user in every server. | -## List SKUs % GET /applications/||FIXME||application.id||/docs/resources/application#application-object||/skus +## List SKUs +/applications/[\{application.id\}](/docs/resources/application#application-object)/skus Returns all SKUs for a given application. diff --git a/docs/resources/soundboard.md b/docs/resources/soundboard.mdx similarity index 87% rename from docs/resources/soundboard.md rename to docs/resources/soundboard.mdx index 8c73a1ef19..6ffe150c9e 100644 --- a/docs/resources/soundboard.md +++ b/docs/resources/soundboard.mdx @@ -60,7 +60,8 @@ A soundboard sound can be retrieved in MP3 or Ogg format at the URL: https://cdn.discordapp.com/soundboard-sounds/{sound_id} ``` -## Send Soundboard Sound % POST /channels/||FIXME||channel.id||/docs/resources/channel#channel-object||/send-soundboard-sound +## Send Soundboard Sound +/channels/[\{channel.id\}](/docs/resources/channel#channel-object)/send-soundboard-sound Send a soundboard sound to a voice channel the user is connected to. Fires a [Voice Channel Effect Send](/docs/events/gateway-events#voice-channel-effect-send) Gateway event. @@ -73,11 +74,13 @@ Requires the `SPEAK` and `USE_SOUNDBOARD` permissions, and also the `USE_EXTERNA | sound_id | snowflake | the id of the soundboard sound to play | | source_guild_id? | snowflake | the id of the guild the soundboard sound is from, required to play sounds from different servers | -## List Default Soundboard Sounds % GET /soundboard-default-sounds +## List Default Soundboard Sounds +/soundboard-default-sounds Returns an array of [soundboard sound](/docs/resources/soundboard#soundboard-sound-object) objects that can be used by all users. -## List Guild Soundboard Sounds % GET /guilds/||FIXME||guild.id||/docs/resources/guild#guild-object||/soundboard-sounds +## List Guild Soundboard Sounds +/guilds/[\{guild.id\}](/docs/resources/guild#guild-object)/soundboard-sounds Returns a list of the guild's soundboard sounds. Includes `user` fields if the bot has the `CREATE_GUILD_EXPRESSIONS` or `MANAGE_GUILD_EXPRESSIONS` permission. @@ -87,11 +90,13 @@ Returns a list of the guild's soundboard sounds. Includes `user` fields if the b |-------|-----------------------------------------------------------------------------------------| | items | array of [soundboard sound](/docs/resources/soundboard#soundboard-sound-object) objects | -## Get Guild Soundboard Sound % GET /guilds/||FIXME||guild.id||/docs/resources/guild#guild-object||/soundboard-sounds/||FIXME||sound.id||/docs/resources/soundboard#soundboard-sound-object|| +## Get Guild Soundboard Sound +/guilds/[\{guild.id\}](/docs/resources/guild#guild-object)/soundboard-sounds/[\{sound.id\}](/docs/resources/soundboard#soundboard-sound-object) Returns a [soundboard sound](/docs/resources/soundboard#soundboard-sound-object) object for the given sound id. Includes the `user` field if the bot has the `CREATE_GUILD_EXPRESSIONS` or `MANAGE_GUILD_EXPRESSIONS` permission. -## Create Guild Soundboard Sound % POST /guilds/||FIXME||guild.id||/docs/resources/guild#guild-object||/soundboard-sounds +## Create Guild Soundboard Sound +/guilds/[\{guild.id\}](/docs/resources/guild#guild-object)/soundboard-sounds Create a new soundboard sound for the guild. Requires the `CREATE_GUILD_EXPRESSIONS` permission. Returns the new [soundboard sound](/docs/resources/soundboard#soundboard-sound-object) object on success. Fires a [Guild Soundboard Sound Create](/docs/events/gateway-events#guild-soundboard-sound-create) Gateway event. @@ -113,7 +118,8 @@ This endpoint supports the `X-Audit-Log-Reason` header. | emoji_id? | ?snowflake | the id of the custom emoji for the soundboard sound | | emoji_name? | ?string | the unicode character of a standard emoji for the soundboard sound | -## Modify Guild Soundboard Sound % PATCH /guilds/||FIXME||guild.id||/docs/resources/guild#guild-object||/soundboard-sounds/||FIXME||sound.id||/docs/resources/soundboard#soundboard-sound-object|| +## Modify Guild Soundboard Sound +/guilds/[\{guild.id\}](/docs/resources/guild#guild-object)/soundboard-sounds/[\{sound.id\}](/docs/resources/soundboard#soundboard-sound-object) Modify the given soundboard sound. For sounds created by the current user, requires either the `CREATE_GUILD_EXPRESSIONS` or `MANAGE_GUILD_EXPRESSIONS` permission. For other sounds, requires the `MANAGE_GUILD_EXPRESSIONS` permission. Returns the updated [soundboard sound](/docs/resources/soundboard#soundboard-sound-object) object on success. Fires a [Guild Soundboard Sound Update](/docs/events/gateway-events#guild-soundboard-sound-update) Gateway event. @@ -134,7 +140,8 @@ This endpoint supports the `X-Audit-Log-Reason` header. | emoji_id | ?snowflake | the id of the custom emoji for the soundboard sound | | emoji_name | ?string | the unicode character of a standard emoji for the soundboard sound | -## Delete Guild Soundboard Sound % DELETE /guilds/||FIXME||guild.id||/docs/resources/guild#guild-object||/soundboard-sounds/||FIXME||sound.id||/docs/resources/soundboard#soundboard-sound-object|| +## Delete Guild Soundboard Sound +/guilds/[\{guild.id\}](/docs/resources/guild#guild-object)/soundboard-sounds/[\{sound.id\}](/docs/resources/soundboard#soundboard-sound-object) Delete the given soundboard sound. For sounds created by the current user, requires either the `CREATE_GUILD_EXPRESSIONS` or `MANAGE_GUILD_EXPRESSIONS` permission. For other sounds, requires the `MANAGE_GUILD_EXPRESSIONS` permission. Returns `204 No Content` on success. Fires a [Guild Soundboard Sound Delete](/docs/events/gateway-events#guild-soundboard-sound-delete) Gateway event. diff --git a/docs/resources/stage-instance.md b/docs/resources/stage-instance.mdx similarity index 93% rename from docs/resources/stage-instance.md rename to docs/resources/stage-instance.mdx index c1d32b3a0a..36ba8f41b5 100644 --- a/docs/resources/stage-instance.md +++ b/docs/resources/stage-instance.mdx @@ -61,7 +61,8 @@ Below are some definitions related to stages. When a Stage channel has no speakers for a certain period of time (on the order of minutes), the Stage instance will be automatically deleted. -## Create Stage Instance % POST /stage-instances +## Create Stage Instance +/stage-instances Creates a new Stage instance associated to a Stage channel. Returns that [Stage instance](/docs/resources/stage-instance#stage-instance-object-stage-instance-structure). Fires a [Stage Instance Create](/docs/events/gateway-events#stage-instance-create) Gateway event. @@ -83,11 +84,13 @@ This endpoint supports the `X-Audit-Log-Reason` header. \* The stage moderator must have the `MENTION_EVERYONE` permission for this notification to be sent. -## Get Stage Instance % GET /stage-instances/||FIXME||channel.id||/docs/resources/channel#channel-object|| +## Get Stage Instance +/stage-instances/[\{channel.id\}](/docs/resources/channel#channel-object) Gets the stage instance associated with the Stage channel, if it exists. -## Modify Stage Instance % PATCH /stage-instances/||FIXME||channel.id||/docs/resources/channel#channel-object|| +## Modify Stage Instance +/stage-instances/[\{channel.id\}](/docs/resources/channel#channel-object) Updates fields of an existing Stage instance. Returns the updated [Stage instance](/docs/resources/stage-instance#stage-instance-object-stage-instance-structure). Fires a [Stage Instance Update](/docs/events/gateway-events#stage-instance-update) Gateway event. @@ -104,7 +107,8 @@ This endpoint supports the `X-Audit-Log-Reason` header. | topic? | string | The topic of the Stage instance (1-120 characters) | | privacy_level? | integer | The [privacy level](/docs/resources/stage-instance#stage-instance-object-privacy-level) of the Stage instance | -## Delete Stage Instance % DELETE /stage-instances/||FIXME||channel.id||/docs/resources/channel#channel-object|| +## Delete Stage Instance +/stage-instances/[\{channel.id\}](/docs/resources/channel#channel-object) Deletes the Stage instance. Returns `204 No Content`. Fires a [Stage Instance Delete](/docs/events/gateway-events#stage-instance-delete) Gateway event. diff --git a/docs/resources/sticker.md b/docs/resources/sticker.mdx similarity index 90% rename from docs/resources/sticker.md rename to docs/resources/sticker.mdx index 22eec28235..70b652962a 100644 --- a/docs/resources/sticker.md +++ b/docs/resources/sticker.mdx @@ -100,11 +100,13 @@ Represents a pack of standard stickers. } ``` -## Get Sticker % GET /stickers/||FIXME||sticker.id||/docs/resources/sticker#sticker-object|| +## Get Sticker +/stickers/[\{sticker.id\}](/docs/resources/sticker#sticker-object) Returns a [sticker](/docs/resources/sticker#sticker-object) object for the given sticker ID. -## List Sticker Packs % GET /sticker-packs +## List Sticker Packs +/sticker-packs Returns a list of available sticker packs. @@ -114,19 +116,23 @@ Returns a list of available sticker packs. |---------------|------------------------------------------------------------------------------| | sticker_packs | array of [sticker pack](/docs/resources/sticker#sticker-pack-object) objects | -## Get Sticker Pack % GET /sticker-packs/||FIXME||pack.id||/docs/resources/sticker#sticker-pack-object|| +## Get Sticker Pack +/sticker-packs/[\{pack.id\}](/docs/resources/sticker#sticker-pack-object) Returns a [sticker pack](/docs/resources/sticker#sticker-pack-object) object for the given sticker pack ID. -## List Guild Stickers % GET /guilds/||FIXME||guild.id||/docs/resources/guild#guild-object||/stickers +## List Guild Stickers +/guilds/[\{guild.id\}](/docs/resources/guild#guild-object)/stickers Returns an array of [sticker](/docs/resources/sticker#sticker-object) objects for the given guild. Includes `user` fields if the bot has the `CREATE_GUILD_EXPRESSIONS` or `MANAGE_GUILD_EXPRESSIONS` permission. -## Get Guild Sticker % GET /guilds/||FIXME||guild.id||/docs/resources/guild#guild-object||/stickers/||FIXME||sticker.id||/docs/resources/sticker#sticker-object|| +## Get Guild Sticker +/guilds/[\{guild.id\}](/docs/resources/guild#guild-object)/stickers/[\{sticker.id\}](/docs/resources/sticker#sticker-object) Returns a [sticker](/docs/resources/sticker#sticker-object) object for the given guild and sticker IDs. Includes the `user` field if the bot has the `CREATE_GUILD_EXPRESSIONS` or `MANAGE_GUILD_EXPRESSIONS` permission. -## Create Guild Sticker % POST /guilds/||FIXME||guild.id||/docs/resources/guild#guild-object||/stickers +## Create Guild Sticker +/guilds/[\{guild.id\}](/docs/resources/guild#guild-object)/stickers Create a new sticker for the guild. Send a `multipart/form-data` body. Requires the `CREATE_GUILD_EXPRESSIONS` permission. Returns the new [sticker](/docs/resources/sticker#sticker-object) object on success. Fires a [Guild Stickers Update](/docs/events/gateway-events#guild-stickers-update) Gateway event. @@ -153,7 +159,8 @@ Uploaded stickers are constrained to 5 seconds in length for animated stickers, | tags | string | autocomplete/suggestion tags for the sticker (max 200 characters) | | file | file contents | the sticker file to upload, must be a PNG, APNG, GIF, or Lottie JSON file, max 512 KiB | -## Modify Guild Sticker % PATCH /guilds/||FIXME||guild.id||/docs/resources/guild#guild-object||/stickers/||FIXME||sticker.id||/docs/resources/sticker#sticker-object|| +## Modify Guild Sticker +/guilds/[\{guild.id\}](/docs/resources/guild#guild-object)/stickers/[\{sticker.id\}](/docs/resources/sticker#sticker-object) Modify the given sticker. For stickers created by the current user, requires either the `CREATE_GUILD_EXPRESSIONS` or `MANAGE_GUILD_EXPRESSIONS` permission. For other stickers, requires the `MANAGE_GUILD_EXPRESSIONS` permission. Returns the updated [sticker](/docs/resources/sticker#sticker-object) object on success. Fires a [Guild Stickers Update](/docs/events/gateway-events#guild-stickers-update) Gateway event. @@ -173,7 +180,8 @@ This endpoint supports the `X-Audit-Log-Reason` header. | description | ?string | description of the sticker (2-100 characters) | | tags | string | autocomplete/suggestion tags for the sticker (max 200 characters) | -## Delete Guild Sticker % DELETE /guilds/||FIXME||guild.id||/docs/resources/guild#guild-object||/stickers/||FIXME||sticker.id||/docs/resources/sticker#sticker-object|| +## Delete Guild Sticker +/guilds/[\{guild.id\}](/docs/resources/guild#guild-object)/stickers/[\{sticker.id\}](/docs/resources/sticker#sticker-object) Delete the given sticker. For stickers created by the current user, requires either the `CREATE_GUILD_EXPRESSIONS` or `MANAGE_GUILD_EXPRESSIONS` permission. For other stickers, requires the `MANAGE_GUILD_EXPRESSIONS` permission. Returns `204 No Content` on success. Fires a [Guild Stickers Update](/docs/events/gateway-events#guild-stickers-update) Gateway event. diff --git a/docs/resources/subscription.md b/docs/resources/subscription.mdx similarity index 94% rename from docs/resources/subscription.md rename to docs/resources/subscription.mdx index a8bac2848d..214efd58b2 100644 --- a/docs/resources/subscription.md +++ b/docs/resources/subscription.mdx @@ -60,7 +60,8 @@ Some examples of this behavior include: - While a failed payment is being retried, the subscription would remain `ACTIVE` until it succeeds or our system determines the payment is not recoverable. - A refund or chargeback during the current period would make the subscription `INACTIVE`. -## List SKU Subscriptions % GET /skus/||FIXME||sku.id||/docs/resources/sku#sku-object||/subscriptions +## List SKU Subscriptions +/skus/[\{sku.id\}](/docs/resources/sku#sku-object)/subscriptions Returns all subscriptions containing the SKU, filtered by user. Returns a list of [subscription](/docs/resources/subscription#subscription-object) objects. @@ -73,6 +74,7 @@ Returns all subscriptions containing the SKU, filtered by user. Returns a list o | limit? | integer | Number of results to return (1-100) | 50 | | user_id? | snowflake | User ID for which to return subscriptions. Required except for OAuth queries. | absent | -## Get SKU Subscription % GET /skus/||FIXME||sku.id||/docs/resources/sku#sku-object||/subscriptions/||FIXME||subscription.id||/docs/resources/subscription#subscription-object|| +## Get SKU Subscription +/skus/[\{sku.id\}](/docs/resources/sku#sku-object)/subscriptions/[\{subscription.id\}](/docs/resources/subscription#subscription-object) Get a subscription by its ID. Returns a [subscription](/docs/resources/subscription#subscription-object) object. diff --git a/docs/resources/user.md b/docs/resources/user.mdx similarity index 95% rename from docs/resources/user.md rename to docs/resources/user.mdx index 41d9e3416b..1d716963aa 100644 --- a/docs/resources/user.md +++ b/docs/resources/user.mdx @@ -183,15 +183,18 @@ The role connection object that an application has attached to a user. | platform_username | ?string | the username on the platform a bot has connected (max 100 characters) | | metadata | object | object mapping [application role connection metadata](/docs/resources/application-role-connection-metadata#application-role-connection-metadata-object) keys to their `string`-ified value (max 100 characters) for the user on the platform a bot has connected | -## Get Current User % GET /users/@me +## Get Current User +/users/@me Returns the [user](/docs/resources/user#user-object) object of the requester's account. For OAuth2, this requires the `identify` scope, which will return the object _without_ an email, and optionally the `email` scope, which returns the object _with_ an email if the user has one. -## Get User % GET /users/||FIXME||user.id||/docs/resources/user#user-object|| +## Get User +/users/[\{user.id\}](/docs/resources/user#user-object) Returns a [user](/docs/resources/user#user-object) object for a given user ID. -## Modify Current User % PATCH /users/@me +## Modify Current User +/users/@me Modify the requester's user account settings. Returns a [user](/docs/resources/user#user-object) object on success. Fires a [User Update](/docs/events/gateway-events#user-update) Gateway event. @@ -207,7 +210,8 @@ All parameters to this endpoint are optional. | avatar | ?[image data](/docs/reference#image-data) | if passed, modifies the user's avatar | | banner | ?[image data](/docs/reference#image-data) | if passed, modifies the user's banner | -## Get Current User Guilds % GET /users/@me/guilds +## Get Current User Guilds +/users/@me/guilds Returns a list of partial [guild](/docs/resources/guild#guild-object) objects the current user is a member of. For OAuth2, requires the `guilds` scope. @@ -240,15 +244,18 @@ This endpoint returns 200 guilds by default, which is the maximum number of guil | limit | integer | max number of guilds to return (1-200) | false | 200 | | with_counts | [boolean](/docs/reference#boolean-query-strings) | include approximate member and presence counts in response | false | false | -## Get Current User Guild Member % GET /users/@me/guilds/||FIXME||guild.id||/docs/resources/guild#guild-object||/member +## Get Current User Guild Member +/users/@me/guilds/[\{guild.id\}](/docs/resources/guild#guild-object)/member Returns a [guild member](/docs/resources/guild#guild-member-object) object for the current user. Requires the `guilds.members.read` OAuth2 scope. -## Leave Guild % DELETE /users/@me/guilds/||FIXME||guild.id||/docs/resources/guild#guild-object|| +## Leave Guild +/users/@me/guilds/[\{guild.id\}](/docs/resources/guild#guild-object) Leave a guild. Returns a 204 empty response on success. Fires a [Guild Delete](/docs/events/gateway-events#guild-delete) Gateway event and a [Guild Member Remove](/docs/events/gateway-events#guild-member-remove) Gateway event. -## Create DM % POST /users/@me/channels +## Create DM +/users/@me/channels Create a new DM channel with a user. Returns a [DM channel](/docs/resources/channel#channel-object) object (if one already exists, it will be returned instead). @@ -262,7 +269,8 @@ You should not use this endpoint to DM everyone in a server about something. DMs |--------------|-----------|-----------------------------------------| | recipient_id | snowflake | the recipient to open a DM channel with | -## Create Group DM % POST /users/@me/channels +## Create Group DM +/users/@me/channels Create a new group DM channel with multiple users. Returns a [DM channel](/docs/resources/channel#channel-object) object. This endpoint was intended to be used with the now-deprecated GameBridge SDK. Fires a [Channel Create](/docs/events/gateway-events#channel-create) Gateway event. @@ -277,15 +285,18 @@ This endpoint is limited to 10 active group DMs. | access_tokens | array of strings | access tokens of users that have granted your app the `gdm.join` scope | | nicks | dict | a dictionary of user ids to their respective nicknames | -## Get Current User Connections % GET /users/@me/connections +## Get Current User Connections +/users/@me/connections Returns a list of [connection](/docs/resources/user#connection-object) objects. Requires the `connections` OAuth2 scope. -## Get Current User Application Role Connection % GET /users/@me/applications/||FIXME||application.id||/docs/resources/application#application-object||/role-connection +## Get Current User Application Role Connection +/users/@me/applications/[\{application.id\}](/docs/resources/application#application-object)/role-connection Returns the [application role connection](/docs/resources/user#application-role-connection-object) for the user. Requires an OAuth2 access token with `role_connections.write` scope for the application specified in the path. -## Update Current User Application Role Connection % PUT /users/@me/applications/||FIXME||application.id||/docs/resources/application#application-object||/role-connection +## Update Current User Application Role Connection +/users/@me/applications/[\{application.id\}](/docs/resources/application#application-object)/role-connection Updates and returns the [application role connection](/docs/resources/user#application-role-connection-object) for the user. Requires an OAuth2 access token with `role_connections.write` scope for the application specified in the path. diff --git a/docs/resources/voice.md b/docs/resources/voice.mdx similarity index 89% rename from docs/resources/voice.md rename to docs/resources/voice.mdx index 63b1426386..6070160fe7 100644 --- a/docs/resources/voice.md +++ b/docs/resources/voice.mdx @@ -54,19 +54,23 @@ Used to represent a user's voice connection status. | deprecated | boolean | whether this is a deprecated voice region (avoid switching to these) | | custom | boolean | whether this is a custom voice region (used for events/etc) | -## List Voice Regions % GET /voice/regions +## List Voice Regions +/voice/regions Returns an array of [voice region](/docs/resources/voice#voice-region-object) objects that can be used when setting a voice or stage channel's [`rtc_region`](/docs/resources/channel#channel-object-channel-structure). -## Get Current User Voice State % GET /guilds/||FIXME||guild.id||/docs/resources/guild#guild-object||/voice-states/@me +## Get Current User Voice State +/guilds/[\{guild.id\}](/docs/resources/guild#guild-object)/voice-states/@me Returns the current user's [voice state](/docs/resources/voice#voice-state-object) in the guild. -## Get User Voice State % GET /guilds/||FIXME||guild.id||/docs/resources/guild#guild-object||/voice-states/||FIXME||user.id||/docs/resources/user#user-object|| +## Get User Voice State +/guilds/[\{guild.id\}](/docs/resources/guild#guild-object)/voice-states/[\{user.id\}](/docs/resources/user#user-object) Returns the specified user's [voice state](/docs/resources/voice#voice-state-object) in the guild. -## Modify Current User Voice State % PATCH /guilds/||FIXME||guild.id||/docs/resources/guild#guild-object||/voice-states/@me +## Modify Current User Voice State +/guilds/[\{guild.id\}](/docs/resources/guild#guild-object)/voice-states/@me Updates the current user's voice state. Returns `204 No Content` on success. Fires a [Voice State Update](/docs/events/gateway-events#voice-state-update) Gateway event. @@ -88,7 +92,8 @@ There are currently several caveats for this endpoint: - You must have the `REQUEST_TO_SPEAK` permission to request to speak. You can always clear your own request to speak. - You are able to set `request_to_speak_timestamp` to any present or future time. -## Modify User Voice State % PATCH /guilds/||FIXME||guild.id||/docs/resources/guild#guild-object||/voice-states/||FIXME||user.id||/docs/resources/user#user-object|| +## Modify User Voice State +/guilds/[\{guild.id\}](/docs/resources/guild#guild-object)/voice-states/[\{user.id\}](/docs/resources/user#user-object) Updates another user's voice state. Fires a [Voice State Update](/docs/events/gateway-events#voice-state-update) Gateway event. diff --git a/docs/resources/webhook.md b/docs/resources/webhook.mdx similarity index 90% rename from docs/resources/webhook.md rename to docs/resources/webhook.mdx index a232a99d0b..ef15e5c4c9 100644 --- a/docs/resources/webhook.md +++ b/docs/resources/webhook.mdx @@ -109,7 +109,8 @@ These types don't include [webhook events](/docs/events/webhook-events), which a } ``` -## Create Webhook % POST /channels/||FIXME||channel.id||/docs/resources/channel#channel-object||/webhooks +## Create Webhook +/channels/[\{channel.id\}](/docs/resources/channel#channel-object)/webhooks Creates a new webhook and returns a [webhook](/docs/resources/webhook#webhook-object) object on success. Requires the `MANAGE_WEBHOOKS` permission. Fires a [Webhooks Update](/docs/events/gateway-events#webhooks-update) Gateway event. @@ -129,26 +130,31 @@ This endpoint supports the `X-Audit-Log-Reason` header. | name | string | name of the webhook (1-80 characters) | | avatar? | ?[image data](/docs/reference#image-data) | image for the default webhook avatar | -## Get Channel Webhooks % GET /channels/||FIXME||channel.id||/docs/resources/channel#channel-object||/webhooks +## Get Channel Webhooks +/channels/[\{channel.id\}](/docs/resources/channel#channel-object)/webhooks Returns a list of channel [webhook](/docs/resources/webhook#webhook-object) objects. Requires the `MANAGE_WEBHOOKS` permission. -## Get Guild Webhooks % GET /guilds/||FIXME||guild.id||/docs/resources/guild#guild-object||/webhooks +## Get Guild Webhooks +/guilds/[\{guild.id\}](/docs/resources/guild#guild-object)/webhooks Returns a list of guild [webhook](/docs/resources/webhook#webhook-object) objects. Requires the `MANAGE_WEBHOOKS` permission. -## Get Webhook % GET /webhooks/||FIXME||webhook.id||/docs/resources/webhook#webhook-object|| +## Get Webhook +/webhooks/[\{webhook.id\}](/docs/resources/webhook#webhook-object) Returns the new [webhook](/docs/resources/webhook#webhook-object) object for the given id. This request requires the `MANAGE_WEBHOOKS` permission unless the application making the request owns the webhook. [(see: webhook.application_id)](/docs/resources/webhook#webhook-object) -## Get Webhook with Token % GET /webhooks/||FIXME||webhook.id||/docs/resources/webhook#webhook-object||/||FIXME||webhook.token||/docs/resources/webhook#webhook-object|| +## Get Webhook with Token +/webhooks/[\{webhook.id\}](/docs/resources/webhook#webhook-object)/[\{webhook.token\}](/docs/resources/webhook#webhook-object) Same as above, except this call does not require authentication and returns no user in the webhook object. -## Modify Webhook % PATCH /webhooks/||FIXME||webhook.id||/docs/resources/webhook#webhook-object|| +## Modify Webhook +/webhooks/[\{webhook.id\}](/docs/resources/webhook#webhook-object) Modify a webhook. Requires the `MANAGE_WEBHOOKS` permission. Returns the updated [webhook](/docs/resources/webhook#webhook-object) object on success. Fires a [Webhooks Update](/docs/events/gateway-events#webhooks-update) Gateway event. @@ -168,11 +174,13 @@ This endpoint supports the `X-Audit-Log-Reason` header. | avatar | ?[image data](/docs/reference#image-data) | image for the default webhook avatar | | channel_id | snowflake | the new channel id this webhook should be moved to | -## Modify Webhook with Token % PATCH /webhooks/||FIXME||webhook.id||/docs/resources/webhook#webhook-object||/||FIXME||webhook.token||/docs/resources/webhook#webhook-object|| +## Modify Webhook with Token +/webhooks/[\{webhook.id\}](/docs/resources/webhook#webhook-object)/[\{webhook.token\}](/docs/resources/webhook#webhook-object) Same as above, except this call does not require authentication, does not accept a `channel_id` parameter in the body, and does not return a user in the webhook object. -## Delete Webhook % DELETE /webhooks/||FIXME||webhook.id||/docs/resources/webhook#webhook-object|| +## Delete Webhook +/webhooks/[\{webhook.id\}](/docs/resources/webhook#webhook-object) Delete a webhook permanently. Requires the `MANAGE_WEBHOOKS` permission. Returns a `204 No Content` response on success. Fires a [Webhooks Update](/docs/events/gateway-events#webhooks-update) Gateway event. @@ -180,11 +188,13 @@ Delete a webhook permanently. Requires the `MANAGE_WEBHOOKS` permission. Returns This endpoint supports the `X-Audit-Log-Reason` header. ::: -## Delete Webhook with Token % DELETE /webhooks/||FIXME||webhook.id||/docs/resources/webhook#webhook-object||/||FIXME||webhook.token||/docs/resources/webhook#webhook-object|| +## Delete Webhook with Token +/webhooks/[\{webhook.id\}](/docs/resources/webhook#webhook-object)/[\{webhook.token\}](/docs/resources/webhook#webhook-object) Same as above, except this call does not require authentication. -## Execute Webhook % POST /webhooks/||FIXME||webhook.id||/docs/resources/webhook#webhook-object||/||FIXME||webhook.token||/docs/resources/webhook#webhook-object|| +## Execute Webhook +/webhooks/[\{webhook.id\}](/docs/resources/webhook#webhook-object)/[\{webhook.token\}](/docs/resources/webhook#webhook-object) Refer to [Uploading Files](/docs/reference#uploading-files) for details on attachments and `multipart/form-data` requests. Returns a message or `204 No Content` depending on the `wait` query parameter. @@ -235,7 +245,8 @@ Discord may strip certain characters from message content, like invalid unicode For the webhook embed objects, you can set every field except `type` (it will be `rich` regardless of if you try to set it), `provider`, `video`, and any `height`, `width`, or `proxy_url` values for images. ::: -## Execute Slack-Compatible Webhook % POST /webhooks/||FIXME||webhook.id||/docs/resources/webhook#webhook-object||/||FIXME||webhook.token||/docs/resources/webhook#webhook-object||/slack +## Execute Slack-Compatible Webhook +/webhooks/[\{webhook.id\}](/docs/resources/webhook#webhook-object)/[\{webhook.token\}](/docs/resources/webhook#webhook-object)/slack Refer to [Slack's documentation](https://api.slack.com/incoming-webhooks) for more information. We do not support Slack's `channel`, `icon_emoji`, `mrkdwn`, or `mrkdwn_in` properties. @@ -246,7 +257,8 @@ Refer to [Slack's documentation](https://api.slack.com/incoming-webhooks) for mo | thread_id | snowflake | id of the thread to send the message in | false | | wait | [boolean](/docs/reference#boolean-query-strings) | waits for server confirmation of message send before response (defaults to `true`; when `false` a message that is not saved does not return an error) | false | -## Execute GitHub-Compatible Webhook % POST /webhooks/||FIXME||webhook.id||/docs/resources/webhook#webhook-object||/||FIXME||webhook.token||/docs/resources/webhook#webhook-object||/github +## Execute GitHub-Compatible Webhook +/webhooks/[\{webhook.id\}](/docs/resources/webhook#webhook-object)/[\{webhook.token\}](/docs/resources/webhook#webhook-object)/github [Add a new webhook](https://support.discord.com/hc/en-us/articles/228383668) to your GitHub repo (in the repo's settings), and use this endpoint as the "Payload URL." You can choose what events your Discord channel receives by choosing the "Let me select individual events" option and selecting individual events for the new webhook you're configuring. The supported [events](https://docs.github.com/en/webhooks/webhook-events-and-payloads) are `commit_comment`, `create`, `delete`, `fork`, `issue_comment`, `issues`, `member`, `public`, `pull_request`, `pull_request_review`, `pull_request_review_comment`, `push`, `release`, `watch`, `check_run`, `check_suite`, `discussion`, and `discussion_comment`. @@ -257,7 +269,8 @@ Refer to [Slack's documentation](https://api.slack.com/incoming-webhooks) for mo | thread_id | snowflake | id of the thread to send the message in | false | | wait | [boolean](/docs/reference#boolean-query-strings) | waits for server confirmation of message send before response (defaults to `true`; when `false` a message that is not saved does not return an error) | false | -## Get Webhook Message % GET /webhooks/||FIXME||webhook.id||/docs/resources/webhook#webhook-object||/||FIXME||webhook.token||/docs/resources/webhook#webhook-object||/messages/||FIXME||message.id||/docs/resources/message#message-object|| +## Get Webhook Message +/webhooks/[\{webhook.id\}](/docs/resources/webhook#webhook-object)/[\{webhook.token\}](/docs/resources/webhook#webhook-object)/messages/[\{message.id\}](/docs/resources/message#message-object) Returns a previously-sent webhook message from the same token. Returns a [message](/docs/resources/message#message-object) object on success. @@ -267,7 +280,8 @@ Returns a previously-sent webhook message from the same token. Returns a [messag |-----------|-----------|------------------------------------|----------| | thread_id | snowflake | id of the thread the message is in | false | -## Edit Webhook Message % PATCH /webhooks/||FIXME||webhook.id||/docs/resources/webhook#webhook-object||/||FIXME||webhook.token||/docs/resources/webhook#webhook-object||/messages/||FIXME||message.id||/docs/resources/message#message-object|| +## Edit Webhook Message +/webhooks/[\{webhook.id\}](/docs/resources/webhook#webhook-object)/[\{webhook.token\}](/docs/resources/webhook#webhook-object)/messages/[\{message.id\}](/docs/resources/message#message-object) Edits a previously-sent webhook message from the same token. Returns a [message](/docs/resources/message#message-object) object on success. @@ -310,7 +324,8 @@ All parameters to this endpoint are optional and nullable. \*\*\* Polls can only be added when editing a deferred interaction response. -## Delete Webhook Message % DELETE /webhooks/||FIXME||webhook.id||/docs/resources/webhook#webhook-object||/||FIXME||webhook.token||/docs/resources/webhook#webhook-object||/messages/||FIXME||message.id||/docs/resources/message#message-object|| +## Delete Webhook Message +/webhooks/[\{webhook.id\}](/docs/resources/webhook#webhook-object)/[\{webhook.token\}](/docs/resources/webhook#webhook-object)/messages/[\{message.id\}](/docs/resources/message#message-object) Deletes a message that was created by the webhook. Returns a `204 No Content` response on success. diff --git a/docs/topics/oauth2.md b/docs/topics/oauth2.mdx similarity index 99% rename from docs/topics/oauth2.md rename to docs/topics/oauth2.mdx index c402a4cd12..c3a235deba 100644 --- a/docs/topics/oauth2.md +++ b/docs/topics/oauth2.mdx @@ -416,11 +416,13 @@ From this object, you should store the `webhook.token` and `webhook.id`. See the Any user that wishes to add your webhook to their channel will need to go through the full OAuth2 flow. A new webhook is created each time, so you will need to save the token and id. If you wish to send a message to all your webhooks, you'll need to iterate over each stored id:token combination and make `POST` requests to each one. Be mindful of our [Rate Limits](/docs/topics/rate-limits#rate-limits)! -## Get Current Bot Application Information % GET /oauth2/applications/@me +## Get Current Bot Application Information +/oauth2/applications/@me Returns the bot's [application](/docs/resources/application#application-object) object. -## Get Current Authorization Information % GET /oauth2/@me +## Get Current Authorization Information +/oauth2/@me Returns info about the current authorization. Requires authentication with a bearer token. From fc872be74642037db5c97bd29b1ecbf2fdd22f61 Mon Sep 17 00:00:00 2001 From: GeniusTimo Date: Tue, 22 Apr 2025 19:01:49 +0200 Subject: [PATCH 12/20] Reverted "Updated Help Center links to improve maintainability" This reverts commit 65ed3d2bc401d10317a876d285d34a85ca2345af. --- docs/activities/development-guides.mdx | 4 +- ...2-05-enhancement-new-message-properties.md | 2 +- ...d-info-around-nitro-boosting-experiment.md | 2 +- docs/change-log/2022-02-14-api-v10.md | 2 +- ...-message-content-is-a-privileged-intent.md | 2 +- .../2022-09-14-forum-channels-release.md | 2 +- .../2023-05-03-unique-usernames-on-discord.md | 4 +- ...ser-installed-apps-general-availability.md | 2 +- ...4-09-26-activities-general-availability.md | 2 +- ...-15-deprecating-guild-createion-by-apps.md | 2 +- docs/developer-tools/game-sdk.mdx | 2 +- .../design-guidelines/signing-in.mdx | 2 +- .../account-linking-with-discord.mdx | 2 +- .../managing-game-invites.mdx | 4 +- docs/discovery/best-practices.md | 6 +-- docs/discovery/enabling-discovery.mdx | 4 +- docs/events/gateway-events.mdx | 32 ++++++------ docs/events/gateway.mdx | 4 +- docs/interactions/application-commands.mdx | 4 +- docs/intro.mdx | 2 +- docs/monetization/enabling-monetization.mdx | 6 +-- docs/quick-start/getting-started.mdx | 4 +- docs/reference.mdx | 2 +- docs/resources/channel.mdx | 4 +- docs/resources/guild.mdx | 52 +++++++++---------- docs/resources/subscription.mdx | 2 +- docs/resources/user.mdx | 4 +- docs/resources/webhook.mdx | 2 +- docs/topics/oauth2.mdx | 2 +- docs/topics/teams.md | 2 +- docs/topics/threads.md | 2 +- .../upgrading-to-application-commands.md | 6 +-- 32 files changed, 87 insertions(+), 87 deletions(-) diff --git a/docs/activities/development-guides.mdx b/docs/activities/development-guides.mdx index 6abdf048be..a36a228d3e 100644 --- a/docs/activities/development-guides.mdx +++ b/docs/activities/development-guides.mdx @@ -267,7 +267,7 @@ By default, the SDK will send any console `log`, `warn`, `error`, `info`, and `d #### Viewing Logs on Desktop -Desktop logs are viewable through the console tab inside a browser's Developer Tools. See the [Troubleshooting Console Log Errors](https://support.discord.com/hc/en-us/articles/115001239472) support article for more information. +Desktop logs are viewable through the console tab inside a browser's Developer Tools. See the [Troubleshooting Console Log Errors](https://support.discord.com/hc/en-us/articles/115001239472-Troubleshooting-Console-Log-Errors) support article for more information. The Public Test Build (PTB) Discord client also allows inspecting your logs from the `View -> Developer -> Toggle Developer Tools` menu. It can be downloaded at [https://discord.com/downloads](https://discord.com/downloads). @@ -442,7 +442,7 @@ User Experience ### Setting Up an Entry Point Command -An [Entry Point command](/docs/interactions/application-commands#entry-point-commands) is required for users to be able to launch your Activity from the [App Launcher menu](https://support-apps.discord.com/hc/en-us/articles/26593412574359#h_01J8JFFXHTHT2XP9C1NYPSZR0T) in Discord. +An [Entry Point command](/docs/interactions/application-commands#entry-point-commands) is required for users to be able to launch your Activity from the [App Launcher menu](https://support.discord.com/hc/articles/21334461140375-Using-Apps-on-Discord#h_01HRQSA6C8TRHS722P1H3HW1TV) in Discord. When you enable Activities in your [app's settings](https://discord.com/developers/applications), a [default Entry Point command](/docs/interactions/application-commands#default-entry-point-command) is automatically created for your app. The default Entry Point command will use the `DISCORD_LAUNCH_ACTIVITY` (`2`) [handler type](/docs/interactions/application-commands#application-command-object-entry-point-command-handler-types), which means that Discord automatically launches your Activity for the user and posts a follow-up message into the channel where it was launched from. diff --git a/docs/change-log/2018-02-05-enhancement-new-message-properties.md b/docs/change-log/2018-02-05-enhancement-new-message-properties.md index 873798515e..07b2deed88 100644 --- a/docs/change-log/2018-02-05-enhancement-new-message-properties.md +++ b/docs/change-log/2018-02-05-enhancement-new-message-properties.md @@ -3,4 +3,4 @@ title: "Enhancement: New Message Properties" date: "2018-02-05" --- -Additional `activity` and `application` fields—as well as corresponding object documentation—have been added to the [Message](/docs/resources/message#message-object) object in support of our newly-released [Spotify integration](https://support.discord.com/hc/en-us/articles/360000167212) and previous Rich Presence enhancements. +Additional `activity` and `application` fields—as well as corresponding object documentation—have been added to the [Message](/docs/resources/message#message-object) object in support of our newly-released [Spotify integration](https://support.discord.com/hc/en-us/articles/360000167212-Discord-Spotify-Connection) and previous Rich Presence enhancements. diff --git a/docs/change-log/2019-05-29-added-info-around-nitro-boosting-experiment.md b/docs/change-log/2019-05-29-added-info-around-nitro-boosting-experiment.md index 2102a0cd42..07fe17274a 100644 --- a/docs/change-log/2019-05-29-added-info-around-nitro-boosting-experiment.md +++ b/docs/change-log/2019-05-29-added-info-around-nitro-boosting-experiment.md @@ -3,4 +3,4 @@ title: "Added Info Around Nitro Boosting Experiment" date: "2019-05-29" --- -Additional information has been documented to support [Server Nitro Boosting](https://support.discord.com/hc/en-us/articles/360028038352). This includes the addition of a few [message types](/docs/resources/message#message-object-message-types), as well as some [new fields on guilds](/docs/resources/guild#guild-object-premium-tier). Please note that this feature is currently under experimentation, and these fields may be subject to change. +Additional information has been documented to support [Server Nitro Boosting](https://support.discord.com/hc/en-us/articles/360028038352-Server-Boosting). This includes the addition of a few [message types](/docs/resources/message#message-object-message-types), as well as some [new fields on guilds](/docs/resources/guild#guild-object-premium-tier). Please note that this feature is currently under experimentation, and these fields may be subject to change. diff --git a/docs/change-log/2022-02-14-api-v10.md b/docs/change-log/2022-02-14-api-v10.md index 649ffbf1c7..cb647a2452 100644 --- a/docs/change-log/2022-02-14-api-v10.md +++ b/docs/change-log/2022-02-14-api-v10.md @@ -16,5 +16,5 @@ date: "2022-02-14" #### Upcoming changes * API v6 and v7 will be decommissioned **in early 2023** -* `MESSAGE_CONTENT` is becoming a privileged intent for verified bots in 75+ servers **on August 31, 2022**. Read details in [the FAQ](https://support-dev.discord.com/hc/en-us/articles/4404772028055) or follow [the guide](/docs/tutorials/upgrading-to-application-commands) on updating your app. +* `MESSAGE_CONTENT` is becoming a privileged intent for verified bots in 75+ servers **on August 31, 2022**. Read details in [the FAQ](https://support-dev.discord.com/hc/en-us/articles/4404772028055-Message-Content-Privileged-Intent-FAQ) or follow [the guide](/docs/tutorials/upgrading-to-application-commands) on updating your app. * The `summary` field for applications will be removed in the next API version (v11) diff --git a/docs/change-log/2022-09-01-message-content-is-a-privileged-intent.md b/docs/change-log/2022-09-01-message-content-is-a-privileged-intent.md index 3bac1a5d14..871f445f18 100644 --- a/docs/change-log/2022-09-01-message-content-is-a-privileged-intent.md +++ b/docs/change-log/2022-09-01-message-content-is-a-privileged-intent.md @@ -4,7 +4,7 @@ date: "2022-09-01" breaking: true --- -As of today, [message content](/docs/events/gateway#message-content-intent) is a privileged intent for all verified apps *and* apps eligible for verification. More details about why it's becoming a privileged intent and how to apply for it is in the [Help Center FAQ](https://support-dev.discord.com/hc/en-us/articles/4404772028055). +As of today, [message content](/docs/events/gateway#message-content-intent) is a privileged intent for all verified apps *and* apps eligible for verification. More details about why it's becoming a privileged intent and how to apply for it is in the [Help Center FAQ](https://support-dev.discord.com/hc/articles/4404772028055-Message-Content-Privileged-Intent-FAQ). Any app that does not have the message content intent configured in its app's settings within the Developer Portal will receive empty values in fields that expose message content across Discord's APIs (including the `content`, `embeds`, `attachments`, and `components` fields). These restrictions do not apply for messages that a bot or app sends, in DMs that it receives, or in messages in which it is mentioned. diff --git a/docs/change-log/2022-09-14-forum-channels-release.md b/docs/change-log/2022-09-14-forum-channels-release.md index 934c0135c6..c94ee3f568 100644 --- a/docs/change-log/2022-09-14-forum-channels-release.md +++ b/docs/change-log/2022-09-14-forum-channels-release.md @@ -5,4 +5,4 @@ date: "2022-09-14" Forum channels ([`GUILD_FORUM` or `15`](/docs/resources/channel#channel-object-channel-types)) have been released to all community servers. `GUILD_FORUM` channels are a new channel type that only supports threads, which display differently than in text (`GUILD_TEXT`) channels. -Check out the [forums topic](/docs/topics/threads#forums) for more information on the relevant APIs and technical details, and the [Forums FAQ](https://support.discord.com/hc/en-us/articles/6208479917079#h_01JAZAWCX4DXYK26BKT49DXMAQ) for more about the feature. +Check out the [forums topic](/docs/topics/threads#forums) for more information on the relevant APIs and technical details, and the [Forums FAQ](https://support.discord.com/hc/en-us/articles/6208479917079-Forum-Channels-FAQ#h_01G69FJQWTWN88HFEHK7Z6X79N) for more about the feature. diff --git a/docs/change-log/2023-05-03-unique-usernames-on-discord.md b/docs/change-log/2023-05-03-unique-usernames-on-discord.md index 7a2f0aad7a..38b52d6761 100644 --- a/docs/change-log/2023-05-03-unique-usernames-on-discord.md +++ b/docs/change-log/2023-05-03-unique-usernames-on-discord.md @@ -4,10 +4,10 @@ date: "2023-05-03" --- :::warn -Bot users will stay on the legacy username system for now. More details can be found on the [Developer Help Center article](https://support-dev.discord.com/hc/en-us/articles/13667755828631). +Bot users will stay on the legacy username system for now. More details can be found on the [Developer Help Center article](https://dis.gd/app-usernames). ::: -Discord’s username system is changing. Discriminators are being removed and new, unique usernames and display names are being introduced. You can read more details about how changes to the username system affects non-bot users in the [general Help Center article](https://support.discord.com/hc/en-us/articles/12620128861463). To learn how it impacts bot users specifically, you can read the [Developer Help Center article](https://support-dev.discord.com/hc/en-us/articles/13667755828631). +Discord’s username system is changing. Discriminators are being removed and new, unique usernames and display names are being introduced. You can read more details about how changes to the username system affects non-bot users in the [general Help Center article](https://dis.gd/usernames). To learn how it impacts bot users specifically, you can read the [Developer Help Center article](https://dis.gd/app-usernames). This changelog focuses only on the technical changes to be aware of to update your app's code. diff --git a/docs/change-log/2024-06-27-user-installed-apps-general-availability.md b/docs/change-log/2024-06-27-user-installed-apps-general-availability.md index b122b6925d..86923c9485 100644 --- a/docs/change-log/2024-06-27-user-installed-apps-general-availability.md +++ b/docs/change-log/2024-06-27-user-installed-apps-general-availability.md @@ -21,7 +21,7 @@ With this update, there are a few API and behavioral updates for user-installed A new [`USE_EXTERNAL_APPS` (`1 << 50`) permission](/docs/topics/permissions#permissions-bitwise-permission-flags) was added, and is enabled for servers by default. The new permission lets modmins control whether user-installed apps can post public replies in a server. If `Use External Apps` is disabled and your app is *not* installed to the server, your app’s responses will be ephemeral for the end user. -Read more in the [Moderating Apps on Discord Help Center article](https://support-apps.discord.com/hc/en-us/articles/26501864012951#h_01HZQQQEADYVN2CM4AX4EZGKHM). +Read more in the [Moderating Apps on Discord Help Center article](https://support.discord.com/hc/en-us/articles/23957313048343-Moderating-Apps-on-Discord#h_01HZQQQEADYVN2CM4AX4EZGKHM). ###### Updated Defaults for New Apps diff --git a/docs/change-log/2024-09-26-activities-general-availability.md b/docs/change-log/2024-09-26-activities-general-availability.md index 73caefc1ab..b74444e6ad 100644 --- a/docs/change-log/2024-09-26-activities-general-availability.md +++ b/docs/change-log/2024-09-26-activities-general-availability.md @@ -7,7 +7,7 @@ topics: - "Premium Apps" --- -Following up on [the rollout of the App Launcher](https://discord.com/blog/discover-more-ways-to-play-with-apps-now-anywhere-on-discord), we’re excited to announce that [Activities](/docs/activities/overview) are now generally available for developers. In addition to API stability, this means that apps with Activities can now be [verified](https://support-dev.discord.com/hc/en-us/articles/23926564536471), [discoverable](/docs/discovery/enabling-discovery) in the App Directory, and [implement monetization](/docs/monetization/overview). +Following up on [the rollout of the App Launcher](https://discord.com/blog/discover-more-ways-to-play-with-apps-now-anywhere-on-discord), we’re excited to announce that [Activities](/docs/activities/overview) are now generally available for developers. In addition to API stability, this means that apps with Activities can now be [verified](https://support-dev.discord.com/hc/en-us/articles/23926564536471-How-Do-I-Get-My-App-Verified), [discoverable](/docs/discovery/enabling-discovery) in the App Directory, and [implement monetization](/docs/monetization/overview). ### Recent API Updates diff --git a/docs/change-log/2025-04-15-deprecating-guild-createion-by-apps.md b/docs/change-log/2025-04-15-deprecating-guild-createion-by-apps.md index 18ce33b7f1..1203567e8c 100644 --- a/docs/change-log/2025-04-15-deprecating-guild-createion-by-apps.md +++ b/docs/change-log/2025-04-15-deprecating-guild-createion-by-apps.md @@ -26,4 +26,4 @@ If your app is affected, you will receive a migration plan via Discord System DM We understand this change may affect some legitimate use cases. If you have questions or believe your application requires continued access to guild creation functionality, please contact us through -the [Developer Support portal](https://support-dev.discord.com/hc/en-us). \ No newline at end of file +the [Developer Support portal](https://support-dev.discord.com/hc). \ No newline at end of file diff --git a/docs/developer-tools/game-sdk.mdx b/docs/developer-tools/game-sdk.mdx index 888821ff45..f3baab355d 100644 --- a/docs/developer-tools/game-sdk.mdx +++ b/docs/developer-tools/game-sdk.mdx @@ -1148,7 +1148,7 @@ activityManager.UpdateActivity(activity, (result) => ## Overlay :::warn -The overlay is only supported on Windows for DirectX or OpenGL games. Linux, Mac, and games using Vulkan are not supported. [Click here for more info.](https://support.discord.com/hc/en-us/articles/217659737) +The overlay is only supported on Windows for DirectX or OpenGL games. Linux, Mac, and games using Vulkan are not supported. [Click here for more info.](https://support.discord.com/hc/en-us/articles/217659737-Games-Overlay-101) ::: Discord comes with an awesome built-in overlay, and you may want to make use of it for your game. This manager will help you do just that! It gives you the current state of the overlay for the user, and allows you to update that state. diff --git a/docs/discord-social-sdk/design-guidelines/signing-in.mdx b/docs/discord-social-sdk/design-guidelines/signing-in.mdx index a4279420a0..85aa80dc31 100644 --- a/docs/discord-social-sdk/design-guidelines/signing-in.mdx +++ b/docs/discord-social-sdk/design-guidelines/signing-in.mdx @@ -30,7 +30,7 @@ A player can also proceed **without** connecting their Discord and continue onwa ## Overlay Authorization -Discord's [Overlay](https://support.discord.com/hc/en-us/articles/217659737) feature can be used to enable authorization without ever leaving the game. This is available for games who support the feature. +Discord's [Overlay](https://support.discord.com/hc/en-us/articles/217659737-Game-Overlay-101) feature can be used to enable authorization without ever leaving the game. This is available for games who support the feature. ![Overlay Authorization](images/social-sdk/design-guidelines/SigningIn-05.png) diff --git a/docs/discord-social-sdk/development-guides/account-linking-with-discord.mdx b/docs/discord-social-sdk/development-guides/account-linking-with-discord.mdx index 7110bed47b..d1c2307c18 100644 --- a/docs/discord-social-sdk/development-guides/account-linking-with-discord.mdx +++ b/docs/discord-social-sdk/development-guides/account-linking-with-discord.mdx @@ -45,7 +45,7 @@ OAuth2 is the standard authentication flow that allows users to sign in using th ### OAuth2 using the Discord Social SDK -- If the Discord client has [overlay support](https://support.discord.com/hc/en-us/articles/217659737) (Windows only), the OAuth2 login modal appears in your game instead of opening a browser. +- If the Discord client has [overlay support](https://support.discord.com/hc/en-us/articles/217659737-Game-Overlay-101) (Windows only), the OAuth2 login modal appears in your game instead of opening a browser. - The SDK automatically handles redirects, simplifying the authentication flow. - Some security measures, such as CSRF protection, are built-in, but you should always follow best practices to secure your app. diff --git a/docs/discord-social-sdk/development-guides/managing-game-invites.mdx b/docs/discord-social-sdk/development-guides/managing-game-invites.mdx index 111c04e920..ce143d5fa1 100644 --- a/docs/discord-social-sdk/development-guides/managing-game-invites.mdx +++ b/docs/discord-social-sdk/development-guides/managing-game-invites.mdx @@ -185,7 +185,7 @@ Game invites can be sent in two ways: ### Sending Game Invites in the Discord Client -Users can send game invites directly through the Discord client. This feature is described in detail in the [Game Invites help center article](https://support.discord.com/hc/en-us/articles/115001557452). +Users can send game invites directly through the Discord client. This feature is described in detail in the [Game Invites help center article](https://support.discord.com/hc/en-us/articles/115001557452-Game-Invites). ### Sending Game Invites in the SDK @@ -210,7 +210,7 @@ Game invites can also be received in two ways: ### Receiving Game Invites in the Discord Client -Users can receive game invites directly in their DMs. This feature is described in detail in the [Game Invites help center article](https://support.discord.com/hc/en-us/articles/115001557452). +Users can receive game invites directly in their DMs. This feature is described in detail in the [Game Invites help center article](https://support.discord.com/hc/en-us/articles/115001557452-Game-Invites). ### Receiving Game Invites in the SDK diff --git a/docs/discovery/best-practices.md b/docs/discovery/best-practices.md index 515bfe04af..460006b834 100644 --- a/docs/discovery/best-practices.md +++ b/docs/discovery/best-practices.md @@ -79,7 +79,7 @@ Think of up to five words that describe your app and add them as tags (see image Your app’s support server is a paramount part of your App Product Page. It’s important to ensure your app has a dedicated server and channel for communication between your app’s users and its developers and maintainers. :::info -If your support server isn't [discoverable](https://support.discord.com/hc/en-us/articles/360030843331), be sure to include an invite link in the "links" section of your App Directory Product Page. +If your support server isn't [discoverable](https://support.discord.com/hc/en-us/articles/360030843331-Enabling-Server-Discovery), be sure to include an invite link in the "links" section of your App Directory Product Page. ::: Some ways you can successfully use your support server includes: @@ -94,8 +94,8 @@ For general best practices on how to run a server, check out our [Community page ### Final checks to make sure you’re ready to go -Before you can click the final “Enable Discovery” button, ensure that your App Directory Product Page complies with the rest of Discord’s Directory eligibility criteria, [app content requirements](https://support-dev.discord.com/hc/en-us/articles/9489299950487) and Developer [Terms of Service](https://dis.gd/discord-developer-terms-of-service) and [Policy](https://dis.gd/discord-developer-policy). +Before you can click the final “Enable Discovery” button, ensure that your App Directory Product Page complies with the rest of Discord’s Directory eligibility criteria, [app content requirements](https://support-dev.discord.com/hc/en-us/articles/9489299950487-App-Directory-App-Content-Requirements-Policy) and Developer [Terms of Service](https://dis.gd/discord-developer-terms-of-service) and [Policy](https://dis.gd/discord-developer-policy). -For more details about what this information entails, read our [Help Center article on Profile Pages](https://support-dev.discord.com/hc/en-us/articles/6378525413143). +For more details about what this information entails, read our [Help Center article on Profile Pages](https://support-dev.discord.com/hc/en-us/articles/6378525413143-App-Directory-App-profile-pages). Now you're ready to publish your new App Directory profile and watch your app grow! If you haven’t already, join our official [Discord Developers server](https://discord.gg/discord-developers) to receive more information on how to update your apps. Way to go, Discord Developer! diff --git a/docs/discovery/enabling-discovery.mdx b/docs/discovery/enabling-discovery.mdx index 31e83846fa..9681525a67 100644 --- a/docs/discovery/enabling-discovery.mdx +++ b/docs/discovery/enabling-discovery.mdx @@ -18,7 +18,7 @@ To see the list of requirements for **App Verification**: 3. Complete the listed App Verification qualification criteria for your app. 4. Once you've completed the requirements, you can submit your app for verification. -For more information on **App Verification**, check out our [Help Center article](https://support-dev.discord.com/hc/en-us/articles/23926564536471). +For more information on **App Verification**, check out our [Help Center article](https://support-dev.discord.com/hc/en-us/articles/23926564536471-How-Do-I-Get-My-App-Verified). ## Step 2: Opt into Discovery @@ -32,7 +32,7 @@ To opt into **Discovery**: 4. Add your app metadata and images under the `Discovery -> Discovery Settings` menu to customize your app's appearance in discovery surfaces. 4. Once you've completed the requirements, you can enable **Discovery** for your app. -For more information on **Discovery**, check out our [Help Center article](https://support-dev.discord.com/hc/en-us/articles/21204493235991). +For more information on **Discovery**, check out our [Help Center article](https://support-dev.discord.com/hc/en-us/articles/21204493235991-How-Can-Users-Discover-and-Play-My-Activity). :::info Once you enable **Discovery**, it may take up to 24 hours for your app to appear in the App Directory and App Launcher. diff --git a/docs/events/gateway-events.mdx b/docs/events/gateway-events.mdx index 1f304fd325..5b4c2cf899 100644 --- a/docs/events/gateway-events.mdx +++ b/docs/events/gateway-events.mdx @@ -770,22 +770,22 @@ Sent when a guild member is updated. This will also fire when the user object of ###### Guild Member Update Event Fields -| Field | Type | Description | -|-------------------------------|-------------------------------------------------------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| guild_id | snowflake | ID of the guild | -| roles | array of snowflakes | User role ids | -| user | a [user](/docs/resources/user#user-object) object | User | -| nick? | ?string | Nickname of the user in the guild | -| avatar | ?string | Member's [guild avatar hash](/docs/reference#image-formatting) | -| banner | ?string | Member's [guild banner hash](/docs/reference#image-formatting) | -| joined_at | ?ISO8601 timestamp | When the user joined the guild | -| premium_since? | ?ISO8601 timestamp | When the user starting [boosting](https://support.discord.com/hc/en-us/articles/360028038352) the guild | -| deaf? | boolean | Whether the user is deafened in voice channels | -| mute? | boolean | Whether the user is muted in voice channels | -| pending? | boolean | Whether the user has not yet passed the guild's [Membership Screening](/docs/resources/guild#membership-screening-object) requirements | -| communication_disabled_until? | ?ISO8601 timestamp | When the user's [timeout](https://support.discord.com/hc/en-us/articles/4413305239191) will expire and the user will be able to communicate in the guild again, null or a time in the past if the user is not timed out | -| flags? | integer | [Guild member flags](/docs/resources/guild#guild-member-object-guild-member-flags) represented as a bit set, defaults to 0 | -| avatar_decoration_data? | ?[avatar decoration data](/docs/resources/user#avatar-decoration-data-object) | Data for the member's guild avatar decoration | +| Field | Type | Description | +|-------------------------------|-------------------------------------------------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| guild_id | snowflake | ID of the guild | +| roles | array of snowflakes | User role ids | +| user | a [user](/docs/resources/user#user-object) object | User | +| nick? | ?string | Nickname of the user in the guild | +| avatar | ?string | Member's [guild avatar hash](/docs/reference#image-formatting) | +| banner | ?string | Member's [guild banner hash](/docs/reference#image-formatting) | +| joined_at | ?ISO8601 timestamp | When the user joined the guild | +| premium_since? | ?ISO8601 timestamp | When the user starting [boosting](https://support.discord.com/hc/en-us/articles/360028038352-Server-Boosting-) the guild | +| deaf? | boolean | Whether the user is deafened in voice channels | +| mute? | boolean | Whether the user is muted in voice channels | +| pending? | boolean | Whether the user has not yet passed the guild's [Membership Screening](/docs/resources/guild#membership-screening-object) requirements | +| communication_disabled_until? | ?ISO8601 timestamp | When the user's [timeout](https://support.discord.com/hc/en-us/articles/4413305239191-Time-Out-FAQ) will expire and the user will be able to communicate in the guild again, null or a time in the past if the user is not timed out | +| flags? | integer | [Guild member flags](/docs/resources/guild#guild-member-object-guild-member-flags) represented as a bit set, defaults to 0 | +| avatar_decoration_data? | ?[avatar decoration data](/docs/resources/user#avatar-decoration-data-object) | Data for the member's guild avatar decoration | #### Guild Members Chunk diff --git a/docs/events/gateway.mdx b/docs/events/gateway.mdx index e072e81507..d74ed7c999 100644 --- a/docs/events/gateway.mdx +++ b/docs/events/gateway.mdx @@ -442,7 +442,7 @@ Some intents are defined as "privileged" due to the sensitive nature of the data Apps that qualify for verification **must** be approved for the privileged intent(s) before they can use them. After your app is verified, you can request privileged intents within the app's settings within the Developer Portal. -Before you specify privileged intents in your `IDENTIFY` payload, you must enable the privileged intents your app requires. [Verified apps](https://support-dev.discord.com/hc/en-us/articles/23926564536471) can only use privileged intents *after* they've been approved for them. +Before you specify privileged intents in your `IDENTIFY` payload, you must enable the privileged intents your app requires. [Verified apps](https://support-dev.discord.com/hc/en-us/articles/23926564536471-How-Do-I-Get-My-App-Verified) can only use privileged intents *after* they've been approved for them. :::info Unverified apps can use privileged intents without approval, but still must enable them in their app's settings. If the app's verification status changes, it will then have to apply for the privileged intent(s). @@ -454,7 +454,7 @@ In addition to the gateway restrictions described here, Discord's REST API is al Before using privileged intents, you must enable them in your app's settings. In the [Developer Portal](https://discord.com/developers/applications), you can navigate to your app's settings then toggle the privileged intents on the **Bots** page under the "Privileged Gateway Intents" section. You should only toggle privileged intents that your bot *requires to function*. -If your app qualifies for [verification](https://support-dev.discord.com/hc/en-us/articles/23926564536471), you must first [verify your app](https://support-dev.discord.com/hc/en-us/articles/23926564536471) and request access to these intents during the verification process. If your app is already verified and you need to request additional privileged intents, you can [contact support](https://dis.gd/support). +If your app qualifies for [verification](https://support-dev.discord.com/hc/en-us/articles/23926564536471-How-Do-I-Get-My-App-Verified), you must first [verify your app](https://support-dev.discord.com/hc/en-us/articles/23926564536471-How-Do-I-Get-My-App-Verified) and request access to these intents during the verification process. If your app is already verified and you need to request additional privileged intents, you can [contact support](https://dis.gd/support). #### Gateway Restrictions diff --git a/docs/interactions/application-commands.mdx b/docs/interactions/application-commands.mdx index acdf9d609f..01659699c1 100644 --- a/docs/interactions/application-commands.mdx +++ b/docs/interactions/application-commands.mdx @@ -992,7 +992,7 @@ When someone uses a message command, your application will receive an interactio ## Entry Point Commands -An Entry Point command serves as the primary way for users to open an app's [Activity](/docs/activities/overview) from the [App Launcher](https://support-apps.discord.com/hc/en-us/articles/26593412574359#h_01J8JFFXHTHT2XP9C1NYPSZR0T). +An Entry Point command serves as the primary way for users to open an app's [Activity](/docs/activities/overview) from the [App Launcher](https://support.discord.com/hc/articles/21334461140375-Using-Apps-on-Discord#h_01HRQSA6C8TRHS722P1H3HW1TV). For the Entry Point command to be visible to users, an app must have [Activities](/docs/activities/overview) enabled. ![Entry Point command in App Launcher](images/command-entry-point.png) @@ -1145,7 +1145,7 @@ Apps with [discovery enabled](https://support-dev.discord.com/hc/en-us/articles/ ### Using Age-Restricted Commands To use an age-restricted command, a user must be 18 years or older and access the command from either: -- an [age-restricted channel](https://support.discord.com/hc/en-us/articles/115000084051) or +- an [age-restricted channel](https://support.discord.com/hc/articles/115000084051-Age-Restricted-Channels-and-Content) or - a DM with the app *after* [enabling age-restricted commands](https://support.discord.com/hc/en-us/articles/10123937946007) within their User Settings. Details about accessing and using age-restricted commands is in [the Help Center](https://support.discord.com/hc/en-us/articles/10123937946007). diff --git a/docs/intro.mdx b/docs/intro.mdx index 5501c738b8..815df361e3 100644 --- a/docs/intro.mdx +++ b/docs/intro.mdx @@ -81,7 +81,7 @@ Connect with the developer community, report issues, and stay updated with API c Submit API bugs, feature requests, or contribute to the documentation. - + Find articles, FAQs, and reach out to Discord's developer support team. diff --git a/docs/monetization/enabling-monetization.mdx b/docs/monetization/enabling-monetization.mdx index f2adfdd19b..0581ec3d38 100644 --- a/docs/monetization/enabling-monetization.mdx +++ b/docs/monetization/enabling-monetization.mdx @@ -18,7 +18,7 @@ Once these are complete, you can [create SKUs](/docs/monetization/managing-skus# Before monetization can be enabled, you will need: - A [team](/docs/topics/teams) in the developer portal. If you don't have one, you can [create one on the Teams page](https://discord.com/developers/teams) -- A [verified app](https://support-dev.discord.com/hc/en-us/articles/23926564536471) that is _owned by that team_ +- A [verified app](https://support-dev.discord.com/hc/en-us/articles/23926564536471-How-Do-I-Get-My-App-Verified) that is _owned by that team_ - Your app and team must be eligible for monetization. See the Eligibility Checklist below for details. ## Step 2. Complete the Eligibility Checklist @@ -37,7 +37,7 @@ Before you can start creating SKUs and offering payments in your app, your app a - This document should clearly and accurately describe to users of your app the user data you collect and how you use and share such data with us and third parties, consistent with our Developer Terms of Service and Developer Policy. - App must not contain any harmful or bad language in the name, description, commands, or role connection metadata. - Payouts must be set up with a valid payment method -- Agreement to the [Monetization Terms](https://support.discord.com/hc/en-us/articles/5330075836311) and [Discord Developer Policy](https://dis.gd/discord-developer-policy). +- Agreement to the [Monetization Terms](https://support.discord.com/hc/articles/5330075836311) and [Discord Developer Policy](https://dis.gd/discord-developer-policy). ## Step 3. Set Up Team Payouts @@ -61,7 +61,7 @@ Let's set up Team Payouts so you can get paid! Discord processes all payouts thr Premium Apps is not currently available outside of these regions. These features will be made available to more regions soon. ::: -For more information, read the [Premium Apps Payouts](https://support-dev.discord.com/hc/en-us/articles/17299902720919) Help Center article. +For more information, read the [Premium Apps Payouts](https://support-dev.discord.com/hc/articles/17299902720919) Help Center article. ## Step 4: Create Your Premium Offering diff --git a/docs/quick-start/getting-started.mdx b/docs/quick-start/getting-started.mdx index b6278f39a1..1ebbfbc73e 100644 --- a/docs/quick-start/getting-started.mdx +++ b/docs/quick-start/getting-started.mdx @@ -124,7 +124,7 @@ On the left hand sidebar in your app's settings, there's a **Bot** page (where w Intents determine which events Discord will send your app when you're creating a [Gateway API connection](/docs/events/gateway). For example, if you want your app to perform an action when users add a reaction to a message, you can pass the `GUILD_MESSAGE_REACTIONS` (`1 << 10`) intent. -Some intents are [privileged](/docs/events/gateway#privileged-intents), meaning they allow your app to access data that may be considered sensitive (like the contents of messages). Privileged intents can be toggled on the **Bot** page in your app's settings, but they must be approved before you [verify your app](https://support-dev.discord.com/hc/en-us/articles/23926564536471). Standard, non-privileged intents don't require any additional permissions or configurations. +Some intents are [privileged](/docs/events/gateway#privileged-intents), meaning they allow your app to access data that may be considered sensitive (like the contents of messages). Privileged intents can be toggled on the **Bot** page in your app's settings, but they must be approved before you [verify your app](https://support-dev.discord.com/hc/en-us/articles/23926564536471-How-Do-I-Get-My-App-Verified). Standard, non-privileged intents don't require any additional permissions or configurations. More information about intents and a full list of available intents (along with their associated events) is in the [Gateway documentation](/docs/events/gateway#gateway-intents). @@ -178,7 +178,7 @@ See a list of all [OAuth2 scopes](/docs/topics/oauth2#shared-resources-oauth2-sc ### Installing your app :::info -When developing apps, you should build and test on your user account (for user-installable apps) and in a server that isn't actively used by others (for server-installable apps). If you don't have your own server already, you can [create one for free](https://support.discord.com/hc/en-us/articles/204849977). +When developing apps, you should build and test on your user account (for user-installable apps) and in a server that isn't actively used by others (for server-installable apps). If you don't have your own server already, you can [create one for free](https://support.discord.com/hc/en-us/articles/204849977-How-do-I-create-a-server-). ::: Once you add scopes, copy the URL from the **Install Link** section from before. diff --git a/docs/reference.mdx b/docs/reference.mdx index 8a88680d7d..502bb17e3b 100644 --- a/docs/reference.mdx +++ b/docs/reference.mdx @@ -400,7 +400,7 @@ https://cdn.discordapp.com/attachments/1012345678900020080/1234567891233211234/m ## Uploading Files :::info -The file upload size limit applies to each file in a request. The default limit is `10 MiB` for all users, but may be higher for users depending on their [Nitro](https://support.discord.com/hc/en-us/articles/115000435108) status or by the server's [Boost Tier](https://support.discord.com/hc/en-us/articles/360028038352#h_01HGX7DJ33Z5HGWCXJ6NKR2FTZ). The `attachment_size_limit` value provided [when working with interactions](/docs/interactions/receiving-and-responding#interaction-object-interaction-structure) is calculated as the maximum of these values. +The file upload size limit applies to each file in a request. The default limit is `10 MiB` for all users, but may be higher for users depending on their [Nitro](https://support.discord.com/hc/en-us/articles/115000435108-What-are-Nitro-Nitro-Basic) status or by the server's [Boost Tier](https://support.discord.com/hc/en-us/articles/360028038352-Server-Boosting-FAQ-#h_419c3bd5-addd-4989-b7cf-c7957ef92583). The `attachment_size_limit` value provided [when working with interactions](/docs/interactions/receiving-and-responding#interaction-object-interaction-structure) is calculated as the maximum of these values. ::: Some endpoints support file attachments, indicated by the `files[n]` parameter. To add file(s), the standard `application/json` body must be replaced by a `multipart/form-data` body. The JSON message body can optionally be provided using the `payload_json` parameter. diff --git a/docs/resources/channel.mdx b/docs/resources/channel.mdx index 1eb63f73f5..26037022f4 100644 --- a/docs/resources/channel.mdx +++ b/docs/resources/channel.mdx @@ -64,13 +64,13 @@ Type 10, 11 and 12 are only available in API v9 and above. | DM | 1 | a direct message between users | | GUILD_VOICE | 2 | a voice channel within a server | | GROUP_DM | 3 | a direct message between multiple users | -| GUILD_CATEGORY | 4 | an [organizational category](https://support.discord.com/hc/en-us/articles/115001580171) that contains up to 50 channels | +| GUILD_CATEGORY | 4 | an [organizational category](https://support.discord.com/hc/en-us/articles/115001580171-Channel-Categories-101) that contains up to 50 channels | | GUILD_ANNOUNCEMENT | 5 | a channel that [users can follow and crosspost into their own server](https://support.discord.com/hc/en-us/articles/360032008192) (formerly news channels) | | ANNOUNCEMENT_THREAD | 10 | a temporary sub-channel within a GUILD_ANNOUNCEMENT channel | | PUBLIC_THREAD | 11 | a temporary sub-channel within a GUILD_TEXT or GUILD_FORUM channel | | PRIVATE_THREAD | 12 | a temporary sub-channel within a GUILD_TEXT channel that is only viewable by those invited and those with the MANAGE_THREADS permission | | GUILD_STAGE_VOICE | 13 | a voice channel for [hosting events with an audience](https://support.discord.com/hc/en-us/articles/1500005513722) | -| GUILD_DIRECTORY | 14 | the channel in a [hub](https://support.discord.com/hc/en-us/articles/4406046651927) containing the listed servers | +| GUILD_DIRECTORY | 14 | the channel in a [hub](https://support.discord.com/hc/en-us/articles/4406046651927-Discord-Student-Hubs-FAQ) containing the listed servers | | GUILD_FORUM | 15 | Channel that can only contain threads | | GUILD_MEDIA | 16 | Channel that can only contain threads, similar to `GUILD_FORUM` channels | diff --git a/docs/resources/guild.mdx b/docs/resources/guild.mdx index 5b06048f54..52ee8f8e3d 100644 --- a/docs/resources/guild.mdx +++ b/docs/resources/guild.mdx @@ -351,22 +351,22 @@ The fields `id`, `discriminator` and `avatar` are anonymized to prevent abuse. ###### Guild Member Structure -| Field | Type | Description | -|-------------------------------|--------------------------------------------------------------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| user? | [user](/docs/resources/user#user-object) object | the user this guild member represents | -| nick? | ?string | this user's guild nickname | -| avatar? | ?string | the member's [guild avatar hash](/docs/reference#image-formatting) | -| banner? | ?string | the member's [guild banner hash](/docs/reference#image-formatting) | -| roles | array of snowflakes | array of [role](/docs/topics/permissions#role-object) object ids | -| joined_at | ISO8601 timestamp | when the user joined the guild | -| premium_since? | ?ISO8601 timestamp | when the user started [boosting](https://support.discord.com/hc/en-us/articles/360028038352) the guild | -| deaf | boolean | whether the user is deafened in voice channels | -| mute | boolean | whether the user is muted in voice channels | -| flags | integer | [guild member flags](/docs/resources/guild#guild-member-object-guild-member-flags) represented as a bit set, defaults to `0` | -| pending? | boolean | whether the user has not yet passed the guild's [Membership Screening](/docs/resources/guild#membership-screening-object) requirements | -| permissions? | string | total permissions of the member in the channel, including overwrites, returned when in the interaction object | -| communication_disabled_until? | ?ISO8601 timestamp | when the user's [timeout](https://support.discord.com/hc/en-us/articles/4413305239191) will expire and the user will be able to communicate in the guild again, null or a time in the past if the user is not timed out | -| avatar_decoration_data? | ?[avatar decoration data](/docs/resources/user#avatar-decoration-data-object) object | data for the member's guild avatar decoration | +| Field | Type | Description | +|-------------------------------|--------------------------------------------------------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| user? | [user](/docs/resources/user#user-object) object | the user this guild member represents | +| nick? | ?string | this user's guild nickname | +| avatar? | ?string | the member's [guild avatar hash](/docs/reference#image-formatting) | +| banner? | ?string | the member's [guild banner hash](/docs/reference#image-formatting) | +| roles | array of snowflakes | array of [role](/docs/topics/permissions#role-object) object ids | +| joined_at | ISO8601 timestamp | when the user joined the guild | +| premium_since? | ?ISO8601 timestamp | when the user started [boosting](https://support.discord.com/hc/en-us/articles/360028038352-Server-Boosting-) the guild | +| deaf | boolean | whether the user is deafened in voice channels | +| mute | boolean | whether the user is muted in voice channels | +| flags | integer | [guild member flags](/docs/resources/guild#guild-member-object-guild-member-flags) represented as a bit set, defaults to `0` | +| pending? | boolean | whether the user has not yet passed the guild's [Membership Screening](/docs/resources/guild#membership-screening-object) requirements | +| permissions? | string | total permissions of the member in the channel, including overwrites, returned when in the interaction object | +| communication_disabled_until? | ?ISO8601 timestamp | when the user's [timeout](https://support.discord.com/hc/en-us/articles/4413305239191-Time-Out-FAQ) will expire and the user will be able to communicate in the guild again, null or a time in the past if the user is not timed out | +| avatar_decoration_data? | ?[avatar decoration data](/docs/resources/user#avatar-decoration-data-object) object | data for the member's guild avatar decoration | :::info The field `user` won't be included in the member object attached to `MESSAGE_CREATE` and `MESSAGE_UPDATE` gateway events. @@ -549,7 +549,7 @@ Some older integrations may not have an attached user. ### Guild Onboarding Object -Represents the [onboarding](https://support.discord.com/hc/en-us/articles/11074987197975) flow for a guild. +Represents the [onboarding](https://support.discord.com/hc/en-us/articles/11074987197975-Community-Onboarding-FAQ) flow for a guild. ###### Guild Onboarding Structure @@ -1059,15 +1059,15 @@ This endpoint supports the `X-Audit-Log-Reason` header. ###### JSON Params -| Field | Type | Description | Permission | -|------------------------------|---------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------------------------------------------------------------------| -| nick | string | value to set user's nickname to | MANAGE_NICKNAMES | -| roles | array of snowflakes | array of role ids the member is assigned | MANAGE_ROLES | -| mute | boolean | whether the user is muted in voice channels. Will throw a 400 error if the user is not in a voice channel | MUTE_MEMBERS | -| deaf | boolean | whether the user is deafened in voice channels. Will throw a 400 error if the user is not in a voice channel | DEAFEN_MEMBERS | -| channel_id | snowflake | id of channel to move user to (if they are connected to voice) | MOVE_MEMBERS | -| communication_disabled_until | ISO8601 timestamp | when the user's [timeout](https://support.discord.com/hc/en-us/articles/4413305239191) will expire and the user will be able to communicate in the guild again (up to 28 days in the future), set to null to remove timeout. Will throw a 403 error if the user has the ADMINISTRATOR permission or is the owner of the guild | MODERATE_MEMBERS | -| flags | integer | [guild member flags](/docs/resources/guild#guild-member-object-guild-member-flags) | MANAGE_GUILD or MANAGE_ROLES or (MODERATE_MEMBERS and KICK_MEMBERS and BAN_MEMBERS) | +| Field | Type | Description | Permission | +|------------------------------|---------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------------------------------------------------------------------| +| nick | string | value to set user's nickname to | MANAGE_NICKNAMES | +| roles | array of snowflakes | array of role ids the member is assigned | MANAGE_ROLES | +| mute | boolean | whether the user is muted in voice channels. Will throw a 400 error if the user is not in a voice channel | MUTE_MEMBERS | +| deaf | boolean | whether the user is deafened in voice channels. Will throw a 400 error if the user is not in a voice channel | DEAFEN_MEMBERS | +| channel_id | snowflake | id of channel to move user to (if they are connected to voice) | MOVE_MEMBERS | +| communication_disabled_until | ISO8601 timestamp | when the user's [timeout](https://support.discord.com/hc/en-us/articles/4413305239191-Time-Out-FAQ) will expire and the user will be able to communicate in the guild again (up to 28 days in the future), set to null to remove timeout. Will throw a 403 error if the user has the ADMINISTRATOR permission or is the owner of the guild | MODERATE_MEMBERS | +| flags | integer | [guild member flags](/docs/resources/guild#guild-member-object-guild-member-flags) | MANAGE_GUILD or MANAGE_ROLES or (MODERATE_MEMBERS and KICK_MEMBERS and BAN_MEMBERS) | ## Modify Current Member /guilds/[\{guild.id\}](/docs/resources/guild#guild-object)/members/@me diff --git a/docs/resources/subscription.mdx b/docs/resources/subscription.mdx index 214efd58b2..e2fc879bc0 100644 --- a/docs/resources/subscription.mdx +++ b/docs/resources/subscription.mdx @@ -77,4 +77,4 @@ Returns all subscriptions containing the SKU, filtered by user. Returns a list o ## Get SKU Subscription /skus/[\{sku.id\}](/docs/resources/sku#sku-object)/subscriptions/[\{subscription.id\}](/docs/resources/subscription#subscription-object) -Get a subscription by its ID. Returns a [subscription](/docs/resources/subscription#subscription-object) object. +Get a subscription by its ID. Returns a [subscription](/docs/resources/subscription#subscription-object) object. \ No newline at end of file diff --git a/docs/resources/user.mdx b/docs/resources/user.mdx index 1d716963aa..ea7a93b807 100644 --- a/docs/resources/user.mdx +++ b/docs/resources/user.mdx @@ -88,7 +88,7 @@ There are other rules and restrictions not shared here for the sake of spam and | `1 << 17` | VERIFIED_DEVELOPER | Early Verified Bot Developer | | `1 << 18` | CERTIFIED_MODERATOR | Moderator Programs Alumni | | `1 << 19` | BOT_HTTP_INTERACTIONS | Bot uses only [HTTP interactions](/docs/interactions/receiving-and-responding#receiving-an-interaction) and is shown in the online member list | -| `1 << 22` | ACTIVE_DEVELOPER | User is an [Active Developer](https://support-dev.discord.com/hc/en-us/articles/10113997751447) | +| `1 << 22` | ACTIVE_DEVELOPER | User is an [Active Developer](https://support-dev.discord.com/hc/articles/10113997751447) | ###### Premium Types @@ -103,7 +103,7 @@ Premium types denote the level of premium a user has. Visit the [Nitro](https:// ### Avatar Decoration Data Object -The data for the user's [avatar decoration](https://support.discord.com/hc/en-us/articles/13410113109911). +The data for the user's [avatar decoration](https://support.discord.com/hc/en-us/articles/13410113109911-Avatar-Decorations). ###### Avatar Decoration Data Structure diff --git a/docs/resources/webhook.mdx b/docs/resources/webhook.mdx index ef15e5c4c9..9a9fde2681 100644 --- a/docs/resources/webhook.mdx +++ b/docs/resources/webhook.mdx @@ -260,7 +260,7 @@ Refer to [Slack's documentation](https://api.slack.com/incoming-webhooks) for mo ## Execute GitHub-Compatible Webhook /webhooks/[\{webhook.id\}](/docs/resources/webhook#webhook-object)/[\{webhook.token\}](/docs/resources/webhook#webhook-object)/github -[Add a new webhook](https://support.discord.com/hc/en-us/articles/228383668) to your GitHub repo (in the repo's settings), and use this endpoint as the "Payload URL." You can choose what events your Discord channel receives by choosing the "Let me select individual events" option and selecting individual events for the new webhook you're configuring. The supported [events](https://docs.github.com/en/webhooks/webhook-events-and-payloads) are `commit_comment`, `create`, `delete`, `fork`, `issue_comment`, `issues`, `member`, `public`, `pull_request`, `pull_request_review`, `pull_request_review_comment`, `push`, `release`, `watch`, `check_run`, `check_suite`, `discussion`, and `discussion_comment`. +[Add a new webhook](https://support.discord.com/hc/en-us/articles/228383668-Intro-to-Webhooks) to your GitHub repo (in the repo's settings), and use this endpoint as the "Payload URL." You can choose what events your Discord channel receives by choosing the "Let me select individual events" option and selecting individual events for the new webhook you're configuring. The supported [events](https://docs.github.com/en/webhooks/webhook-events-and-payloads) are `commit_comment`, `create`, `delete`, `fork`, `issue_comment`, `issues`, `member`, `public`, `pull_request`, `pull_request_review`, `pull_request_review_comment`, `push`, `release`, `watch`, `check_run`, `check_suite`, `discussion`, and `discussion_comment`. ###### Query String Params diff --git a/docs/topics/oauth2.mdx b/docs/topics/oauth2.mdx index 05c8e074f9..065a72f77a 100644 --- a/docs/topics/oauth2.mdx +++ b/docs/topics/oauth2.mdx @@ -275,7 +275,7 @@ Bot users have a few differences compared to standard Discord users: 1. Bots are added to guilds through the OAuth2 API, and cannot accept normal invites. 2. Bots cannot have friends or be added to or join Group DMs. -3. [Verified bots](https://support-dev.discord.com/hc/en-us/articles/23926564536471) do not have a maximum number of guilds. +3. [Verified bots](https://support-dev.discord.com/hc/en-us/articles/23926564536471-How-Do-I-Get-My-App-Verified) do not have a maximum number of guilds. 4. Bots have an entirely separate set of [rate limits](/docs/topics/rate-limits#rate-limits). ### Bot Authorization Flow diff --git a/docs/topics/teams.md b/docs/topics/teams.md index 541f355b2b..7c3893521f 100644 --- a/docs/topics/teams.md +++ b/docs/topics/teams.md @@ -4,7 +4,7 @@ Teams are groups of developers (or other Discord users) who want to collaborate ## Creating a Team -To create or be a member on a team, you must [enable 2FA for your Discord account](https://support.discord.com/hc/en-us/articles/219576828). After you have 2FA enabled, create a team by navigating to the [Teams page](https://discord.com/developers/teams) then clicking the "New Team" button. +To create or be a member on a team, you must [enable 2FA for your Discord account](https://support.discord.com/hc/en-us/articles/219576828-Setting-up-Two-Factor-Authentication). After you have 2FA enabled, create a team by navigating to the [Teams page](https://discord.com/developers/teams) then clicking the "New Team" button. ![Screenshot of the Teams page](images/team-page.png) diff --git a/docs/topics/threads.md b/docs/topics/threads.md index 8ed30c1147..f0951e7af3 100644 --- a/docs/topics/threads.md +++ b/docs/topics/threads.md @@ -204,7 +204,7 @@ A `GUILD_FORUM` (type `15`) channel is similar to a `GUILD_TEXT` channel, except Messages cannot be sent directly in forum channels. :::info -More information about forum channels and how they appear in Discord can be found in the [Forum Channels FAQ](https://support.discord.com/hc/en-us/articles/6208479917079#h_01JAZAWCX4DXYK26BKT49DXMAQ) +More information about forum channels and how they appear in Discord can be found in the [Forum Channels FAQ](https://support.discord.com/hc/en-us/articles/6208479917079-Forum-Channels-FAQ#h_01G69FJQWTWN88HFEHK7Z6X79N) ::: ## Media Channels diff --git a/docs/tutorials/upgrading-to-application-commands.md b/docs/tutorials/upgrading-to-application-commands.md index 7ab2b8af62..1d61c03143 100644 --- a/docs/tutorials/upgrading-to-application-commands.md +++ b/docs/tutorials/upgrading-to-application-commands.md @@ -4,7 +4,7 @@ sidebar_label: Upgrading to Application Commands # Upgrading Apps to Use Application Commands -As [message content has become a privileged intent](https://support-dev.discord.com/hc/en-us/articles/4404772028055) for verified apps, [application commands](/docs/interactions/application-commands) are the primary way Discord users interact with apps. The three types of commands (slash commands, user commands, and message commands) act as entry points into apps, and can be registered globally or for a subset of guilds. +As [message content has become a privileged intent](https://support-dev.discord.com/hc/en-us/articles/4404772028055-Message-Content-Privileged-Intent-FAQ) for verified apps, [application commands](/docs/interactions/application-commands) are the primary way Discord users interact with apps. The three types of commands (slash commands, user commands, and message commands) act as entry points into apps, and can be registered globally or for a subset of guilds. This guide is intended to provide developers with apps currently using message content with a resource to walk through implementing and designing commands. Throughout the guide, the terms "application commands" and "commands" are used interchangeably. @@ -308,5 +308,5 @@ This can come in the form of a specific command that shows app usage, a message Hopefully this guide was helpful in considering how to design and implement application commands. Below is a couple of follow-up resources you can use: - [Application command documentation](/docs/interactions/application-commands)—I know it's linked a bunch in this guide, but there's a reason! -- Help center article on [message content intent alternatives](https://support-dev.discord.com/hc/en-us/articles/6383579033751) -- The official [Discord Developers Server](https://discord.gg/discord-developers) where you can find API updates, ask questions about developing apps, and connect with other developers +- Help center article on [message content intent workarounds](https://support-dev.discord.com/hc/en-us/articles/6383579033751-Message-Content-Intent-Alternatives-Workarounds) +- The [DDevs server](https://discord.gg/discord-developers) where you can find API updates, ask questions about developing apps, and connect with other developers From 3415eedc9c5ec65b9aeca5ad7fd2c136560564f6 Mon Sep 17 00:00:00 2001 From: GeniusTimo Date: Tue, 22 Apr 2025 22:03:13 +0200 Subject: [PATCH 13/20] Wrapped enpoint paths in inline code --- docs/topics/oauth2.mdx | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-) diff --git a/docs/topics/oauth2.mdx b/docs/topics/oauth2.mdx index 065a72f77a..6667892ad3 100644 --- a/docs/topics/oauth2.mdx +++ b/docs/topics/oauth2.mdx @@ -34,14 +34,14 @@ These are a list of all the OAuth2 scopes that Discord supports. Some scopes req | applications.entitlements | allows your app to read entitlements for a user's applications | | applications.store.update | allows your app to read and update store data (SKUs, store listings, achievements, etc.) for a user's applications | | bot | for oauth2 bots, this puts the bot in the user's selected guild by default | -| connections | allows [/users/@me/connections](/docs/resources/user#get-current-user-connections) to return linked third-party accounts | +| connections | allows [`/users/@me/connections`](/docs/resources/user#get-current-user-connections) to return linked third-party accounts | | dm_channels.read | allows your app to see information about the user's DMs and group DMs - requires Discord approval | -| email | enables [/users/@me](/docs/resources/user#get-current-user) to return an `email` | +| email | enables [`/users/@me`](/docs/resources/user#get-current-user) to return an `email` | | gdm.join | allows your app to [join users to a group dm](/docs/resources/channel#group-dm-add-recipient) | -| guilds | allows [/users/@me/guilds](/docs/resources/user#get-current-user-guilds) to return basic information about all of a user's guilds | -| guilds.join | allows [/guilds/{guild.id}/members/{user.id}](/docs/resources/guild#add-guild-member) to be used for joining users to a guild | -| guilds.members.read | allows [/users/@me/guilds/{guild.id}/member](/docs/resources/user#get-current-user-guild-member) to return a user's member information in a guild | -| identify | allows [/users/@me](/docs/resources/user#get-current-user) without `email` | +| guilds | allows [`/users/@me/guilds`](/docs/resources/user#get-current-user-guilds) to return basic information about all of a user's guilds | +| guilds.join | allows [`/guilds/{guild.id}/members/{user.id}`](/docs/resources/guild#add-guild-member) to be used for joining users to a guild | +| guilds.members.read | allows [`/users/@me/guilds/{guild.id}/member`](/docs/resources/user#get-current-user-guild-member) to return a user's member information in a guild | +| identify | allows [`/users/@me`](/docs/resources/user#get-current-user) without `email` | | messages.read | for local rpc server api access, this allows you to read messages from all client channels (otherwise restricted to channels/guilds your app creates) | | relationships.read | allows your app to know a user's friends and implicit relationships - requires Discord approval | | role_connections.write | allows your app to update a user's connection and metadata for the app | From 2e42c672adb5468a0515af925fd0a44272a0c3cb Mon Sep 17 00:00:00 2001 From: GeniusTimo Date: Wed, 23 Apr 2025 17:16:46 +0200 Subject: [PATCH 14/20] Changed Route attribute "type" to correct attribute "method" --- docs/events/gateway.mdx | 4 +- docs/interactions/application-commands.mdx | 32 +++---- .../interactions/receiving-and-responding.mdx | 16 ++-- .../application-role-connection-metadata.mdx | 4 +- docs/resources/application.mdx | 6 +- docs/resources/audit-log.mdx | 2 +- docs/resources/auto-moderation.mdx | 10 +- docs/resources/channel.mdx | 52 +++++----- docs/resources/emoji.mdx | 20 ++-- docs/resources/entitlement.mdx | 10 +- docs/resources/guild-scheduled-event.mdx | 12 +-- docs/resources/guild-template.mdx | 14 +-- docs/resources/guild.mdx | 94 +++++++++---------- docs/resources/invite.mdx | 4 +- docs/resources/lobby.mdx | 18 ++-- docs/resources/message.mdx | 26 ++--- docs/resources/poll.mdx | 4 +- docs/resources/sku.mdx | 2 +- docs/resources/soundboard.mdx | 14 +-- docs/resources/stage-instance.mdx | 8 +- docs/resources/sticker.mdx | 16 ++-- docs/resources/subscription.mdx | 4 +- docs/resources/user.mdx | 22 ++--- docs/resources/voice.mdx | 10 +- docs/resources/webhook.mdx | 30 +++--- docs/topics/oauth2.mdx | 4 +- 26 files changed, 219 insertions(+), 219 deletions(-) diff --git a/docs/events/gateway.mdx b/docs/events/gateway.mdx index d74ed7c999..a1ef17279e 100644 --- a/docs/events/gateway.mdx +++ b/docs/events/gateway.mdx @@ -698,7 +698,7 @@ The [Get Gateway Bot endpoint](/docs/events/gateway#get-gateway-bot) will always The session start limit for these bots will also be increased from 1000 to `max(2000, (guild_count / 1000) * 5)` per day. You also receive an increased `max_concurrency`, the number of [shards you can concurrently start](/docs/events/gateway#session-start-limit-object). ## Get Gateway -/gateway +/gateway :::info This endpoint does not require authentication. @@ -715,7 +715,7 @@ Returns an object with a valid WSS URL which the app can use when [Connecting](/ ``` ## Get Gateway Bot -/gateway/bot +/gateway/bot :::warn This endpoint requires authentication using a valid bot token. diff --git a/docs/interactions/application-commands.mdx b/docs/interactions/application-commands.mdx index 01659699c1..60ad34c1f3 100644 --- a/docs/interactions/application-commands.mdx +++ b/docs/interactions/application-commands.mdx @@ -1157,7 +1157,7 @@ For authorization, all endpoints take either a [bot token](/docs/reference#authe ::: ## Get Global Application Commands -/applications/[\{application.id\}](/docs/resources/application#application-object)/commands +/applications/[\{application.id\}](/docs/resources/application#application-object)/commands :::warn The objects returned by this endpoint may be augmented with [additional fields if localization is active](/docs/interactions/application-commands#retrieving-localized-commands). @@ -1172,7 +1172,7 @@ Fetch all of the global commands for your application. Returns an array of [appl | with_localizations? | [boolean](/docs/reference#boolean-query-strings) | Whether to include full localization dictionaries (`name_localizations` and `description_localizations`) in the returned objects, instead of the `name_localized` and `description_localized` fields. Default `false`. | ## Create Global Application Command -/applications/[\{application.id\}](/docs/resources/application#application-object)/commands +/applications/[\{application.id\}](/docs/resources/application#application-object)/commands :::warn Creating a command with the same name as an existing command for your application will overwrite the old command. @@ -1198,12 +1198,12 @@ Create a new global command. Returns `201` if a command with the same name does | nsfw? | boolean | Indicates whether the command is [age-restricted](/docs/interactions/application-commands#agerestricted-commands) | ## Get Global Application Command -/applications/[\{application.id\}](/docs/resources/application#application-object)/commands/[\{command.id\}](/docs/interactions/application-commands#application-command-object) +/applications/[\{application.id\}](/docs/resources/application#application-object)/commands/[\{command.id\}](/docs/interactions/application-commands#application-command-object) Fetch a global command for your application. Returns an [application command](/docs/interactions/application-commands#application-command-object) object. ## Edit Global Application Command -/applications/[\{application.id\}](/docs/resources/application#application-object)/commands/[\{command.id\}](/docs/interactions/application-commands#application-command-object) +/applications/[\{application.id\}](/docs/resources/application#application-object)/commands/[\{command.id\}](/docs/interactions/application-commands#application-command-object) :::info All parameters for this endpoint are optional. @@ -1228,12 +1228,12 @@ Edit a global command. Returns `200` and an [application command](/docs/interact | nsfw? | boolean | Indicates whether the command is [age-restricted](/docs/interactions/application-commands#agerestricted-commands) | ## Delete Global Application Command -/applications/[\{application.id\}](/docs/resources/application#application-object)/commands/[\{command.id\}](/docs/interactions/application-commands#application-command-object) +/applications/[\{application.id\}](/docs/resources/application#application-object)/commands/[\{command.id\}](/docs/interactions/application-commands#application-command-object) Deletes a global command. Returns `204 No Content` on success. ## Bulk Overwrite Global Application Commands -/applications/[\{application.id\}](/docs/resources/application#application-object)/commands +/applications/[\{application.id\}](/docs/resources/application#application-object)/commands Takes a list of application commands, overwriting the existing global command list for this application. Returns `200` and a list of [application command](/docs/interactions/application-commands#application-command-object) objects. Commands that do not already exist will count toward daily application command create limits. @@ -1242,7 +1242,7 @@ This will overwrite **all** types of application commands: slash commands, user ::: ## Get Guild Application Commands -/applications/[\{application.id\}](/docs/resources/application#application-object)/guilds/[\{guild.id\}](/docs/resources/guild#guild-object)/commands +/applications/[\{application.id\}](/docs/resources/application#application-object)/guilds/[\{guild.id\}](/docs/resources/guild#guild-object)/commands :::warn The objects returned by this endpoint may be augmented with [additional fields if localization is active](/docs/interactions/application-commands#retrieving-localized-commands). @@ -1257,7 +1257,7 @@ Fetch all of the guild commands for your application for a specific guild. Retur | with_localizations? | [boolean](/docs/reference#boolean-query-strings) | Whether to include full localization dictionaries (`name_localizations` and `description_localizations`) in the returned objects, instead of the `name_localized` and `description_localized` fields. Default `false`. | ## Create Guild Application Command -/applications/[\{application.id\}](/docs/resources/application#application-object)/guilds/[\{guild.id\}](/docs/resources/guild#guild-object)/commands +/applications/[\{application.id\}](/docs/resources/application#application-object)/guilds/[\{guild.id\}](/docs/resources/guild#guild-object)/commands :::danger Creating a command with the same name as an existing command for your application will overwrite the old command. @@ -1280,12 +1280,12 @@ Create a new guild command. New guild commands will be available in the guild im | nsfw? | boolean | Indicates whether the command is [age-restricted](/docs/interactions/application-commands#agerestricted-commands) | ## Get Guild Application Command -/applications/[\{application.id\}](/docs/resources/application#application-object)/guilds/[\{guild.id\}](/docs/resources/guild#guild-object)/commands/[\{command.id\}](/docs/interactions/application-commands#application-command-object) +/applications/[\{application.id\}](/docs/resources/application#application-object)/guilds/[\{guild.id\}](/docs/resources/guild#guild-object)/commands/[\{command.id\}](/docs/interactions/application-commands#application-command-object) Fetch a guild command for your application. Returns an [application command](/docs/interactions/application-commands#application-command-object) object. ## Edit Guild Application Command -/applications/[\{application.id\}](/docs/resources/application#application-object)/guilds/[\{guild.id\}](/docs/resources/guild#guild-object)/commands/[\{command.id\}](/docs/interactions/application-commands#application-command-object) +/applications/[\{application.id\}](/docs/resources/application#application-object)/guilds/[\{guild.id\}](/docs/resources/guild#guild-object)/commands/[\{command.id\}](/docs/interactions/application-commands#application-command-object) :::info All parameters for this endpoint are optional. @@ -1307,12 +1307,12 @@ Edit a guild command. Updates for guild commands will be available immediately. | nsfw? | boolean | Indicates whether the command is [age-restricted](/docs/interactions/application-commands#agerestricted-commands) | ## Delete Guild Application Command -/applications/[\{application.id\}](/docs/resources/application#application-object)/guilds/[\{guild.id\}](/docs/resources/guild#guild-object)/commands/[\{command.id\}](/docs/interactions/application-commands#application-command-object) +/applications/[\{application.id\}](/docs/resources/application#application-object)/guilds/[\{guild.id\}](/docs/resources/guild#guild-object)/commands/[\{command.id\}](/docs/interactions/application-commands#application-command-object) Delete a guild command. Returns `204 No Content` on success. ## Bulk Overwrite Guild Application Commands -/applications/[\{application.id\}](/docs/resources/application#application-object)/guilds/[\{guild.id\}](/docs/resources/guild#guild-object)/commands +/applications/[\{application.id\}](/docs/resources/application#application-object)/guilds/[\{guild.id\}](/docs/resources/guild#guild-object)/commands Takes a list of application commands, overwriting the existing command list for this application for the targeted guild. Returns `200` and a list of [application command](/docs/interactions/application-commands#application-command-object) objects. @@ -1339,17 +1339,17 @@ This will overwrite **all** types of application commands: slash commands, user | nsfw? | boolean | Indicates whether the command is [age-restricted](/docs/interactions/application-commands#agerestricted-commands) | ## Get Guild Application Command Permissions -/applications/[\{application.id\}](/docs/resources/application#application-object)/guilds/[\{guild.id\}](/docs/resources/guild#guild-object)/commands/permissions +/applications/[\{application.id\}](/docs/resources/application#application-object)/guilds/[\{guild.id\}](/docs/resources/guild#guild-object)/commands/permissions Fetches permissions for all commands for your application in a guild. Returns an array of [guild application command permissions](/docs/interactions/application-commands#application-command-permissions-object-guild-application-command-permissions-structure) objects. ## Get Application Command Permissions -/applications/[\{application.id\}](/docs/resources/application#application-object)/guilds/[\{guild.id\}](/docs/resources/guild#guild-object)/commands/[\{command.id\}](/docs/interactions/application-commands#application-command-object)/permissions +/applications/[\{application.id\}](/docs/resources/application#application-object)/guilds/[\{guild.id\}](/docs/resources/guild#guild-object)/commands/[\{command.id\}](/docs/interactions/application-commands#application-command-object)/permissions Fetches permissions for a specific command for your application in a guild. Returns a [guild application command permissions](/docs/interactions/application-commands#application-command-permissions-object-guild-application-command-permissions-structure) object. ## Edit Application Command Permissions -/applications/[\{application.id\}](/docs/resources/application#application-object)/guilds/[\{guild.id\}](/docs/resources/guild#guild-object)/commands/[\{command.id\}](/docs/interactions/application-commands#application-command-object)/permissions +/applications/[\{application.id\}](/docs/resources/application#application-object)/guilds/[\{guild.id\}](/docs/resources/guild#guild-object)/commands/[\{command.id\}](/docs/interactions/application-commands#application-command-object)/permissions :::warn This endpoint will overwrite existing permissions for the command in that guild @@ -1374,7 +1374,7 @@ Deleting or renaming a command will permanently delete all permissions for the c | permissions | array of [application command permissions](/docs/interactions/application-commands#application-command-permissions-object-application-command-permissions-structure) | Permissions for the command in the guild | ## Batch Edit Application Command Permissions -/applications/[\{application.id\}](/docs/resources/application#application-object)/guilds/[\{guild.id\}](/docs/resources/guild#guild-object)/commands/permissions +/applications/[\{application.id\}](/docs/resources/application#application-object)/guilds/[\{guild.id\}](/docs/resources/guild#guild-object)/commands/permissions :::danger This endpoint has been disabled with [updates to command permissions (Permissions v2)](/docs/change-log#updated-command-permissions). Instead, you can [edit each application command permissions](/docs/interactions/application-commands#edit-application-command-permissions) (though you should be careful to handle any potential [rate limits](/docs/topics/rate-limits)). diff --git a/docs/interactions/receiving-and-responding.mdx b/docs/interactions/receiving-and-responding.mdx index 3fc651e578..5d9d0cfb7f 100644 --- a/docs/interactions/receiving-and-responding.mdx +++ b/docs/interactions/receiving-and-responding.mdx @@ -390,7 +390,7 @@ The endpoints below are not bound to the application's [Global Rate Limit](/docs ::: ## Create Interaction Response -/interactions/[\{interaction.id\}](/docs/interactions/receiving-and-responding#interaction-object)/[\{interaction.token\}](/docs/interactions/receiving-and-responding#interaction-object)/callback +/interactions/[\{interaction.id\}](/docs/interactions/receiving-and-responding#interaction-object)/[\{interaction.token\}](/docs/interactions/receiving-and-responding#interaction-object)/callback Create a response to an Interaction. Body is an [interaction response](/docs/interactions/receiving-and-responding#interaction-response-object). Returns `204` unless `with_response` is set to `true` which returns `200` with the body as [interaction callback response](/docs/interactions/receiving-and-responding#interaction-callback-interaction-callback-response-object). @@ -404,22 +404,22 @@ This endpoint also supports file attachments similar to the webhook endpoints. R ## Get Original Interaction Response -/webhooks/[\{application.id\}](/docs/resources/application#application-object)/[\{interaction.token\}](/docs/interactions/receiving-and-responding#interaction-object)/messages/@original +/webhooks/[\{application.id\}](/docs/resources/application#application-object)/[\{interaction.token\}](/docs/interactions/receiving-and-responding#interaction-object)/messages/@original Returns the initial Interaction response. Functions the same as [Get Webhook Message](/docs/resources/webhook#get-webhook-message). ## Edit Original Interaction Response -/webhooks/[\{application.id\}](/docs/resources/application#application-object)/[\{interaction.token\}](/docs/interactions/receiving-and-responding#interaction-object)/messages/@original +/webhooks/[\{application.id\}](/docs/resources/application#application-object)/[\{interaction.token\}](/docs/interactions/receiving-and-responding#interaction-object)/messages/@original Edits the initial Interaction response. Functions the same as [Edit Webhook Message](/docs/resources/webhook#edit-webhook-message). ## Delete Original Interaction Response -/webhooks/[\{application.id\}](/docs/resources/application#application-object)/[\{interaction.token\}](/docs/interactions/receiving-and-responding#interaction-object)/messages/@original +/webhooks/[\{application.id\}](/docs/resources/application#application-object)/[\{interaction.token\}](/docs/interactions/receiving-and-responding#interaction-object)/messages/@original Deletes the initial Interaction response. Returns `204 No Content` on success. ## Create Followup Message -/webhooks/[\{application.id\}](/docs/resources/application#application-object)/[\{interaction.token\}](/docs/interactions/receiving-and-responding#interaction-object) +/webhooks/[\{application.id\}](/docs/resources/application#application-object)/[\{interaction.token\}](/docs/interactions/receiving-and-responding#interaction-object) :::info Apps are limited to 5 followup messages per interaction if it was initiated from a user-installed app and isn't installed in the server (meaning the [authorizing integration owners object](/docs/interactions/receiving-and-responding#interaction-object-authorizing-integration-owners-object) only contains `USER_INSTALL`) @@ -430,16 +430,16 @@ Create a followup message for an Interaction. Functions the same as [Execute Web When using this endpoint directly after responding to an interaction with `DEFERRED_CHANNEL_MESSAGE_WITH_SOURCE`, this endpoint will function as [Edit Original Interaction Response](/docs/interactions/receiving-and-responding#edit-original-interaction-response) for backwards compatibility. In this case, no new message will be created, and the loading message will be edited instead. The ephemeral flag will be ignored, and the value you provided in the initial defer response will be preserved, as an existing message's ephemeral state cannot be changed. This behavior is deprecated, and you should use the Edit Original Interaction Response endpoint in this case instead. ## Get Followup Message -/webhooks/[\{application.id\}](/docs/resources/application#application-object)/[\{interaction.token\}](/docs/interactions/receiving-and-responding#interaction-object)/messages/[\{message.id\}](/docs/resources/message#message-object) +/webhooks/[\{application.id\}](/docs/resources/application#application-object)/[\{interaction.token\}](/docs/interactions/receiving-and-responding#interaction-object)/messages/[\{message.id\}](/docs/resources/message#message-object) Returns a followup message for an Interaction. Functions the same as [Get Webhook Message](/docs/resources/webhook#get-webhook-message). ## Edit Followup Message -/webhooks/[\{application.id\}](/docs/resources/application#application-object)/[\{interaction.token\}](/docs/interactions/receiving-and-responding#interaction-object)/messages/[\{message.id\}](/docs/resources/message#message-object) +/webhooks/[\{application.id\}](/docs/resources/application#application-object)/[\{interaction.token\}](/docs/interactions/receiving-and-responding#interaction-object)/messages/[\{message.id\}](/docs/resources/message#message-object) Edits a followup message for an Interaction. Functions the same as [Edit Webhook Message](/docs/resources/webhook#edit-webhook-message). ## Delete Followup Message -/webhooks/[\{application.id\}](/docs/resources/application#application-object)/[\{interaction.token\}](/docs/interactions/receiving-and-responding#interaction-object)/messages/[\{message.id\}](/docs/resources/message#message-object) +/webhooks/[\{application.id\}](/docs/resources/application#application-object)/[\{interaction.token\}](/docs/interactions/receiving-and-responding#interaction-object)/messages/[\{message.id\}](/docs/resources/message#message-object) Deletes a followup message for an Interaction. Returns `204 No Content` on success. diff --git a/docs/resources/application-role-connection-metadata.mdx b/docs/resources/application-role-connection-metadata.mdx index 04ee162c87..9ca88f9806 100644 --- a/docs/resources/application-role-connection-metadata.mdx +++ b/docs/resources/application-role-connection-metadata.mdx @@ -39,12 +39,12 @@ Each metadata type offers a comparison operation that allows guilds to configure ::: ## Get Application Role Connection Metadata Records -/applications/[\{application.id\}](/docs/resources/application#application-object)/role-connections/metadata +/applications/[\{application.id\}](/docs/resources/application#application-object)/role-connections/metadata Returns a list of [application role connection metadata](/docs/resources/application-role-connection-metadata#application-role-connection-metadata-object) objects for the given application. ## Update Application Role Connection Metadata Records -/applications/[\{application.id\}](/docs/resources/application#application-object)/role-connections/metadata +/applications/[\{application.id\}](/docs/resources/application#application-object)/role-connections/metadata Updates and returns a list of [application role connection metadata](/docs/resources/application-role-connection-metadata#application-role-connection-metadata-object) objects for the given application. diff --git a/docs/resources/application.mdx b/docs/resources/application.mdx index 6f54616eb1..3c74ea9824 100644 --- a/docs/resources/application.mdx +++ b/docs/resources/application.mdx @@ -227,12 +227,12 @@ You can configure your app's install link in your [app's settings](https://disco The Default Install Settings will appear on the **Installation** page when you have "Discord Provided Link" selected as your install link type. ## Get Current Application -/applications/@me +/applications/@me Returns the [application](/docs/resources/application#application-object) object associated with the requesting bot user. ## Edit Current Application -/applications/@me +/applications/@me Edit properties of the app associated with the requesting bot user. Only properties that are passed will be updated. Returns the updated [application](/docs/resources/application#application-object) object on success. @@ -263,7 +263,7 @@ All parameters to this endpoint are optional \*\* To update an Interactions endpoint URL via the API, the URL must be valid according to the [Receiving an Interaction](/docs/interactions/receiving-and-responding#receiving-an-interaction) documentation. ## Get Application Activity Instance -/applications/[\{application.id\}](/docs/resources/application#application-object)/activity-instances/{instance_id} +/applications/[\{application.id\}](/docs/resources/application#application-object)/activity-instances/{instance_id} Returns a serialized activity instance, if it exists. Useful for [preventing unwanted activity sessions](/docs/activities/development-guides#preventing-unwanted-activity-sessions). diff --git a/docs/resources/audit-log.mdx b/docs/resources/audit-log.mdx index 97c56a6c4f..ccbb74e52c 100644 --- a/docs/resources/audit-log.mdx +++ b/docs/resources/audit-log.mdx @@ -198,7 +198,7 @@ For most objects, the change keys may be any field on the changed object. The fo | [Webhook](/docs/resources/webhook#webhook-object) | `avatar_hash` key (instead of `avatar`) | | ## Get Guild Audit Log -/guilds/[\{guild.id\}](/docs/resources/guild#guild-object)/audit-logs +/guilds/[\{guild.id\}](/docs/resources/guild#guild-object)/audit-logs Returns an [audit log](/docs/resources/audit-log#audit-log-object) object for the guild. Requires the [`VIEW_AUDIT_LOG`](/docs/topics/permissions#permissions-bitwise-permission-flags) permission. diff --git a/docs/resources/auto-moderation.mdx b/docs/resources/auto-moderation.mdx index 775c27f8d8..40141afdb2 100644 --- a/docs/resources/auto-moderation.mdx +++ b/docs/resources/auto-moderation.mdx @@ -199,7 +199,7 @@ Users are required to have the `MANAGE_GUILD` permission to access all Auto Mode Some [action types](/docs/resources/auto-moderation#auto-moderation-action-object-action-types) require additional permissions, e.g. the `TIMEOUT` action type requires an additional `MODERATE_MEMBERS` permission. ## List Auto Moderation Rules for Guild -/guilds/[\{guild.id\}](/docs/resources/guild#guild-object)/auto-moderation/rules +/guilds/[\{guild.id\}](/docs/resources/guild#guild-object)/auto-moderation/rules Get a list of all rules currently configured for the guild. Returns a list of [auto moderation rule](/docs/resources/auto-moderation#auto-moderation-rule-object) objects for the given guild. @@ -208,7 +208,7 @@ This endpoint requires the `MANAGE_GUILD` [permission](/docs/resources/auto-mode ::: ## Get Auto Moderation Rule -/guilds/[\{guild.id\}](/docs/resources/guild#guild-object)/auto-moderation/rules/[\{auto_moderation_rule.id\}](/docs/resources/auto-moderation#auto-moderation-rule-object) +/guilds/[\{guild.id\}](/docs/resources/guild#guild-object)/auto-moderation/rules/[\{auto_moderation_rule.id\}](/docs/resources/auto-moderation#auto-moderation-rule-object) Get a single rule. Returns an [auto moderation rule](/docs/resources/auto-moderation#auto-moderation-rule-object) object. @@ -217,7 +217,7 @@ This endpoint requires the `MANAGE_GUILD` [permission](/docs/resources/auto-mode ::: ## Create Auto Moderation Rule -/guilds/[\{guild.id\}](/docs/resources/guild#guild-object)/auto-moderation/rules +/guilds/[\{guild.id\}](/docs/resources/guild#guild-object)/auto-moderation/rules Create a new rule. Returns an [auto moderation rule](/docs/resources/auto-moderation#auto-moderation-rule-object) on success. Fires an [Auto Moderation Rule Create](/docs/events/gateway-events#auto-moderation-rule-create) Gateway event. @@ -250,7 +250,7 @@ See [Trigger Types](/docs/resources/auto-moderation#auto-moderation-rule-object- ## Modify Auto Moderation Rule -/guilds/[\{guild.id\}](/docs/resources/guild#guild-object)/auto-moderation/rules/[\{auto_moderation_rule.id\}](/docs/resources/auto-moderation#auto-moderation-rule-object) +/guilds/[\{guild.id\}](/docs/resources/guild#guild-object)/auto-moderation/rules/[\{auto_moderation_rule.id\}](/docs/resources/auto-moderation#auto-moderation-rule-object) Modify an existing rule. Returns an [auto moderation rule](/docs/resources/auto-moderation#auto-moderation-rule-object) on success. Fires an [Auto Moderation Rule Update](/docs/events/gateway-events#auto-moderation-rule-update) Gateway event. @@ -281,7 +281,7 @@ This endpoint supports the `X-Audit-Log-Reason` header. \* Can be omitted based on `trigger_type`. See the `Associated Trigger Types` column in [trigger metadata](/docs/resources/auto-moderation#auto-moderation-rule-object-trigger-metadata) to understand which `trigger_type` values require `trigger_metadata` to be set. ## Delete Auto Moderation Rule -/guilds/[\{guild.id\}](/docs/resources/guild#guild-object)/auto-moderation/rules/[\{auto_moderation_rule.id\}](/docs/resources/auto-moderation#auto-moderation-rule-object) +/guilds/[\{guild.id\}](/docs/resources/guild#guild-object)/auto-moderation/rules/[\{auto_moderation_rule.id\}](/docs/resources/auto-moderation#auto-moderation-rule-object) Delete a rule. Returns a `204` on success. Fires an [Auto Moderation Rule Delete](/docs/events/gateway-events#auto-moderation-rule-delete) Gateway event. diff --git a/docs/resources/channel.mdx b/docs/resources/channel.mdx index 26037022f4..9db8c226a4 100644 --- a/docs/resources/channel.mdx +++ b/docs/resources/channel.mdx @@ -346,12 +346,12 @@ When updating a `GUILD_FORUM` or a `GUILD_MEDIA` channel, tag objects in `availa \* At most one of `emoji_id` and `emoji_name` may be set to a non-null value. ## Get Channel -/channels/[\{channel.id\}](/docs/resources/channel#channel-object) +/channels/[\{channel.id\}](/docs/resources/channel#channel-object) Get a channel by ID. Returns a [channel](/docs/resources/channel#channel-object) object. If the channel is a thread, a [thread member](/docs/resources/channel#thread-member-object) object is included in the returned result. ## Modify Channel -/channels/[\{channel.id\}](/docs/resources/channel#channel-object) +/channels/[\{channel.id\}](/docs/resources/channel#channel-object) Update a channel's settings. Returns a [channel](/docs/resources/channel#channel-object) on success, and a 400 BAD REQUEST on invalid parameters. @@ -420,7 +420,7 @@ Otherwise, requires the `MANAGE_THREADS` permission. Fires a [Thread Update](/do | applied_tags? | array of snowflakes | the IDs of the set of tags that have been applied to a thread in a `GUILD_FORUM` or a `GUILD_MEDIA` channel; limited to 5 | ## Delete/Close Channel -/channels/[\{channel.id\}](/docs/resources/channel#channel-object) +/channels/[\{channel.id\}](/docs/resources/channel#channel-object) Delete a channel, or close a private message. Requires the `MANAGE_CHANNELS` permission for the guild, or `MANAGE_THREADS` if the channel is a thread. Deleting a category does not delete its child channels; they will have their `parent_id` removed and a [Channel Update](/docs/events/gateway-events#channel-update) Gateway event will fire for each of them. Returns a [channel](/docs/resources/channel#channel-object) object on success. Fires a [Channel Delete](/docs/events/gateway-events#channel-delete) Gateway event (or [Thread Delete](/docs/events/gateway-events#thread-delete) if the channel was a thread). @@ -437,7 +437,7 @@ This endpoint supports the `X-Audit-Log-Reason` header. ::: ## Edit Channel Permissions -/channels/[\{channel.id\}](/docs/resources/channel#channel-object)/permissions/[\{overwrite.id\}](/docs/resources/channel#overwrite-object) +/channels/[\{channel.id\}](/docs/resources/channel#channel-object)/permissions/[\{overwrite.id\}](/docs/resources/channel#overwrite-object) Edit the channel permission overwrites for a user or role in a channel. Only usable for guild channels. Requires the `MANAGE_ROLES` permission. Only permissions your bot has in the guild or parent channel (if applicable) can be allowed/denied (unless your bot has a `MANAGE_ROLES` overwrite in the channel). Returns a 204 empty response on success. Fires a [Channel Update](/docs/events/gateway-events#channel-update) Gateway event. For more information about permissions, see [permissions](/docs/topics/permissions#permissions). @@ -454,12 +454,12 @@ This endpoint supports the `X-Audit-Log-Reason` header. | type | integer | 0 for a role or 1 for a member | ## Get Channel Invites -/channels/[\{channel.id\}](/docs/resources/channel#channel-object)/invites +/channels/[\{channel.id\}](/docs/resources/channel#channel-object)/invites Returns a list of [invite](/docs/resources/invite#invite-object) objects (with [invite metadata](/docs/resources/invite#invite-metadata-object)) for the channel. Only usable for guild channels. Requires the `MANAGE_CHANNELS` permission. ## Create Channel Invite -/channels/[\{channel.id\}](/docs/resources/channel#channel-object)/invites +/channels/[\{channel.id\}](/docs/resources/channel#channel-object)/invites Create a new [invite](/docs/resources/invite#invite-object) object for the channel. Only usable for guild channels. Requires the `CREATE_INSTANT_INVITE` permission. All JSON parameters for this route are optional, however the request body is not. If you are not sending any fields, you still have to send an empty JSON object (`{}`). Returns an [invite](/docs/resources/invite#invite-object) object. Fires an [Invite Create](/docs/events/gateway-events#invite-create) Gateway event. @@ -480,7 +480,7 @@ This endpoint supports the `X-Audit-Log-Reason` header. | target_application_id | snowflake | the id of the embedded application to open for this invite, required if `target_type` is 2, the application must have the `EMBEDDED` flag | | ## Delete Channel Permission -/channels/[\{channel.id\}](/docs/resources/channel#channel-object)/permissions/[\{overwrite.id\}](/docs/resources/channel#overwrite-object) +/channels/[\{channel.id\}](/docs/resources/channel#channel-object)/permissions/[\{overwrite.id\}](/docs/resources/channel#overwrite-object) Delete a channel permission overwrite for a user or role in a channel. Only usable for guild channels. Requires the `MANAGE_ROLES` permission. Returns a 204 empty response on success. Fires a [Channel Update](/docs/events/gateway-events#channel-update) Gateway event. For more information about permissions, see [permissions](/docs/topics/permissions#permissions) @@ -489,7 +489,7 @@ This endpoint supports the `X-Audit-Log-Reason` header. ::: ## Follow Announcement Channel -/channels/[\{channel.id\}](/docs/resources/channel#channel-object)/followers +/channels/[\{channel.id\}](/docs/resources/channel#channel-object)/followers Follow an Announcement Channel to send messages to a target channel. Requires the `MANAGE_WEBHOOKS` permission in the target channel. Returns a [followed channel](/docs/resources/channel#followed-channel-object) object. Fires a [Webhooks Update](/docs/events/gateway-events#webhooks-update) Gateway event for the target channel. @@ -504,19 +504,19 @@ This endpoint supports the `X-Audit-Log-Reason` header. | webhook_channel_id | snowflake | id of target channel | ## Trigger Typing Indicator -/channels/[\{channel.id\}](/docs/resources/channel#channel-object)/typing +/channels/[\{channel.id\}](/docs/resources/channel#channel-object)/typing Post a typing indicator for the specified channel, which expires after 10 seconds. Returns a 204 empty response on success. Fires a [Typing Start](/docs/events/gateway-events#typing-start) Gateway event. Generally bots should **not** use this route. However, if a bot is responding to a command and expects the computation to take a few seconds, this endpoint may be called to let the user know that the bot is processing their message. ## Get Pinned Messages -/channels/[\{channel.id\}](/docs/resources/channel#channel-object)/pins +/channels/[\{channel.id\}](/docs/resources/channel#channel-object)/pins Returns all pinned messages in the channel as an array of [message](/docs/resources/message#message-object) objects. ## Pin Message -/channels/[\{channel.id\}](/docs/resources/channel#channel-object)/pins/[\{message.id\}](/docs/resources/message#message-object) +/channels/[\{channel.id\}](/docs/resources/channel#channel-object)/pins/[\{message.id\}](/docs/resources/message#message-object) Pin a message in a channel. Requires the `MANAGE_MESSAGES` permission. Returns a 204 empty response on success. Fires a [Channel Pins Update](/docs/events/gateway-events#channel-pins-update) Gateway event. @@ -529,7 +529,7 @@ This endpoint supports the `X-Audit-Log-Reason` header. ::: ## Unpin Message -/channels/[\{channel.id\}](/docs/resources/channel#channel-object)/pins/[\{message.id\}](/docs/resources/message#message-object) +/channels/[\{channel.id\}](/docs/resources/channel#channel-object)/pins/[\{message.id\}](/docs/resources/message#message-object) Unpin a message in a channel. Requires the `MANAGE_MESSAGES` permission. Returns a 204 empty response on success. Fires a [Channel Pins Update](/docs/events/gateway-events#channel-pins-update) Gateway event. @@ -538,7 +538,7 @@ This endpoint supports the `X-Audit-Log-Reason` header. ::: ## Group DM Add Recipient -/channels/[\{channel.id\}](/docs/resources/channel#channel-object)/recipients/[\{user.id\}](/docs/resources/user#user-object) +/channels/[\{channel.id\}](/docs/resources/channel#channel-object)/recipients/[\{user.id\}](/docs/resources/user#user-object) Adds a recipient to a Group DM using their access token. @@ -550,12 +550,12 @@ Adds a recipient to a Group DM using their access token. | nick | string | nickname of the user being added | ## Group DM Remove Recipient -/channels/[\{channel.id\}](/docs/resources/channel#channel-object)/recipients/[\{user.id\}](/docs/resources/user#user-object) +/channels/[\{channel.id\}](/docs/resources/channel#channel-object)/recipients/[\{user.id\}](/docs/resources/user#user-object) Removes a recipient from a Group DM. ## Start Thread from Message -/channels/[\{channel.id\}](/docs/resources/channel#channel-object)/messages/[\{message.id\}](/docs/resources/message#message-object)/threads +/channels/[\{channel.id\}](/docs/resources/channel#channel-object)/messages/[\{message.id\}](/docs/resources/message#message-object)/threads Creates a new thread from an existing message. Returns a [channel](/docs/resources/channel#channel-object) on success, and a 400 BAD REQUEST on invalid parameters. Fires a [Thread Create](/docs/events/gateway-events#thread-create) and a [Message Update](/docs/events/gateway-events#message-update) Gateway event. @@ -574,7 +574,7 @@ This endpoint supports the `X-Audit-Log-Reason` header. | rate_limit_per_user? | ?integer | amount of seconds a user has to wait before sending another message (0-21600) | ## Start Thread without Message -/channels/[\{channel.id\}](/docs/resources/channel#channel-object)/threads +/channels/[\{channel.id\}](/docs/resources/channel#channel-object)/threads Creates a new thread that is not connected to an existing message. Returns a [channel](/docs/resources/channel#channel-object) on success, and a 400 BAD REQUEST on invalid parameters. Fires a [Thread Create](/docs/events/gateway-events#thread-create) Gateway event. @@ -595,7 +595,7 @@ This endpoint supports the `X-Audit-Log-Reason` header. \* `type` currently defaults to `PRIVATE_THREAD` in order to match the behavior when thread documentation was first published. In a future API version this will be changed to be a required field, with no default. ## Start Thread in Forum or Media Channel -/channels/[\{channel.id\}](/docs/resources/channel#channel-object)/threads +/channels/[\{channel.id\}](/docs/resources/channel#channel-object)/threads Creates a new thread in a forum or a media channel, and sends a message within the created thread. Returns a [channel](/docs/resources/channel#channel-object), with a nested [message](/docs/resources/message#message-object) object, on success, and a 400 BAD REQUEST on invalid parameters. Fires a [Thread Create](/docs/events/gateway-events#thread-create) and [Message Create](/docs/events/gateway-events#message-create) Gateway event. @@ -648,27 +648,27 @@ When sending a message, apps must provide a value for **at least one of** `conte \* At least one of `content`, `embeds`, `sticker_ids`, `components`, or `files[n]` is required. ## Join Thread -/channels/[\{channel.id\}](/docs/resources/channel#channel-object)/thread-members/@me +/channels/[\{channel.id\}](/docs/resources/channel#channel-object)/thread-members/@me Adds the current user to a thread. Also requires the thread is not archived. Returns a 204 empty response on success. Fires a [Thread Members Update](/docs/events/gateway-events#thread-members-update) and a [Thread Create](/docs/events/gateway-events#thread-create) Gateway event. ## Add Thread Member -/channels/[\{channel.id\}](/docs/resources/channel#channel-object)/thread-members/[\{user.id\}](/docs/resources/user#user-object) +/channels/[\{channel.id\}](/docs/resources/channel#channel-object)/thread-members/[\{user.id\}](/docs/resources/user#user-object) Adds another member to a thread. Requires the ability to send messages in the thread. Also requires the thread is not archived. Returns a 204 empty response if the member is successfully added or was already a member of the thread. Fires a [Thread Members Update](/docs/events/gateway-events#thread-members-update) Gateway event. ## Leave Thread -/channels/[\{channel.id\}](/docs/resources/channel#channel-object)/thread-members/@me +/channels/[\{channel.id\}](/docs/resources/channel#channel-object)/thread-members/@me Removes the current user from a thread. Also requires the thread is not archived. Returns a 204 empty response on success. Fires a [Thread Members Update](/docs/events/gateway-events#thread-members-update) Gateway event. ## Remove Thread Member -/channels/[\{channel.id\}](/docs/resources/channel#channel-object)/thread-members/[\{user.id\}](/docs/resources/user#user-object) +/channels/[\{channel.id\}](/docs/resources/channel#channel-object)/thread-members/[\{user.id\}](/docs/resources/user#user-object) Removes another member from a thread. Requires the `MANAGE_THREADS` permission, or the creator of the thread if it is a `PRIVATE_THREAD`. Also requires the thread is not archived. Returns a 204 empty response on success. Fires a [Thread Members Update](/docs/events/gateway-events#thread-members-update) Gateway event. ## Get Thread Member -/channels/[\{channel.id\}](/docs/resources/channel#channel-object)/thread-members/[\{user.id\}](/docs/resources/user#user-object) +/channels/[\{channel.id\}](/docs/resources/channel#channel-object)/thread-members/[\{user.id\}](/docs/resources/user#user-object) Returns a [thread member](/docs/resources/channel#thread-member-object) object for the specified user if they are a member of the thread, returns a 404 response otherwise. @@ -681,7 +681,7 @@ When `with_member` is set to `true`, the thread member object will include a `me | with_member? | [boolean](/docs/reference#boolean-query-strings) | Whether to include a [guild member](/docs/resources/guild#guild-member-object) object for the thread member | ## List Thread Members -/channels/[\{channel.id\}](/docs/resources/channel#channel-object)/thread-members +/channels/[\{channel.id\}](/docs/resources/channel#channel-object)/thread-members :::warn Starting in API v11, this endpoint will always return paginated results. Paginated results can be enabled before API v11 by setting `with_member` to `true`. Read [the changelog](/docs/change-log#thread-member-details-and-pagination) for details. @@ -704,7 +704,7 @@ This endpoint is restricted according to whether the `GUILD_MEMBERS` [Privileged | limit? | integer | Max number of thread members to return (1-100). Defaults to 100. | ## List Public Archived Threads -/channels/[\{channel.id\}](/docs/resources/channel#channel-object)/threads/archived/public +/channels/[\{channel.id\}](/docs/resources/channel#channel-object)/threads/archived/public Returns archived threads in the channel that are public. When called on a `GUILD_TEXT` channel, returns threads of [type](/docs/resources/channel#channel-object-channel-types) `PUBLIC_THREAD`. When called on a `GUILD_ANNOUNCEMENT` channel returns threads of [type](/docs/resources/channel#channel-object-channel-types) `ANNOUNCEMENT_THREAD`. Threads are ordered by `archive_timestamp`, in descending order. Requires the `READ_MESSAGE_HISTORY` permission. @@ -724,7 +724,7 @@ Returns archived threads in the channel that are public. When called on a `GUILD | has_more | boolean | whether there are potentially additional threads that could be returned on a subsequent call | ## List Private Archived Threads -/channels/[\{channel.id\}](/docs/resources/channel#channel-object)/threads/archived/private +/channels/[\{channel.id\}](/docs/resources/channel#channel-object)/threads/archived/private Returns archived threads in the channel that are of [type](/docs/resources/channel#channel-object-channel-types) `PRIVATE_THREAD`. Threads are ordered by `archive_timestamp`, in descending order. Requires both the `READ_MESSAGE_HISTORY` and `MANAGE_THREADS` permissions. @@ -744,7 +744,7 @@ Returns archived threads in the channel that are of [type](/docs/resources/chann | has_more | boolean | whether there are potentially additional threads that could be returned on a subsequent call | ## List Joined Private Archived Threads -/channels/[\{channel.id\}](/docs/resources/channel#channel-object)/users/@me/threads/archived/private +/channels/[\{channel.id\}](/docs/resources/channel#channel-object)/users/@me/threads/archived/private Returns archived threads in the channel that are of [type](/docs/resources/channel#channel-object-channel-types) `PRIVATE_THREAD`, and the user has joined. Threads are ordered by their `id`, in descending order. Requires the `READ_MESSAGE_HISTORY` permission. diff --git a/docs/resources/emoji.mdx b/docs/resources/emoji.mdx index fec6d990bb..886dd112c6 100644 --- a/docs/resources/emoji.mdx +++ b/docs/resources/emoji.mdx @@ -92,17 +92,17 @@ In `MESSAGE_REACTION_ADD` and `MESSAGE_REACTION_REMOVE` gateway events `name` ma ``` ## List Guild Emojis -/guilds/[\{guild.id\}](/docs/resources/guild#guild-object)/emojis +/guilds/[\{guild.id\}](/docs/resources/guild#guild-object)/emojis Returns a list of [emoji](/docs/resources/emoji#emoji-object) objects for the given guild. Includes `user` fields if the bot has the `CREATE_GUILD_EXPRESSIONS` or `MANAGE_GUILD_EXPRESSIONS` permission. ## Get Guild Emoji -/guilds/[\{guild.id\}](/docs/resources/guild#guild-object)/emojis/[\{emoji.id\}](/docs/resources/emoji#emoji-object) +/guilds/[\{guild.id\}](/docs/resources/guild#guild-object)/emojis/[\{emoji.id\}](/docs/resources/emoji#emoji-object) Returns an [emoji](/docs/resources/emoji#emoji-object) object for the given guild and emoji IDs. Includes the `user` field if the bot has the `MANAGE_GUILD_EXPRESSIONS` permission, or if the bot created the emoji and has the the `CREATE_GUILD_EXPRESSIONS` permission. ## Create Guild Emoji -/guilds/[\{guild.id\}](/docs/resources/guild#guild-object)/emojis +/guilds/[\{guild.id\}](/docs/resources/guild#guild-object)/emojis Create a new emoji for the guild. Requires the `CREATE_GUILD_EXPRESSIONS` permission. Returns the new [emoji](/docs/resources/emoji#emoji-object) object on success. Fires a [Guild Emojis Update](/docs/events/gateway-events#guild-emojis-update) Gateway event. @@ -123,7 +123,7 @@ This endpoint supports the `X-Audit-Log-Reason` header. | roles | array of snowflakes | roles allowed to use this emoji | ## Modify Guild Emoji -/guilds/[\{guild.id\}](/docs/resources/guild#guild-object)/emojis/[\{emoji.id\}](/docs/resources/emoji#emoji-object) +/guilds/[\{guild.id\}](/docs/resources/guild#guild-object)/emojis/[\{emoji.id\}](/docs/resources/emoji#emoji-object) Modify the given emoji. For emojis created by the current user, requires either the `CREATE_GUILD_EXPRESSIONS` or `MANAGE_GUILD_EXPRESSIONS` permission. For other emojis, requires the `MANAGE_GUILD_EXPRESSIONS` permission. Returns the updated [emoji](/docs/resources/emoji#emoji-object) object on success. Fires a [Guild Emojis Update](/docs/events/gateway-events#guild-emojis-update) Gateway event. @@ -143,7 +143,7 @@ This endpoint supports the `X-Audit-Log-Reason` header. | roles | ?array of snowflakes | roles allowed to use this emoji | ## Delete Guild Emoji -/guilds/[\{guild.id\}](/docs/resources/guild#guild-object)/emojis/[\{emoji.id\}](/docs/resources/emoji#emoji-object) +/guilds/[\{guild.id\}](/docs/resources/guild#guild-object)/emojis/[\{emoji.id\}](/docs/resources/emoji#emoji-object) Delete the given emoji. For emojis created by the current user, requires either the `CREATE_GUILD_EXPRESSIONS` or `MANAGE_GUILD_EXPRESSIONS` permission. For other emojis, requires the `MANAGE_GUILD_EXPRESSIONS` permission. Returns `204 No Content` on success. Fires a [Guild Emojis Update](/docs/events/gateway-events#guild-emojis-update) Gateway event. @@ -152,7 +152,7 @@ This endpoint supports the `X-Audit-Log-Reason` header. ::: ## List Application Emojis -/applications/[\{application.id\}](/docs/resources/application#application-object)/emojis +/applications/[\{application.id\}](/docs/resources/application#application-object)/emojis Returns an object containing a list of [emoji](/docs/resources/emoji#emoji-object) objects for the given application under the `items` key. Includes a `user` object for the team member that uploaded the emoji from the app's settings, or for the bot user if uploaded using the API. @@ -179,12 +179,12 @@ Returns an object containing a list of [emoji](/docs/resources/emoji#emoji-objec ``` ## Get Application Emoji -/applications/[\{application.id\}](/docs/resources/application#application-object)/emojis/[\{emoji.id\}](/docs/resources/emoji#emoji-object) +/applications/[\{application.id\}](/docs/resources/application#application-object)/emojis/[\{emoji.id\}](/docs/resources/emoji#emoji-object) Returns an [emoji](/docs/resources/emoji#emoji-object) object for the given application and emoji IDs. Includes the `user` field. ## Create Application Emoji -/applications/[\{application.id\}](/docs/resources/application#application-object)/emojis +/applications/[\{application.id\}](/docs/resources/application#application-object)/emojis Create a new emoji for the application. Returns the new [emoji](/docs/resources/emoji#emoji-object) object on success. @@ -200,7 +200,7 @@ Emojis and animated emojis have a maximum file size of 256 KiB. Attempting to up | image | [image data](/docs/reference#image-data) | the 128x128 emoji image | ## Modify Application Emoji -/applications/[\{application.id\}](/docs/resources/application#application-object)/emojis/[\{emoji.id\}](/docs/resources/emoji#emoji-object) +/applications/[\{application.id\}](/docs/resources/application#application-object)/emojis/[\{emoji.id\}](/docs/resources/emoji#emoji-object) Modify the given emoji. Returns the updated [emoji](/docs/resources/emoji#emoji-object) object on success. @@ -211,6 +211,6 @@ Modify the given emoji. Returns the updated [emoji](/docs/resources/emoji#emoji- | name | string | name of the emoji | ## Delete Application Emoji -/applications/[\{application.id\}](/docs/resources/application#application-object)/emojis/[\{emoji.id\}](/docs/resources/emoji#emoji-object) +/applications/[\{application.id\}](/docs/resources/application#application-object)/emojis/[\{emoji.id\}](/docs/resources/emoji#emoji-object) Delete the given emoji. Returns `204 No Content` on success. diff --git a/docs/resources/entitlement.mdx b/docs/resources/entitlement.mdx index 9c930a7ec3..fffd4e62d4 100644 --- a/docs/resources/entitlement.mdx +++ b/docs/resources/entitlement.mdx @@ -59,7 +59,7 @@ Refer to the [Monetization Overview](/docs/monetization/overview) for more infor | APPLICATION_SUBSCRIPTION | 8 | Entitlement was purchased as an app subscription | ## List Entitlements -/applications/[\{application.id\}](/docs/resources/application#application-object)/entitlements +/applications/[\{application.id\}](/docs/resources/application#application-object)/entitlements Returns all entitlements for a given app, active and expired. @@ -97,7 +97,7 @@ Returns all entitlements for a given app, active and expired. ``` ## Get Entitlement -/applications/[\{application.id\}](/docs/resources/application#application-object)/entitlements/[\{entitlement.id\}](/docs/resources/entitlement#entitlement-object) +/applications/[\{application.id\}](/docs/resources/application#application-object)/entitlements/[\{entitlement.id\}](/docs/resources/entitlement#entitlement-object) Returns an entitlement. @@ -120,14 +120,14 @@ Returns an entitlement. ``` ## Consume an Entitlement -/applications/[\{application.id\}](/docs/resources/application#application-object)/entitlements/[\{entitlement.id\}](/docs/resources/entitlement#entitlement-object)/consume +/applications/[\{application.id\}](/docs/resources/application#application-object)/entitlements/[\{entitlement.id\}](/docs/resources/entitlement#entitlement-object)/consume For One-Time Purchase consumable SKUs, marks a given entitlement for the user as consumed. The entitlement will have `consumed: true` when using [List Entitlements](/docs/resources/entitlement#list-entitlements). Returns a `204 No Content` on success. ## Create Test Entitlement -/applications/[\{application.id\}](/docs/resources/application#application-object)/entitlements +/applications/[\{application.id\}](/docs/resources/application#application-object)/entitlements Creates a test entitlement to a given SKU for a given guild or user. Discord will act as though that user or guild has entitlement to your premium offering. @@ -152,7 +152,7 @@ After creating a test entitlement, you'll need to reload your Discord client. Af ``` ## Delete Test Entitlement -/applications/[\{application.id\}](/docs/resources/application#application-object)/entitlements/[\{entitlement.id\}](/docs/resources/entitlement#entitlement-object) +/applications/[\{application.id\}](/docs/resources/application#application-object)/entitlements/[\{entitlement.id\}](/docs/resources/entitlement#entitlement-object) Deletes a currently-active test entitlement. Discord will act as though that user or guild _no longer has_ entitlement to your premium offering. diff --git a/docs/resources/guild-scheduled-event.mdx b/docs/resources/guild-scheduled-event.mdx index d9321bc70c..20a1f8612c 100644 --- a/docs/resources/guild-scheduled-event.mdx +++ b/docs/resources/guild-scheduled-event.mdx @@ -261,7 +261,7 @@ by_month_day = [24] | DECEMBER | 12 | ## List Scheduled Events for Guild -/guilds/[\{guild.id\}](/docs/resources/guild#guild-object)/scheduled-events +/guilds/[\{guild.id\}](/docs/resources/guild#guild-object)/scheduled-events Returns a list of [guild scheduled event](/docs/resources/guild-scheduled-event#guild-scheduled-event-object) objects for the given guild. @@ -272,7 +272,7 @@ Returns a list of [guild scheduled event](/docs/resources/guild-scheduled-event# | with_user_count? | [boolean](/docs/reference#boolean-query-strings) | include number of users subscribed to each event | ## Create Guild Scheduled Event -/guilds/[\{guild.id\}](/docs/resources/guild#guild-object)/scheduled-events +/guilds/[\{guild.id\}](/docs/resources/guild#guild-object)/scheduled-events Create a guild scheduled event in the guild. Returns a [guild scheduled event](/docs/resources/guild-scheduled-event#guild-scheduled-event-object) object on success. Fires a [Guild Scheduled Event Create](/docs/events/gateway-events#guild-scheduled-event-create) Gateway event. @@ -305,7 +305,7 @@ This endpoint supports the `X-Audit-Log-Reason` header. \*\* Required for events with `'entity_type': EXTERNAL` ## Get Guild Scheduled Event -/guilds/[\{guild.id\}](/docs/resources/guild#guild-object)/scheduled-events/[\{guild_scheduled_event.id\}](/docs/resources/guild-scheduled-event#guild-scheduled-event-object) +/guilds/[\{guild.id\}](/docs/resources/guild#guild-object)/scheduled-events/[\{guild_scheduled_event.id\}](/docs/resources/guild-scheduled-event#guild-scheduled-event-object) Get a guild scheduled event. Returns a [guild scheduled event](/docs/resources/guild-scheduled-event#guild-scheduled-event-object) object on success. @@ -316,7 +316,7 @@ Get a guild scheduled event. Returns a [guild scheduled event](/docs/resources/g | with_user_count? | [boolean](/docs/reference#boolean-query-strings) | include number of users subscribed to this event | ## Modify Guild Scheduled Event -/guilds/[\{guild.id\}](/docs/resources/guild#guild-object)/scheduled-events/[\{guild_scheduled_event.id\}](/docs/resources/guild-scheduled-event#guild-scheduled-event-object) +/guilds/[\{guild.id\}](/docs/resources/guild#guild-object)/scheduled-events/[\{guild_scheduled_event.id\}](/docs/resources/guild-scheduled-event#guild-scheduled-event-object) Modify a guild scheduled event. Returns the modified [guild scheduled event](/docs/resources/guild-scheduled-event#guild-scheduled-event-object) object on success. Fires a [Guild Scheduled Event Update](/docs/events/gateway-events#guild-scheduled-event-update) Gateway event. @@ -360,12 +360,12 @@ All parameters to this endpoint are optional - `scheduled_end_time` must be provided ## Delete Guild Scheduled Event -/guilds/[\{guild.id\}](/docs/resources/guild#guild-object)/scheduled-events/[\{guild_scheduled_event.id\}](/docs/resources/guild-scheduled-event#guild-scheduled-event-object) +/guilds/[\{guild.id\}](/docs/resources/guild#guild-object)/scheduled-events/[\{guild_scheduled_event.id\}](/docs/resources/guild-scheduled-event#guild-scheduled-event-object) Delete a guild scheduled event. Returns a `204` on success. Fires a [Guild Scheduled Event Delete](/docs/events/gateway-events#guild-scheduled-event-delete) Gateway event. ## Get Guild Scheduled Event Users -/guilds/[\{guild.id\}](/docs/resources/guild#guild-object)/scheduled-events/[\{guild_scheduled_event.id\}](/docs/resources/guild-scheduled-event#guild-scheduled-event-object)/users +/guilds/[\{guild.id\}](/docs/resources/guild#guild-object)/scheduled-events/[\{guild_scheduled_event.id\}](/docs/resources/guild-scheduled-event#guild-scheduled-event-object)/users Get a list of guild scheduled event users subscribed to a guild scheduled event. Returns a list of [guild scheduled event user](/docs/resources/guild-scheduled-event#guild-scheduled-event-user-object) objects on success. Guild member data, if it exists, is included if the `with_member` query parameter is set. diff --git a/docs/resources/guild-template.mdx b/docs/resources/guild-template.mdx index 90e139a71a..e0c37319c3 100644 --- a/docs/resources/guild-template.mdx +++ b/docs/resources/guild-template.mdx @@ -100,12 +100,12 @@ Represents a code that when used, creates a guild based on a snapshot of an exis ``` ## Get Guild Template -/guilds/templates/[\{template.code\}](/docs/resources/guild-template#guild-template-object) +/guilds/templates/[\{template.code\}](/docs/resources/guild-template#guild-template-object) Returns a [guild template](/docs/resources/guild-template#guild-template-object) object for the given code. ## Create Guild from Guild Template -/guilds/templates/[\{template.code\}](/docs/resources/guild-template#guild-template-object) +/guilds/templates/[\{template.code\}](/docs/resources/guild-template#guild-template-object) Create a new guild based on a template. Returns a [guild](/docs/resources/guild#guild-object) object on success. Fires a [Guild Create](/docs/events/gateway-events#guild-create) Gateway event. @@ -121,12 +121,12 @@ This endpoint can be used only by bots in less than 10 guilds. | icon? | [image data](/docs/reference#image-data) | base64 128x128 image for the guild icon | ## Get Guild Templates -/guilds/[\{guild.id\}](/docs/resources/guild#guild-object)/templates +/guilds/[\{guild.id\}](/docs/resources/guild#guild-object)/templates Returns an array of [guild template](/docs/resources/guild-template#guild-template-object) objects. Requires the `MANAGE_GUILD` permission. ## Create Guild Template -/guilds/[\{guild.id\}](/docs/resources/guild#guild-object)/templates +/guilds/[\{guild.id\}](/docs/resources/guild#guild-object)/templates Creates a template for the guild. Requires the `MANAGE_GUILD` permission. Returns the created [guild template](/docs/resources/guild-template#guild-template-object) object on success. @@ -138,12 +138,12 @@ Creates a template for the guild. Requires the `MANAGE_GUILD` permission. Return | description? | ?string | description for the template (0-120 characters) | ## Sync Guild Template -/guilds/[\{guild.id\}](/docs/resources/guild#guild-object)/templates/[\{template.code\}](/docs/resources/guild-template#guild-template-object) +/guilds/[\{guild.id\}](/docs/resources/guild#guild-object)/templates/[\{template.code\}](/docs/resources/guild-template#guild-template-object) Syncs the template to the guild's current state. Requires the `MANAGE_GUILD` permission. Returns the [guild template](/docs/resources/guild-template#guild-template-object) object on success. ## Modify Guild Template -/guilds/[\{guild.id\}](/docs/resources/guild#guild-object)/templates/[\{template.code\}](/docs/resources/guild-template#guild-template-object) +/guilds/[\{guild.id\}](/docs/resources/guild#guild-object)/templates/[\{template.code\}](/docs/resources/guild-template#guild-template-object) Modifies the template's metadata. Requires the `MANAGE_GUILD` permission. Returns the [guild template](/docs/resources/guild-template#guild-template-object) object on success. @@ -155,6 +155,6 @@ Modifies the template's metadata. Requires the `MANAGE_GUILD` permission. Return | description? | ?string | description for the template (0-120 characters) | ## Delete Guild Template -/guilds/[\{guild.id\}](/docs/resources/guild#guild-object)/templates/[\{template.code\}](/docs/resources/guild-template#guild-template-object) +/guilds/[\{guild.id\}](/docs/resources/guild#guild-object)/templates/[\{template.code\}](/docs/resources/guild-template#guild-template-object) Deletes the template. Requires the `MANAGE_GUILD` permission. Returns the deleted [guild template](/docs/resources/guild-template#guild-template-object) object on success. diff --git a/docs/resources/guild.mdx b/docs/resources/guild.mdx index 52ee8f8e3d..182dca781f 100644 --- a/docs/resources/guild.mdx +++ b/docs/resources/guild.mdx @@ -694,7 +694,7 @@ We are making significant changes to the Membership Screening API specifically r ``` ## Create Guild -/guilds +/guilds Create a new guild. Returns a [guild](/docs/resources/guild#guild-object) object on success. Fires a [Guild Create](/docs/events/gateway-events#guild-create) Gateway event. @@ -765,7 +765,7 @@ The `region` field is deprecated and is replaced by [channel.rtc_region](/docs/r ``` ## Get Guild -/guilds/[\{guild.id\}](/docs/resources/guild#guild-object) +/guilds/[\{guild.id\}](/docs/resources/guild#guild-object) Returns the [guild](/docs/resources/guild#guild-object) object for the given id. If `with_counts` is set to `true`, this endpoint will also return `approximate_member_count` and `approximate_presence_count` for the guild. @@ -847,13 +847,13 @@ Returns the [guild](/docs/resources/guild#guild-object) object for the given id. ``` ## Get Guild Preview -/guilds/[\{guild.id\}](/docs/resources/guild#guild-object)/preview +/guilds/[\{guild.id\}](/docs/resources/guild#guild-object)/preview Returns the [guild preview](/docs/resources/guild#guild-preview-object) object for the given id. If the user is not in the guild, then the guild must be [discoverable](/docs/resources/guild#guild-object-guild-features). ## Modify Guild -/guilds/[\{guild.id\}](/docs/resources/guild#guild-object) +/guilds/[\{guild.id\}](/docs/resources/guild#guild-object) Modify a guild's settings. Requires the `MANAGE_GUILD` permission. Returns the updated [guild](/docs/resources/guild#guild-object) object on success. Fires a [Guild Update](/docs/events/gateway-events#guild-update) Gateway event. @@ -896,17 +896,17 @@ Attempting to add or remove the `COMMUNITY` [guild feature](/docs/resources/guil | safety_alerts_channel_id | ?snowflake | the id of the channel where admins and moderators of Community guilds receive safety alerts from Discord | ## Delete Guild -/guilds/[\{guild.id\}](/docs/resources/guild#guild-object) +/guilds/[\{guild.id\}](/docs/resources/guild#guild-object) Delete a guild permanently. User must be owner. Returns `204 No Content` on success. Fires a [Guild Delete](/docs/events/gateway-events#guild-delete) Gateway event. ## Get Guild Channels -/guilds/[\{guild.id\}](/docs/resources/guild#guild-object)/channels +/guilds/[\{guild.id\}](/docs/resources/guild#guild-object)/channels Returns a list of guild [channel](/docs/resources/channel#channel-object) objects. Does not include threads. ## Create Guild Channel -/guilds/[\{guild.id\}](/docs/resources/guild#guild-object)/channels +/guilds/[\{guild.id\}](/docs/resources/guild#guild-object)/channels Create a new [channel](/docs/resources/channel#channel-object) object for the guild. Requires the `MANAGE_CHANNELS` permission. If setting permission overwrites, only permissions your bot has in the guild can be allowed/denied. Setting `MANAGE_ROLES` permission in channels is only possible for guild administrators. Returns the new [channel](/docs/resources/channel#channel-object) object on success. Fires a [Channel Create](/docs/events/gateway-events#channel-create) Gateway event. @@ -946,7 +946,7 @@ This endpoint supports the `X-Audit-Log-Reason` header. \*\* In each overwrite object, the `allow` and `deny` keys can be omitted or set to `null`, which both default to `"0"`. ## Modify Guild Channel Positions -/guilds/[\{guild.id\}](/docs/resources/guild#guild-object)/channels +/guilds/[\{guild.id\}](/docs/resources/guild#guild-object)/channels Modify the positions of a set of [channel](/docs/resources/channel#channel-object) objects for the guild. Requires `MANAGE_CHANNELS` permission. Returns a 204 empty response on success. Fires multiple [Channel Update](/docs/events/gateway-events#channel-update) Gateway events. @@ -966,7 +966,7 @@ This endpoint takes a JSON array of parameters in the following format: | parent_id? | ?snowflake | the new parent ID for the channel that is moved | ## List Active Guild Threads -/guilds/[\{guild.id\}](/docs/resources/guild#guild-object)/threads/active +/guilds/[\{guild.id\}](/docs/resources/guild#guild-object)/threads/active Returns all active threads in the guild, including public and private threads. Threads are ordered by their `id`, in descending order. @@ -978,12 +978,12 @@ Returns all active threads in the guild, including public and private threads. T | members | array of [thread members](/docs/resources/channel#thread-member-object) objects | a thread member object for each returned thread the current user has joined | ## Get Guild Member -/guilds/[\{guild.id\}](/docs/resources/guild#guild-object)/members/[\{user.id\}](/docs/resources/user#user-object) +/guilds/[\{guild.id\}](/docs/resources/guild#guild-object)/members/[\{user.id\}](/docs/resources/user#user-object) Returns a [guild member](/docs/resources/guild#guild-member-object) object for the specified user. ## List Guild Members -/guilds/[\{guild.id\}](/docs/resources/guild#guild-object)/members +/guilds/[\{guild.id\}](/docs/resources/guild#guild-object)/members Returns a list of [guild member](/docs/resources/guild#guild-member-object) objects that are members of the guild. @@ -1003,7 +1003,7 @@ All parameters to this endpoint are optional | after | snowflake | the highest user id in the previous page | 0 | ## Search Guild Members -/guilds/[\{guild.id\}](/docs/resources/guild#guild-object)/members/search +/guilds/[\{guild.id\}](/docs/resources/guild#guild-object)/members/search Returns a list of [guild member](/docs/resources/guild#guild-member-object) objects whose username or nickname starts with a provided string. @@ -1019,7 +1019,7 @@ All parameters to this endpoint except for `query` are optional | limit | integer | max number of members to return (1-1000) | 1 | ## Add Guild Member -/guilds/[\{guild.id\}](/docs/resources/guild#guild-object)/members/[\{user.id\}](/docs/resources/user#user-object) +/guilds/[\{guild.id\}](/docs/resources/guild#guild-object)/members/[\{user.id\}](/docs/resources/user#user-object) Adds a user to the guild, provided you have a valid oauth2 access token for the user with the `guilds.join` scope. Returns a 201 Created with the [guild member](/docs/resources/guild#guild-member-object) as the body, or 204 No Content if the user is already a member of the guild. Fires a [Guild Member Add](/docs/events/gateway-events#guild-member-add) Gateway event. @@ -1045,7 +1045,7 @@ The Authorization header must be a Bot token (belonging to the same application ## Modify Guild Member -/guilds/[\{guild.id\}](/docs/resources/guild#guild-object)/members/[\{user.id\}](/docs/resources/user#user-object) +/guilds/[\{guild.id\}](/docs/resources/guild#guild-object)/members/[\{user.id\}](/docs/resources/user#user-object) Modify attributes of a [guild member](/docs/resources/guild#guild-member-object). Returns a 200 OK with the [guild member](/docs/resources/guild#guild-member-object) as the body. Fires a [Guild Member Update](/docs/events/gateway-events#guild-member-update) Gateway event. If the `channel_id` is set to null, this will force the target user to be disconnected from voice. @@ -1070,7 +1070,7 @@ This endpoint supports the `X-Audit-Log-Reason` header. | flags | integer | [guild member flags](/docs/resources/guild#guild-member-object-guild-member-flags) | MANAGE_GUILD or MANAGE_ROLES or (MODERATE_MEMBERS and KICK_MEMBERS and BAN_MEMBERS) | ## Modify Current Member -/guilds/[\{guild.id\}](/docs/resources/guild#guild-object)/members/@me +/guilds/[\{guild.id\}](/docs/resources/guild#guild-object)/members/@me Modifies the current member in a guild. Returns a 200 with the updated member object on success. Fires a [Guild Member Update](/docs/events/gateway-events#guild-member-update) Gateway event. @@ -1085,7 +1085,7 @@ This endpoint supports the `X-Audit-Log-Reason` header. | nick? | ?string | value to set user's nickname to | CHANGE_NICKNAME | ## Modify Current User Nick -/guilds/[\{guild.id\}](/docs/resources/guild#guild-object)/members/@me/nick +/guilds/[\{guild.id\}](/docs/resources/guild#guild-object)/members/@me/nick :::danger Deprecated in favor of [Modify Current Member](/docs/resources/guild#modify-current-member). @@ -1104,7 +1104,7 @@ This endpoint supports the `X-Audit-Log-Reason` header. | nick? | ?string | value to set user's nickname to | CHANGE_NICKNAME | ## Add Guild Member Role -/guilds/[\{guild.id\}](/docs/resources/guild#guild-object)/members/[\{user.id\}](/docs/resources/user#user-object)/roles/[\{role.id\}](/docs/topics/permissions#role-object) +/guilds/[\{guild.id\}](/docs/resources/guild#guild-object)/members/[\{user.id\}](/docs/resources/user#user-object)/roles/[\{role.id\}](/docs/topics/permissions#role-object) Adds a role to a [guild member](/docs/resources/guild#guild-member-object). Requires the `MANAGE_ROLES` permission. Returns a 204 empty response on success. Fires a [Guild Member Update](/docs/events/gateway-events#guild-member-update) Gateway event. @@ -1113,7 +1113,7 @@ This endpoint supports the `X-Audit-Log-Reason` header. ::: ## Remove Guild Member Role -/guilds/[\{guild.id\}](/docs/resources/guild#guild-object)/members/[\{user.id\}](/docs/resources/user#user-object)/roles/[\{role.id\}](/docs/topics/permissions#role-object) +/guilds/[\{guild.id\}](/docs/resources/guild#guild-object)/members/[\{user.id\}](/docs/resources/user#user-object)/roles/[\{role.id\}](/docs/topics/permissions#role-object) Removes a role from a [guild member](/docs/resources/guild#guild-member-object). Requires the `MANAGE_ROLES` permission. Returns a 204 empty response on success. Fires a [Guild Member Update](/docs/events/gateway-events#guild-member-update) Gateway event. @@ -1122,7 +1122,7 @@ This endpoint supports the `X-Audit-Log-Reason` header. ::: ## Remove Guild Member -/guilds/[\{guild.id\}](/docs/resources/guild#guild-object)/members/[\{user.id\}](/docs/resources/user#user-object) +/guilds/[\{guild.id\}](/docs/resources/guild#guild-object)/members/[\{user.id\}](/docs/resources/user#user-object) Remove a member from a guild. Requires `KICK_MEMBERS` permission. Returns a 204 empty response on success. Fires a [Guild Member Remove](/docs/events/gateway-events#guild-member-remove) Gateway event. @@ -1131,7 +1131,7 @@ This endpoint supports the `X-Audit-Log-Reason` header. ::: ## Get Guild Bans -/guilds/[\{guild.id\}](/docs/resources/guild#guild-object)/bans +/guilds/[\{guild.id\}](/docs/resources/guild#guild-object)/bans Returns a list of [ban](/docs/resources/guild#ban-object) objects for the users banned from this guild. Requires the `BAN_MEMBERS` permission. @@ -1146,12 +1146,12 @@ Returns a list of [ban](/docs/resources/guild#ban-object) objects for the users \* Provide a user id to `before` and `after` for pagination. Users will always be returned in ascending order by `user.id`. If both `before` and `after` are provided, only `before` is respected. ## Get Guild Ban -/guilds/[\{guild.id\}](/docs/resources/guild#guild-object)/bans/[\{user.id\}](/docs/resources/user#user-object) +/guilds/[\{guild.id\}](/docs/resources/guild#guild-object)/bans/[\{user.id\}](/docs/resources/user#user-object) Returns a [ban](/docs/resources/guild#ban-object) object for the given user or a 404 not found if the ban cannot be found. Requires the `BAN_MEMBERS` permission. ## Create Guild Ban -/guilds/[\{guild.id\}](/docs/resources/guild#guild-object)/bans/[\{user.id\}](/docs/resources/user#user-object) +/guilds/[\{guild.id\}](/docs/resources/guild#guild-object)/bans/[\{user.id\}](/docs/resources/user#user-object) Create a guild ban, and optionally delete previous messages sent by the banned user. Requires the `BAN_MEMBERS` permission. Returns a 204 empty response on success. Fires a [Guild Ban Add](/docs/events/gateway-events#guild-ban-add) Gateway event. @@ -1167,7 +1167,7 @@ This endpoint supports the `X-Audit-Log-Reason` header. | delete_message_seconds? | integer | number of seconds to delete messages for, between 0 and 604800 (7 days) | 0 | ## Remove Guild Ban -/guilds/[\{guild.id\}](/docs/resources/guild#guild-object)/bans/[\{user.id\}](/docs/resources/user#user-object) +/guilds/[\{guild.id\}](/docs/resources/guild#guild-object)/bans/[\{user.id\}](/docs/resources/user#user-object) Remove the ban for a user. Requires the `BAN_MEMBERS` permissions. Returns a 204 empty response on success. Fires a [Guild Ban Remove](/docs/events/gateway-events#guild-ban-remove) Gateway event. @@ -1176,7 +1176,7 @@ This endpoint supports the `X-Audit-Log-Reason` header. ::: ## Bulk Guild Ban -/guilds/[\{guild.id\}](/docs/resources/guild#guild-object)/bulk-ban +/guilds/[\{guild.id\}](/docs/resources/guild#guild-object)/bulk-ban Ban up to 200 users from a guild, and optionally delete previous messages sent by the banned users. Requires both the `BAN_MEMBERS` and `MANAGE_GUILD` permissions. Returns a 200 response on success, including the fields `banned_users` with the IDs of the banned users and `failed_users` with IDs that could not be banned or were already banned. @@ -1205,17 +1205,17 @@ If none of the users could be banned, an error response code `500000: Failed to ::: ## Get Guild Roles -/guilds/[\{guild.id\}](/docs/resources/guild#guild-object)/roles +/guilds/[\{guild.id\}](/docs/resources/guild#guild-object)/roles Returns a list of [role](/docs/topics/permissions#role-object) objects for the guild. ## Get Guild Role -/guilds/[\{guild.id\}](/docs/resources/guild#guild-object)/roles/[\{role.id\}](/docs/topics/permissions#role-object) +/guilds/[\{guild.id\}](/docs/resources/guild#guild-object)/roles/[\{role.id\}](/docs/topics/permissions#role-object) Returns a [role](/docs/topics/permissions#role-object) object for the specified role. ## Create Guild Role -/guilds/[\{guild.id\}](/docs/resources/guild#guild-object)/roles +/guilds/[\{guild.id\}](/docs/resources/guild#guild-object)/roles Create a new [role](/docs/topics/permissions#role-object) for the guild. Requires the `MANAGE_ROLES` permission. Returns the new [role](/docs/topics/permissions#role-object) object on success. Fires a [Guild Role Create](/docs/events/gateway-events#guild-role-create) Gateway event. All JSON params are optional. @@ -1236,7 +1236,7 @@ This endpoint supports the `X-Audit-Log-Reason` header. | mentionable | boolean | whether the role should be mentionable | false | ## Modify Guild Role Positions -/guilds/[\{guild.id\}](/docs/resources/guild#guild-object)/roles +/guilds/[\{guild.id\}](/docs/resources/guild#guild-object)/roles Modify the positions of a set of [role](/docs/topics/permissions#role-object) objects for the guild. Requires the `MANAGE_ROLES` permission. Returns a list of all of the guild's [role](/docs/topics/permissions#role-object) objects on success. Fires multiple [Guild Role Update](/docs/events/gateway-events#guild-role-update) Gateway events. @@ -1254,7 +1254,7 @@ This endpoint takes a JSON array of parameters in the following format: | position? | ?integer | sorting position of the role (roles with the same position are sorted by id) | ## Modify Guild Role -/guilds/[\{guild.id\}](/docs/resources/guild#guild-object)/roles/[\{role.id\}](/docs/topics/permissions#role-object) +/guilds/[\{guild.id\}](/docs/resources/guild#guild-object)/roles/[\{role.id\}](/docs/topics/permissions#role-object) Modify a guild role. Requires the `MANAGE_ROLES` permission. Returns the updated [role](/docs/topics/permissions#role-object) on success. Fires a [Guild Role Update](/docs/events/gateway-events#guild-role-update) Gateway event. @@ -1279,7 +1279,7 @@ This endpoint supports the `X-Audit-Log-Reason` header. | mentionable | boolean | whether the role should be mentionable | ## Modify Guild MFA Level -/guilds/[\{guild.id\}](/docs/resources/guild#guild-object)/mfa +/guilds/[\{guild.id\}](/docs/resources/guild#guild-object)/mfa Modify a guild's MFA level. Requires guild ownership. Returns the updated [level](/docs/resources/guild#guild-object-mfa-level) on success. Fires a [Guild Update](/docs/events/gateway-events#guild-update) Gateway event. @@ -1294,7 +1294,7 @@ This endpoint supports the `X-Audit-Log-Reason` header. | level | integer | [MFA level](/docs/resources/guild#guild-object-mfa-level) | ## Delete Guild Role -/guilds/[\{guild.id\}](/docs/resources/guild#guild-object)/roles/[\{role.id\}](/docs/topics/permissions#role-object) +/guilds/[\{guild.id\}](/docs/resources/guild#guild-object)/roles/[\{role.id\}](/docs/topics/permissions#role-object) Delete a guild role. Requires the `MANAGE_ROLES` permission. Returns a 204 empty response on success. Fires a [Guild Role Delete](/docs/events/gateway-events#guild-role-delete) Gateway event. @@ -1303,7 +1303,7 @@ This endpoint supports the `X-Audit-Log-Reason` header. ::: ## Get Guild Prune Count -/guilds/[\{guild.id\}](/docs/resources/guild#guild-object)/prune +/guilds/[\{guild.id\}](/docs/resources/guild#guild-object)/prune Returns an object with one `pruned` key indicating the number of members that would be removed in a prune operation. Requires the `MANAGE_GUILD` and `KICK_MEMBERS` permissions. @@ -1317,7 +1317,7 @@ By default, prune will not remove users with roles. You can optionally include s | include_roles | string; comma-delimited array of snowflakes | role(s) to include | none | ## Begin Guild Prune -/guilds/[\{guild.id\}](/docs/resources/guild#guild-object)/prune +/guilds/[\{guild.id\}](/docs/resources/guild#guild-object)/prune Begin a prune operation. Requires the `MANAGE_GUILD` and `KICK_MEMBERS` permissions. Returns an object with one `pruned` key indicating the number of members that were removed in the prune operation. For large guilds it's recommended to set the `compute_prune_count` option to `false`, forcing `pruned` to `null`. Fires multiple [Guild Member Remove](/docs/events/gateway-events#guild-member-remove) Gateway events. @@ -1337,17 +1337,17 @@ This endpoint supports the `X-Audit-Log-Reason` header. | reason? | string | reason for the prune (deprecated) | | ## Get Guild Voice Regions -/guilds/[\{guild.id\}](/docs/resources/guild#guild-object)/regions +/guilds/[\{guild.id\}](/docs/resources/guild#guild-object)/regions Returns a list of [voice region](/docs/resources/voice#voice-region-object) objects for the guild. Unlike the similar `/voice` route, this returns VIP servers when the guild is VIP-enabled. ## Get Guild Invites -/guilds/[\{guild.id\}](/docs/resources/guild#guild-object)/invites +/guilds/[\{guild.id\}](/docs/resources/guild#guild-object)/invites Returns a list of [invite](/docs/resources/invite#invite-object) objects (with [invite metadata](/docs/resources/invite#invite-metadata-object)) for the guild. Requires the `MANAGE_GUILD` permission. ## Get Guild Integrations -/guilds/[\{guild.id\}](/docs/resources/guild#guild-object)/integrations +/guilds/[\{guild.id\}](/docs/resources/guild#guild-object)/integrations Returns a list of [integration](/docs/resources/guild#integration-object) objects for the guild. Requires the `MANAGE_GUILD` permission. @@ -1356,7 +1356,7 @@ This endpoint returns a maximum of 50 integrations. If a guild has more integrat ::: ## Delete Guild Integration -/guilds/[\{guild.id\}](/docs/resources/guild#guild-object)/integrations/[\{integration.id\}](/docs/resources/guild#integration-object) +/guilds/[\{guild.id\}](/docs/resources/guild#guild-object)/integrations/[\{integration.id\}](/docs/resources/guild#integration-object) Delete the attached [integration](/docs/resources/guild#integration-object) object for the guild. Deletes any associated webhooks and kicks the associated bot if there is one. Requires the `MANAGE_GUILD` permission. Returns a 204 empty response on success. Fires [Guild Integrations Update](/docs/events/gateway-events#guild-integrations-update) and [Integration Delete](/docs/events/gateway-events#integration-delete) Gateway events. @@ -1365,12 +1365,12 @@ This endpoint supports the `X-Audit-Log-Reason` header. ::: ## Get Guild Widget Settings -/guilds/[\{guild.id\}](/docs/resources/guild#guild-object)/widget +/guilds/[\{guild.id\}](/docs/resources/guild#guild-object)/widget Returns a [guild widget settings](/docs/resources/guild#guild-widget-settings-object) object. Requires the `MANAGE_GUILD` permission. ## Modify Guild Widget -/guilds/[\{guild.id\}](/docs/resources/guild#guild-object)/widget +/guilds/[\{guild.id\}](/docs/resources/guild#guild-object)/widget Modify a [guild widget settings](/docs/resources/guild#guild-widget-settings-object) object for the guild. All attributes may be passed in with JSON and modified. Requires the `MANAGE_GUILD` permission. Returns the updated [guild widget settings](/docs/resources/guild#guild-widget-settings-object) object. Fires a [Guild Update](/docs/events/gateway-events#guild-update) Gateway event. @@ -1379,12 +1379,12 @@ This endpoint supports the `X-Audit-Log-Reason` header. ::: ## Get Guild Widget -/guilds/[\{guild.id\}](/docs/resources/guild#guild-object)/widget.json +/guilds/[\{guild.id\}](/docs/resources/guild#guild-object)/widget.json Returns the [widget](/docs/resources/guild#guild-widget-object) for the guild. Fires an [Invite Create](/docs/events/gateway-events#invite-create) Gateway event when an invite channel is defined and a new [Invite](/docs/resources/invite#invite-object) is generated. ## Get Guild Vanity URL -/guilds/[\{guild.id\}](/docs/resources/guild#guild-object)/vanity-url +/guilds/[\{guild.id\}](/docs/resources/guild#guild-object)/vanity-url Returns a partial [invite](/docs/resources/invite#invite-object) object for guilds with that feature enabled. Requires the `MANAGE_GUILD` permission. `code` will be null if a vanity url for the guild is not set. @@ -1402,7 +1402,7 @@ This endpoint is required to get the usage count of the vanity invite, but the i ``` ## Get Guild Widget Image -/guilds/[\{guild.id\}](/docs/resources/guild#guild-object)/widget.png +/guilds/[\{guild.id\}](/docs/resources/guild#guild-object)/widget.png Returns a PNG image widget for the guild. Requires no permissions or authentication. @@ -1427,12 +1427,12 @@ All parameters to this endpoint are optional. | banner4 | large Discord logo at the top of the widget. Guild icon, name and online count in the middle portion of the widget and a "JOIN MY SERVER" button at the bottom | [Example](https://discord.com/api/guilds/81384788765712384/widget.png?style=banner4) | ## Get Guild Welcome Screen -/guilds/[\{guild.id\}](/docs/resources/guild#guild-object)/welcome-screen +/guilds/[\{guild.id\}](/docs/resources/guild#guild-object)/welcome-screen Returns the [Welcome Screen](/docs/resources/guild#welcome-screen-object) object for the guild. If the welcome screen is not enabled, the `MANAGE_GUILD` permission is required. ## Modify Guild Welcome Screen -/guilds/[\{guild.id\}](/docs/resources/guild#guild-object)/welcome-screen +/guilds/[\{guild.id\}](/docs/resources/guild#guild-object)/welcome-screen Modify the guild's [Welcome Screen](/docs/resources/guild#welcome-screen-object). Requires the `MANAGE_GUILD` permission. Returns the updated [Welcome Screen](/docs/resources/guild#welcome-screen-object) object. May fire a [Guild Update](/docs/events/gateway-events#guild-update) Gateway event. @@ -1453,12 +1453,12 @@ This endpoint supports the `X-Audit-Log-Reason` header. | description | string | the server description to show in the welcome screen | ## Get Guild Onboarding -/guilds/[\{guild.id\}](/docs/resources/guild#guild-object)/onboarding +/guilds/[\{guild.id\}](/docs/resources/guild#guild-object)/onboarding Returns the [Onboarding](/docs/resources/guild#guild-onboarding-object) object for the guild. ## Modify Guild Onboarding -/guilds/[\{guild.id\}](/docs/resources/guild#guild-object)/onboarding +/guilds/[\{guild.id\}](/docs/resources/guild#guild-object)/onboarding Modifies the onboarding configuration of the guild. Returns a 200 with the [Onboarding](/docs/resources/guild#guild-onboarding-object) object for the guild. Requires the `MANAGE_GUILD` and `MANAGE_ROLES` permissions. @@ -1480,7 +1480,7 @@ This endpoint supports the `X-Audit-Log-Reason` header. | mode | [onboarding mode](/docs/resources/guild#guild-onboarding-object-onboarding-mode) | Current mode of onboarding | ## Modify Guild Incident Actions -/guilds/[\{guild.id\}](/docs/resources/guild#guild-object)/incident-actions +/guilds/[\{guild.id\}](/docs/resources/guild#guild-object)/incident-actions Modifies the incident actions of the guild. Returns a 200 with the [Incidents Data](/docs/resources/guild#incidents-data-object) object for the guild. Requires the `MANAGE_GUILD` permission. diff --git a/docs/resources/invite.mdx b/docs/resources/invite.mdx index 892d6320b9..a9f8aa8ceb 100644 --- a/docs/resources/invite.mdx +++ b/docs/resources/invite.mdx @@ -146,7 +146,7 @@ This is deprecated. ``` ## Get Invite -/invites/[\{invite.code\}](/docs/resources/invite#invite-object) +/invites/[\{invite.code\}](/docs/resources/invite#invite-object) Returns an [invite](/docs/resources/invite#invite-object) object for the given code. @@ -159,7 +159,7 @@ Returns an [invite](/docs/resources/invite#invite-object) object for the given c | guild_scheduled_event_id? | snowflake | the guild scheduled event to include with the invite | ## Delete Invite -/invites/[\{invite.code\}](/docs/resources/invite#invite-object) +/invites/[\{invite.code\}](/docs/resources/invite#invite-object) Delete an invite. Requires the `MANAGE_CHANNELS` permission on the channel this invite belongs to, or `MANAGE_GUILD` to remove any invite across the guild. Returns an [invite](/docs/resources/invite#invite-object) object on success. Fires an [Invite Delete](/docs/events/gateway-events#invite-delete) Gateway event. diff --git a/docs/resources/lobby.mdx b/docs/resources/lobby.mdx index 6472cf1e75..e82d3d533c 100644 --- a/docs/resources/lobby.mdx +++ b/docs/resources/lobby.mdx @@ -57,7 +57,7 @@ Represents a member of a lobby, including optional metadata and flags. ``` ## Create Lobby -/lobbies +/lobbies Creates a new lobby, adding any of the specified members to it, if provided. @@ -84,12 +84,12 @@ Returns a [lobby](/docs/resources/lobby#lobby-object) object. | flags? | integer | [lobby member flags](/docs/resources/lobby#lobby-member-object-lobby-member-flags) combined as a [bitfield](https://en.wikipedia.org/wiki/Bit_field) | ## Get Lobby -/lobbies/[\{lobby.id\}](/docs/resources/lobby#lobby-object) +/lobbies/[\{lobby.id\}](/docs/resources/lobby#lobby-object) Returns a [lobby](/docs/resources/lobby#lobby-object) object for the specified lobby id, if it exists. ## Modify Lobby -/lobbies/[\{lobby.id\}](/docs/resources/lobby#lobby-object) +/lobbies/[\{lobby.id\}](/docs/resources/lobby#lobby-object) Modifies the specified lobby with new values, if provided. @@ -104,7 +104,7 @@ Returns the updated [lobby](/docs/resources/lobby#lobby-object) object. | idle_timeout_seconds? | integer | seconds to wait before shutting down a lobby after it becomes idle. Value can be between 5 and 604800 (7 days). See [`LobbyHandle`] for more details on this behavior. | ## Delete Lobby -/lobbies/[\{lobby.id\}](/docs/resources/lobby#lobby-object) +/lobbies/[\{lobby.id\}](/docs/resources/lobby#lobby-object) Deletes the specified lobby if it exists. @@ -113,7 +113,7 @@ It is safe to call even if the lobby is already deleted as well. Returns nothing. ## Add a Member to a Lobby -/lobbies/[\{lobby.id\}](/docs/resources/lobby#lobby-object)/members/[\{user.id\}](/docs/resources/user#user-object) +/lobbies/[\{lobby.id\}](/docs/resources/lobby#lobby-object)/members/[\{user.id\}](/docs/resources/user#user-object) Adds the provided user to the specified lobby. If called when the user is already a member of the lobby will update fields such as metadata on that user instead. @@ -127,14 +127,14 @@ Returns the [lobby member](/docs/resources/lobby#lobby-member-object) object. | flags? | integer | [lobby member flags](/docs/resources/lobby#lobby-member-object-lobby-member-flags) combined as a [bitfield](https://en.wikipedia.org/wiki/Bit_field) | ## Remove a Member from a Lobby -/lobbies/[\{lobby.id\}](/docs/resources/lobby#lobby-object)/members/[\{user.id\}](/docs/resources/user#user-object) +/lobbies/[\{lobby.id\}](/docs/resources/lobby#lobby-object)/members/[\{user.id\}](/docs/resources/user#user-object) Removes the provided user from the specified lobby. It is safe to call this even if the user is no longer a member of the lobby, but will fail if the lobby does not exist. Returns nothing. ## Leave Lobby -/lobbies/[\{lobby.id\}](/docs/resources/lobby#lobby-object)/members/@me +/lobbies/[\{lobby.id\}](/docs/resources/lobby#lobby-object)/members/@me Removes the current user from the specified lobby. It is safe to call this even if the user is no longer a member of the lobby, but will fail if the lobby does not exist. @@ -143,7 +143,7 @@ Uses `Bearer` token for authorization. Returns nothing. ## Link Channel to Lobby -/lobbies/[\{lobby.id\}](/docs/resources/lobby#lobby-object)/channel-linking +/lobbies/[\{lobby.id\}](/docs/resources/lobby#lobby-object)/channel-linking Links an existing text channel to a lobby. See [Linked Channels](/docs/discord-social-sdk/development-guides/linked-channels) for more information. @@ -158,7 +158,7 @@ Returns a [lobby](/docs/resources/lobby#lobby-object) object with a linked chann | channel_id? | snowflake | the id of the channel to link to the lobby. If not provided, will unlink any currently linked channels from the lobby. | ## Unlink Channel from Lobby -/lobbies/[\{lobby.id\}](/docs/resources/lobby#lobby-object)/channel-linking +/lobbies/[\{lobby.id\}](/docs/resources/lobby#lobby-object)/channel-linking Unlinks any currently linked channels from the specified lobby. diff --git a/docs/resources/message.mdx b/docs/resources/message.mdx index e8433b7e8a..da70e1cd96 100644 --- a/docs/resources/message.mdx +++ b/docs/resources/message.mdx @@ -735,7 +735,7 @@ user 125 in the content. | is_renewal | boolean | whether this notification is for a renewal rather than a new purchase | ## Get Channel Messages -/channels/[\{channel.id\}](/docs/resources/channel#channel-object)/messages +/channels/[\{channel.id\}](/docs/resources/channel#channel-object)/messages Retrieves the messages in a channel. Returns an array of [message](/docs/resources/message#message-object) objects on success. @@ -757,14 +757,14 @@ The `before`, `after`, and `around` parameters are mutually exclusive, only one | limit? | integer | Max number of messages to return (1-100) | 50 | ## Get Channel Message -/channels/[\{channel.id\}](/docs/resources/channel#channel-object)/messages/[\{message.id\}](/docs/resources/message#message-object) +/channels/[\{channel.id\}](/docs/resources/channel#channel-object)/messages/[\{message.id\}](/docs/resources/message#message-object) Retrieves a specific message in the channel. Returns a [message](/docs/resources/message#message-object) object on success. If operating on a guild channel, this endpoint requires the current user to have the `VIEW_CHANNEL` and `READ_MESSAGE_HISTORY` permissions. If the channel is a voice channel, they must _also_ have the `CONNECT` permission. ## Create Message -/channels/[\{channel.id\}](/docs/resources/channel#channel-object)/messages +/channels/[\{channel.id\}](/docs/resources/channel#channel-object)/messages :::warn Discord may strip certain characters from message content, like invalid unicode characters or characters which cause unexpected message formatting. If you are passing user-generated strings into message content, consider sanitizing the data to prevent unexpected behavior and using `allowed_mentions` to prevent unexpected mentions. @@ -827,32 +827,32 @@ When creating a message, apps must provide a value for **at least one of** `cont Examples for file uploads are available in [Uploading Files](/docs/reference#uploading-files). ## Crosspost Message -/channels/[\{channel.id\}](/docs/resources/channel#channel-object)/messages/[\{message.id\}](/docs/resources/message#message-object)/crosspost +/channels/[\{channel.id\}](/docs/resources/channel#channel-object)/messages/[\{message.id\}](/docs/resources/message#message-object)/crosspost Crosspost a message in an Announcement Channel to following channels. This endpoint requires the `SEND_MESSAGES` permission, if the current user sent the message, or additionally the `MANAGE_MESSAGES` permission, for all other messages, to be present for the current user. Returns a [message](/docs/resources/message#message-object) object. Fires a [Message Update](/docs/events/gateway-events#message-update) Gateway event. ## Create Reaction -/channels/[\{channel.id\}](/docs/resources/channel#channel-object)/messages/[\{message.id\}](/docs/resources/message#message-object)/reactions/[\{emoji.id\}](/docs/resources/emoji#emoji-object)/@me +/channels/[\{channel.id\}](/docs/resources/channel#channel-object)/messages/[\{message.id\}](/docs/resources/message#message-object)/reactions/[\{emoji.id\}](/docs/resources/emoji#emoji-object)/@me Create a reaction for the message. This endpoint requires the `READ_MESSAGE_HISTORY` permission to be present on the current user. Additionally, if nobody else has reacted to the message using this emoji, this endpoint requires the `ADD_REACTIONS` permission to be present on the current user. Returns a 204 empty response on success. Fires a [Message Reaction Add](/docs/events/gateway-events#message-reaction-add) Gateway event. The `emoji` must be [URL Encoded](https://en.wikipedia.org/wiki/Percent-encoding) or the request will fail with `10014: Unknown Emoji`. To use custom emoji, you must encode it in the format `name:id` with the emoji name and emoji id. ## Delete Own Reaction -/channels/[\{channel.id\}](/docs/resources/channel#channel-object)/messages/[\{message.id\}](/docs/resources/message#message-object)/reactions/[\{emoji.id\}](/docs/resources/emoji#emoji-object)/@me +/channels/[\{channel.id\}](/docs/resources/channel#channel-object)/messages/[\{message.id\}](/docs/resources/message#message-object)/reactions/[\{emoji.id\}](/docs/resources/emoji#emoji-object)/@me Delete a reaction the current user has made for the message. Returns a 204 empty response on success. Fires a [Message Reaction Remove](/docs/events/gateway-events#message-reaction-remove) Gateway event. The `emoji` must be [URL Encoded](https://en.wikipedia.org/wiki/Percent-encoding) or the request will fail with `10014: Unknown Emoji`. To use custom emoji, you must encode it in the format `name:id` with the emoji name and emoji id. ## Delete User Reaction -/channels/[\{channel.id\}](/docs/resources/channel#channel-object)/messages/[\{message.id\}](/docs/resources/message#message-object)/reactions/[\{emoji.id\}](/docs/resources/emoji#emoji-object)/[\{user.id\}](/docs/resources/user#user-object) +/channels/[\{channel.id\}](/docs/resources/channel#channel-object)/messages/[\{message.id\}](/docs/resources/message#message-object)/reactions/[\{emoji.id\}](/docs/resources/emoji#emoji-object)/[\{user.id\}](/docs/resources/user#user-object) Deletes another user's reaction. This endpoint requires the `MANAGE_MESSAGES` permission to be present on the current user. Returns a 204 empty response on success. Fires a [Message Reaction Remove](/docs/events/gateway-events#message-reaction-remove) Gateway event. The `emoji` must be [URL Encoded](https://en.wikipedia.org/wiki/Percent-encoding) or the request will fail with `10014: Unknown Emoji`. To use custom emoji, you must encode it in the format `name:id` with the emoji name and emoji id. ## Get Reactions -/channels/[\{channel.id\}](/docs/resources/channel#channel-object)/messages/[\{message.id\}](/docs/resources/message#message-object)/reactions/[\{emoji.id\}](/docs/resources/emoji#emoji-object) +/channels/[\{channel.id\}](/docs/resources/channel#channel-object)/messages/[\{message.id\}](/docs/resources/message#message-object)/reactions/[\{emoji.id\}](/docs/resources/emoji#emoji-object) Get a list of users that reacted with this emoji. Returns an array of [user](/docs/resources/user#user-object) objects on success. The `emoji` must be [URL Encoded](https://en.wikipedia.org/wiki/Percent-encoding) or the request will fail with `10014: Unknown Emoji`. To use custom emoji, you must encode it in the format `name:id` with the emoji name and emoji id. @@ -873,18 +873,18 @@ The `emoji` must be [URL Encoded](https://en.wikipedia.org/wiki/Percent-encoding | BURST | 1 | ## Delete All Reactions -/channels/[\{channel.id\}](/docs/resources/channel#channel-object)/messages/[\{message.id\}](/docs/resources/message#message-object)/reactions +/channels/[\{channel.id\}](/docs/resources/channel#channel-object)/messages/[\{message.id\}](/docs/resources/message#message-object)/reactions Deletes all reactions on a message. This endpoint requires the `MANAGE_MESSAGES` permission to be present on the current user. Fires a [Message Reaction Remove All](/docs/events/gateway-events#message-reaction-remove-all) Gateway event. ## Delete All Reactions for Emoji -/channels/[\{channel.id\}](/docs/resources/channel#channel-object)/messages/[\{message.id\}](/docs/resources/message#message-object)/reactions/[\{emoji.id\}](/docs/resources/emoji#emoji-object) +/channels/[\{channel.id\}](/docs/resources/channel#channel-object)/messages/[\{message.id\}](/docs/resources/message#message-object)/reactions/[\{emoji.id\}](/docs/resources/emoji#emoji-object) Deletes all the reactions for a given emoji on a message. This endpoint requires the `MANAGE_MESSAGES` permission to be present on the current user. Fires a [Message Reaction Remove Emoji](/docs/events/gateway-events#message-reaction-remove-emoji) Gateway event. The `emoji` must be [URL Encoded](https://en.wikipedia.org/wiki/Percent-encoding) or the request will fail with `10014: Unknown Emoji`. To use custom emoji, you must encode it in the format `name:id` with the emoji name and emoji id. ## Edit Message -/channels/[\{channel.id\}](/docs/resources/channel#channel-object)/messages/[\{message.id\}](/docs/resources/message#message-object) +/channels/[\{channel.id\}](/docs/resources/channel#channel-object)/messages/[\{message.id\}](/docs/resources/message#message-object) Edit a previously sent message. The fields `content`, `embeds`, and `flags` can be edited by the original message author. Other users can only edit `flags` and only if they have the `MANAGE_MESSAGES` permission in the corresponding channel. When specifying flags, ensure to include all previously set flags/bits in addition to ones that you are modifying. Only `flags` documented in the table below may be modified by users (unsupported flag changes are currently ignored without error). @@ -917,7 +917,7 @@ All parameters to this endpoint are optional and nullable. | attachments | array of [attachment](/docs/resources/message#attachment-object) objects | Attached files to keep and possible descriptions for new files. See [Uploading Files](/docs/reference#uploading-files) | ## Delete Message -/channels/[\{channel.id\}](/docs/resources/channel#channel-object)/messages/[\{message.id\}](/docs/resources/message#message-object) +/channels/[\{channel.id\}](/docs/resources/channel#channel-object)/messages/[\{message.id\}](/docs/resources/message#message-object) Delete a message. If operating on a guild channel and trying to delete a message that was not sent by the current user, this endpoint requires the `MANAGE_MESSAGES` permission. Returns a 204 empty response on success. Fires a [Message Delete](/docs/events/gateway-events#message-delete) Gateway event. @@ -926,7 +926,7 @@ This endpoint supports the `X-Audit-Log-Reason` header. ::: ## Bulk Delete Messages -/channels/[\{channel.id\}](/docs/resources/channel#channel-object)/messages/bulk-delete +/channels/[\{channel.id\}](/docs/resources/channel#channel-object)/messages/bulk-delete Delete multiple messages in a single request. This endpoint can only be used on guild channels and requires the `MANAGE_MESSAGES` permission. Returns a 204 empty response on success. Fires a [Message Delete Bulk](/docs/events/gateway-events#message-delete-bulk) Gateway event. diff --git a/docs/resources/poll.mdx b/docs/resources/poll.mdx index 0ae7fbee2e..c5de3d57fc 100644 --- a/docs/resources/poll.mdx +++ b/docs/resources/poll.mdx @@ -124,7 +124,7 @@ For creating a poll, see [Create Message](/docs/resources/message#create-message Apps are not allowed to vote on polls. No rights! :) ## Get Answer Voters -/channels/[\{channel.id\}](/docs/resources/channel#channel-object)/polls/[\{message.id\}](/docs/resources/message#message-object)/answers/[\{answer_id\}](/docs/resources/poll#poll-answer-object) +/channels/[\{channel.id\}](/docs/resources/channel#channel-object)/polls/[\{message.id\}](/docs/resources/message#message-object)/answers/[\{answer_id\}](/docs/resources/poll#poll-answer-object) Get a list of users that voted for this specific answer. @@ -142,7 +142,7 @@ Get a list of users that voted for this specific answer. | users | array of [user](/docs/resources/user#user-object) | Users who voted for this answer | ## End Poll -/channels/[\{channel.id\}](/docs/resources/channel#channel-object)/polls/[\{message.id\}](/docs/resources/message#message-object)/expire +/channels/[\{channel.id\}](/docs/resources/channel#channel-object)/polls/[\{message.id\}](/docs/resources/message#message-object)/expire Immediately ends the poll. You cannot end polls from other users. diff --git a/docs/resources/sku.mdx b/docs/resources/sku.mdx index 8c50dbd15d..d7f7ad96e1 100644 --- a/docs/resources/sku.mdx +++ b/docs/resources/sku.mdx @@ -66,7 +66,7 @@ The `flags` field can be used to differentiate user and server subscriptions wit | USER_SUBSCRIPTION | `1 << 8` | Recurring SKU purchased by a user for themselves. Grants access to the purchasing user in every server. | ## List SKUs -/applications/[\{application.id\}](/docs/resources/application#application-object)/skus +/applications/[\{application.id\}](/docs/resources/application#application-object)/skus Returns all SKUs for a given application. diff --git a/docs/resources/soundboard.mdx b/docs/resources/soundboard.mdx index 6ffe150c9e..f723d282b1 100644 --- a/docs/resources/soundboard.mdx +++ b/docs/resources/soundboard.mdx @@ -61,7 +61,7 @@ https://cdn.discordapp.com/soundboard-sounds/{sound_id} ``` ## Send Soundboard Sound -/channels/[\{channel.id\}](/docs/resources/channel#channel-object)/send-soundboard-sound +/channels/[\{channel.id\}](/docs/resources/channel#channel-object)/send-soundboard-sound Send a soundboard sound to a voice channel the user is connected to. Fires a [Voice Channel Effect Send](/docs/events/gateway-events#voice-channel-effect-send) Gateway event. @@ -75,12 +75,12 @@ Requires the `SPEAK` and `USE_SOUNDBOARD` permissions, and also the `USE_EXTERNA | source_guild_id? | snowflake | the id of the guild the soundboard sound is from, required to play sounds from different servers | ## List Default Soundboard Sounds -/soundboard-default-sounds +/soundboard-default-sounds Returns an array of [soundboard sound](/docs/resources/soundboard#soundboard-sound-object) objects that can be used by all users. ## List Guild Soundboard Sounds -/guilds/[\{guild.id\}](/docs/resources/guild#guild-object)/soundboard-sounds +/guilds/[\{guild.id\}](/docs/resources/guild#guild-object)/soundboard-sounds Returns a list of the guild's soundboard sounds. Includes `user` fields if the bot has the `CREATE_GUILD_EXPRESSIONS` or `MANAGE_GUILD_EXPRESSIONS` permission. @@ -91,12 +91,12 @@ Returns a list of the guild's soundboard sounds. Includes `user` fields if the b | items | array of [soundboard sound](/docs/resources/soundboard#soundboard-sound-object) objects | ## Get Guild Soundboard Sound -/guilds/[\{guild.id\}](/docs/resources/guild#guild-object)/soundboard-sounds/[\{sound.id\}](/docs/resources/soundboard#soundboard-sound-object) +/guilds/[\{guild.id\}](/docs/resources/guild#guild-object)/soundboard-sounds/[\{sound.id\}](/docs/resources/soundboard#soundboard-sound-object) Returns a [soundboard sound](/docs/resources/soundboard#soundboard-sound-object) object for the given sound id. Includes the `user` field if the bot has the `CREATE_GUILD_EXPRESSIONS` or `MANAGE_GUILD_EXPRESSIONS` permission. ## Create Guild Soundboard Sound -/guilds/[\{guild.id\}](/docs/resources/guild#guild-object)/soundboard-sounds +/guilds/[\{guild.id\}](/docs/resources/guild#guild-object)/soundboard-sounds Create a new soundboard sound for the guild. Requires the `CREATE_GUILD_EXPRESSIONS` permission. Returns the new [soundboard sound](/docs/resources/soundboard#soundboard-sound-object) object on success. Fires a [Guild Soundboard Sound Create](/docs/events/gateway-events#guild-soundboard-sound-create) Gateway event. @@ -119,7 +119,7 @@ This endpoint supports the `X-Audit-Log-Reason` header. | emoji_name? | ?string | the unicode character of a standard emoji for the soundboard sound | ## Modify Guild Soundboard Sound -/guilds/[\{guild.id\}](/docs/resources/guild#guild-object)/soundboard-sounds/[\{sound.id\}](/docs/resources/soundboard#soundboard-sound-object) +/guilds/[\{guild.id\}](/docs/resources/guild#guild-object)/soundboard-sounds/[\{sound.id\}](/docs/resources/soundboard#soundboard-sound-object) Modify the given soundboard sound. For sounds created by the current user, requires either the `CREATE_GUILD_EXPRESSIONS` or `MANAGE_GUILD_EXPRESSIONS` permission. For other sounds, requires the `MANAGE_GUILD_EXPRESSIONS` permission. Returns the updated [soundboard sound](/docs/resources/soundboard#soundboard-sound-object) object on success. Fires a [Guild Soundboard Sound Update](/docs/events/gateway-events#guild-soundboard-sound-update) Gateway event. @@ -141,7 +141,7 @@ This endpoint supports the `X-Audit-Log-Reason` header. | emoji_name | ?string | the unicode character of a standard emoji for the soundboard sound | ## Delete Guild Soundboard Sound -/guilds/[\{guild.id\}](/docs/resources/guild#guild-object)/soundboard-sounds/[\{sound.id\}](/docs/resources/soundboard#soundboard-sound-object) +/guilds/[\{guild.id\}](/docs/resources/guild#guild-object)/soundboard-sounds/[\{sound.id\}](/docs/resources/soundboard#soundboard-sound-object) Delete the given soundboard sound. For sounds created by the current user, requires either the `CREATE_GUILD_EXPRESSIONS` or `MANAGE_GUILD_EXPRESSIONS` permission. For other sounds, requires the `MANAGE_GUILD_EXPRESSIONS` permission. Returns `204 No Content` on success. Fires a [Guild Soundboard Sound Delete](/docs/events/gateway-events#guild-soundboard-sound-delete) Gateway event. diff --git a/docs/resources/stage-instance.mdx b/docs/resources/stage-instance.mdx index 36ba8f41b5..fbbf3fc428 100644 --- a/docs/resources/stage-instance.mdx +++ b/docs/resources/stage-instance.mdx @@ -62,7 +62,7 @@ Below are some definitions related to stages. When a Stage channel has no speakers for a certain period of time (on the order of minutes), the Stage instance will be automatically deleted. ## Create Stage Instance -/stage-instances +/stage-instances Creates a new Stage instance associated to a Stage channel. Returns that [Stage instance](/docs/resources/stage-instance#stage-instance-object-stage-instance-structure). Fires a [Stage Instance Create](/docs/events/gateway-events#stage-instance-create) Gateway event. @@ -85,12 +85,12 @@ This endpoint supports the `X-Audit-Log-Reason` header. \* The stage moderator must have the `MENTION_EVERYONE` permission for this notification to be sent. ## Get Stage Instance -/stage-instances/[\{channel.id\}](/docs/resources/channel#channel-object) +/stage-instances/[\{channel.id\}](/docs/resources/channel#channel-object) Gets the stage instance associated with the Stage channel, if it exists. ## Modify Stage Instance -/stage-instances/[\{channel.id\}](/docs/resources/channel#channel-object) +/stage-instances/[\{channel.id\}](/docs/resources/channel#channel-object) Updates fields of an existing Stage instance. Returns the updated [Stage instance](/docs/resources/stage-instance#stage-instance-object-stage-instance-structure). Fires a [Stage Instance Update](/docs/events/gateway-events#stage-instance-update) Gateway event. @@ -108,7 +108,7 @@ This endpoint supports the `X-Audit-Log-Reason` header. | privacy_level? | integer | The [privacy level](/docs/resources/stage-instance#stage-instance-object-privacy-level) of the Stage instance | ## Delete Stage Instance -/stage-instances/[\{channel.id\}](/docs/resources/channel#channel-object) +/stage-instances/[\{channel.id\}](/docs/resources/channel#channel-object) Deletes the Stage instance. Returns `204 No Content`. Fires a [Stage Instance Delete](/docs/events/gateway-events#stage-instance-delete) Gateway event. diff --git a/docs/resources/sticker.mdx b/docs/resources/sticker.mdx index 70b652962a..ac0fa4bfac 100644 --- a/docs/resources/sticker.mdx +++ b/docs/resources/sticker.mdx @@ -101,12 +101,12 @@ Represents a pack of standard stickers. ``` ## Get Sticker -/stickers/[\{sticker.id\}](/docs/resources/sticker#sticker-object) +/stickers/[\{sticker.id\}](/docs/resources/sticker#sticker-object) Returns a [sticker](/docs/resources/sticker#sticker-object) object for the given sticker ID. ## List Sticker Packs -/sticker-packs +/sticker-packs Returns a list of available sticker packs. @@ -117,22 +117,22 @@ Returns a list of available sticker packs. | sticker_packs | array of [sticker pack](/docs/resources/sticker#sticker-pack-object) objects | ## Get Sticker Pack -/sticker-packs/[\{pack.id\}](/docs/resources/sticker#sticker-pack-object) +/sticker-packs/[\{pack.id\}](/docs/resources/sticker#sticker-pack-object) Returns a [sticker pack](/docs/resources/sticker#sticker-pack-object) object for the given sticker pack ID. ## List Guild Stickers -/guilds/[\{guild.id\}](/docs/resources/guild#guild-object)/stickers +/guilds/[\{guild.id\}](/docs/resources/guild#guild-object)/stickers Returns an array of [sticker](/docs/resources/sticker#sticker-object) objects for the given guild. Includes `user` fields if the bot has the `CREATE_GUILD_EXPRESSIONS` or `MANAGE_GUILD_EXPRESSIONS` permission. ## Get Guild Sticker -/guilds/[\{guild.id\}](/docs/resources/guild#guild-object)/stickers/[\{sticker.id\}](/docs/resources/sticker#sticker-object) +/guilds/[\{guild.id\}](/docs/resources/guild#guild-object)/stickers/[\{sticker.id\}](/docs/resources/sticker#sticker-object) Returns a [sticker](/docs/resources/sticker#sticker-object) object for the given guild and sticker IDs. Includes the `user` field if the bot has the `CREATE_GUILD_EXPRESSIONS` or `MANAGE_GUILD_EXPRESSIONS` permission. ## Create Guild Sticker -/guilds/[\{guild.id\}](/docs/resources/guild#guild-object)/stickers +/guilds/[\{guild.id\}](/docs/resources/guild#guild-object)/stickers Create a new sticker for the guild. Send a `multipart/form-data` body. Requires the `CREATE_GUILD_EXPRESSIONS` permission. Returns the new [sticker](/docs/resources/sticker#sticker-object) object on success. Fires a [Guild Stickers Update](/docs/events/gateway-events#guild-stickers-update) Gateway event. @@ -160,7 +160,7 @@ Uploaded stickers are constrained to 5 seconds in length for animated stickers, | file | file contents | the sticker file to upload, must be a PNG, APNG, GIF, or Lottie JSON file, max 512 KiB | ## Modify Guild Sticker -/guilds/[\{guild.id\}](/docs/resources/guild#guild-object)/stickers/[\{sticker.id\}](/docs/resources/sticker#sticker-object) +/guilds/[\{guild.id\}](/docs/resources/guild#guild-object)/stickers/[\{sticker.id\}](/docs/resources/sticker#sticker-object) Modify the given sticker. For stickers created by the current user, requires either the `CREATE_GUILD_EXPRESSIONS` or `MANAGE_GUILD_EXPRESSIONS` permission. For other stickers, requires the `MANAGE_GUILD_EXPRESSIONS` permission. Returns the updated [sticker](/docs/resources/sticker#sticker-object) object on success. Fires a [Guild Stickers Update](/docs/events/gateway-events#guild-stickers-update) Gateway event. @@ -181,7 +181,7 @@ This endpoint supports the `X-Audit-Log-Reason` header. | tags | string | autocomplete/suggestion tags for the sticker (max 200 characters) | ## Delete Guild Sticker -/guilds/[\{guild.id\}](/docs/resources/guild#guild-object)/stickers/[\{sticker.id\}](/docs/resources/sticker#sticker-object) +/guilds/[\{guild.id\}](/docs/resources/guild#guild-object)/stickers/[\{sticker.id\}](/docs/resources/sticker#sticker-object) Delete the given sticker. For stickers created by the current user, requires either the `CREATE_GUILD_EXPRESSIONS` or `MANAGE_GUILD_EXPRESSIONS` permission. For other stickers, requires the `MANAGE_GUILD_EXPRESSIONS` permission. Returns `204 No Content` on success. Fires a [Guild Stickers Update](/docs/events/gateway-events#guild-stickers-update) Gateway event. diff --git a/docs/resources/subscription.mdx b/docs/resources/subscription.mdx index e2fc879bc0..68e7161300 100644 --- a/docs/resources/subscription.mdx +++ b/docs/resources/subscription.mdx @@ -61,7 +61,7 @@ Some examples of this behavior include: - A refund or chargeback during the current period would make the subscription `INACTIVE`. ## List SKU Subscriptions -/skus/[\{sku.id\}](/docs/resources/sku#sku-object)/subscriptions +/skus/[\{sku.id\}](/docs/resources/sku#sku-object)/subscriptions Returns all subscriptions containing the SKU, filtered by user. Returns a list of [subscription](/docs/resources/subscription#subscription-object) objects. @@ -75,6 +75,6 @@ Returns all subscriptions containing the SKU, filtered by user. Returns a list o | user_id? | snowflake | User ID for which to return subscriptions. Required except for OAuth queries. | absent | ## Get SKU Subscription -/skus/[\{sku.id\}](/docs/resources/sku#sku-object)/subscriptions/[\{subscription.id\}](/docs/resources/subscription#subscription-object) +/skus/[\{sku.id\}](/docs/resources/sku#sku-object)/subscriptions/[\{subscription.id\}](/docs/resources/subscription#subscription-object) Get a subscription by its ID. Returns a [subscription](/docs/resources/subscription#subscription-object) object. \ No newline at end of file diff --git a/docs/resources/user.mdx b/docs/resources/user.mdx index ea7a93b807..f7eff1c1f0 100644 --- a/docs/resources/user.mdx +++ b/docs/resources/user.mdx @@ -184,17 +184,17 @@ The role connection object that an application has attached to a user. | metadata | object | object mapping [application role connection metadata](/docs/resources/application-role-connection-metadata#application-role-connection-metadata-object) keys to their `string`-ified value (max 100 characters) for the user on the platform a bot has connected | ## Get Current User -/users/@me +/users/@me Returns the [user](/docs/resources/user#user-object) object of the requester's account. For OAuth2, this requires the `identify` scope, which will return the object _without_ an email, and optionally the `email` scope, which returns the object _with_ an email if the user has one. ## Get User -/users/[\{user.id\}](/docs/resources/user#user-object) +/users/[\{user.id\}](/docs/resources/user#user-object) Returns a [user](/docs/resources/user#user-object) object for a given user ID. ## Modify Current User -/users/@me +/users/@me Modify the requester's user account settings. Returns a [user](/docs/resources/user#user-object) object on success. Fires a [User Update](/docs/events/gateway-events#user-update) Gateway event. @@ -211,7 +211,7 @@ All parameters to this endpoint are optional. | banner | ?[image data](/docs/reference#image-data) | if passed, modifies the user's banner | ## Get Current User Guilds -/users/@me/guilds +/users/@me/guilds Returns a list of partial [guild](/docs/resources/guild#guild-object) objects the current user is a member of. For OAuth2, requires the `guilds` scope. @@ -245,17 +245,17 @@ This endpoint returns 200 guilds by default, which is the maximum number of guil | with_counts | [boolean](/docs/reference#boolean-query-strings) | include approximate member and presence counts in response | false | false | ## Get Current User Guild Member -/users/@me/guilds/[\{guild.id\}](/docs/resources/guild#guild-object)/member +/users/@me/guilds/[\{guild.id\}](/docs/resources/guild#guild-object)/member Returns a [guild member](/docs/resources/guild#guild-member-object) object for the current user. Requires the `guilds.members.read` OAuth2 scope. ## Leave Guild -/users/@me/guilds/[\{guild.id\}](/docs/resources/guild#guild-object) +/users/@me/guilds/[\{guild.id\}](/docs/resources/guild#guild-object) Leave a guild. Returns a 204 empty response on success. Fires a [Guild Delete](/docs/events/gateway-events#guild-delete) Gateway event and a [Guild Member Remove](/docs/events/gateway-events#guild-member-remove) Gateway event. ## Create DM -/users/@me/channels +/users/@me/channels Create a new DM channel with a user. Returns a [DM channel](/docs/resources/channel#channel-object) object (if one already exists, it will be returned instead). @@ -270,7 +270,7 @@ You should not use this endpoint to DM everyone in a server about something. DMs | recipient_id | snowflake | the recipient to open a DM channel with | ## Create Group DM -/users/@me/channels +/users/@me/channels Create a new group DM channel with multiple users. Returns a [DM channel](/docs/resources/channel#channel-object) object. This endpoint was intended to be used with the now-deprecated GameBridge SDK. Fires a [Channel Create](/docs/events/gateway-events#channel-create) Gateway event. @@ -286,17 +286,17 @@ This endpoint is limited to 10 active group DMs. | nicks | dict | a dictionary of user ids to their respective nicknames | ## Get Current User Connections -/users/@me/connections +/users/@me/connections Returns a list of [connection](/docs/resources/user#connection-object) objects. Requires the `connections` OAuth2 scope. ## Get Current User Application Role Connection -/users/@me/applications/[\{application.id\}](/docs/resources/application#application-object)/role-connection +/users/@me/applications/[\{application.id\}](/docs/resources/application#application-object)/role-connection Returns the [application role connection](/docs/resources/user#application-role-connection-object) for the user. Requires an OAuth2 access token with `role_connections.write` scope for the application specified in the path. ## Update Current User Application Role Connection -/users/@me/applications/[\{application.id\}](/docs/resources/application#application-object)/role-connection +/users/@me/applications/[\{application.id\}](/docs/resources/application#application-object)/role-connection Updates and returns the [application role connection](/docs/resources/user#application-role-connection-object) for the user. Requires an OAuth2 access token with `role_connections.write` scope for the application specified in the path. diff --git a/docs/resources/voice.mdx b/docs/resources/voice.mdx index 6070160fe7..86baed96eb 100644 --- a/docs/resources/voice.mdx +++ b/docs/resources/voice.mdx @@ -55,22 +55,22 @@ Used to represent a user's voice connection status. | custom | boolean | whether this is a custom voice region (used for events/etc) | ## List Voice Regions -/voice/regions +/voice/regions Returns an array of [voice region](/docs/resources/voice#voice-region-object) objects that can be used when setting a voice or stage channel's [`rtc_region`](/docs/resources/channel#channel-object-channel-structure). ## Get Current User Voice State -/guilds/[\{guild.id\}](/docs/resources/guild#guild-object)/voice-states/@me +/guilds/[\{guild.id\}](/docs/resources/guild#guild-object)/voice-states/@me Returns the current user's [voice state](/docs/resources/voice#voice-state-object) in the guild. ## Get User Voice State -/guilds/[\{guild.id\}](/docs/resources/guild#guild-object)/voice-states/[\{user.id\}](/docs/resources/user#user-object) +/guilds/[\{guild.id\}](/docs/resources/guild#guild-object)/voice-states/[\{user.id\}](/docs/resources/user#user-object) Returns the specified user's [voice state](/docs/resources/voice#voice-state-object) in the guild. ## Modify Current User Voice State -/guilds/[\{guild.id\}](/docs/resources/guild#guild-object)/voice-states/@me +/guilds/[\{guild.id\}](/docs/resources/guild#guild-object)/voice-states/@me Updates the current user's voice state. Returns `204 No Content` on success. Fires a [Voice State Update](/docs/events/gateway-events#voice-state-update) Gateway event. @@ -93,7 +93,7 @@ There are currently several caveats for this endpoint: - You are able to set `request_to_speak_timestamp` to any present or future time. ## Modify User Voice State -/guilds/[\{guild.id\}](/docs/resources/guild#guild-object)/voice-states/[\{user.id\}](/docs/resources/user#user-object) +/guilds/[\{guild.id\}](/docs/resources/guild#guild-object)/voice-states/[\{user.id\}](/docs/resources/user#user-object) Updates another user's voice state. Fires a [Voice State Update](/docs/events/gateway-events#voice-state-update) Gateway event. diff --git a/docs/resources/webhook.mdx b/docs/resources/webhook.mdx index 9a9fde2681..f17d12a5ea 100644 --- a/docs/resources/webhook.mdx +++ b/docs/resources/webhook.mdx @@ -110,7 +110,7 @@ These types don't include [webhook events](/docs/events/webhook-events), which a ``` ## Create Webhook -/channels/[\{channel.id\}](/docs/resources/channel#channel-object)/webhooks +/channels/[\{channel.id\}](/docs/resources/channel#channel-object)/webhooks Creates a new webhook and returns a [webhook](/docs/resources/webhook#webhook-object) object on success. Requires the `MANAGE_WEBHOOKS` permission. Fires a [Webhooks Update](/docs/events/gateway-events#webhooks-update) Gateway event. @@ -131,17 +131,17 @@ This endpoint supports the `X-Audit-Log-Reason` header. | avatar? | ?[image data](/docs/reference#image-data) | image for the default webhook avatar | ## Get Channel Webhooks -/channels/[\{channel.id\}](/docs/resources/channel#channel-object)/webhooks +/channels/[\{channel.id\}](/docs/resources/channel#channel-object)/webhooks Returns a list of channel [webhook](/docs/resources/webhook#webhook-object) objects. Requires the `MANAGE_WEBHOOKS` permission. ## Get Guild Webhooks -/guilds/[\{guild.id\}](/docs/resources/guild#guild-object)/webhooks +/guilds/[\{guild.id\}](/docs/resources/guild#guild-object)/webhooks Returns a list of guild [webhook](/docs/resources/webhook#webhook-object) objects. Requires the `MANAGE_WEBHOOKS` permission. ## Get Webhook -/webhooks/[\{webhook.id\}](/docs/resources/webhook#webhook-object) +/webhooks/[\{webhook.id\}](/docs/resources/webhook#webhook-object) Returns the new [webhook](/docs/resources/webhook#webhook-object) object for the given id. @@ -149,12 +149,12 @@ This request requires the `MANAGE_WEBHOOKS` permission unless the application ma webhook. [(see: webhook.application_id)](/docs/resources/webhook#webhook-object) ## Get Webhook with Token -/webhooks/[\{webhook.id\}](/docs/resources/webhook#webhook-object)/[\{webhook.token\}](/docs/resources/webhook#webhook-object) +/webhooks/[\{webhook.id\}](/docs/resources/webhook#webhook-object)/[\{webhook.token\}](/docs/resources/webhook#webhook-object) Same as above, except this call does not require authentication and returns no user in the webhook object. ## Modify Webhook -/webhooks/[\{webhook.id\}](/docs/resources/webhook#webhook-object) +/webhooks/[\{webhook.id\}](/docs/resources/webhook#webhook-object) Modify a webhook. Requires the `MANAGE_WEBHOOKS` permission. Returns the updated [webhook](/docs/resources/webhook#webhook-object) object on success. Fires a [Webhooks Update](/docs/events/gateway-events#webhooks-update) Gateway event. @@ -175,12 +175,12 @@ This endpoint supports the `X-Audit-Log-Reason` header. | channel_id | snowflake | the new channel id this webhook should be moved to | ## Modify Webhook with Token -/webhooks/[\{webhook.id\}](/docs/resources/webhook#webhook-object)/[\{webhook.token\}](/docs/resources/webhook#webhook-object) +/webhooks/[\{webhook.id\}](/docs/resources/webhook#webhook-object)/[\{webhook.token\}](/docs/resources/webhook#webhook-object) Same as above, except this call does not require authentication, does not accept a `channel_id` parameter in the body, and does not return a user in the webhook object. ## Delete Webhook -/webhooks/[\{webhook.id\}](/docs/resources/webhook#webhook-object) +/webhooks/[\{webhook.id\}](/docs/resources/webhook#webhook-object) Delete a webhook permanently. Requires the `MANAGE_WEBHOOKS` permission. Returns a `204 No Content` response on success. Fires a [Webhooks Update](/docs/events/gateway-events#webhooks-update) Gateway event. @@ -189,12 +189,12 @@ This endpoint supports the `X-Audit-Log-Reason` header. ::: ## Delete Webhook with Token -/webhooks/[\{webhook.id\}](/docs/resources/webhook#webhook-object)/[\{webhook.token\}](/docs/resources/webhook#webhook-object) +/webhooks/[\{webhook.id\}](/docs/resources/webhook#webhook-object)/[\{webhook.token\}](/docs/resources/webhook#webhook-object) Same as above, except this call does not require authentication. ## Execute Webhook -/webhooks/[\{webhook.id\}](/docs/resources/webhook#webhook-object)/[\{webhook.token\}](/docs/resources/webhook#webhook-object) +/webhooks/[\{webhook.id\}](/docs/resources/webhook#webhook-object)/[\{webhook.token\}](/docs/resources/webhook#webhook-object) Refer to [Uploading Files](/docs/reference#uploading-files) for details on attachments and `multipart/form-data` requests. Returns a message or `204 No Content` depending on the `wait` query parameter. @@ -246,7 +246,7 @@ For the webhook embed objects, you can set every field except `type` (it will be ::: ## Execute Slack-Compatible Webhook -/webhooks/[\{webhook.id\}](/docs/resources/webhook#webhook-object)/[\{webhook.token\}](/docs/resources/webhook#webhook-object)/slack +/webhooks/[\{webhook.id\}](/docs/resources/webhook#webhook-object)/[\{webhook.token\}](/docs/resources/webhook#webhook-object)/slack Refer to [Slack's documentation](https://api.slack.com/incoming-webhooks) for more information. We do not support Slack's `channel`, `icon_emoji`, `mrkdwn`, or `mrkdwn_in` properties. @@ -258,7 +258,7 @@ Refer to [Slack's documentation](https://api.slack.com/incoming-webhooks) for mo | wait | [boolean](/docs/reference#boolean-query-strings) | waits for server confirmation of message send before response (defaults to `true`; when `false` a message that is not saved does not return an error) | false | ## Execute GitHub-Compatible Webhook -/webhooks/[\{webhook.id\}](/docs/resources/webhook#webhook-object)/[\{webhook.token\}](/docs/resources/webhook#webhook-object)/github +/webhooks/[\{webhook.id\}](/docs/resources/webhook#webhook-object)/[\{webhook.token\}](/docs/resources/webhook#webhook-object)/github [Add a new webhook](https://support.discord.com/hc/en-us/articles/228383668-Intro-to-Webhooks) to your GitHub repo (in the repo's settings), and use this endpoint as the "Payload URL." You can choose what events your Discord channel receives by choosing the "Let me select individual events" option and selecting individual events for the new webhook you're configuring. The supported [events](https://docs.github.com/en/webhooks/webhook-events-and-payloads) are `commit_comment`, `create`, `delete`, `fork`, `issue_comment`, `issues`, `member`, `public`, `pull_request`, `pull_request_review`, `pull_request_review_comment`, `push`, `release`, `watch`, `check_run`, `check_suite`, `discussion`, and `discussion_comment`. @@ -270,7 +270,7 @@ Refer to [Slack's documentation](https://api.slack.com/incoming-webhooks) for mo | wait | [boolean](/docs/reference#boolean-query-strings) | waits for server confirmation of message send before response (defaults to `true`; when `false` a message that is not saved does not return an error) | false | ## Get Webhook Message -/webhooks/[\{webhook.id\}](/docs/resources/webhook#webhook-object)/[\{webhook.token\}](/docs/resources/webhook#webhook-object)/messages/[\{message.id\}](/docs/resources/message#message-object) +/webhooks/[\{webhook.id\}](/docs/resources/webhook#webhook-object)/[\{webhook.token\}](/docs/resources/webhook#webhook-object)/messages/[\{message.id\}](/docs/resources/message#message-object) Returns a previously-sent webhook message from the same token. Returns a [message](/docs/resources/message#message-object) object on success. @@ -281,7 +281,7 @@ Returns a previously-sent webhook message from the same token. Returns a [messag | thread_id | snowflake | id of the thread the message is in | false | ## Edit Webhook Message -/webhooks/[\{webhook.id\}](/docs/resources/webhook#webhook-object)/[\{webhook.token\}](/docs/resources/webhook#webhook-object)/messages/[\{message.id\}](/docs/resources/message#message-object) +/webhooks/[\{webhook.id\}](/docs/resources/webhook#webhook-object)/[\{webhook.token\}](/docs/resources/webhook#webhook-object)/messages/[\{message.id\}](/docs/resources/message#message-object) Edits a previously-sent webhook message from the same token. Returns a [message](/docs/resources/message#message-object) object on success. @@ -325,7 +325,7 @@ All parameters to this endpoint are optional and nullable. \*\*\* Polls can only be added when editing a deferred interaction response. ## Delete Webhook Message -/webhooks/[\{webhook.id\}](/docs/resources/webhook#webhook-object)/[\{webhook.token\}](/docs/resources/webhook#webhook-object)/messages/[\{message.id\}](/docs/resources/message#message-object) +/webhooks/[\{webhook.id\}](/docs/resources/webhook#webhook-object)/[\{webhook.token\}](/docs/resources/webhook#webhook-object)/messages/[\{message.id\}](/docs/resources/message#message-object) Deletes a message that was created by the webhook. Returns a `204 No Content` response on success. diff --git a/docs/topics/oauth2.mdx b/docs/topics/oauth2.mdx index 6667892ad3..1576fb0529 100644 --- a/docs/topics/oauth2.mdx +++ b/docs/topics/oauth2.mdx @@ -416,12 +416,12 @@ From this object, you should store the `webhook.token` and `webhook.id`. See the Any user that wishes to add your webhook to their channel will need to go through the full OAuth2 flow. A new webhook is created each time, so you will need to save the token and id. If you wish to send a message to all your webhooks, you'll need to iterate over each stored id:token combination and make `POST` requests to each one. Be mindful of our [Rate Limits](/docs/topics/rate-limits#rate-limits)! ## Get Current Bot Application Information -/oauth2/applications/@me +/oauth2/applications/@me Returns the bot's [application](/docs/resources/application#application-object) object. ## Get Current Authorization Information -/oauth2/@me +/oauth2/@me Returns info about the current authorization. Requires authentication with a bearer token. From 2d7e847f4b6c63e08f029e2cca4cbb7442c05c1b Mon Sep 17 00:00:00 2001 From: GeniusTimo Date: Wed, 23 Apr 2025 17:29:46 +0200 Subject: [PATCH 15/20] Added link for "{instance_id}" See https://github.com/discord/discord-api-docs/pull/7479#discussion_r2054789425 --- docs/resources/application.mdx | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/resources/application.mdx b/docs/resources/application.mdx index 3c74ea9824..dc50b7a2b0 100644 --- a/docs/resources/application.mdx +++ b/docs/resources/application.mdx @@ -263,7 +263,7 @@ All parameters to this endpoint are optional \*\* To update an Interactions endpoint URL via the API, the URL must be valid according to the [Receiving an Interaction](/docs/interactions/receiving-and-responding#receiving-an-interaction) documentation. ## Get Application Activity Instance -/applications/[\{application.id\}](/docs/resources/application#application-object)/activity-instances/{instance_id} +/applications/[\{application.id\}](/docs/resources/application#application-object)/activity-instances/[\{instance_id\}](/docs/resources/application#get-application-activity-instance-activity-instance-object) Returns a serialized activity instance, if it exists. Useful for [preventing unwanted activity sessions](/docs/activities/development-guides#preventing-unwanted-activity-sessions). From 08fcf040a464a4775ab04fbc5e3022b00b8525d1 Mon Sep 17 00:00:00 2001 From: GeniusTimo Date: Wed, 23 Apr 2025 17:31:33 +0200 Subject: [PATCH 16/20] Reverted "Changed protocol to https where appropriate" This reverts commit 8f71342600ed16f7c1302b4809e0c9aa8580d2de. --- docs/activities/development-guides.mdx | 2 +- ...cord-activities-developer-preview-of-the-embedded-app-sdk.md | 2 +- docs/change-log/2024-08-26-entry-point-commands.md | 2 +- .../change-log/2025-03-17-introducing-the-discord-social-sdk.md | 2 +- docs/quick-start/getting-started.mdx | 2 +- 5 files changed, 5 insertions(+), 5 deletions(-) diff --git a/docs/activities/development-guides.mdx b/docs/activities/development-guides.mdx index a36a228d3e..098649e888 100644 --- a/docs/activities/development-guides.mdx +++ b/docs/activities/development-guides.mdx @@ -444,7 +444,7 @@ User Experience An [Entry Point command](/docs/interactions/application-commands#entry-point-commands) is required for users to be able to launch your Activity from the [App Launcher menu](https://support.discord.com/hc/articles/21334461140375-Using-Apps-on-Discord#h_01HRQSA6C8TRHS722P1H3HW1TV) in Discord. -When you enable Activities in your [app's settings](https://discord.com/developers/applications), a [default Entry Point command](/docs/interactions/application-commands#default-entry-point-command) is automatically created for your app. The default Entry Point command will use the `DISCORD_LAUNCH_ACTIVITY` (`2`) [handler type](/docs/interactions/application-commands#application-command-object-entry-point-command-handler-types), which means that Discord automatically launches your Activity for the user and posts a follow-up message into the channel where it was launched from. +When you enable Activities in your [app's settings](http://discord.com/developers/applications), a [default Entry Point command](/docs/interactions/application-commands#default-entry-point-command) is automatically created for your app. The default Entry Point command will use the `DISCORD_LAUNCH_ACTIVITY` (`2`) [handler type](/docs/interactions/application-commands#application-command-object-entry-point-command-handler-types), which means that Discord automatically launches your Activity for the user and posts a follow-up message into the channel where it was launched from. If you want to handle sending messages yourself, you can update the handler to be `APP_HANDLER` (`1`). Details about Entry Point command handlers is in the [Entry Point command documentation](/docs/interactions/application-commands#entry-point-handlers). diff --git a/docs/change-log/2024-03-18-discord-activities-developer-preview-of-the-embedded-app-sdk.md b/docs/change-log/2024-03-18-discord-activities-developer-preview-of-the-embedded-app-sdk.md index ecc7fce7d0..0895b7fa8a 100644 --- a/docs/change-log/2024-03-18-discord-activities-developer-preview-of-the-embedded-app-sdk.md +++ b/docs/change-log/2024-03-18-discord-activities-developer-preview-of-the-embedded-app-sdk.md @@ -11,7 +11,7 @@ Discord Developers can now build Activities! Activities are interactive, multiplayer experiences that run in an iframe in Discord. In order to make the communication between your experience and Discord, we've introduced the Embedded App SDK to assist in communicating between your app and the Discord client. * New [Discord Activities](/docs/activities/overview) developer docs with a tutorial, code samples, development guides, and design principles. -* The Embedded App SDK is now available via [npm](https://npmjs.com/package/@discord/embedded-app-sdk) and [GitHub](https://github.com/discord/embedded-app-sdk). +* The Embedded App SDK is now available via [npm](https://npmjs.com/package/@discord/embedded-app-sdk) and [GitHub](http://github.com/discord/embedded-app-sdk). * The [Embedded App SDK Reference](/docs/developer-tools/embedded-app-sdk) is now available. To learn more about how to get started building your own Activity, check out the [Activities Overview](/docs/activities/overview). diff --git a/docs/change-log/2024-08-26-entry-point-commands.md b/docs/change-log/2024-08-26-entry-point-commands.md index 44702fe659..99bf9f853a 100644 --- a/docs/change-log/2024-08-26-entry-point-commands.md +++ b/docs/change-log/2024-08-26-entry-point-commands.md @@ -16,4 +16,4 @@ More details about Entry Point commands can be found in the [Application Command ### Default Entry Point Commands -Starting today, when you enable Activities in your [app's settings](https://discord.com/developers/applications), a [default Entry Point command](/docs/interactions/application-commands#default-entry-point-command) called "Launch" will automatically be created for your app. This can be customized or deleted like other commands if you want to update the name or handler type. \ No newline at end of file +Starting today, when you enable Activities in your [app's settings](http://discord.com/developers/applications), a [default Entry Point command](/docs/interactions/application-commands#default-entry-point-command) called "Launch" will automatically be created for your app. This can be customized or deleted like other commands if you want to update the name or handler type. \ No newline at end of file diff --git a/docs/change-log/2025-03-17-introducing-the-discord-social-sdk.md b/docs/change-log/2025-03-17-introducing-the-discord-social-sdk.md index c5aa71bdb9..4da78fc441 100644 --- a/docs/change-log/2025-03-17-introducing-the-discord-social-sdk.md +++ b/docs/change-log/2025-03-17-introducing-the-discord-social-sdk.md @@ -29,7 +29,7 @@ New resources are available in the Developer Portal to help you get started with - [Getting Started Guides](/docs/discord-social-sdk/getting-started) for C++, Unity and Unreal Engine. - [Development Guides](/docs/discord-social-sdk/development-guides) for building your game's social features. - [Design Guidelines](/docs/discord-social-sdk/design-guidelines) for designing your game's social features. -- [SDK Reference](https://discord.com/developers/docs/social-sdk/index.html) is now available. +- [SDK Reference](http://discord.com/developers/docs/social-sdk/index.html) is now available. - The Discord Social SDK binaries are available for download in the Developer Portal after enabling the Discord Social SDK for your application. To learn more about building with the Discord Social SDK, check out the [Discord Social SDK Overview](/docs/discord-social-sdk/overview). diff --git a/docs/quick-start/getting-started.mdx b/docs/quick-start/getting-started.mdx index 1ebbfbc73e..43e2a4d1de 100644 --- a/docs/quick-start/getting-started.mdx +++ b/docs/quick-start/getting-started.mdx @@ -289,7 +289,7 @@ If you have troubles verifying your endpoint, make sure both ngrok and your app ::: The verification is handled automatically by the sample app in two ways: -- It uses the `PUBLIC_KEY` and [discord-interactions package](https://github.com/discord/discord-interactions-js#usage) with a wrapper function (imported from `utils.js`) that makes it conform to [Express's `verify` interface](https://expressjs.com/en/5x/api.html#express.json). This is run on every incoming request to your app. +- It uses the `PUBLIC_KEY` and [discord-interactions package](https://github.com/discord/discord-interactions-js#usage) with a wrapper function (imported from `utils.js`) that makes it conform to [Express's `verify` interface](http://expressjs.com/en/5x/api.html#express.json). This is run on every incoming request to your app. - It responds to incoming `PING` requests. You can learn more about preparing your app to receive interactions in [the interactions documentation](/docs/interactions/overview#preparing-for-interactions). From b58d452e1b0951d1a20a5d695431826a6060924f Mon Sep 17 00:00:00 2001 From: GeniusTimo Date: Wed, 23 Apr 2025 17:33:30 +0200 Subject: [PATCH 17/20] Reverted "Updated links to the developer TOS and policy" This reverts commit fe1eeaebdf6822e0794ad23287335e60480d5c29. --- README.md | 2 +- docs/discovery/best-practices.md | 2 +- docs/monetization/enabling-monetization.mdx | 2 +- docs/topics/oauth2.mdx | 2 +- 4 files changed, 4 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 9923b62dbc..809bce8188 100644 --- a/README.md +++ b/README.md @@ -20,4 +20,4 @@ The [Unofficial Discord API server](https://discord.gg/discord-api) is a common ## License -Except as otherwise noted, the Discord API Documentation and other content in this repository is licensed under the Creative Commons Attribution-ShareAlike 4.0 License (see [LICENSE](https://github.com/discord/discord-api-docs/blob/main/LICENSE)), and code samples in this repository are licensed under the MIT License (see [LICENSE-CODE](https://github.com/discord/discord-api-docs/blob/main/LICENSE-CODE)). These licenses do not grant you rights to use any of Discord’s trademarks or other brand features. Please see the [Discord Developer Terms of Service](https://dis.gd/discord-developer-terms-of-service) for more information about use of Discord’s brand features and APIs. +Except as otherwise noted, the Discord API Documentation and other content in this repository is licensed under the Creative Commons Attribution-ShareAlike 4.0 License (see [LICENSE](https://github.com/discord/discord-api-docs/blob/main/LICENSE)), and code samples in this repository are licensed under the MIT License (see [LICENSE-CODE](https://github.com/discord/discord-api-docs/blob/main/LICENSE-CODE)). These licenses do not grant you rights to use any of Discord’s trademarks or other brand features. Please see the [Discord Developer Terms of Service](https://support-dev.discord.com/hc/en-us/articles/8562894815383) for more information about use of Discord’s brand features and APIs. diff --git a/docs/discovery/best-practices.md b/docs/discovery/best-practices.md index 460006b834..32b8513d42 100644 --- a/docs/discovery/best-practices.md +++ b/docs/discovery/best-practices.md @@ -94,7 +94,7 @@ For general best practices on how to run a server, check out our [Community page ### Final checks to make sure you’re ready to go -Before you can click the final “Enable Discovery” button, ensure that your App Directory Product Page complies with the rest of Discord’s Directory eligibility criteria, [app content requirements](https://support-dev.discord.com/hc/en-us/articles/9489299950487-App-Directory-App-Content-Requirements-Policy) and Developer [Terms of Service](https://dis.gd/discord-developer-terms-of-service) and [Policy](https://dis.gd/discord-developer-policy). +Before you can click the final “Enable Discovery” button, ensure that your App Directory Product Page complies with the rest of Discord’s Directory eligibility criteria, [app content requirements](https://support-dev.discord.com/hc/en-us/articles/9489299950487-App-Directory-App-Content-Requirements-Policy) and Developer [Terms of Service](https://support-dev.discord.com/hc/en-us/articles/8562894815383) and [Policy](https://support-dev.discord.com/hc/en-us/articles/8563934450327). For more details about what this information entails, read our [Help Center article on Profile Pages](https://support-dev.discord.com/hc/en-us/articles/6378525413143-App-Directory-App-profile-pages). diff --git a/docs/monetization/enabling-monetization.mdx b/docs/monetization/enabling-monetization.mdx index 0581ec3d38..87ca2275b7 100644 --- a/docs/monetization/enabling-monetization.mdx +++ b/docs/monetization/enabling-monetization.mdx @@ -37,7 +37,7 @@ Before you can start creating SKUs and offering payments in your app, your app a - This document should clearly and accurately describe to users of your app the user data you collect and how you use and share such data with us and third parties, consistent with our Developer Terms of Service and Developer Policy. - App must not contain any harmful or bad language in the name, description, commands, or role connection metadata. - Payouts must be set up with a valid payment method -- Agreement to the [Monetization Terms](https://support.discord.com/hc/articles/5330075836311) and [Discord Developer Policy](https://dis.gd/discord-developer-policy). +- Agreement to the [Monetization Terms](https://support.discord.com/hc/articles/5330075836311) and [Discord Developer Policy](https://support-dev.discord.com/hc/en-us/articles/8563934450327). ## Step 3. Set Up Team Payouts diff --git a/docs/topics/oauth2.mdx b/docs/topics/oauth2.mdx index 1576fb0529..f8ddd25da3 100644 --- a/docs/topics/oauth2.mdx +++ b/docs/topics/oauth2.mdx @@ -268,7 +268,7 @@ Discord's API provides bot users, which are a separate type of user dedicated to ### Bot vs User Accounts :::warn -Developers must abide by the [terms of service](https://dis.gd/discord-developer-terms-of-service), which includes refraining from automating standard user accounts (generally called "self-bots") outside of the OAuth2/bot API. +Developers must abide by the [terms of service](https://support-dev.discord.com/hc/en-us/articles/8562894815383), which includes refraining from automating standard user accounts (generally called "self-bots") outside of the OAuth2/bot API. ::: Bot users have a few differences compared to standard Discord users: From 9cbd305543bfa58a17fc7a734b7022c51e6bd537 Mon Sep 17 00:00:00 2001 From: GeniusTimo Date: Wed, 23 Apr 2025 17:52:11 +0200 Subject: [PATCH 18/20] Manually revert some commits and fix merge issues --- README.md | 2 +- docs/change-log.mdx | 2 +- ...-moderation-custom-message-action-metadata-field.md | 2 +- ...023-10-17-global-rate-limit-added-to-discord.com.md | 4 ++-- docs/change-log/2025-04-11-incentivized-links.md | 4 ++-- docs/events/gateway.mdx | 2 +- docs/interactions/application-commands.mdx | 4 ++-- docs/monetization/enabling-monetization.mdx | 2 +- docs/reference.mdx | 2 +- .../resources/application-role-connection-metadata.mdx | 1 - docs/resources/message.mdx | 10 ---------- docs/topics/oauth2.mdx | 2 +- 12 files changed, 13 insertions(+), 24 deletions(-) diff --git a/README.md b/README.md index 809bce8188..62e6492bdf 100644 --- a/README.md +++ b/README.md @@ -20,4 +20,4 @@ The [Unofficial Discord API server](https://discord.gg/discord-api) is a common ## License -Except as otherwise noted, the Discord API Documentation and other content in this repository is licensed under the Creative Commons Attribution-ShareAlike 4.0 License (see [LICENSE](https://github.com/discord/discord-api-docs/blob/main/LICENSE)), and code samples in this repository are licensed under the MIT License (see [LICENSE-CODE](https://github.com/discord/discord-api-docs/blob/main/LICENSE-CODE)). These licenses do not grant you rights to use any of Discord’s trademarks or other brand features. Please see the [Discord Developer Terms of Service](https://support-dev.discord.com/hc/en-us/articles/8562894815383) for more information about use of Discord’s brand features and APIs. +Except as otherwise noted, the Discord API Documentation and other content in this repository is licensed under the Creative Commons Attribution-ShareAlike 4.0 License (see [LICENSE](https://github.com/discord/discord-api-docs/blob/main/LICENSE)), and code samples in this repository are licensed under the MIT License (see [LICENSE-CODE](https://github.com/discord/discord-api-docs/blob/main/LICENSE-CODE)). These licenses do not grant you rights to use any of Discord’s trademarks or other brand features. Please see the [Discord Developer Terms of Service](https://support-dev.discord.com/hc/articles/8562894815383-Discord-Developer-Terms-of-Service) for more information about use of Discord’s brand features and APIs. diff --git a/docs/change-log.mdx b/docs/change-log.mdx index 8ae836c14e..3bb9c66ef7 100644 --- a/docs/change-log.mdx +++ b/docs/change-log.mdx @@ -4,6 +4,6 @@ showTOC: false # Change Log -Discover the latest updates, new features, and bug fixes on the Discord Developer Platform. To join in on the conversation, join the [Discord Developers Server](https://discord.gg/discord-developers). +Discover the latest updates, new features, and bug fixes on the Discord Developer Platform. To join in on the conversation, join the [Discord Developers Server](https://discord.com/invite/discord-developers). diff --git a/docs/change-log/2023-02-24-add-auto-moderation-custom-message-action-metadata-field.md b/docs/change-log/2023-02-24-add-auto-moderation-custom-message-action-metadata-field.md index 3aef9a6d87..4aaf655a63 100644 --- a/docs/change-log/2023-02-24-add-auto-moderation-custom-message-action-metadata-field.md +++ b/docs/change-log/2023-02-24-add-auto-moderation-custom-message-action-metadata-field.md @@ -3,4 +3,4 @@ title: "Add Auto Moderation custom_message Action Metadata Field" date: "2023-02-24" --- -Add new `custom_message` [action metadata](/docs/resources/auto-moderation#auto-moderation-action-object-action-metadata) for the `BLOCK_MESSAGE` [action type](/docs/resources/auto-moderation#auto-moderation-action-object-action-types). You can now specify a custom string for every Auto Moderation rule that will be shown to members whenever the rule blocks their message. This can be used as an additional explanation for why a message was blocked and as a chance to help members understand your server's rules and guidelines. +Add new `custom_message` [action metadata](/docs/resources/auto-moderation#auto-moderation-action-object-action-metadata) for the `BLOCK_MESSAGE` [action type](/docs/resources/auto-moderation#auto-moderation-action-object-action-types)). You can now specify a custom string for every Auto Moderation rule that will be shown to members whenever the rule blocks their message. This can be used as an additional explanation for why a message was blocked and as a chance to help members understand your server's rules and guidelines. diff --git a/docs/change-log/2023-10-17-global-rate-limit-added-to-discord.com.md b/docs/change-log/2023-10-17-global-rate-limit-added-to-discord.com.md index 5a2123a8ba..d481a5b8b9 100644 --- a/docs/change-log/2023-10-17-global-rate-limit-added-to-discord.com.md +++ b/docs/change-log/2023-10-17-global-rate-limit-added-to-discord.com.md @@ -9,7 +9,7 @@ To limit impact on your app, please make sure you are making calls to `discord.c This does **not** apply for `cdn.discordapp.com`. -Refer to the [API Reference](/docs/reference) for more info on which url(s) to use when building on the REST API +Refer to the [API Reference](https://discord.com/developers/docs/reference) for more info on which url(s) to use when building on the REST API -* [February 14, 2022 Change Log](/docs/change-log#api-v10): Requests to v10 and higher will no longer be supported on `discordapp.com` (this does not affect `cdn.discordapp.com`) +* [February 14, 2022 Change Log](https://discord.com/developers/docs/change-log#feb-14-2022): Requests to v10 and higher will no longer be supported on `discordapp.com` (this does not affect `cdn.discordapp.com`) * [May 4, 2020 #api-announcements](https://discord.com/channels/613425648685547541/697138785317814292/706944540971630662) diff --git a/docs/change-log/2025-04-11-incentivized-links.md b/docs/change-log/2025-04-11-incentivized-links.md index c1e27de1be..a172903c45 100644 --- a/docs/change-log/2025-04-11-incentivized-links.md +++ b/docs/change-log/2025-04-11-incentivized-links.md @@ -13,6 +13,6 @@ Custom Incentivized Links are used to customize how your incentivized link embed - shareLink will now let you attach custom params to links you share about your game using `custom_id`. - Removed `referrer_id` from shareLink API. Any uses of `referrer_id` should be moved over to use `custom_id` instead. Passing `referrer_id` to shareLink will silently fail. -Learn more about [creating and managing Custom Incentivized Links](/docs/activities/development-guides#creating-and-managing-custom-incentivized-links) and [how to generate them from within your activity](/docs/activities/development-guides#generating-a-custom-link-within-your-activity) with the shareLink API. +Learn more about [creating and managing Custom Incentivized Links](https://discord.com/developers/docs/activities/development-guides#creating-and-managing-custom-incentivized-links) and [how to generate them from within your activity](https://discord.com/developers/docs/activities/development-guides#generating-a-custom-link-within-your-activity) with the shareLink API. -The Embedded App SDK is available via [npm](https://www.npmjs.com/package/@discord/embedded-app-sdk) and [GitHub](https://github.com/discord/embedded-app-sdk). You can check out our [installation guide and reference](/docs/developer-tools/embedded-app-sdk) to get started with it! +The Embedded App SDK is available via [npm](https://www.npmjs.com/package/@discord/embedded-app-sdk) and [GitHub](https://github.com/discord/embedded-app-sdk). You can check out our [installation guide and reference](https://discord.com/developers/docs/developer-tools/embedded-app-sdk) to get started with it! diff --git a/docs/events/gateway.mdx b/docs/events/gateway.mdx index a1ef17279e..a432fff794 100644 --- a/docs/events/gateway.mdx +++ b/docs/events/gateway.mdx @@ -54,7 +54,7 @@ Receiving a Gateway event from Discord (like when [a reaction is added to a mess While some events are sent to your app automatically, most events require your app to define intents when [Identifying](/docs/events/gateway#identifying). Intents are bitwise values that can be ORed (`|`) to indicate which events (or groups of events) you want Discord to send your app. A list of intents and their corresponding events are listed in the [intents section](/docs/events/gateway#gateway-intents). -When receiving events, you can also configure *how* events will be sent to your app, like the [encoding and compression](/docs/events/gateway#encoding-and-compression), or whether [sharding should be enabled](/docs/events/gateway#sharding). +When receiving events, you can also configure *how* events will be sent to your app, like the [encoding and compression](/docs/events/gateway#encoding-and-compression), or whether [sharding should be enabled](/docs/events/gateway#sharding)). All events that your app can receive via a connection are in the [Gateway event documentation](/docs/events/gateway-events#receive-events). diff --git a/docs/interactions/application-commands.mdx b/docs/interactions/application-commands.mdx index f56a2ba06d..02b42f00a7 100644 --- a/docs/interactions/application-commands.mdx +++ b/docs/interactions/application-commands.mdx @@ -1012,12 +1012,12 @@ For the Entry Point command to be visible to users, an app must have [Activities When a user invokes an app's Entry Point command, the value of [`handler`](/docs/interactions/application-commands#application-command-object-application-command-structure) will determine how the interaction is handled: -- For `APP_HANDLER` (`1`), the app is responsible for [responding to the interaction](/docs/interactions/receiving-and-responding#responding-to-an-interaction). It can respond by launching the app's associated Activity using the `LAUNCH_ACTIVITY` (type `12`) [interaction callback type](/docs/interactions/receiving-and-responding#interaction-response-object-interaction-callback-type), or take another action (like sending a follow-up message in channel). +- For `APP_HANDLER` (`1`), the app is responsible for [responding to the interaction](/docs/interactions/receiving-and-responding#responding-to-an-interaction). It can respond by launching the app's associated Activity using the `LAUNCH_ACTIVITY` (type `12`) [interaction callback type](/docs/interactions/receiving-and-responding##interaction-response-object-interaction-callback-type), or take another action (like sending a follow-up message in channel). - For `DISCORD_LAUNCH_ACTIVITY` (`2`), Discord will handle the interaction automatically by launching the associated Activity and sending a message to the channel where it was launched. ### Default Entry Point command -When you enable Activities, an Entry Point command (named "Launch") is automatically created for your app with `DISCORD_LAUNCH_ACTIVITY` (`2`) set as the [Entry Point handler](/docs/interactions/application-commands#entry-point-handlers). You can retrieve details for the automatically-created command, like its ID, by calling the [Get Global Application Commands](/docs/interactions/application-commands#get-global-application-commands) endpoint and looking for the "Launch" command. +When you enable Activities, an Entry Point command (named "Launch") is automatically created for your app with `DISCORD_LAUNCH_ACTIVITY` (`2`) set as the [Entry Point handler](/docs/interactions/application-commands#entry-point-handlers). You can retrieve details for the automatically-created command, like its ID, by calling the [Get Global Application Commands](/docs/interactions/application-commands##get-global-application-commands) endpoint and looking for the "Launch" command. Details about updating or replacing the default Entry Point command is in the [Setting Up an Entry Point Command guide](/docs/activities/development-guides/user-actions#setting-up-an-entry-point-command). diff --git a/docs/monetization/enabling-monetization.mdx b/docs/monetization/enabling-monetization.mdx index 87ca2275b7..3642f70fee 100644 --- a/docs/monetization/enabling-monetization.mdx +++ b/docs/monetization/enabling-monetization.mdx @@ -37,7 +37,7 @@ Before you can start creating SKUs and offering payments in your app, your app a - This document should clearly and accurately describe to users of your app the user data you collect and how you use and share such data with us and third parties, consistent with our Developer Terms of Service and Developer Policy. - App must not contain any harmful or bad language in the name, description, commands, or role connection metadata. - Payouts must be set up with a valid payment method -- Agreement to the [Monetization Terms](https://support.discord.com/hc/articles/5330075836311) and [Discord Developer Policy](https://support-dev.discord.com/hc/en-us/articles/8563934450327). +- Agreement to the [Monetization Terms](https://support.discord.com/hc/articles/5330075836311) and [Discord Developer Policy](https://support-dev.discord.com/hc/en-us/articles/8563934450327-Discord-Developer-Policy). ## Step 3. Set Up Team Payouts diff --git a/docs/reference.mdx b/docs/reference.mdx index 502bb17e3b..683f403f57 100644 --- a/docs/reference.mdx +++ b/docs/reference.mdx @@ -14,7 +14,7 @@ https://discord.com/api Some API and Gateway versions are now non-functioning, and are labeled as discontinued in the table below for posterity. Trying to use these versions will fail and return 400 Bad Request. ::: -Discord exposes different versions of our API[.](https://c.tenor.com/BuZl66EegkgAAAAC/westworld-dolores.gif) You should specify which version to use by including it in the request path like `https://discord.com/api/v{version_number}`. Omitting the version number from the route will route requests to the current default version (marked below). You can find the change log for the newest API version [here](/docs/change-log). +Discord exposes different versions of our API[.](https://c.tenor.com/BuZl66EegkgAAAAC/westworld-dolores.gif) You should specify which version to use by including it in the request path like `https://discord.com/api/v{version_number}`. Omitting the version number from the route will route requests to the current default version (marked below). You can find the change log for the newest API version [here](https://discord.com/developers/docs/change-log). ###### API Versions diff --git a/docs/resources/application-role-connection-metadata.mdx b/docs/resources/application-role-connection-metadata.mdx index 7ee8e52c6a..9ca88f9806 100644 --- a/docs/resources/application-role-connection-metadata.mdx +++ b/docs/resources/application-role-connection-metadata.mdx @@ -1,6 +1,5 @@ # Application Role Connection Metadata -A representation of role connection metadata for an [application](/docs/resources/application). A representation of role connection metadata for an [application](/docs/resources/application). When a guild has added a bot and that bot has configured its [`role_connections_verification_url`](/docs/resources/application#application-object) (in the developer portal), the application will render as a potential verification method in the guild's role verification configuration. diff --git a/docs/resources/message.mdx b/docs/resources/message.mdx index 16eeb70563..2df844d816 100644 --- a/docs/resources/message.mdx +++ b/docs/resources/message.mdx @@ -263,7 +263,6 @@ One of [Application Command Interaction Metadata](/docs/resources/message#messag | user | [user](/docs/resources/user#user-object) object | User who triggered the interaction | | authorizing_integration_owners | dictionary with keys of [application integration types](/docs/resources/application#application-object-application-integration-types) | IDs for installation context(s) related to an interaction. Details in [Authorizing Integration Owners Object](/docs/interactions/receiving-and-responding#interaction-object-authorizing-integration-owners-object) | | original_response_message_id? | snowflake | ID of the original response message, present only on [follow-up messages](/docs/interactions/receiving-and-responding) | -| original_response_message_id? | snowflake | ID of the original response message, present only on [follow-up messages](/docs/interactions/receiving-and-responding) | | target_user? | [user](/docs/resources/user#user-object) object | The user the command was run on, present only on [user command](/docs/interactions/application-commands#user-commands) interactions | | target_message_id? | snowflake | The ID of the message the command was run on, present only on [message command](/docs/interactions/application-commands#message-commands) interactions. The original response message will also have `message_reference` and `referenced_message` pointing to this message. | @@ -277,7 +276,6 @@ One of [Application Command Interaction Metadata](/docs/resources/message#messag | user | [user](/docs/resources/user#user-object) object | User who triggered the interaction | | authorizing_integration_owners | dictionary with keys of [application integration types](/docs/resources/application#application-object-application-integration-types) | IDs for installation context(s) related to an interaction. Details in [Authorizing Integration Owners Object](/docs/interactions/receiving-and-responding#interaction-object-authorizing-integration-owners-object) | | original_response_message_id? | snowflake | ID of the original response message, present only on [follow-up messages](/docs/interactions/receiving-and-responding) | -| original_response_message_id? | snowflake | ID of the original response message, present only on [follow-up messages](/docs/interactions/receiving-and-responding) | | interacted_message_id | snowflake | ID of the message that contained the interactive component | @@ -290,7 +288,6 @@ One of [Application Command Interaction Metadata](/docs/resources/message#messag | user | [user](/docs/resources/user#user-object) object | User who triggered the interaction | | authorizing_integration_owners | dictionary with keys of [application integration types](/docs/resources/application#application-object-application-integration-types) | IDs for installation context(s) related to an interaction. Details in [Authorizing Integration Owners Object](/docs/interactions/receiving-and-responding#interaction-object-authorizing-integration-owners-object) | | original_response_message_id? | snowflake | ID of the original response message, present only on [follow-up messages](/docs/interactions/receiving-and-responding) | -| original_response_message_id? | snowflake | ID of the original response message, present only on [follow-up messages](/docs/interactions/receiving-and-responding) | | triggering_interaction_metadata | [Application Command Interaction Metadata](/docs/resources/message#message-interaction-metadata-object-application-command-interaction-metadata-structure) or [Message Component Interaction Metadata](/docs/resources/message#message-interaction-metadata-object-message-component-interaction-metadata-structure) object | Metadata for the interaction that was used to open the modal | @@ -763,7 +760,6 @@ The `before`, `after`, and `around` parameters are mutually exclusive, only one ## Get Channel Message /channels/[\{channel.id\}](/docs/resources/channel#channel-object)/messages/[\{message.id\}](/docs/resources/message#message-object) -/channels/[\{channel.id\}](/docs/resources/channel#channel-object)/messages/[\{message.id\}](/docs/resources/message#message-object) Retrieves a specific message in the channel. Returns a [message](/docs/resources/message#message-object) object on success. @@ -771,7 +767,6 @@ If operating on a guild channel, this endpoint requires the current user to have ## Create Message /channels/[\{channel.id\}](/docs/resources/channel#channel-object)/messages -/channels/[\{channel.id\}](/docs/resources/channel#channel-object)/messages :::warn Discord may strip certain characters from message content, like invalid unicode characters or characters which cause unexpected message formatting. If you are passing user-generated strings into message content, consider sanitizing the data to prevent unexpected behavior and using `allowed_mentions` to prevent unexpected mentions. @@ -835,7 +830,6 @@ Examples for file uploads are available in [Uploading Files](/docs/reference#upl ## Crosspost Message /channels/[\{channel.id\}](/docs/resources/channel#channel-object)/messages/[\{message.id\}](/docs/resources/message#message-object)/crosspost -/channels/[\{channel.id\}](/docs/resources/channel#channel-object)/messages/[\{message.id\}](/docs/resources/message#message-object)/crosspost Crosspost a message in an Announcement Channel to following channels. This endpoint requires the `SEND_MESSAGES` permission, if the current user sent the message, or additionally the `MANAGE_MESSAGES` permission, for all other messages, to be present for the current user. @@ -882,7 +876,6 @@ The `emoji` must be [URL Encoded](https://en.wikipedia.org/wiki/Percent-encoding ## Delete All Reactions /channels/[\{channel.id\}](/docs/resources/channel#channel-object)/messages/[\{message.id\}](/docs/resources/message#message-object)/reactions -/channels/[\{channel.id\}](/docs/resources/channel#channel-object)/messages/[\{message.id\}](/docs/resources/message#message-object)/reactions Deletes all reactions on a message. This endpoint requires the `MANAGE_MESSAGES` permission to be present on the current user. Fires a [Message Reaction Remove All](/docs/events/gateway-events#message-reaction-remove-all) Gateway event. @@ -894,7 +887,6 @@ The `emoji` must be [URL Encoded](https://en.wikipedia.org/wiki/Percent-encoding ## Edit Message /channels/[\{channel.id\}](/docs/resources/channel#channel-object)/messages/[\{message.id\}](/docs/resources/message#message-object) -/channels/[\{channel.id\}](/docs/resources/channel#channel-object)/messages/[\{message.id\}](/docs/resources/message#message-object) Edit a previously sent message. The fields `content`, `embeds`, and `flags` can be edited by the original message author. Other users can only edit `flags` and only if they have the `MANAGE_MESSAGES` permission in the corresponding channel. When specifying flags, ensure to include all previously set flags/bits in addition to ones that you are modifying. Only `flags` documented in the table below may be modified by users (unsupported flag changes are currently ignored without error). @@ -928,7 +920,6 @@ All parameters to this endpoint are optional and nullable. ## Delete Message /channels/[\{channel.id\}](/docs/resources/channel#channel-object)/messages/[\{message.id\}](/docs/resources/message#message-object) -/channels/[\{channel.id\}](/docs/resources/channel#channel-object)/messages/[\{message.id\}](/docs/resources/message#message-object) Delete a message. If operating on a guild channel and trying to delete a message that was not sent by the current user, this endpoint requires the `MANAGE_MESSAGES` permission. Returns a 204 empty response on success. Fires a [Message Delete](/docs/events/gateway-events#message-delete) Gateway event. @@ -938,7 +929,6 @@ This endpoint supports the `X-Audit-Log-Reason` header. ## Bulk Delete Messages /channels/[\{channel.id\}](/docs/resources/channel#channel-object)/messages/bulk-delete -/channels/[\{channel.id\}](/docs/resources/channel#channel-object)/messages/bulk-delete Delete multiple messages in a single request. This endpoint can only be used on guild channels and requires the `MANAGE_MESSAGES` permission. Returns a 204 empty response on success. Fires a [Message Delete Bulk](/docs/events/gateway-events#message-delete-bulk) Gateway event. diff --git a/docs/topics/oauth2.mdx b/docs/topics/oauth2.mdx index f8ddd25da3..33713ebad3 100644 --- a/docs/topics/oauth2.mdx +++ b/docs/topics/oauth2.mdx @@ -268,7 +268,7 @@ Discord's API provides bot users, which are a separate type of user dedicated to ### Bot vs User Accounts :::warn -Developers must abide by the [terms of service](https://support-dev.discord.com/hc/en-us/articles/8562894815383), which includes refraining from automating standard user accounts (generally called "self-bots") outside of the OAuth2/bot API. +Developers must abide by the [terms of service](https://support-dev.discord.com/hc/articles/8562894815383-Discord-Developer-Terms-of-Service), which includes refraining from automating standard user accounts (generally called "self-bots") outside of the OAuth2/bot API. ::: Bot users have a few differences compared to standard Discord users: From 6141e54e9d0d8cc3f3160a9fccfc64f724ccca99 Mon Sep 17 00:00:00 2001 From: GeniusTimo Date: Wed, 23 Apr 2025 17:55:45 +0200 Subject: [PATCH 19/20] Manually reviewed the changes once again and removed the last ones --- docs/change-log/2025-04-11-incentivized-links.md | 2 +- docs/resources/message.mdx | 1 - docs/tutorials/configuring-app-metadata-for-linked-roles.md | 4 ++-- 3 files changed, 3 insertions(+), 4 deletions(-) diff --git a/docs/change-log/2025-04-11-incentivized-links.md b/docs/change-log/2025-04-11-incentivized-links.md index a172903c45..ff0f17fa62 100644 --- a/docs/change-log/2025-04-11-incentivized-links.md +++ b/docs/change-log/2025-04-11-incentivized-links.md @@ -15,4 +15,4 @@ Custom Incentivized Links are used to customize how your incentivized link embed Learn more about [creating and managing Custom Incentivized Links](https://discord.com/developers/docs/activities/development-guides#creating-and-managing-custom-incentivized-links) and [how to generate them from within your activity](https://discord.com/developers/docs/activities/development-guides#generating-a-custom-link-within-your-activity) with the shareLink API. -The Embedded App SDK is available via [npm](https://www.npmjs.com/package/@discord/embedded-app-sdk) and [GitHub](https://github.com/discord/embedded-app-sdk). You can check out our [installation guide and reference](https://discord.com/developers/docs/developer-tools/embedded-app-sdk) to get started with it! +The Embedded App SDK is available via [npm](https://www.npmjs.com/package/@discord/embedded-app-sdk) and [GitHub](https://github.com/discord/embedded-app-sdk). You can check out our [installation guide and reference](https://discord.com/developers/docs/developer-tools/embedded-app-sdk) to get started with it! \ No newline at end of file diff --git a/docs/resources/message.mdx b/docs/resources/message.mdx index 2df844d816..1ae270b204 100644 --- a/docs/resources/message.mdx +++ b/docs/resources/message.mdx @@ -737,7 +737,6 @@ user 125 in the content. ## Get Channel Messages /channels/[\{channel.id\}](/docs/resources/channel#channel-object)/messages -/channels/[\{channel.id\}](/docs/resources/channel#channel-object)/messages Retrieves the messages in a channel. Returns an array of [message](/docs/resources/message#message-object) objects on success. diff --git a/docs/tutorials/configuring-app-metadata-for-linked-roles.md b/docs/tutorials/configuring-app-metadata-for-linked-roles.md index 0c467f200a..fbdbbb1680 100644 --- a/docs/tutorials/configuring-app-metadata-for-linked-roles.md +++ b/docs/tutorials/configuring-app-metadata-for-linked-roles.md @@ -37,7 +37,7 @@ Apps need approval from installing users to perform actions inside of Discord. S - After the scope is selected, you should see a **Generated URL** which can be used to install your app :::info -See a list of all [OAuth2 scopes](/docs/topics/oauth2#shared-resources-oauth2-scopes), or read more on [user permissions](/docs/topics/permissions) in the documentation. +See a list of all [OAuth2 scopes](https://discord.com/developers/docs/topics/oauth2#shared-resources-oauth2-scopes), or read more on [user permissions](https://discord.com/developers/docs/topics/permissions) in the documentation. ::: ### Installing your app @@ -177,7 +177,7 @@ Finally, create a new private channel, and add the new linked role. ### Token storage -This app largely relies on Discord's [OAuth2](/docs/topics/oauth2) implementation to obtain access tokens. This model of user based authentication relies on storing refresh tokens, and using them to acquire access tokens. The example code in [`src/storage.js`](https://github.com/discord/linked-roles-sample/blob/main/src/storage.js) uses in-memory storage to manage these tokens, but for any production deployment a database with persistent storage should be used. +This app largely relies on Discord's [OAuth2](https://discord.com/developers/docs/topics/oauth2) implementation to obtain access tokens. This model of user based authentication relies on storing refresh tokens, and using them to acquire access tokens. The example code in [`src/storage.js`](https://github.com/discord/linked-roles-sample/blob/main/src/storage.js) uses in-memory storage to manage these tokens, but for any production deployment a database with persistent storage should be used. ### Advanced examples From 996f0f8fd90f3e6016f7be2d45c63484a98f2cb7 Mon Sep 17 00:00:00 2001 From: GeniusTimo Date: Wed, 23 Apr 2025 17:57:34 +0200 Subject: [PATCH 20/20] Lets add a trailing whitespace to clean up the diff --- docs/tutorials/configuring-app-metadata-for-linked-roles.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/tutorials/configuring-app-metadata-for-linked-roles.md b/docs/tutorials/configuring-app-metadata-for-linked-roles.md index fbdbbb1680..66be5ae77b 100644 --- a/docs/tutorials/configuring-app-metadata-for-linked-roles.md +++ b/docs/tutorials/configuring-app-metadata-for-linked-roles.md @@ -177,7 +177,7 @@ Finally, create a new private channel, and add the new linked role. ### Token storage -This app largely relies on Discord's [OAuth2](https://discord.com/developers/docs/topics/oauth2) implementation to obtain access tokens. This model of user based authentication relies on storing refresh tokens, and using them to acquire access tokens. The example code in [`src/storage.js`](https://github.com/discord/linked-roles-sample/blob/main/src/storage.js) uses in-memory storage to manage these tokens, but for any production deployment a database with persistent storage should be used. +This app largely relies on Discord's [OAuth2](https://discord.com/developers/docs/topics/oauth2) implementation to obtain access tokens. This model of user based authentication relies on storing refresh tokens, and using them to acquire access tokens. The example code in [`src/storage.js`](https://github.com/discord/linked-roles-sample/blob/main/src/storage.js) uses in-memory storage to manage these tokens, but for any production deployment a database with persistent storage should be used. ### Advanced examples