Package discord4j.rest.route

Class Routes

java.lang.Object

discord4j.rest.route.Routes

public abstract class Routes
extends Object

A collection of Route object definitions.

Since:

3.0

Field Summary

Fields

Modifier and Type	Field	Description
static final Route	ADD_THREAD_MEMBER
static final Route	APPLICATION_COMMAND_PERMISSIONS_BULK_MODIFY
static final Route	APPLICATION_COMMAND_PERMISSIONS_GET
static final Route	APPLICATION_COMMAND_PERMISSIONS_MODIFY
static final Route	APPLICATION_EMOJI_CREATE	Create a new emoji for the application.
static final Route	APPLICATION_EMOJI_DELETE	Delete the given emoji.
static final Route	APPLICATION_EMOJI_GET	Returns an emoji object for the given application and emoji IDs.
static final Route	APPLICATION_EMOJI_MODIFY	Modify the given emoji.
static final Route	APPLICATION_EMOJIS_GET	Returns an object containing a list of emoji objects for the given application under the items key.
static final Route	APPLICATION_INFO_GET	Returns the bot's OAuth2 application info.
static final Route	APPLICATION_INFO_MODIFY
static final Route	APPLICATION_ROLE_CONNECTION_METADATA_GET	Returns a list of application role connection metadata objects for the given application.
static final Route	APPLICATION_ROLE_CONNECTION_METADATA_MODIFY	Updates and returns a list of application role connection metadata objects for the given application.
static final Route	AUDIT_LOG_GET	Returns an audit log object for the guild.
static final Route	AUTHORIZATION_INFO_GET
static final Route	AUTO_MOD_RULE_CREATE	Create a new rule.
static final Route	AUTO_MOD_RULE_DELETE	Delete a rule.
static final Route	AUTO_MOD_RULE_GET	Get a single rule.
static final Route	AUTO_MOD_RULE_MODIFY	Modify an existing rule.
static final Route	AUTO_MOD_RULES_GET	Get a list of all rules currently configured for guild.
static final String	BASE_URL	The base URL for all API requests.
static final Route	CHANNEL_DELETE	Delete a guild channel, or close a private message.
static final Route	CHANNEL_GET	Get a channel by ID.
static final Route	CHANNEL_INVITE_CREATE	Create a new invite object for the channel.
static final Route	CHANNEL_INVITES_GET	Returns a list of invite objects (with invite metadata) for the channel.
static final Route	CHANNEL_MODIFY	Update a channels settings.
static final Route	CHANNEL_MODIFY_PARTIAL	Update a channels settings.
static final Route	CHANNEL_PERMISSION_DELETE	Delete a channel permission overwrite for a user or role in a channel.
static final Route	CHANNEL_PERMISSIONS_EDIT	Edit the channel permission overwrites for a user or role in a channel.
static final Route	CHANNEL_WEBHOOK_CREATE	Create a new webhook.
static final Route	CHANNEL_WEBHOOKS_GET	Returns a list of channel webhook objects.
static final Route	CONSUME_ENTITLEMENT	For One-Time Purchase consumable SKUs, marks a given entitlement for the user as consumed.
static final Route	CREATE_GUILD_SOUNDBOARD_SOUND	Create a new soundboard sound for the guild.
static final Route	CREATE_STAGE_INSTANCE
static final Route	CREATE_TEST_ENTITLEMENT	Creates a test entitlement for a given application.
static final Route	CROSSPOST_MESSAGE	Crosspost a Message into all guilds what follow the news channel indicated.
static final Route	CURRENT_MEMBER_MODIFY	Modifies the current member in a guild.
static final Route	CURRENT_USER_GET	Returns the user object of the requester's account.
static final Route	CURRENT_USER_GUILD_MEMBER_GET	Returns a guild member object for the current user.
static final Route	CURRENT_USER_GUILDS_GET	Returns a list of partial guild objects the current user is a member of.
static final Route	CURRENT_USER_MODIFY	Modify the requester's user account settings.
static final Route	DELETE_GUILD_SOUNDBOARD_SOUND	Delete the given soundboard sound.
static final Route	DELETE_STAGE_INSTANCE
static final Route	DELETE_TEST_ENTITLEMENT	Deletes a test entitlement for a given application.
static final Route	END_POLL	Request to end a poll early.
static final Route	FOLLOW_NEWS_CHANNEL	Follow a News Channel to send messages to a target channel.
static final Route	GATEWAY_BOT_GET	Returns an object with the same information as Get Gateway, plus a shards key, containing the recommended number of shards to connect with (as an integer).
static final Route	GATEWAY_GET	Returns an object with a single valid WSS URL, which the client can use as a basis for Connecting.
static final Route	GET_GUILD_SOUNDBOARD_SOUND	Returns a soundboard sound object for the given sound id.
static final Route	GET_SKU_SUBSCRIPTION	Get a subscription by its ID.
static final Route	GET_STAGE_INSTANCE
static final Route	GET_THREAD_MEMBER
static final Route	GLOBAL_APPLICATION_COMMAND_DELETE
static final Route	GLOBAL_APPLICATION_COMMAND_GET
static final Route	GLOBAL_APPLICATION_COMMAND_MODIFY
static final Route	GLOBAL_APPLICATION_COMMANDS_BULK_OVERWRITE
static final Route	GLOBAL_APPLICATION_COMMANDS_CREATE
static final Route	GLOBAL_APPLICATION_COMMANDS_GET
static final Route	GROUP_DM_CREATE	Create a new group DM channel with multiple users.
static final Route	GROUP_DM_RECIPIENT_ADD	Adds a recipient to a Group DM using their access token.
static final Route	GROUP_DM_RECIPIENT_DELETE	Removes a recipient from a Group DM.
static final Route	GUILD_APPLICATION_COMMAND_DELETE
static final Route	GUILD_APPLICATION_COMMAND_GET
static final Route	GUILD_APPLICATION_COMMAND_MODIFY
static final Route	GUILD_APPLICATION_COMMAND_PERMISSIONS_GET
static final Route	GUILD_APPLICATION_COMMANDS_BULK_OVERWRITE
static final Route	GUILD_APPLICATION_COMMANDS_CREATE
static final Route	GUILD_APPLICATION_COMMANDS_GET
static final Route	GUILD_BAN_BULK	Ban up to 200 users from a guild, and optionally delete previous messages sent by the banned users.
static final Route	GUILD_BAN_CREATE	Create a guild ban, and optionally delete previous messages sent by the banned user.
static final Route	GUILD_BAN_GET	Returns a ban object for the given user or a 404 not found if the ban cannot be found.
static final Route	GUILD_BAN_REMOVE	Remove the ban for a user.
static final Route	GUILD_BANS_GET	Returns a list of ban objects for the users banned from this guild.
static final Route	GUILD_CHANNEL_CREATE	Create a new channel object for the guild.
static final Route	GUILD_CHANNEL_POSITIONS_MODIFY	Modify the positions of a set of role objects for the guild.
static final Route	GUILD_CHANNELS_GET	Returns a list of guild channel objects.
static final Route	GUILD_CREATE	Create a new guild.
static final Route	GUILD_DELETE	Delete a guild permanently.
static final Route	GUILD_EMOJI_CREATE	Create a new emoji for the guild.
static final Route	GUILD_EMOJI_DELETE	Delete the given emoji.
static final Route	GUILD_EMOJI_GET	Returns an emoji object for the given guild and emoji IDs.
static final Route	GUILD_EMOJI_MODIFY	Modify the given emoji.
static final Route	GUILD_EMOJIS_GET	Returns a list of emoji objects for the given guild.
static final Route	GUILD_GET	Returns the guild object for the given id.
static final Route	GUILD_INTEGRATION_CREATE	Attach an integration object from the current user to the guild.
static final Route	GUILD_INTEGRATION_DELETE	Delete the attached integration object for the guild.
static final Route	GUILD_INTEGRATION_MODIFY	Modify the behavior and settings of a integration object for the guild.
static final Route	GUILD_INTEGRATION_SYNC	Sync an integration.
static final Route	GUILD_INTEGRATIONS_GET	Returns a list of integration objects for the guild.
static final Route	GUILD_INVITES_GET	Returns a list of invite objects (with invite metadata) for the guild.
static final Route	GUILD_LEAVE	Leave a guild.
static final Route	GUILD_MEMBER_ADD	Adds a user to the guild, provided you have a valid oauth2 access token for the user with the guilds.join scope.
static final Route	GUILD_MEMBER_GET	Returns a guild member object for the specified user.
static final Route	GUILD_MEMBER_MODIFY	Modify attributes of a guild member.
static final Route	GUILD_MEMBER_REMOVE	Remove a member from a guild.
static final Route	GUILD_MEMBER_ROLE_ADD	Adds a role to a guild member.
static final Route	GUILD_MEMBER_ROLE_REMOVE	Removes a role from a guild member.
static final Route	GUILD_MEMBERS_LIST	Returns a list of guild member objects that are members of the guild.
static final Route	GUILD_MODIFY	Modify a guild's settings.
static final Route	GUILD_ONBOARDING_GET	Returns the Onboarding object for the guild.
static final Route	GUILD_ONBOARDING_MODIFY	Modifies the onboarding configuration of the guild.
static final Route	GUILD_PREVIEW_GET	Returns the guild preview object.
static final Route	GUILD_PRUNE_BEGIN	Begin a prune operation.
static final Route	GUILD_PRUNE_COUNT_GET	Returns an object with one 'pruned' key indicating the number of members that would be removed in a prune operation.
static final Route	GUILD_ROLE_CREATE	Create a new role for the guild.
static final Route	GUILD_ROLE_DELETE	Delete a guild role.
static final Route	GUILD_ROLE_GET	Returns a role object for the specified role id.
static final Route	GUILD_ROLE_MODIFY	Modify a guild role.
static final Route	GUILD_ROLE_POSITIONS_MODIFY	Modify the positions of a set of role objects for the guild.
static final Route	GUILD_ROLES_GET	Returns a list of role objects for the guild.
static final Route	GUILD_SCHEDULED_EVENT_CREATE	Creates a guild scheduled event for the given guild.
static final Route	GUILD_SCHEDULED_EVENT_DELETE	Deletes a scheduled event for the given guild.
static final Route	GUILD_SCHEDULED_EVENT_GET	Returns a scheduled event for the given guild.
static final Route	GUILD_SCHEDULED_EVENT_MODIFY	Modifies a scheduled event for the given guild.
static final Route	GUILD_SCHEDULED_EVENT_USERS_GET	Returns a list of users RSVP'd to the scheduled event for the given guild.
static final Route	GUILD_SCHEDULED_EVENTS_GET	Returns a list of all scheduled events for a guild.
static final Route	GUILD_STICKER_CREATE	Create a new sticker for the guild.
static final Route	GUILD_STICKER_DELETE	Delete the given sticker.
static final Route	GUILD_STICKER_GET	Returns a sticker object for the given guild and sticker IDs.
static final Route	GUILD_STICKER_MODIFY	Modify the given sticker.
static final Route	GUILD_STICKERS_GET	Returns an array of sticker objects for the given guild.
static final Route	GUILD_TEMPLATE_CREATE	Creates a template for the guild.
static final Route	GUILD_TEMPLATE_DELETE	Deletes the template.
static final Route	GUILD_TEMPLATE_GET	Get a template.
static final Route	GUILD_TEMPLATE_LIST_GET	Returns an array of template objects.
static final Route	GUILD_TEMPLATE_MODIFY	Modifies the template's metadata.
static final Route	GUILD_TEMPLATE_SYNC	Syncs the template to the guild's current state.
static final Route	GUILD_VOICE_REGIONS_GET	Returns a list of voice region objects for the guild.
static final Route	GUILD_WEBHOOKS_GET	Returns a list of guild webhook objects.
static final Route	GUILD_WIDGET_GET	Returns the guild widget object.
static final Route	GUILD_WIDGET_MODIFY	Modify a guild widget object for the guild.
static final Route	INTERACTION_RESPONSE_CREATE
static final Route	INVITE_ACCEPT	Accept an invite.
static final Route	INVITE_DELETE	Delete an invite.
static final Route	INVITE_GET	Returns an invite object for the given code.
static final Route	JOIN_THREAD
static final Route	LEAVE_THREAD
static final Route	LIST_ACTIVE_GUILD_THREADS
static final Route	LIST_DEFAULT_SOUNDBOARD_SOUNDS	Returns an array of soundboard sound objects that can be used by all users.
static final Route	LIST_ENTITLEMENTS	Returns a list of entitlements for a given application.
static final Route	LIST_GUILD_SOUNDBOARD_SOUNDS	Returns a list of the guild's soundboard sounds.
static final Route	LIST_JOINED_PRIVATE_ARCHIVED_THREADS
static final Route	LIST_PRIVATE_ARCHIVED_THREADS
static final Route	LIST_PUBLIC_ARCHIVED_THREADS
static final Route	LIST_SKU_SUBSCRIPTIONS	Returns all subscriptions containing the SKU, filtered by user.
static final Route	LIST_SKUS	Returns a list of SKUs for a given application.
static final Route	LIST_THREAD_MEMBERS
static final Route	MESSAGE_CREATE	Post a message to a guild text or DM channel.
static final Route	MESSAGE_DELETE	Delete a message.
static final Route	MESSAGE_DELETE_BULK	Delete multiple messages in a single request.
static final Route	MESSAGE_EDIT	Edit a previously sent message.
static final Route	MESSAGE_GET	Returns a specific message in the channel.
static final Route	MESSAGES_GET	Returns the messages for a channel.
static final Route	MESSAGES_PINNED_ADD	Pin a message in a channel.
static final Route	MESSAGES_PINNED_DELETE	Delete a pinned message in a channel.
static final Route	MESSAGES_PINNED_GET	Returns all pinned messages in the channel as an array of message objects.
static final Route	MODIFY_GUILD_SOUNDBOARD_SOUND	Modify the given soundboard sound.
static final Route	MODIFY_STAGE_INSTANCE
static final Route	OTHERS_VOICE_STATE_GET	Returns the specified user's voice state in the guild.
static final Route	OTHERS_VOICE_STATE_MODIFY	Updates another user's voice state.
static final Route	POLL_ANSWER_VOTERS_GET	Returns a list of users that voted for the given `answer_id` in the poll for the given message represented by its `message.id` and `channel.id`.
static final Route	REACTION_CREATE	Create a reaction for the message.
static final Route	REACTION_DELETE	Deletes all the reactions for a given emoji on a message.
static final Route	REACTION_DELETE_OWN	Delete a reaction the current user has made for the message.
static final Route	REACTION_DELETE_USER	Deletes another user's reaction.
static final Route	REACTIONS_DELETE_ALL	Deletes all reactions on a message.
static final Route	REACTIONS_GET	Get a list of users that reacted with this emoji.
static final Route	REMOVE_THREAD_MEMBER
static final Route	SEARCH_GUILD_MEMBERS_GET	Returns a list of guild member objects whose username or nickname starts with a provided string.
static final Route	SELF_VOICE_STATE_GET	Returns the current user's voice state in the guild.
static final Route	SELF_VOICE_STATE_MODIFY	Updates the current user's voice state.
static final Route	SEND_SOUNDBOARD_SOUND	Send a soundboard sound to a voice channel the user is connected to.
static final Route	START_THREAD_IN_FORUM_CHANNEL_MESSAGE
static final Route	START_THREAD_WITH_MESSAGE
static final Route	START_THREAD_WITHOUT_MESSAGE
static final Route	STICKER_GET	Returns a sticker object for the given sticker ID.
static final Route	STICKER_PACK_GET	Returns a sticker pack object for the given sticker pack ID.
static final Route	STICKER_PACKS_GET	Returns the list of available sticker packs.
static final Route	TEMPLATE_GUILD_CREATE	Create a new guild from template.
static final Route	TOKEN
static final Route	TOKEN_REVOKE
static final Route	TYPING_INDICATOR_TRIGGER	Post a typing indicator for the specified channel.
static final Route	USER_APPLICATIONS_ROLE_CONNECTION_GET	Returns the application role connection for the user.
static final Route	USER_APPLICATIONS_ROLE_CONNECTION_MODIFY	Updates and returns the application role connection for the user.
static final Route	USER_CONNECTIONS_GET	Returns a list of connection objects.
static final Route	USER_DM_CREATE	Create a new DM channel with a user.
static final Route	USER_GET	Returns a user object for a given user ID.
static final Route	VOICE_REGION_LIST	Returns an array of voice region objects that can be used when creating servers.
static final Route	WEBHOOK_DELETE	Delete a webhook permanently.
static final Route	WEBHOOK_EXECUTE	This endpoint supports both JSON and form data bodies.
static final Route	WEBHOOK_EXECUTE_GITHUB
static final Route	WEBHOOK_EXECUTE_SLACK
static final Route	WEBHOOK_GET	Returns the new webhook object for the given id.
static final Route	WEBHOOK_MESSAGE_DELETE
static final Route	WEBHOOK_MESSAGE_EDIT
static final Route	WEBHOOK_MESSAGE_GET
static final Route	WEBHOOK_MODIFY	Modify a webhook.
static final Route	WEBHOOK_TOKEN_DELETE	Same as above, except this call does not require authentication.
static final Route	WEBHOOK_TOKEN_GET	Same as WEBHOOK_GET, except this call does not require authentication and returns no user in the webhook object.
static final Route	WEBHOOK_TOKEN_MODIFY	Same as WEBHOOK_MODIFY, except this call does not require authentication and returns no user in the webhook object.

