Discordbot

Learn how to use Discordbot with Composio

Overview

Enum

DISCORDBOT

Description

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

Authentication Details

client_id
stringRequired
client_secret
stringRequired
oauth_redirect_uri
stringDefaults to https://backend.composio.dev/api/v1/auth-apps/add
scopes
stringDefaults to identify,email,bot,messages.read
permissions
stringDefaults to 8Required
bot_token
stringRequired
token
stringRequired
bot_token
stringRequired

Actions

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

Action Parameters

access_token
string
channel_id
stringRequired
nick
string
user_id
stringRequired

Action Response

data
object
error
successful
boolean
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.

Action Parameters

access_token
stringRequired
deaf
boolean
flags
integer
guild_id
stringRequired
mute
boolean
nick
string
roles
array
user_id
stringRequired

Action Response

data
object
error
successful
boolean
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.

Action Parameters

guild_id
stringRequired
role_id
stringRequired
user_id
stringRequired

Action Response

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

Action Parameters

channel_id
stringRequired
emoji_name
stringRequired
message_id
stringRequired

Action Response

data
object
error
successful
boolean
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.

Action Parameters

channel_id
stringRequired
user_id
stringRequired

Action Response

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

Action Parameters

delete_message_days
integer
delete_message_seconds
integer
guild_id
stringRequired
user_id
stringRequired

Action Response

data
object
error
successful
boolean
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.

Action Parameters

delete_message_seconds
integer
guild_id
stringRequired
user_ids
arrayRequired

Action Response

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

Action Parameters

channel_id
stringRequired
messages
arrayRequired

Action Response

data
object
error
successful
boolean
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.

Action Parameters

application_id
stringRequired
default_member_permissions
integer
description
string
description_localizations
object
dm_permission
boolean
name
stringRequired
name_localizations
object
options
array
type
null

Action Response

data
object
error
successful
boolean
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).

Action Parameters

guild_id
stringRequired

Action Response

data
object
error
successful
boolean
Creates a new invite for the specified discord channel, provided the bot has 'create instant invite' permission for that channel.

Action Parameters

channel_id
stringRequired

Action Response

data
object
error
successful
boolean
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.

Action Parameters

access_tokens
array
nicks
object
recipient_id
null

Action Response

data
object
error
successful
boolean
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.

Action Parameters

afk_channel_id
null
afk_timeout
null
channels
array
default_message_notifications
null
description
string
explicit_content_filter
null
icon
string
name
stringRequired
preferred_locale
null
region
string
roles
array
system_channel_flags
integer
system_channel_id
null
verification_level
null

Action Response

data
object
error
successful
boolean
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.

Action Parameters

application_id
stringRequired
default_member_permissions
integer
description
string
description_localizations
object
dm_permission
boolean
guild_id
stringRequired
name
stringRequired
name_localizations
object
options
array
type
null

Action Response

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

Action Parameters

available_tags
array
bitrate
integer
default_auto_archive_duration
integer
default_forum_layout
integer
default_reaction_emoji
string
default_sort_order
integer
default_thread_rate_limit_per_user
integer
guild_id
stringRequired
name
stringRequired
nsfw
boolean
parent_id
string
permission_overwrites
array
position
integer
rate_limit_per_user
integer
rtc_region
string
topic
string
type
integer
user_limit
integer
video_quality_mode
integer

Action Response

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

Action Parameters

guild_id
stringRequired
image
stringRequired
name
stringRequired
roles
array

Action Response

data
object
error
successful
boolean
Creates a new discord guild by applying channels, roles, and settings from a specified, valid, and accessible guild template code.

Action Parameters

code
stringRequired
icon
string
name
stringRequired

Action Response

data
object
error
successful
boolean
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.

Action Parameters

color
integer
guild_id
stringRequired
hoist
boolean
icon
string
mentionable
boolean
name
string
permissions
integer
unicode_emoji
string

Action Response

data
object
error
successful
boolean
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`.

Action Parameters

guild_id
stringRequired

Action Response

data
object
error
successful
boolean
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.

Action Parameters

description
string
file
string
guild_id
stringRequired
name
string
tags
string

Action Response

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

Action Parameters

description
string
guild_id
stringRequired
name
stringRequired

Action Response

data
object
error
successful
boolean
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.

Action Parameters

interaction_id
stringRequired
interaction_token
stringRequired

Action Response

data
object
error
successful
boolean
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`.

