RESTPatchAPIGuildJSONBody

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

Signature

export interface RESTPatchAPIGuildJSONBody

Properties

name?: string | undefined;

New name for the guild (2-100 characters)

region?: string | null | undefined;

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

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

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

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 https://discord.com/developers/docs/reference#image-data

owner_id?: Snowflake | undefined;

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

splash?: string | null | undefined;

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

discovery_splash?: string | null | undefined;

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

banner?: string | null | undefined;

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)

system_channel_id?: Snowflake | null | undefined;

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

rules_channel_id?: Snowflake | null | undefined;

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

public_updates_channel_id?: Snowflake | null | undefined;

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

preferred_locale?: string | null | undefined;

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`)
features?: GuildFeature[] | undefined;

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

description?: string | null | undefined;

The description for the guild

safety_alerts_channel_id?: Snowflake | null | undefined;

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