Skip to content
Core API
Esc
navigateopen⌘Jpreview

Announcements

Announcements: available fields, filters, associations, and API operations.

Path: events/{event_id}/announcements
Methods: GET collection/record, POST, PATCH, DELETE.

GET

  • Fields: event-id, heading, content, url, send-as-email, released, created-at, updated-at, admin-updated-at, sent-to-count, sent-at, seen-by-count, registrant-count, target-list-ids, delivery-mode, scheduled-at.
  • Filters: released, delivery_mode, scheduled_from, scheduled_to, created_from, created_to.
  • delivery_mode filter values: draft, immediate, scheduled, sent.
  • Associations: none.
GET .../announcements?delivery_mode=scheduled&scheduled_from=2026-09-01T00:00:00Z

POST/PATCH inputs: heading, content, url, send_as_email, target_list_ids (array), delivery_mode, scheduled_at.

{
  "heading": "Welcome reception",
  "content": "Doors open at 18:00.",
  "url": "https://example.com/reception",
  "send_as_email": false,
  "target_list_ids": [401, 402],
  "delivery_mode": "scheduled",
  "scheduled_at": "2026-09-03T15:00:00Z"
}

delivery_mode accepts draft, immediate, or scheduled; scheduled delivery requires scheduled_at. target_list_ids is a full replacement. Every list must belong to the event; an empty array removes list-specific targeting and therefore targets all lists. Sending announcement email requires an organization-wide, unrestricted scope. Released announcements cannot be updated or deleted.

Last updated on August 21, 2026