Passa al contenuto principale

Channels

Actions in the category "Channels".

Update channel name​

Renames a channel on your server.

Required permissions: Manage channels.

Inputs

NameTypeRequiredDetails
ChannelServer channelYesChannel to rename.
New nameTextYesNew name for the channel (1 - 100 characters). Length: 1 to 100 characters.
Audit log reasonTextNoReason recorded in the audit log. Maximum length: 512 characters.

Outputs

NameTypeDetails
Updated channelServer channelThe channel after the rename.

Create channel​

Creates a new channel on a server.

Required permissions: Manage channels.

Inputs

NameTypeRequiredDetails
NameTextYesName of the new channel. Length: 1 to 100 characters.
TypeChannel typeYesKind of channel to create. Allowed values: Text channel, Announcement channel, Voice channel, Stage channel, Category, Forum channel, Media channel. Default: Text channel.
CategoryCategoryNoCategory to place the channel in. Shown when Type is Text channel, Announcement channel, Voice channel, Stage channel, Forum channel, Media channel.
TopicTextNoChannel topic (text-like channels only). Maximum length: 1024 characters. Shown when Type is Text channel, Announcement channel, Forum channel, Media channel.
NSFWYes/NoYesMark the channel age-restricted. Default: No. Shown when Type is Text channel, Announcement channel, Voice channel, Forum channel, Media channel.
SlowmodeDurationNoSlowmode duration (text-like channels only). Value: 0 to 21600000. Shown when Type is Text channel, Announcement channel, Forum channel, Media channel.
BitrateWhole numberNoVoice bitrate (voice channels only). Value: 8000 to 384000. Shown when Type is Voice channel, Stage channel.
User limitWhole numberNoMaximum users (voice channel only). Value: 0 to 99. Shown when Type is.
Audit log reasonTextNoReason recorded in the audit log. Maximum length: 512 characters.

Outputs

NameTypeDetails
Created channelServer channelThe newly created channel.

Delete channel​

Deletes a channel from your server.

Required permissions: Manage channels.

Inputs

NameTypeRequiredDetails
ChannelServer channelYesChannel to delete.
Audit log reasonTextNoReason recorded in the audit log. Maximum length: 512 characters.

Create text channel​

Create a new text channel in a server.

Required permissions: Manage channels.

Inputs

NameTypeRequiredDetails
NameTextYesName for the new channel (1-100 characters). Length: 1 to 100 characters.
TopicTextNoOptional topic shown above the channel. Maximum length: 1024 characters.
Parent CategoryCategoryNoCategory that will contain this channel.
PositionWhole numberNoSort position of the channel within its parent. Minimum: 0.
NSFWYes/NoNoMark the channel as age-restricted. Default: No.
Slowmode (Seconds)Whole numberNoPer-user slowmode delay in seconds (0-21600). Value: 0 to 21600.
Default Auto ArchiveAuto archive durationNoDefault auto-archive duration for threads created here.
Default Thread SlowmodeWhole numberNoDefault slowmode applied to new threads. Value: 0 to 21600.
Permission OverwritesList of Permission overwriteNoInitial permission overwrites for the channel.
Audit Log ReasonTextNoReason recorded in the audit log. Maximum length: 512 characters.

Outputs

NameTypeDetails
ChannelText channelThe text channel that was created.

Create announcement channel​

Create a new announcement channel that can be followed by other servers.

Required permissions: Manage channels.

Inputs

NameTypeRequiredDetails
NameTextYesName for the new channel. Length: 1 to 100 characters.
TopicTextNoOptional channel topic. Maximum length: 1024 characters.
Parent CategoryCategoryNoCategory that will contain this channel.
PositionWhole numberNoSort position within the parent. Minimum: 0.
NSFWYes/NoNoMark the channel as age-restricted. Default: No.
Default Auto ArchiveAuto archive durationNoDefault auto-archive duration for threads.
Permission OverwritesList of Permission overwriteNoInitial permission overwrites.
Audit Log ReasonTextNoReason recorded in the audit log. Maximum length: 512 characters.

