onboarding_modify
Replace a Discord server's onboarding flow by setting prompts, default channels, and enabled mode to fully customize the member onboarding experience.
Instructions
Purpose: Replace a guild's onboarding configuration (PUT - full replace).
prompts is an array of Discord-shaped prompt objects. See:
https://docs.discord.com/developers/resources/guild#guild-onboarding-object-onboarding-prompt-structure
Enabling requirements: Discord requires at least 7 default channels, and at least 5 must allow @everyone to send messages. The generated reference uses a safe disabled configuration; replace it with real channel IDs before setting enabled:true.
Returns: {guild_id, enabled, mode}.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| mode | Yes | Onboarding mode (0 ONBOARDING_DEFAULT, 1 ONBOARDING_ADVANCED) | |
| enabled | Yes | Whether onboarding is enabled | |
| prompts | Yes | Onboarding prompts (full replace) - see Discord docs for prompt object shape | |
| guild_id | Yes | Target guild | |
| audit_reason | No | Reason recorded in audit log (X-Audit-Log-Reason header) | |
| default_channel_ids | Yes | Channels members see by default after onboarding |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
No arguments | |||