League: Moderation

Issue a league cooldown

Changed on

Issues or updates a manual cooldown for a league member. Requires a personal or developer API key whose owner is currently a league ADMIN of the league in the path, with the league cooldowns capability enabled on the key. League API access is gated at api_pro on the league owner's plan.

post/leagues/{identifier}/cooldowns/issue

Request

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

Path parameters

identifierstring required

League slug or Convex league ID.

Request body

userIdstring required

User ID receiving the cooldown.

cooldownHoursinteger required

Cooldown length in hours, from 1 to 8760.

notestring

Optional admin note.

Response

The league cooldown was issued.

successtrue required
cooldownIdstring required

League member cooldown ID.

timestampstring required

Response generation time (ISO 8601).

Changes