--- title: "PATCH /guilds/{guild_id}" method: PATCH path: "/guilds/{guild_id}" --- # PATCH /guilds/{guild_id} `PATCH /guilds/{guild_id}` ## Request body - GuildPatchRequestPartial - `name` string - `description` string, nullable - `region` string, nullable - `icon` string, byte, nullable - `verification_level` union - 0 — unrestricted - 1 — must have verified email on account - 2 — must be registered on Discord for longer than 5 minutes - 3 — must be a member of the server for longer than 10 minutes - 4 — must have a verified phone number - `default_message_notifications` union - 0 — members will receive notifications for all messages by default - 1 — members will receive notifications only for messages that @mention them by default - `explicit_content_filter` union - 0 — media content will not be scanned - 1 — media content sent by members without roles will be scanned - 2 — media content sent by all members will be scanned - `preferred_locale` union - 'ar' — The ar locale - 'bg' — The bg locale - 'cs' — The cs locale - 'da' — The da locale - 'de' — The de locale - 'el' — The el locale - 'en-GB' — The en-GB locale - 'en-US' — The en-US locale - 'es-419' — The es-419 locale - 'es-ES' — The es-ES locale - 'fi' — The fi locale - 'fr' — The fr locale - 'he' — The he locale - 'hi' — The hi locale - 'hr' — The hr locale - 'hu' — The hu locale - 'id' — The id locale - 'it' — The it locale - 'ja' — The ja locale - 'ko' — The ko locale - 'lt' — The lt locale - 'nl' — The nl locale - 'no' — The no locale - 'pl' — The pl locale - 'pt-BR' — The pt-BR locale - 'ro' — The ro locale - 'ru' — The ru locale - 'sv-SE' — The sv-SE locale - 'th' — The th locale - 'tr' — The tr locale - 'uk' — The uk locale - 'vi' — The vi locale - 'zh-CN' — The zh-CN locale - 'zh-TW' — The zh-TW locale - `afk_timeout` union - 60 - 300 - 900 - 1800 - 3600 - `afk_channel_id` string, snowflake - `system_channel_id` string, snowflake - `splash` string, byte, nullable - `banner` string, byte, nullable - `system_channel_flags` integer, nullable - `features` string[], nullable - `discovery_splash` string, byte, nullable - `home_header` string, byte, nullable - `rules_channel_id` string, snowflake - `safety_alerts_channel_id` string, snowflake - `public_updates_channel_id` string, snowflake - `premium_progress_bar_enabled` boolean, nullable ## Response `200` 200 response for update_guild - GuildResponse - `id` string, snowflake, required - `name` string, required - `icon` string, nullable, required - `description` string, nullable, required - `home_header` string, nullable, required - `splash` string, nullable, required - `discovery_splash` string, nullable, required - `features` GuildFeatures[], required - union - 'ANIMATED_BANNER' — guild has access to set an animated guild banner image - 'ANIMATED_ICON' — guild has access to set an animated guild icon - 'APPLICATION_COMMAND_PERMISSIONS_V2' — guild is using the old permissions configuration behavior - 'AUTO_MODERATION' — guild has set up auto moderation rules - 'BANNER' — guild has access to set a guild banner image - 'COMMUNITY' — guild can enable welcome screen, Membership Screening, stage channels and discovery, and receives community updates - 'CREATOR_MONETIZABLE_PROVISIONAL' — guild has enabled monetization - 'CREATOR_STORE_PAGE' — guild has enabled the role subscription promo page - 'DEVELOPER_SUPPORT_SERVER' — guild has been set as a support server on the App Directory - 'DISCOVERABLE' — guild is able to be discovered in the directory - 'FEATURABLE' — guild is able to be featured in the directory - 'INVITES_DISABLED' — guild has paused invites, preventing new users from joining - 'INVITE_SPLASH' — guild has access to set an invite splash background - 'MEMBER_VERIFICATION_GATE_ENABLED' — guild has enabled Membership Screening - 'MORE_STICKERS' — guild has increased custom sticker slots - 'NEWS' — guild has access to create announcement channels - 'PARTNERED' — guild is partnered - 'PREVIEW_ENABLED' — guild can be previewed before joining via Membership Screening or the directory - 'RAID_ALERTS_DISABLED' — guild has disabled activity alerts in the configured safety alerts channel - 'PRUNE_REQUIRES_ADMIN' — guild has restricted member prune to administrators and the guild owner - 'ROLE_ICONS' — guild is able to set role icons - 'ROLE_SUBSCRIPTIONS_AVAILABLE_FOR_PURCHASE' — guild has role subscriptions that can be purchased - 'ROLE_SUBSCRIPTIONS_ENABLED' — guild has enabled role subscriptions - 'TICKETED_EVENTS_ENABLED' — guild has enabled ticketed events - 'VANITY_URL' — guild has access to set a vanity URL - 'VERIFIED' — guild is verified - 'VIP_REGIONS' — guild has access to set 384kbps bitrate in voice (previously VIP voice servers) - 'WELCOME_SCREEN_ENABLED' — guild has enabled the welcome screen - 'OFFICIAL_GAME_GUILD' — guild is an official guild for one or more games - `banner` string, nullable, required - `owner_id` string, snowflake, required - `application_id` string, snowflake, required - `region` string, required - `afk_channel_id` string, snowflake, required - `afk_timeout` union, required - 60 - 300 - 900 - 1800 - 3600 - `system_channel_id` string, snowflake, required - `system_channel_flags` integer, required - `widget_enabled` boolean, required - `widget_channel_id` string, snowflake, required - `verification_level` union, required - 0 — unrestricted - 1 — must have verified email on account - 2 — must be registered on Discord for longer than 5 minutes - 3 — must be a member of the server for longer than 10 minutes - 4 — must have a verified phone number - `roles` GuildRoleResponse[], required - `id` string, snowflake, required - `name` string, required - `permissions` string, required - `position` integer, required - `color` integer, required - `colors` GuildRoleColorsResponse, required - `primary_color` integer, required - `secondary_color` integer, nullable, required - `tertiary_color` integer, nullable, required - `hoist` boolean, required - `managed` boolean, required - `mentionable` boolean, required - `icon` string, nullable, required - `unicode_emoji` string, nullable, required - `tags` GuildRoleTagsResponse - `premium_subscriber` unknown - `bot_id` string, snowflake - `integration_id` string, snowflake - `subscription_listing_id` string, snowflake - `available_for_purchase` unknown - `guild_connections` unknown - `flags` integer, required - `default_message_notifications` union, required - 0 — members will receive notifications for all messages by default - 1 — members will receive notifications only for messages that @mention them by default - `mfa_level` union, required - 0 — Guild has no MFA/2FA requirement for moderation actions - 1 — Guild has a 2FA requirement for moderation actions - `explicit_content_filter` union, required - 0 — media content will not be scanned - 1 — media content sent by members without roles will be scanned - 2 — media content sent by all members will be scanned - `max_presences` integer, nullable, required - `max_members` integer, required - `max_stage_video_channel_users` integer, required - `max_video_channel_users` integer, required - `vanity_url_code` string, nullable, required - `premium_tier` union, required - 0 — Guild has not unlocked any Server Boost perks - 1 — Guild has unlocked Server Boost level 1 perks - 2 — Guild has unlocked Server Boost level 2 perks - 3 — Guild has unlocked Server Boost level 3 perks - `premium_subscription_count` integer, required - `preferred_locale` union, required - 'ar' — The ar locale - 'bg' — The bg locale - 'cs' — The cs locale - 'da' — The da locale - 'de' — The de locale - 'el' — The el locale - 'en-GB' — The en-GB locale - 'en-US' — The en-US locale - 'es-419' — The es-419 locale - 'es-ES' — The es-ES locale - 'fi' — The fi locale - 'fr' — The fr locale - 'he' — The he locale - 'hi' — The hi locale - 'hr' — The hr locale - 'hu' — The hu locale - 'id' — The id locale - 'it' — The it locale - 'ja' — The ja locale - 'ko' — The ko locale - 'lt' — The lt locale - 'nl' — The nl locale - 'no' — The no locale - 'pl' — The pl locale - 'pt-BR' — The pt-BR locale - 'ro' — The ro locale - 'ru' — The ru locale - 'sv-SE' — The sv-SE locale - 'th' — The th locale - 'tr' — The tr locale - 'uk' — The uk locale - 'vi' — The vi locale - 'zh-CN' — The zh-CN locale - 'zh-TW' — The zh-TW locale - `rules_channel_id` string, snowflake, required - `safety_alerts_channel_id` string, snowflake, required - `public_updates_channel_id` string, snowflake, required - `premium_progress_bar_enabled` boolean, required - `premium_progress_bar_enabled_user_updated_at` string, date-time, nullable - `nsfw` boolean, required - `nsfw_level` union, required - 0 - 1 - 2 - 3 - `emojis` EmojiResponse[], required - `id` string, snowflake, required - `name` string, required - `user` UserResponse - `id` string, snowflake, required - `username` string, required — the user's username, not unique across the platform - `avatar` string, nullable, required — the user's avatar hash - `discriminator` string, required — the user's Discord-tag - `public_flags` integer, required — the public flags on a user's account - `flags` integer, required - `bot` boolean — whether the user belongs to an OAuth2 application - `system` boolean — whether the user is an Official Discord System user (part of the urgent message system) - `banner` string, nullable — the user's banner hash - `accent_color` integer, nullable — the user's banner color encoded as an integer representation of hexadecimal color code - `global_name` string, nullable, required — the user's display name, if it is set - `avatar_decoration_data` UserAvatarDecorationResponse - `asset` string, required — the avatar decoration hash - `sku_id` string, snowflake, required - `collectibles` UserCollectiblesResponse - `nameplate` UserNameplateResponse, required - `sku_id` string, snowflake, required - `asset` string, required — Path to the nameplate asset - `label` string, required — The label of this nameplate. Currently unused - `palette` union, required - 'crimson' — Crimson color palette - 'berry' — Berry color palette - 'sky' — Sky color palette - 'teal' — Teal color palette - 'forest' — Forest color palette - 'bubble_gum' — Bubble gum color palette - 'violet' — Violet color palette - 'cobalt' — Cobalt color palette - 'clover' — Clover color palette - 'lemon' — Lemon color palette - 'white' — White color palette - 'black' — Black color palette - `primary_guild` UserPrimaryGuildResponse, required - `identity_guild_id` string, snowflake, required - `identity_enabled` boolean, nullable, required — whether the user is displaying the primary guild's server tag - `tag` string, nullable, required — the text of the user's server tag, limited to 4 characters - `badge` string, nullable, required — the server tag badge hash - `roles` SnowflakeType[], required - `require_colons` boolean, required - `managed` boolean, required - `animated` boolean, required - `available` boolean, required - `stickers` GuildStickerResponse[], required - `id` string, snowflake, required - `name` string, required - `tags` string, required - `type` union, required - 1 — an official sticker in a pack, part of Nitro or in a removed purchasable pack - 2 — a sticker uploaded to a guild for the guild's members - `format_type` union, required - 1 - 2 - 3 - 4 - `description` string, nullable, required - `available` boolean, required - `guild_id` string, snowflake, required - `user` UserResponse - `id` string, snowflake, required - `username` string, required — the user's username, not unique across the platform - `avatar` string, nullable, required — the user's avatar hash - `discriminator` string, required — the user's Discord-tag - `public_flags` integer, required — the public flags on a user's account - `flags` integer, required - `bot` boolean — whether the user belongs to an OAuth2 application - `system` boolean — whether the user is an Official Discord System user (part of the urgent message system) - `banner` string, nullable — the user's banner hash - `accent_color` integer, nullable — the user's banner color encoded as an integer representation of hexadecimal color code - `global_name` string, nullable, required — the user's display name, if it is set - `avatar_decoration_data` UserAvatarDecorationResponse - `asset` string, required — the avatar decoration hash - `sku_id` string, snowflake, required - `collectibles` UserCollectiblesResponse - `nameplate` UserNameplateResponse, required - `sku_id` string, snowflake, required - `asset` string, required — Path to the nameplate asset - `label` string, required — The label of this nameplate. Currently unused - `palette` union, required - 'crimson' — Crimson color palette - 'berry' — Berry color palette - 'sky' — Sky color palette - 'teal' — Teal color palette - 'forest' — Forest color palette - 'bubble_gum' — Bubble gum color palette - 'violet' — Violet color palette - 'cobalt' — Cobalt color palette - 'clover' — Clover color palette - 'lemon' — Lemon color palette - 'white' — White color palette - 'black' — Black color palette - `primary_guild` UserPrimaryGuildResponse, required - `identity_guild_id` string, snowflake, required - `identity_enabled` boolean, nullable, required — whether the user is displaying the primary guild's server tag - `tag` string, nullable, required — the text of the user's server tag, limited to 4 characters - `badge` string, nullable, required — the server tag badge hash - `incidents_data` GuildIncidentsDataResponse, required - `invites_disabled_until` string, date-time, nullable, required — When invites get enabled again - `dms_disabled_until` string, date-time, nullable, required — When direct messages get enabled again ## Other responses - `429` — Client ratelimited response - `4XX` — Client error response --- [API](https://skmtc.net/discord/apis/discord-http-api-preview.md) · [All operations](https://skmtc.net/discord/apis/discord-http-api-preview/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/discord/discord-http-api-preview/versions/f6cd197cbe47/schema)