Constructor Summary

Constructors

Constructor	Description
Routes()

Method Summary

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

BASE_URL

public static final String BASE_URL

The base URL for all API requests.

See Also:

• https://discord.com/developers/docs/reference#base-url
• Constant Field Values

GATEWAY_GET

public static final Route GATEWAY_GET

Returns an object with a single valid WSS URL, which the client can use as a basis for Connecting. Clients should cache this value and only call this endpoint to retrieve a new URL if they are unable to properly establish a connection using the cached version of the URL.

See Also:

• https://discord.com/developers/docs/topics/gateway#get-gateway

GATEWAY_BOT_GET

public static final Route GATEWAY_BOT_GET

Returns an object with the same information as Get Gateway, plus a shards key, containing the recommended number of shards to connect with (as an integer). Bots that want to dynamically/automatically spawn shard processes should use this endpoint to determine the number of processes to run. This route should be called once when starting up numerous shards, with the response being cached and passed to all sub-shards/processes. Unlike the Get Gateway, this route should not be cached for extended periods of time as the value is not guaranteed to be the same per-call, and changes as the bot joins/leaves guilds.

See Also:

• https://discord.com/developers/docs/topics/gateway#get-gateway-bot

AUDIT_LOG_GET

public static final Route AUDIT_LOG_GET

