v20

latestOpenAPI 3.1.0raw.githubusercontent.com2026-08-011984401.2 MB

League: Rules & Config

Upsert a league display rule

Creates or updates an informational display rule 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 display_rules capability enabled on the key. League API access is gated at api_pro on the league owner's plan.

post/leagues/{identifier}/display-rules/upsert

Path parameters

identifierstring required

League slug or Convex league ID.

Request body

gameIdstring required

Game ID whose display rule should change.

categorystring required

Display rule category.

categoryIconstring

categoryOrdernumber required

isCustomCategoryboolean required

isOverrideboolean required

Response

The display rule was upserted.

successtrue required

displayRuleIdstring required

timestampstring required