Action Parameters

allowed_mentions
null
attachments
array
channel_id
stringRequired
components
array
content
string
embeds
array
flags
integer
message_reference
null
nonce
integer
sticker_ids
array
tts
boolean

Action Response

data
object
error
successful
boolean
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.

Action Parameters

channel_id
stringRequired
guild_scheduled_event_id
null
privacy_level
null
send_start_notification
boolean
topic
stringRequired

Action Response

data
object
error
successful
boolean
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.

Action Parameters

channel_id
stringRequired

Action Response

data
object
error
successful
boolean
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).

Action Parameters

auto_archive_duration
null
channel_id
stringRequired
message_id
stringRequired
name
stringRequired
rate_limit_per_user
integer

Action Response

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

Action Parameters

avatar
string
channel_id
stringRequired
name
stringRequired

Action Response

data
object
error
successful
boolean
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.

Action Parameters

channel_id
stringRequired
message_id
stringRequired

Action Response

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

Action Parameters

channel_id
stringRequired
message_id
stringRequired

Action Response

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

Action Parameters

channel_id
stringRequired
emoji_name
stringRequired
message_id
stringRequired

Action Response

data
object
error
successful
boolean
Permanently deletes a specific application command; this action is irreversible.

Action Parameters

application_id
stringRequired
command_id
stringRequired

Action Response

data
object
error
successful
boolean
Deletes a specific auto-moderation rule from a discord guild.

Action Parameters

guild_id
stringRequired
rule_id
stringRequired

Action Response

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

Action Parameters

channel_id
stringRequired

Action Response

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

Action Parameters

channel_id
stringRequired
overwrite_id
stringRequired

Action Response

data
object
error
successful
boolean
Permanently removes a user from an accessible discord group dm channel, revoking their access.

Action Parameters

channel_id
stringRequired
user_id
stringRequired

Action Response

data
object
error
successful
boolean
Permanently deletes a specified discord guild (server); the authenticated user must be the owner of the guild.

Action Parameters

guild_id
stringRequired

Action Response

data
object
error
successful
boolean
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.

Action Parameters

application_id
stringRequired
command_id
stringRequired
guild_id
stringRequired

Action Response

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

Action Parameters

emoji_id
stringRequired
guild_id
stringRequired

Action Response

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

Action Parameters

guild_id
stringRequired
integration_id
stringRequired

Action Response

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

Action Parameters

guild_id
stringRequired
user_id
stringRequired

Action Response

data
object
error
successful
boolean
Removes a specified role from a member of a discord guild, provided the member currently possesses that role.

Action Parameters

guild_id
stringRequired
role_id
stringRequired
user_id
stringRequired

Action Response

data
object
error
successful
boolean
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.

Action Parameters

guild_id
stringRequired
role_id
stringRequired

Action Response

data
object
error
successful
boolean
Permanently deletes a specific scheduled event from a discord guild; this action is irreversible.

Action Parameters

guild_id
stringRequired
guild_scheduled_event_id
stringRequired

Action Response

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

Action Parameters

guild_id
stringRequired
sticker_id
stringRequired

Action Response

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

Action Parameters

code
stringRequired
guild_id
stringRequired

Action Response

data
object
error
successful
boolean
Permanently and irreversibly deletes a message from a specified discord channel.

Action Parameters

channel_id
stringRequired
message_id
stringRequired

Action Response

data
object
error
successful
boolean
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.

Action Parameters

channel_id
stringRequired
emoji_name
stringRequired
message_id
stringRequired

Action Response

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

Action Parameters

thread_id
string
webhook_id
stringRequired
webhook_token
stringRequired

Action Response

data
object
error
successful
boolean
Deletes the stage instance for the given `channel id`, permanently ending its live audio event.

Action Parameters

channel_id
stringRequired

Action Response

data
object
error
successful
boolean
Removes a user from a specified, unarchived thread in a discord channel.

Action Parameters

channel_id
stringRequired
user_id
stringRequired

Action Response

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

Action Parameters

channel_id
stringRequired
emoji_name
stringRequired
message_id
stringRequired
user_id
stringRequired

Action Response

data
object
error
successful
boolean
Permanently deletes a specified, existing discord webhook by its unique id; this action is irreversible.

Action Parameters

webhook_id
stringRequired

Action Response

data
object
error
successful
boolean
Permanently deletes a discord webhook specified by its id and token; this action is irreversible.

