Skip to main content
DELETE
/
user
/
game-ranks
/
{gameId}
/
{mode}
curl -X DELETE "https://teambattles.gg/api/v1/user/game-ranks/bo6/ranked" \
  -H "Authorization: Bearer tb_your_api_key"
{
  "deleted": true,
  "timestamp": "<string>"
}

Permission Required

This endpoint requires game.ranks:read-write on your API key. The user is always the API key owner, derived from the key itself - it is never accepted as a parameter, so a key can only delete its own ranks. A free (api_free) key receives 403 error_api_feature_required; this requires an api_pro+ plan.

Access / Membership Rules

This is a self-write route. The owner is always derived from principal.user._id, so there is no membership or participant gating - the key deletes exactly the owner’s own rank. The target rank is identified by the {gameId} and {mode} path parameters; both are required. Deletion is a no-op when no matching rank exists (the response simply reports deleted: false).

What’s Returned

Returns an object with deleted (true when a rank was removed, false when none existed) and a timestamp. Mintlify renders the full schema from the spec below.
curl -X DELETE "https://teambattles.gg/api/v1/user/game-ranks/bo6/ranked" \
  -H "Authorization: Bearer tb_your_api_key"

Authorizations

Authorization
string
header
required

Send your API key as: Authorization: Bearer tb_

Path Parameters

gameId
string
required

Game definition ID of the rank to delete.

mode
string
required

Game mode / playlist of the rank to delete.

Response

The rank was deleted, or no matching rank existed.

Result of deleting a game rank.

deleted
boolean
required

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

timestamp
string
required

ISO 8601 response timestamp.