Returns an audit log object for the guild. Requires the 'VIEW_AUDIT_LOG' permission.

See Also:

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

AUTO_MOD_RULES_GET

public static final Route AUTO_MOD_RULES_GET

Get a list of all rules currently configured for guild. Returns a list of auto moderation rule objects for the given guild. Requires the 'MANAGE_GUILD' permission.

See Also:

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

AUTO_MOD_RULE_GET

public static final Route AUTO_MOD_RULE_GET

Get a single rule. Returns an auto moderation rule object. Requires the 'MANAGE_GUILD' permission.

See Also:

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

AUTO_MOD_RULE_CREATE

public static final Route AUTO_MOD_RULE_CREATE

Create a new rule. Returns an auto moderation rule on success. Requires the 'MANAGE_GUILD' permission.

See Also:

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

AUTO_MOD_RULE_MODIFY

public static final Route AUTO_MOD_RULE_MODIFY

Modify an existing rule. Returns an auto moderation rule on success. Requires the 'MANAGE_GUILD' permission.

See Also:

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

AUTO_MOD_RULE_DELETE

public static final Route AUTO_MOD_RULE_DELETE

Delete a rule. Returns a 204 on success. Requires the 'MANAGE_GUILD' permission.

See Also:

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

CHANNEL_GET

public static final Route CHANNEL_GET

Get a channel by ID. Returns a guild channel or dm channel object.

See Also:

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

CHANNEL_MODIFY

public static final Route CHANNEL_MODIFY

Update a channels settings. Requires the 'MANAGE_CHANNELS' permission for the guild. Returns a guild channel on success, and a 400 BAD REQUEST on invalid parameters. Fires a Channel Update Gateway event.

See Also:

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

CHANNEL_MODIFY_PARTIAL

public static final Route CHANNEL_MODIFY_PARTIAL

Update a channels settings. Requires the 'MANAGE_CHANNELS' permission for the guild. Returns a guild channel on success, and a 400 BAD REQUEST on invalid parameters. Fires a Channel Update Gateway event. All the JSON Params are optional.

See Also:

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

CHANNEL_DELETE

public static final Route CHANNEL_DELETE

Delete a guild channel, or close a private message. Requires the 'MANAGE_CHANNELS' permission for the guild. Returns a guild channel or dm channel object on success. Fires a Channel Delete Gateway event.

See Also:

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

MESSAGES_GET

public static final Route MESSAGES_GET

Returns the messages for a channel. If operating on a guild channel, this endpoint requires the 'READ_MESSAGES' permission to be present on the current user. Returns an array of message objects on success.

See Also:

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

