Tags

{channel} Tags

{channel.mention;channel}

Returns a string with a channel mention.

NameTypeDefault
channelChannelcontext Channel

{channel.id;channel}

Returns the ID of a channel.

NameTypeDefault
channelChannelcontext Channel

{channel.type;channel}

Returns an integer for the channel type.

NameTypeDefault
channelChannelcontext Channel

{channel.createdAt;channel}

Returns a timestamp for the creation date of a channel that can be used with {time}.

NameTypeDefault
channelChannelcontext Channel

{channel.nsfw;channel}

Checks if a channel is marked as NSFW.

NameTypeDefault
channelChannelcontext Channel

{channel.name;channel}

Returns the name of a channel.

NameTypeDefault
channelChannelcontext Channel

{channel.position;channel}

Returns the position of the channel.

Discord sorts channels by their category, then their type, then their position. Two channels can have the same position and a channel at the bottom of the list can have a higher position than a channel at the top of the list, because of the category-first sorting.

NameTypeDefault
channelChannelcontext Channel

{channel.lastMessageId;channel}

Returns the ID of the last message sent in a channel.

NameTypeDefault
channelChannelcontext Channel

{channel.topic;channel}

Returns a channel topic, also known as channel description.

NameTypeDefault
channelChannelcontext Channel

{channel.parentId}

Get the parent ID of the channel. For regular channels this is the category ID. For threads this is the ID of the parent channel.

{channel.parentId} // "", a channel with no parent
{channel.parentId} // "532902705404837888", a regular channel with a parent
{channel.parentId} // "532902728834351115", a thread channel with a parent
NameTypeDefault
channelChannelcontext Channel

{channel.isThread}

Returns true if the channel is a thread.

NameTypeDefault
channelChannelcontext Channel

{channel.isVoice}

Returns true if the channel is a voice channel.

NameTypeDefault
channelChannelcontext Channel

{channel.isTextable}

Returns true if the channel can accept messages.

NameTypeDefault
channelChannelcontext Channel

{channel.edit name topic nsfw archived ratelimit parent;channel}

Note

This tag is part of the Mutate Channel expensive group.

Updates a channel.

NameTypeDescription
channelChannel
namestring?The new name of the channel.
topicstring?The new topic of the channel.
nsfwboolean?Whether the channel is NSFW or not.
archivedboolean?Whether this channel is archived; channel must be a thread.
ratelimitTime?How often users can send messages in this channel, for example 1m.
parentChannel?The category to move the channel to.

{channel.startThread auto_archive_duration ratelimit invitable is_private return_id channel;name;message}

Note

This tag is part of the Mutate Channel expensive group.

Creates a new thread.

NameTypeDefaultDescription
namestringthe name of the thread.
messageMessage?the message the thread is created from.
auto_archive_durationThreadAutoArchiveDuration?ThreadAutoArchiveDuration.OneDaythe time until threads are archived after inactivity. Can be one_hour, one_day, three_days or one_week.
ratelimitTime?how often users can send messages in the thread, for example 1m.
invitableboolean?whether non-moderators can add other non-moderators to the thread; only available on private threads.
is_privateboolean?falsewhether the read is private, must not have a message to be private.
return_idboolean?falsewhether to return the ID of the created thread.
channelChannel?context Channelthe channel to create the thread on.

{channel.getPins;channel}

Returns a list of pinned message IDs in a channel.

NameTypeDefault
channelChannelcontext Channel

{channel.create name type topic nsfw parent return_id;channel}

Note

This tag is part of the Mutate Channel expensive group.

Creates a new channel.

NameTypeDescription
namestringThe name of the channel.
typeChannelTypeThe type of the channel. Only GuildText, GuildVoice and GuildCategory are allowed.
topicstring?The topic of the channel.
nsfwboolean?Whether the channel is NSFW or not.
parentChannel?The parent channel, if any.
return_idboolean?Whether to return the created channels ID or not.

{channel.delete;channel}

Note

This tag is part of the Mutate Channel expensive group. This tag is marked Dangerous and must be enabled in Advanced Settings.

Deletes a channel.

NameTypeDescription
channelChannelThe channel to delete

{channel.position;channel}

Get the position of a channel.

NameTypeDefault
channelChannelcontext Channel

{channel.purge;limit;channel}

Note

This tag is part of the Mutate Message expensive group. This tag is marked Dangerous and must be enabled in Advanced Settings.

Purge messages from a channel with various parameters.

NameTypeDefaultDescription
limitnumber?100The number of messages to purge, applied before filtering.
channelChannel?context ChannelThe channel to purge messages in, defaults to the context channel.
includePinnedboolean?falseWhether to include pinned messages.
newerThanTime?Messages that are newer than this time will be purged. Accepts a time value.
olderThanTime?Messages that are older than this time will be purged. Accepts a time value.
beforeMessageMessage?Purge messages sent before this message.
afterMessageMessage?Purge messages sent after this message.
includingstring?Purge messages including this message. Can be a regex pattern.
excludingstring?Purge messages excluding this message. Can be a regex pattern.
authorUser?Purge messages that were sent by this user.
notAuthorUser?Purge messages that were not sent by this user.
hasImageboolean?Purge messages that do or do not contain an image.
hasLinkboolean?Purge messages that do or do not contain a link.
hasInviteboolean?Purge messages that do or do not contain a server invite.
hasAttachmentboolean?Purge messages that do or do not have an attachment.
reasonstring?The reason for deleting the channel.
returnBoolboolean?falseWhether to return true if messages were purged.