RESTPatchAPIChannelJSONBody

https://discord.com/developers/docs/resources/channel#modify-channel

Signature

export interface RESTPatchAPIChannelJSONBody

Properties

name?: string | undefined;

1-100 character channel name Channel types: all

type?: ChannelType.GuildAnnouncement | ChannelType.GuildText | undefined;

The type of channel; only conversion between `text` and `news` is supported and only in guilds with the "NEWS" feature Channel types: text, news

position?: number | null | undefined;

The position of the channel in the left-hand listing Channel types: all excluding newsThread, publicThread, privateThread

topic?: string | null | undefined;

0-1024 character channel topic (0-4096 characters for thread-only channels) Channel types: text, news, forum, media

nsfw?: boolean | null | undefined;

Whether the channel is nsfw Channel types: text, voice, news, forum, media

rate_limit_per_user?: number | null | undefined;

Amount of seconds a user has to wait before sending another message (0-21600); bots, as well as users with the permission `MANAGE_MESSAGES` or `MANAGE_CHANNELS`, are unaffected Channel types: text, newsThread, publicThread, privateThread, forum, media

bitrate?: number | null | undefined;

The bitrate (in bits) of the voice channel; 8000 to 96000 (128000 for VIP servers) Channel types: voice

user_limit?: number | null | undefined;

The user limit of the voice channel; 0 refers to no limit, 1 to 99 refers to a user limit Channel types: voice

parent_id?: Snowflake | null | undefined;

ID of the new parent category for a channel Channel types: text, voice, news, stage, forum, media

rtc_region?: string | null | undefined;

Voice region id for the voice or stage channel, automatic when set to `null` See https://discord.com/developers/docs/resources/voice#voice-region-object

video_quality_mode?: VideoQualityMode | null | undefined;

The camera video quality mode of the voice channel See https://discord.com/developers/docs/resources/channel#channel-object-video-quality-modes

archived?: boolean | undefined;

Whether the thread should be archived Channel types: newsThread, publicThread, privateThread

locked?: boolean | undefined;

Whether the thread should be locked Channel types: newsThread, publicThread, privateThread

invitable?: boolean | undefined;

Whether non-moderators can add other non-moderators to the thread Channel types: privateThread

default_thread_rate_limit_per_user?: number | null | undefined;

The initial `rate_limit_per_user` to set on newly created threads in a channel. This field is copied to the thread at creation time and does not live update Channel types: text, forum, media

default_sort_order?: SortOrderType | null | undefined;

The default sort order type used to order posts in a thread-only channel Channel types: forum, media

applied_tags?: Snowflake[] | undefined;

The ids of the set of tags that have been applied to a thread-only channel; limited to 5 Channel types: forum, media