Sign in
League: Rules & Config

Update league game rules

Creates or updates enforced rules for a 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 rules capability enabled on the key. League API access is gated at api_pro on the league owner's plan.

post/leagues/{identifier}/rules/update

Path parameters

identifierstring required

League slug or Convex league ID.

League slug or Convex league ID.

Request body

gameIdstring required

Game ID whose league rules should change.

allowedPlaylistIdsstring[]
allowedMapIdsstring[]
matchFormat'BEST_OF_1' | 'BEST_OF_3' | 'BEST_OF_5' | 'BEST_OF_7' | 'BEST_OF_9'
forceCompetitiveboolean
allowedDaysstring[]
blockedDaysstring[]
timezonestring
challengesEnabledboolean
maxChallengesPerTeamPerSeasonnumber
maxPointsMatchesPerPairPer24hnumber
maxPendingChallengesPerOpponentnumber
maxPendingChallengesTotalnumber
challengeCooldownMinutesnumber
wagersAllowedboolean
minWagerAmountnumber
maxWagerAmountnumber
minRosterSizenumber
maxRosterSizenumber
rosterLockEnabledboolean
rosterChangeWindowDaysstring[]
maxRosterChangesPerWeeknumber

Response

The league game rules were updated.

successtrue required
rulesIdstring required
timestampstring required

Changes

Changed in 3 of the 21 revisions of this API.13