Class Routes
- java.lang.Object
-
- discord4j.rest.route.Routes
-
-
Field Summary
Fields Modifier and Type Field Description static RouteAPPLICATION_COMMAND_PERMISSIONS_BULK_MODIFYstatic RouteAPPLICATION_COMMAND_PERMISSIONS_GETstatic RouteAPPLICATION_COMMAND_PERMISSIONS_MODIFYstatic RouteAPPLICATION_INFO_GETReturns the bot's OAuth2 application info.static RouteAUDIT_LOG_GETReturns an audit log object for the guild.static StringBASE_URLThe base URL for all API requests.static RouteCHANNEL_DELETEDelete a guild channel, or close a private message.static RouteCHANNEL_GETGet a channel by ID.static RouteCHANNEL_INVITE_CREATECreate a new invite object for the channel.static RouteCHANNEL_INVITES_GETReturns a list of invite objects (with invite metadata) for the channel.static RouteCHANNEL_MODIFYUpdate a channels settings.static RouteCHANNEL_MODIFY_PARTIALUpdate a channels settings.static RouteCHANNEL_PERMISSION_DELETEDelete a channel permission overwrite for a user or role in a channel.static RouteCHANNEL_PERMISSIONS_EDITEdit the channel permission overwrites for a user or role in a channel.static RouteCHANNEL_WEBHOOK_CREATECreate a new webhook.static RouteCHANNEL_WEBHOOKS_GETReturns a list of channel webhook objects.static RouteCROSSPOST_MESSAGECrosspost a Message into all guilds what follow the news channel indicated.static RouteCURRENT_USER_GETReturns the user object of the requester's account.static RouteCURRENT_USER_GUILDS_GETReturns a list of partial guild objects the current user is a member of.static RouteCURRENT_USER_MODIFYModify the requester's user account settings.static RouteFOLLOW_NEWS_CHANNELFollow a News Channel to send messages to a target channel.static RouteGATEWAY_BOT_GETReturns 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 RouteGATEWAY_GETReturns an object with a single valid WSS URL, which the client can use as a basis for Connecting.static RouteGLOBAL_APPLICATION_COMMAND_DELETEstatic RouteGLOBAL_APPLICATION_COMMAND_GETstatic RouteGLOBAL_APPLICATION_COMMAND_MODIFYstatic RouteGLOBAL_APPLICATION_COMMANDS_BULK_OVERWRITEstatic RouteGLOBAL_APPLICATION_COMMANDS_CREATEstatic RouteGLOBAL_APPLICATION_COMMANDS_GETstatic RouteGROUP_DM_CREATECreate a new group DM channel with multiple users.static RouteGROUP_DM_RECIPIENT_ADDAdds a recipient to a Group DM using their access token.static RouteGROUP_DM_RECIPIENT_DELETERemoves a recipient from a Group DM.static RouteGUILD_APPLICATION_COMMAND_DELETEstatic RouteGUILD_APPLICATION_COMMAND_GETstatic RouteGUILD_APPLICATION_COMMAND_MODIFYstatic RouteGUILD_APPLICATION_COMMAND_PERMISSIONS_GETstatic RouteGUILD_APPLICATION_COMMANDS_BULK_OVERWRITEstatic RouteGUILD_APPLICATION_COMMANDS_CREATEstatic RouteGUILD_APPLICATION_COMMANDS_GETstatic RouteGUILD_BAN_CREATECreate a guild ban, and optionally delete previous messages sent by the banned user.static RouteGUILD_BAN_GETReturns a ban object for the given user or a 404 not found if the ban cannot be found.static RouteGUILD_BAN_REMOVERemove the ban for a user.static RouteGUILD_BANS_GETReturns a list of ban objects for the users banned from this guild.static RouteGUILD_CHANNEL_CREATECreate a new channel object for the guild.static RouteGUILD_CHANNEL_POSITIONS_MODIFYModify the positions of a set of role objects for the guild.static RouteGUILD_CHANNELS_GETReturns a list of guild channel objects.static RouteGUILD_CREATECreate a new guild.static RouteGUILD_DELETEDelete a guild permanently.static RouteGUILD_EMOJI_CREATECreate a new emoji for the guild.static RouteGUILD_EMOJI_DELETEDelete the given emoji.static RouteGUILD_EMOJI_GETReturns an emoji object for the given guild and emoji IDs.static RouteGUILD_EMOJI_MODIFYModify the given emoji.static RouteGUILD_EMOJIS_GETReturns a list of emoji objects for the given guild.static RouteGUILD_GETReturns the guild object for the given id.static RouteGUILD_INTEGRATION_CREATEAttach an integration object from the current user to the guild.static RouteGUILD_INTEGRATION_DELETEDelete the attached integration object for the guild.static RouteGUILD_INTEGRATION_MODIFYModify the behavior and settings of a integration object for the guild.static RouteGUILD_INTEGRATION_SYNCSync an integration.static RouteGUILD_INTEGRATIONS_GETReturns a list of integration objects for the guild.static RouteGUILD_INVITES_GETReturns a list of invite objects (with invite metadata) for the guild.static RouteGUILD_LEAVELeave a guild.static RouteGUILD_MEMBER_ADDAdds a user to the guild, provided you have a valid oauth2 access token for the user with the guilds.join scope.static RouteGUILD_MEMBER_GETReturns a guild member object for the specified user.static RouteGUILD_MEMBER_MODIFYModify attributes of a guild member.static RouteGUILD_MEMBER_REMOVERemove a member from a guild.static RouteGUILD_MEMBER_ROLE_ADDAdds a role to a guild member.static RouteGUILD_MEMBER_ROLE_REMOVERemoves a role from a guild member.static RouteGUILD_MEMBERS_LISTReturns a list of guild member objects that are members of the guild.static RouteGUILD_MODIFYModify a guild's settings.static RouteGUILD_PREVIEW_GETReturns the guild preview object.static RouteGUILD_PRUNE_BEGINBegin a prune operation.static RouteGUILD_PRUNE_COUNT_GETReturns an object with one 'pruned' key indicating the number of members that would be removed in a prune operation.static RouteGUILD_ROLE_CREATECreate a new role for the guild.static RouteGUILD_ROLE_DELETEDelete a guild role.static RouteGUILD_ROLE_MODIFYModify a guild role.static RouteGUILD_ROLE_POSITIONS_MODIFYModify the positions of a set of role objects for the guild.static RouteGUILD_ROLES_GETReturns a list of role objects for the guild.static RouteGUILD_TEMPLATE_CREATECreates a template for the guild.static RouteGUILD_TEMPLATE_DELETEDeletes the template.static RouteGUILD_TEMPLATE_GETGet a template.static RouteGUILD_TEMPLATE_LIST_GETReturns an array of template objects.static RouteGUILD_TEMPLATE_MODIFYModifies the template's metadata.static RouteGUILD_TEMPLATE_SYNCSyncs the template to the guild's current state.static RouteGUILD_VOICE_REGIONS_GETReturns a list of voice region objects for the guild.static RouteGUILD_WEBHOOKS_GETReturns a list of guild webhook objects.static RouteGUILD_WIDGET_GETReturns the guild widget object.static RouteGUILD_WIDGET_MODIFYModify a guild widget object for the guild.static RouteINTERACTION_RESPONSE_CREATEstatic RouteINVITE_ACCEPTAccept an invite.static RouteINVITE_DELETEDelete an invite.static RouteINVITE_GETReturns an invite object for the given code.static RouteMESSAGE_CREATEPost a message to a guild text or DM channel.static RouteMESSAGE_DELETEDelete a message.static RouteMESSAGE_DELETE_BULKDelete multiple messages in a single request.static RouteMESSAGE_EDITEdit a previously sent message.static RouteMESSAGE_GETReturns a specific message in the channel.static RouteMESSAGE_SUPPRESS_EMBEDSEnable/disable suppression of embeds on a Message.static RouteMESSAGES_GETReturns the messages for a channel.static RouteMESSAGES_PINNED_ADDPin a message in a channel.static RouteMESSAGES_PINNED_DELETEDelete a pinned message in a channel.static RouteMESSAGES_PINNED_GETReturns all pinned messages in the channel as an array of message objects.static RouteNICKNAME_MODIFY_OWNModifies the nickname of the current user in a guild.static RouteOTHERS_VOICE_STATE_MODIFYUpdates another user's voice state.static RouteREACTION_CREATECreate a reaction for the message.static RouteREACTION_DELETEDeletes all the reactions for a given emoji on a message.static RouteREACTION_DELETE_OWNDelete a reaction the current user has made for the message.static RouteREACTION_DELETE_USERDeletes another user's reaction.static RouteREACTIONS_DELETE_ALLDeletes all reactions on a message.static RouteREACTIONS_GETGet a list of users that reacted with this emoji.static RouteSEARCH_GUILD_MEMBERS_GETReturns a list of guild member objects whose username or nickname starts with a provided string.static RouteSELF_VOICE_STATE_MODIFYUpdates the current user's voice state.static RouteTEMPLATE_GUILD_CREATECreate a new guild from template.static RouteTYPING_INDICATOR_TRIGGERPost a typing indicator for the specified channel.static RouteUSER_CONNECTIONS_GETReturns a list of connection objects.static RouteUSER_DM_CREATECreate a new DM channel with a user.static RouteUSER_GETReturns a user object for a given user ID.static RouteVOICE_REGION_LISTReturns an array of voice region objects that can be used when creating servers.static RouteWEBHOOK_DELETEDelete a webhook permanently.static RouteWEBHOOK_EXECUTEThis endpoint supports both JSON and form data bodies.static RouteWEBHOOK_EXECUTE_GITHUBstatic RouteWEBHOOK_EXECUTE_SLACKstatic RouteWEBHOOK_GETReturns the new webhook object for the given id.static RouteWEBHOOK_MESSAGE_DELETEstatic RouteWEBHOOK_MESSAGE_EDITstatic RouteWEBHOOK_MESSAGE_GETstatic RouteWEBHOOK_MODIFYModify a webhook.static RouteWEBHOOK_TOKEN_DELETESame as above, except this call does not require authentication.static RouteWEBHOOK_TOKEN_GETSame asWEBHOOK_GET, except this call does not require authentication and returns no user in the webhook object.static RouteWEBHOOK_TOKEN_MODIFYSame asWEBHOOK_MODIFY, except this call does not require authentication and returns no user in the webhook object.
-
Constructor Summary
Constructors Constructor Description Routes()
-
-
-
Field Detail
-
BASE_URL
public static final String BASE_URL
The base URL for all API requests.
-
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.
-
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.
-
AUDIT_LOG_GET
public static final Route AUDIT_LOG_GET
Returns an audit log object for the guild. Requires the 'VIEW_AUDIT_LOG' permission.
-
CHANNEL_GET
public static final Route CHANNEL_GET
Get a channel by ID. Returns a guild channel or dm channel object.
-
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.
-
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.
-
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.
-
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.
-
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.
-
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.
-
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.
-
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.
-
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.
-
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.
-
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.
-
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.
-
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.
-
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.
-
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.
-
MESSAGE_SUPPRESS_EMBEDS
@Experimental public static final Route MESSAGE_SUPPRESS_EMBEDS
Enable/disable suppression of embeds on a Message. This endpoint requires the 'MANAGE_MESSAGES' permission to be present for the current user.Returns a 204 empty response on success. Fires a Message Update Gateway event.
-
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.
-
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.
-
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.
-
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.
-
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.
-
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.
-
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.
-
MESSAGES_PINNED_GET
public static final Route MESSAGES_PINNED_GET
Returns all pinned messages in the channel as an array of message objects.
-
MESSAGES_PINNED_ADD
public static final Route MESSAGES_PINNED_ADD
Pin a message in a channel. Requires the 'MANAGE_MESSAGES' permission. Returns a 204 empty response on success.
-
MESSAGES_PINNED_DELETE
public static final Route MESSAGES_PINNED_DELETE
Delete a pinned message in a channel. Requires the 'MANAGE_MESSAGES' permission. Returns a 204 empty response on success.
-
GROUP_DM_RECIPIENT_ADD
public static final Route GROUP_DM_RECIPIENT_ADD
Adds a recipient to a Group DM using their access token.
-
GROUP_DM_RECIPIENT_DELETE
public static final Route GROUP_DM_RECIPIENT_DELETE
Removes a recipient from a Group DM.
-
GUILD_EMOJIS_GET
public static final Route GUILD_EMOJIS_GET
Returns a list of emoji objects for the given guild.
-
GUILD_EMOJI_GET
public static final Route GUILD_EMOJI_GET
Returns an emoji object for the given guild and emoji IDs.
-
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.
-
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.
-
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.
-
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.
-
GUILD_GET
public static final Route GUILD_GET
Returns the guild object for the given id.
-
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.
-
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.
-
GUILD_CHANNELS_GET
public static final Route GUILD_CHANNELS_GET
Returns a list of guild channel objects.
-
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.
-
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.
-
GUILD_MEMBER_GET
public static final Route GUILD_MEMBER_GET
Returns a guild member object for the specified user.
-
GUILD_MEMBERS_LIST
public static final Route GUILD_MEMBERS_LIST
Returns a list of guild member objects that are members of the guild.
-
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.
-
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.
-
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.
-
NICKNAME_MODIFY_OWN
public static final Route NICKNAME_MODIFY_OWN
Modifies the nickname of the current user in a guild. Returns a 200 with the nickname on success. Fires a Guild Member Update Gateway event.
-
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.
-
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.
-
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.
-
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.
-
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.
-
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.
-
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.
-
GUILD_ROLES_GET
public static final Route GUILD_ROLES_GET
Returns a list of role objects for the guild. Requires the 'MANAGE_ROLES' permission.
-
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.
-
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.
-
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.
-
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.
-
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.
-
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.
-
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.
-
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.
-
GUILD_INTEGRATIONS_GET
public static final Route GUILD_INTEGRATIONS_GET
Returns a list of integration objects for the guild. Requires the 'MANAGE_GUILD' permission.
-
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.
-
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.
-
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.
-
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.
-
GUILD_WIDGET_GET
public static final Route GUILD_WIDGET_GET
Returns the guild widget object. Requires the 'MANAGE_GUILD' permission.
-
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.
-
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.
-
SELF_VOICE_STATE_MODIFY
public static final Route SELF_VOICE_STATE_MODIFY
Updates the current user's voice state.
-
OTHERS_VOICE_STATE_MODIFY
public static final Route OTHERS_VOICE_STATE_MODIFY
Updates another user's voice state.
-
INVITE_GET
public static final Route INVITE_GET
Returns an invite object for the given code.
-
INVITE_DELETE
public static final Route INVITE_DELETE
Delete an invite. Requires the MANAGE_CHANNELS permission. Returns an invite object on success.
-
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.
-
GUILD_TEMPLATE_GET
public static final Route GUILD_TEMPLATE_GET
Get a template. Returns a template object for the given code on success.
-
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.
-
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.
-
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.
-
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.
-
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.
-
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.
-
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.
-
USER_GET
public static final Route USER_GET
Returns a user object for a given user ID.
-
CURRENT_USER_MODIFY
public static final Route CURRENT_USER_MODIFY
Modify the requester's user account settings. Returns a user object on success.
-
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.
-
GUILD_LEAVE
public static final Route GUILD_LEAVE
Leave a guild. Returns a 204 empty response on success.
-
USER_DM_CREATE
public static final Route USER_DM_CREATE
Create a new DM channel with a user. Returns a DM channel object.
-
GROUP_DM_CREATE
public static final Route GROUP_DM_CREATE
Create a new group DM channel with multiple users. Returns a DM channel object.
-
USER_CONNECTIONS_GET
public static final Route USER_CONNECTIONS_GET
Returns a list of connection objects. Requires the connections OAuth2 scope.
-
VOICE_REGION_LIST
public static final Route VOICE_REGION_LIST
Returns an array of voice region objects that can be used when creating servers.
-
CHANNEL_WEBHOOK_CREATE
public static final Route CHANNEL_WEBHOOK_CREATE
Create a new webhook. Returns a webhook object on success.
-
CHANNEL_WEBHOOKS_GET
public static final Route CHANNEL_WEBHOOKS_GET
Returns a list of channel webhook objects.
-
GUILD_WEBHOOKS_GET
public static final Route GUILD_WEBHOOKS_GET
Returns a list of guild webhook objects.
-
WEBHOOK_GET
public static final Route WEBHOOK_GET
Returns the new webhook object for the given id.
-
WEBHOOK_TOKEN_GET
public static final Route WEBHOOK_TOKEN_GET
Same asWEBHOOK_GET, except this call does not require authentication and returns no user in the webhook object.
-
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.
-
WEBHOOK_TOKEN_MODIFY
public static final Route WEBHOOK_TOKEN_MODIFY
Same asWEBHOOK_MODIFY, except this call does not require authentication and returns no user in the webhook object.
-
WEBHOOK_DELETE
public static final Route WEBHOOK_DELETE
Delete a webhook permanently. User must be owner. Returns a 204 NO CONTENT response on success.
-
WEBHOOK_TOKEN_DELETE
public static final Route WEBHOOK_TOKEN_DELETE
Same as above, except this call does not require authentication.
-
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.
-
WEBHOOK_EXECUTE_SLACK
public static final Route WEBHOOK_EXECUTE_SLACK
-
WEBHOOK_EXECUTE_GITHUB
public static final Route WEBHOOK_EXECUTE_GITHUB
-
WEBHOOK_MESSAGE_GET
public static final Route WEBHOOK_MESSAGE_GET
-
WEBHOOK_MESSAGE_EDIT
public static final Route WEBHOOK_MESSAGE_EDIT
-
WEBHOOK_MESSAGE_DELETE
public static final Route WEBHOOK_MESSAGE_DELETE
-
APPLICATION_INFO_GET
public static final Route APPLICATION_INFO_GET
Returns the bot's OAuth2 application info.
-
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
-
INTERACTION_RESPONSE_CREATE
public static final Route INTERACTION_RESPONSE_CREATE
-
-