Skip to main content
Module

x/discord_api_types/v9.ts>RESTPatchAPIChannelJSONBody

Up to date Discord API Typings, versioned by the API version
Go to Latest
interface RESTPatchAPIChannelJSONBody
import { type RESTPatchAPIChannelJSONBody } from "https://deno.land/x/discord_api_types@0.37.82/v9.ts";

Properties

optional
name: string | undefined

1-100 character channel name

Channel types: all

optional
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

optional
position: number | null | undefined

The position of the channel in the left-hand listing

Channel types: all excluding newsThread, publicThread, privateThread

optional
topic: string | null | undefined

0-1024 character channel topic (0-4096 characters for thread-only channels)

Channel types: text, news, forum, media

optional
nsfw: boolean | null | undefined

Whether the channel is nsfw

Channel types: text, voice, news, forum, media

optional
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

optional
bitrate: number | null | undefined

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

Channel types: voice

optional
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

optional
permission_overwrites: APIChannelPatchOverwrite[] | null | undefined

Channel or category-specific permissions

Channel types: all excluding newsThread, publicThread, privateThread

optional
parent_id: Snowflake | null | undefined

ID of the new parent category for a channel

Channel types: text, voice, news, stage, forum, media

optional
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

optional
video_quality_mode: VideoQualityMode | null | undefined
optional
archived: boolean | undefined

Whether the thread should be archived

Channel types: newsThread, publicThread, privateThread

optional
auto_archive_duration: ThreadAutoArchiveDuration | undefined

The amount of time in minutes to wait before automatically archiving the thread

Channel types: newsThread, publicThread, privateThread

optional
locked: boolean | undefined

Whether the thread should be locked

Channel types: newsThread, publicThread, privateThread

optional
default_auto_archive_duration: ThreadAutoArchiveDuration | undefined

Default duration for newly created threads, in minutes, to automatically archive the thread after recent activity

Channel types: text, news, forum, media

optional
flags: ChannelFlags | undefined

Channel flags combined as a bit field.

optional
available_tags: (Partial<APIGuildForumTag> & Pick<APIGuildForumTag, "name">)[] | undefined

The set of tags that can be used in a thread-only channel; limited to 20

Channel types: forum, media

optional
invitable: boolean | undefined

Whether non-moderators can add other non-moderators to the thread

Channel types: privateThread

optional
default_reaction_emoji: APIGuildForumDefaultReactionEmoji | undefined

The emoji to show in the add reaction button on a thread in a thread-only channel

Channel types: forum, media

optional
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

optional
default_sort_order: SortOrderType | null | undefined

The default sort order type used to order posts in a thread-only channel

Channel types: forum, media

optional
default_forum_layout: ForumLayoutType | undefined

The default layout type used to display posts in a forum channel

Channel types: forum

optional
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