Toolcog home
Search ⌘ + K

Command Palette

Search for a command to run...

Sign In

update_guild

PATCH /guilds/{guild_id}
Copy endpoint
https://discord.com/api/v10

Parameters

path Path Parameters

Name Type
guild_id required
type SnowflakeType = string

Request Body

application/json required
interface GuildPatchRequestPartial {
name?: string;
description?: string | null;
region?: string | null;
icon?: string | null;
verification_level?: VerificationLevels
type VerificationLevels = 0 | 1 | 2 | 3 | 4
| null;
default_message_notifications?: UserNotificationSettings
type UserNotificationSettings = 0 | 1
| null;
explicit_content_filter?: GuildExplicitContentFilterTypes
type GuildExplicitContentFilterTypes = 0 | 1 | 2
| null;
preferred_locale?: AvailableLocalesEnum
type AvailableLocalesEnum = "ar" | "bg" | "cs" | "da" | "de" | "el" | "en-GB" | "en-US" | "es-419" | "es-ES" | "fi" | "fr" | "he" | "hi" | "hr" | "hu" | "id" | "it" | "ja" | "ko" | "lt" | "nl" | "no" | "pl" | "pt-BR" | "ro" | "ru" | "sv-SE" | "th" | "tr" | "uk" | "vi" | "zh-CN" | "zh-TW"
| null;
afk_timeout?: AfkTimeouts
type AfkTimeouts = 60 | 300 | 900 | 1800 | 3600
| null;
afk_channel_id?: SnowflakeType
type SnowflakeType = string
| null;
system_channel_id?: SnowflakeType
type SnowflakeType = string
| null;
splash?: string | null;
banner?: string | null;
system_channel_flags?: number | null;
features?: (string | null)[] | null;
discovery_splash?: string | null;
home_header?: string | null;
rules_channel_id?: SnowflakeType
type SnowflakeType = string
| null;
safety_alerts_channel_id?: SnowflakeType
type SnowflakeType = string
| null;
public_updates_channel_id?: SnowflakeType
type SnowflakeType = string
| null;
premium_progress_bar_enabled?: boolean | null;
}

Responses

200 application/json

200 response for update_guild

interface GuildResponse {
id: SnowflakeType
type SnowflakeType = string
;
name: string;
icon?: string | null;
description?: string | null;
home_header?: string | null;
splash?: string | null;
discovery_splash?: string | null;
features: GuildFeatures
type GuildFeatures = "ANIMATED_BANNER" | "ANIMATED_ICON" | "APPLICATION_COMMAND_PERMISSIONS_V2" | "AUTO_MODERATION" | "BANNER" | "COMMUNITY" | "CREATOR_MONETIZABLE_PROVISIONAL" | "CREATOR_STORE_PAGE" | "DEVELOPER_SUPPORT_SERVER" | "DISCOVERABLE" | "FEATURABLE" | "INVITES_DISABLED" | "INVITE_SPLASH" | "MEMBER_VERIFICATION_GATE_ENABLED" | "MORE_STICKERS" | "NEWS" | "PARTNERED" | "PREVIEW_ENABLED" | "RAID_ALERTS_DISABLED" | "ROLE_ICONS" | "ROLE_SUBSCRIPTIONS_AVAILABLE_FOR_PURCHASE" | "ROLE_SUBSCRIPTIONS_ENABLED" | "TICKETED_EVENTS_ENABLED" | "VANITY_URL" | "VERIFIED" | "VIP_REGIONS" | "WELCOME_SCREEN_ENABLED"
[];
banner?: string | null;
owner_id: SnowflakeType
type SnowflakeType = string
;
application_id?: SnowflakeType
type SnowflakeType = string
| null;
region: string;
afk_channel_id?: SnowflakeType
type SnowflakeType = string
| null;
afk_timeout: AfkTimeouts
type AfkTimeouts = 60 | 300 | 900 | 1800 | 3600
;
system_channel_id?: SnowflakeType
type SnowflakeType = string
| null;
system_channel_flags: number;
widget_enabled: boolean;
widget_channel_id?: SnowflakeType
type SnowflakeType = string
| null;
verification_level: VerificationLevels
type VerificationLevels = 0 | 1 | 2 | 3 | 4
;
roles: GuildRoleResponse
interface GuildRoleResponse {
id: SnowflakeType;
name: string;
description?: string | null;
permissions: string;
position: number;
color: number;
colors: GuildRoleColorsResponse;
hoist: boolean;
managed: boolean;
mentionable: boolean;
icon?: string | null;
unicode_emoji?: string | null;
tags?: GuildRoleTagsResponse;
flags: number;
}
[];
default_message_notifications: UserNotificationSettings
type UserNotificationSettings = 0 | 1
;
mfa_level: GuildMFALevel
type GuildMFALevel = 0 | 1
;
explicit_content_filter: GuildExplicitContentFilterTypes
type GuildExplicitContentFilterTypes = 0 | 1 | 2
;
max_presences?: number | null;
max_members: number;
max_stage_video_channel_users: number;
max_video_channel_users: number;
vanity_url_code?: string | null;
premium_tier: PremiumGuildTiers
type PremiumGuildTiers = 0 | 1 | 2 | 3
;
premium_subscription_count: number;
preferred_locale: AvailableLocalesEnum
type AvailableLocalesEnum = "ar" | "bg" | "cs" | "da" | "de" | "el" | "en-GB" | "en-US" | "es-419" | "es-ES" | "fi" | "fr" | "he" | "hi" | "hr" | "hu" | "id" | "it" | "ja" | "ko" | "lt" | "nl" | "no" | "pl" | "pt-BR" | "ro" | "ru" | "sv-SE" | "th" | "tr" | "uk" | "vi" | "zh-CN" | "zh-TW"
;
rules_channel_id?: SnowflakeType
type SnowflakeType = string
| null;
safety_alerts_channel_id?: SnowflakeType
type SnowflakeType = string
| null;
public_updates_channel_id?: SnowflakeType
type SnowflakeType = string
| null;
premium_progress_bar_enabled: boolean;
nsfw: boolean;
nsfw_level: GuildNSFWContentLevel
type GuildNSFWContentLevel = 0 | 1 | 2 | 3
;
emojis: EmojiResponse
interface EmojiResponse {
id: SnowflakeType;
name: string;
user?: UserResponse;
roles: SnowflakeType[];
require_colons: boolean;
managed: boolean;
animated: boolean;
available: boolean;
}
[];
stickers: GuildStickerResponse
interface GuildStickerResponse {
id: SnowflakeType;
name: string;
tags: string;
type: 2 & StickerTypes;
format_type?: StickerFormatTypes | null;
description?: string | null;
available: boolean;
guild_id: SnowflakeType;
user?: UserResponse;
}
[];
}

Client Errors

429 application/json

Client ratelimited response

type RatelimitedResponse = never
4XX application/json

Client error response

type ErrorResponse = never