diff --git a/docs/reference.mdx b/docs/reference.mdx index 0d7503e6b9..33606ed8aa 100644 --- a/docs/reference.mdx +++ b/docs/reference.mdx @@ -353,6 +353,7 @@ Discord uses ids and hashes to render images in the client. These hashes can be | Role Icon | role-icons/[role_id](/docs/topics/permissions#role-object)/[role_icon](/docs/topics/permissions#role-object).png | PNG, JPEG, WebP | | Guild Scheduled Event Cover | guild-events/[scheduled_event_id](/docs/resources/guild-scheduled-event#guild-scheduled-event-object)/[scheduled_event_cover_image](/docs/resources/guild-scheduled-event#guild-scheduled-event-object).png | PNG, JPEG, WebP | | Guild Member Banner | guilds/[guild_id](/docs/resources/guild#guild-object)/users/[user_id](/docs/resources/user#user-object)/banners/[member_banner](/docs/resources/guild#guild-member-object).png \* | PNG, JPEG, WebP, GIF | +| Guild Tag Badge | guild-tag-badges/[guild_id](/docs/resources/guild#guild-object)/[badge_hash](/docs/resources/user#user-object-user-primary-guild).png | PNG, JPEG, WebP | \* In the case of endpoints that support GIFs, the hash will begin with `a_` if it is available in GIF format. These images can also be retrieved as animated WebP using the `?animated=true` querystring parameter. (example: `a_1269e74af4df7417b13759eae50c83dc`) diff --git a/docs/resources/user.mdx b/docs/resources/user.mdx index 41b1b0a751..f31d414156 100644 --- a/docs/resources/user.mdx +++ b/docs/resources/user.mdx @@ -48,6 +48,7 @@ There are other rules and restrictions not shared here for the sake of spam and | public_flags? | integer | the public [flags](/docs/resources/user#user-object-user-flags) on a user's account | identify | | avatar_decoration_data? | ?[avatar decoration data](/docs/resources/user#avatar-decoration-data-object) object | data for the user's avatar decoration | identify | | collectibles? | ?[collectibles](/docs/resources/user#collectibles) object | data for the user's collectibles | identify | +| primary_guild? | ?[user primary guild](/docs/resources/user#user-object-user-primary-guild) object | the user's primary guild | identify | ###### Example User @@ -75,6 +76,12 @@ There are other rules and restrictions not shared here for the sake of spam and "label": "", "palette": "cobalt" } + }, + "primary_guild": { + "identity_guild_id": "1234647491267808778", + "identity_enabled": true, + "tag": "DISC", + "badge": "7d1734ae5a615e82bc7a4033b98fade8" } } ``` @@ -110,6 +117,15 @@ Premium types denote the level of premium a user has. Visit the [Nitro](https:// | 2 | Nitro | | 3 | Nitro Basic | +###### User Primary Guild + +| Field | Type | Description | +|-------------------|------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| identity_guild_id | ?snowflake | the id of the user's primary guild | +| identity_enabled | ?boolean | whether the user is displaying the primary guild's server tag. This can be `null` if the system clears the identity, e.g. because the server no longer supports tags. | +| tag | ?string | the text of the user's server tag. Limited to 4 characters | +| badge | ?string | the [server tag badge hash](/docs/reference#image-formatting) | + ### Avatar Decoration Data Object The data for the user's [avatar decoration](https://support.discord.com/hc/en-us/articles/13410113109911-Avatar-Decorations).