---
title: "Refresh roster data"
method: POST
path: "/v2/server/{serverId}/rosters/{rosterId}/refresh"
tags: ["Roster Builder"]
---

# Refresh roster data

`POST /v2/server/{serverId}/rosters/{rosterId}/refresh`

## Request

- Base URL: `https://api.clashk.ing`
- URL: `https://api.clashk.ing/v2/server/{serverId}/rosters/{rosterId}/refresh`
- Auth: one of:
  - HTTP bearer
  - HTTP bearer

## Path parameters

- `serverId` string, required: Discord snowflake as an unsigned decimal string
- `rosterId` string, required

## Request body

- object
  - `scope` 'data' | 'role', required

## Response `200`

Success

- object
  - `refreshId` string, required
  - `scope` string, required
  - `status` string, required
  - `refreshedPlayers` union, required
    - number
    - 'NaN'
    - 'Infinity'
    - '-Infinity'
  - `failedPlayers` union, required
    - number
    - 'NaN'
    - 'Infinity'
    - '-Infinity'
  - `refreshedAt` string, required
  - `reused` boolean, required
  - `roleId` string: Discord snowflake as an unsigned decimal string
  - `roleMemberUserIds` string[]

---

[API](https://skmtc.dev/clashk/apis/clashking-api.md) - [All operations](https://skmtc.dev/clashk/apis/clashking-api/llms.txt) - [OpenAPI document](https://skmtc.dev/clashk/apis/clashking-api/revisions/8411b4ef8009?raw)