API Docs / Schemas / SendEmailBroadcastRequest

SendEmailBroadcastRequest

Optional body for the send broadcast endpoint. An empty body (or null ScheduledAt)
sends immediately, exactly as before.

Properties

Name Type Description
scheduledAtstring

When set, the broadcast is not sent now: it moves to Scheduled status and is dispatched
at this UTC instant. Must be in the future. Recipients are resolved and snapshotted at
dispatch time, not schedule time.

When set, the broadcast is not sent now: it moves to Scheduled status and is dispatched
at this UTC instant. Must be in the future. Recipients are resolved and snapshotted at
dispatch time, not schedule time.

JSON Example

{
  "scheduledAt": "2024-01-01T00:00:00Z"
}

Used By Operations