Discord Bot

discordbot

Discordbot refers to automated programs on Discord servers, performing tasks like moderation, music playback, and user engagement to enhance community interactions

Team Chat Team Collaboration Web del proveedor

Acciones

164

Triggers

Autenticación

—

OAuth gestionado

Sí

Información técnica: el detalle de parámetros, schemas y triggers de esta página está pensado para equipos de integración. Si solo necesitas saber si tu herramienta favorita está disponible, basta con ver la lista de acciones.

Acciones disponibles (164)

Cada acción es una operación que el agente puede ejecutar contra este conector. Haz clic en una acción para ver sus parámetros.

Add recipient to group channelDISCORDBOT_ADD_GROUP_DM_USERAcción

Adds a user to a discord group direct message (dm) channel.

Parámetros de entrada

nickstring
Nickname for the user in the group DM. Uses user's default display name if not provided.
user_idstringObligatorio
ID of the user to add to the group DM channel.
channel_idstringObligatorio
ID of the group DM channel to add the user to.
access_tokenstring
Access token of the user being added; must have the `gdm.join` OAuth2 scope.

Parámetros de salida

dataobjectObligatorio
API response. Empty or contains channel/recipient details on success; error details on failure.
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Update guild member informationDISCORDBOT_ADD_GUILD_MEMBERAcción

Adds a user (who is not already a member) to a guild using their `access token` (which must have `guilds.join` scope), optionally setting nickname, roles, mute/deaf status, or flags.

Parámetros de entrada

deafboolean
Whether the user should be server deafened in voice channels. Requires `DEAFEN_MEMBERS` permission for the bot if setting this.
muteboolean
Whether the user should be server muted in voice channels. Requires `MUTE_MEMBERS` permission for the bot if setting this.
nickstring
Nickname to set for the user in this guild. If `null` or empty, no nickname is set.
flagsinteger
Member flags to set. Refer to Discord API for values. Setting certain flags might require `MODERATE_MEMBERS` permission.
rolesnull[]
List of role IDs (strings) to assign. **Important**: Value must be a list of role ID strings, despite the schema's type hint.
user_idstringObligatorio
ID of the user to add.
guild_idstringObligatorio
ID of the guild to add the user to.
access_tokenstringObligatorio
OAuth2 access token for the user, with `guilds.join` scope, to authorize adding them to the guild.

Parámetros de salida

dataobjectObligatorio
The guild member object for the user added/updated in the guild.
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Assign role to guild memberDISCORDBOT_ADD_GUILD_MEMBER_ROLEAcción

Assigns a role to a guild member, provided the bot has 'manage roles' permission in the guild and the role to be assigned is hierarchically lower than the bot's highest role.

Parámetros de entrada

role_idstringObligatorio
The unique identifier of the Discord role to be assigned to the member.
user_idstringObligatorio
The unique identifier of the Discord user (member) to whom the role will be added.
guild_idstringObligatorio
The unique identifier of the Discord guild (server) where the member and role exist.

Parámetros de salida

dataobjectObligatorio
An empty dictionary. A successful operation returns a `204 No Content` status, signifying that the role was added but no data is returned in the response body.
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Add reaction to messageDISCORDBOT_ADD_MY_MESSAGE_REACTIONAcción

Adds an emoji reaction from the authenticated user/bot to a specific message in a discord channel; does not return information about existing reactions.

Parámetros de entrada

channel_idstringObligatorio
Channel Id
emoji_namestringObligatorio
Emoji Name
message_idstringObligatorio
Message Id

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Add or update thread memberDISCORDBOT_ADD_THREAD_MEMBERAcción

Adds a user to a specific, unarchived thread; the user must have access to the thread's parent channel, and for private threads, the bot must already be a member.

Parámetros de entrada

user_idstringObligatorio
The ID of the user to add to the thread.
channel_idstringObligatorio
The ID of the thread to which the user will be added.

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Modify guild ban settingsDISCORDBOT_BAN_USER_FROM_GUILDAcción

Permanently bans a user from a discord guild, optionally deleting their recent messages (specify deletion period in seconds or days, not both).

Parámetros de entrada

user_idstringObligatorio
Unique identifier of the Discord user to be banned.
guild_idstringObligatorio
Unique identifier of the Discord guild (server).
delete_message_daysinteger
Number of days (0-7) of the user's past messages to delete; use this OR `delete_message_seconds`.
delete_message_secondsinteger
Number of seconds (0-604800, i.e., 7 days) of the user's past messages to delete; use this OR `delete_message_days`.

Parámetros de salida

dataobjectObligatorio
A dictionary containing the API response. For a successful ban (HTTP 204 No Content), this may be an empty dictionary. If the API returns a ban object (e.g., HTTP 201 Created), it will be included here.
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Bulk ban users in guild with message deletion optionDISCORDBOT_BULK_BAN_USERS_FROM_GUILDAcción

Bans up to 200 users from a discord guild, optionally deleting their recent messages; the bot must have 'ban members' permission in the guild, and this action is irreversible.

Parámetros de entrada

guild_idstringObligatorio
The unique identifier of the Discord guild (server) from which users will be banned.
user_idsstring[]Obligatorio
IDs of users to ban from the guild (maximum 200).
delete_message_secondsinteger
Number of seconds of messages (0-604800, i.e., 0 seconds to 7 days) to delete for banned users. If omitted or set to 0, no messages are deleted.

Parámetros de salida

dataobjectObligatorio
The result of the bulk ban operation, listing successful and failed user bans.
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Bulk delete messages in channelDISCORDBOT_BULK_DELETE_MESSAGESAcción

Atomically bulk deletes messages in a discord channel for moderation or maintenance; deletion may not be instantaneous and messages are unrecoverable.

Parámetros de entrada

messagesstring[]Obligatorio
A list of unique message IDs to be deleted from the specified channel. This list must contain between 2 and 100 message IDs. All messages must be less than two weeks old; older messages must be deleted individually.
channel_idstringObligatorio
The unique identifier of the Discord channel from which messages will be deleted.

Parámetros de salida

dataobjectObligatorio
An empty dictionary. This endpoint returns an HTTP 204 No Content status upon successful message deletion, indicating that there is no response body.
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Create application command objectsDISCORDBOT_CREATE_APPLICATION_COMMANDAcción

Creates a new global discord application command, accessible across guilds and in dms (if `dm permission` is true), noting global commands can take up to an hour to propagate and have registration limits; for guild-specific commands, use a different action.

Parámetros de entrada

namestringObligatorio
1-32 characters. For USER and MESSAGE commands, this is the label displayed in the context menu. Must be unique for the application in its scope (global or guild).
typenull
Command type. Defaults to 1 (CHAT_INPUT). Others: 2 (USER), 3 (MESSAGE).
optionsobject[]
For CHAT_INPUT commands: parameters or subcommands (max 25). See Discord API for option structure.
descriptionstring
1-100 characters for CHAT_INPUT commands; displayed to user. For USER/MESSAGE commands, use empty string or omit.
dm_permissionboolean
If command is available in DMs with the app (global commands only). Defaults to true.
application_idstringObligatorio
Unique ID of the Discord application.
name_localizationsobject
Localization dictionary for `name`, mapping locale codes to names (1-32 chars each).
description_localizationsobject
Localization dictionary for `description`, mapping locale codes to descriptions (1-100 chars each).
default_member_permissionsinteger
Bitwise permission flags (string) a member needs. '0' for none. Omitted/null means usable by everyone with access.

Parámetros de salida

dataobjectObligatorio
The created Application Command object.
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Create guild auto moderation ruleDISCORDBOT_CREATE_AUTO_MODERATION_RULEAcción

Creates a new auto moderation rule for a discord guild, requiring 'manage guild' permission; rule parameters are passed in the json request body (see request schema description for body content).

Parámetros de entrada

guild_idstringObligatorio
The unique identifier of the Discord guild (server) where the auto moderation rule will be created.

Parámetros de salida

dataobjectObligatorio
A dictionary representing the auto moderation rule object that was successfully created.
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Create channel inviteDISCORDBOT_CREATE_CHANNEL_INVITEAcción

Creates a new invite for the specified discord channel, provided the bot has 'create instant invite' permission for that channel.

Parámetros de entrada

channel_idstringObligatorio
The unique identifier of the Discord channel for which to create the invite.

Parámetros de salida

dataobjectObligatorio
A dictionary representing the created Discord Invite object. This typically includes fields like `code`, `guild` and `channel` details, `inviter` information, `uses`, `max_uses`, `max_age` (in seconds), `temporary` (boolean indicating temporary membership), and `created_at` timestamp. Other fields related to invite targets may also be present.
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Initiate user channel with recipientDISCORDBOT_CREATE_DMAcción

Creates a new direct message (dm) channel or retrieves an existing one, using `recipient id` for a 1-on-1 dm or `access tokens` for a group dm; this action only establishes or fetches the channel and does not send messages.

Parámetros de entrada

nicksobject
Sets custom nicknames for users in a group DM. Keys are User IDs, values are nicknames. Only used with `access_tokens`.
recipient_idnull
The User ID for a 1-on-1 DM. Use this OR `access_tokens`.
access_tokensstring[]
OAuth2 access tokens for users in a group DM (1 to 9 others). Use this OR `recipient_id`.

Parámetros de salida

dataobjectObligatorio
A dictionary representing the DM channel object that was created or retrieved. The structure of this object conforms to Discord's Channel Object specification.
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Create new guild objectDISCORDBOT_CREATE_GUILDAcción

Creates a new discord guild (server) with the specified name, roles, and channels; icon must be a base64 encoded 128x128 image, and if `afk channel id` is set, `afk timeout` must also be set.

Parámetros de entrada

iconstring
Base64 encoded 128x128 image (JPEG, PNG, or GIF) for the guild icon.
namestringObligatorio
The name of the guild (2-100 characters).
rolesobject[]
Array of role objects for the new guild. The first role in this list (e.g., with placeholder ID 0) is often used to set permissions for the `@everyone` role.
regionstring
Voice region ID. This field is deprecated; voice regions are now handled automatically by Discord.
channelsobject[]
Array of channel objects for the new guild. When specifying `permission_overwrites` within these channels, the `id` field refers to a placeholder ID from the `roles` array.
afk_timeoutnull
AFK timeout in seconds. After this period of inactivity, users will be moved to the AFK channel. Allowed values: 60, 300, 900, 1800, 3600.
descriptionstring
The description for the guild, if desired.
afk_channel_idnull
The ID of the channel to which AFK users are moved. Must be a voice channel. If provided, `afk_timeout` must also be set.
preferred_localenull
The preferred locale for a Community guild, used in server discovery and notices from Discord. Defaults to 'en-US'.
system_channel_idnull
The ID of the channel where guild system messages (e.g., welcome messages, server boost notifications) are posted.
verification_levelnull
Verification level required for the guild. `0`: None, `1`: Low (verified email), `2`: Medium (registered on Discord >5 mins), `3`: High (member of server >10 mins), `4`: Highest (verified phone).
system_channel_flagsinteger
Bitwise value of system channel flags that control which system messages are sent. Consult Discord API documentation for flag values (e.g., suppress join notifications: 1 << 0).
explicit_content_filternull
Explicit content filter level for the guild. `0`: Disabled, `1`: Members without roles, `2`: All members.
default_message_notificationsnull
Default message notification level for new members. `0`: All Messages, `1`: Only @mentions.

Parámetros de salida

dataobjectObligatorio
The newly created guild object, containing all its properties and settings.
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Create guild application commandDISCORDBOT_CREATE_GUILD_APPLICATION_COMMANDAcción

Creates a new guild-specific application command (slash, user, or message) in discord; command name must be unique per type within the guild (max 100 total commands), and client ui updates may take up to an hour.

Parámetros de entrada

namestringObligatorio
The name of the command (1-32 characters).
typenull
The type of command. Defaults to 1 (CHAT_INPUT) if not set. Other types include USER (2) and MESSAGE (3).
optionsobject[]
The parameters for the command, max 25. See Discord API documentation for `ApplicationCommandOption` structure.
guild_idstringObligatorio
The ID of the guild (server).
descriptionstring
The description of the command (1-100 characters).
dm_permissionboolean
Indicates whether the command is available in DMs with the app. Only for globally-scoped commands.
application_idstringObligatorio
The ID of the application.
name_localizationsobject
A dictionary of localizations for the command name. The keys should be valid locales, e.g. 'en-US', 'es-ES'.
description_localizationsobject
A dictionary of localizations for the command description. The keys should be valid locales, e.g. 'en-US', 'es-ES'.
default_member_permissionsinteger
A bitwise OR of permissions a member needs to use this command by default. Set to 0 to disable for everyone except administrators.

Parámetros de salida

dataobjectObligatorio
The application command object that was created.
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Create guild channelDISCORDBOT_CREATE_GUILD_CHANNELAcción

Creates a new discord channel (text, voice, category, etc.) within a guild, with options for permissions, topic, and type-specific settings.

Parámetros de entrada

namestringObligatorio
New channel name (2-100 characters).
nsfwboolean
Whether the channel is age-restricted.
typeinteger
Type of channel (e.g., 0 for GUILD_TEXT, 2 for GUILD_VOICE). See Discord API docs for all types.
topicstring
Channel topic (0-1024 characters for text; 0-120 for forum channels).
bitrateinteger
Bitrate (in bits) for voice channels (8000-96000; 8000-128000 for VIP servers).
guild_idstringObligatorio
ID of the guild (server) to create the channel in.
positioninteger
Sorting position of the channel.
parent_idstring
ID of the parent category for this channel.
rtc_regionstring
Voice region ID for voice channels (auto if not set). See Discord API docs for regions.
user_limitinteger
Maximum users in a voice channel (0-99, 0 for no limit).
available_tagsstring[]
Tag objects available in a forum channel (max 20). Each tag needs `name` and can optionally include `moderated`, `emoji_id`, `emoji_name`.
default_sort_orderinteger
Default sort order for forum posts: 0 for 'Latest Activity', 1 for 'Creation Date'.
video_quality_modeinteger
Camera video quality for voice channels: 1 for auto, 2 for 720p.
rate_limit_per_userinteger
Seconds a user must wait before sending another message (0-21600); bots and users with MANAGE_MESSAGES or MANAGE_CHANNEL permission are unaffected. Known as slowmode. For forum channels, this sets `default_thread_rate_limit_per_user`.
default_forum_layoutinteger
Default forum layout for displaying posts: 0 for 'Not Set', 1 for 'List View', 2 for 'Gallery View'.
permission_overwritesobject[]
Permission overwrite objects for the channel.
default_reaction_emojistring
Default reaction emoji for forum posts (requires `emoji_id` or `emoji_name`).
default_auto_archive_durationinteger
Default duration (minutes) for new threads to auto-archive after inactivity (60, 1440, 4320, 10080). For text/announcement channels.
default_thread_rate_limit_per_userinteger
Initial `rate_limit_per_user` for new threads in text channels (not forum channels).

