Clan Resource

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.

Clan Object

Clan Structure

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)

Partial Clan Structure

Field	Type	Description
tag	string	The tag of the clan (2-4 characters)
badge	integer	The badge shown on the clan's tag

Clan Play Style

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.	💀

Clan Badge Type

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

Clan Banner Style

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

Example Clan

{
  "id": "1094450071610863667",
  "name": "Apple's Tree",
  "tag": "CUTE",
  "icon_hash": "f25500db1de69d66a679c5fb2bdce28c",
  "play_style": 2,
  "member_count": 235,
  "description": "Welcome to Apple's Tree! We are a chaotic bunch that groups together to play various games and laugh a little. Join our vibrant community and make memories!",
  "search_terms": [
    "English",
    "Work-life Balance",
    "20+",
    "cars",
    "anime",
    "Inclusive",
    "Beginner Friendly",
    "travel",
    "Server: NA",
    "Streamers",
    "music",
    "All Ranks",
    "Server: EU"
  ],
  "game_application_ids": [
    "356876176465199104",
    "1158877933042143272",
    "1149118246826561609",
    "432980957394370572",
    "700136079562375258",
    "356875570916753438"
  ],
  "badge": 7,
  "badge_color_primary": "#c03f7d",
  "badge_color_secondary": "#ff80bd",
  "banner": 6,
  "brand_color_primary": "#c03f7d",
  "brand_color_secondary": "#ff80bd",
  "wildcard_descriptors": ["Friendly", "Active", "Funny"],
  "badge_hash": "0fcf9a436df1a4b0de5644d3d42188e2",
  "banner_hash": "670481d4ce15cfe3621a7dd38ce77c6f"
}

Endpoints

Set Clan Identity

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.

JSON Params

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 Clans

GET/discovery/games/{game_type}

Returns a list of clan objects for a game type.

Game Type

Value	Description
all	All clans
genshin	Clans for Genshin Impact
valorant	Clans for Valorant

Get Clan

GET/discovery/{guild.id}/clan

Returns a clan object associated with a guild if it has one.

Create Clan

POST/clan/{guild.id}

Enables clan features for a guild. Returns a 204 empty response on success. Fires a Guild Update Gateway event.

JSON Params

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 object	The member verification shown to applicants

¹ When modifying, only the form_fields and optionally description fields are accepted.

Get Clan Settings

GET/clan/{guild.id}/settings

Returns a guild's clan settings.

Response Body

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 object	The member verification data shown to applicants

Modify Clan Settings

PATCH/clan/{guild.id}/settings

Updates a guild's clan settings. Returns a 204 empty response on success.

JSON Params

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 object	The member verification data shown to applicants

¹ When modifying, only the form_fields and optionally description fields are accepted.

Disable Clan

POST/clan/{guild.id}/disable

Disables clan features for a guild. Returns a 204 empty response on success. Fires a Guild Update Gateway event.