League: Announcements

Send a league announcement

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

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

Changed in 2 of the 22 revisions of this API.11

Jun 24, 2026fd9c943724311See the full diff
- ○
  endpoint added
  endpoint-added
This revision also has 1 change that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog
Jun 4, 2026f22bd61fd5951See the full diff
- ▲
  api path removed without deprecation
  api-path-removed-without-deprecation
This revision also has 377 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

Full history