Skip to content

Commit 5b63dae

Browse files
advaith1advaith1
authored
document missing fields in Create and Modify Guild (#1764)
1 parent ad3a7fd commit 5b63dae

File tree

1 file changed

+35
-29
lines changed

1 file changed

+35
-29
lines changed

‎docs/resources/Guild.md‎

Lines changed: 35 additions & 29 deletions
Original file line numberDiff line numberDiff line change
@@ -192,18 +192,18 @@ A partial [guild](#DOCS_RESOURCES_GUILD/guild-object) object. Represents an Offl
192192

193193
###### Guild Preview Structure
194194

195-
| Field | Type | Description |
196-
| -------------------------- | ----------------------------------------------------------------------------------- | --------------------------------------------------------- |
197-
| id | snowflake | guild id |
198-
| name | string | guild name (2-100 characters) |
199-
| icon | ?string | [icon hash](#DOCS_REFERENCE/image-formatting) |
200-
| splash | ?string | [splash hash](#DOCS_REFERENCE/image-formatting) |
201-
| discovery_splash | ?string | [discovery splash hash](#DOCS_REFERENCE/image-formatting) |
202-
| emojis | array of [emoji](#DOCS_RESOURCES_EMOJI/emoji-object) objects | custom guild emojis |
203-
| features | array of [guild feature](#DOCS_RESOURCES_GUILD/guild-object-guild-features) strings | enabled guild features |
204-
| approximate_member_count | integer | approximate number of members in this guild |
205-
| approximate_presence_count | integer | approximate number of online members in this guild |
206-
| description | ?string | the description for the guild |
195+
| Field | Type | Description |
196+
| -------------------------- | ----------------------------------------------------------------------------------- | ----------------------------------------------------------- |
197+
| id | snowflake | guild id |
198+
| name | string | guild name (2-100 characters) |
199+
| icon | ?string | [icon hash](#DOCS_REFERENCE/image-formatting) |
200+
| splash | ?string | [splash hash](#DOCS_REFERENCE/image-formatting) |
201+
| discovery_splash | ?string | [discovery splash hash](#DOCS_REFERENCE/image-formatting) |
202+
| emojis | array of [emoji](#DOCS_RESOURCES_EMOJI/emoji-object) objects | custom guild emojis |
203+
| features | array of [guild feature](#DOCS_RESOURCES_GUILD/guild-object-guild-features) strings | enabled guild features |
204+
| approximate_member_count | integer | approximate number of members in this guild |
205+
| approximate_presence_count | integer | approximate number of online members in this guild |
206+
| description | ?string | the description for the guild, if the guild is discoverable |
207207

208208
###### Example Guild Preview
209209

@@ -452,6 +452,8 @@ Create a new guild. Returns a [guild](#DOCS_RESOURCES_GUILD/guild-object) object
452452
| afk_channel_id? | snowflake | id for afk channel |
453453
| afk_timeout? | integer | afk timeout in seconds |
454454
| system_channel_id? | snowflake | the id of the channel where guild notices such as welcome messages and boost events are posted |
455+
| system_channel_flags? | integer | [system channel flags](#DOCS_RESOURCES_GUILD/guild-object-system-channel-flags) |
456+
455457

456458
> warn
457459
> When using the `roles` parameter, the first member of the array is used to change properties of the guild's `@everyone` role. If you are trying to bootstrap a guild with additional roles, keep this in mind.
@@ -576,23 +578,27 @@ Modify a guild's settings. Requires the `MANAGE_GUILD` permission. Returns the u
576578
577579
###### JSON Params
578580

579-
| Field | Type | Description |
580-
| ----------------------------- | ----------------------------------------- | ------------------------------------------------------------------------------------------------------------------------ |
581-
| name | string | guild name |
582-
| region | ?string | guild [voice region](#DOCS_RESOURCES_VOICE/voice-region-object) id |
583-
| verification_level | ?integer | [verification level](#DOCS_RESOURCES_GUILD/guild-object-verification-level) |
584-
| default_message_notifications | ?integer | default [message notification level](#DOCS_RESOURCES_GUILD/guild-object-default-message-notification-level) |
585-
| explicit_content_filter | ?integer | [explicit content filter level](#DOCS_RESOURCES_GUILD/guild-object-explicit-content-filter-level) |
586-
| afk_channel_id | ?snowflake | id for afk channel |
587-
| afk_timeout | integer | afk timeout in seconds |
588-
| icon | ?[image data](#DOCS_REFERENCE/image-data) | base64 1024x1024 png/jpeg/gif image for the guild icon (can be animated gif when the server has `ANIMATED_ICON` feature) |
589-
| owner_id | snowflake | user id to transfer guild ownership to (must be owner) |
590-
| splash | ?[image data](#DOCS_REFERENCE/image-data) | base64 16:9 png/jpeg image for the guild splash (when the server has `INVITE_SPLASH` feature) |
591-
| banner | ?[image data](#DOCS_REFERENCE/image-data) | base64 16:9 png/jpeg image for the guild banner (when the server has `BANNER` feature) |
592-
| system_channel_id | ?snowflake | the id of the channel where guild notices such as welcome messages and boost events are posted |
593-
| rules_channel_id | ?snowflake | the id of the channel where Community guilds display rules and/or guidelines |
594-
| public_updates_channel_id | ?snowflake | the id of the channel where admins and moderators of Community guilds receive notices from Discord |
595-
| preferred_locale | ?string | the preferred locale of a Community guild used in server discovery and notices from Discord; defaults to "en-US" |
581+
| Field | Type | Description |
582+
| ----------------------------- | ----------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------- |
583+
| name | string | guild name |
584+
| region | ?string | guild [voice region](#DOCS_RESOURCES_VOICE/voice-region-object) id |
585+
| verification_level | ?integer | [verification level](#DOCS_RESOURCES_GUILD/guild-object-verification-level) |
586+
| default_message_notifications | ?integer | default [message notification level](#DOCS_RESOURCES_GUILD/guild-object-default-message-notification-level) |
587+
| explicit_content_filter | ?integer | [explicit content filter level](#DOCS_RESOURCES_GUILD/guild-object-explicit-content-filter-level) |
588+
| afk_channel_id | ?snowflake | id for afk channel |
589+
| afk_timeout | integer | afk timeout in seconds |
590+
| icon | ?[image data](#DOCS_REFERENCE/image-data) | base64 1024x1024 png/jpeg/gif image for the guild icon (can be animated gif when the server has the `ANIMATED_ICON` feature) |
591+
| owner_id | snowflake | user id to transfer guild ownership to (must be owner) |
592+
| splash | ?[image data](#DOCS_REFERENCE/image-data) | base64 16:9 png/jpeg image for the guild splash (when the server has the `INVITE_SPLASH` feature) |
593+
| discovery_splash | ?[image data](#DOCS_REFERENCE/image-data) | base64 16:9 png/jpeg image for the guild discovery splash (when the server has the `DISCOVERABLE` feature) |
594+
| banner | ?[image data](#DOCS_REFERENCE/image-data) | base64 16:9 png/jpeg image for the guild banner (when the server has the `BANNER` feature) |
595+
| system_channel_id | ?snowflake | the id of the channel where guild notices such as welcome messages and boost events are posted |
596+
| system_channel_flags | integer | [system channel flags](#DOCS_RESOURCES_GUILD/guild-object-system-channel-flags) |
597+
| rules_channel_id | ?snowflake | the id of the channel where Community guilds display rules and/or guidelines |
598+
| public_updates_channel_id | ?snowflake | the id of the channel where admins and moderators of Community guilds receive notices from Discord |
599+
| preferred_locale | ?string | the preferred locale of a Community guild used in server discovery and notices from Discord; defaults to "en-US" |
600+
| features | array of [guild feature](#DOCS_RESOURCES_GUILD/guild-object-guild-features) strings | enabled guild features |
601+
| description | ?string | the description for the guild, if the guild is discoverable |
596602

597603
## Delete Guild % DELETE /guilds/{guild.id#DOCS_RESOURCES_GUILD/guild-object}
598604

0 commit comments

Comments
 (0)