discord-api-types

interface RESTPatchAPIGuildJSONBody

export interface RESTPatchAPIGuildJSONBody

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

optional
afk_channel_id? : Snowflake | null | undefined

ID for afk channel

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

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

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)

optional
default_message_notifications? : GuildDefaultMessageNotifications | null | undefined

Default message notification level

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

optional
description? : string | null | undefined

The description for the guild

optional
discovery_splash? : string | null | undefined

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

optional
explicit_content_filter? : GuildExplicitContentFilter | null | undefined

Explicit content filter level

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

optional
features? : GuildFeature[] | undefined

Enabled guild features

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

optional
icon? : string | null | undefined

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

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

optional
name? : string | undefined

New name for the guild (2-100 characters)

optional
owner_id? : Snowflake | undefined

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

optional
preferred_locale? : Locale | null | undefined = "en-US" (if the value is set to null)

The preferred locale of a Community guild used in server discovery and notices from Discord

optional
premium_progress_bar_enabled? : boolean | undefined

Whether the boosts progress bar should be enabled.

optional
public_updates_channel_id? : Snowflake | null | undefined

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

optional
region? : string | null | undefined

Voice region id

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

optional
rules_channel_id? : Snowflake | null | undefined

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

optional
safety_alerts_channel_id? : Snowflake | null | undefined

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

optional
splash? : string | null | undefined

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

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

optional
system_channel_flags? : GuildSystemChannelFlags | undefined

System channel flags

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

optional
system_channel_id? : Snowflake | null | undefined

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

optional
verification_level? : GuildVerificationLevel | null | undefined

Verification level

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