---
title: "PUT /guilds/{guild_id}/onboarding"
method: PUT
path: "/guilds/{guild_id}/onboarding"
---

# PUT /guilds/{guild_id}/onboarding

`PUT /guilds/{guild_id}/onboarding`

## Request body

- UpdateGuildOnboardingRequest
  - `prompts` UpdateOnboardingPromptRequest[], nullable
    - `title` string, required
    - `options` OnboardingPromptOptionRequest[], required
      - `id` string, snowflake
      - `title` string, required
      - `description` string, nullable
      - `emoji_id` string, snowflake
      - `emoji_name` string, nullable
      - `emoji_animated` boolean, nullable
      - `role_ids` SnowflakeType[], nullable
      - `channel_ids` SnowflakeType[], nullable
    - `single_select` boolean, nullable
    - `required` boolean, nullable
    - `in_onboarding` boolean, nullable
    - `type` union
      - 0 — Multiple choice options
      - 1 — Many options shown as a dropdown
    - `id` string, snowflake, required
  - `enabled` boolean, nullable
  - `default_channel_ids` SnowflakeType[], nullable
  - `mode` union
    - 0 — Only Default Channels considered in constraints
    - 1 — Default Channels and Onboarding Prompts considered in constraints

## Response `200`

200 response for put_guilds_onboarding

- GuildOnboardingResponse
  - `guild_id` string, snowflake, required
  - `prompts` OnboardingPromptResponse[], required
    - `id` string, snowflake, required
    - `title` string, required
    - `options` OnboardingPromptOptionResponse[], required
      - `id` string, snowflake, required
      - `title` string, required
      - `description` string, required
      - `emoji` SettingsEmojiResponse, required
        - `id` string, snowflake, required
        - `name` string, nullable, required
        - `animated` boolean, required
      - `role_ids` SnowflakeType[], required
      - `channel_ids` SnowflakeType[], required
    - `single_select` boolean, required
    - `required` boolean, required
    - `in_onboarding` boolean, required
    - `type` union, required
      - 0 — Multiple choice options
      - 1 — Many options shown as a dropdown
  - `default_channel_ids` SnowflakeType[], required
  - `enabled` boolean, required
  - `mode` union, required
    - 0 — Only Default Channels considered in constraints
    - 1 — Default Channels and Onboarding Prompts considered in constraints

## Other responses

- `429` — Client ratelimited response
- `4XX` — Client error response

## Changes

- **2026-04-15** `e2ba79dfc5ba` — 1 info
  - added the required property `mode` to the response with the `200` status
- **2026-02-04** `e200830e509a` — 2 info
  - the response property `prompts/items/options/items/emoji/id` became required for the status `200`
  - the response property `prompts/items/options/items/emoji/name` became required for the status `200`

[Change history](https://skmtc.dev/discord/apis/discord-http-api-preview/changes/guilds/:guild_id/onboarding/put.md)

---

[API](https://skmtc.dev/discord/apis/discord-http-api-preview.md) · [All operations](https://skmtc.dev/discord/apis/discord-http-api-preview/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/discord/discord-http-api-preview/revisions/49efa428e0dd/schema)