Skip to main content
PATCH
/
guilds
/
{guild_id}
/
welcome-screen
cURL
curl --request PATCH \
  --url https://discord.com/api/v10/guilds/{guild_id}/welcome-screen \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "description": "<string>",
  "welcome_channels": [
    {
      "channel_id": "<string>",
      "description": "<string>",
      "emoji_id": "<unknown>",
      "emoji_name": "<string>"
    }
  ],
  "enabled": true
}
'
{
  "description": "<string>",
  "welcome_channels": [
    {
      "channel_id": "<string>",
      "description": "<string>",
      "emoji_id": "<unknown>",
      "emoji_name": "<string>"
    }
  ]
}

Authorizations

Authorization
string
header
required

Discord bot token

Path Parameters

guild_id
string<snowflake>
required

Body

application/json
description
string | null
Maximum string length: 140
welcome_channels
object[] | null
Maximum array length: 5
enabled
boolean | null

Response

200 response for update_guild_welcome_screen

description
string | null
required
welcome_channels
object[]
required