MESSAGE_GET

public static final Route MESSAGE_GET

Returns a specific message in the channel. If operating on a guild channel, this endpoints requires the 'READ_MESSAGE_HISTORY' permission to be present on the current user. Returns a message object on success.

See Also:

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

MESSAGE_CREATE

public static final Route MESSAGE_CREATE

Post a message to a guild text or DM channel. If operating on a guild channel, this endpoint requires the 'SEND_MESSAGES' permission to be present on the current user. Returns a message object. Fires a Message Create Gateway event. See message formatting for more information on how to properly format messages.

This endpoint supports both JSON and form data bodies. It does require multipart/form-data requests instead of the normal JSON request type when uploading files. Make sure you set your Content-Type to multipart/form-data if you're doing that. Note that in that case, the embed field cannot be used, but you can pass an url-encoded JSON body as a form value for payload_json.

See Also:

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

REACTION_CREATE

public static final Route REACTION_CREATE

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.

See Also:

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

REACTION_DELETE_OWN

public static final Route REACTION_DELETE_OWN

Delete a reaction the current user has made for the message. Returns a 204 empty response on success.

See Also:

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

REACTION_DELETE_USER

public static final Route REACTION_DELETE_USER

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.

See Also:

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

REACTION_DELETE

public static final Route REACTION_DELETE

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.

See Also:

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

REACTIONS_GET

public static final Route REACTIONS_GET

Get a list of users that reacted with this emoji. Returns an array of user objects on success.

See Also:

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

REACTIONS_DELETE_ALL

public static final Route REACTIONS_DELETE_ALL

Deletes all reactions on a message. This endpoint requires the 'MANAGE_MESSAGES' permission to be present on the current user.

See Also:

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

MESSAGE_EDIT

public static final Route MESSAGE_EDIT

Edit a previously sent message. You can only edit messages that have been sent by the current user. Returns a message object. Fires a Message Update Gateway event.

See Also:

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

MESSAGE_DELETE

public static final Route MESSAGE_DELETE

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 Gateway event.

See Also:

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

MESSAGE_DELETE_BULK

public static final Route MESSAGE_DELETE_BULK

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 multiple Message Delete Gateway events.

The gateway will ignore any individual messages that do not exist or do not belong to this channel, but these will count towards the minimum and maximum message count. Duplicate snowflakes will only be counted once for these limits.

This endpoint will not delete messages older than 2 weeks, and will fail if any message provided is older than that. An endpoint will be added in the future to prune messages older than 2 weeks from a channel.

See Also:

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

CROSSPOST_MESSAGE

public static final Route CROSSPOST_MESSAGE

Crosspost a Message into all guilds what follow the news channel indicated. This endpoint requires the 'DISCOVERY' feature to be present for the guild and 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 204 empty response on success.

See Also:

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

CHANNEL_PERMISSIONS_EDIT

public static final Route CHANNEL_PERMISSIONS_EDIT

Edit the channel permission overwrites 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. For more information about permissions, see permissions.

See Also:

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

CHANNEL_INVITES_GET

public static final Route CHANNEL_INVITES_GET

Returns a list of invite objects (with invite metadata) for the channel. Only usable for guild channels. Requires the 'MANAGE_CHANNELS' permission.

See Also:

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

CHANNEL_INVITE_CREATE

public static final Route CHANNEL_INVITE_CREATE

Create a new invite 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 object.

See Also:

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

CHANNEL_PERMISSION_DELETE

public static final Route CHANNEL_PERMISSION_DELETE

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. For more information about permissions, see permissions.

See Also:

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

FOLLOW_NEWS_CHANNEL

public static final Route FOLLOW_NEWS_CHANNEL

Follow a News Channel to send messages to a target channel. Requires the `MANAGE_WEBHOOKS` permission in the target channel. Returns a followed channel object.

See Also:

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

TYPING_INDICATOR_TRIGGER

public static final Route TYPING_INDICATOR_TRIGGER

Post a typing indicator for the specified channel. Generally bots should not implement 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. Returns a 204 empty response on success. Fires a Typing Start Gateway event.

See Also:

• https://discord.com/developers/docs/resources/channel#trigger-typing-indicator

MESSAGES_PINNED_GET

public static final Route MESSAGES_PINNED_GET

Returns all pinned messages in the channel as an array of message objects. Requires the `VIEW_CHANNEL` permission. If the user is missing the `READ_MESSAGE_HISTORY` permission in the channel, then no pins will be returned.

See Also:

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

MESSAGES_PINNED_ADD

public static final Route MESSAGES_PINNED_ADD

Pin a message in a channel. Requires the 'PIN_MESSAGES' permission. Returns a 204 empty response on success.

See Also:

• https://discord.com/developers/docs/resources/message#pin-message

MESSAGES_PINNED_DELETE

public static final Route MESSAGES_PINNED_DELETE

Delete a pinned message in a channel. Requires the 'PIN_MESSAGES' permission. Returns a 204 empty response on success.

See Also:

• https://discord.com/developers/docs/resources/message#unpin-message

GROUP_DM_RECIPIENT_ADD

public static final Route GROUP_DM_RECIPIENT_ADD

Adds a recipient to a Group DM using their access token.

See Also:

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

GROUP_DM_RECIPIENT_DELETE

public static final Route GROUP_DM_RECIPIENT_DELETE

Removes a recipient from a Group DM.

See Also:

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

START_THREAD_WITH_MESSAGE

public static final Route START_THREAD_WITH_MESSAGE

START_THREAD_WITHOUT_MESSAGE

public static final Route START_THREAD_WITHOUT_MESSAGE

START_THREAD_IN_FORUM_CHANNEL_MESSAGE

public static final Route START_THREAD_IN_FORUM_CHANNEL_MESSAGE

JOIN_THREAD

public static final Route JOIN_THREAD

ADD_THREAD_MEMBER

public static final Route ADD_THREAD_MEMBER

LEAVE_THREAD

public static final Route LEAVE_THREAD

REMOVE_THREAD_MEMBER

public static final Route REMOVE_THREAD_MEMBER

GET_THREAD_MEMBER

public static final Route GET_THREAD_MEMBER

LIST_THREAD_MEMBERS

public static final Route LIST_THREAD_MEMBERS

LIST_PUBLIC_ARCHIVED_THREADS

public static final Route LIST_PUBLIC_ARCHIVED_THREADS

LIST_PRIVATE_ARCHIVED_THREADS

public static final Route LIST_PRIVATE_ARCHIVED_THREADS

LIST_JOINED_PRIVATE_ARCHIVED_THREADS

public static final Route LIST_JOINED_PRIVATE_ARCHIVED_THREADS

POLL_ANSWER_VOTERS_GET

public static final Route POLL_ANSWER_VOTERS_GET

Returns a list of users that voted for the given `answer_id` in the poll for the given message represented by its `message.id` and `channel.id`.

See Also:

• https://discord.com/developers/docs/resources/poll#get-answer-voters

END_POLL

public static final Route END_POLL

Request to end a poll early. This will end the poll and return the final results.

See Also:

• https://discord.com/developers/docs/resources/poll#end-poll

STICKER_GET

public static final Route STICKER_GET

Returns a sticker object for the given sticker ID.

