My Account

Delete one of the API key owner's game ranks

Changed on

Deletes the API key owner's rank for a single (gameId, mode) slot. No-op when no such rank exists. The user is always derived from the API key. Requires game.ranks:read-write and the writes feature (api_pro).

delete/user/game-ranks/{gameId}/{mode}

Request

  • Base URL
    https://teambattles.gg/api/v1
  • URL
    https://teambattles.gg/api/v1/user/game-ranks/{gameId}/{mode}
  • Auth
    HTTP bearer

Path parameters

gameIdstring required

Game definition ID of the rank to delete.

modestring required

Game mode / playlist of the rank to delete.

Response

The rank was deleted, or no matching rank existed.

deletedboolean required

True when a rank was removed; false when none existed (no-op).

timestampstring required

ISO 8601 response timestamp.

Changes