v20

latestOpenAPI 3.1.0raw.githubusercontent.com2026-08-011984401.2 MB
League: Rules & Config

Toggle a league game

Activates or deactivates a league game. Deactivation cancels pending, accepted, and ready matches for that league game. Requires a personal or developer API key whose owner is currently a league ADMIN of the league in the path, with the league games capability enabled on the key. League API access is gated at api_pro on the league owner's plan.

post/leagues/{identifier}/games/{leagueGameId}/toggle

Path parameters

identifierstring required

League slug or Convex league ID.

League slug or Convex league ID.

leagueGameIdstring required

League game link ID.

League game link ID.

Request body

isActiveboolean required

Whether the game should be active.

Response

The league game was toggled.

successtrue required
timestampstring required