Skip to main content
Version: 0.37.70

RESTPatchAPIGuildJSONBody

@deprecated

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

Index

Properties

optionalafk_channel_id

afk_channel_id?: null | string

ID for afk channel

optionalafk_timeout

afk_timeout?: number

AFK timeout in seconds

optionalbanner

banner?: null | string

base64 16:9 png/jpeg image for the guild banner (when the server has the BANNER feature; can be animated gif when the server has the ANIMATED_BANNER feature)

optionaldefault_message_notifications

default_message_notifications?: null | GuildDefaultMessageNotifications

optionaldescription

description?: null | string

The description for the guild, if the guild is discoverable

optionaldiscovery_splash

discovery_splash?: null | string

base64 png/jpeg image for the guild discovery splash (when the guild has DISCOVERABLE feature)

optionalexplicit_content_filter

explicit_content_filter?: null | GuildExplicitContentFilter

optionalfeatures

features?: GuildFeature[]

optionalicon

icon?: null | string

base64 1024x1024 png/jpeg/gif image for the guild icon (can be animated gif when the guild has ANIMATED_ICON feature)

optionalname

name?: string

New name for the guild (2-100 characters)

optionalowner_id

owner_id?: string

User id to transfer guild ownership to (must be owner)

optionalpreferred_locale

preferred_locale?: null | string

The preferred locale of a Community guild used in server discovery and notices from Discord; defaults to “en-US”

@default

“en-US” (if the value is set to null)

optionalpremium_progress_bar_enabled

premium_progress_bar_enabled?: boolean

Whether the boosts progress bar should be enabled.

optionalpublic_updates_channel_id

public_updates_channel_id?: null | string

The id of the channel where admins and moderators of Community guilds receive notices from Discord

optionalregion

region?: null | string

optionalrules_channel_id

rules_channel_id?: null | string

The id of the channel where Community guilds display rules and/or guidelines

optionalsplash

splash?: null | string

base64 16:9 png/jpeg image for the guild splash (when the guild has INVITE_SPLASH feature)

optionalsystem_channel_flags

system_channel_flags?: GuildSystemChannelFlags

optionalsystem_channel_id

system_channel_id?: null | string

The id of the channel where guild notices such as welcome messages and boost events are posted

optionalverification_level

verification_level?: null | GuildVerificationLevel