Clans are an extension of guilds that are intended for small gaming communities, offering users the ability to display a global badge representing their group.
They require an application to join, and thus have guild previewing disabled and member verification manual approval by default.
Field Type Description id snowflake The ID of the guild name string The name of the guild (2-100 characters) tag string The tag of the clan (2-4 characters) icon_hash ?string The guild's icon hash member_count integer Approximate count of total members in the guild description ?string The description for the clan; this can be different than the guild's description (max 160 characters) play_style? integer The play style of the clan search_terms? array[string] Interests, topics, or traits for the clan (max 30, max 24 characters) game_application_ids? array[snowflake] The IDs of the applications representing the games the clan plays (max 20) badge? integer The badge shown on the clan's tag badge_hash? string The clan's badge hash badge_color_primary? string The primary color of the badge as a hexadecimal color string badge_color_secondary? string The secondary color of the badge as a hexadecimal color string banner? integer The banner representing the clan banner_hash? string The clan's banner hash brand_color_primary? string The primary color of the banner as a hexadecimal color string brand_color_secondary? string The secondary color of the banner as a hexadecimal color string wildcard_descriptors? array[string] Terms to describe the clan (max 3, max 12 characters) game_activity? map[snowflake, game activity object] The activity of the clan in each game discovery_profile_features? array[string] Clan-specific guild features
Field Type Description activity_level integer The activity level of the clan in the game activity_score integer The activity score of the clan in the game
Value Name Title Subtitle Emoji 0 NONE 1 SOCIAL Very Casual Skill doesn't matter. We have a good time win or lose. 👋 2 CASUAL Casual We play to chill and have fun, but more fun if we win! 🎮 3 COMPETITIVE Competitive We play together to win, rank up, or beat challenges. ⚔️ 4 CREATIVE 5 VERY_COMPETITIVE Very Competitive We won't sleep until we win. 💀
Value Name 0 SWORD 1 WATER_DROP 2 SKULL 3 TOADSTOOL 4 MOON 5 LIGHTNING 6 LEAF 7 HEART 8 FIRE 9 COMPASS 10 CROSSHAIRS 11 FLOWER 12 FORCE 13 GEM 14 LAVA 15 PSYCHIC 16 SMOKE 17 SNOW 18 SOUND 19 SUN 20 WIND
Value Name 0 NIGHT_SKY 1 CASTLE 2 WORLD_MAP 3 SEA_FOAM 4 WARP_TUNNEL 5 HOUSE 6 HEIGHT_MAP 7 MESH 8 SPATTER
{
"id" : "1241115476021481582" ,
"name" : "Fehlerj\u00e4ger" ,
"tag" : "BUG" ,
"icon_hash" : "b47f6747d7d6548b6f3eaf8c8e8af20c" ,
"member_count" : 120 ,
"description" : "Do you enjoy finding those creepy crawlies? \ud83d\udc1b We seek those with a keen eye and ability for uncovering hidden gems. Not all bugs are what they seem \ud83d\udd0e Ready to join the hunt?" ,
"search_terms" : [ "Tech" , "P0" , "Work-life Balance" , "H1" , "Security" ] ,
"badge" : 6 ,
"badge_color_primary" : "#219b54" ,
"badge_color_secondary" : "#57b59e" ,
"banner" : 7 ,
"brand_color_primary" : "#7cf895" ,
"brand_color_secondary" : "#f5cc74" ,
"wildcard_descriptors" : [ "open discord" , "do bug" , "" ] ,
"badge_hash" : "6cdb13f9bdba1234e711a7c24dce1f51" ,
"banner_hash" : "1468ceeb0f9c384826b982b7eddbfa6f" ,
"play_style" : 0 ,
"game_application_ids" : [ "356869127241072640" ] ,
"game_activity" : {
"356869127241072640" : {
"activity_level" : 1 ,
"activity_score" : 45
}
} ,
"discovery_profile_features" : [ "CLAN_DISCOVERY_DISABLED" ]
}
PUT/users/@me/clan
Sets the current user's primary clan. Returns an outdated partial user object on success. Fires a User Update Gateway event.
Field Type Description identity_enabled boolean Whether the clan tag is enabled identity_guild_id ?snowflake The guild ID of the clan to be associated with, if any
GET/discovery/{guild.id}/clan
Returns a clan object associated with a guild if it has one.
POST/clan/{guild.id}
Enables clan features for a guild. Returns a 204 empty response on success. Fires a Guild Update Gateway event.
Field Type Description tag string The tag of the clan (2-4 characters) game_application_ids array[snowflake] The IDs of the applications representing the games the clan plays (max 20) search_terms array[string] Interests, topics, or traits for the clan (max 30, max 24 characters) play_style integer The play style of the clan description string The description for the clan; this can be different than the guild's description (max 160 characters) wildcard_descriptors array[string] Terms to describe the clan (max 3, max 12 characters) badge integer The badge shown on the clan's tag badge_color_primary string The primary color of the badge as a hexadecimal color string badge_color_secondary string The secondary color of the badge as a hexadecimal color string banner integer The banner representing the clan brand_color_primary string The primary color of the banner as a hexadecimal color string brand_color_secondary string The secondary color of the banner as a hexadecimal color string verification_form 1 member verification objectThe member verification shown to applicants
1 When modifying, only the and optionally fields are accepted.
GET/clan/{guild.id}/settings
Returns a guild's clan settings.
Field Type Description tag string The tag of the clan (2-4 characters) game_application_ids array[snowflake] The IDs of the applications representing the games the clan plays (max 20) search_terms array[string] Interests, topics, or traits for the clan (max 30, max 24 characters) play_style integer The play style of the clan description string The description for the clan; this can be different than the guild's description (max 160 characters) wildcard_descriptors array[string] Terms to describe the clan (max 3, max 12 characters) badge integer The badge shown on the clan's tag badge_color_primary string The primary color of the badge as a hexadecimal color string badge_color_secondary string The secondary color of the badge as a hexadecimal color string banner integer The banner representing the clan brand_color_primary string The primary color of the banner as a hexadecimal color string brand_color_secondary string The secondary color of the banner as a hexadecimal color string verification_form member verification objectThe member verification data shown to applicants
PATCH/clan/{guild.id}/settings
Updates a guild's clan settings. Returns a 204 empty response on success.
Modifying a clan's will remove the tag from any users who have the clan set as their primary clan. Users must re-enable it using the Set Clan Identity endpoint.
Field Type Description tag? string The tag of the clan (2-4 characters) game_application_ids? array[snowflake] The IDs of the applications representing the games the clan plays (max 20) search_terms? array[string] Interests, topics, or traits for the clan (max 30, max 24 characters) play_style? integer The play style of the clan description? string The description for the clan; this can be different than the guild's description (max 160 characters) wildcard_descriptors? array[string] Terms to describe the clan (max 3, max 12 characters) badge? integer The badge shown on the clan's tag badge_color_primary? string The primary color of the badge as a hexadecimal color string badge_color_secondary? string The secondary color of the badge as a hexadecimal color string banner? integer The banner representing the clan brand_color_primary? string The primary color of the banner as a hexadecimal color string brand_color_secondary? string The secondary color of the banner as a hexadecimal color string verification_form? 1 member verification objectThe member verification data shown to applicants
1 When modifying, only the and optionally fields are accepted.
POST/clan/{guild.id}/disable
Disables clan features for a guild. Returns a 204 empty response on success. Fires a Guild Update Gateway event.