Outputs

NameTypeDetails
ChannelAnnouncement channelThe announcement channel that was created.

Create voice channel​

Create a new voice channel in a server.

Required permissions: Manage channels.

Inputs

NameTypeRequiredDetails
NameTextYesName for the new channel. Length: 1 to 100 characters.
Parent CategoryCategoryNoCategory that will contain this channel.
PositionWhole numberNoSort position within the parent. Minimum: 0.
BitrateWhole numberNoAudio bitrate in bits per second (8000-384000). Value: 8000 to 384000.
User LimitWhole numberNoMaximum users allowed at once (0 for unlimited, max 99). Value: 0 to 99.
Voice RegionTextNoOverride the automatic voice region (leave empty for automatic).
Video Quality ModeVideo quality modeNoCamera video quality mode.
NSFWYes/NoNoMark the channel as age-restricted. Default: No.
Slowmode (Seconds)Whole numberNoSlowmode for the chat tied to this voice channel. Value: 0 to 21600.
Permission OverwritesList of Permission overwriteNoInitial permission overwrites.
Audit Log ReasonTextNoReason recorded in the audit log. Maximum length: 512 characters.

Outputs

NameTypeDetails
ChannelVoice channelThe voice channel that was created.

Create stage channel​

Create a new stage channel for moderated audio events.

Required permissions: Manage channels.

Inputs

NameTypeRequiredDetails
NameTextYesName for the new channel. Length: 1 to 100 characters.
TopicTextNoOptional topic for the stage. Maximum length: 1024 characters.
Parent CategoryCategoryNoCategory that will contain this channel.
PositionWhole numberNoSort position within the parent. Minimum: 0.
BitrateWhole numberNoAudio bitrate in bits per second (8000-64000). Value: 8000 to 64000.
User LimitWhole numberNoMaximum number of attendees (0 for unlimited). Value: 0 to 10000.
Voice RegionTextNoOverride the automatic voice region.
Permission OverwritesList of Permission overwriteNoInitial permission overwrites.
Audit Log ReasonTextNoReason recorded in the audit log. Maximum length: 512 characters.

Outputs

NameTypeDetails
ChannelStage channelThe stage channel that was created.

Create category channel​

Create a new category that can group other channels.

Required permissions: Manage channels.

Inputs

NameTypeRequiredDetails
NameTextYesName for the new category. Length: 1 to 100 characters.
PositionWhole numberNoSort position of the category. Minimum: 0.
Permission OverwritesList of Permission overwriteNoInitial permission overwrites.
Audit Log ReasonTextNoReason recorded in the audit log. Maximum length: 512 characters.

Outputs

NameTypeDetails
CategoryCategoryThe category that was created.

Create forum channel​

Create a new forum channel for organized post-style discussions.

Required permissions: Manage channels.

Inputs

NameTypeRequiredDetails
NameTextYesName for the new channel. Length: 1 to 100 characters.
GuidelinesTextNoChannel topic shown as posting guidelines. Maximum length: 4096 characters.
Parent CategoryCategoryNoCategory that will contain this channel.
PositionWhole numberNoSort position within the parent. Minimum: 0.
NSFWYes/NoNoMark the channel as age-restricted. Default: No.
Post SlowmodeWhole numberNoSlowmode applied to creating new posts. Value: 0 to 21600.
Default Auto ArchiveAuto archive durationNoDefault auto-archive duration for posts.
Default Post SlowmodeWhole numberNoDefault per-message slowmode inside posts. Value: 0 to 21600.
Default Sort OrderSort orderNoDefault ordering of posts.
Default LayoutForum layoutNoDefault visual layout for the forum.
Default ReactionDefault reactionNoDefault reaction emoji shown on each post.
Available TagsList of Forum tagNoTags that can be applied to posts in this forum.
Permission OverwritesList of Permission overwriteNoInitial permission overwrites.
Audit Log ReasonTextNoReason recorded in the audit log. Maximum length: 512 characters.