See Also:

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

STICKER_PACKS_GET

public static final Route STICKER_PACKS_GET

Returns the list of available sticker packs.

See Also:

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

STICKER_PACK_GET

public static final Route STICKER_PACK_GET

Returns a sticker pack object for the given sticker pack ID.

See Also:

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

GUILD_STICKERS_GET

public static final Route GUILD_STICKERS_GET

Returns an array of sticker objects for the given guild. Includes user fields if the bot has the MANAGE_EMOJIS_AND_STICKERS permission.

See Also:

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

GUILD_STICKER_GET

public static final Route GUILD_STICKER_GET

Returns a sticker object for the given guild and sticker IDs. Includes the user field if the bot has the MANAGE_EMOJIS_AND_STICKERS permission.

See Also:

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

GUILD_STICKER_CREATE

public static final Route GUILD_STICKER_CREATE

Create a new sticker for the guild. Send a multipart/form-data body. Requires the MANAGE_EMOJIS_AND_STICKERS permission. Returns the new sticker object on success.

See Also:

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

GUILD_STICKER_MODIFY

public static final Route GUILD_STICKER_MODIFY

Modify the given sticker. Requires the MANAGE_EMOJIS_AND_STICKERS permission. Returns the updated sticker object on success.

See Also:

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

GUILD_STICKER_DELETE

public static final Route GUILD_STICKER_DELETE

Delete the given sticker. Requires the MANAGE_EMOJIS_AND_STICKERS permission. Returns 204 No Content on success.

See Also:

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

GUILD_EMOJIS_GET

public static final Route GUILD_EMOJIS_GET

Returns a list of emoji objects for the given guild.

See Also:

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

GUILD_EMOJI_GET

public static final Route GUILD_EMOJI_GET

Returns an emoji object for the given guild and emoji IDs.

See Also:

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

GUILD_EMOJI_CREATE

public static final Route GUILD_EMOJI_CREATE

Create a new emoji for the guild. Returns the new emoji object on success. Fires a Guild Emojis Update Gateway event.

See Also:

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

GUILD_EMOJI_MODIFY

public static final Route GUILD_EMOJI_MODIFY

Modify the given emoji. Returns the updated emoji object on success. Fires a Guild Emojis Update Gateway event.

See Also:

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

GUILD_EMOJI_DELETE

public static final Route GUILD_EMOJI_DELETE

Delete the given emoji. Returns 204 No Content on success. Fires a Guild Emojis Update Gateway event.

See Also:

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

GUILD_CREATE

public static final Route GUILD_CREATE

Create a new guild. Returns a guild object on success. Fires a Guild Create Gateway event.

By default this endpoint is limited to 10 active guilds. These limits are raised for whitelisted GameBridge applications.

See Also:

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

GUILD_GET

public static final Route GUILD_GET

Returns the guild object for the given id.

See Also:

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

GUILD_MODIFY

public static final Route GUILD_MODIFY

Modify a guild's settings. Returns the updated guild object on success. Fires a Guild Update Gateway event.

See Also:

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

GUILD_DELETE

public static final Route GUILD_DELETE

Delete a guild permanently. User must be owner. Returns 204 No Content on success. Fires a Guild Delete Gateway event.

See Also:

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

GUILD_CHANNELS_GET

public static final Route GUILD_CHANNELS_GET

Returns a list of guild channel objects.

See Also:

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

GUILD_CHANNEL_CREATE

public static final Route GUILD_CHANNEL_CREATE

Create a new channel object for the guild. Requires the 'MANAGE_CHANNELS' permission. Returns the new channel object on success. Fires a Channel Create Gateway event.

See Also:

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

GUILD_CHANNEL_POSITIONS_MODIFY

public static final Route GUILD_CHANNEL_POSITIONS_MODIFY

Modify the positions of a set of role objects for the guild. Requires the 'MANAGE_ROLES' permission. Returns a list of all of the guild's role objects on success. Fires multiple Guild Role Update Gateway events.

See Also:

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

GUILD_MEMBER_GET

public static final Route GUILD_MEMBER_GET

Returns a guild member object for the specified user.

See Also:

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

GUILD_MEMBERS_LIST

public static final Route GUILD_MEMBERS_LIST

Returns a list of guild member objects that are members of the guild.

See Also:

• https://discord.com/developers/docs/resources/guild#list-guild-members

SEARCH_GUILD_MEMBERS_GET

public static final Route SEARCH_GUILD_MEMBERS_GET

Returns a list of guild member objects whose username or nickname starts with a provided string.

See Also:

• https://discord.com/developers/docs/resources/guild#search-guild-members

GUILD_MEMBER_ADD

public static final Route GUILD_MEMBER_ADD

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 as the body. Fires a Guild Member Add Gateway event. Requires the bot to have the CREATE_INSTANT_INVITE permission.

See Also:

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

GUILD_MEMBER_MODIFY

public static final Route GUILD_MEMBER_MODIFY

Modify attributes of a guild member. Returns a 200 OK with the guild member on success. Fires a Guild Member Update Gateway event.

See Also:

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

CURRENT_MEMBER_MODIFY

public static final Route CURRENT_MEMBER_MODIFY

Modifies the current member in a guild. Returns a 200 with the updated member on success. Fires a Guild Member Update Gateway event.

See Also:

• Discord

GUILD_MEMBER_ROLE_ADD

public static final Route GUILD_MEMBER_ROLE_ADD

Adds a role to a guild member. Requires the 'MANAGE_ROLES' permission. Returns a 204 empty response on success. Fires a Guild Member Update Gateway event.

See Also:

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

GUILD_MEMBER_ROLE_REMOVE

public static final Route GUILD_MEMBER_ROLE_REMOVE

Removes a role from a guild member. Requires the 'MANAGE_ROLES' permission. Returns a 204 empty response on success. Fires a Guild Member Update Gateway event.

See Also:

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

GUILD_MEMBER_REMOVE

public static final Route GUILD_MEMBER_REMOVE

Remove a member from a guild. Requires 'KICK_MEMBERS' permission. Returns a 204 empty response on success. Fires a Guild Member Remove Gateway event.

See Also:

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

GUILD_BANS_GET

public static final Route GUILD_BANS_GET

Returns a list of ban objects for the users banned from this guild. Requires the 'BAN_MEMBERS' permission.

See Also:

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

GUILD_BAN_GET

public static final Route GUILD_BAN_GET

Returns a ban object for the given user or a 404 not found if the ban cannot be found. Requires the 'BAN_MEMBERS' permission.

See Also:

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

GUILD_BAN_CREATE

public static final Route GUILD_BAN_CREATE

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 Gateway event.

See Also:

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

GUILD_BAN_REMOVE

public static final Route GUILD_BAN_REMOVE

Remove the ban for a user. Requires the 'BAN_MEMBERS' permissions. Returns a 204 empty response on success. Fires a Guild Ban Remove Gateway event.

See Also:

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

GUILD_BAN_BULK

public static final Route GUILD_BAN_BULK

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.

See Also:

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

GUILD_ROLES_GET

public static final Route GUILD_ROLES_GET

Returns a list of role objects for the guild. Requires the 'MANAGE_ROLES' permission.

See Also:

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

GUILD_ROLE_GET

