POST/broadcasts/{id}/send

Send or schedule a broadcast

Submits a broadcast for sending or schedules it for later delivery. Provide scheduled_at in ISO 8601 format when you want the broadcast sent at a specific time; omit it to send without scheduling.

  • IdempotentThe SDK sends Idempotency-Key, so a retried request is only applied once.

1 parameter · 1 body field
idstringrequired
The unique identifier of the broadcast to send or schedule.

Optional scheduling details for sending the broadcast.

scheduled_atstringoptional
Schedule email to be sent later. The date should be in ISO 8601 format.

1 status code
200Returns an object containing the broadcast identifier.
idstringoptional
The ID of the broadcast.

Error handling

The id path parameter must identify the broadcast you want to send or schedule. If you provide scheduled_at, it must use ISO 8601 format.