Outputs

NameTypeDetails
ChannelForum channelThe forum channel that was created.

Create media channel​

Create a new media channel optimized for image and video posts.

Required permissions: Manage channels.

Inputs

NameTypeRequiredDetails
NameTextYesName for the new channel. Length: 1 to 100 characters.
GuidelinesTextNoChannel topic shown as posting guidelines. Maximum length: 4096 characters.
Parent CategoryCategoryNoCategory that will contain this channel.
PositionWhole numberNoSort position within the parent. Minimum: 0.
NSFWYes/NoNoMark the channel as age-restricted. Default: No.
Post SlowmodeWhole numberNoSlowmode applied to creating new posts. Value: 0 to 21600.
Default Auto ArchiveAuto archive durationNoDefault auto-archive duration for posts.
Default Post SlowmodeWhole numberNoDefault per-message slowmode inside posts. Value: 0 to 21600.
Default Sort OrderSort orderNoDefault ordering of posts.
Default ReactionDefault reactionNoDefault reaction emoji shown on each post.
Available TagsList of Forum tagNoTags that can be applied to posts.
Permission OverwritesList of Permission overwriteNoInitial permission overwrites.
Audit Log ReasonTextNoReason recorded in the audit log. Maximum length: 512 characters.

Outputs

NameTypeDetails
ChannelMedia channelThe media channel that was created.

Update channel topic​

Change a channel's topic text.

Required permissions: Manage channels.

Inputs

NameTypeRequiredDetails
ChannelServer channelYesChannel to update.
New TopicTextNoNew topic text. Leave empty to clear. Maximum length: 4096 characters.
Audit Log ReasonTextNoReason recorded in the audit log. Maximum length: 512 characters.

Outputs

NameTypeDetails
ChannelServer channelThe updated channel.

Update channel position​

Move a channel to a new position in its parent or server.

Required permissions: Manage channels.

Inputs

NameTypeRequiredDetails
ChannelServer channelYesChannel to move.
New PositionWhole numberYesZero-based target position. Minimum: 0.
Lock PermissionsYes/NoNoSync permissions with the new parent category if any. Default: No.
Audit Log ReasonTextNoReason recorded in the audit log. Maximum length: 512 characters.

Outputs

NameTypeDetails
ChannelServer channelThe updated channel.

Update channel parent​

Move a channel into a different category, or remove it from any category.

Required permissions: Manage channels.

Inputs

NameTypeRequiredDetails
ChannelServer channelYesChannel to move.
New Parent CategoryCategoryNoTarget category. Leave empty to remove from any category.
Lock PermissionsYes/NoNoSync permissions with the new parent category. Default: No.
Audit Log ReasonTextNoReason recorded in the audit log. Maximum length: 512 characters.

Outputs

NameTypeDetails
ChannelServer channelThe updated channel.

Update channel NSFW flag​

Toggle whether a channel is marked as age-restricted (NSFW).

Required permissions: Manage channels.

Inputs

NameTypeRequiredDetails
ChannelServer channelYesChannel to update.
NSFWYes/NoYesTrue to mark as NSFW, false to unmark. Default: No.
Audit Log ReasonTextNoReason recorded in the audit log. Maximum length: 512 characters.

Outputs

NameTypeDetails
ChannelServer channelThe updated channel.

Update channel slowmode​

Change the per-user slowmode of a text-like channel.

Required permissions: Manage channels.

Inputs

NameTypeRequiredDetails
ChannelServer channelYesChannel to update.
Slowmode (Seconds)Whole numberYesPer-user delay in seconds (0-21600). Value: 0 to 21600.
Audit Log ReasonTextNoReason recorded in the audit log. Maximum length: 512 characters.

Outputs

NameTypeDetails
ChannelServer channelThe updated channel.

