interface RESTPatchAPIChannelJSONBody

external
export interface RESTPatchAPIChannelJSONBody

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

optionalexternal
applied_tags? : Snowflake[] | undefined

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

optionalexternal
archived? : boolean | undefined

Whether the thread should be archivedChannel types: newsThread, publicThread, privateThread

optionalexternal
auto_archive_duration? : ThreadAutoArchiveDuration | undefined

The amount of time in minutes to wait before automatically archiving the threadChannel types: newsThread, publicThread, privateThread

optionalexternal
available_tags? : (Partial<APIGuildForumTag> & Pick<APIGuildForumTag, 'name'>)[] | undefined

The set of tags that can be used in a thread-only channel; limited to 20Channel types: forum, media

optionalexternal
bitrate? : number | null | undefined

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

optionalexternal
default_auto_archive_duration? : ThreadAutoArchiveDuration | undefined

Default duration for newly created threads, in minutes, to automatically archive the thread after recent activityChannel types: text, news, forum, media

optionalexternal
default_forum_layout? : ForumLayoutType | undefined

The default layout type used to display posts in a forum channelChannel types: forum

optionalexternal
default_reaction_emoji? : APIGuildForumDefaultReactionEmoji | undefined

The emoji to show in the add reaction button on a thread in a thread-only channelChannel types: forum, media

optionalexternal
default_sort_order? : SortOrderType | null | undefined

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

optionalexternal
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 updateChannel types: text, forum, media

optionalexternal
flags? : ChannelFlags | undefined

Channel flags combined as a bit field.

optionalexternal
invitable? : boolean | undefined

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

optionalexternal
locked? : boolean | undefined

Whether the thread should be lockedChannel types: newsThread, publicThread, privateThread

optionalexternal
name? : string | undefined

1-100 character channel nameChannel types: all

optionalexternal
nsfw? : boolean | null | undefined

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

optionalexternal
parent_id? : Snowflake | null | undefined

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

optionalexternal
permission_overwrites? : RESTAPIChannelPatchOverwrite[] | null | undefined

Channel or category-specific permissionsChannel types: all excluding newsThread, publicThread, privateThread

optionalexternal
position? : number | null | undefined

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

optionalexternal
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 unaffectedChannel types: text, newsThread, publicThread, privateThread, forum, media

optionalexternal
rtc_region? : string | null | undefined

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

optionalexternal
topic? : string | null | undefined

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

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

optionalexternal
user_limit? : number | null | undefined

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

optionalexternal
video_quality_mode? : VideoQualityMode | null | undefined

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