v20

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

League: Moderation

Create a league team ban

Bans a team from the league and removes it from active/pending league participation. Requires a personal or developer API key whose owner is currently a league ADMIN of the league in the path, with the league bans capability enabled on the key. League API access is gated at api_pro on the league owner's plan.

post/leagues/{identifier}/bans/create

Path parameters

identifierstring required

League slug or Convex league ID.

Request body

teamIdstring required

Team ID to ban from the league.

reasonstring required

Reason for the ban.

isPermanentboolean required

Whether the ban never expires.

expiresAtnumber

Expiration timestamp for temporary bans, in epoch milliseconds.

Response

The league ban was created.

successtrue required

banIdstring required

Created league ban ID.

timestampstring required

Response generation time (ISO 8601).