Fetch channel slowmode​

Reads the per-user slowmode currently set on a channel.

Inputs

NameTypeRequiredDetails
ChannelServer channelYesChannel to read the slowmode of.

Outputs

NameTypeDetails
SlowmodeWhole numberPer-user slowmode in seconds (0 when slowmode is off).

Update voice channel bitrate​

Change the audio bitrate of a voice channel.

Required permissions: Manage channels.

Inputs

NameTypeRequiredDetails
ChannelVoice channelYesVoice channel to update.
BitrateWhole numberYesAudio bitrate in bits per second (8000-384000). Value: 8000 to 384000.
Audit Log ReasonTextNoReason recorded in the audit log. Maximum length: 512 characters.

Outputs

NameTypeDetails
ChannelVoice channelThe updated voice channel.

Update voice channel user limit​

Change the maximum number of users allowed in a voice channel.

Required permissions: Manage channels.

Inputs

NameTypeRequiredDetails
ChannelVoice channelYesVoice channel to update.
User LimitWhole numberYesMaximum users (0 for unlimited, max 99). Value: 0 to 99.
Audit Log ReasonTextNoReason recorded in the audit log. Maximum length: 512 characters.

Outputs

NameTypeDetails
ChannelVoice channelThe updated voice channel.

Update voice channel region​

Override the voice region of a voice channel, or reset to automatic.

Required permissions: Manage channels.

Inputs

NameTypeRequiredDetails
ChannelVoice channelYesVoice channel to update.
Voice RegionTextNoRegion identifier (e.g. us-east). Leave empty for automatic.
Audit Log ReasonTextNoReason recorded in the audit log. Maximum length: 512 characters.

Outputs

NameTypeDetails
ChannelVoice channelThe updated voice channel.

Update voice channel video quality​

Change the camera video quality mode of a voice channel.

Required permissions: Manage channels.

Inputs

NameTypeRequiredDetails
ChannelVoice channelYesVoice channel to update.
Video Quality ModeVideo quality modeYesAuto or forced 720p.
Audit Log ReasonTextNoReason recorded in the audit log. Maximum length: 512 characters.

Outputs

NameTypeDetails
ChannelVoice channelThe updated voice channel.

Update default auto archive duration​

Change the default auto-archive duration for threads created in this channel.

Required permissions: Manage channels.

Inputs

NameTypeRequiredDetails
ChannelServer channelYesChannel to update.
Default Auto ArchiveAuto archive durationYesDefault auto-archive duration.
Audit Log ReasonTextNoReason recorded in the audit log. Maximum length: 512 characters.

Outputs

NameTypeDetails
ChannelServer channelThe updated channel.

Update default thread slowmode​

Change the default per-message slowmode for new threads in this channel.

Required permissions: Manage channels.

Inputs

NameTypeRequiredDetails
ChannelServer channelYesChannel to update.
Default Thread SlowmodeWhole numberYesDefault slowmode in seconds (0-21600). Value: 0 to 21600.
Audit Log ReasonTextNoReason recorded in the audit log. Maximum length: 512 characters.

Outputs

NameTypeDetails
ChannelServer channelThe updated channel.

Update default sort order​

Change the default ordering of posts in a forum or media channel.

Required permissions: Manage channels.

Inputs

NameTypeRequiredDetails
ChannelServer channelYesForum or media channel to update.
Default Sort OrderSort orderNoNew default sort order. Leave empty to clear.
Audit Log ReasonTextNoReason recorded in the audit log. Maximum length: 512 characters.

Outputs

NameTypeDetails
ChannelServer channelThe updated channel.

Update forum layout​

Change the default visual layout of a forum channel.

Required permissions: Manage channels.

Inputs

NameTypeRequiredDetails
ChannelForum channelYesForum channel to update.
Default LayoutForum layoutYesList view, gallery view, or not set.
Audit Log ReasonTextNoReason recorded in the audit log. Maximum length: 512 characters.

