Skip to main content
PATCH
/
guilds
/
{guild_id}
cURL
curl --request PATCH \
  --url https://discord.com/api/v10/guilds/{guild_id} \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "description": "<string>",
  "region": "<string>",
  "icon": "<string>",
  "verification_level": "<unknown>",
  "default_message_notifications": "<unknown>",
  "explicit_content_filter": "<unknown>",
  "preferred_locale": "<unknown>",
  "afk_timeout": "<unknown>",
  "afk_channel_id": "<unknown>",
  "system_channel_id": "<unknown>",
  "splash": "<string>",
  "banner": "<string>",
  "system_channel_flags": 123,
  "features": [
    "<string>"
  ],
  "discovery_splash": "<string>",
  "home_header": "<string>",
  "rules_channel_id": "<unknown>",
  "safety_alerts_channel_id": "<unknown>",
  "public_updates_channel_id": "<unknown>",
  "premium_progress_bar_enabled": true
}
'
{
  "id": "<string>",
  "name": "<string>",
  "icon": "<string>",
  "description": "<string>",
  "home_header": "<string>",
  "splash": "<string>",
  "discovery_splash": "<string>",
  "features": [
    "<string>"
  ],
  "banner": "<string>",
  "owner_id": "<string>",
  "application_id": "<unknown>",
  "region": "<string>",
  "afk_channel_id": "<unknown>",
  "afk_timeout": 123,
  "system_channel_id": "<unknown>",
  "system_channel_flags": 123,
  "widget_enabled": true,
  "widget_channel_id": "<unknown>",
  "verification_level": 123,
  "roles": [
    {
      "id": "<string>",
      "name": "<string>",
      "description": "<string>",
      "permissions": "<string>",
      "position": 123,
      "color": 123,
      "colors": {
        "primary_color": 123,
        "secondary_color": 123,
        "tertiary_color": 123
      },
      "hoist": true,
      "managed": true,
      "mentionable": true,
      "icon": "<string>",
      "unicode_emoji": "<string>",
      "flags": 123,
      "tags": {
        "premium_subscriber": "<unknown>",
        "bot_id": "<string>",
        "integration_id": "<string>",
        "subscription_listing_id": "<string>",
        "available_for_purchase": "<unknown>",
        "guild_connections": "<unknown>"
      }
    }
  ],
  "default_message_notifications": 123,
  "mfa_level": 123,
  "explicit_content_filter": 123,
  "max_presences": 123,
  "max_members": 123,
  "max_stage_video_channel_users": 123,
  "max_video_channel_users": 123,
  "vanity_url_code": "<string>",
  "premium_tier": 123,
  "premium_subscription_count": 123,
  "preferred_locale": "<string>",
  "rules_channel_id": "<unknown>",
  "safety_alerts_channel_id": "<unknown>",
  "public_updates_channel_id": "<unknown>",
  "premium_progress_bar_enabled": true,
  "nsfw": true,
  "nsfw_level": 123,
  "emojis": [
    {
      "id": "<string>",
      "name": "<string>",
      "roles": [
        "<string>"
      ],
      "require_colons": true,
      "managed": true,
      "animated": true,
      "available": true,
      "user": {
        "id": "<string>",
        "username": "<string>",
        "avatar": "<string>",
        "discriminator": "<string>",
        "public_flags": 123,
        "flags": 0,
        "global_name": "<string>",
        "primary_guild": "<unknown>",
        "bot": true,
        "system": true,
        "banner": "<string>",
        "accent_color": 123,
        "avatar_decoration_data": "<unknown>",
        "collectibles": "<unknown>"
      }
    }
  ],
  "stickers": [
    {
      "id": "<string>",
      "name": "<string>",
      "tags": "<string>",
      "type": 2,
      "format_type": "<unknown>",
      "description": "<string>",
      "available": true,
      "guild_id": "<string>",
      "user": {
        "id": "<string>",
        "username": "<string>",
        "avatar": "<string>",
        "discriminator": "<string>",
        "public_flags": 123,
        "flags": 0,
        "global_name": "<string>",
        "primary_guild": "<unknown>",
        "bot": true,
        "system": true,
        "banner": "<string>",
        "accent_color": 123,
        "avatar_decoration_data": "<unknown>",
        "collectibles": "<unknown>"
      }
    }
  ],
  "premium_progress_bar_enabled_user_updated_at": "2023-11-07T05:31:56Z"
}

Authorizations

Authorization
string
header
required

Discord bot token

Path Parameters

guild_id
string<snowflake>
required

Body

application/json
name
string
Required string length: 2 - 100
description
string | null
Maximum string length: 300
region
string | null
icon
string | null
verification_level

unrestricted

default_message_notifications

members will receive notifications for all messages by default

explicit_content_filter

media content will not be scanned

preferred_locale

The ar locale

Allowed value: "ar"
afk_timeout
afk_channel_id
null | string<snowflake>
system_channel_id
null | string<snowflake>
splash
string | null
banner
string | null
system_channel_flags
integer | null
features
(string | null)[] | null
Maximum array length: 1521
Maximum string length: 152133
discovery_splash
string | null
home_header
string | null
rules_channel_id
null | string<snowflake>
safety_alerts_channel_id
null | string<snowflake>
public_updates_channel_id
null | string<snowflake>
premium_progress_bar_enabled
boolean | null

Response

200 response for update_guild

id
string<snowflake>
required
name
string
required
icon
string | null
required
description
string | null
required
home_header
string | null
required
splash
string | null
required
discovery_splash
string | null
required
features
string[]
required

guild has access to set an animated guild banner image

Allowed value: "ANIMATED_BANNER"
banner
string | null
required
owner_id
string<snowflake>
required
application_id
null | string<snowflake>
required
region
string
required
afk_channel_id
null | string<snowflake>
required
afk_timeout
required
system_channel_id
null | string<snowflake>
required
system_channel_flags
integer<int32>
required
widget_enabled
boolean
required
widget_channel_id
null | string<snowflake>
required
verification_level
required

unrestricted

roles
object[]
required
default_message_notifications
required

members will receive notifications for all messages by default

mfa_level
required

Guild has no MFA/2FA requirement for moderation actions

explicit_content_filter
required

media content will not be scanned

max_presences
integer<int32> | null
required
max_members
integer<int32>
required
max_stage_video_channel_users
integer<int32>
required
max_video_channel_users
integer<int32>
required
vanity_url_code
string | null
required
premium_tier
required

Guild has not unlocked any Server Boost perks

premium_subscription_count
integer<int32>
required
preferred_locale
required

The ar locale

Allowed value: "ar"
rules_channel_id
null | string<snowflake>
required
safety_alerts_channel_id
null | string<snowflake>
required
public_updates_channel_id
null | string<snowflake>
required
premium_progress_bar_enabled
boolean
required
nsfw
boolean
required
nsfw_level
required
emojis
object[]
required
stickers
object[]
required
premium_progress_bar_enabled_user_updated_at
string<date-time> | null