public static final Route GUILD_ROLE_GET

Returns a role object for the specified role id. Requires the 'MANAGE_ROLES' permission.

See Also:

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

GUILD_ROLE_CREATE

public static final Route GUILD_ROLE_CREATE

Create a new role for the guild. Requires the 'MANAGE_ROLES' permission. Returns the new role object on success. Fires a Guild Role Create Gateway event. All JSON params are optional.

See Also:

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

GUILD_ROLE_POSITIONS_MODIFY

public static final Route GUILD_ROLE_POSITIONS_MODIFY

Modify the positions of a set of role objects for the guild. Requires the 'MANAGE_ROLES' permission. Returns a list of all of the guild's role objects on success. Fires multiple Guild Role Update Gateway events.

See Also:

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

GUILD_ROLE_MODIFY

public static final Route GUILD_ROLE_MODIFY

Modify a guild role. Requires the 'MANAGE_ROLES' permission. Returns the updated role on success. Fires a Guild Role Update Gateway event.

See Also:

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

GUILD_ROLE_DELETE

public static final Route GUILD_ROLE_DELETE

Delete a guild role. Requires the 'MANAGE_ROLES' permission. Returns a 204 empty response on success. Fires a Guild Role Delete Gateway event.

See Also:

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

GUILD_PRUNE_COUNT_GET

public static final Route GUILD_PRUNE_COUNT_GET

Returns an object with one 'pruned' key indicating the number of members that would be removed in a prune operation. Requires the 'KICK_MEMBERS' permission.

See Also:

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

GUILD_PRUNE_BEGIN

public static final Route GUILD_PRUNE_BEGIN

Begin a prune operation. Requires the 'KICK_MEMBERS' permission. Returns an object with one 'pruned' key indicating the number of members that were removed in the prune operation. Fires multiple Guild Member Remove Gateway events.

See Also:

• https://discord.com/developers/docs/resources/guild#begin-guild-prune

GUILD_VOICE_REGIONS_GET

public static final Route GUILD_VOICE_REGIONS_GET

Returns a list of voice region objects for the guild. Unlike the similar /voice route, this returns VIP servers when the guild is VIP-enabled.

See Also:

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

GUILD_INVITES_GET

public static final Route GUILD_INVITES_GET

Returns a list of invite objects (with invite metadata) for the guild. Requires the 'MANAGE_GUILD' permission.

See Also:

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

GUILD_INTEGRATIONS_GET

public static final Route GUILD_INTEGRATIONS_GET

Returns a list of integration objects for the guild. Requires the 'MANAGE_GUILD' permission.

See Also:

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

GUILD_INTEGRATION_CREATE

public static final Route GUILD_INTEGRATION_CREATE

Attach an integration object from the current user to the guild. Requires the 'MANAGE_GUILD' permission. Returns a 204 empty response on success. Fires a Guild Integrations Update Gateway event.

See Also:

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

GUILD_INTEGRATION_MODIFY

public static final Route GUILD_INTEGRATION_MODIFY

Modify the behavior and settings of a integration object for the guild. Requires the 'MANAGE_GUILD' permission. Returns a 204 empty response on success. Fires a Guild Integrations Update Gateway event.

See Also:

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

GUILD_INTEGRATION_DELETE

public static final Route GUILD_INTEGRATION_DELETE

Delete the attached integration object for the guild. Requires the 'MANAGE_GUILD' permission. Returns a 204 empty response on success. Fires a Guild Integrations Update Gateway event.

See Also:

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

GUILD_INTEGRATION_SYNC

public static final Route GUILD_INTEGRATION_SYNC

Sync an integration. Requires the 'MANAGE_GUILD' permission. Returns a 204 empty response on success.

See Also:

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

GUILD_WIDGET_GET

public static final Route GUILD_WIDGET_GET

Returns the guild widget object. Requires the 'MANAGE_GUILD' permission.

See Also:

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

GUILD_WIDGET_MODIFY

public static final Route GUILD_WIDGET_MODIFY

Modify a guild widget object for the guild. All attributes may be passed in with JSON and modified. Requires the 'MANAGE_GUILD' permission. Returns the updated guild widget object.

See Also:

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

GUILD_PREVIEW_GET

public static final Route GUILD_PREVIEW_GET

Returns the guild preview object. If the user is not in the guild, then the guild must be Discoverable.

See Also:

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

SELF_VOICE_STATE_GET

public static final Route SELF_VOICE_STATE_GET

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

See Also:

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

OTHERS_VOICE_STATE_GET

public static final Route OTHERS_VOICE_STATE_GET

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

See Also:

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

SELF_VOICE_STATE_MODIFY

public static final Route SELF_VOICE_STATE_MODIFY

Updates the current user's voice state.

See Also:

• https://discord.com/developers/docs/resources/guild#update-self-voice-state

OTHERS_VOICE_STATE_MODIFY

public static final Route OTHERS_VOICE_STATE_MODIFY

Updates another user's voice state.

See Also:

• https://discord.com/developers/docs/resources/guild#update-others-voice-state

LIST_ACTIVE_GUILD_THREADS

public static final Route LIST_ACTIVE_GUILD_THREADS

INVITE_GET

public static final Route INVITE_GET

Returns an invite object for the given code.

See Also:

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

INVITE_DELETE

public static final Route INVITE_DELETE

Delete an invite. Requires the MANAGE_CHANNELS permission. Returns an invite object on success.

See Also:

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

INVITE_ACCEPT

public static final Route INVITE_ACCEPT

Accept an invite. This requires the guilds.join OAuth2 scope to be able to accept invites on behalf of normal users (via an OAuth2 Bearer token). Bot users are disallowed. Returns an invite object on success.

See Also:

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

GUILD_TEMPLATE_GET

public static final Route GUILD_TEMPLATE_GET

Get a template. Returns a template object for the given code on success.

See Also:

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

TEMPLATE_GUILD_CREATE

public static final Route TEMPLATE_GUILD_CREATE

Create a new guild from template. Returns a guild object on success. Fires a Guild Create Gateway event. By default this endpoint can be used only by bots in less than 10 guilds.

See Also:

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

GUILD_TEMPLATE_LIST_GET

public static final Route GUILD_TEMPLATE_LIST_GET

Returns an array of template objects. Requires the MANAGE_GUILD permission. Returns an array of template objects.

See Also:

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

GUILD_TEMPLATE_CREATE

public static final Route GUILD_TEMPLATE_CREATE

Creates a template for the guild. Requires the MANAGE_GUILD permission. Returns the created template object on success.

See Also:

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

GUILD_TEMPLATE_SYNC

public static final Route GUILD_TEMPLATE_SYNC

Syncs the template to the guild's current state. Requires the MANAGE_GUILD permission. Returns the template object on success.

See Also:

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

GUILD_TEMPLATE_MODIFY

public static final Route GUILD_TEMPLATE_MODIFY

Modifies the template's metadata. Requires the MANAGE_GUILD permission. Returns the template object on success.

See Also:

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

GUILD_TEMPLATE_DELETE

public static final Route GUILD_TEMPLATE_DELETE

Deletes the template. Requires the MANAGE_GUILD permission. Returns the deleted template object on success.

See Also:

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

CURRENT_USER_GET