Outputs

NameTypeDetails
ChannelForum channelThe updated forum channel.

Update default reaction​

Change the default reaction emoji shown on posts in a forum or media channel.

Required permissions: Manage channels.

Inputs

NameTypeRequiredDetails
ChannelServer channelYesForum or media channel to update.
Default ReactionDefault reactionNoEmoji to use as the default reaction. Leave empty to clear.
Audit Log ReasonTextNoReason recorded in the audit log. Maximum length: 512 characters.

Outputs

NameTypeDetails
ChannelServer channelThe updated channel.

Update available tags​

Replace the set of tags that can be applied to posts in a forum or media channel.

Required permissions: Manage channels.

Inputs

NameTypeRequiredDetails
ChannelServer channelYesForum or media channel to update.
Available TagsList of Forum tagYesNew full list of tags (max 20). Maximum items: 20.
Audit Log ReasonTextNoReason recorded in the audit log. Maximum length: 512 characters.

Outputs

NameTypeDetails
ChannelServer channelThe updated channel.

Update channel flags​

Set the bit-flag features enabled for a channel.

Required permissions: Manage channels.

Inputs

NameTypeRequiredDetails
ChannelServer channelYesChannel to update.
FlagsList of Channel flagYesChannel flags to set.
Audit Log ReasonTextNoReason recorded in the audit log. Maximum length: 512 characters.

Outputs

NameTypeDetails
ChannelServer channelThe updated channel.

Convert announcement / text channel​

Convert an announcement channel into a regular text channel, or back. Uses Discord's setType API.

Required permissions: Manage channels.

Inputs

NameTypeRequiredDetails
ChannelServer channelYesChannel to convert.
Convert To TextYes/NoYesTrue converts announcement -> text; false converts text -> announcement. Default: Yes.
Audit Log ReasonTextNoReason recorded in the audit log. Maximum length: 512 characters.

Outputs

NameTypeDetails
ChannelServer channelThe channel after the type change.

Clone channel​

Create a copy of an existing channel including its settings and permission overwrites.

Required permissions: Manage channels.

Inputs

NameTypeRequiredDetails
Source ChannelServer channelYesChannel to clone.
NameTextNoOptional name for the cloned channel. Defaults to the source name. Length: 1 to 100 characters.
Parent CategoryCategoryNoCategory for the cloned channel.
PositionWhole numberNoPosition for the cloned channel. Minimum: 0.
Audit Log ReasonTextNoReason recorded in the audit log. Maximum length: 512 characters.

Outputs

NameTypeDetails
ChannelServer channelThe newly created clone.

Delete channel by ID​

Delete a server channel using only its ID. Use when you don't have a channel reference.

Required permissions: Manage channels.

Inputs

NameTypeRequiredDetails
Channel IDDiscord IDYesID of the channel to delete.
Audit Log ReasonTextNoReason recorded in the audit log. Maximum length: 512 characters.

Outputs

NameTypeDetails
DeletedYes/NoTrue if the channel was deleted successfully.

Follow announcement channel​

Subscribe a text channel to an announcement channel so its messages are crossposted.

Required permissions: Manage webhooks.

Inputs

NameTypeRequiredDetails
Source Announcement ChannelAnnouncement channelYesAnnouncement channel to follow.
Target Text ChannelText channelYesText channel that will receive crossposted announcements.
Audit Log ReasonTextNoReason recorded in the audit log. Maximum length: 512 characters.

Outputs

NameTypeDetails
Webhook IDDiscord IDID of the webhook created to deliver crossposted messages.

Sync permissions with category​

Reset a channel's permission overwrites to match those of its parent category.

Required permissions: Manage channels.

Inputs

NameTypeRequiredDetails
ChannelServer channelYesChannel whose permissions should be synced.
Audit Log ReasonTextNoReason recorded in the audit log. Maximum length: 512 characters.

Outputs

NameTypeDetails
ChannelServer channelThe channel after permissions were synced.

