v20

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

Request league shutdown

Requests TeamBattles staff review for league shutdown. Requires a personal or developer API key whose owner is currently a league ADMIN of the league in the path, with leagues.league_admin:read-write access on the key; Convex re-checks current OWNER authority. Staff-only shutdown execution is not exposed by the public API. League API access is gated at api_pro on the league owner's plan.

post/leagues/{identifier}/shutdown/request

Path parameters

identifierstring required

League slug or Convex league ID.

League slug or Convex league ID.

Response

League shutdown was requested.

successtrue required
timestampstring required