Rosters

Create a dashboard roster

Changed on Sep 9, 2026

post/v2/roster

Request

Base URL: https://api.clashk.ing
URL: https://api.clashk.ing/v2/roster
Auth: one of:
- HTTP bearer
- HTTP bearer

Query parameters

server_idstring required

Request body

max_accounts_per_userinteger nullable

server_idstring

aliasstring required

descriptionstring nullable

roster_type'clan' | 'family' required

signup_scope'clan-only' | 'family-wide' required

clan_tagstring nullable

group_idstring nullable

Response

Success

messagestring required

roster_idstring required

Changes

Sep 9, 20269ec0debedfc6 Revision changes
- breaking
  the request property became required
- breaking
  the request property // became required
- breaking
  the request property became required
- breaking
  the request property became required
- breaking
  request property // list-of-types was narrowed by removing types integer from media type application/json
- breaking
  request property // list-of-types was narrowed by removing types integer from media type application/json
- breaking
  request property // list-of-types was narrowed by removing types integer from media type application/json
- breaking
  request property // list-of-types was narrowed by removing types integer from media type application/json
- breaking
  the // request property type changed from object to no type
- breaking
  response property roster/clan_badge list-of-types was widened by adding types null to media type application/json of response 201
- breaking
  response property roster/clan_name list-of-types was widened by adding types null to media type application/json of response 201
- breaking
  response property roster/event_start_time list-of-types was widened by adding types number and string to media type application/json of response 201
- breaking
  response property roster/max_th list-of-types was widened by adding types number and string to media type application/json of response 201
- breaking
  response property roster/members/items/hero_level_sum list-of-types was widened by adding types number and string to media type application/json of response 201
- breaking
  response property roster/members/items/league_id list-of-types was widened by adding types number and string to media type application/json of response 201
- breaking
  response property roster/members/items/max_percent list-of-types was widened by adding types string to media type application/json of response 201
- breaking
  response property roster/members/items/townhall list-of-types was widened by adding types number and string to media type application/json of response 201
- breaking
  response property roster/members/items/trophies list-of-types was widened by adding types number and string to media type application/json of response 201
- breaking
  response property roster/min_signups list-of-types was widened by adding types number and string to media type application/json of response 201
- breaking
  response property roster/min_th list-of-types was widened by adding types number and string to media type application/json of response 201
- breaking
  response property roster/recurrence_day_of_month list-of-types was widened by adding types number and string to media type application/json of response 201
- breaking
  response property roster/recurrence_days list-of-types was widened by adding types number and string to media type application/json of response 201
- breaking
  the / response's property format changed from uuid to no format for status
- breaking
  the /// response's property type changed from object to no type for status
- info
  api operation id dashboardCreateRoster was added
- info
  the endpoint scheme security BotToken was added to the API
- info
  the endpoint scheme security UserToken was added to the API
- info
  the endpoint scheme security ApiKeyAuth was removed from the API
- info
  added the new optional request property
- info
  added the new optional request property
- info
  for the query request parameter server_id, the type was generalized from integer to string
- info
  request property list-of-types was widened by adding types null to media type application/json
- info
  request property list-of-types was widened by adding types null to media type application/json
- info
  request property list-of-types was widened by adding types null to media type application/json
- info
  request property // list-of-types was widened by adding types string to media type application/json
- info
  removed the non-success response with the status
- info
  removed the non-success response with the status
- info
  added the optional property /// to the response with the status
- info
  added the optional property /// to the response with the status
- info
  added the optional property /// to the response with the status
- info
  added the optional property /// to the response with the status
- info
  added the optional property /// to the response with the status
- info
  added the optional property /// to the response with the status
- info
  added the optional property / to the response with the status
- info
  the response property became required for the status
- info
  the response property became required for the status
- info
  the response property / became required for the status
- info
  the response property / became required for the status
- info
  the response property / became required for the status
- info
  the response property / became required for the status
- info
  the response property / became required for the status
- info
  the response property /// became required for the status
- info
  the response property /// became required for the status
- info
  the response property /// became required for the status
- info
  the response property /// became required for the status
- info
  the response property / became required for the status
- info
  the response property / became required for the status
- info
  the response property / became required for the status
- info
  the response property / became required for the status
- info
  the response property /// became required for the status
- info
  the response property /// became required for the status
- info
  the response property / became required for the status
- info
  the response property became required for the status
- info
  added the required property / to the response with the status

Operation history