Create permission overwrite​

Add a permission overwrite for a role or member on a channel.

Required permissions: Manage roles.

Inputs

NameTypeRequiredDetails
ChannelServer channelYesChannel to modify.
RoleRoleNoRole this overwrite applies to. Use only one of these: Member.
MemberServer memberNoMember this overwrite applies to. Use only one of these: Role.
Allowed PermissionsList of PermissionNoPermissions explicitly granted.
Denied PermissionsList of PermissionNoPermissions explicitly denied.
Audit Log ReasonTextNoReason recorded in the audit log. Maximum length: 512 characters.

Outputs

NameTypeDetails
ChannelServer channelThe channel after the overwrite was added.

Build permission overwrite​

Build a permission overwrite value for a role or member. Use the result in Add permission overwrite, then into a channel-creation action's permission overwrites.

Inputs

NameTypeRequiredDetails
RoleRoleNoRole this overwrite applies to. Use only one of these: Member.
MemberServer memberNoMember this overwrite applies to. Use only one of these: Role.
Allowed PermissionsList of PermissionNoPermissions explicitly granted.
Denied PermissionsList of PermissionNoPermissions explicitly denied.

Outputs

NameTypeDetails
OverwritePermission overwriteThe constructed permission overwrite.

Add permission overwrite​

Appends a permission overwrite to a list and returns the updated list. Use the result in a channel-creation action's permission overwrites.

Inputs

NameTypeRequiredDetails
OverwritesList of Permission overwriteNoThe overwrite list to extend (leave empty to start a new list).
OverwritePermission overwriteYesThe permission overwrite to append (from Build permission overwrite).

Outputs

NameTypeDetails
OverwritesList of Permission overwriteThe updated overwrite list.

Update permission overwrite​

Edit an existing permission overwrite for a role or member on a channel.

Required permissions: Manage roles.

Inputs

NameTypeRequiredDetails
ChannelServer channelYesChannel to modify.
RoleRoleNoRole whose overwrite to update. Use only one of these: Member.
MemberServer memberNoMember whose overwrite to update. Use only one of these: Role.
Allowed PermissionsList of PermissionNoPermissions explicitly granted.
Denied PermissionsList of PermissionNoPermissions explicitly denied.
Audit Log ReasonTextNoReason recorded in the audit log. Maximum length: 512 characters.

Outputs

NameTypeDetails
ChannelServer channelThe channel after the overwrite was updated.

Delete permission overwrite​

Remove the permission overwrite for a role or member on a channel.

Required permissions: Manage roles.

Inputs

NameTypeRequiredDetails
ChannelServer channelYesChannel to modify.
RoleRoleNoRole whose overwrite to remove. Use only one of these: Member.
MemberServer memberNoMember whose overwrite to remove. Use only one of these: Role.
Audit Log ReasonTextNoReason recorded in the audit log. Maximum length: 512 characters.

Outputs

NameTypeDetails
ChannelServer channelThe channel after the overwrite was removed.

Fetch permission overwrites​

Get all permission overwrites configured on a channel.

Required permissions: View channel.

Inputs

NameTypeRequiredDetails
ChannelServer channelYesChannel to inspect.

Outputs

NameTypeDetails
OverwritesList of Permission overwriteAll permission overwrites on the channel.

Fetch channel by ID​

Look up a channel within a server by its ID. Returns an empty value if the channel does not exist.

Required permissions: View channel.

Inputs

NameTypeRequiredDetails
Channel IDDiscord IDYesID of the channel to fetch.
Force RefreshYes/NoNoBypass the cache and request fresh data from Discord. Default: No.

Outputs

NameTypeDetails
ChannelChannelThe fetched channel, or empty if not found. May be empty.

Fetch channel invites​

List all invites that point to a specific channel.

Required permissions: Manage channels.

Inputs

NameTypeRequiredDetails
ChannelServer channelYesChannel to inspect.

Outputs

