League: Announcements

Send a league announcement

Changed on

Sends an announcement to all members of the league. Requires a personal or developer API key whose owner is currently a league ADMIN of the league in the path, with the league announcements capability enabled on the key. League API access is gated at api_pro on the league owner's plan.

post/leagues/{identifier}/announcements

Request

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

Path parameters

identifierstring required

League slug or Convex league ID.

Request body

titlestring required

Announcement title.

bodystring required

Announcement body text.

Response

The announcement was sent.

successtrue required
notifiednumber required

Number of members notified by the announcement.

timestampstring required

Response generation time (ISO 8601).

Changes