Broadcast

Send Broadcast

Send a message to attendees of an event.

Supports the same filtering options as the web app's broadcast composer:

  • Filter by registration status (confirmed, pending, invited, waitlisted, cancelled, declined). Omit to target the default set (confirmed + pending + invited).
  • Filter by specific ticket type IDs. Omit to include all ticket types.
  • Optionally post the message to the event feed.

Recipients who have opted out of event messages for this host are automatically excluded. Free-tier hosts are subject to the monthly email quota; upgrade to Pro for a higher allowance.

post/v1/events/{event_slug}/broadcast

Request

  • Base URL: https://developer.eventship.com (the document declares no server; this is the origin it was published from)
  • URL: https://developer.eventship.com/v1/events/{event_slug}/broadcast
  • Auth: API key in header X-API-Key

Path parameters

event_slugstring required

Request body

subjectstring nullable

Email subject line. Optional — if omitted or blank, defaults to "📣 {event title} update" (the same placeholder the web composer pre-fills for hosts).

bodyHtmlstring required

Email body. Plain text or safe HTML.

registrationStatusesstring[] nullable

Filter by registration status. Valid values: 'confirmed', 'pending', 'invited', 'waitlisted', 'cancelled', 'declined'. Omit to target the default set (confirmed, pending, invited).

ticketTypeIdsinteger[] nullable

Filter by ticket type IDs. Omit to include all ticket types.

postToFeedboolean

If true, also post the message to the event's feed.

Response

Successful Response

successboolean
messagestring nullable

Changes

No recorded changes to this operation across all 1 revision of this API.