NameTypeDetails
InvitesList of InviteInvites for the channel.

Fetch channel webhooks​

List all webhooks in a single channel.

Required permissions: Manage webhooks.

Inputs

NameTypeRequiredDetails
ChannelServer channelYesThe channel to query.

Outputs

NameTypeDetails
WebhooksList of WebhookAll webhooks in the channel.

Fetch server channels​

List every channel in a server.

Required permissions: View channel.

Outputs

NameTypeDetails
ChannelsList of Server channelAll channels in the server.

Show bot as typing in channel​

Triggers the bot's typing indicator in a channel for roughly 10 seconds.

Required permissions: Send messages.

Inputs

NameTypeRequiredDetails
ChannelServer channelYesThe channel where the typing indicator should appear.

Treat channel as text channel​

Narrow a generic channel to a server text channel. Returns nothing if the channel is a different type.

Inputs

NameTypeRequiredDetails
ChannelChannelYesChannel to narrow.

Outputs

NameTypeDetails
Text channelText channelNarrowed text channel, or empty if not a text channel. May be empty.

Treat channel as announcement channel​

Narrow a generic channel to an announcement channel. Returns nothing if the channel is a different type.

Inputs

NameTypeRequiredDetails
ChannelChannelYesChannel to narrow.

Outputs

NameTypeDetails
Announcement channelAnnouncement channelNarrowed announcement channel, or empty if not an announcement channel. May be empty.

Treat channel as voice channel​

Narrow a generic channel to a voice channel. Returns nothing if the channel is a different type.

Inputs

NameTypeRequiredDetails
ChannelChannelYesChannel to narrow.

Outputs

NameTypeDetails
Voice channelVoice channelNarrowed voice channel, or empty if not a voice channel. May be empty.

Treat channel as stage channel​

Narrow a generic channel to a stage channel. Returns nothing if the channel is a different type.

Inputs

NameTypeRequiredDetails
ChannelChannelYesChannel to narrow.

Outputs

NameTypeDetails
Stage channelStage channelNarrowed stage channel, or empty if not a stage channel. May be empty.

Treat channel as category​

Narrow a generic channel to a category. Returns nothing if the channel is not a category.

Inputs

NameTypeRequiredDetails
ChannelChannelYesChannel to narrow.

Outputs

NameTypeDetails
CategoryCategoryNarrowed category channel, or empty if not a category. May be empty.

Treat channel as forum channel​

Narrow a generic channel to a forum channel. Returns nothing if the channel is a different type.

Inputs

NameTypeRequiredDetails
ChannelChannelYesChannel to narrow.

Outputs

NameTypeDetails
Forum channelForum channelNarrowed forum channel, or empty if not a forum channel. May be empty.

Treat channel as media channel​

Narrow a generic channel to a media channel. Returns nothing if the channel is a different type.

Inputs

NameTypeRequiredDetails
ChannelChannelYesChannel to narrow.

Outputs

NameTypeDetails
Media channelMedia channelNarrowed media channel, or empty if not a media channel. May be empty.

Treat channel as thread​

Narrow a generic channel to a thread. Returns nothing if the channel is not a thread.

Inputs

NameTypeRequiredDetails
ChannelChannelYesChannel to narrow.

Outputs

NameTypeDetails
ThreadThreadNarrowed thread channel, or empty if not a thread. May be empty.

Treat channel as direct message​

Narrow a generic channel to a DM channel. Returns nothing if the channel is a server channel.

Inputs

NameTypeRequiredDetails
ChannelChannelYesChannel to narrow.

Outputs

NameTypeDetails
DM channelDirect messageNarrowed DM channel, or empty if not a DM. May be empty.

Create forum tag​

Adds a new tag to the available tags of a forum or media channel. Requires MANAGE_CHANNELS.

Required permissions: Manage channels.

Inputs

