Skip to main content
Version: Next

RESTPatchAPIChannelJSONBody

@deprecated

API and gateway v8 are deprecated and the types will not receive further updates, please update to v10.

Index

Properties

optionalbitrate

bitrate?: null | number

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

Channel types: voice

optionalname

name?: string

1-100 character channel name

Channel types: all

optionalnsfw

nsfw?: null | boolean

Whether the channel is nsfw

Channel types: text, news, store

optionalparent_id

parent_id?: null | string

ID of the new parent category for a channel

Channel types: text, news, store, voice

optionalpermission_overwrites

permission_overwrites?: null | APIChannelPatchOverwrite[]

Channel or category-specific permissions

Channel types: all

optionalposition

position?: null | number

The position of the channel in the left-hand listing

Channel types: all

optionalrate_limit_per_user

rate_limit_per_user?: null | number

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

optionalrtc_region

rtc_region?: null | string

Voice region id for the voice or stage channel, automatic when set to null

optionaltopic

topic?: null | string

0-1024 character channel topic

Channel types: text, news

optionaltype

type?: GuildText | GuildNews

The type of channel; only conversion between text and news is supported and only in guilds with the “NEWS” feature

Channel types: text, news

optionaluser_limit

user_limit?: null | number

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

Channel types: voice

optionalvideo_quality_mode

video_quality_mode?: null | VideoQualityMode