Version: Next

RESTPostAPIChatInputApplicationCommandsJSONBody

https://discord.com/developers/docs/interactions/application-commands#create-global-application-command

Hierarchy

RESTPostAPIBaseApplicationCommandsJSONBody
- RESTPostAPIChatInputApplicationCommandsJSONBody

Index

Properties

contexts
default_member_permissions
default_permission
description
description_localizations
dm_permission
handler
integration_types
name
name_localizations
nsfw
options
type

Properties

optionalcontexts

contexts?: AddUndefinedToPossiblyUndefinedPropertiesOfInterface<InteractionContextType>[]

Interaction context(s) where the command can be used, only for globally-scoped commands. By default, all interaction context types included for new commands [0,1,2].

optionaldefault_member_permissions

default_member_permissions?: null | string

Set of permissions represented as a bitset

optionaldefault_permission

default_permission?: boolean

Whether the command is enabled by default when the app is added to a guild

If missing, this property should be assumed as true

@deprecated: Use dm_permission and/or default_member_permissions instead

description

description: string

optionaldescription_localizations

description_localizations?: null | AddUndefinedToPossiblyUndefinedPropertiesOfInterface<Partial<Record<Locale, null | string>>>

Localization dictionary for the description field. Values follow the same restrictions as description

optionaldm_permission

dm_permission?: boolean

Indicates whether the command is available in DMs with the app, only for globally-scoped commands. By default, commands are visible

@deprecated: Use contexts instead

optionalhandler

handler?: AppHandler | DiscordLaunchActivity

Determines whether the interaction is handled by the app’s interactions handler or by Discord

@remarks: This is only available for ApplicationCommandType.PrimaryEntryPoint commands

optionalintegration_types

integration_types?: AddUndefinedToPossiblyUndefinedPropertiesOfInterface<ApplicationIntegrationType>[]

Installation context(s) where the command is available, only for globally-scoped commands. Defaults to GUILD_INSTALL ([0])

name

name: string

1-32 character name; CHAT_INPUT command names must be all lowercase matching ^[-_\p{L}\p{N}\p{sc=Deva}\p{sc=Thai}]{1,32}$

optionalname_localizations

name_localizations?: null | AddUndefinedToPossiblyUndefinedPropertiesOfInterface<Partial<Record<Locale, null | string>>>

Localization dictionary for the name field. Values follow the same restrictions as name

optionalnsfw

nsfw?: boolean

Indicates whether the command is age-restricted, defaults to false

optionaloptions

options?: AddUndefinedToPossiblyUndefinedPropertiesOfInterface<APIApplicationCommandOption>[]

The parameters for the CHAT_INPUT command, max 25

optionaltype

type?: ChatInput