NameTypeRequiredDetails
ChannelServer channelYesForum or media channel to add the tag to. Allowed values: FORUM_CHANNEL, MEDIA_CHANNEL.
TagForum tagYesTag definition to append.
Audit Log ReasonTextNoReason recorded in the audit log (max 512 characters). Maximum length: 512 characters.

Outputs

NameTypeDetails
ChannelForum channelThe updated channel.

Update forum tag​

Updates an existing tag of a forum or media channel. Requires MANAGE_CHANNELS.

Required permissions: Manage channels.

Inputs

NameTypeRequiredDetails
ChannelServer channelYesForum or media channel containing the tag. Allowed values: FORUM_CHANNEL, MEDIA_CHANNEL.
Tag IDDiscord IDYesDiscord ID of the tag to update.
NameTextNoNew tag name (max 20 characters). Maximum length: 20 characters.
EmojiTextNoNew emoji as unicode character or custom emoji ID/mention.
ModeratedYes/NoNoWhether only members with MANAGE_THREADS may apply the tag.
Audit Log ReasonTextNoReason recorded in the audit log (max 512 characters). Maximum length: 512 characters.

Outputs

NameTypeDetails
ChannelForum channelThe updated channel.

Delete forum tag​

Removes a tag from a forum or media channel. Requires MANAGE_CHANNELS.

Required permissions: Manage channels.

Inputs

NameTypeRequiredDetails
ChannelServer channelYesForum or media channel containing the tag. Allowed values: FORUM_CHANNEL, MEDIA_CHANNEL.
Tag IDDiscord IDYesDiscord ID of the tag to remove.
Audit Log ReasonTextNoReason recorded in the audit log (max 512 characters). Maximum length: 512 characters.

Outputs

NameTypeDetails
ChannelForum channelThe updated channel.

Bulk set channel positions​

Repositions multiple channels in a single API call. Requires MANAGE_CHANNELS.

Required permissions: Manage channels.

Inputs

NameTypeRequiredDetails
UpdatesList of Channel position updateYesList of position updates to apply. Minimum items: 1.

Create channel position update​

Builds a single channel reposition entry (a channel plus its new position, and optional lock-permissions / parent) for Bulk set channel positions. Collect entries with Add channel position or Add item to list.

Inputs

NameTypeRequiredDetails
ChannelServer channelYesThe channel to move.
PositionWhole numberYesThe channel's new position (0 is first). Minimum: 0.
Lock PermissionsYes/NoNoSync the channel's permissions to its (new) parent category. Default: No.
Parent Category IDDiscord IDNoThe id of the category to move the channel under (leave empty to keep, set to nothing to move to the root).

Outputs

NameTypeDetails
Position UpdateChannel position updateThe constructed channel position update.

Add channel position​

Appends a channel reposition entry (a channel plus its new position, and optional lock-permissions / parent) to a list and returns the updated list. Leave the list empty to start a new one; use the result in Bulk set channel positions.

Inputs

NameTypeRequiredDetails
UpdatesList of Channel position updateNoThe position-update list to extend (leave empty to start a new list). Maximum items: 500.
ChannelServer channelYesThe channel to move.
PositionWhole numberYesThe channel's new position (0 is first). Minimum: 0.
Lock PermissionsYes/NoNoSync the channel's permissions to its (new) parent category. Default: No.
Parent Category IDDiscord IDNoThe id of the category to move the channel under (leave empty to keep, set to nothing to move to the root).

Outputs

NameTypeDetails
UpdatesList of Channel position updateThe updated position-update list.

Fetch channel by name​

Finds a channel on the server by its name. Optionally filter by channel type.

Inputs

NameTypeRequiredDetails
NameTextYesChannel name to search for. Length: 1 to 100 characters.
TypeChannel typeNoRestrict to this channel type.
Case sensitiveYes/NoYesMatch upper/lower case exactly. Default: No.

Outputs

NameTypeDetails
ChannelServer channelThe first matching channel, or empty. May be empty.
Need more help?
Can't find what you're looking for? Our team is happy to help.