guild_modify_widget
guild_modify_widget
Section titled “guild_modify_widget”Category: guild
Update widget settings (toggle enabled, set invite channel).
When to use
Section titled “When to use”- Toggle the public widget on/off, change which channel an embed-invite points at.
When NOT to use
Section titled “When NOT to use”| Field | Type | Required | Description |
|---|---|---|---|
guild_id | string | yes | Guild to modify |
enabled | boolean | no | |
channel_id | unknown | no | |
audit_reason | string | no | Reason recorded in audit log (X-Audit-Log-Reason header) |
Returns
Section titled “Returns”\{enabled, channel_id\}.
Output schema
Section titled “Output schema”| Field | Type | Required | Description |
|---|---|---|---|
enabled | boolean | yes | |
channel_id | unknown | yes |
Annotations
Section titled “Annotations”| Property | Value |
|---|---|
| Read-only | no |
| Destructive | no |
| Idempotent | yes |
| Open-world | yes |
| Confirmation required | no |