Roster Builder

Refresh roster data or prepare role reconciliation

Changed on
post/v2/roster/refresh-data

Request

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

Query parameters

server_idstring required

Discord snowflake as an unsigned decimal string

roster_idstring required

Request body

scope'data' | 'role' required

Response

Success

refreshIdstring required
scope'data' | 'role' required
statusstring required
refreshedAtstring required
reusedboolean required
roleIdstring

Discord snowflake as an unsigned decimal string

roleMemberUserIdsstring[]

Changes

  • 9ec0debedfc6Revision changes
    • breaking

      added the pattern ^\d{1,20}$ to the query request parameter server_id

    • breaking

      the request property became required

    • breaking

      response property failedPlayers list-of-types was widened by adding types number and string to media type application/json of response 200

    • breaking

      response property refreshedPlayers list-of-types was widened by adding types number and string to media type application/json of response 200

    • warning

      added the new data enum value to the response property for the response status

    • warning

      added the new payload_too_large enum value to the response property for the response status

    • warning

      added the new role enum value to the response property for the response status

    • warning

      added the new unprocessable_entity enum value to the response property for the response status

    • info

      api operation id dashboardRosterRefreshData 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 non-success response with the status

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status

    • info

      added the non-success 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's property pattern ^\d{1,20}$ was added for the status

    • info

      the / response's property pattern ^\d{1,20}$ was added for the status