Action Parameters

webhook_id
stringRequired
webhook_token
stringRequired

Action Response

data
object
error
successful
boolean
Deletes a message previously sent by the specified webhook, optionally within a specific thread.

Action Parameters

message_id
stringRequired
thread_id
string
webhook_id
stringRequired
webhook_token
stringRequired

Action Response

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

Action Parameters

action
string
answer
null
check_run
null
check_suite
null
comment
null
commits
array
compare
string
discussion
null
forced
boolean
forkee
null
head_commit
null
issue
null
member
null
pull_request
null
ref
string
ref_type
string
release
null
repository
null
review
null
sender__avatar__url
string
sender__html__url
string
sender__id
integer
sender__login
string
thread_id
string
wait
boolean
webhook_id
stringRequired
webhook_token
stringRequired

Action Response

data
object
error
successful
boolean
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.

Action Parameters

attachments
array
icon_url
string
text
string
thread_id
string
username
string
wait
boolean
webhook_id
stringRequired
webhook_token
stringRequired

Action Response

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

Action Parameters

thread_id
string
wait
boolean
webhook_id
stringRequired
webhook_token
stringRequired

Action Response

data
object
error
successful
boolean
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.

Action Parameters

channel_id
stringRequired
webhook_channel_id
stringRequired

Action Response

data
object
error
successful
boolean
Retrieves all currently active and visible threads within a specified discord guild, excluding archived or hidden threads.

Action Parameters

guild_id
stringRequired

Action Response

data
object
error
successful
boolean
Retrieves the full details of a discord application using its unique `application id`.

Action Parameters

application_id
stringRequired

Action Response

data
object
error
successful
boolean
Fetches the details of a specific, existing application command, identified by its application snowflake id and command snowflake id.

Action Parameters

application_id
stringRequired
command_id
stringRequired

Action Response

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

Action Parameters

application_id
stringRequired

Action Response

data
array
error
successful
boolean
Fetches the role connection object for the current user for a specified discord application.

Action Parameters

application_id
stringRequired

Action Response

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

Action Parameters

guild_id
stringRequired
rule_id
stringRequired

Action Response

data
object
error
successful
boolean
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.

Action Parameters

Action Response

data
object
error
successful
boolean
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.

Action Parameters

channel_id
stringRequired

Action Response

data
object
error
successful
boolean
Retrieves the websocket url to connect to discord's gateway for receiving real-time events.

Action Parameters

Action Response

data
object
error
successful
boolean
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.

Action Parameters

guild_id
stringRequired
with_counts
boolean

Action Response

data
object
error
successful
boolean
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.

Action Parameters

guild_id
stringRequired

Action Response

data
object
error
successful
boolean
Fetches detailed information for a specific application command within a discord guild, identified by `application id`, `guild id`, and `command id`.

Action Parameters

application_id
stringRequired
command_id
stringRequired
guild_id
stringRequired

Action Response

data
object
error
successful
boolean
Fetches the permissions for a specific application command within a guild, used to inspect its current access settings.

Action Parameters

application_id
stringRequired
command_id
stringRequired
guild_id
stringRequired

Action Response

data
object
error
successful
boolean
Fetches the ban details for a specific user in a discord guild, if that user is currently banned.

Action Parameters

guild_id
stringRequired
user_id
stringRequired

Action Response

data
object
error
successful
boolean
Retrieves details for a specific custom emoji within a specified discord guild, requiring valid and accessible guild and emoji ids.

Action Parameters

emoji_id
stringRequired
guild_id
stringRequired

Action Response

data
object
error
successful
boolean
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).

Action Parameters

guild_id
stringRequired
user_id
stringRequired

Action Response

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

Action Parameters

guild_id
stringRequired

Action Response

data
object
error
successful
boolean
Fetches a public preview of a discord guild by its id, if the guild has the preview feature enabled.

Action Parameters

guild_id
stringRequired

Action Response

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

Action Parameters

guild_id
stringRequired
guild_scheduled_event_id
stringRequired
with_user_count
boolean

Action Response

data
object
error
successful
boolean
Retrieves a specific sticker from a discord guild using the guild and sticker ids; requires the sticker to exist in the guild.

Action Parameters

guild_id
stringRequired
sticker_id
stringRequired

Action Response

data
object
error
successful
boolean
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.

Action Parameters

code
stringRequired

Action Response

data
object
error
successful
boolean
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.

Action Parameters

