> ## Documentation Index > Fetch the complete documentation index at: https://discord-platform-username.mintlify.site/llms.txt > Use this file to discover all available pages before exploring further. # Application Commands > Complete guide to creating slash commands, user commands, and message commands. export const Route = ({method, children}) => { return
{method} {children}
; }; export const ManualAnchor = ({id}) => { return
; }; Application commands are native ways to interact with apps in the Discord client. There are 3 types of commands accessible in different interfaces: the chat input, a message's context menu (top-right menu or right-clicking in a message), and a user's context menu (right-clicking on a user). Client interfaces showing the different types of application commands ## Application Command Object ###### Application Command Naming `CHAT_INPUT` command names and command option names must match the following regex `^[-_'\p{L}\p{N}\p{sc=Deva}\p{sc=Thai}]{1,32}$` with the unicode flag set. If there is a lowercase variant of any letters used, you must use those. Characters with no lowercase variants and/or uncased letters are still allowed. `USER` and `MESSAGE` commands may be mixed case and can include spaces. ###### Application Command Structure | Field | Type | Description | Valid Types | | ---------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------ | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------- | | id | snowflake | Unique ID of command | all | | type? | one of [command types](/developers/interactions/application-commands#application-command-object-application-command-types) | [Type of command](/developers/interactions/application-commands#application-command-object-application-command-types), defaults to `1` | all | | application\_id | snowflake | ID of the parent application | all | | guild\_id? | snowflake | Guild ID of the command, if not global | all | | name | string | [Name of command](/developers/interactions/application-commands#application-command-object-application-command-naming), 1-32 characters | all | | name\_localizations? | ?dictionary with keys in [available locales](/developers/reference#locales) | Localization dictionary for `name` field. Values follow the same restrictions as `name` | all | | description | string | Description for `CHAT_INPUT` commands, 1-100 characters. Empty string for `USER` and `MESSAGE` commands | all | | description\_localizations? | ?dictionary with keys in [available locales](/developers/reference#locales) | Localization dictionary for `description` field. Values follow the same restrictions as `description` | all | | options? \* | array of [command options](/developers/interactions/application-commands#application-command-object-application-command-option-structure) | Parameters for the command, max of 25 | CHAT\_INPUT | | default\_member\_permissions | ?string | Set of [permissions](/developers/topics/permissions) represented as a bit set | all | | dm\_permission? | boolean | **Deprecated (use `contexts` instead)**; Indicates whether the command is available in DMs with the app, only for globally-scoped commands. By default, commands are visible. | all | | default\_permission? | ?boolean | Not recommended for use as field will soon be deprecated. Indicates whether the command is enabled by default when the app is added to a guild, defaults to `true` | all | | nsfw? | boolean | Indicates whether the command is [age-restricted](/developers/interactions/application-commands#agerestricted-commands), defaults to `false` | all | | integration\_types? | list of [integration types](/developers/resources/application#application-object-application-integration-types) | [Installation contexts](/developers/resources/application#installation-context) where the command is available, only for globally-scoped commands. Defaults to your app's [configured contexts](/developers/resources/application#setting-supported-installation-contexts) | all | | contexts? | ?list of [interaction context types](/developers/interactions/receiving-and-responding#interaction-object-interaction-context-types) | [Interaction context(s)](/developers/interactions/receiving-and-responding#interaction-object-interaction-context-types) where the command can be used, only for globally-scoped commands. | all | | version | snowflake | Autoincrementing version identifier updated during substantial record changes | all | | handler? | one of [command handler types](/developers/interactions/application-commands#application-command-object-entry-point-command-handler-types) | Determines whether the interaction is handled by the app's interactions handler or by Discord | PRIMARY\_ENTRY\_POINT | \* `options` can only be set for application commands of type `CHAT_INPUT`. \* `handler` can only be set for application commands of type `PRIMARY_ENTRY_POINT` for applications with the `EMBEDDED` flag (i.e. applications that have an Activity). `default_permission` will soon be deprecated. You can instead set `default_member_permissions` to `"0"` to disable the command for everyone except admins by default, and/or use `contexts` to disable globally-scoped commands inside of DMs with your app ###### Application Command Types | Name | Type | Description | | --------------------- | ---- | ----------------------------------------------------------------------------------------------------------------- | | CHAT\_INPUT | 1 | Slash commands; a text-based command that shows up when a user types `/` | | USER | 2 | A UI-based command that shows up when you right click or tap on a user | | MESSAGE | 3 | A UI-based command that shows up when you right click or tap on a message | | PRIMARY\_ENTRY\_POINT | 4 | A UI-based command that represents the primary way to invoke an app's [Activity](/developers/activities/overview) | ###### Application Command Option Structure Required `options` must be listed before optional options | Field | Type | Description | Valid Option Types | | --------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ----------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------- | | type | one of [application command option type](/developers/interactions/application-commands#application-command-object-application-command-option-type) | Type of option | all | | name \* | string | [1-32 character name](/developers/interactions/application-commands#application-command-object-application-command-naming) | all | | name\_localizations? | ?dictionary with keys in [available locales](/developers/reference#locales) | Localization dictionary for the `name` field. Values follow the same restrictions as `name` | all | | description | string | 1-100 character description | all | | description\_localizations? | ?dictionary with keys in [available locales](/developers/reference#locales) | Localization dictionary for the `description` field. Values follow the same restrictions as `description` | all | | required? | boolean | Whether the parameter is required or optional, default `false` | all but `SUB_COMMAND` and `SUB_COMMAND_GROUP` | | choices? | array of [application command option choice](/developers/interactions/application-commands#application-command-object-application-command-option-choice-structure) | Choices for the user to pick from, max 25 | `STRING`, `INTEGER`, `NUMBER` | | options? | array of [application command option](/developers/interactions/application-commands#application-command-object-application-command-option-structure) | If the option is a subcommand or subcommand group type, these nested options will be the parameters or subcommands respectively; up to 25 | `SUB_COMMAND` , `SUB_COMMAND_GROUP` | | channel\_types? | array of [channel types](/developers/resources/channel#channel-object-channel-types) | The channels shown will be restricted to these types | `CHANNEL` | | min\_value? | integer for `INTEGER` options, double for `NUMBER` options | The minimum value permitted | `INTEGER` , `NUMBER` | | max\_value? | integer for `INTEGER` options, double for `NUMBER` options | The maximum value permitted | `INTEGER` , `NUMBER` | | min\_length? | integer | The minimum allowed length (minimum of `0`, maximum of `6000`) | `STRING` | | max\_length? | integer | The maximum allowed length (minimum of `1`, maximum of `6000`) | `STRING` | | autocomplete? \*\* | boolean | If autocomplete interactions are enabled for this option | `STRING`, `INTEGER`, `NUMBER` | \* `name` must be unique within an array of [application command options](/developers/interactions/application-commands#application-command-object-application-command-option-structure). \*\* `autocomplete` may not be set to true if `choices` are present. Options using `autocomplete` are not confined to only use choices given by the application. ###### Application Command Option Type | Name | Value | Note | | ------------------- | ----- | -------------------------------------------------------------------- | | SUB\_COMMAND | 1 | | | SUB\_COMMAND\_GROUP | 2 | | | STRING | 3 | | | INTEGER | 4 | Any integer between -2^53+1 and 2^53-1 | | BOOLEAN | 5 | | | USER | 6 | | | CHANNEL | 7 | Includes all channel types + categories | | ROLE | 8 | | | MENTIONABLE | 9 | Includes users and roles | | NUMBER | 10 | Any double between -2^53 and 2^53 | | ATTACHMENT | 11 | [attachment](/developers/resources/message#attachment-object) object | ###### Application Command Option Choice Structure If you specify `choices` for an option, they are the **only** valid values for a user to pick | Field | Type | Description | | -------------------- | --------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------- | | name | string | 1-100 character choice name | | name\_localizations? | ?dictionary with keys in [available locales](/developers/reference#locales) | Localization dictionary for the `name` field. Values follow the same restrictions as `name` | | value | string, integer, or double \* | Value for the choice, up to 100 characters if string | \* Type of `value` depends on the [option type](/developers/interactions/application-commands#application-command-object-application-command-option-type) that the choice belongs to. ###### Entry Point Command Handler Types | Name | Value | Note | | ------------------------- | ----- | -------------------------------------------------------------------------------------------------------------------------- | | APP\_HANDLER | 1 | The app handles the interaction using an interaction token | | DISCORD\_LAUNCH\_ACTIVITY | 2 | Discord handles the interaction by launching an Activity and sending a follow-up message without coordinating with the app | Details about Entry Point command handler types are in the [Entry Point handlers](/developers/interactions/application-commands#entry-point-handlers) section. ## Authorizing Your Application Application commands do not depend on a bot user in the guild; they use the [interactions](/developers/interactions/receiving-and-responding) model. To create commands in a guild, your app must be authorized with the `applications.commands` scope which can be used independently, but is also automatically included with the `bot` scope. When requesting this scope, we "shortcut" the OAuth2 flow similar to adding a bot. You don't need to complete the flow, exchange for a token, or any of that. If your application does not require a bot user in the guild for its commands to work, **you don't need to add the bot scope or a permission bitfield to the URL**. ## Registering a Command Commands can only be registered via HTTP endpoint. Commands can be scoped either globally or to a specific guild. Global commands are available for every guild that adds your app. An individual app's global commands are also available in DMs if that app has a bot that shares a mutual guild with the user. Guild commands are specific to the guild you specify when making them. Guild commands are not available in DMs. Command names are unique per application, per type, within each scope (global and guild). That means: * Your app **cannot** have two global `CHAT_INPUT` commands with the same name * Your app **cannot** have two guild `CHAT_INPUT` commands within the same name **on the same guild** * Your app **cannot** have two global `USER` commands with the same name * Your app **can** have a global and guild `CHAT_INPUT` command with the same name * Your app **can** have a global `CHAT_INPUT` and `USER` command with the same name * Your app **cannot** have a `PRIMARY_ENTRY_POINT` guild command * Multiple apps **can** have commands with the same names This list is non-exhaustive. In general, remember that command names must be unique per application, per type, and within each scope (global and guild). An app can have the following number of commands: * 100 global `CHAT_INPUT` commands * 15 global `USER` commands * 15 global `MESSAGE` commands * 1 global `PRIMARY_ENTRY_POINT` command For all command types except `PRIMARY_ENTRY_POINT`, you can have the same amount of guild-specific commands per guild. There is a global rate limit of 200 application command creates per day, per guild ### Making a Global Command Global commands are available on *all* your app's guilds. Global commands have inherent read-repair functionality. That means that if you make an update to a global command, and a user tries to use that command before it has updated for them, Discord will do an internal version check and reject the command, and trigger a reload for that command. To make a **global** command, make an HTTP POST call like this: ```py theme={null} import requests url = "https://discord.com/api/v10/applications//commands" # This is an example CHAT_INPUT or Slash Command, with a type of 1 json = { "name": "blep", "type": 1, "description": "Send a random adorable animal photo", "options": [ { "name": "animal", "description": "The type of animal", "type": 3, "required": True, "choices": [ { "name": "Dog", "value": "animal_dog" }, { "name": "Cat", "value": "animal_cat" }, { "name": "Penguin", "value": "animal_penguin" } ] }, { "name": "only_smol", "description": "Whether to show only baby animals", "type": 5, "required": False } ] } # For authorization, you can use either your bot token headers = { "Authorization": "Bot " } # or a client credentials token for your app with the applications.commands.update scope headers = { "Authorization": "Bearer " } r = requests.post(url, headers=headers, json=json) ``` ### Making a Guild Command Guild commands are available only within the guild specified on creation. Guild commands update **instantly**. We recommend you use guild commands for quick testing, and global commands when they're ready for public use. To make a **guild** command, make a similar HTTP POST call, but scope it to a specific `guild_id`: ```py theme={null} import requests url = "https://discord.com/api/v10/applications//guilds//commands" # This is an example USER command, with a type of 2 json = { "name": "High Five", "type": 2 } # For authorization, you can use either your bot token headers = { "Authorization": "Bot " } # or a client credentials token for your app with the applications.commands.update scope headers = { "Authorization": "Bearer " } r = requests.post(url, headers=headers, json=json) ``` ## Updating and Deleting a Command Commands can be deleted and updated by making `DELETE` and `PATCH` calls to the command endpoint. Those endpoints are * `applications//commands/` for global commands, or * `applications//guilds//commands/` for guild commands Because commands have unique names within a type and scope, we treat `POST` requests for new commands as upserts. That means **making a new command with an already-used name for your application will update the existing command**. Detailed documentation about application command endpoints and their parameters are [in the endpoints section](/developers/interactions/application-commands#endpoints). ## Contexts Commands have two sets of contexts on the [application command object](/developers/interactions/application-commands#application-command-object) that let you to configure when and where it can be used: * `integration_types` defines the **[installation contexts](/developers/interactions/application-commands#installation-context)** that a command supports * `contexts` defines the **[interaction contexts](/developers/interactions/application-commands#interaction-contexts)** where a command can be used Details for both types of command contexts are in the sections below. Contexts are distinct from, and do not affect, any [command permissions](/developers/interactions/application-commands#permissions) for apps installed to a server. ### Installation Context The [installation context](/developers/resources/application#installation-context) is where your app was installed—to a server, a user, or both. If your app supports both installation contexts, there may be cases where you want some of your app's commands to only be available for one or the other. For example, maybe your app has a `/profile` command that is only relevant when it's installed to a user. A command's supported installation context(s) can be set using the [`integration_types` field](/developers/interactions/application-commands#application-command-object-application-command-structure) when creating or updating a command as long as any included contexts are already [supported on the application-level](/developers/resources/application#setting-supported-installation-contexts). A command's value for `integration_types` may affect which [interaction contexts](/developers/interactions/application-commands#interaction-contexts) a command is visible in. ### Interaction Contexts The interaction contexts for a command determines where in the Discord client it can be used, and can be configured by setting the [`contexts` field](/developers/interactions/application-commands#application-command-object-application-command-structure) when creating or updating a command. There are three [interaction context types](/developers/interactions/receiving-and-responding#interaction-object-interaction-context-types) that correspond to different surfaces: `GUILD` (`0`), `BOT_DM` (`1`), and `PRIVATE_CHANNEL` (`2`). However, the `PRIVATE_CHANNEL` interaction context is only meaningful for commands installed to a user (when the command's `integration_types` includes `USER_INSTALL`). ## Permissions Application command permissions allow your app to enable or disable commands for up to 100 users, roles, and channels within a guild. Command permissions can also be updated by users in the client if they have the necessary permissions. Command permissions can only be updated using a [Bearer token](/developers/topics/oauth2#client-credentials-grant). Authenticating with a bot token will result in an error. A command's current permissions can be retrieved using the [`GET /applications/{application.id}/guilds/{guild.id}/commands/{command.id}/permissions`](/developers/interactions/application-commands#get-application-command-permissions) endpoint. The response will include an array called `permissions` with associated IDs and permission types. Command permissions can be updated with the [`PUT /applications/{application.id}/guilds/{guild.id}/commands/{command.id}/permissions`](/developers/interactions/application-commands#edit-application-command-permissions) endpoint. To call the endpoint, apps must use a Bearer token that's authorized with the [`applications.commands.permissions.update`](/developers/topics/oauth2#shared-resources-oauth2-scopes) scope from a user with sufficient permissions. For their permissions to be considered sufficient, all of the following must be true for **the authenticating user** (not your app or bot user): * Has [permission to Manage Guild and Manage Roles](/developers/topics/permissions) in the guild where the command is being edited * Has the ability to run the command being edited * Has permission to manage the resources that will be affected (roles, users, and/or channels depending on the [permission types](/developers/interactions/application-commands#application-command-permissions-object-application-command-permission-type)) ### Syncing and Unsyncing Permissions The command permissions interface can be accessed in the client by navigating to `Server Settings` > `Integrations`, then clicking `Manage` to the right of an installed app. At the top of the interface, users can edit permissions for a specific user, role, or channel. By default, these top-level permissions will apply to all of an app's commands. However, each permission can also be unsynced and customized for individual commands to provide more granular control. When the permissions for a specific command are unsynced, meaning it doesn't align with the top-level permissions, the interface will display "Not Synced" to users. ### Application Command Permissions Object ###### Guild Application Command Permissions Structure Returned when fetching the permissions for an app's command(s) in a guild. | Field | Type | Description | | --------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------- | | id | snowflake | ID of the command or the application ID | | application\_id | snowflake | ID of the application the command belongs to | | guild\_id | snowflake | ID of the guild | | permissions | array of [application command permissions](/developers/interactions/application-commands#application-command-permissions-object-application-command-permissions-structure) | Permissions for the command in the guild, max of 100 | When the `id` field is the application ID instead of a command ID, the permissions apply to all commands that do not contain explicit overwrites. ###### Application Command Permissions Structure Application command permissions allow you to enable or disable commands for specific users, roles, or channels within a guild. | Field | Type | Description | | ---------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | id | snowflake | ID of the role, user, or channel. It can also be a [permission constant](/developers/interactions/application-commands#application-command-permissions-object-application-command-permissions-constants) | | type | [application command permission type](/developers/interactions/application-commands#application-command-permissions-object-application-command-permission-type) | role (`1`), user (`2`), or channel (`3`) | | permission | boolean | `true` to allow, `false`, to disallow | ###### Application Command Permissions Constants The following constants can be used in the `id` field for command permissions payloads. | Permission | Value | Type | Description | | ------------ | -------------- | --------- | ----------------------- | | `@everyone` | `guild_id` | snowflake | All members in a guild | | All Channels | `guild_id - 1` | snowflake | All channels in a guild | ###### Application Command Permission Type | Name | Value | | ------- | ----- | | ROLE | 1 | | USER | 2 | | CHANNEL | 3 | To allow for fine-tuned access to commands, application command permissions are supported for guild and global commands of all types. Guild members and apps with the [necessary permissions](/developers/interactions/application-commands#permissions) can allow or deny specific users and roles from using a command, or toggle commands for entire channels. Similar to how threads [inherit user and role permissions from the parent channel](/developers/topics/threads#permissions), any command permissions for a channel will apply to the threads it contains. If you don't have permission to use a command, it will not show up in the command picker. Members with the Administrator permission can use all commands. ###### Using Default Permissions Default permissions can be added to a command during creation using the `default_member_permissions` and `context` fields. Adding default permissions doesn't require any Bearer token since it's configured during command creation and isn't targeting specific roles, users, or channels. The `default_member_permissions` field can be used when creating a command to set the permissions a user must have to use it. The value for `default_member_permissions` is a bitwise OR-ed set of [permissions](/developers/topics/permissions#permissions-bitwise-permission-flags), serialized as a string. Setting it to `"0"` will prohibit anyone in a guild from using the command unless a specific overwrite is configured or the user has admin permissions. You can also include `BOT_DM` (`1`) in `contexts` when setting a global command's [interaction contexts](/developers/interactions/application-commands#interaction-contexts) to control whether it can be run in DMs with your app. Guild commands don't support the `BOT_DM` interaction context. ###### Example of editing permissions As an example, the following command would not be usable by anyone except admins in any guilds by default: ```json theme={null} { "name": "permissions_test", "description": "A test of default permissions", "type": 1, "default_member_permissions": "0" } ``` Or this would enable it just for users that have the `MANAGE_GUILD` permission: ```py theme={null} permissions = str(1 << 5) command = { "name": "permissions_test", "description": "A test of default permissions", "type": 1, "default_member_permissions": permissions } ``` And the following would disable a command for a specific channel: ```py theme={null} A_SPECIFIC_CHANNEL = "" url = "https://discord.com/api/v10/applications//guilds//commands//permissions" json = { "permissions": [ { "id": A_SPECIFIC_CHANNEL, "type": 3, "permission": False } ] } headers = { "Authorization": "Bearer " } r = requests.put(url, headers=headers, json=json) ``` ## Slash Commands Slash commands—the `CHAT_INPUT` type—are a type of application command. They're made up of a name, description, and a block of `options`, which you can think of like arguments to a function. The name and description help users find your command among many others, and the `options` validate user input as they fill out your command. Slash commands can also have groups and subcommands to further organize commands. More on those later. Slash commands can have a maximum of 8000 characters for combined name, description, and value properties for each command, its options (including subcommands and groups), and choices. When [localization fields](/developers/interactions/application-commands#localization) are present, only the longest localization for each field (including the default value) is counted towards the size limit. ###### Example Slash Command ```json theme={null} { "name": "blep", "type": 1, "description": "Send a random adorable animal photo", "options": [ { "name": "animal", "description": "The type of animal", "type": 3, "required": true, "choices": [ { "name": "Dog", "value": "animal_dog" }, { "name": "Cat", "value": "animal_cat" }, { "name": "Penguin", "value": "animal_penguin" } ] }, { "name": "only_smol", "description": "Whether to show only baby animals", "type": 5, "required": false } ] } ``` When someone uses a slash command, your application will receive an interaction: ###### Example Interaction ```json theme={null} { "type": 2, "token": "A_UNIQUE_TOKEN", "member": { "user": { "id": "53908232506183680", "username": "Mason", "avatar": "a_d5efa99b3eeaa7dd43acca82f5692432", "discriminator": "1337", "public_flags": 131141 }, "roles": ["539082325061836999"], "premium_since": null, "permissions": "2147483647", "pending": false, "nick": null, "mute": false, "joined_at": "2017-03-13T19:19:14.040000+00:00", "is_pending": false, "deaf": false }, "id": "786008729715212338", "guild_id": "290926798626357999", "app_permissions": "442368", "guild_locale": "en-US", "locale": "en-US", "data": { "options": [{ "type": 3, "name": "cardname", "value": "The Gitrog Monster" }], "type": 1, "name": "cardsearch", "id": "771825006014889984" }, "channel_id": "645027906669510667" } ``` ## Subcommands and Subcommand Groups Currently, subcommands and subcommand groups all appear at the top level in the command explorer. This may change in the future to include them as nested autocomplete options. For those developers looking to make more organized and complex groups of commands, look no further than subcommands and groups. **Subcommands** organize your commands by **specifying actions within a command or group**. **Subcommand Groups** organize your **subcommands** by **grouping subcommands by similar action or resource within a command**. These are not enforced rules. You are free to use subcommands and groups however you'd like; it's just how we think about them. Using subcommands or subcommand groups will make your base command unusable. You can't send the base `/permissions` command as a valid command if you also have `/permissions add | remove` as subcommands or subcommand groups We support nesting one level deep within a group, meaning your top level command can contain subcommand groups, and those groups can contain subcommands. **That is the only kind of nesting supported.** Here's some visual examples: ``` VALID command | |__ subcommand | |__ subcommand ---- VALID command | |__ subcommand-group | |__ subcommand | |__ subcommand-group | |__ subcommand ---- VALID command | |__ subcommand-group | |__ subcommand | |__ subcommand ------- INVALID command | |__ subcommand-group | |__ subcommand-group | |__ subcommand-group | |__ subcommand-group ---- INVALID command | |__ subcommand | |__ subcommand-group | |__ subcommand | |__ subcommand-group ``` ### Example Walkthrough Let's look at an example. Let's imagine you run a moderation bot. You want to make a `/permissions` command that can do the following: * Get the guild permissions for a user or a role * Get the permissions for a user or a role on a specific channel * Change the guild permissions for a user or a role * Change the permissions for a user or a role on a specific channel We'll start by defining the top-level information for `/permissions`: ```js theme={null} { "name": "permissions", "description": "Get or edit permissions for a user or a role", "options": [] } ``` A command with no arguments. It says /permissions Now we have a command named `permissions`. We want this command to be able to affect users and roles. Rather than making two separate commands, we can use subcommand groups. We want to use subcommand groups here because we are grouping commands on a similar resource: `user` or `role`. ```js theme={null} { "name": "permissions", "description": "Get or edit permissions for a user or a role", "options": [ { "name": "user", "description": "Get or edit permissions for a user", "type": 2 // 2 is type SUB_COMMAND_GROUP }, { "name": "role", "description": "Get or edit permissions for a role", "type": 2 } ] } ``` You'll notice that a command like this **will not show up** in the command explorer. That's because groups are effectively "folders" for commands, and we've made two empty folders. So let's continue. Now that we've effectively made `user` and `role` "folders", we want to be able to either `get` and `edit` permissions. Within the subcommand groups, we can make subcommands for `get` and `edit`: ```js theme={null} { "name": "permissions", "description": "Get or edit permissions for a user or a role", "options": [ { "name": "user", "description": "Get or edit permissions for a user", "type": 2, // 2 is type SUB_COMMAND_GROUP "options": [ { "name": "get", "description": "Get permissions for a user", "type": 1 // 1 is type SUB_COMMAND }, { "name": "edit", "description": "Edit permissions for a user", "type": 1 } ] }, { "name": "role", "description": "Get or edit permissions for a role", "type": 2, "options": [ { "name": "get", "description": "Get permissions for a role", "type": 1 }, { "name": "edit", "description": "Edit permissions for a role", "type": 1 } ] } ] } ``` A command with grouped subcommands. It says /permissions user get Now, we need some arguments! If we chose `user`, we need to be able to pick a user; if we chose `role`, we need to be able to pick a role. We also want to be able to pick between guild-level permissions and channel-specific permissions. For that, we can use optional arguments: ```js theme={null} { "name": "permissions", "description": "Get or edit permissions for a user or a role", "options": [ { "name": "user", "description": "Get or edit permissions for a user", "type": 2, // 2 is type SUB_COMMAND_GROUP "options": [ { "name": "get", "description": "Get permissions for a user", "type": 1, // 1 is type SUB_COMMAND "options": [ { "name": "user", "description": "The user to get", "type": 6, // 6 is type USER "required": true }, { "name": "channel", "description": "The channel permissions to get. If omitted, the guild permissions will be returned", "type": 7, // 7 is type CHANNEL "required": false } ] }, { "name": "edit", "description": "Edit permissions for a user", "type": 1, "options": [ { "name": "user", "description": "The user to edit", "type": 6, "required": true }, { "name": "channel", "description": "The channel permissions to edit. If omitted, the guild permissions will be edited", "type": 7, "required": false } ] } ] }, { "name": "role", "description": "Get or edit permissions for a role", "type": 2, "options": [ { "name": "get", "description": "Get permissions for a role", "type": 1, "options": [ { "name": "role", "description": "The role to get", "type": 8, // 8 is type ROLE "required": true }, { "name": "channel", "description": "The channel permissions to get. If omitted, the guild permissions will be returned", "type": 7, "required": false } ] }, { "name": "edit", "description": "Edit permissions for a role", "type": 1, "options": [ { "name": "role", "description": "The role to edit", "type": 8, "required": true }, { "name": "channel", "description": "The channel permissions to edit. If omitted, the guild permissions will be edited", "type": 7, "required": false } ] } ] } ] } ``` And, done! The JSON looks a bit complicated, but what we've ended up with is a single command that can be scoped to multiple actions, and then further scoped to a particular resource, and then even *further* scope with optional arguments. Here's what it looks like all put together. A command with grouped subcommands and parameters. It says /permissions user get with arguments for a user and a channel. ## User Commands User commands are application commands that appear on the context menu (right click or tap) of users. They're a great way to surface quick actions for your app that target users. They don't take any arguments, and will return the user on whom you clicked or tapped in the interaction response. A user must have permission to send text messages in the channel they invoke a user command in. If they don't have this permission, they will receive a 'Permission Denied' error from the interaction. The `description` field is not allowed when creating user commands. However, to avoid breaking changes to data models, `description` will be an **empty string** (instead of `null`) when fetching commands. ###### Example User Command ```json theme={null} { "name": "View Stats", "type": 2 } ``` An example user command. The context menu has an Apps section open to a High Five command When someone uses a user command, your application will receive an interaction: ###### Example Interaction ```json theme={null} { "application_id": "775799577604522054", "channel_id": "772908445358620702", "data": { "id": "866818195033292850", "name": "context-menu-user-2", "resolved": { "members": { "809850198683418695": { "avatar": null, "is_pending": false, "joined_at": "2021-02-12T18:25:07.972000+00:00", "nick": null, "pending": false, "permissions": "246997699136", "premium_since": null, "roles": [] } }, "users": { "809850198683418695": { "avatar": "afc428077119df8aabbbd84b0dc90c74", "bot": true, "discriminator": "7302", "id": "809850198683418695", "public_flags": 0, "username": "VoltyDemo" } } }, "target_id": "809850198683418695", "type": 2 }, "guild_id": "772904309264089089", "guild_locale": "en-US", "app_permissions": "442368", "id": "867794291820986368", "locale": "en-US", "member": { "avatar": null, "deaf": false, "is_pending": false, "joined_at": "2020-11-02T20:46:57.364000+00:00", "mute": false, "nick": null, "pending": false, "permissions": "274877906943", "premium_since": null, "roles": ["785609923542777878"], "user": { "avatar": "a_f03401914fb4f3caa9037578ab980920", "discriminator": "6538", "id": "167348773423415296", "public_flags": 1, "username": "ian" } }, "token": "UNIQUE_TOKEN", "type": 2, "version": 1 } ``` ## Message Commands Message commands are application commands that appear on the context menu (right click or tap) of messages. They're a great way to surface quick actions for your app that target messages. They don't take any arguments, and will return the message on whom you clicked or tapped in the interaction response. The `description` field is not allowed when creating message commands. However, to avoid breaking changes to data models, `description` will be an **empty string** (instead of `null`) when fetching commands. ###### Example Message Command ```json theme={null} { "name": "Challenge", "type": 3 } ``` An example message command. The context menu has an Apps section open to a Bookmark command When someone uses a message command, your application will receive an interaction: ###### Example Interaction ```json theme={null} { "application_id": "775799577604522054", "channel_id": "772908445358620702", "data": { "id": "866818195033292851", "name": "context-menu-message-2", "resolved": { "messages": { "867793854505943041": { "attachments": [], "author": { "avatar": "a_f03401914fb4f3caa9037578ab980920", "discriminator": "6538", "id": "167348773423415296", "public_flags": 1, "username": "ian" }, "channel_id": "772908445358620702", "components": [], "content": "some message", "edited_timestamp": null, "embeds": [], "flags": 0, "id": "867793854505943041", "mention_everyone": false, "mention_roles": [], "mentions": [], "pinned": false, "timestamp": "2021-07-22T15:42:57.744000+00:00", "tts": false, "type": 0 } } }, "target_id": "867793854505943041", "type": 3 }, "guild_id": "772904309264089089", "guild_locale": "en-US", "app_permissions": "442368", "id": "867793873336926249", "locale": "en-US", "member": { "avatar": null, "deaf": false, "is_pending": false, "joined_at": "2020-11-02T20:46:57.364000+00:00", "mute": false, "nick": null, "pending": false, "permissions": "274877906943", "premium_since": null, "roles": ["785609923542777878"], "user": { "avatar": "a_f03401914fb4f3caa9037578ab980920", "discriminator": "6538", "id": "167348773423415296", "public_flags": 1, "username": "ian" } }, "token": "UNIQUE_TOKEN", "type": 2, "version": 1 } ``` ## Entry Point Commands An Entry Point command serves as the primary way for users to open an app's [Activity](/developers/activities/overview) from the [App Launcher](https://support.discord.com/hc/articles/21334461140375-Using-Apps-on-Discord#h_01HRQSA6C8TRHS722P1H3HW1TV). For the Entry Point command to be visible to users, an app must have [Activities](/developers/activities/overview) enabled. Entry Point command in App Launcher ###### Example Entry Point Command ```json theme={null} { "name": "launch", "description": "Launch Racing with Friends", "type": 4, "handler": 2 } ``` ### Entry Point handlers When a user invokes an app's Entry Point command, the value of [`handler`](/developers/interactions/application-commands#application-command-object-application-command-structure) will determine how the interaction is handled: * For `APP_HANDLER` (`1`), the app is responsible for [responding to the interaction](/developers/interactions/receiving-and-responding#responding-to-an-interaction). It can respond by launching the app's associated Activity using the `LAUNCH_ACTIVITY` (type `12`) [interaction callback type](/developers/interactions/receiving-and-responding#interaction-response-object-interaction-callback-type), or take another action (like sending a follow-up message in channel). * For `DISCORD_LAUNCH_ACTIVITY` (`2`), Discord will handle the interaction automatically by launching the associated Activity and sending a message to the channel where it was launched. ### Default Entry Point command When you enable Activities, an Entry Point command (named "Launch") is automatically created for your app with `DISCORD_LAUNCH_ACTIVITY` (`2`) set as the [Entry Point handler](/developers/interactions/application-commands#entry-point-handlers). You can retrieve details for the automatically-created command, like its ID, by calling the [Get Global Application Commands](/developers/interactions/application-commands##get-global-application-commands) endpoint and looking for the "Launch" command. Details about updating or replacing the default Entry Point command is in the [Setting Up an Entry Point Command guide](/developers/activities/development-guides/user-actions#setting-up-an-entry-point-command). ## Autocomplete Autocomplete interactions allow your application to dynamically return option suggestions to a user as they type. An autocomplete interaction **can return partial data** for option values. Your application will receive partial data for any existing user input, as long as that input passes client-side validation. For example, you may receive partial strings, but not invalid numbers. The option the user is currently typing will be sent with a `focused: true` boolean field and options the user has already filled will also be sent but without the `focused` field. This is a special case where options that are otherwise required might not be present, due to the user not having filled them yet. This validation is **client-side only**. ```json theme={null} { "type": 4, "data": { "id": "816437322781949972", "name": "airhorn", "type": 1, "version": "847194950382780532", "options": [ { "type": 3, "name": "variant", "value": "data a user is typ", "focused": true } ] } } ``` ## Localization Application commands can be localized, which will cause them to use localized names and descriptions depending on the client's selected language. This is entirely optional. Localization is available for names and descriptions of commands, subcommands, and options, as well as the names of choices, by submitting the appropriate `name_localizations` and `description_localizations` fields when creating or updating the application command. Application commands may be partially localized - not all [available locales](/developers/reference#locales) are required, nor do different fields within a command need to support the same set of locales. If a locale is not present in a localizations dictionary for a field, users in that locale will see the default value for that field. It's not necessary to fill out all locales with the default value. Any localized values that are identical to the default will be ignored. Localized option names are subject to an additional constraint, which is that they must be distinct from all other default option names of that command, as well as all other option names within that locale on that command. When taking advantage of command localization, the interaction payload received by your client will still use default command, subcommand, and option names. To localize your interaction response, you can determine the client's selected language by using the `locale` key in the interaction payload. An application command furnished with localizations might look like this: ```json theme={null} { "name": "birthday", "type": 1, "description": "Wish a friend a happy birthday", "name_localizations": { "zh-CN": "生日", "el": "γενέθλια" }, "description_localizations": { "zh-CN": "祝你朋友生日快乐" }, "options": [ { "name": "age", "type": 4, "description": "Your friend's age", "name_localizations": { "zh-CN": "岁数" }, "description_localizations": { "zh-CN": "你朋友的岁数" } } ] } ``` ### Locale fallbacks For application commands, there are built-in fallbacks in case a user's locale isn't present in the localizations. If the fallback locale is also missing, it will use the default. You should make sure to include your default value in its proper locale key, otherwise it may use a fallback value unexpectedly. For example, if your default value is `en-US`, but you don't specify the `en-US` value in your localizations, users with `en-US` selected will see the `en-GB` value if it's specified. For example, if you have a command with the default name "color", and your localizations specify only the `en-GB` value as "colour", users in the `en-US` locale will see "colour" because the `en-US` key is missing. | Locale | Fallback | | ------ | -------- | | en-US | en-GB | | en-GB | en-US | | es-419 | es-ES | ### Retrieving localized commands While most endpoints that return application command objects will return the `name_localizations` and `description_localizations` fields, some will not by default. This includes `GET` endpoints that return all of an application's guild or global commands. Instead, those endpoints will supply additional `name_localized` or `description_localized` fields, which only contain the localization relevant to the requester's locale. (The full dictionaries can still be obtained by supplying the appropriate query argument). For example, if a batch `GET` request were made with locale `zh-CN`, including the above command, the returned object would look as follows: ```json theme={null} { "name": "birthday", "type": 1, "description": "Wish a friend a happy birthday", "name_localized": "生日", "description_localized": "祝你朋友生日快乐", "options": [ { "name": "age", "type": 4, "description": "Your friend's age", "name_localized": "岁数", "description_localized": "你朋友的岁数", } ] } ``` If the requester's locale is not found in a localizations dictionary, then the corresponding `name_localization` or `description_localization` for that field will also not be present. Locale is determined by looking at the `X-Discord-Locale` header, then the `Accept-Language` header if not present, then lastly the user settings locale. ## Age-Restricted Commands A command that contains age-restricted content should have the [`nsfw` field](/developers/interactions/application-commands#application-command-object-application-command-structure) set to `true` upon creation or update. Marking a command as age-restricted will limit who can see and access the command, and from which channels. Apps with [discovery enabled](https://support-dev.discord.com/hc/en-us/articles/9489299950487) (which is required to appear in the App Directory) cannot contain any age-restricted commands or content. ### Using Age-Restricted Commands To use an age-restricted command, a user must be 18 years or older and access the command from either: * an [age-restricted channel](https://support.discord.com/hc/articles/115000084051-Age-Restricted-Channels-and-Content) or * a DM with the app *after* [enabling age-restricted commands](https://support.discord.com/hc/en-us/articles/10123937946007) within their User Settings. Details about accessing and using age-restricted commands is in [the Help Center](https://support.discord.com/hc/en-us/articles/10123937946007). ### Endpoints For authorization, all endpoints take either a [bot token](/developers/reference#authentication) or [client credentials token](/developers/topics/oauth2#client-credentials-grant) for your application ## Get Global Application Commands /applications/[\{application.id}](/developers/resources/application#application-object)/commands The objects returned by this endpoint may be augmented with [additional fields if localization is active](/developers/interactions/application-commands#retrieving-localized-commands). Fetch all of the global commands for your application. Returns an array of [application command](/developers/interactions/application-commands#application-command-object) objects. ###### Query String Params | Field | Type | Description | | -------------------- | ------------------------------------------------------ | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | with\_localizations? | [boolean](/developers/reference#boolean-query-strings) | Whether to include full localization dictionaries (`name_localizations` and `description_localizations`) in the returned objects, instead of the `name_localized` and `description_localized` fields. Default `false`. | ## Create Global Application Command /applications/[\{application.id}](/developers/resources/application#application-object)/commands Creating a command with the same name as an existing command for your application will overwrite the old command. Create a new global command. Returns `201` if a command with the same name does not already exist, or a `200` if it does (in which case the previous command will be overwritten). Both responses include an [application command](/developers/interactions/application-commands#application-command-object) object. ###### JSON Params | Field | Type | Description | | ----------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | name | string | [Name of command](/developers/interactions/application-commands#application-command-object-application-command-naming), 1-32 characters | | name\_localizations? | ?dictionary with keys in [available locales](/developers/reference#locales) | Localization dictionary for the `name` field. Values follow the same restrictions as `name` | | description? | string | 1-100 character description for `CHAT_INPUT` commands | | description\_localizations? | ?dictionary with keys in [available locales](/developers/reference#locales) | Localization dictionary for the `description` field. Values follow the same restrictions as `description` | | options? | array of [application command option](/developers/interactions/application-commands#application-command-object-application-command-option-structure) | the parameters for the command, max of 25 | | default\_member\_permissions? | ?string | Set of [permissions](/developers/topics/permissions) represented as a bit set | | dm\_permission? | ?boolean | **Deprecated (use `contexts` instead)**; Indicates whether the command is available in DMs with the app, only for globally-scoped commands. By default, commands are visible. | | default\_permission? | boolean | Replaced by `default_member_permissions` and will be deprecated in the future. Indicates whether the command is enabled by default when the app is added to a guild. Defaults to `true` | | integration\_types? | list of [integration types](/developers/resources/application#application-object-application-integration-types) | [Installation context(s)](/developers/resources/application#installation-context) where the command is available | | contexts? | list of [interaction context types](/developers/interactions/receiving-and-responding#interaction-object-interaction-context-types) | [Interaction context(s)](/developers/interactions/receiving-and-responding#interaction-object-interaction-context-types) where the command can be used | | type? | one of [application command type](/developers/interactions/application-commands#application-command-object-application-command-types) | Type of command, defaults `1` if not set | | nsfw? | boolean | Indicates whether the command is [age-restricted](/developers/interactions/application-commands#agerestricted-commands) | ## Get Global Application Command /applications/[\{application.id}](/developers/resources/application#application-object)/commands/[\{command.id}](/developers/interactions/application-commands#application-command-object) Fetch a global command for your application. Returns an [application command](/developers/interactions/application-commands#application-command-object) object. ## Edit Global Application Command /applications/[\{application.id}](/developers/resources/application#application-object)/commands/[\{command.id}](/developers/interactions/application-commands#application-command-object) All parameters for this endpoint are optional. Edit a global command. Returns `200` and an [application command](/developers/interactions/application-commands#application-command-object) object. All fields are optional, but any fields provided will entirely overwrite the existing values of those fields. ###### JSON Params | Field | Type | Description | | ----------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | name? | string | [Name of command](/developers/interactions/application-commands#application-command-object-application-command-naming), 1-32 characters | | name\_localizations? | ?dictionary with keys in [available locales](/developers/reference#locales) | Localization dictionary for the `name` field. Values follow the same restrictions as `name` | | description? | string | 1-100 character description | | description\_localizations? | ?dictionary with keys in [available locales](/developers/reference#locales) | Localization dictionary for the `description` field. Values follow the same restrictions as `description` | | options? | array of [application command option](/developers/interactions/application-commands#application-command-object-application-command-option-structure) | the parameters for the command | | default\_member\_permissions? | ?string | Set of [permissions](/developers/topics/permissions) represented as a bit set | | dm\_permission? | ?boolean | **Deprecated (use `contexts` instead)**; Indicates whether the command is available in DMs with the app, only for globally-scoped commands. By default, commands are visible. | | default\_permission? | boolean | Replaced by `default_member_permissions` and will be deprecated in the future. Indicates whether the command is enabled by default when the app is added to a guild. Defaults to `true` | | integration\_types? | list of [integration types](/developers/resources/application#application-object-application-integration-types) | [Installation context(s)](/developers/resources/application#installation-context) where the command is available | | contexts? | list of [interaction context types](/developers/interactions/receiving-and-responding#interaction-object-interaction-context-types) | [Interaction context(s)](/developers/interactions/receiving-and-responding#interaction-object-interaction-context-types) where the command can be used | | nsfw? | boolean | Indicates whether the command is [age-restricted](/developers/interactions/application-commands#agerestricted-commands) | ## Delete Global Application Command /applications/[\{application.id}](/developers/resources/application#application-object)/commands/[\{command.id}](/developers/interactions/application-commands#application-command-object) Deletes a global command. Returns `204 No Content` on success. ## Bulk Overwrite Global Application Commands /applications/[\{application.id}](/developers/resources/application#application-object)/commands Takes a list of application commands, overwriting the existing global command list for this application. Returns `200` and a list of [application command](/developers/interactions/application-commands#application-command-object) objects. Commands that do not already exist will count toward daily application command create limits. This will overwrite **all** types of application commands: slash commands, user commands, and message commands. ## Get Guild Application Commands /applications/[\{application.id}](/developers/resources/application#application-object)/guilds/[\{guild.id}](/developers/resources/guild#guild-object)/commands The objects returned by this endpoint may be augmented with [additional fields if localization is active](/developers/interactions/application-commands#retrieving-localized-commands). Fetch all of the guild commands for your application for a specific guild. Returns an array of [application command](/developers/interactions/application-commands#application-command-object) objects. ###### Query String Params | Field | Type | Description | | -------------------- | ------------------------------------------------------ | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | with\_localizations? | [boolean](/developers/reference#boolean-query-strings) | Whether to include full localization dictionaries (`name_localizations` and `description_localizations`) in the returned objects, instead of the `name_localized` and `description_localized` fields. Default `false`. | ## Create Guild Application Command /applications/[\{application.id}](/developers/resources/application#application-object)/guilds/[\{guild.id}](/developers/resources/guild#guild-object)/commands Creating a command with the same name as an existing command for your application will overwrite the old command. Create a new guild command. New guild commands will be available in the guild immediately. Returns `201` if a command with the same name does not already exist, or a `200` if it does (in which case the previous command will be overwritten). Both responses include an [application command](/developers/interactions/application-commands#application-command-object) object. ###### JSON Params | Field | Type | Description | | ----------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | name | string | [Name of command](/developers/interactions/application-commands#application-command-object-application-command-naming), 1-32 characters | | name\_localizations? | ?dictionary with keys in [available locales](/developers/reference#locales) | Localization dictionary for the `name` field. Values follow the same restrictions as `name` | | description? | string | 1-100 character description for `CHAT_INPUT` commands | | description\_localizations? | ?dictionary with keys in [available locales](/developers/reference#locales) | Localization dictionary for the `description` field. Values follow the same restrictions as `description` | | options? | array of [application command option](/developers/interactions/application-commands#application-command-object-application-command-option-structure) | Parameters for the command, max of 25 | | default\_member\_permissions? | ?string | Set of [permissions](/developers/topics/permissions) represented as a bit set | | default\_permission? | boolean | Replaced by `default_member_permissions` and will be deprecated in the future. Indicates whether the command is enabled by default when the app is added to a guild. Defaults to `true` | | type? | one of [application command type](/developers/interactions/application-commands#application-command-object-application-command-types) | Type of command, defaults `1` if not set | | nsfw? | boolean | Indicates whether the command is [age-restricted](/developers/interactions/application-commands#agerestricted-commands) | ## Get Guild Application Command /applications/[\{application.id}](/developers/resources/application#application-object)/guilds/[\{guild.id}](/developers/resources/guild#guild-object)/commands/[\{command.id}](/developers/interactions/application-commands#application-command-object) Fetch a guild command for your application. Returns an [application command](/developers/interactions/application-commands#application-command-object) object. ## Edit Guild Application Command /applications/[\{application.id}](/developers/resources/application#application-object)/guilds/[\{guild.id}](/developers/resources/guild#guild-object)/commands/[\{command.id}](/developers/interactions/application-commands#application-command-object) All parameters for this endpoint are optional. Edit a guild command. Updates for guild commands will be available immediately. Returns `200` and an [application command](/developers/interactions/application-commands#application-command-object) object. All fields are optional, but any fields provided will entirely overwrite the existing values of those fields. ###### JSON Params | Field | Type | Description | | ----------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | name? | string | [Name of command](/developers/interactions/application-commands#application-command-object-application-command-naming), 1-32 characters | | name\_localizations? | ?dictionary with keys in [available locales](/developers/reference#locales) | Localization dictionary for the `name` field. Values follow the same restrictions as `name` | | description? | string | 1-100 character description | | description\_localizations? | ?dictionary with keys in [available locales](/developers/reference#locales) | Localization dictionary for the `description` field. Values follow the same restrictions as `description` | | options? | array of [application command option](/developers/interactions/application-commands#application-command-object-application-command-option-structure) | Parameters for the command, max of 25 | | default\_member\_permissions? | ?string | Set of [permissions](/developers/topics/permissions) represented as a bit set | | default\_permission? | boolean | Replaced by `default_member_permissions` and will be deprecated in the future. Indicates whether the command is enabled by default when the app is added to a guild. Defaults to `true` | | nsfw? | boolean | Indicates whether the command is [age-restricted](/developers/interactions/application-commands#agerestricted-commands) | ## Delete Guild Application Command /applications/[\{application.id}](/developers/resources/application#application-object)/guilds/[\{guild.id}](/developers/resources/guild#guild-object)/commands/[\{command.id}](/developers/interactions/application-commands#application-command-object) Delete a guild command. Returns `204 No Content` on success. ## Bulk Overwrite Guild Application Commands /applications/[\{application.id}](/developers/resources/application#application-object)/guilds/[\{guild.id}](/developers/resources/guild#guild-object)/commands Takes a list of application commands, overwriting the existing command list for this application for the targeted guild. Returns `200` and a list of [application command](/developers/interactions/application-commands#application-command-object) objects. This will overwrite **all** types of application commands: slash commands, user commands, and message commands. ###### JSON Params | Field | Type | Description | | ----------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | id? | snowflake | ID of the command, if known | | name | string | [Name of command](/developers/interactions/application-commands#application-command-object-application-command-naming), 1-32 characters | | name\_localizations? | ?dictionary with keys in [available locales](/developers/reference#locales) | Localization dictionary for the `name` field. Values follow the same restrictions as `name` | | description | string | 1-100 character description | | description\_localizations? | ?dictionary with keys in [available locales](/developers/reference#locales) | Localization dictionary for the `description` field. Values follow the same restrictions as `description` | | options? | array of [application command option](/developers/interactions/application-commands#application-command-object-application-command-option-structure) | Parameters for the command | | default\_member\_permissions? | ?string | Set of [permissions](/developers/topics/permissions) represented as a bit set | | dm\_permission? | ?boolean | **Deprecated (use `contexts` instead)**; Indicates whether the command is available in DMs with the app, only for globally-scoped commands. By default, commands are visible. | | default\_permission? | boolean | Replaced by `default_member_permissions` and will be deprecated in the future. Indicates whether the command is enabled by default when the app is added to a guild. Defaults to `true` | | integration\_types | list of [integration types](/developers/resources/application#application-object-application-integration-types) | [Installation context(s)](/developers/resources/application#installation-context) where the command is available, defaults to `GUILD_INSTALL` (`[0]`) | | contexts | list of [interaction context types](/developers/interactions/receiving-and-responding#interaction-object-interaction-context-types) | [Interaction context(s)](/developers/interactions/receiving-and-responding#interaction-object-interaction-context-types) where the command can be used, defaults to all contexts `[0,1,2]` | | type? | one of [application command type](/developers/interactions/application-commands#application-command-object-application-command-types) | Type of command, defaults `1` if not set | ## Get Guild Application Command Permissions /applications/[\{application.id}](/developers/resources/application#application-object)/guilds/[\{guild.id}](/developers/resources/guild#guild-object)/commands/permissions Fetches permissions for all commands for your application in a guild. Returns an array of [guild application command permissions](/developers/interactions/application-commands#application-command-permissions-object-guild-application-command-permissions-structure) objects. ## Get Application Command Permissions /applications/[\{application.id}](/developers/resources/application#application-object)/guilds/[\{guild.id}](/developers/resources/guild#guild-object)/commands/[\{command.id}](/developers/interactions/application-commands#application-command-object)/permissions Fetches permissions for a specific command for your application in a guild. Returns a [guild application command permissions](/developers/interactions/application-commands#application-command-permissions-object-guild-application-command-permissions-structure) object. ## Edit Application Command Permissions /applications/[\{application.id}](/developers/resources/application#application-object)/guilds/[\{guild.id}](/developers/resources/guild#guild-object)/commands/[\{command.id}](/developers/interactions/application-commands#application-command-object)/permissions This endpoint will overwrite existing permissions for the command in that guild Edits command permissions for a specific command for your application in a guild and returns a [guild application command permissions](/developers/interactions/application-commands#application-command-permissions-object-guild-application-command-permissions-structure) object. Fires an [Application Command Permissions Update](/developers/events/gateway-events#application-command-permissions-update) Gateway event. You can add up to 100 permission overwrites for a command. This endpoint requires authentication with a Bearer token that has permission to manage the guild and its roles. For more information, read above about [application command permissions](/developers/interactions/application-commands#permissions). Deleting or renaming a command will permanently delete all permissions for the command ###### JSON Params | Field | Type | Description | | ----------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------- | | permissions | array of [application command permissions](/developers/interactions/application-commands#application-command-permissions-object-application-command-permissions-structure) | Permissions for the command in the guild | ## Batch Edit Application Command Permissions /applications/[\{application.id}](/developers/resources/application#application-object)/guilds/[\{guild.id}](/developers/resources/guild#guild-object)/commands/permissions This endpoint has been disabled with [updates to command permissions (Permissions v2)](/developers/change-log#updated-command-permissions). Instead, you can [edit each application command permissions](/developers/interactions/application-commands#edit-application-command-permissions) (though you should be careful to handle any potential [rate limits](/developers/topics/rate-limits)).