onboarding_modify
onboarding_modify
Section titled “onboarding_modify”Category: onboarding
Replace a guild’s onboarding configuration (PUT — full replace).
prompts is an array of Discord-shaped prompt objects. See:
https://discord.com/developers/docs/resources/guild#guild-onboarding-object-onboarding-prompt-structure
When to use
Section titled “When to use”When NOT to use
Section titled “When NOT to use”| Field | Type | Required | Description |
|---|---|---|---|
guild_id | string | yes | Target guild |
prompts | array | yes | Onboarding prompts (full replace) — see Discord docs for prompt object shape |
default_channel_ids | array | yes | Channels members see by default after onboarding |
enabled | boolean | yes | Whether onboarding is enabled |
mode | integer | yes | Onboarding mode (0 ONBOARDING_DEFAULT, 1 ONBOARDING_ADVANCED) |
audit_reason | string | no | Reason recorded in audit log (X-Audit-Log-Reason header) |
Returns
Section titled “Returns”\{guild_id, enabled, mode\}.
Output schema
Section titled “Output schema”| Field | Type | Required | Description |
|---|---|---|---|
guild_id | string | yes | Discord guild (server) ID |
enabled | boolean | yes | |
mode | integer | yes |
Annotations
Section titled “Annotations”| Property | Value |
|---|---|
| Read-only | no |
| Destructive | no |
| Idempotent | yes |
| Open-world | yes |
| Confirmation required | no |