guild_modify_welcome_screen
guild_modify_welcome_screen
Section titled “guild_modify_welcome_screen”Category: guild
Update the Community welcome screen.
When to use
Section titled “When to use”- Toggle enabled, change top description, swap the up-to-5 highlighted channels.
welcome_channels is the FULL replacement list (no PATCH-merge). Pass null for description to clear.
When NOT to use
Section titled “When NOT to use”| Field | Type | Required | Description |
|---|---|---|---|
guild_id | string | yes | Guild to modify |
enabled | boolean | no | |
welcome_channels | array | no | |
description | unknown | no | |
audit_reason | string | no | Reason recorded in audit log (X-Audit-Log-Reason header) |
Returns
Section titled “Returns”\{description, welcome_channels\}.
Output schema
Section titled “Output schema”| Field | Type | Required | Description |
|---|---|---|---|
description | unknown | yes | |
welcome_channels | array | yes |
Annotations
Section titled “Annotations”| Property | Value |
|---|---|
| Read-only | no |
| Destructive | no |
| Idempotent | yes |
| Open-world | yes |
| Confirmation required | no |