From c4f31872a53a98f4786a490b939f346375ffb4b3 Mon Sep 17 00:00:00 2001 From: Soheab <33902984+Soheab@users.noreply.github.com> Date: Fri, 19 Sep 2025 19:34:11 +0200 Subject: [PATCH 1/6] Document guild profile --- docs/resources/guild.mdx | 30 ++++++++++++++++++++++++++++++ 1 file changed, 30 insertions(+) diff --git a/docs/resources/guild.mdx b/docs/resources/guild.mdx index 3effec4e51..1bbf7e0adb 100644 --- a/docs/resources/guild.mdx +++ b/docs/resources/guild.mdx @@ -60,11 +60,14 @@ Fields specific to the `GUILD_CREATE` event are listed in the [Gateway Events do | premium_progress_bar_enabled | boolean | whether the guild has the boost progress bar enabled | | safety_alerts_channel_id | ?snowflake | the id of the channel where admins and moderators of Community guilds receive safety alerts from Discord | | incidents_data | ?[incidents data](/docs/resources/guild#incidents-data-object) object | the incidents data for this guild | +| profile? \*\*\* | [guild profile](/docs/resources/guild#guild-profile-object) object | the profile of this guild | \* These fields are only sent when using the [GET Current User Guilds](/docs/resources/user#get-current-user-guilds) endpoint and are relative to the requested user \*\* This field is deprecated and is replaced by [channel.rtc_region](/docs/resources/channel#channel-object-channel-structure) +\*\*\* This field is only sent when using the [GET Invite](docs/resources/invite#get-invite) endpoint. + ###### Default Message Notification Level | Key | Value | Description | @@ -417,6 +420,33 @@ Member objects retrieved from `VOICE_STATE_UPDATE` events will have `joined_at` BYPASSES_VERIFICATION allows a member who does not meet verification requirements to participate in a server. ::: +### Guild Profile Object + +###### Guild Profile Structure + +| Field | Type | Description | +|----------------------------|-------------------------------------------------------------------------------------|------------------------------------------------------------------------------------------------| +| badge | integer | guild badge | +| badge_color_primary | string | primary color for the guild badge | +| badge_color_secondary | string | secondary color for the guild badge | +| badge_hash | ?string | [guild tag badge hash](/docs/reference#image-formatting) | +| banner_hash | ?string | [server tag badge hash](/docs/reference#image-formatting) | +| custom_banner_hash | ?string | [custom banner hash](/docs/reference#image-formatting) | +| description | ?string | the description for the guild | +| features | array of [guild feature](/docs/resources/guild#guild-object-guild-features) strings | enabled guild features | +| game_activity | object | game activity data for the guild | +| game_application_ids | array of snowflakes | application ids for games associated with the guild | +| icon_hash | ?string | [icon hash](/docs/reference#image-formatting) | +| id | snowflake | guild id | +| member_count | integer | total number of members in the guild | +| name | string | guild name | +| online_count | integer | number of online members in the guild | +| premium_subscription_count | integer | the number of boosts this guild currently has | +| premium_tier | integer | [premium tier](/docs/resources/guild#guild-object-premium-tier) (Server Boost level) | +| tag | ?string | tag of the guild | +| traits | array of strings | traits associated with the guild | +| visibility | integer | visibility level of the guild | + ### Integration Object ###### Integration Structure From a42593386b7b6913d44c410c7b0ef63a2e0609dc Mon Sep 17 00:00:00 2001 From: Soheab <33902984+Soheab@users.noreply.github.com> Date: Fri, 19 Sep 2025 19:38:51 +0200 Subject: [PATCH 2/6] it's not part of the guild object --- docs/resources/guild.mdx | 6 ++++-- docs/resources/invite.mdx | 1 + 2 files changed, 5 insertions(+), 2 deletions(-) diff --git a/docs/resources/guild.mdx b/docs/resources/guild.mdx index 1bbf7e0adb..c39b92e856 100644 --- a/docs/resources/guild.mdx +++ b/docs/resources/guild.mdx @@ -60,13 +60,11 @@ Fields specific to the `GUILD_CREATE` event are listed in the [Gateway Events do | premium_progress_bar_enabled | boolean | whether the guild has the boost progress bar enabled | | safety_alerts_channel_id | ?snowflake | the id of the channel where admins and moderators of Community guilds receive safety alerts from Discord | | incidents_data | ?[incidents data](/docs/resources/guild#incidents-data-object) object | the incidents data for this guild | -| profile? \*\*\* | [guild profile](/docs/resources/guild#guild-profile-object) object | the profile of this guild | \* These fields are only sent when using the [GET Current User Guilds](/docs/resources/user#get-current-user-guilds) endpoint and are relative to the requested user \*\* This field is deprecated and is replaced by [channel.rtc_region](/docs/resources/channel#channel-object-channel-structure) -\*\*\* This field is only sent when using the [GET Invite](docs/resources/invite#get-invite) endpoint. ###### Default Message Notification Level @@ -422,6 +420,10 @@ BYPASSES_VERIFICATION allows a member who does not meet verification requirement ### Guild Profile Object +:::info +This object can be retrieved using `profile` field using the [GET Invite](docs/resources/invite#get-invite) endpoint. +::: + ###### Guild Profile Structure | Field | Type | Description | diff --git a/docs/resources/invite.mdx b/docs/resources/invite.mdx index 333c1f3e03..73884c5dea 100644 --- a/docs/resources/invite.mdx +++ b/docs/resources/invite.mdx @@ -25,6 +25,7 @@ Represents a code that when used, adds a user to a guild or group DM channel. | expires_at | ?ISO8601 timestamp | the expiration date of this invite | | guild_scheduled_event? | [guild scheduled event](/docs/resources/guild-scheduled-event#guild-scheduled-event-object) object | guild scheduled event data, only included if `guild_scheduled_event_id` contains a valid guild scheduled event id | | flags? | integer | [guild invite flags](/docs/resources/invite#invite-object-guild-invite-flags) for guild invites | +| profile | [guild profile](/docs/resources/guild#guild-profile-object) object | the profile of this guild | ###### Invite Types From ed607728ef24441f391a9f136c200442e3fd19b9 Mon Sep 17 00:00:00 2001 From: Soheab <33902984+Soheab@users.noreply.github.com> Date: Fri, 19 Sep 2025 19:58:06 +0200 Subject: [PATCH 3/6] Remove newline and grammar --- docs/resources/guild.mdx | 3 +-- 1 file changed, 1 insertion(+), 2 deletions(-) diff --git a/docs/resources/guild.mdx b/docs/resources/guild.mdx index c39b92e856..dc5b3d86da 100644 --- a/docs/resources/guild.mdx +++ b/docs/resources/guild.mdx @@ -65,7 +65,6 @@ Fields specific to the `GUILD_CREATE` event are listed in the [Gateway Events do \*\* This field is deprecated and is replaced by [channel.rtc_region](/docs/resources/channel#channel-object-channel-structure) - ###### Default Message Notification Level | Key | Value | Description | @@ -421,7 +420,7 @@ BYPASSES_VERIFICATION allows a member who does not meet verification requirement ### Guild Profile Object :::info -This object can be retrieved using `profile` field using the [GET Invite](docs/resources/invite#get-invite) endpoint. +This object can only be retrieved through the `profile` field of the [GET Invite](/docs/resources/invite#get-invite) endpoint. ::: ###### Guild Profile Structure From 30e5735e5249df1e436e3ec478d7cd44904ea4bd Mon Sep 17 00:00:00 2001 From: Soheab <33902984+Soheab@users.noreply.github.com> Date: Fri, 19 Sep 2025 19:59:04 +0200 Subject: [PATCH 4/6] Better description for field --- docs/resources/invite.mdx | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/resources/invite.mdx b/docs/resources/invite.mdx index 73884c5dea..f9233b5af7 100644 --- a/docs/resources/invite.mdx +++ b/docs/resources/invite.mdx @@ -25,7 +25,7 @@ Represents a code that when used, adds a user to a guild or group DM channel. | expires_at | ?ISO8601 timestamp | the expiration date of this invite | | guild_scheduled_event? | [guild scheduled event](/docs/resources/guild-scheduled-event#guild-scheduled-event-object) object | guild scheduled event data, only included if `guild_scheduled_event_id` contains a valid guild scheduled event id | | flags? | integer | [guild invite flags](/docs/resources/invite#invite-object-guild-invite-flags) for guild invites | -| profile | [guild profile](/docs/resources/guild#guild-profile-object) object | the profile of this guild | +| profile | [guild profile](/docs/resources/guild#guild-profile-object) object | the guild profile | ###### Invite Types From bc72ef1bbd2a29c50a20cb01cd31f08d3f8e3b40 Mon Sep 17 00:00:00 2001 From: Soheab <33902984+Soheab@users.noreply.github.com> Date: Fri, 19 Sep 2025 20:30:29 +0200 Subject: [PATCH 5/6] Add guild trait object --- docs/resources/guild.mdx | 55 ++++++++++++++++++++++++---------------- 1 file changed, 33 insertions(+), 22 deletions(-) diff --git a/docs/resources/guild.mdx b/docs/resources/guild.mdx index dc5b3d86da..300df7d19e 100644 --- a/docs/resources/guild.mdx +++ b/docs/resources/guild.mdx @@ -425,28 +425,39 @@ This object can only be retrieved through the `profile` field of the [GET Invite ###### Guild Profile Structure -| Field | Type | Description | -|----------------------------|-------------------------------------------------------------------------------------|------------------------------------------------------------------------------------------------| -| badge | integer | guild badge | -| badge_color_primary | string | primary color for the guild badge | -| badge_color_secondary | string | secondary color for the guild badge | -| badge_hash | ?string | [guild tag badge hash](/docs/reference#image-formatting) | -| banner_hash | ?string | [server tag badge hash](/docs/reference#image-formatting) | -| custom_banner_hash | ?string | [custom banner hash](/docs/reference#image-formatting) | -| description | ?string | the description for the guild | -| features | array of [guild feature](/docs/resources/guild#guild-object-guild-features) strings | enabled guild features | -| game_activity | object | game activity data for the guild | -| game_application_ids | array of snowflakes | application ids for games associated with the guild | -| icon_hash | ?string | [icon hash](/docs/reference#image-formatting) | -| id | snowflake | guild id | -| member_count | integer | total number of members in the guild | -| name | string | guild name | -| online_count | integer | number of online members in the guild | -| premium_subscription_count | integer | the number of boosts this guild currently has | -| premium_tier | integer | [premium tier](/docs/resources/guild#guild-object-premium-tier) (Server Boost level) | -| tag | ?string | tag of the guild | -| traits | array of strings | traits associated with the guild | -| visibility | integer | visibility level of the guild | +| Field | Type | Description | +|----------------------------|--------------------------------------------------------------------------------------|------------------------------------------------------------------------------------- | +| badge | integer | guild badge | +| badge_color_primary | string | primary color for the guild badge | +| badge_color_secondary | string | secondary color for the guild badge | +| badge_hash | ?string | [guild tag badge hash](/docs/reference#image-formatting) | +| banner_hash | ?string | [server tag badge hash](/docs/reference#image-formatting) | +| custom_banner_hash | ?string | [custom banner hash](/docs/reference#image-formatting) | +| description | ?string | the description for the guild | +| features | array of [guild feature](/docs/resources/guild#guild-object-guild-features) strings | enabled guild features | +| game_activity | object | game activity data for the guild | +| game_application_ids | array of snowflakes | application ids for games associated with the guild | +| icon_hash | ?string | [icon hash](/docs/reference#image-formatting) | +| id | snowflake | guild id | +| member_count | integer | total number of members in the guild | +| name | string | guild name | +| online_count | integer | number of online members in the guild | +| premium_subscription_count | integer | the number of boosts this guild currently has | +| premium_tier | integer | [premium tier](/docs/resources/guild#guild-object-premium-tier) (Server Boost level) | +| tag | ?string | tag of the guild | +| traits | array of [guild trait object](/docs/resources/guild#guild-object-guild-trait-object) | traits of the guild | +| visibility | integer | visibility level of the guild | + + +###### Guild Trait Object + +| Field | Type | Description | +|----------------|------------|------------------------------------| +| emoji_id | ?snowflake | the id of a guild's custom emoji | +| emoji_name | string | the unicode character of the emoji | +| emoji_animated | boolean | Whether the emoji is animated | +| label | string | The label of the trait | +| position | integer | The position of the trait | ### Integration Object From 349b77163397c375817ed01abd7a0ee4486a6d71 Mon Sep 17 00:00:00 2001 From: Soheab <33902984+Soheab@users.noreply.github.com> Date: Fri, 19 Sep 2025 20:32:51 +0200 Subject: [PATCH 6/6] Remove extra newline --- docs/resources/guild.mdx | 1 - 1 file changed, 1 deletion(-) diff --git a/docs/resources/guild.mdx b/docs/resources/guild.mdx index 300df7d19e..c9a5e54128 100644 --- a/docs/resources/guild.mdx +++ b/docs/resources/guild.mdx @@ -448,7 +448,6 @@ This object can only be retrieved through the `profile` field of the [GET Invite | traits | array of [guild trait object](/docs/resources/guild#guild-object-guild-trait-object) | traits of the guild | | visibility | integer | visibility level of the guild | - ###### Guild Trait Object | Field | Type | Description |