diff --git a/docs/resources/guild.mdx b/docs/resources/guild.mdx index 3effec4e51..c9a5e54128 100644 --- a/docs/resources/guild.mdx +++ b/docs/resources/guild.mdx @@ -417,6 +417,47 @@ 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 + +:::info +This object can only be retrieved through the `profile` field of the [GET Invite](/docs/resources/invite#get-invite) endpoint. +::: + +###### 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 [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 ###### Integration Structure diff --git a/docs/resources/invite.mdx b/docs/resources/invite.mdx index 333c1f3e03..f9233b5af7 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 guild profile | ###### Invite Types