guild_id
stringRequired

Action Response

data
object
error
successful
boolean
Retrieves all webhook objects for a specified discord guild; requires 'manage webhooks' permission for the authenticated entity.

Action Parameters

guild_id
stringRequired

Action Response

data
array
error
successful
boolean
Retrieves the configured welcome screen for a specific discord guild that has the 'community' feature enabled.

Action Parameters

guild_id
stringRequired

Action Response

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

Action Parameters

guild_id
stringRequired

Action Response

data
object
error
successful
boolean
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`.

Action Parameters

guild_id
stringRequired

Action Response

data
object
error
successful
boolean
Retrieves a specific message from a discord channel, identified by `channel id` and `message id`, if the channel and message exist and are accessible.

Action Parameters

channel_id
stringRequired
message_id
stringRequired

Action Response

data
object
error
successful
boolean
Retrieves detailed information about the current authenticated discord application.

Action Parameters

Action Response

data
object
error
successful
boolean
Retrieves detailed information about the oauth2 application associated with the current authentication; cannot query other applications.

Action Parameters

Action Response

data
object
error
successful
boolean
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.

Action Parameters

thread_id
string
webhook_id
stringRequired
webhook_token
stringRequired

Action Response

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

Action Parameters

Action Response

data
object
error
successful
boolean
Gets the active stage instance for a given stage channel id.

Action Parameters

channel_id
stringRequired

Action Response

data
object
error
successful
boolean
Retrieves a specific discord sticker by its unique id.

Action Parameters

sticker_id
stringRequired

Action Response

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

Action Parameters

channel_id
stringRequired
user_id
stringRequired
with_member
boolean

Action Response

data
object
error
successful
boolean
Fetches public information for a discord user, requiring a valid and existing user id (snowflake).

Action Parameters

user_id
stringRequired

Action Response

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

Action Parameters

webhook_id
stringRequired

Action Response

data
object
error
successful
boolean
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.

Action Parameters

webhook_id
stringRequired
webhook_token
stringRequired

Action Response

data
object
error
successful
boolean
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.

Action Parameters

message_id
stringRequired
thread_id
string
webhook_id
stringRequired
webhook_token
stringRequired

Action Response

data
object
error
successful
boolean
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.

Action Parameters

code
stringRequired
guild_scheduled_event_id
string
with_counts
boolean

Action Response

data
object
error
successful
boolean
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.

Action Parameters

code
stringRequired

Action Response

data
object
error
successful
boolean
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.

Action Parameters

channel_id
stringRequired

Action Response

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

Action Parameters

guild_id
stringRequired

Action Response

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

Action Parameters

channel_id
stringRequired

Action Response

data
object
error
successful
boolean
Fetches all global application commands for the specified discord application id; does not fetch guild-specific commands.

Action Parameters

application_id
stringRequired
with_localizations
boolean

Action Response

data
array
error
successful
boolean
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.

Action Parameters

guild_id
stringRequired

Action Response

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

Action Parameters

channel_id
stringRequired

Action Response

data
array
error
successful
boolean
Fetches detailed information for all webhooks in a given valid discord channel, useful for review or auditing purposes.

Action Parameters

channel_id
stringRequired

Action Response

data
array
error
successful
boolean
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.

Action Parameters

application_id
stringRequired
guild_id
stringRequired
with_localizations
boolean

Action Response

data
array
error
successful
boolean
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.

Action Parameters

application_id
stringRequired
guild_id
stringRequired

Action Response

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

Action Parameters

action_type
integer
after
string
before
string
guild_id
stringRequired
limit
integer
target_id
string
user_id
string

Action Response

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

Action Parameters

after
string
before
string
guild_id
stringRequired
limit
integer

Action Response

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

Action Parameters

guild_id
stringRequired

Action Response

data
array
error
successful
boolean
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.

Action Parameters

guild_id
stringRequired

Action Response

data
array
error
successful
boolean
Lists all integration objects for a specified discord guild.

Action Parameters

guild_id
stringRequired

Action Response

data
array
error
successful
boolean
Retrieves all currently active invite codes for a specified discord guild, typically for administration, analytics, or managing guild invitations.

Action Parameters

guild_id
stringRequired

Action Response

data
array
error
successful
boolean
Retrieves members for a discord guild; requires a valid guild id for an existing guild.

Action Parameters

after
integer
guild_id
stringRequired
limit
integer

Action Response

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

Action Parameters

guild_id
stringRequired

Action Response

data
array
error
successful
boolean
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.

Action Parameters

guild_id
stringRequired
with_user_count
boolean

Action Response

data
array
error
successful
boolean
Fetches users who have expressed interest in a specific scheduled event, requiring valid guild and event ids.

Action Parameters

after
string
before
string
guild_id
stringRequired
guild_scheduled_event_id
stringRequired
limit
integer
with_member
boolean

Action Response

data
array
error
successful
boolean
Retrieves all custom sticker objects for a discord guild; does not include standard/nitro stickers.

Action Parameters

guild_id
stringRequired

Action Response

data
array
error
successful
boolean
Retrieves all guild templates for an existing discord guild, specified by its id.

Action Parameters

guild_id
stringRequired

Action Response

data
array
error
successful
boolean
Fetches a list of available voice regions for a specified discord guild.

Action Parameters

guild_id
stringRequired

Action Response

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

Action Parameters

after
string
around
string
before
string
channel_id
stringRequired
limit
integer

Action Response

data
object
error
successful
boolean
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.

Action Parameters

after
string
channel_id
stringRequired
emoji_name
stringRequired
limit
integer
message_id
stringRequired

Action Response

data
array
error
successful
boolean
Retrieves private archived threads from a specified channel that the current user is a member of.

Action Parameters

before
string
channel_id
stringRequired
limit
integer

Action Response

data
object
error
successful
boolean
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.

Action Parameters

channel_id
stringRequired

Action Response

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

Action Parameters

before
string
channel_id
stringRequired
limit
integer

Action Response

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

Action Parameters

before
string
channel_id
stringRequired
limit
integer

Action Response

data
object
error
successful
boolean
Fetches sticker packs available to nitro subscribers on discord, excluding custom or guild-specific ones.

Action Parameters

Action Response

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

Action Parameters

after
string
channel_id
stringRequired
limit
integer
with_member
boolean

Action Response

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

Action Parameters

Action Response

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

Action Parameters

channel_id
stringRequired
message_id
stringRequired

Action Response

data
object
error
successful
boolean
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.

Action Parameters

days
integer
guild_id
stringRequired
include_roles
array

Action Response

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

Action Parameters

compute_prune_count
boolean
days
integer
guild_id
stringRequired
include_roles
array

Action Response

data
object
error
successful
boolean
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.

Action Parameters

default_channel_ids
array
enabled
boolean
guild_id
stringRequired
mode
null
prompts
array

Action Response

data
object
error
successful
boolean
Searches for members in a specific discord guild, allowing filtering by a query string.

Action Parameters

guild_id
stringRequired
limit
integerRequired
query
stringRequired

Action Response

data
array
error
successful
boolean
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.

Action Parameters

allow
integer
channel_id
stringRequired
deny
integer
overwrite_id
stringRequired
type
integerRequired

Action Response

data
object
error
successful
boolean
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.

Action Parameters

code
stringRequired
guild_id
stringRequired

Action Response

data
object
error
successful
boolean
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.

Action Parameters

channel_id
stringRequired

Action Response

data
object
error
successful
boolean
Revokes a ban for a user from a discord guild, allowing them to rejoin if they choose.

Action Parameters

guild_id
stringRequired
user_id
stringRequired

Action Response

data
object
error
successful
boolean
Unpins a message that is currently pinned in a specified discord channel; the message itself is not deleted.

Action Parameters

channel_id
stringRequired
message_id
stringRequired

Action Response

data
object
error
successful
boolean
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.

Action Parameters

application_id
stringRequired
cover_image
string
custom_install_url
string
description__default
string
description__localizations
object
flags
integer
icon
string
install_params
null
interactions_endpoint_url
string
max_participants
integer
role_connections_verification_url
string
tags
array
team_id
null
type
null

Action Response

data
object
error
successful
boolean
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.

Action Parameters

application_id
stringRequired
command_id
stringRequired
default_member_permissions
integer
description
string
description_localizations
object
dm_permission
boolean
name
string
name_localizations
object
options
array

Action Response

data
object
error
successful
boolean
Updates the authorized user's role connection for a specific application, which must have a linked role connection configured.

Action Parameters

application_id
stringRequired
metadata
object
platform_name
string
platform_username
string

Action Response

data
object
error
successful
boolean
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.

Action Parameters

guild_id
stringRequired
rule_id
stringRequired

Action Response

data
object
error
successful
boolean
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.

Action Parameters

channel_id
stringRequired

Action Response

data
object
error
successful
boolean
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'.

Action Parameters

afk_channel_id
null
afk_timeout
null
banner
string
default_message_notifications
null
description
string
discovery_splash
string
explicit_content_filter
null
features
array
guild_id
stringRequired
home_header
string
icon
string
name
string
owner_id
string
preferred_locale
null
premium_progress_bar_enabled
boolean
public_updates_channel_id
null
region
string
rules_channel_id
null
safety_alerts_channel_id
null
splash
string
system_channel_flags
integer
system_channel_id
null
verification_level
null

Action Response

data
object
error
successful
boolean
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.

Action Parameters

application_id
stringRequired
command_id
stringRequired
default_member_permissions
integer
description
string
description_localizations
object
dm_permission
boolean
guild_id
stringRequired
name
string
name_localizations
object
options
array

Action Response

data
object
error
successful
boolean
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.

Action Parameters

emoji_id
stringRequired
guild_id
stringRequired
name
string
roles
array

Action Response

data
object
error
successful
boolean
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.

Action Parameters

channel_id
null
communication_disabled_until
string
deaf
boolean
flags
integer
guild_id
stringRequired
mute
boolean
nick
string
roles
array
user_id
stringRequired

Action Response

data
object
error
successful
boolean
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.

Action Parameters

color
integer
guild_id
stringRequired
hoist
boolean
icon
string
mentionable
boolean
name
string
permissions
integer
role_id
stringRequired
unicode_emoji
string

Action Response

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

Action Parameters

guild_id
stringRequired
guild_scheduled_event_id
stringRequired

Action Response

data
object
error
successful
boolean
Modifies a guild sticker's name, description, or tags, requiring 'manage emojis and stickers' permission.

Action Parameters

description
string
guild_id
stringRequired
name
string
sticker_id
stringRequired
tags
string

Action Response

data
object
error
successful
boolean
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.

Action Parameters

code
stringRequired
description
string
guild_id
stringRequired
name
string

Action Response

data
object
error
successful
boolean
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.

Action Parameters

description
string
enabled
boolean
guild_id
stringRequired
welcome_channels
array

Action Response

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

Action Parameters

channel_id
null
enabled
boolean
guild_id
stringRequired

Action Response

data
object
error
successful
boolean
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.

Action Parameters

allowed_mentions
null
attachments
array
channel_id
stringRequired
components
array
content
string
embeds
array
flags
integer
message_id
stringRequired
sticker_ids
array

Action Response

data
object
error
successful
boolean
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.

Action Parameters

cover_image
string
custom_install_url
string
description__default
string
description__localizations
object
flags
integer
icon
string
install_params
null
interactions_endpoint_url
string
max_participants
integer
role_connections_verification_url
string
tags
array
team_id
null
type
null

Action Response

data
object
error
successful
boolean
Modifies the nickname of the currently authenticated user within a specified discord guild.

Action Parameters

guild_id
stringRequired
nick
string

Action Response

data
object
error
successful
boolean
Updates the current authenticated user's discord username and/or avatar.

Action Parameters

avatar
string
username
stringRequired

Action Response

data
object
error
successful
boolean
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.

Action Parameters

allowed_mentions
null
attachments
array
components
array
content
string
embeds
array
flags
integer
thread_id
string
webhook_id
stringRequired
webhook_token
stringRequired

Action Response

data
object
error
successful
boolean
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.

Action Parameters

channel_id
null
guild_id
stringRequired
request_to_speak_timestamp
string
suppress
boolean

Action Response

data
object
error
successful
boolean
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.

Action Parameters

channel_id
null
guild_id
stringRequired
suppress
boolean
user_id
stringRequired

Action Response

data
object
error
successful
boolean
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.

Action Parameters

avatar
string
channel_id
null
name
string
webhook_id
stringRequired

Action Response

data
object
error
successful
boolean
Updates the default name and/or avatar for an existing discord webhook, using its id and token.

Action Parameters

avatar
string
name
string
webhook_id
stringRequired
webhook_token
stringRequired

Action Response

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

Action Parameters

allowed_mentions
null
attachments
array
components
array
content
string
embeds
array
flags
integer
message_id
stringRequired
thread_id
string
webhook_id
stringRequired
webhook_token
stringRequired

Action Response

data
object
error
successful
boolean