RESTPatchAPIGuildJSONBody

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

Index

Properties

• afk_channel_id
• afk_timeout
• banner
• default_message_notifications
• description
• discovery_splash
• explicit_content_filter
• features
• icon
• name
• owner_id
• preferred_locale
• premium_progress_bar_enabled
• public_updates_channel_id
• region
• rules_channel_id
• safety_alerts_channel_id
• splash
• system_channel_flags
• system_channel_id
• verification_level

Properties

optionalafk_channel_id

afk_channel_id?: null | string

ID for afk channel

optionalafk_timeout

afk_timeout?: 1800 | 3600 | 60 | 300 | 900

afk timeout in seconds, can be set to: 60, 300, 900, 1800, 3600

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

Default message notification level

See https://discord.com/developers/docs/resources/guild#guild-object-default-message-notification-level

optionaldescription

description?: null | string

The description for the guild

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

Explicit content filter level

See https://discord.com/developers/docs/resources/guild#guild-object-explicit-content-filter-level

optionalfeatures

features?: GuildFeature[]

Enabled guild features

See https://discord.com/developers/docs/resources/guild#guild-object-guild-features

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)

See https://discord.com/developers/docs/reference#image-data

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 | Locale

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

Voice region id

See https://discord.com/developers/docs/resources/voice#voice-region-object

optionalrules_channel_id

rules_channel_id?: null | string

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

optionalsafety_alerts_channel_id

safety_alerts_channel_id?: null | string

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

optionalsplash

splash?: null | string

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

See https://discord.com/developers/docs/reference#image-data

optionalsystem_channel_flags

system_channel_flags?: GuildSystemChannelFlags

System channel flags

See https://discord.com/developers/docs/resources/guild#guild-object-system-channel-flags

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

Verification level

See https://discord.com/developers/docs/resources/guild#guild-object-verification-level