public static final Route CURRENT_USER_GET

Returns the user 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.

See Also:

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

USER_GET

public static final Route USER_GET

Returns a user object for a given user ID.

See Also:

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

CURRENT_USER_MODIFY

public static final Route CURRENT_USER_MODIFY

Modify the requester's user account settings. Returns a user object on success.

See Also:

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

CURRENT_USER_GUILDS_GET

public static final Route CURRENT_USER_GUILDS_GET

Returns a list of partial guild objects the current user is a member of. Requires the guilds OAuth2 scope.

See Also:

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

CURRENT_USER_GUILD_MEMBER_GET

public static final Route CURRENT_USER_GUILD_MEMBER_GET

Returns a guild member object for the current user. Requires the guilds.members.read OAuth2 scope.

See Also:

• Discord

GUILD_LEAVE

public static final Route GUILD_LEAVE

Leave a guild. Returns a 204 empty response on success.

See Also:

• https://discord.com/developers/docs/resources/user#leave-guild

USER_DM_CREATE

public static final Route USER_DM_CREATE

Create a new DM channel with a user. Returns a DM channel object.

See Also:

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

GROUP_DM_CREATE

public static final Route GROUP_DM_CREATE

Create a new group DM channel with multiple users. Returns a DM channel object.

See Also:

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

USER_CONNECTIONS_GET

public static final Route USER_CONNECTIONS_GET

Returns a list of connection objects. Requires the connections OAuth2 scope.

See Also:

• https://discord.com/developers/docs/resources/user#get-user-connections

USER_APPLICATIONS_ROLE_CONNECTION_GET

public static final Route USER_APPLICATIONS_ROLE_CONNECTION_GET

Returns the application role connection for the user. Requires an OAuth2 access token with role_connections.write scope for the application specified in the path.

See Also:

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

USER_APPLICATIONS_ROLE_CONNECTION_MODIFY

public static final Route USER_APPLICATIONS_ROLE_CONNECTION_MODIFY

Updates and returns the application role connection for the user. Requires an OAuth2 access token with role_connections.write scope for the application specified in the path.

See Also:

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

VOICE_REGION_LIST

public static final Route VOICE_REGION_LIST

Returns an array of voice region objects that can be used when creating servers.

See Also:

• https://discord.com/developers/docs/resources/voice#list-voice-regions

CHANNEL_WEBHOOK_CREATE

public static final Route CHANNEL_WEBHOOK_CREATE

Create a new webhook. Returns a webhook object on success.

See Also:

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

CHANNEL_WEBHOOKS_GET

public static final Route CHANNEL_WEBHOOKS_GET

Returns a list of channel webhook objects.

See Also:

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

GUILD_WEBHOOKS_GET

public static final Route GUILD_WEBHOOKS_GET

Returns a list of guild webhook objects.

See Also:

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

WEBHOOK_GET

public static final Route WEBHOOK_GET

Returns the new webhook object for the given id.

See Also:

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

WEBHOOK_TOKEN_GET

public static final Route WEBHOOK_TOKEN_GET

Same as WEBHOOK_GET, except this call does not require authentication and returns no user in the webhook object.

See Also:

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

WEBHOOK_MODIFY

public static final Route WEBHOOK_MODIFY

Modify a webhook. Returns the updated webhook object on success. All parameters to this endpoint are optional.

See Also:

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

WEBHOOK_TOKEN_MODIFY

public static final Route WEBHOOK_TOKEN_MODIFY

Same as WEBHOOK_MODIFY, except this call does not require authentication and returns no user in the webhook object.

See Also:

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

WEBHOOK_DELETE

public static final Route WEBHOOK_DELETE

Delete a webhook permanently. User must be owner. Returns a 204 NO CONTENT response on success.

See Also:

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

WEBHOOK_TOKEN_DELETE

public static final Route WEBHOOK_TOKEN_DELETE

Same as above, except this call does not require authentication.

See Also:

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

WEBHOOK_EXECUTE

public static final Route WEBHOOK_EXECUTE

This endpoint supports both JSON and form data bodies. It does require multipart/form-data requests instead of the normal JSON request type when uploading files. Make sure you set your Content-Type to multipart/form-data if you're doing that. Note that in that case, the embeds field cannot be used, but you can pass an url-encoded JSON body as a form value for payload_json.

See Also:

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

WEBHOOK_EXECUTE_SLACK

public static final Route WEBHOOK_EXECUTE_SLACK

See Also:

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

WEBHOOK_EXECUTE_GITHUB

public static final Route WEBHOOK_EXECUTE_GITHUB

See Also:

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

WEBHOOK_MESSAGE_GET

public static final Route WEBHOOK_MESSAGE_GET

See Also:

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

WEBHOOK_MESSAGE_EDIT

public static final Route WEBHOOK_MESSAGE_EDIT

See Also:

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

WEBHOOK_MESSAGE_DELETE

public static final Route WEBHOOK_MESSAGE_DELETE

See Also:

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

APPLICATION_INFO_GET

public static final Route APPLICATION_INFO_GET

Returns the bot's OAuth2 application info.

See Also:

• https://discord.com/developers/docs/topics/oauth2#get-current-application-information

APPLICATION_INFO_MODIFY

public static final Route APPLICATION_INFO_MODIFY

GLOBAL_APPLICATION_COMMANDS_GET

public static final Route GLOBAL_APPLICATION_COMMANDS_GET

GLOBAL_APPLICATION_COMMANDS_CREATE

public static final Route GLOBAL_APPLICATION_COMMANDS_CREATE

GLOBAL_APPLICATION_COMMANDS_BULK_OVERWRITE

public static final Route GLOBAL_APPLICATION_COMMANDS_BULK_OVERWRITE

GLOBAL_APPLICATION_COMMAND_GET

public static final Route GLOBAL_APPLICATION_COMMAND_GET

GLOBAL_APPLICATION_COMMAND_MODIFY

public static final Route GLOBAL_APPLICATION_COMMAND_MODIFY

GLOBAL_APPLICATION_COMMAND_DELETE

public static final Route GLOBAL_APPLICATION_COMMAND_DELETE

GUILD_APPLICATION_COMMANDS_GET

public static final Route GUILD_APPLICATION_COMMANDS_GET

GUILD_APPLICATION_COMMANDS_CREATE

public static final Route GUILD_APPLICATION_COMMANDS_CREATE

GUILD_APPLICATION_COMMANDS_BULK_OVERWRITE

public static final Route GUILD_APPLICATION_COMMANDS_BULK_OVERWRITE

GUILD_APPLICATION_COMMAND_GET

public static final Route GUILD_APPLICATION_COMMAND_GET

GUILD_APPLICATION_COMMAND_MODIFY

public static final Route GUILD_APPLICATION_COMMAND_MODIFY

GUILD_APPLICATION_COMMAND_DELETE

public static final Route GUILD_APPLICATION_COMMAND_DELETE

GUILD_APPLICATION_COMMAND_PERMISSIONS_GET

public static final Route GUILD_APPLICATION_COMMAND_PERMISSIONS_GET

APPLICATION_COMMAND_PERMISSIONS_GET

public static final Route APPLICATION_COMMAND_PERMISSIONS_GET

