Sign in
Rosters

Update a dashboard roster

patch/v2/roster/{rosterId}

Request

  • Base URL: https://api.clashk.ing
  • URL: https://api.clashk.ing/v2/roster/{rosterId}
  • Auth: one of:
    • HTTP bearer
    • HTTP bearer

Path parameters

rosterIdstring required

Query parameters

server_idstring required

Request body

aliasstring
descriptionstring nullable
roster_type'clan' | 'family'
signup_scope'clan-only' | 'family-wide'
clan_tagstring nullable
group_idstring nullable
max_accounts_per_userinteger nullable
columnsstring[]
webhook_idstring nullable
message_idstring nullable
imagestring nullable

Response

Success

messagestring required

Changes

No recorded changes to this operation across all 3 revisions of this API.