guild_modify
guild_modify
Section titled “guild_modify”Category: guild
Update guild-level settings. Pass only fields you want to change.
When to use
Section titled “When to use”- Rename, change verification level, set system/rules/safety channels, toggle premium progress bar, etc.
When NOT to use
Section titled “When NOT to use”- Channels → use
channels_modify. Roles → useroles_modify. Welcome screen → useguild_modify_welcome_screen.
| Field | Type | Required | Description |
|---|---|---|---|
guild_id | string | yes | Guild to modify |
name | string | no | |
verification_level | integer | no | |
default_message_notifications | integer | no | |
explicit_content_filter | integer | no | |
afk_channel_id | unknown | no | |
afk_timeout | unknown | no | |
icon | unknown | no | base64 image data or null |
owner_id | string | no | Transfer ownership (must already be guild owner) |
splash | unknown | no | |
discovery_splash | unknown | no | |
banner | unknown | no | |
system_channel_id | unknown | no | |
system_channel_flags | integer | no | System channel flags bitfield (see Discord docs) |
rules_channel_id | unknown | no | |
public_updates_channel_id | unknown | no | |
preferred_locale | string | no | |
features | array | no | |
description | unknown | no | |
premium_progress_bar_enabled | boolean | no | |
safety_alerts_channel_id | unknown | no | |
audit_reason | string | no | Reason recorded in audit log (X-Audit-Log-Reason header) |
Returns
Section titled “Returns”projected guild shape \{id, name, icon, owner_id, description, preferred_locale, features\}. name and description are wrapped (server-owner controlled).
Output schema
Section titled “Output schema”| Field | Type | Required | Description |
|---|---|---|---|
id | string | yes | Discord guild (server) ID |
name | string | yes | |
icon | unknown | yes | |
owner_id | string | yes | Discord user ID |
description | unknown | yes | |
preferred_locale | string | yes | |
features | array | yes | |
untrusted_text | string | yes |
Annotations
Section titled “Annotations”| Property | Value |
|---|---|
| Read-only | no |
| Destructive | no |
| Idempotent | yes |
| Open-world | yes |
| Confirmation required | no |