A one-off marketing email campaign to a {@link MarketingSegment} segment. v1 composes a subject + preview text + a plain-text/markdown body; rich block content and the actual send fan-out land with the email-sending platform.
Fields
idID!businessBusiness!urlResourceUrl!Canonical staff-admin page for this broadcast. Consume instead of building paths from the id.
nameString!Internal owner-facing name; not the email subject.
segmentMarketingSegmentTarget segment, or null for a draft that hasn't chosen one yet.
subjectString!previewTextStringInbox preview/preheader text shown after the subject.
bodyString!The email body (plain text / markdown for v1).
statusBroadcastStatus!scheduledAtDateTimerecipientCountInt!Recipients materialised for the send (the audience snapshot size). 0 until the broadcast is sent.
sentCountInt!Recipients actually handed to the email provider, after consent/suppression skips. Grows as the fan-out progresses.
deliveredCountInt!Sends the provider confirmed as delivered. Reported by the engagement webhook, so it trails sentCount slightly.
openedCountInt!Delivered emails that were opened (provider open tracking).
clickedCountInt!Delivered emails with at least one tracked link click.
bouncedCountInt!Hard bounces — the address was suppressed for future sends.
complainedCountInt!Spam complaints — the address was suppressed for future sends.
unsubscribedCountInt!Recipients who unsubscribed via this broadcast's unsubscribe link.
sendStartedAtDateTimeWhen the fan-out began, or null before sending.
sentAtDateTimeWhen the fan-out finished (status became sent), or null.
createdAtDateTime!updatedAtDateTime!