Parámetros de salida

dataobjectObligatorio
The newly created channel object.
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Create guild emojiDISCORDBOT_CREATE_GUILD_EMOJIAcción

Creates a new custom emoji in a specified discord guild, requiring `create expressions` permission and adherence to guild emoji limits.

Parámetros de entrada

namestringObligatorio
The name for the new emoji. Must be between 2 and 32 characters long and can only contain alphanumeric characters and underscores.
imagestringObligatorio
The base64 encoded image data for the emoji. Must be a 128x128px GIF or PNG. For animated emojis, a GIF is required. The data must be URI encoded (e.g., 'data:image/png;base64,BASE64_ENCODED_IMAGE_DATA'). Image size should be less than 256KB.
rolesnull[]
An array of role IDs (strings) to which this emoji will be restricted. If omitted, `None`, or an empty list, the emoji is available to @everyone. Note: Despite the type hint, this field expects a list of string role IDs if provided.
guild_idstringObligatorio
The ID of the Discord guild (server) where the emoji will be created.

Parámetros de salida

dataobjectObligatorio
Contains the full emoji object for the newly created emoji, as defined by Discord's API.
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Post guild template by codeDISCORDBOT_CREATE_GUILD_FROM_TEMPLATEAcción

Creates a new discord guild by applying channels, roles, and settings from a specified, valid, and accessible guild template code.

Parámetros de entrada

codestringObligatorio
The unique code of the guild template to use.
iconstring
Data URI scheme (e.g., `data:image/png;base64,...` or `data:image/jpeg;base64,...`) for the guild's 128x128 icon.
namestringObligatorio
Name for the new guild (must be between 2 and 100 characters).

Parámetros de salida

dataobjectObligatorio
The newly created guild object, detailing its structure, channels, roles, and settings.
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Create role with guild idDISCORDBOT_CREATE_GUILD_ROLEAcción

Creates a new role in a discord guild with customizable name, permissions, color, hoist, mentionability, and icon; `icon` (custom image hash) and `unicode emoji` (standard emoji) are mutually exclusive.

Parámetros de entrada

