League: Rules & Config

Set league enabled state

Changed on

Enables or disables a league. 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. League API access is gated at api_pro on the league owner's plan.

post/leagues/{identifier}/settings/enabled

Request

  • Base URL
    https://teambattles.gg/api/v1
  • URL
    https://teambattles.gg/api/v1/leagues/{identifier}/settings/enabled
  • Auth
    HTTP bearer

Path parameters

identifierstring required

League slug or Convex league ID.

Request body

isEnabledboolean required

Whether the league is enabled/discoverable.

Response

The league enabled state was updated.

successtrue required
timestampstring required

Changes