League: Moderation

Create a league penalty

Changed on

Issues a warning, match-forfeit penalty, or point deduction to a league team. Requires a personal or developer API key whose owner is currently a league ADMIN of the league in the path, with the league penalties capability enabled on the key. League API access is gated at api_pro on the league owner's plan.

post/leagues/{identifier}/penalties/create

Request

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

Path parameters

identifierstring required

League slug or Convex league ID.

Request body

teamIdstring required

Team ID receiving the penalty.

gameIdstring required

Game ID for the league penalty.

seasonIdstring

Optional league season ID for the penalty.

type'POINT_DEDUCTION' | 'MATCH_FORFEIT' | 'WARNING' required

Penalty type.

valueinteger

Point value for POINT_DEDUCTION (integer, 1-1000).

reasonstring required

Reason for the penalty.

Response

The league penalty was created.

successtrue required
penaltyIdstring required

Created league penalty ID.

timestampstring required

Response generation time (ISO 8601).

Changes