Skip to content

Updated endpoint paths after link normalization #7479

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 24 commits into from
Apr 23, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
24 commits
Select commit Hold shift + click to select a range
8e82316
Updated several links
GeniusTimo Apr 19, 2025
f8de1cc
Reverted a62c908953da8cd224d0904f4c06a9adb0b0290c for 2021-11-23-guil…
GeniusTimo Apr 19, 2025
fe1e87a
[WIP] Added placeholder for links within the request paths
GeniusTimo Apr 19, 2025
31e6ccf
Updated absolute to relative links
GeniusTimo Apr 19, 2025
424e81e
Updated the invite link to the Discord Developers Server
GeniusTimo Apr 19, 2025
7286784
Fixed table indentation
GeniusTimo Apr 19, 2025
8f71342
Changed protocol to https where appropriate
GeniusTimo Apr 20, 2025
65ed3d2
Updated Help Center links to improve maintainability
GeniusTimo Apr 20, 2025
4354cb9
Fixed table indentation once again
GeniusTimo Apr 20, 2025
fe1eeae
Updated links to the developer TOS and policy
GeniusTimo Apr 20, 2025
1867226
Merge branch 'main' into patch-1
GeniusTimo Apr 21, 2025
59fb320
Updated placeholders to new link format
GeniusTimo Apr 22, 2025
2d7666c
Merge branch 'main' into patch-1
GeniusTimo Apr 22, 2025
fc872be
Reverted "Updated Help Center links to improve maintainability"
GeniusTimo Apr 22, 2025
06e82b7
Merge branch 'main' into patch-1
GeniusTimo Apr 22, 2025
3415eed
Wrapped enpoint paths in inline code
GeniusTimo Apr 22, 2025
2e42c67
Changed Route attribute "type" to correct attribute "method"
GeniusTimo Apr 23, 2025
2d7e847
Added link for "{instance_id}"
GeniusTimo Apr 23, 2025
08fcf04
Reverted "Changed protocol to https where appropriate"
GeniusTimo Apr 23, 2025
b58d452
Reverted "Updated links to the developer TOS and policy"
GeniusTimo Apr 23, 2025
57ea157
Merge branch 'main' into patch-1
GeniusTimo Apr 23, 2025
9cbd305
Manually revert some commits and fix merge issues
GeniusTimo Apr 23, 2025
6141e54
Manually reviewed the changes once again and removed the last ones
GeniusTimo Apr 23, 2025
996f0f8
Lets add a trailing whitespace to clean up the diff
GeniusTimo Apr 23, 2025
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 4 additions & 4 deletions docs/change-log/2021-11-23-guild-scheduled-events.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down
1 change: 0 additions & 1 deletion docs/events/gateway.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -715,7 +715,6 @@ Returns an object with a valid WSS URL which the app can use when [Connecting](/
```

## Get Gateway Bot

<Route method="GET">/gateway/bot</Route>

:::warn
Expand Down
9 changes: 3 additions & 6 deletions docs/interactions/application-commands.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -301,9 +301,9 @@ Application command permissions allow your app to enable or disable commands for
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))
Expand Down Expand Up @@ -1307,14 +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

<Route method="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)</Route>

Delete a guild command. Returns `204 No Content` on success.

## Bulk Overwrite Guild Application Commands

<Route method="PUT">/applications/\{application.id/docs/resources/application#application-object\}/guilds/\{guild.id/docs/resources/guild#guild-object\}/commands</Route>
<Route method="PUT">/applications/[\{application.id\}](/docs/resources/application#application-object)/guilds/[\{guild.id\}](/docs/resources/guild#guild-object)/commands</Route>

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.

Expand All @@ -1341,7 +1339,6 @@ 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

<Route method="GET">/applications/[\{application.id\}](/docs/resources/application#application-object)/guilds/[\{guild.id\}](/docs/resources/guild#guild-object)/commands/permissions</Route>

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.
Expand Down
2 changes: 1 addition & 1 deletion docs/interactions/receiving-and-responding.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -389,7 +389,7 @@ The endpoints below are not bound to the application's [Global Rate Limit](/docs
:::

## Create Interaction Response
<Route method="POST">/interactions/[\{interaction.id}](/docs/interactions/receiving-and-responding#interaction-object)/[\{interaction.token\}](/docs/interactions/receiving-and-responding#interaction-object)/callback</Route>
<Route method="POST">/interactions/[\{interaction.id\}](/docs/interactions/receiving-and-responding#interaction-object)/[\{interaction.token\}](/docs/interactions/receiving-and-responding#interaction-object)/callback</Route>

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).

Expand Down
2 changes: 0 additions & 2 deletions docs/resources/application-role-connection-metadata.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -39,13 +39,11 @@ Each metadata type offers a comparison operation that allows guilds to configure
:::

## Get Application Role Connection Metadata Records

<Route method="GET">/applications/[\{application.id\}](/docs/resources/application#application-object)/role-connections/metadata</Route>

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

<Route method="PUT">/applications/[\{application.id\}](/docs/resources/application#application-object)/role-connections/metadata</Route>

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.
Expand Down
2 changes: 1 addition & 1 deletion docs/resources/application.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -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
<Route>/applications/[\{application.id\}](/docs/resources/application#application-object)/activity-instances/[\{instance_id\}](/docs/resources/application#get-application-activity-instance-activity-instance-object)</Route>
<Route method="GET">/applications/[\{application.id\}](/docs/resources/application#application-object)/activity-instances/[\{instance_id\}](/docs/resources/application#get-application-activity-instance-activity-instance-object)</Route>

Returns a serialized activity instance, if it exists. Useful for [preventing unwanted activity sessions](/docs/activities/development-guides/multiplayer-experience#preventing-unwanted-activity-sessions).

Expand Down
2 changes: 1 addition & 1 deletion docs/resources/entitlement.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -152,7 +152,7 @@ After creating a test entitlement, you'll need to reload your Discord client. Af
```

## Delete Test Entitlement
<Route method="DELETE">/applications/[\{application.id\}](/docs/resources/application#application-object)/entitlements/[\{entitlement.id\}](/docs/resources/entitlement#entitlement-object)</Route>
<Route method="DELETE">/applications/[\{application.id\}](/docs/resources/application#application-object)/entitlements/[\{entitlement.id\}](/docs/resources/entitlement#entitlement-object)</Route>

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

Expand Down
8 changes: 4 additions & 4 deletions docs/resources/guild-scheduled-event.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -305,7 +305,7 @@ This endpoint supports the `X-Audit-Log-Reason` header.
\*\* Required for events with `'entity_type': EXTERNAL`

## Get Guild Scheduled Event
<Route method="GET">/guilds/[\{guild.id\}](/docs/resources/guild#guild-object)/scheduled-events/[\{guild-scheduled-event.id\}](/docs/resources/guild-scheduled-event#guild-scheduled-event-object)</Route>
<Route method="GET">/guilds/[\{guild.id\}](/docs/resources/guild#guild-object)/scheduled-events/[\{guild_scheduled_event.id\}](/docs/resources/guild-scheduled-event#guild-scheduled-event-object)</Route>

Get a guild scheduled event. Returns a [guild scheduled event](/docs/resources/guild-scheduled-event#guild-scheduled-event-object) object on success.

Expand All @@ -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
<Route method="PATCH">/guilds/[\{guild.id\}](/docs/resources/guild#guild-object)/scheduled-events/[\{guild-scheduled-event.id\}](/docs/resources/guild-scheduled-event#guild-scheduled-event-object)</Route>
<Route method="PATCH">/guilds/[\{guild.id\}](/docs/resources/guild#guild-object)/scheduled-events/[\{guild_scheduled_event.id\}](/docs/resources/guild-scheduled-event#guild-scheduled-event-object)</Route>

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.

Expand Down Expand Up @@ -360,12 +360,12 @@ All parameters to this endpoint are optional
- `scheduled_end_time` must be provided

## Delete Guild Scheduled Event
<Route method="DELETE">/guilds/[\{guild.id\}](/docs/resources/guild#guild-object)/scheduled-events/[\{guild-scheduled-event.id\}](/docs/resources/guild-scheduled-event#guild-scheduled-event-object)</Route>
<Route method="DELETE">/guilds/[\{guild.id\}](/docs/resources/guild#guild-object)/scheduled-events/[\{guild_scheduled_event.id\}](/docs/resources/guild-scheduled-event#guild-scheduled-event-object)</Route>

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
<Route method="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</Route>
<Route method="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</Route>

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.

Expand Down
10 changes: 5 additions & 5 deletions docs/resources/message.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -835,25 +835,25 @@ Crosspost a message in an Announcement Channel to following channels. This endpo
Returns a [message](/docs/resources/message#message-object) object. Fires a [Message Update](/docs/events/gateway-events#message-update) Gateway event.

## Create Reaction
<Route method="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</Route>
<Route method="PUT">/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</Route>

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
<Route method="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</Route>
<Route method="DELETE">/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</Route>

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
<Route method="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)</Route>
<Route method="DELETE">/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)</Route>

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
<Route method="GET">/channels/[\{channel.id\}](/docs/resources/channel#channel-object)/messages/[\{message.id\}](/docs/resources/message#message-object)/reactions/[\{emoji/docs/resources/emoji#emoji-object}</Route>
<Route method="GET">/channels/[\{channel.id\}](/docs/resources/channel#channel-object)/messages/[\{message.id\}](/docs/resources/message#message-object)/reactions/[\{emoji.id\}](/docs/resources/emoji#emoji-object)</Route>

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.
Expand All @@ -879,7 +879,7 @@ The `emoji` must be [URL Encoded](https://en.wikipedia.org/wiki/Percent-encoding
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
<Route method="DELETE">/channels/[\{channel.id\}](/docs/resources/channel#channel-object)/messages/[\{message.id\}](/docs/resources/message#message-object)/reactions/[\{emoji/docs/resources/emoji#emoji-object}</Route>
<Route method="DELETE">/channels/[\{channel.id\}](/docs/resources/channel#channel-object)/messages/[\{message.id\}](/docs/resources/message#message-object)/reactions/[\{emoji.id\}](/docs/resources/emoji#emoji-object)</Route>

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.
Expand Down
2 changes: 1 addition & 1 deletion docs/resources/sticker.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -101,7 +101,7 @@ Represents a pack of standard stickers.
```

## Get Sticker
<Route method="GET">/stickers/[\{sticker.id\}](/docs/resources/sticker#sticker-object)</Route>
<Route method="GET">/stickers/[\{sticker.id\}](/docs/resources/sticker#sticker-object)</Route>

Returns a [sticker](/docs/resources/sticker#sticker-object) object for the given sticker ID.

Expand Down
Loading