channels_modify
channels_modify
Section titled “channels_modify”Category: channels
Update an existing channel’s settings. Pass only the fields you want to change.
When to use
Section titled “When to use”- Rename, move under a category, toggle nsfw, change slowmode, retag a forum channel.
When NOT to use
Section titled “When NOT to use”- Permission overwrites for a single role/user → use
channels_modify_permissions. - Deleting → use
channels_delete.
Field applicability mirrors channels_create_guild_channel. Discord ignores fields that do not apply to the channel type.
| Field | Type | Required | Description |
|---|---|---|---|
channel_id | string | yes | Channel to modify |
name | string | no | New channel name |
type | integer | no | Convert text↔announcement only (Discord limitation) |
position | integer | no | |
topic | unknown | no | |
nsfw | boolean | no | |
rate_limit_per_user | integer | no | |
bitrate | integer | no | |
user_limit | integer | no | |
permission_overwrites | array | no | |
parent_id | unknown | no | |
rtc_region | unknown | no | |
video_quality_mode | unknown | no | |
default_auto_archive_duration | unknown | no | |
flags | integer | no | Channel flags bitfield |
available_tags | array | no | |
default_reaction_emoji | unknown | no | |
default_thread_rate_limit_per_user | integer | no | |
default_sort_order | unknown | no | |
default_forum_layout | unknown | no | |
audit_reason | string | no | Reason recorded in audit log (X-Audit-Log-Reason header) |
Returns
Section titled “Returns”\{id, name, type, parent_id\}.
Output schema
Section titled “Output schema”| Field | Type | Required | Description |
|---|---|---|---|
id | string | yes | Discord channel ID (snowflake) |
name | string | yes | |
type | integer | yes | |
parent_id | unknown | yes |
Annotations
Section titled “Annotations”| Property | Value |
|---|---|
| Read-only | no |
| Destructive | no |
| Idempotent | yes |
| Open-world | yes |
| Confirmation required | no |