APPLICATION_COMMAND_PERMISSIONS_MODIFY

public static final Route APPLICATION_COMMAND_PERMISSIONS_MODIFY

APPLICATION_COMMAND_PERMISSIONS_BULK_MODIFY

public static final Route APPLICATION_COMMAND_PERMISSIONS_BULK_MODIFY

APPLICATION_EMOJIS_GET

public static final Route APPLICATION_EMOJIS_GET

Returns an object containing a list of emoji 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.

See Also:

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

APPLICATION_EMOJI_GET

public static final Route APPLICATION_EMOJI_GET

Returns an emoji object for the given application and emoji IDs. Includes the user field.

See Also:

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

APPLICATION_EMOJI_CREATE

public static final Route APPLICATION_EMOJI_CREATE

Create a new emoji for the application. Returns the new emoji object on success.
Emojis and animated emojis have a maximum file size of 256 KiB. Attempting to upload an emoji larger than this limit will fail and return 400 Bad Request and an error message, but not a JSON status code.

See Also:

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

APPLICATION_EMOJI_MODIFY

public static final Route APPLICATION_EMOJI_MODIFY

Modify the given emoji. Returns the updated emoji object on success.

See Also:

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

APPLICATION_EMOJI_DELETE

public static final Route APPLICATION_EMOJI_DELETE

Delete the given emoji. Returns 204 No Content on success.

See Also:

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

APPLICATION_ROLE_CONNECTION_METADATA_GET

public static final Route APPLICATION_ROLE_CONNECTION_METADATA_GET

Returns a list of application role connection metadata objects for the given application.

See Also:

• https://discord.com/developers/docs/resources/application-role-connection-metadata#get-application-role-connection-metadata-records

APPLICATION_ROLE_CONNECTION_METADATA_MODIFY

public static final Route APPLICATION_ROLE_CONNECTION_METADATA_MODIFY

Updates and returns a list of application role connection metadata objects for the given application. An application can have a maximum of 5 metadata records.

See Also:

• https://discord.com/developers/docs/resources/application-role-connection-metadata#modify-application-role-connection-metadata

INTERACTION_RESPONSE_CREATE

public static final Route INTERACTION_RESPONSE_CREATE

CREATE_STAGE_INSTANCE

public static final Route CREATE_STAGE_INSTANCE

GET_STAGE_INSTANCE

public static final Route GET_STAGE_INSTANCE

MODIFY_STAGE_INSTANCE

public static final Route MODIFY_STAGE_INSTANCE

DELETE_STAGE_INSTANCE

public static final Route DELETE_STAGE_INSTANCE

GUILD_SCHEDULED_EVENTS_GET

public static final Route GUILD_SCHEDULED_EVENTS_GET

Returns a list of all scheduled events for a guild.

See Also:

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

GUILD_SCHEDULED_EVENT_CREATE

public static final Route GUILD_SCHEDULED_EVENT_CREATE

Creates a guild scheduled event for the given guild. Returns a scheduled event object on success.

See Also:

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

GUILD_SCHEDULED_EVENT_GET

public static final Route GUILD_SCHEDULED_EVENT_GET

Returns a scheduled event for the given guild.

See Also:

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

GUILD_SCHEDULED_EVENT_MODIFY

public static final Route GUILD_SCHEDULED_EVENT_MODIFY

Modifies a scheduled event for the given guild. Returns the modified scheduled event object on success.

See Also:

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

GUILD_SCHEDULED_EVENT_DELETE

public static final Route GUILD_SCHEDULED_EVENT_DELETE

Deletes a scheduled event for the given guild. Returns a 204 empty response on success.

See Also:

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

GUILD_SCHEDULED_EVENT_USERS_GET

public static final Route GUILD_SCHEDULED_EVENT_USERS_GET

Returns a list of users RSVP'd to the scheduled event for the given guild. Returns a list of user objects on success with an optional `guild_member` property for each user if `with_member` query param is passed.

See Also:

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

GUILD_ONBOARDING_GET

public static final Route GUILD_ONBOARDING_GET

Returns the Onboarding object for the guild.

See Also:

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

GUILD_ONBOARDING_MODIFY

public static final Route GUILD_ONBOARDING_MODIFY

Modifies the onboarding configuration of the guild. Returns a 200 with the Onboarding object for the guild. Requires the MANAGE_GUILD and MANAGE_ROLES permissions. This endpoint supports the X-Audit-Log-Reason header.

See Also:

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

TOKEN

public static final Route TOKEN

TOKEN_REVOKE

public static final Route TOKEN_REVOKE

AUTHORIZATION_INFO_GET

public static final Route AUTHORIZATION_INFO_GET

LIST_SKUS

public static final Route LIST_SKUS

Returns a list of SKUs for a given application.

See Also:

• Docs

LIST_ENTITLEMENTS

public static final Route LIST_ENTITLEMENTS

Returns a list of entitlements for a given application.

See Also:

• Docs

CREATE_TEST_ENTITLEMENT

public static final Route CREATE_TEST_ENTITLEMENT

Creates a test entitlement for a given application.

See Also:

• Docs

DELETE_TEST_ENTITLEMENT

public static final Route DELETE_TEST_ENTITLEMENT

Deletes a test entitlement for a given application.

See Also:

• Docs

CONSUME_ENTITLEMENT

public static final Route CONSUME_ENTITLEMENT

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.

See Also:

• Docs

LIST_SKU_SUBSCRIPTIONS

public static final Route LIST_SKU_SUBSCRIPTIONS

Returns all subscriptions containing the SKU, filtered by user. Returns a list of subscription objects.

See Also:

• Docs

GET_SKU_SUBSCRIPTION

public static final Route GET_SKU_SUBSCRIPTION

Get a subscription by its ID. Returns a subscription object.

See Also:

• Docs

SEND_SOUNDBOARD_SOUND

public static final Route SEND_SOUNDBOARD_SOUND

Send a soundboard sound to a voice channel the user is connected to.

See Also:

• Docs

LIST_DEFAULT_SOUNDBOARD_SOUNDS

public static final Route LIST_DEFAULT_SOUNDBOARD_SOUNDS

Returns an array of soundboard sound objects that can be used by all users.

See Also:

• Docs

LIST_GUILD_SOUNDBOARD_SOUNDS

public static final Route LIST_GUILD_SOUNDBOARD_SOUNDS

Returns a list of the guild's soundboard sounds.

See Also:

• Docs

GET_GUILD_SOUNDBOARD_SOUND

public static final Route GET_GUILD_SOUNDBOARD_SOUND

Returns a soundboard sound object for the given sound id.

See Also:

• Docs

CREATE_GUILD_SOUNDBOARD_SOUND

public static final Route CREATE_GUILD_SOUNDBOARD_SOUND

Create a new soundboard sound for the guild.

See Also:

• Docs

MODIFY_GUILD_SOUNDBOARD_SOUND

public static final Route MODIFY_GUILD_SOUNDBOARD_SOUND

Modify the given soundboard sound.

See Also:

• Docs

DELETE_GUILD_SOUNDBOARD_SOUND

public static final Route DELETE_GUILD_SOUNDBOARD_SOUND

Delete the given soundboard sound.

See Also:

• Docs

Constructor Details

Routes

public Routes()