Skip to main content
Module

x/discord_api_types/v10.ts>RESTPatchAPIGuildJSONBody

Up to date Discord API Typings, versioned by the API version
Go to Latest
interface RESTPatchAPIGuildJSONBody
import { type RESTPatchAPIGuildJSONBody } from "https://deno.land/x/discord_api_types@0.37.82/v10.ts";

Properties

optional
name: string | undefined

New name for the guild (2-100 characters)

optional
region: string | null | undefined
optional
verification_level: GuildVerificationLevel | null | undefined
optional
default_message_notifications: GuildDefaultMessageNotifications | null | undefined
optional
explicit_content_filter: GuildExplicitContentFilter | null | undefined
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

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

optional
owner_id: Snowflake | undefined

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

optional
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

optional
discovery_splash: string | null | undefined

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

optional
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)

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
rules_channel_id: Snowflake | null | undefined

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

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
preferred_locale: string | null | undefined

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

optional
description: string | null | undefined

The description for the guild

optional
premium_progress_bar_enabled: boolean | undefined

Whether the boosts progress bar should be enabled.

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