$editChannel
Edits the properties of a channel.
Usage:
$editChannel[channelID;categoryID/$default;name/$default;position/$default;nsfw/$default (yes/no);bitrate/$default;userLimit/$default;syncPermission/$default (yes/no);reason (optional)]
Use
$default
as a placeholder if you don't want to modify a specific property.
Parameters:
channelID
: The ID of the channel you want to edit.categoryID
: The ID of the category to move the channel to. Use$default
to keep it in the same category.name
: The new name of the channel. Use$default
to keep the current name.position
: The new position of the channel in the channel list (integer). Use$default
to keep the current position.nsfw
: Whether the channel is NSFW (Not Safe For Work). Useyes
orno
. Use$default
to keep the current setting.bitrate
: The new bitrate of the channel (for voice channels). Use$default
to keep the current bitrate.userLimit
: The new user limit of the channel (for voice channels). Use$default
to keep the current limit.syncPermission
: Whether to sync the channel's permissions with its category. Useyes
orno
. Use$default
to keep the current setting.reason
: (Optional) The reason for editing the channel. This will be visible in the audit log.
Channel Types
Refer to this list for all valid channel types and their properties.
Example:
$editChannel[$channelID;$default;new-channel-name;$default;$default;$default;$default;yes;Channel name update]
This example changes the channel name to "new-channel-name", syncs permissions with category and provides a reason for audit logs. All other channel properties will remain unchanged.
Related Functions
Use $modifyChannelPerms to manage channel permissions in more detail.