iconstring
Hash of a custom image for the role's icon (e.g., from a previous Discord upload). Use `unicode_emoji` for standard emojis.
namestring
Name for the new role. If omitted, Discord defaults to 'new role'.
colorinteger
RGB color value for the role (e.g., red is `16711680`). Defaults to `0` (no color) if omitted.
hoistboolean
If `True`, displays the role separately in the user list. Defaults to `False` if omitted.
guild_idstringObligatorio
ID of the Discord guild (server) where the role will be created.
mentionableboolean
If `True`, this role can be mentioned by others. Defaults to `False` if omitted.
permissionsinteger
Bitwise integer for role permissions, combined from [Discord permission flags](https://discord.com/developers/docs/topics/permissions#permissions-bitwise-permission-flags) (e.g., 'Manage Channels' 0x4 + 'Kick Members' 0x2 = 6). Default permissions may apply if omitted.
unicode_emojistring
Standard Unicode emoji for the role's icon (e.g., '🎉'). Use `icon` for custom image hashes.

Parámetros de salida

dataobjectObligatorio
A [Discord Role object](https://discord.com/developers/docs/topics/permissions#role-object) containing the details of the newly created role.
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Create guild scheduled eventDISCORDBOT_CREATE_GUILD_SCHEDULED_EVENTAcción

Creates a new scheduled event in a discord guild; a separate json request body (not defined in this action's request schema model) with event details (e.g., name, type, schedule) is required, and its specific fields depend on the event's `entity type`.

Parámetros de entrada

guild_idstringObligatorio
The unique identifier of the Discord guild where the event will be created. This ID is used as a path parameter in the API request URL.

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Create guild stickerDISCORDBOT_CREATE_GUILD_STICKERAcción

Uploads a png, apng, or lottie json file (max 512kb) as a new custom sticker to the specified discord guild; requires 'manage expressions' permissions and sufficient server boost level for sticker slots.

Parámetros de entrada

filestring
Sticker file to upload (PNG, APNG, Lottie JSON; max 512KB; 320x320px recommended). Content is used as file part in multipart/form-data.
namestring
Name of the sticker (2-30 characters).
tagsstring
Autocomplete suggestion tags (comma-separated, max 200 characters) for the sticker; corresponds to the Discord emoji name.
guild_idstringObligatorio
ID of the guild to create the sticker for.
descriptionstring
Description for the sticker (empty or 2-100 characters).

Parámetros de salida

dataobjectObligatorio
The newly created sticker object.
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Create guild templateDISCORDBOT_CREATE_GUILD_TEMPLATEAcción

Creates a template of an existing discord guild's structure (settings, roles, channels) but not its content (e.g., messages, members).

Parámetros de entrada

namestringObligatorio
Name for the new guild template (1-100 characters).
guild_idstringObligatorio
ID of the existing guild from which to create the template.
descriptionstring
Optional description for the guild template (0-120 characters).

Parámetros de salida

dataobjectObligatorio
The created guild template object.
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Post interaction callbackDISCORDBOT_CREATE_INTERACTION_RESPONSEAcción

Sends a response to a discord interaction (e.g., slash command, component); ensure response type is context-appropriate and initial reply is within 3 seconds.

Parámetros de entrada

interaction_idstringObligatorio
ID of the originating user interaction (e.g., slash command, button, or other component).
interaction_tokenstringObligatorio
Temporary, single-use token for responding to the interaction, valid for 15 minutes from the initial interaction event.

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Post message to channelDISCORDBOT_CREATE_MESSAGEAcción

Sends a message to a specified discord channel (text, embeds, stickers, components, attachments); requires `send messages` permission and one of `content`, `embeds`, `sticker ids`, or `attachments`.

Parámetros de entrada

ttsboolean
Send as a text-to-speech (TTS) message. Use sparingly.
flagsinteger
Bitwise value for message flags (e.g., 4 for `SUPPRESS_EMBEDS`, 64 for `EPHEMERAL` making message visible only to invoker).
nonceinteger
Unique integer (0 to 2^53-1) to confirm message sending and prevent duplicates.
embedsobject[]
Up to 10 embed objects. Combined character count across all embed attributes must not exceed 6000.
contentstring
Message text (max 2000 chars). Required if `embeds`, `sticker_ids`, `components`, or `attachments` are empty.
channel_idstringObligatorio
ID of the target channel.
componentsobject[]
Message components (e.g., buttons, select menus), up to 5 action rows. See Discord API docs for structure.
attachmentsobject[]
Attachment objects describing files for the message. Requires `multipart/form-data` request.
sticker_idsstring[]
Up to 3 IDs of stickers accessible to the bot.
allowed_mentionsnull
Controls which mentions in `content` ping recipients. See Discord API docs for structure if customizing.
message_referencenull
For replying to an existing message. Requires `message_id`. See Discord API docs for full structure (includes `channel_id`, `guild_id`, `fail_if_not_exists`).

Parámetros de salida

dataobjectObligatorio
The created Discord message object.
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Create stage instanceDISCORDBOT_CREATE_STAGE_INSTANCEAcción

Creates a new stage instance in a specified stage channel for live audio events; requires `manage channels`, `mute members`, and `move members` permissions in the channel.

Parámetros de entrada

topicstringObligatorio
The topic for the Stage instance. Must be between 1 and 120 characters.
channel_idstringObligatoriosnowflake
The unique ID of the Stage channel where the Stage instance will be created.
privacy_levelnull
The privacy level of the Stage instance. Provide `None` for the Discord API's default (GUILD_ONLY, value `2`); Discord also supports `1` (PUBLIC, deprecated).
send_start_notificationboolean
Specifies if a notification should be sent to @everyone when the Stage instance starts. `True` to send, `False` to not send. If `None` or omitted, the API typically defaults to `false`.
guild_scheduled_event_idnull
The ID of the Guild Scheduled Event to associate with this Stage instance, or `None` if no event is associated. The actual ID for an event is a snowflake string.

Parámetros de salida

dataobjectObligatorio
Contains the details of the newly created Stage instance.
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Create new thread in channelDISCORDBOT_CREATE_THREADAcción

Creates a new thread in a text or announcement discord channel; requires a 'name' and optionally other details (e.g., 'auto archive duration', an initial 'message') in the request body.

Parámetros de entrada

channel_idstringObligatorio
The ID of the Discord channel in which the new thread will be created.

Parámetros de salida

dataobjectObligatorio
The full Discord channel object representing the newly created thread.
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Create thread in message channelDISCORDBOT_CREATE_THREAD_FROM_MESSAGEAcción

Creates a new thread from a specific message in a discord channel, requiring `create public threads` permission (and `send messages` if in a forum/media channel).

Parámetros de entrada

namestringObligatorio
The name for the new thread (1-100 characters).
channel_idstringObligatorio
The ID of the channel where the message exists and the new thread will be created.
message_idstringObligatorio
The ID of the message from which to create the new thread.
rate_limit_per_userinteger
Amount of seconds a user must wait before sending another message in the thread (0-21600). Bots and users with `MANAGE_MESSAGES` or `MANAGE_CHANNELS` permissions are exempt. If omitted, no user-specific rate limit is applied beyond channel defaults.
auto_archive_durationnull
Duration in minutes after which the thread automatically archives due to inactivity. Accepted values: 60 (1 hour), 1440 (1 day), 4320 (3 days), 10080 (7 days). If omitted, it defaults to the channel's settings.

Parámetros de salida

dataobjectObligatorio
A channel object representing the newly created thread.
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Create channel webhookDISCORDBOT_CREATE_WEBHOOKAcción

Creates a webhook in a specified discord channel for external applications to post messages, provided the caller has 'manage webhooks' permission in that channel.

Parámetros de entrada

namestringObligatorio
Name for the webhook (1-80 characters).
avatarstring
Base64 encoded image data string for the webhook's avatar (e.g., 'data:image/jpeg;base64,...').
channel_idstringObligatorio
ID of the channel to create the webhook in.

Parámetros de salida

dataobjectObligatorio
Newly created webhook object.
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Crosspost channel messageDISCORDBOT_CROSSPOST_MESSAGEAcción

Crossposts a message from an announcement channel to all following channels, provided the message has not been previously crossposted and is not a system message or a message sent by a webhook.

Parámetros de entrada

channel_idstringObligatorio
The unique identifier of the announcement channel (News Channel) containing the message to be crossposted.
message_idstringObligatorio
The unique identifier of the message within the specified announcement channel that is to be crossposted.

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Delete reaction from messageDISCORDBOT_DELETE_ALL_MESSAGE_REACTIONSAcción

Deletes all reactions (not just the bot's) from a message in a channel; requires 'manage messages' permission.

Parámetros de entrada

channel_idstringObligatorio
ID of the channel where the message is located.
message_idstringObligatorio
ID of the message from which to remove all reactions.

Parámetros de salida

dataobjectObligatorio
API response data; typically empty for successful deletion (204 No Content).
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Delete channel message reaction by emojiDISCORDBOT_DELETE_ALL_MESSAGE_REACTIONS_BY_EMOJIAcción

Removes all reactions for a specific emoji from a message in a discord channel; requires 'manage messages' permission and this operation is irreversible.

Parámetros de entrada

channel_idstringObligatorio
The unique identifier of the Discord channel containing the message.
emoji_namestringObligatorio
The emoji for which all reactions should be removed. For standard Unicode emojis, provide the URL-encoded emoji character (e.g., `%F0%9F%91%8D` for 👍). For custom server emojis, use the format `name:id` (e.g., `myemote:123456789012345678`).
message_idstringObligatorio
The unique identifier of the message from which all reactions for the specified emoji will be removed.

Parámetros de salida

dataobjectObligatorio
The response from the Discord API. On a successful deletion (HTTP 204 No Content), this dictionary will typically be empty. It may contain details if an error occurs.
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Delete application commandDISCORDBOT_DELETE_APPLICATION_COMMANDAcción

Permanently deletes a specific application command; this action is irreversible.

Parámetros de entrada

command_idstringObligatorio
The unique identifier of the command to be deleted.
application_idstringObligatorio
The unique identifier of the Discord application.

Parámetros de salida

dataobjectObligatorio
An empty dictionary indicating a successful deletion.
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Delete guild auto moderation ruleDISCORDBOT_DELETE_AUTO_MODERATION_RULEAcción

Deletes a specific auto-moderation rule from a discord guild.

Parámetros de entrada

rule_idstringObligatorio
The unique identifier of the auto-moderation rule to be deleted.
guild_idstringObligatorio
The unique identifier of the Discord guild (server) where the auto-moderation rule is located.

Parámetros de salida

dataobjectObligatorio
Response data from the Discord API; typically empty or a minimal confirmation for successful deletion.
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Delete channel by idDISCORDBOT_DELETE_CHANNELAcción

Permanently deletes a discord channel by its id; this action is irreversible and the channel must exist and be deletable.

Parámetros de entrada

channel_idstringObligatorio
The unique identifier of the Discord channel to be deleted.

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Delete channel permission overrideDISCORDBOT_DELETE_CHANNEL_PERMISSION_OVERWRITEAcción

Deletes a specific user's or role's permission overwrite in a discord channel, reverting their permissions to default; this action is irreversible.

Parámetros de entrada

channel_idstringObligatorio
ID of the Discord channel from which the permission overwrite will be removed.
overwrite_idstringObligatorio
ID of the permission overwrite (typically a user or role ID) to be deleted.

Parámetros de salida

dataobjectObligatorio
The response data. For a successful deletion where the Discord API returns a 204 No Content status, this field is typically an empty dictionary.
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Delete channel recipientDISCORDBOT_DELETE_GROUP_DM_USERAcción

Permanently removes a user from an accessible discord group dm channel, revoking their access.

Parámetros de entrada

user_idstringObligatorio
The unique identifier of the user to be removed from the group DM channel.
channel_idstringObligatorio
The unique identifier of the group DM channel from which the user will be removed.

Parámetros de salida

dataobjectObligatorio
An empty dictionary is typically returned upon successful removal of the user, consistent with a 204 No Content HTTP status from the Discord API.
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Delete guild by idDISCORDBOT_DELETE_GUILDAcción

Permanently deletes a specified discord guild (server); the authenticated user must be the owner of the guild.

Parámetros de entrada

guild_idstringObligatorio
The unique identifier of the Discord guild (server) to be deleted. This ID can be obtained through other API endpoints or by enabling Developer Mode in Discord user settings.

Parámetros de salida

dataobjectObligatorio
A dictionary that may contain data related to the deletion. For a successful guild deletion, Discord's API typically returns a 204 No Content status, meaning this field would often be empty or not applicable if the response body is indeed empty.
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Delete guild commandDISCORDBOT_DELETE_GUILD_APPLICATION_COMMANDAcción

Permanently deletes a specific application command (e.g., slash, user, or message) for an application from a discord guild, used to remove outdated or unnecessary commands.

Parámetros de entrada

guild_idstringObligatorio
The unique ID of the guild (server) from which the command is to be deleted.
command_idstringObligatorio
The unique ID of the command to be deleted.
application_idstringObligatorio
The unique ID of the application whose command is to be deleted.

Parámetros de salida

dataobjectObligatorio
A dictionary containing the response data. On successful deletion, this is typically an empty dictionary as the Discord API returns a 204 No Content status. If an error occurs, this dictionary may contain error details.
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Delete guild emoji by idDISCORDBOT_DELETE_GUILD_EMOJIAcción

Permanently deletes a specified custom emoji from a guild, requiring 'manage expressions' permissions; cannot delete default emojis and is irreversible.

Parámetros de entrada

emoji_idstringObligatorio
The unique identifier of the custom emoji to be deleted from the guild.
guild_idstringObligatorio
The unique identifier of the Discord guild (server) from which the emoji will be deleted.

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Delete guild integrationDISCORDBOT_DELETE_GUILD_INTEGRATIONAcción

Permanently deletes a specific, unwanted or problematic integration from a discord guild; requires 'manage server' or 'administrator' permissions.

Parámetros de entrada

guild_idstringObligatorio
The unique identifier of the Discord guild (server) from which the integration will be deleted.
integration_idstringObligatorio
The unique identifier of the integration to be deleted from the guild.

Parámetros de salida

dataobjectObligatorio
Contains error data or unexpected response details; empty on successful deletion (204 No Content).
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Delete guild member by idDISCORDBOT_DELETE_GUILD_MEMBERAcción

Removes (kicks) a member from a discord guild; the user must be an existing member of the specified guild, and this action is permanent.

Parámetros de entrada

user_idstringObligatorio
The unique identifier of the user to be removed from the guild.
guild_idstringObligatorio
The unique identifier of the Discord guild (server) from which the member will be removed.

Parámetros de salida

dataobjectObligatorio
Response data; typically an empty dictionary for a successful removal (204 No Content), or contains error details.
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Delete guild member roleDISCORDBOT_DELETE_GUILD_MEMBER_ROLEAcción

Removes a specified role from a member of a discord guild, provided the member currently possesses that role.

Parámetros de entrada

role_idstringObligatorio
The unique identifier of the role to be removed from the specified guild member.
user_idstringObligatorio
The unique identifier of the user (member) whose role is to be removed from the guild.
guild_idstringObligatorio
The unique identifier of the Discord guild (server) from which the member's role will be removed.

Parámetros de salida

dataobjectObligatorio
An empty dictionary, as this operation typically returns a 204 No Content status upon successful execution, indicating no response body.
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Delete role from guildDISCORDBOT_DELETE_GUILD_ROLEAcción

Permanently deletes a specified role from a discord guild, revoking it from all members; requires 'manage roles' permission and the target role must be lower in hierarchy than the bot's highest role.

Parámetros de entrada

role_idstringObligatorio
Identifier of the role to be deleted from the specified guild.
guild_idstringObligatorio
Identifier of the Discord guild (server) from which the role is to be deleted.

Parámetros de salida

dataobjectObligatorio
Response data from the Discord API; typically empty for successful deletions (HTTP 204 No Content).
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Delete guild scheduled eventDISCORDBOT_DELETE_GUILD_SCHEDULED_EVENTAcción

Permanently deletes a specific scheduled event from a discord guild; this action is irreversible.

Parámetros de entrada

guild_idstringObligatorio
ID of the Discord guild from which the event will be deleted.
guild_scheduled_event_idstringObligatorio
ID of the guild's scheduled event to delete.

Parámetros de salida

dataobjectObligatorio
Response data. Typically empty for a successful deletion (HTTP 204 No Content) as Discord API returns no body content for this case.
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Delete guild stickerDISCORDBOT_DELETE_GUILD_STICKERAcción

Permanently deletes a custom sticker from a discord guild; the specified guild and sticker must exist, and this action is irreversible.

Parámetros de entrada

guild_idstringObligatorio
Unique identifier of the Discord guild from which the sticker will be deleted.
sticker_idstringObligatorio
The unique identifier of the sticker to be deleted.

Parámetros de salida

dataobjectObligatorio
Typically empty for successful deletions (HTTP 204); may contain error details on failure.
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Delete guild template by codeDISCORDBOT_DELETE_GUILD_TEMPLATEAcción

Deletes an existing guild template by its unique code from a specified guild, returning the deleted template's details.

Parámetros de entrada

codestringObligatorio
The unique code of the guild template to be deleted.
guild_idstringObligatorio
The ID of the guild (server) from which the template will be deleted.

Parámetros de salida

dataobjectObligatorio
The guild template object that was deleted.
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Delete channel messageDISCORDBOT_DELETE_MESSAGEAcción

Permanently and irreversibly deletes a message from a specified discord channel.

Parámetros de entrada

channel_idstringObligatorio
ID of the Discord channel.
message_idstringObligatorio
ID of the message to delete.

Parámetros de salida

dataobjectObligatorio
Response data; typically empty for a successful deletion (HTTP 204 No Content).
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Delete user reaction on messageDISCORDBOT_DELETE_MY_MESSAGE_REACTIONAcción

Removes the authenticated user's own emoji reaction, which they must have previously added, from a specific message in a discord channel; this action is irreversible and cannot remove others' reactions.

Parámetros de entrada

channel_idstringObligatorio
Identifier of the Discord channel containing the message.
emoji_namestringObligatorio
The specific emoji reaction to remove. Use the emoji character for standard Unicode emojis (e.g., '👍') or 'name:id' for custom emojis (e.g., 'mycustomemoji:123456789012345678').
message_idstringObligatorio
Identifier of the message from which to remove the authenticated user's reaction.

Parámetros de salida

dataobjectObligatorio
A dictionary containing the API response. For this operation, a successful deletion typically results in an HTTP 204 No Content response, in which case this dictionary will be empty.
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Delete original webhook messageDISCORDBOT_DELETE_ORIGINAL_WEBHOOK_MESSAGEAcción

Permanently deletes an existing original message posted by a webhook (using its id and token), optionally within a specific thread.

Parámetros de entrada

thread_idstring
ID of the thread where the original webhook message is located; provide only if the message is within that thread.
webhook_idstringObligatorio
Unique identifier of the webhook that posted the original message.
webhook_tokenstringObligatorio
Secure token for the webhook, used for authenticating its actions.

Parámetros de salida

dataobjectObligatorio
API response data; this may be an empty dictionary on successful deletion (HTTP 204 No Content).
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Delete stage instance by channel idDISCORDBOT_DELETE_STAGE_INSTANCEAcción

Deletes the stage instance for the given `channel id`, permanently ending its live audio event.

Parámetros de entrada

channel_idstringObligatorio
The ID of the Stage channel from which to delete the instance.

Parámetros de salida

dataobject
An empty dictionary or a success indicator. The Discord API usually returns no content (HTTP 204) upon successful deletion of a stage instance.
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Delete channel thread memberDISCORDBOT_DELETE_THREAD_MEMBERAcción

Removes a user from a specified, unarchived thread in a discord channel.

Parámetros de entrada

user_idstringObligatorio
The ID of the user to remove from the thread. The special value '@me' can be used to target the current user (e.g., the bot itself leaving the thread).
channel_idstringObligatorio
The ID of the thread from which the user will be removed.

Parámetros de salida

dataobjectObligatorio
A dictionary that is typically empty, as this action returns a 204 No Content response upon successful removal of the thread member.
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Delete user reaction from messageDISCORDBOT_DELETE_USER_MESSAGE_REACTIONAcción

Removes a specific user's emoji reaction from a message; requires 'manage messages' permission if deleting reactions from other users.

Parámetros de entrada

user_idstringObligatorio
The ID of the user whose reaction should be removed. Use '@me' to remove the current user's reaction.
channel_idstringObligatorio
The ID of the channel where the message is located.
emoji_namestringObligatorio
The name or ID of the emoji to remove. For standard Unicode emojis, use the emoji character (e.g., 👍). For custom emojis, use the format `name:id` (e.g., `customemoji:876543210987654321`).
message_idstringObligatorio
The ID of the message from which to remove the reaction.

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Delete webhook by idDISCORDBOT_DELETE_WEBHOOKAcción

Permanently deletes a specified, existing discord webhook by its unique id; this action is irreversible.

Parámetros de entrada

webhook_idstringObligatorio
The unique identifier of the Discord webhook to be deleted.

Parámetros de salida

dataobjectObligatorio
The response data from the Discord API. For a successful deletion (HTTP 204 No Content), this field is typically empty as no content body is returned.
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Delete webhook using id and tokenDISCORDBOT_DELETE_WEBHOOK_BY_TOKENAcción

Permanently deletes a discord webhook specified by its id and token; this action is irreversible.

Parámetros de entrada

webhook_idstringObligatorio
The ID of the webhook to delete.
webhook_tokenstringObligatorio
The token of the webhook to delete.

Parámetros de salida

dataobjectObligatorio
An empty dictionary on successful deletion (HTTP 204 No Content).
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Delete webhook messageDISCORDBOT_DELETE_WEBHOOK_MESSAGEAcción

Deletes a message previously sent by the specified webhook, optionally within a specific thread.

Parámetros de entrada

thread_idstring
ID of the thread the message is in (optional).
message_idstringObligatorio
The ID of the message to be deleted.
webhook_idstringObligatorio
The ID of the webhook.
webhook_tokenstringObligatorio
The token of the webhook.

Parámetros de salida

dataobjectObligatorio
A dictionary containing the response data. Upon successful deletion (HTTP 204 No Content), this field is typically empty. In case of an error, it may contain error details.
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Github action webhooks processingDISCORDBOT_EXECUTE_GITHUB_COMPATIBLE_WEBHOOKAcción

Forwards github event notifications to a discord channel via a webhook configured for github-formatted payloads (url ending in `/github`).

Parámetros de entrada

refstring
Git reference involved in the event (e.g., 'refs/heads/main', 'refs/tags/v1.0.0').
waitboolean
Waits for message confirmation before responding if true; otherwise, responds immediately.
issuenull
GitHub issue object; must be `null` if included, as complex objects are stubbed in this schema.
actionstring
Type of action that triggered the GitHub event (e.g., 'opened', 'created').
answernull
Answer within a GitHub Discussion; must be `null` if included, as complex objects are stubbed in this schema.
forcedboolean
Indicates if a Git push was a force push.
forkeenull
Forkee (new repository) in a GitHub 'fork' event; must be `null` if included, as complex objects are stubbed in this schema.
membernull
GitHub member object; must be `null` if included, as complex objects are stubbed in this schema.
reviewnull
GitHub pull request review object; must be `null` if included, as complex objects are stubbed in this schema.
commentnull
GitHub comment object; must be `null` if included, as complex objects are stubbed in this schema.
commitsobject[]
List of commit details, primarily for 'push' events.
comparestringuri
URL to view the comparison of changes, typically for a 'push' event.
releasenull
GitHub release object; must be `null` if included, as complex objects are stubbed in this schema.
ref_typestring
Type of the Git reference in 'ref' (e.g., 'branch', 'tag').
check_runnull
GitHub Check Run object; must be `null` if included, as complex objects are stubbed in this schema.
thread_idstring
ID of the target Discord thread for the message; if unspecified, posts to the main channel.
discussionnull
GitHub Discussion object; must be `null` if included, as complex objects are stubbed in this schema.
repositorynull
GitHub repository object; must be `null` if included, as complex objects are stubbed in this schema.
sender__idinteger
Numeric ID of the GitHub user/application that triggered the event.
webhook_idstringObligatorio
ID of the Discord webhook.
check_suitenull
GitHub Check Suite object; must be `null` if included, as complex objects are stubbed in this schema.
head_commitnull
Head commit object in a GitHub 'push' event; must be `null` if included, as complex objects are stubbed in this schema.
pull_requestnull
GitHub pull request object; must be `null` if included, as complex objects are stubbed in this schema.
sender__loginstring
GitHub username (login) of the user/application that triggered the event.
webhook_tokenstringObligatorio
Token for the Discord webhook.
sender__html__urlstringuri
URL to the GitHub profile of the event sender.
sender__avatar__urlstringuri
URL of the event sender's GitHub avatar.

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Post to slack webhookDISCORDBOT_EXECUTE_SLACK_COMPATIBLE_WEBHOOKAcción

Sends richly formatted messages to discord via its slack-compatible webhook endpoint; requires at least one of `text` or `attachments` and adherence to content limits.

Parámetros de entrada

textstring
The main message content, up to 2000 characters. Supports Slack's `mrkdwn` formatting (e.g., `*bold*`, `_italic_`, `~strike~`, code, `>quote`). At least one of `text`, `attachments`, or `embeds` (via attachments) is required.
waitboolean
If true, the endpoint will wait for server confirmation of message send before responding and will return the created message object. Defaults to false.
icon_urlstringuri
If provided, this URL will be used for the avatar icon, overriding the default webhook icon. Must be a valid image URL.
usernamestring
If provided, this username will override the default username associated with the webhook. Limited to 80 characters.
thread_idstring
The ID of the target thread within the channel to send the message to. If not provided, the message is sent to the main channel.
webhook_idstringObligatorio
The unique identifier for the Discord webhook. This is part of the webhook URL.
attachmentsobject[]
An array of up to 10 attachment objects that provide rich formatting options for the message, similar to Slack attachments. At least one of `text`, `attachments`, or `embeds` (via attachments) is required.
webhook_tokenstringObligatorio
The secret token for the Discord webhook. This is part of the webhook URL.

Parámetros de salida

datastringObligatorio
The raw string content of the response from the webhook execution. If the `wait` parameter in the request was true, this field typically contains the created message object as a JSON string. If `wait` was false or not provided, this field may be null or represent a simple success indicator (e.g., 'ok').
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Post webhook with embeds and componentsDISCORDBOT_EXECUTE_WEBHOOKAcción

Executes a discord webhook to send messages, embeds, or interactive components to a specific discord channel or thread.

Parámetros de entrada

waitboolean
If true, waits for Discord to confirm message delivery before responding (response includes message object); if false or omitted, responds immediately.
thread_idstring
ID of the thread in the webhook's channel to send the message to; if omitted, sends to the main channel.
webhook_idstringObligatorio
Unique ID of the Discord webhook.
webhook_tokenstringObligatorio
Secret token for the Discord webhook.

Parámetros de salida

dataobjectObligatorio
Discord API response data. Contains the message object if 'wait' was true and the request succeeded. If 'wait' was false, this may be empty (expect 204 No Content on success).
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Add follower to channel via webhookDISCORDBOT_FOLLOW_CHANNELAcción

Follows a specified announcement channel (`channel id`), relaying its messages to `webhook channel id` in the current server; requires 'manage webhooks' permission in the current server and that it has community features enabled.

Parámetros de entrada

channel_idstringObligatorio
The ID of the Announcement Channel to follow (the source channel).
webhook_channel_idstringObligatoriosnowflake
The ID of the channel in the current server where messages from the followed channel will be posted. A webhook will be created in this channel (the destination channel).

Parámetros de salida

dataobjectObligatorio
Contains the IDs of the followed Announcement Channel and the webhook created for it.
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

List active threads in guildDISCORDBOT_GET_ACTIVE_GUILD_THREADSAcción

Retrieves all currently active and visible threads within a specified discord guild, excluding archived or hidden threads.

Parámetros de entrada

guild_idstringObligatorio
Guild Id

Parámetros de salida

dataobjectObligatorio
Active threads and their members from the guild.
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Retrieve application detailsDISCORDBOT_GET_APPLICATIONAcción

Retrieves the full details of a discord application using its unique `application id`.

Parámetros de entrada

application_idstringObligatorio
The unique snowflake ID of the Discord application.

Parámetros de salida

dataobjectObligatorio
The full Discord application object containing its detailed properties.
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Fetch application command by idDISCORDBOT_GET_APPLICATION_COMMANDAcción

Fetches the details of a specific, existing application command, identified by its application snowflake id and command snowflake id.

Parámetros de entrada

command_idstringObligatorio
The unique identifier of the command.
application_idstringObligatorio
The unique identifier of the Discord application.

Parámetros de salida

dataobjectObligatorio
The application command object for the requested command ID.
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Retrieve application role metadataDISCORDBOT_GET_APPLICATION_ROLE_CONNECTIONS_METADATAAcción

Retrieves all role connection metadata records for a given discord application id; an empty list is returned if none are configured.

Parámetros de entrada

application_idstringObligatorio
The unique identifier of the Discord application for which to fetch role connection metadata.

Parámetros de salida

dataobject[]Obligatorio
List of application role connection metadata objects, defining criteria that can be set for users.
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get user role connectionDISCORDBOT_GET_APPLICATION_USER_ROLE_CONNECTIONAcción

Fetches the role connection object for the current user for a specified discord application.

Parámetros de entrada

application_idstringObligatorio
The unique ID of the Discord application for which the user's role connection information is being requested.

Parámetros de salida

dataobjectObligatorio
The role connection object for the user and the specified application.
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Retrieve auto moderation ruleDISCORDBOT_GET_AUTO_MODERATION_RULEAcción

Retrieves the complete configuration details of a specific auto-moderation rule within a discord guild for inspection or verification.

Parámetros de entrada

rule_idstringObligatorio
The unique identifier of the auto-moderation rule to retrieve.
guild_idstringObligatorio
The unique identifier of the Discord guild (server).

Parámetros de salida

dataobjectObligatorio
A dictionary representing the auto-moderation rule object. This includes properties such as 'id', 'guild_id', 'name', 'creator_id', 'event_type', 'trigger_type', 'trigger_metadata', 'actions', 'enabled', 'exempt_roles', and 'exempt_channels'.
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Retrieve bot gatewayDISCORDBOT_GET_BOT_GATEWAYAcción

Retrieves the wss url, recommended shard count, and session start limits, which are prerequisite for a bot to connect to the discord gateway and receive events.

Parámetros de entrada

Sin parámetros.

Parámetros de salida

dataobjectObligatorio
Contains the Gateway WSS URL, recommended shard count, and session start limit details.
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Retrieve channel detailsDISCORDBOT_GET_CHANNELAcción

Retrieves detailed metadata for a specific discord channel using its `channel id`, which must be a valid and accessible channel id; note that this action returns only channel metadata, not message content or member lists.

Parámetros de entrada

channel_idstringObligatorio
The ID of the Discord channel.

Parámetros de salida

dataobjectObligatorio
A dictionary containing attributes and detailed information of the Discord channel.
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get gateway detailsDISCORDBOT_GET_GATEWAYAcción

Retrieves the websocket url to connect to discord's gateway for receiving real-time events.

Parámetros de entrada

Sin parámetros.

Parámetros de salida

dataobjectObligatorio
Gateway connection details, including the WebSocket URL.
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Retrieve guild detailsDISCORDBOT_GET_GUILDAcción

Retrieves detailed information for a specified discord guild (server) by its `guild id`, optionally including approximate member and presence counts if `with counts` is true.

Parámetros de entrada

guild_idstringObligatorio
The unique identifier (ID) of the Discord guild (server) to retrieve.
with_countsboolean
When true, includes approximate member and presence counts for the guild.

Parámetros de salida

dataobjectObligatorio
A Guild object containing the detailed information about the retrieved guild.
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Fetch guild application command by idDISCORDBOT_GET_GUILD_APPLICATION_COMMANDAcción

Fetches detailed information for a specific application command within a discord guild, identified by `application id`, `guild id`, and `command id`.

Parámetros de entrada

guild_idstringObligatorio
The unique identifier of the Discord guild (server).
command_idstringObligatorio
The unique identifier of the application command to retrieve.
application_idstringObligatorio
The unique identifier of the Discord application.

Parámetros de salida

dataobjectObligatorio
Contains the detailed structure and properties of the fetched application command.
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Retrieve guild command permissionsDISCORDBOT_GET_GUILD_APPLICATION_COMMAND_PERMISSIONSAcción

Fetches the permissions for a specific application command within a guild, used to inspect its current access settings.

Parámetros de entrada

guild_idstringObligatorio
The unique identifier of the guild (server).
command_idstringObligatorio
The unique identifier of the command.
application_idstringObligatorio
The unique identifier of the application.

Parámetros de salida

dataobjectObligatorio
An object containing the permissions for the specified command in the guild.
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Retrieve guild user ban detailsDISCORDBOT_GET_GUILD_BANAcción

Fetches the ban details for a specific user in a discord guild, if that user is currently banned.

Parámetros de entrada

user_idstringObligatorio
Unique ID of the user.
guild_idstringObligatorio
Unique ID of the Discord guild (server).

Parámetros de salida

dataobjectObligatorio
The fetched ban details.
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Fetch emoji by guild and idDISCORDBOT_GET_GUILD_EMOJIAcción

Retrieves details for a specific custom emoji within a specified discord guild, requiring valid and accessible guild and emoji ids.

Parámetros de entrada

emoji_idstringObligatorio
Unique identifier of the custom emoji to retrieve.
guild_idstringObligatorio
Unique identifier of the Discord guild (server) from which to fetch the emoji.

Parámetros de salida

dataobjectObligatorio
Detailed information of the fetched guild emoji.
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Retrieve guild member by user idDISCORDBOT_GET_GUILD_MEMBERAcción

Retrieves detailed information for a specific member of a discord guild, provided the bot belongs to the guild and has necessary permissions (e.g., guild members intent).

Parámetros de entrada

user_idstringObligatorio
The unique identifier of the Discord user whose guild member information is to be retrieved.
guild_idstringObligatorio
The unique identifier of the Discord guild (server) from which to fetch the member.

Parámetros de salida

dataobjectObligatorio
The guild member object containing their detailed information.
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Retrieve guild new member welcomeDISCORDBOT_GET_GUILD_NEW_MEMBER_WELCOMEAcción

Retrieves the configured new member welcome screen for a discord guild, detailing the welcome message, suggested member actions, and resource channels.

Parámetros de entrada

guild_idstringObligatorio
The unique identifier of the Discord guild (server).

Parámetros de salida

dataobjectObligatorio
The detailed configuration of the new member welcome screen for the specified guild.
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Preview guild by idDISCORDBOT_GET_GUILD_PREVIEWAcción

Fetches a public preview of a discord guild by its id, if the guild has the preview feature enabled.

Parámetros de entrada

guild_idstringObligatorio
The unique identifier of the Discord guild (server) to preview.

Parámetros de salida

dataobjectObligatorio
The guild preview information, including public details like name, icon, description, and approximate member counts.
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get guild scheduled event by idDISCORDBOT_GET_GUILD_SCHEDULED_EVENTAcción

Retrieves a specific scheduled event from a discord guild by its id, optionally including the count of subscribed users.

Parámetros de entrada

guild_idstringObligatorio
ID of the Discord guild (server) containing the event.
with_user_countboolean
If true, includes `user_count` (number of subscribed users) in the event data.
guild_scheduled_event_idstringObligatorio
ID of the scheduled event to retrieve.

Parámetros de salida

dataobjectObligatorio
The Guild Scheduled Event object. Refer to Discord API documentation for detailed structure.
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get guild onboarding by idDISCORDBOT_GET_GUILDS_ONBOARDINGAcción

Retrieves the onboarding settings for a specified discord guild, including prompts, options, default channels, and enabled status, to examine its new member guidance process when the guild id is known and accessible.

Parámetros de entrada

guild_idstringObligatorio
The unique identifier of the Discord guild (server) for which to retrieve onboarding information.

Parámetros de salida

dataobjectObligatorio
The guild's onboarding configuration, structured according to the 'Model' schema.
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Retrieve sticker from guildDISCORDBOT_GET_GUILD_STICKERAcción

Retrieves a specific sticker from a discord guild using the guild and sticker ids; requires the sticker to exist in the guild.

Parámetros de entrada

guild_idstringObligatorio
The snowflake ID of the Discord guild (server) from which to retrieve the sticker.
sticker_idstringObligatorio
The snowflake ID of the sticker to retrieve.

Parámetros de salida

dataobjectObligatorio
The retrieved Discord sticker object.
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Retrieve guild template with codeDISCORDBOT_GET_GUILD_TEMPLATEAcción

Retrieves the complete structure and details of a discord guild template using its unique code; the code must be valid and refer to an existing, accessible template.

Parámetros de entrada

codestringObligatorio
The unique code of the guild template.

Parámetros de salida

dataobjectObligatorio
Detailed information of the fetched guild template.
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Retrieve guild vanity urlDISCORDBOT_GET_GUILD_VANITY_URLAcción

Fetches the vanity url, including the invite `code` and its `uses` count, for a given discord `guild id`, which must correspond to an existing guild.

Parámetros de entrada

guild_idstringObligatorio
The unique identifier of the Discord guild (server) for which to retrieve the vanity URL.

Parámetros de salida

dataobjectObligatorio
The vanity URL details for the guild. Includes the invite `code` (which may be `null` if no vanity URL is set), the number of `uses`, and an optional `error` object if issues were encountered specific to the vanity URL.
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Retrieve guild webhooksDISCORDBOT_GET_GUILD_WEBHOOKSAcción

Retrieves all webhook objects for a specified discord guild; requires 'manage webhooks' permission for the authenticated entity.

Parámetros de entrada

guild_idstringObligatorio
The unique identifier (Snowflake ID) of the Discord guild (server) for which to retrieve webhooks.

Parámetros de salida

dataarrayObligatorio
A list of webhook objects. Each object details a webhook in the guild and can conform to one of several structures (Model1, Model2, or Model3) depending on its type and properties.
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Retrieve guild welcome screenDISCORDBOT_GET_GUILD_WELCOME_SCREENAcción

Retrieves the configured welcome screen for a specific discord guild that has the 'community' feature enabled.

Parámetros de entrada

guild_idstringObligatorio
Unique identifier of the Discord guild (server).

Parámetros de salida

dataobjectObligatorio
Welcome screen object with its description and list of welcome channels.
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Retrieve guild widget jsonDISCORDBOT_GET_GUILD_WIDGETAcción

Retrieves the public json widget data for a discord guild, if the widget is enabled for that guild.

Parámetros de entrada

guild_idstringObligatorio
Unique ID (snowflake) of the Discord guild for which to retrieve the widget JSON.

Parámetros de salida

dataobjectObligatorio
Guild widget data. See the 'Model' schema for detailed structure.
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Retrieve guild widget informationDISCORDBOT_GET_GUILD_WIDGET_SETTINGSAcción

Retrieves the widget settings for a specified discord guild, indicating if the widget is enabled and its configured channel id; requires a valid `guild id`.

Parámetros de entrada

guild_idstringObligatorio
The unique identifier (Snowflake ID) of the Discord guild (server) for which to retrieve the widget settings.

Parámetros de salida

dataobjectObligatorio
The widget settings for the specified guild, including its enablement status and the configured widget channel ID.
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Retrieve message from channelDISCORDBOT_GET_MESSAGEAcción

Retrieves a specific message from a discord channel, identified by `channel id` and `message id`, if the channel and message exist and are accessible.

Parámetros de entrada

channel_idstringObligatorio
The unique identifier of the Discord channel where the message is located.
message_idstringObligatorio
The unique identifier of the Discord message to be retrieved.

Parámetros de salida

dataobjectObligatorio
A dictionary representing the Discord message object, containing details such as content, author, timestamp, attachments, and embeds as returned by the Discord API.
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get your applicationsDISCORDBOT_GET_MY_APPLICATIONAcción

Retrieves detailed information about the current authenticated discord application.

Parámetros de entrada

Sin parámetros.

Parámetros de salida

dataobjectObligatorio
Detailed information about the current authenticated application.
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get oauth2 applications for current userDISCORDBOT_GET_MY_OAUTH2_APPLICATIONAcción

Retrieves detailed information about the oauth2 application associated with the current authentication; cannot query other applications.

Parámetros de entrada

Sin parámetros.

Parámetros de salida

dataobjectObligatorio
The detailed information of the current OAuth2 application.
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Retrieve original webhook messageDISCORDBOT_GET_ORIGINAL_WEBHOOK_MESSAGEAcción

Fetches the original, unedited message posted by a specific discord webhook, requiring a message to have been previously sent by this webhook and to exist in the specified thread if `thread id` is provided.

Parámetros de entrada

thread_idstring
ID of the thread the original webhook message is in; provide only if the message was posted in a specific thread.
webhook_idstringObligatorio
The ID of the Discord webhook used to send the original message.
webhook_tokenstringObligatorio
The token associated with the Discord webhook.

Parámetros de salida

dataobjectObligatorio
A dictionary representing the Discord Message Object for the original webhook message.
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get oauth2 keysDISCORDBOT_GET_PUBLIC_KEYSAcción

Retrieves discord's oauth2 public keys (jwk format) for verifying access tokens; keys may rotate, so refresh caches periodically.

Parámetros de entrada

Sin parámetros.

Parámetros de salida

dataobjectObligatorio
The structured response containing a list of public keys.
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Retrieve stage instance by channel idDISCORDBOT_GET_STAGE_INSTANCEAcción

Gets the active stage instance for a given stage channel id.

Parámetros de entrada

channel_idstringObligatorio
The unique identifier of the stage channel whose instance is to be retrieved.

Parámetros de salida

dataobjectObligatorio
Contains the detailed information of the retrieved stage instance.
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Retrieve sticker by idDISCORDBOT_GET_STICKERAcción

Retrieves a specific discord sticker by its unique id.

Parámetros de entrada

sticker_idstringObligatorio
The unique identifier of the Discord sticker to retrieve.

Parámetros de salida

dataobjectObligatorio
A dictionary representing the sticker object, including details such as `id`, `name`, `description`, `format_type`, `tags`, and `pack_id` if applicable.
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Retrieve thread member by idDISCORDBOT_GET_THREAD_MEMBERAcción

Retrieves a member from a specified thread using their user id, optionally including the full guild member object.

Parámetros de entrada

user_idstringObligatorio
The ID of the user whose membership in the thread is being retrieved.
channel_idstringObligatorio
The ID of the thread.
with_memberboolean
If true, the response includes the full guild member object with detailed guild-specific user information.

Parámetros de salida

dataobjectObligatorio
Contains the details of the retrieved thread member.
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Retrieve user by idDISCORDBOT_GET_USERAcción

Fetches public information for a discord user, requiring a valid and existing user id (snowflake).

Parámetros de entrada

user_idstringObligatorio
The unique identifier (snowflake ID) of the Discord user.

Parámetros de salida

dataobjectObligatorio
An object containing the detailed public information of the fetched Discord user.
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Retrieve webhook by idDISCORDBOT_GET_WEBHOOKAcción

Retrieves detailed information for an existing discord webhook, identified by its unique id, to verify settings or manage the webhook.

Parámetros de entrada

webhook_idstringObligatorio
The unique identifier of the Discord webhook to retrieve.

Parámetros de salida

dataobjectObligatorio
A dictionary containing the webhook object's details. Common fields include `id`, `type`, `guild_id`, `channel_id`, `user` (the creator of the webhook), `name`, `avatar`, `token` (partial token), `application_id`, and `url`.
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Retrieve webhook informationDISCORDBOT_GET_WEBHOOK_BY_TOKENAcción

Fetches a discord webhook's configuration details (e.g., name, avatar, channel id) using its id and token; this excludes message history or usage statistics.

Parámetros de entrada

webhook_idstringObligatorio
The unique identifier of the Discord webhook. This is a numerical string.
webhook_tokenstringObligatorio
The secret token for the Discord webhook, used for authentication. This is an alphanumeric string.

Parámetros de salida

dataobjectObligatorio
A dictionary representing the webhook object, containing details such as name, avatar, channel ID, and guild ID.
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Retrieve webhook message by idDISCORDBOT_GET_WEBHOOK_MESSAGEAcción

Retrieves a specific message previously sent by a discord webhook using its `message id`, requiring `thread id` if the message is part of a thread.

Parámetros de entrada

thread_idstring
ID of the thread if the message is part of one.
message_idstringObligatorio
Unique ID of the message to retrieve.
webhook_idstringObligatorio
Unique ID of the webhook that sent the message.
webhook_tokenstringObligatorio
Token for the webhook.

Parámetros de salida

dataobjectObligatorio
Dictionary representing the Discord Message object, following the Discord API specification.
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Retrieve invite by codeDISCORDBOT_INVITE_RESOLVEAcción

Resolves a discord invite code to get its details, optionally including member counts or data for a specific guild scheduled event; visibility of some details may depend on bot permissions.

Parámetros de entrada

codestringObligatorio
Unique invite code (e.g., 'nYUs4yAE' from 'discord.gg/nYUs4yAE').
with_countsboolean
Include approximate member and online presence counts for the guild in the response.
guild_scheduled_event_idstring
Retrieve invite data for a specific guild scheduled event using its ID.

Parámetros de salida

dataobjectObligatorio
Resolved invite object, including details such as guild, channel, inviter, expiration, and (if requested via `with_counts`) approximate member/presence counts.
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Delete invite via codeDISCORDBOT_INVITE_REVOKEAcción

Revokes a discord server invite using its unique code, permanently preventing new joins via this link (does not affect existing members); requires 'manage server' or 'manage invites' permissions on the server.

Parámetros de entrada

codestringObligatorio
The unique code of the Discord invite to be revoked (e.g., the string after 'discord.gg/').

Parámetros de salida

dataobjectObligatorio
Details of the revoked invite object upon successful deletion. Structure may differ for errors or non-existent invites.
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Update thread membershipDISCORDBOT_JOIN_THREADAcción

Joins the authenticated user to a thread specified by `channel id`; use this when the user is not already a member, for archived threads, or for threads requiring explicit joining, provided the thread is joinable, not locked or full, and the user has permissions.

Parámetros de entrada

channel_idstringObligatorio
The ID of the thread to join. In the Discord API, threads are a type of channel, so this ID refers to the thread itself.

Parámetros de salida

dataobjectObligatorio
Response data from the API. A successful join operation (HTTP 204 No Content) typically results in an empty dictionary. If populated, it might indicate an error or provide other contextual information.
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Delete user guildDISCORDBOT_LEAVE_GUILDAcción

Enables the authenticated user to leave a specified discord guild of which they are a member but not the owner; this action is irreversible.

Parámetros de entrada

guild_idstringObligatorio
The unique identifier of the Discord guild (server) the authenticated user wishes to leave.

Parámetros de salida

dataobjectObligatorio
Response data from the guild leave operation. Typically, this will be an empty dictionary upon successful execution, as the Discord API returns a 204 No Content status for this action.
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Remove current user from threadDISCORDBOT_LEAVE_THREADAcción

Removes the currently authenticated user from a specified, existing, and accessible discord thread of which they are currently a member.

Parámetros de entrada

channel_idstringObligatorio
The ID of the thread the current user wishes to leave.

Parámetros de salida

dataobjectObligatorio
Empty on successful leave (HTTP 204); may contain error details on failure.
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

List commands for applicationDISCORDBOT_LIST_APPLICATION_COMMANDSAcción

Fetches all global application commands for the specified discord application id; does not fetch guild-specific commands.

Parámetros de entrada

application_idstringObligatorio
Unique identifier of the Discord application.
with_localizationsboolean
Include localized names and descriptions for commands. Defaults to Discord's behavior (typically false).

Parámetros de salida

dataobject[]Obligatorio
List of application command objects.
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Retrieve guild auto moderation rulesDISCORDBOT_LIST_AUTO_MODERATION_RULESAcción

Fetches all auto moderation rules for a specified discord guild to review or audit its configuration; requires `view audit log` permissions and the action does not modify rules.

Parámetros de entrada

guild_idstringObligatorio
Guild ID for which to retrieve auto moderation rules.

Parámetros de salida

dataarrayObligatorio
A list of auto moderation rule objects for the given guild.
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

List Channel InvitesDISCORDBOT_LIST_CHANNEL_INVITESAcción

Fetches all active invites for a given discord channel id (read-only), requiring channel invite view permissions; response object structures may vary.

Parámetros de entrada

channel_idstringObligatorio
The unique identifier of the Discord channel for which to retrieve invites.

Parámetros de salida

dataarrayObligatorio
List of invite objects for the channel; structure of each invite varies by its properties and target.
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Retrieve channel webhooksDISCORDBOT_LIST_CHANNEL_WEBHOOKSAcción

Fetches detailed information for all webhooks in a given valid discord channel, useful for review or auditing purposes.

Parámetros de entrada

channel_idstringObligatorio
The unique identifier of the Discord channel for which webhooks are to be listed.

Parámetros de salida

dataarrayObligatorio
A list of webhook objects retrieved for the specified channel. The structure of each webhook object in the list varies by its type.
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get application guild command permissionsDISCORDBOT_LIST_GUILD_APPLICATION_COMMAND_PERMISSIONSAcción

Call this action to retrieve all explicitly set guild-level permission settings for all commands of a specific application within a given guild, typically for auditing or troubleshooting command access.

Parámetros de entrada

guild_idstringObligatorio
The unique identifier of the guild (server).
application_idstringObligatorio
The unique identifier of the application.

Parámetros de salida

dataobject[]Obligatorio
An array of objects, each detailing a command and its explicit guild-level permissions.
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Fetch guild commands via application idDISCORDBOT_LIST_GUILD_APPLICATION_COMMANDSAcción

Fetches all application command definitions (slash, user, and message types) for a specific application within a given discord guild, optionally including localizations; does not return permissions or usage statistics.

Parámetros de entrada

guild_idstringObligatorio
The ID of the guild for which commands are being fetched.
application_idstringObligatorio
The ID of the application whose commands are being fetched.
with_localizationsboolean
Whether to include full localization dictionaries (name_localizations and description_localizations) in the returned objects, instead of just the name_localized and description_localized fields.

Parámetros de salida

dataobject[]Obligatorio
The list of application commands for the specified guild.
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get guild audit logs by guild idDISCORDBOT_LIST_GUILD_AUDIT_LOG_ENTRIESAcción

Retrieves audit log entries (e.g., message deletions, member kicks/bans, role changes) for a specified discord guild, requiring 'view audit log' permission.

Parámetros de entrada

afterstring
Retrieve audit log entries that occurred after this entry ID for pagination.
limitinteger
Maximum number of entries to return (1-100, default 50).
beforestring
Retrieve audit log entries that occurred before this entry ID for pagination.
user_idstring
Filter logs by the ID of the user who performed the action.
guild_idstringObligatorio
ID of the Discord guild (server) for which to retrieve audit logs.
target_idstring
Filter logs by the ID of the entity targeted by the action. The nature of this ID depends on the `action_type` (e.g., a user ID for a ban, a role ID for a role update).
action_typeinteger
Filter logs by a specific audit log event type. Refer to Discord API documentation for event type codes.

Parámetros de salida

dataobjectObligatorio
A dictionary representing the raw JSON response from the Discord API. This typically includes a list of `audit_log_entries` and may also contain related data objects like `users`, `webhooks`, `integrations`, etc., that are referenced within the audit log entries.
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

List guild bansDISCORDBOT_LIST_GUILD_BANSAcción

Fetches a list of users banned from a specified discord guild; `before`/`after` parameters require user ids from previous results for correct pagination.

Parámetros de entrada

afterstring
Fetches bans for users with IDs after this user ID. For forward pagination.
limitinteger
Maximum number of bans to return (typically 1-1000); if unspecified, Discord's default is used. For pagination.
beforestring
Fetches bans for users with IDs before this user ID. For backward pagination.
guild_idstringObligatorio
ID of the Discord guild (server) from which to retrieve the ban list.

Parámetros de salida

dataobject[]Obligatorio
List of ban objects, each including the ban reason and banned user details.
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Retrieve guild channelsDISCORDBOT_LIST_GUILD_CHANNELSAcción

Fetches all channels (e.g., text, voice, category, threads) and their structural information for a specified discord guild id; does not include message content.

Parámetros de entrada

guild_idstringObligatorio
Identifier of the Discord guild (server).

Parámetros de salida

dataarrayObligatorio
Channel objects returned for the guild; details vary by channel type (e.g., text, voice, DM, thread).
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Retrieve guild emojisDISCORDBOT_LIST_GUILD_EMOJISAcción

Fetches all custom emoji objects for a specified discord guild if the bot has access; returns only custom guild emojis, not standard unicode or nitro emojis.

Parámetros de entrada

guild_idstringObligatorio
The unique identifier of the Discord guild (server) for which to list emojis.

Parámetros de salida

dataobject[]Obligatorio
A list of emoji objects found in the specified guild. Each object provides details about a custom emoji.
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

List guild integrationsDISCORDBOT_LIST_GUILD_INTEGRATIONSAcción

Lists all integration objects for a specified discord guild.

Parámetros de entrada

guild_idstringObligatorio
The unique identifier of the Discord guild (server) for which to list integrations.

Parámetros de salida

dataarrayObligatorio
List of integration objects for the guild.
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Retrieve guild invites by idDISCORDBOT_LIST_GUILD_INVITESAcción

Retrieves all currently active invite codes for a specified discord guild, typically for administration, analytics, or managing guild invitations.

Parámetros de entrada

guild_idstringObligatorio
The unique identifier of the Discord guild (server) for which to retrieve active invites.

Parámetros de salida

dataarrayObligatorio
A list of active invite objects for the specified guild. Each object provides details about an invite, such as its code, creator, channel, usage, and expiration.
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get guild membersDISCORDBOT_LIST_GUILD_MEMBERSAcción

Retrieves members for a discord guild; requires a valid guild id for an existing guild.

Parámetros de entrada

afterinteger
User ID for pagination offset; fetches members with IDs greater than this value.
limitinteger
Max number of members to return (API default: 1, max: 1000).
guild_idstringObligatorio
Identifier of the Discord guild (server) to retrieve members from.

Parámetros de salida

dataobject[]Obligatorio
List of member objects.
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

List guild rolesDISCORDBOT_LIST_GUILD_ROLESAcción

Fetches all roles in a discord guild, providing details for each role but not user assignments; `guild id` must be valid.

Parámetros de entrada

guild_idstringObligatorio
Identifier of the Discord guild (server).

Parámetros de salida

dataobject[]Obligatorio
List of role objects detailing roles in the guild.
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Retrieve guild scheduled eventsDISCORDBOT_LIST_GUILD_SCHEDULED_EVENTSAcción

Retrieves a list of scheduled events for a specified discord guild, optionally including subscribed user counts, provided the authenticated user/bot has access to the guild.

Parámetros de entrada

guild_idstringObligatorio
Guild ID for which to retrieve scheduled events.
with_user_countboolean
Include the count of users subscribed to each event.

Parámetros de salida

dataarrayObligatorio
List of retrieved scheduled events for the guild.
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Retrieve users for scheduled eventDISCORDBOT_LIST_GUILD_SCHEDULED_EVENT_USERSAcción

Fetches users who have expressed interest in a specific scheduled event, requiring valid guild and event ids.

Parámetros de entrada

afterstring
Return users after this user ID for pagination.
limitinteger
Maximum number of users to return (1-100); Discord defaults to 100 if omitted.
beforestring
Return users before this user ID for pagination.
guild_idstringObligatorio
Unique identifier of the Discord guild (server).
with_memberboolean
Include the guild member object for each user. Defaults to false if omitted.
guild_scheduled_event_idstringObligatorio
Unique identifier of the scheduled event.

Parámetros de salida

dataobject[]Obligatorio
List of users interested in the event; includes guild member data if requested.
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Retrieve guild stickersDISCORDBOT_LIST_GUILD_STICKERSAcción

Retrieves all custom sticker objects for a discord guild; does not include standard/nitro stickers.

Parámetros de entrada

guild_idstringObligatorio
Unique identifier of the Discord guild (server).

Parámetros de salida

dataobject[]Obligatorio
List of sticker objects available in the specified guild.
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get guild templates by guild idDISCORDBOT_LIST_GUILD_TEMPLATESAcción

Retrieves all guild templates for an existing discord guild, specified by its id.

Parámetros de entrada

guild_idstringObligatorio
The unique identifier of the Discord guild for which to retrieve templates.

Parámetros de salida

dataobject[]Obligatorio
A list of guild templates associated with the specified guild.
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

List guild regionsDISCORDBOT_LIST_GUILD_VOICE_REGIONSAcción

Fetches a list of available voice regions for a specified discord guild.

Parámetros de entrada

guild_idstringObligatorio
The unique identifier of the Discord guild (server).

Parámetros de salida

dataobject[]Obligatorio
A list of available voice region objects for the specified guild. Each object details a voice region's properties.
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get channel message reaction by emojiDISCORDBOT_LIST_MESSAGE_REACTIONS_BY_EMOJIAcción

Fetches a list of users who reacted to a specific message with a given emoji in a discord channel; retrieves users for one emoji at a time.

Parámetros de entrada

afterstring
Get users after this user ID. Used for pagination.
limitinteger
The maximum number of users to return (1-100). Defaults to 25 if not specified.
channel_idstringObligatorio
The ID of the channel where the message is located.
emoji_namestringObligatorio
The emoji to retrieve reactions for. For standard Unicode emojis, use the URL-encoded emoji character (e.g., '%F0%9F%91%8D' for 👍). For custom emojis, use the format 'name:id' (e.g., 'customEmoji:12345678901234567').
message_idstringObligatorio
The ID of the message to retrieve reactions from.

Parámetros de salida

dataobject[]Obligatorio
The data payload containing a list of user objects representing the users who reacted.
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Fetch messages from channelDISCORDBOT_LIST_MESSAGESAcción

Retrieves historical messages from a specified, accessible discord channel, typically newest first; for real-time messages, use discord's websocket gateway api.

Parámetros de entrada

afterstring
Get messages after this message ID for forward pagination.
limitinteger
Max messages to retrieve (1-100, API defaults to 50).
aroundstring
Get messages around this message ID.
beforestring
Get messages before this message ID for backward pagination.
channel_idstringObligatorio
ID of the Discord channel to fetch messages from.

Parámetros de salida

dataobjectObligatorio
A dictionary containing the list of retrieved message objects and other relevant response data.
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get private archived threads for userDISCORDBOT_LIST_MY_PRIVATE_ARCHIVED_THREADSAcción

Retrieves private archived threads from a specified channel that the current user is a member of.

Parámetros de entrada

limitinteger
Maximum number of threads to retrieve (1-100); defaults to an API-defined limit (often 50).
beforestring
An ISO8601 timestamp or a thread ID. Returns threads archived before this value. Used for pagination.
channel_idstringObligatorio
The ID of the channel where the private archived threads are located.

Parámetros de salida

dataobjectObligatorio
Contains the list of threads, associated member objects for the current user, and a flag indicating if more threads are available.
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Retrieve pinned messages in channelDISCORDBOT_LIST_PINNED_MESSAGESAcción

Retrieves all currently pinned messages from a discord channel using its valid, existing id; typically limited to 50 messages, and no history of past pins is returned.

Parámetros de entrada

channel_idstringObligatorio
ID of the Discord channel.

Parámetros de salida

dataobjectObligatorio
Array of Discord Message objects representing currently pinned messages. For Message Object structure, refer to Discord API documentation.
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get archived private threads by channel idDISCORDBOT_LIST_PRIVATE_ARCHIVED_THREADSAcción

Lists a channel's private archived threads, sorted by most recent archival, requiring view access to them.

Parámetros de entrada

limitinteger
The maximum number of threads to return (1-100). Defaults to a server-specified limit, typically 50.
beforestring
Retrieve threads archived before this timestamp (ISO8601 format) or thread ID (snowflake). If not provided, the most recent threads are returned.
channel_idstringObligatorio
The ID of the channel to retrieve archived private threads from.

Parámetros de salida

dataobjectObligatorio
The object containing an array of archived private threads, an array of their members, and a boolean indicating if more results are available.
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get archived public threads by channel idDISCORDBOT_LIST_PUBLIC_ARCHIVED_THREADSAcción

Lists public archived threads in an accessible discord channel, returning an empty list if none exist; does not list private or active threads.

Parámetros de entrada

limitinteger
The maximum number of threads to return. Must be an integer between 1 and 100. Defaults by Discord to 50 if not specified.
beforestring
An ISO8601 timestamp string or a thread ID (snowflake). Returns threads created before this specified timestamp or ID. If omitted, threads are returned from the most recent.
channel_idstringObligatorio
The ID (snowflake) of the channel from which to retrieve public archived threads.

Parámetros de salida

dataobjectObligatorio
The structured response data which includes a list of thread objects, a list of member objects for those threads, and a boolean indicating if more threads are available.
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

List sticker packsDISCORDBOT_LIST_STICKER_PACKSAcción

Fetches sticker packs available to nitro subscribers on discord, excluding custom or guild-specific ones.

Parámetros de entrada

Sin parámetros.

Parámetros de salida

dataobjectObligatorio
The main payload of the response, containing a list of sticker packs.
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

List thread members in channelDISCORDBOT_LIST_THREAD_MEMBERSAcción

Retrieves members of a specified discord thread, with an option to include full guild member objects for each.

Parámetros de entrada

afterstring
The user ID to paginate from, returning thread members whose user IDs are after this one. Used for retrieving subsequent pages of results.
limitinteger
The maximum number of thread members to return. Must be between 1 and 100, inclusive. Defaults to a server-defined value (often 50) if omitted or invalid.
channel_idstringObligatorio
The ID of the thread channel from which to retrieve members. This must be a thread ID, not a parent channel ID.
with_memberboolean
If `true`, includes the full guild member object for each thread member in the response. If omitted or `false`, only basic thread member information is returned.

Parámetros de salida

dataobject[]Obligatorio
Contains a list of thread member objects retrieved. See `ModelItem` for the structure of each object.
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Fetch voice regions listDISCORDBOT_LIST_VOICE_REGIONSAcción

Lists all available discord voice regions with their id, name, operational status (custom, deprecated, optimal), noting that availability may vary by server.

Parámetros de entrada

Sin parámetros.

Parámetros de salida

dataobject[]Obligatorio
A list of `ModelItem` objects, each detailing an available voice region's properties (like ID, name) and status (custom, deprecated, optimal).
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Pin message in channelDISCORDBOT_PIN_MESSAGEAcción

Pins a message in a discord channel for increased visibility, if the channel's pin limit (typically 50) is not exceeded.

Parámetros de entrada

channel_idstringObligatorio
Identifier of the channel containing the message.
message_idstringObligatorio
Identifier of the message to pin.

Parámetros de salida

dataobjectObligatorio
API response. For a successful pin (HTTP 204 No Content), Discord returns no body, so this dictionary is expected to be empty.
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Retrieve guild prune infoDISCORDBOT_PREVIEW_PRUNE_GUILDAcción

Previews the number of members that would be pruned from a discord guild based on inactivity days and optional roles; this action only returns a count and does not remove members.

Parámetros de entrada

daysinteger
Number of days of inactivity (1-30 inclusive). Members inactive for at least this many days are eligible for pruning. Defaults to 7 (API default).
guild_idstringObligatorio
The unique identifier of the Discord guild (server) for which to preview the prune operation.
include_rolesnull[]
Filters prune count by role IDs. If empty/not provided, API default role filtering applies. The Discord API expects comma-delimited role IDs; due to `t.List[None]`, the exact mechanism for passing these IDs is implementation-specific.

Parámetros de salida

dataobjectObligatorio
Contains the result of the prune preview, including the count of members that would be pruned.
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Prune guild members by rolesDISCORDBOT_PRUNE_GUILDAcción

Removes inactive members from a discord guild, requiring 'kick members' permission; use `compute prune count=true` to preview results before actual removal.

Parámetros de entrada

daysinteger
Number of inactivity days (1-30, default 7) before pruning members.
guild_idstringObligatorio
ID of the Discord guild (server) for member pruning.
include_rolesstring[]
Optional list of role IDs to restrict pruning to members with any of these roles.
compute_prune_countboolean
If true (default false), simulates prune and returns count without removing members.

Parámetros de salida

dataobjectObligatorio
Result of the prune operation, typically the number of members pruned or to be pruned.
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Update guild onboarding configurationDISCORDBOT_PUT_GUILDS_ONBOARDINGAcción

Configures or updates a discord guild's new member onboarding flow, including defining prompts with options, assigning roles/channels, setting default channels, and managing the flow's active status.

Parámetros de entrada

modenull
Onboarding mode; its value must be `null` (Discord-managed). See `OnboardingMode` docs for internal integer modes.
enabledboolean
If true, the guild's onboarding flow is active.
promptsobject[]
Up to 5 onboarding prompts for the guild.
guild_idstringObligatorio
Guild's unique ID (Snowflake) for which onboarding settings are being updated.
default_channel_idsstring[]
Up to 7 channel IDs (Snowflake) new members join/are recommended post-onboarding.

Parámetros de salida

dataobjectObligatorio
Updated onboarding settings for the specified guild.
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Search guild members by idDISCORDBOT_SEARCH_GUILD_MEMBERSAcción

Searches for members in a specific discord guild, allowing filtering by a query string.

Parámetros de entrada

limitintegerObligatorio
Maximum number of members to return. Defaults to 1 if not specified, with a maximum of 1000.
querystringObligatorio
The query string to match against usernames or nicknames. The search is prefix-based (e.g., 'adm' will match 'admin').
guild_idstringObligatorio
The unique identifier of the Discord guild (server) to search within.

Parámetros de salida

dataobject[]Obligatorio
A list of guild member objects that match the search query within the specified guild.
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Modify channel permissionsDISCORDBOT_SET_CHANNEL_PERMISSION_OVERWRITEAcción

Updates or creates a permission overwrite for a role (type `0`) or member (type `1`) specified by `overwrite id` within an existing discord channel (`channel id`), using `allow` and `deny` bitwise values to precisely control permissions.

Parámetros de entrada

denyinteger
Bitwise value of Discord permission flags to deny. '0' means no explicit denials; omit to inherit. See Discord docs for flags.
typeintegerObligatorio
Type of entity `overwrite_id` refers to: `0` for a role or `1` for a member (user).
allowinteger
Bitwise value of Discord permission flags to grant. '0' means no new permissions; omit to inherit. See Discord docs for flags.
channel_idstringObligatorio
The unique identifier of the Discord channel where the permission overwrite will be applied.
overwrite_idstringObligatorio
The unique identifier of the role or member (user) to whom the permission overwrite applies.

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Update guild template by codeDISCORDBOT_SYNC_GUILD_TEMPLATEAcción

Synchronizes a guild template (by `code`) with its source guild (`guild id`), updating it to match the source's current configuration; this does not affect guilds already created from this template.

Parámetros de entrada

codestringObligatorio
The unique code of the guild template to be synchronized.
guild_idstringObligatorio
The unique identifier of the Discord server (guild) that is the source of the template.

Parámetros de salida

dataobjectObligatorio
The updated guild template object, reflecting its state after synchronization.
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Trigger typing indicatorDISCORDBOT_TRIGGER_TYPING_INDICATORAcción

Shows the bot is 'typing' in a discord channel, typically before sending a message; indicator stops after 10 seconds or upon message send, so use when actively preparing a response.

Parámetros de entrada

channel_idstringObligatorio
The unique identifier of the Discord channel where the typing indicator should be displayed.

Parámetros de salida

dataobjectObligatorio
An empty object, as this operation typically returns a 204 No Content status on success, indicating the typing indicator was successfully triggered.
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Delete guild user banDISCORDBOT_UNBAN_USER_FROM_GUILDAcción

Revokes a ban for a user from a discord guild, allowing them to rejoin if they choose.

Parámetros de entrada

user_idstringObligatorio
ID of the user to unban from the specified guild.
guild_idstringObligatorio
ID of the Discord server (guild) from which to remove the user's ban.

Parámetros de salida

dataobjectObligatorio
An empty dictionary upon successful unban (HTTP 204 No Content).
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Delete channel message pinDISCORDBOT_UNPIN_MESSAGEAcción

Unpins a message that is currently pinned in a specified discord channel; the message itself is not deleted.

Parámetros de entrada

channel_idstringObligatorio
Identifier of the Discord channel containing the pinned message.
message_idstringObligatorio
Identifier of the pinned message to unpin.

Parámetros de salida

dataobjectObligatorio
Discord API response; typically empty or indicates success upon unpinning.
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Modify application by idDISCORDBOT_UPDATE_APPLICATIONAcción

Updates a discord application's settings using its `application id`; `max participants` requires the `application embedded activities` flag, and `team id`, `type`, or `install params` must be `null` if specified.

Parámetros de entrada

iconstring
Base64 encoded application icon (PNG, JPEG, or GIF).
tagsstring[]
Up to 5 string tags for application discovery.
typenull
Application type; if provided, must be `null` for type transitions or resets (consult Discord API).
flagsinteger
Bitwise value for application flags; consult Discord API for flag meanings.
team_idnull
Team ID; if provided, must be `null` to transfer ownership or disassociate from a team.
cover_imagestring
Base64 encoded cover image (PNG, JPEG, or GIF).
application_idstringObligatorio
Unique identifier of the Discord application to update.
install_paramsnull
OAuth2 installation parameters; if provided, must be `null` to reset or clear existing defaults.
max_participantsinteger
Maximum participants for an activity; requires `APPLICATION_EMBEDDED_ACTIVITIES` flag.
custom_install_urlstringuri
Custom URL for redirection after authorization, bypassing default OAuth2 completion.
description__defaultstring
Default description if localized version is unavailable for the user's client.
interactions_endpoint_urlstringuri
HTTPS URL for Discord to send interaction events (e.g., slash commands).
description__localizationsobject
Dictionary of localized descriptions; keys are locale strings (e.g., 'en-US', 'de').
role_connections_verification_urlstringuri
URL for verifying linked roles in role connections.

Parámetros de salida

dataobjectObligatorio
The updated application object.
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Patch command for applicationDISCORDBOT_UPDATE_APPLICATION_COMMANDAcción

Updates specified properties of a discord application command (e.g., name, description); omitted properties remain unchanged, and the `options` field, if provided, overwrites all existing options.

Parámetros de entrada

namestring
The new name for the command (1-32 characters).
optionsobject[]
The new list of [application command options](https://discord.com/developers/docs/interactions/application-commands#application-command-object-application-command-option-structure) for the command. If provided, all existing options will be overwritten. An empty list will remove all options. Required options must be listed before optional ones.
command_idstringObligatorio
The unique identifier of the command to be updated.
descriptionstring
The new description for the command (1-100 characters). For USER and MESSAGE commands, this should be an empty string if provided.
dm_permissionboolean
Indicates whether the command is available in DMs with the app. If `null` or not set, it will inherit the application's default DM permission configuration.
application_idstringObligatorio
The unique identifier of the Discord application.
name_localizationsobject
A dictionary mapping [locale strings](https://discord.com/developers/docs/reference#locales) to localized names for the command.
description_localizationsobject
A dictionary mapping [locale strings](https://discord.com/developers/docs/reference#locales) to localized descriptions for the command.
default_member_permissionsinteger
An integer representing the bitwise OR-ed set of [permission flags](https://discord.com/developers/docs/topics/permissions#permissions-bitwise-permission-flags) required for a member to use this command by default. For example, 8 for Administrator. Set to 0 to disable for everyone except admins by default.

Parámetros de salida

dataobjectObligatorio
The updated [application command object](https://discord.com/developers/docs/interactions/application-commands#application-command-object) reflecting the changes.
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Update user application role connectionDISCORDBOT_UPDATE_APPLICATION_USER_ROLE_CONNECTIONAcción

Updates the authorized user's role connection for a specific application, which must have a linked role connection configured.

Parámetros de entrada

metadataobject
A dictionary of custom metadata. Values must be strings. Keys can be up to 100 characters and values up to 1000 characters. There can be up to 5 metadata fields.
platform_namestring
The name of the external platform (e.g., Twitch, GitHub).
application_idstringObligatorio
The ID of the application.
platform_usernamestring
The user's username on the external platform.

Parámetros de salida

dataobjectObligatorio
The updated role connection object.
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Modify guild auto moderation ruleDISCORDBOT_UPDATE_AUTO_MODERATION_RULEAcción

Updates an existing auto-moderation rule, identified by `guild id` and `rule id` in the path, with new values for rule properties (e.g., `name`, `event type`) provided in the request body.

Parámetros de entrada

rule_idstringObligatorio
The unique identifier of the auto-moderation rule that needs to be updated.
guild_idstringObligatorio
The unique identifier of the Discord guild where the auto-moderation rule is located.

Parámetros de salida

dataobjectObligatorio
A dictionary representing the complete auto-moderation rule object as it exists after the update. For details on the structure of this object, refer to the Discord API documentation for auto-moderation rules.
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Patch channel properties by idDISCORDBOT_UPDATE_CHANNELAcción

Partially updates an existing discord channel, using `channel id` for identification and properties in the request body for changes, ensuring these properties are applicable to the channel's type.

Parámetros de entrada

channel_idstringObligatorio
The unique identifier of the Discord channel to be modified.

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Update guild settingsDISCORDBOT_UPDATE_GUILDAcción

Updates settings for a discord guild, such as its name, region, or icon; transferring ownership requires being the current owner, and managing features or certain visual elements (e.g., banners, splashes) may require specific permissions or guild statuses like 'community' or 'vip'.

Parámetros de entrada

iconstring
Base64 encoded 128x128 image for the guild icon; null to remove.
namestring
New name for the guild (2-100 characters).
bannerstring
Base64 encoded 16:9 image for guild banner (VIP servers only, requires 'BANNER' feature); null to remove.
regionstring
New voice region ID; use `vip-` prefix for VIP servers, or null to remove override.
splashstring
Base64 encoded 16:9 image for guild splash (VIP servers only); null to remove.
featuresstring[]
List of guild feature strings to enable/disable (e.g., 'COMMUNITY', 'DISCOVERABLE'); requires 'MANAGE_GUILD' permission or specific server status.
guild_idstringObligatorio
Identifier of the guild to update.
owner_idstringsnowflake
User ID to transfer guild ownership to; requires current user to be the owner.
afk_timeoutnull
New AFK timeout in seconds (e.g., 60, 300, 900, 1800, 3600).
descriptionstring
New description for the guild; null to remove.
home_headerstring
Base64 encoded image for home header (requires 'COMMUNITY' feature); null to remove.
afk_channel_idnull
ID of the new AFK channel; null to disable.
discovery_splashstring
Base64 encoded 16:9 image for guild discovery splash (requires 'DISCOVERABLE' feature); null to remove.
preferred_localenull
New preferred locale for server discovery and Discord notices (e.g., 'en-US', 'es-ES').
rules_channel_idnull
ID of the channel for server rules (requires 'COMMUNITY' feature); null to disable.
system_channel_idnull
ID of the channel for guild notices (e.g., welcome messages, server boosts); null to disable.
verification_levelnull
New verification level (integer; e.g., 0: None, 1: Low, 2: Medium, 3: High, 4: Very High).
system_channel_flagsinteger
New system channel flags (integer; e.g., suppress join notifications, suppress premium subscription notifications).
explicit_content_filternull
New explicit content filter level (integer; e.g., 0: Disabled, 1: Members without roles, 2: All members).
safety_alerts_channel_idnull
ID of the channel for Discord safety alerts; null to disable.
public_updates_channel_idnull
ID of the channel for Discord notices to admins/moderators of Community guilds; null to disable.
premium_progress_bar_enabledboolean
Enable/disable the premium progress bar for the guild.
default_message_notificationsnull
New default message notification level (integer; e.g., 0: All Messages, 1: Only @mentions).

Parámetros de salida

dataobjectObligatorio
Updated guild object reflecting the changes.
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Update application guild commandDISCORDBOT_UPDATE_GUILD_APPLICATION_COMMANDAcción

Updates a specific discord application command's properties (like name, description, options, or permissions) within a given guild; `application id`, `guild id`, and `command id` must refer to valid entities.

Parámetros de entrada

namestring
New name for the command (1-32 characters).
optionsobject[]
Array of new application command option objects for the command; up to 25 options.
guild_idstringObligatorio
The unique ID of the guild where the command is registered.
command_idstringObligatorio
The unique ID of the command to update.
descriptionstring
New description for the command (1-100 characters).
dm_permissionboolean
Indicates whether the command is available in DMs with the app. This field is not supported for guild commands and will be ignored if provided.
application_idstringObligatorio
The unique ID of the application whose command is being updated.
name_localizationsobject
Dictionary of localizations for the command's name; keys are Discord locale codes.
description_localizationsobject
Dictionary of localizations for the command's description; keys are Discord locale codes.
default_member_permissionsinteger
Bitwise value for the command's new default member permissions; '0' allows everyone.

Parámetros de salida

dataobjectObligatorio
The updated [Application Command object](https://discord.com/developers/docs/interactions/application-commands#application-command-object) reflecting the changes.
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Update guild emoji rolesDISCORDBOT_UPDATE_GUILD_EMOJIAcción

Updates a custom emoji's name and/or role restrictions in a discord guild; cannot create or delete emojis, and role updates for managed emojis may be restricted by their integration.

Parámetros de entrada

namestring
The new name for the emoji (must be 2-32 characters). If `null` or not provided, the name will not be changed.
rolesnull[]
A list of role IDs that are allowed to use this emoji. Provide an empty list to make the emoji available to @everyone (if role restrictions are generally active for emojis). If this field is `null` (or not provided, as `default=None`), the emoji's role restrictions remain unchanged. Each element in the list should be a string representing a role ID.
emoji_idstringObligatorio
The unique identifier of the custom emoji to be updated.
guild_idstringObligatorio
The unique identifier of the Discord guild (server) where the emoji resides.

Parámetros de salida

dataobjectObligatorio
An object representing the updated state of the guild emoji.
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Modify guild member detailsDISCORDBOT_UPDATE_GUILD_MEMBERAcción

Updates a guild member's attributes (e.g., nickname, roles, voice state); if moving via `channel id`, it must be a valid voice channel in the guild.

Parámetros de entrada

deafboolean
Server deafens the member in voice channels. Requires the DEAFEN_MEMBERS permission.
muteboolean
Server mutes the member in voice channels. Requires the MUTE_MEMBERS permission.
nickstring
New nickname for the guild member; `null` or an empty string removes the nickname.
flagsinteger
Guild member flags (integer), e.g., `BYPASSES_VERIFICATION` (1), `SUPPRESS_ROLES` (4). Consult Discord API documentation for details on member flags.
rolesnull[]
List of role IDs (as strings) to assign. Replaces all existing roles. An empty list removes all roles.
user_idstringObligatorio
Unique identifier of the Discord user whose guild member information is being updated.
guild_idstringObligatorio
Unique identifier of the Discord guild (server).
channel_idnull
Voice channel ID to move the member to (if connected); set to `null` to disconnect the member from their current voice channel.
communication_disabled_untilstringdate-time
ISO8601 timestamp for user's timeout expiration (max 28 days in future). `null` or a past time removes an active timeout. Requires MODERATE_MEMBERS permission.

Parámetros de salida

dataobjectObligatorio
The updated guild member object.
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Modify guild roleDISCORDBOT_UPDATE_GUILD_ROLEAcción

Updates a discord guild role's attributes (name, permissions, color, etc.); requires `manage roles` permission, and the `role icons` guild feature if using `unicode emoji`; unspecified attributes remain unchanged.

Parámetros de entrada

iconstring
New role icon as base64 encoded image data (64x64px, max 256KB); cannot be used if `unicode_emoji` is set.
namestring
New name for the role (max 100 characters).
colorinteger
New color as an integer representation of a hex code (0 for no color).
hoistboolean
Set to true to display the role separately in the member list.
role_idstringObligatorio
Unique identifier of the role to be updated.
guild_idstringObligatorio
Unique identifier of the guild (server).
mentionableboolean
Set to true to allow anyone to mention this role.
permissionsinteger
Bitwise value for new role permissions; refer to Discord API documentation for flags.
unicode_emojistring
New unicode emoji for the role's icon; cannot be used if `icon` is set and requires the `ROLE_ICONS` guild feature.

Parámetros de salida

dataobjectObligatorio
Updated role object.
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Update guild scheduled eventDISCORDBOT_UPDATE_GUILD_SCHEDULED_EVENTAcción

Updates attributes such as name, description, schedule, status, or location for an existing discord guild event; only fields in the request body are changed.

Parámetros de entrada

guild_idstringObligatorio
The unique identifier of the Discord guild where the event is scheduled.
guild_scheduled_event_idstringObligatorio
The unique identifier of the guild scheduled event to be updated.

Parámetros de salida

dataobjectObligatorio
A dictionary containing the updated guild scheduled event object.
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Update guild sticker infoDISCORDBOT_UPDATE_GUILD_STICKERAcción

Modifies a guild sticker's name, description, or tags, requiring 'manage emojis and stickers' permission.

Parámetros de entrada

namestring
New name for the sticker (2-30 characters).
tagsstring
New tags for sticker suggestions (comma-separated keywords, up to 200 characters total).
guild_idstringObligatorio
ID of the guild where the sticker is located.
sticker_idstringObligatorio
ID of the sticker to be updated.
descriptionstring
New description for the sticker (2-100 characters).

Parámetros de salida

dataobjectObligatorio
The updated sticker object containing all its current attributes.
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Patch guild template informationDISCORDBOT_UPDATE_GUILD_TEMPLATEAcción

Updates a discord guild template's `name` and/or `description` given its `guild id` and template `code`; omitted fields retain current values, and an empty string for `description` clears it.

Parámetros de entrada

codestringObligatorio
Unique code of the guild template to be updated.
namestring
New name for the guild template; if omitted or null, the current name is retained.
guild_idstringObligatorio
Unique identifier of the Discord guild where the template resides.
descriptionstring
New description for the guild template; if omitted or null, current description is retained. An empty string ("") clears it.

Parámetros de salida

dataobjectObligatorio
The updated guild template object, reflecting the changes made.
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Update guild welcome screenDISCORDBOT_UPDATE_GUILD_WELCOME_SCREENAcción

Updates a guild's welcome screen, including its description, enabled status, and up to 5 welcome channels; when specifying channel emojis, use `emoji name` as `emoji id` must be `null` if sent.

Parámetros de entrada

enabledboolean
Whether the welcome screen is enabled. Set to `true` to enable, `false` to disable. Set to `null` to leave unchanged.
guild_idstringObligatorio
The unique ID (snowflake) of the guild (server) whose welcome screen is to be updated.
descriptionstring
The server description to show in the welcome screen. Set to `null` to remove the description.
welcome_channelsobject[]
An array of welcome channel objects (max 5). These channels are highlighted on the welcome screen. Set to `null` or an empty list to remove all welcome channels.

Parámetros de salida

dataobjectObligatorio
The updated welcome screen configuration for the guild.
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Patch guild widget endpointDISCORDBOT_UPDATE_GUILD_WIDGET_SETTINGSAcción

Updates an existing discord guild's widget settings, such as its enabled state or clearing its invite channel.

Parámetros de entrada

enabledboolean
Enables (`true`) or disables (`false`) the guild widget. Omit to leave unchanged.
guild_idstringObligatorio
Unique ID (Snowflake ID) of the Discord guild whose widget settings are to be updated.
channel_idnull
Set to `null` to clear the widget's invite channel. Omit to leave current invite channel unchanged.

Parámetros de salida

dataobjectObligatorio
The updated guild widget settings. Contains the 'enabled' status (boolean) and 'channel_id' (Snowflake ID string or null) for the widget invite.
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Update channel messageDISCORDBOT_UPDATE_MESSAGEAcción

Updates a message previously sent by the bot in a discord channel, by modifying its content, embeds, components, flags, or attachment metadata (new attachments cannot be uploaded); only provide fields to change, using null or an empty list to clear existing values.

Parámetros de entrada

flagsinteger
Message flags to set (e.g., 4 for SUPPRESS_EMBEDS). Consult Discord API documentation for all flags.
embedsobject[]
List of up to 10 embed objects. Set to null or an empty list to remove all.
contentstring
New message content (up to 2000 characters). Set to null or an empty string to remove.
channel_idstringObligatorio
ID of the channel where the message is located.
componentsobject[]
List of message component objects (e.g., buttons, select menus). Set to an empty list to remove.
message_idstringObligatorio
ID of the message to update.
attachmentsobject[]
List of attachments to keep or update metadata for. New files cannot be uploaded here. Omit item or provide empty list to remove an attachment.
sticker_idsstring[]
List of up to 3 sticker IDs the bot can access. Set to an empty list to remove.
allowed_mentionsnull
Controls mention notifications (roles, users, 'everyone'). Set to null for default behavior or to clear previous settings.

Parámetros de salida

dataobjectObligatorio
The updated Discord message object.
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Update application descriptionDISCORDBOT_UPDATE_MY_APPLICATIONAcción

Modifies settings for the current authenticated discord application (e.g., description, icon, interaction urls); setting `team id` to `null` (none) transfers team ownership, while `null` (none) for `type` or `install params` clears/resets them.

Parámetros de entrada

iconstring
Base64 encoded data URI for the application's icon (e.g., JPEG, PNG).
tagsstring[]
List of up to 5 tags describing the application (max 20 characters per tag).
typenull
Application type. If provided, must be `null` (None in Python) to unset or reset to a default. Consult Discord's documentation for behavior of `null`.
flagsinteger
Bitwise [application flags](https://discord.com/developers/docs/resources/application#application-object-application-flags) value. Consult Discord's documentation for specific flag values.
team_idnull
Team ID of the application owner. If provided, must be `null` (None in Python) to transfer ownership of a team-owned app to the current user.
cover_imagestring
Base64 encoded data URI for the application's cover image (e.g., JPEG, PNG).
install_paramsnull
Installation parameters (OAuth2 scopes, permissions) for the app's default install link. If provided, must be `null` (None in Python) to clear existing custom parameters.
max_participantsinteger
Maximum participants for an embedded application (activity). Minimum 1; absolute maximum depends on the activity.
custom_install_urlstringuri
Custom HTTPS URL for post-authorization redirection, bypassing default Discord screen.
description__defaultstring
The default description of the application.
interactions_endpoint_urlstringuri
HTTPS URL where Discord sends HTTP POST requests for interactions (e.g., slash commands, message components).
description__localizationsobject
Dictionary of [locale keys](https://discord.com/developers/docs/reference#locales) to localized descriptions.
role_connections_verification_urlstringuri
HTTPS URL for Discord to redirect users for role-linked verification when connecting their account.

Parámetros de salida

dataobjectObligatorio
The updated application object containing all its current properties.
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Modify guild member nicknameDISCORDBOT_UPDATE_MY_GUILD_MEMBERAcción

Modifies the nickname of the currently authenticated user within a specified discord guild.

Parámetros de entrada

nickstring
The new nickname for the user in the guild. Set to null or an empty string to remove the nickname. Max 32 characters.
guild_idstringObligatorio
The unique identifier of the Discord guild (server).

Parámetros de salida

dataobjectObligatorio
The updated guild member object reflecting the changes.
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Update current user profileDISCORDBOT_UPDATE_MY_USERAcción

Updates the current authenticated user's discord username and/or avatar.

Parámetros de entrada

avatarstring
Base64 encoded image data for the new avatar (e.g., 'data:image/jpeg;base64,BASE64_ENCODED_IMAGE_STRING'). Supported formats: JPG, PNG, GIF. **Caution:** If this field is omitted in the request to the action, its default value will instruct Discord to remove the user's current avatar. Provide new image data to set/update the avatar.
usernamestringObligatorio
The new username for the user. Must be 2-32 characters. Cannot contain '@', '#', ':', '', 'discord', or be 'everyone' or 'here'. Most Unicode characters are allowed. Changes are subject to Discord rate limits.

Parámetros de salida

dataobjectObligatorio
An object containing the updated user profile information.
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Patch webhook original messageDISCORDBOT_UPDATE_ORIGINAL_WEBHOOK_MESSAGEAcción

Updates the original editable message previously sent by a webhook, allowing partial modification of its content (max 2000 chars), embeds (max 10), attachments (kept by `id`, metadata updatable), components, allowed mentions, and flags.

Parámetros de entrada

flagsinteger
Integer value representing message flags combined as a bitfield. For example, flag `4` (SUPPRESS_EMBEDS). Consult Discord API for a list of message flag values.
embedsobject[]
An array of up to 10 embed objects to be displayed with the message. Send `null` or an empty list to remove all embeds.
contentstring
The new message content as a string (0-2000 characters). Send `null` or an empty string to remove existing content.
thread_idstring
If the message is part of a thread, this is the ID of the thread. Edits the message within that thread.
componentsobject[]
An array of message component objects (e.g., buttons, select menus). Send `null` or an empty list to remove components.
webhook_idstringObligatorio
The ID of the webhook executing this message update.
attachmentsobject[]
Array of attachment objects to be associated with the message. To keep an existing attachment, include its `id`. To update metadata of an attachment, include its `id` and new `filename` or `description`. Adding new files typically requires a multipart/form-data request, not solely this JSON body.
webhook_tokenstringObligatorio
The secure token for the webhook.
allowed_mentionsnull
Controls which mentions in the message content will actually ping users/roles. Structure defined by Discord API (allowed_mentions object).

Parámetros de salida

dataobjectObligatorio
A dictionary containing the updated message object on success, conforming to Discord's message object structure.
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Modify guild voice state for meDISCORDBOT_UPDATE_SELF_VOICE_STATEAcción

Updates the current user's voice state in a guild (e.g., mute, request to speak), and can explicitly disconnect the user from voice; this action does not support joining or switching voice channels.

Parámetros de entrada

guild_idstringObligatorio
The unique identifier of the Discord guild where the user's voice state is to be updated.
suppressboolean
Toggles the current user's audio suppression (mute) state in the guild. True to suppress (mute), False to unsuppress (unmute).
channel_idnull
Identifier of the voice channel. **Important: Due to the schema type `None`, this field will always be processed as null when sent to Discord, signaling a request to disconnect the user from their current voice channel.** It cannot be used to specify a channel to join.
request_to_speak_timestampstringdate-time
ISO8601 timestamp indicating when the user requests to speak. Used for Stage channels. Set to a future time to request to speak. Set to null or omit to revoke a request to speak.

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Patch guild voice stateDISCORDBOT_UPDATE_VOICE_STATEAcción

Updates a user's voice state in a discord guild, such as toggling server mute or disconnecting from a voice channel; requires `mute members` permission to change mute status or `move members` to disconnect.

Parámetros de entrada

user_idstringObligatorio
The ID of the user whose voice state is to be updated.
guild_idstringObligatorio
The ID of the Discord guild where the user's voice state will be updated.
suppressboolean
Toggles the user's server mute status. If not provided, the current suppression state is unchanged.
channel_idnull
Set to `null` to disconnect the user from their current voice channel. If omitted, the user's channel remains unchanged. Cannot be used to move to a new channel.

Parámetros de salida

dataobjectObligatorio
Response data from the API. This operation typically returns a 204 No Content status on success, so this field may be empty or not applicable in such cases.
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Update webhook details patchDISCORDBOT_UPDATE_WEBHOOKAcción

Updates properties (e.g., name, avatar, channel id) of an existing discord webhook; the webhook and any new channel (if specified) must exist, with the new channel being in the same server.

Parámetros de entrada

namestring
New default name for the webhook.
avatarstring
Data URI for the new webhook avatar image (e.g., `data:image/png;base64,iVBORw0KGgo...`). Send a literal `null` string to remove the avatar.
channel_idnull
ID of the new channel to associate with the webhook, effectively moving it.
webhook_idstringObligatorio
Unique identifier of the webhook to be updated.

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Update webhook name and avatarDISCORDBOT_UPDATE_WEBHOOK_BY_TOKENAcción

Updates the default name and/or avatar for an existing discord webhook, using its id and token.

Parámetros de entrada

namestring
The new default name for the webhook. If omitted, the name will not be changed.
avatarstring
Image data string for the new default webhook avatar (e.g., 'data:image/jpeg;base64,...'). If omitted, the avatar will not be changed.
webhook_idstringObligatorio
The ID of the webhook to update.
webhook_tokenstringObligatorio
The token of the webhook to update.

Parámetros de salida

dataobjectObligatorio
A dictionary containing the updated webhook object.
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Update discord message with webhookDISCORDBOT_UPDATE_WEBHOOK_MESSAGEAcción

Updates a message previously sent by the *same* webhook, allowing partial modification of content, embeds, attachments, or components; will not edit user/bot messages.

Parámetros de entrada

flagsinteger
Message flags (bitfield). `SUPPRESS_EMBEDS` (4) is modifiable by default.
embedsobject[]
Up to 10 embed objects; replaces existing embeds.
contentstring
New message text (max 2000 chars). Empty string removes content; `None` leaves unchanged.
thread_idstring
ID of the target thread; webhook must have send permissions if specified.
componentsobject[]
Message components (e.g., buttons); replaces existing. Max 5 action rows with component limits.
message_idstringObligatorio
ID of the message to update (path parameter).
webhook_idstringObligatorio
Webhook ID (path parameter).
attachmentsobject[]
Attachments to keep/update. Must include existing `id`. Unlisted original attachments are removed. New files require separate upload and new ID reference.
webhook_tokenstringObligatorio
Webhook token (path parameter).
allowed_mentionsnull
Controls pings for roles/users. Refer to Discord API for structure.

Parámetros de salida

dataobjectObligatorio
The updated Discord message object.
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not