Skip to main content
PUT
/
guilds
/
{guild_id}
/
onboarding
cURL
curl --request PUT \
  --url https://discord.com/api/v10/guilds/{guild_id}/onboarding \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "prompts": [
    {
      "title": "<string>",
      "options": [
        {
          "title": "<string>",
          "id": "<unknown>",
          "description": "<string>",
          "emoji_id": "<unknown>",
          "emoji_name": "<string>",
          "emoji_animated": true,
          "role_ids": [
            "<string>"
          ],
          "channel_ids": [
            "<string>"
          ]
        }
      ],
      "id": "<string>",
      "single_select": true,
      "required": true,
      "in_onboarding": true,
      "type": "<unknown>"
    }
  ],
  "enabled": true,
  "default_channel_ids": [
    "<string>"
  ],
  "mode": "<unknown>"
}
'
{
  "guild_id": "<string>",
  "prompts": [
    {
      "id": "<string>",
      "title": "<string>",
      "options": [
        {
          "id": "<string>",
          "title": "<string>",
          "description": "<string>",
          "emoji": {
            "id": "<unknown>",
            "name": "<string>",
            "animated": true
          },
          "role_ids": [
            "<string>"
          ],
          "channel_ids": [
            "<string>"
          ]
        }
      ],
      "single_select": true,
      "required": true,
      "in_onboarding": true,
      "type": 123
    }
  ],
  "default_channel_ids": [
    "<string>"
  ],
  "enabled": true
}

Authorizations

Authorization
string
header
required

Discord bot token

Path Parameters

guild_id
string<snowflake>
required

Body

application/json
prompts
object[] | null
Maximum array length: 15
enabled
boolean | null
default_channel_ids
string<snowflake>[] | null
Maximum array length: 500
mode

Only Default Channels considered in constraints

Response

200 response for put_guilds_onboarding

guild_id
string<snowflake>
required
prompts
object[]
required
default_channel_ids
string<snowflake>[]
required
enabled
boolean
required