Docs

POST /broadcasts/{id}/send

Send now. Content is SNAPSHOTTED: the segment is evaluated and every member rendered with their properties; the result is immutable.

Parameters

  • id path · string · required
  • Idempotency-Key header · string · optionalMakes this call safe to retry. Send the same key with the same body and the original response is replayed instead of the work happening twice. Keys are 1-256 characters and are remembered for 7 days. While the first attempt is still running, a second call with that key returns 409 idempotency_in_flight (Resend calls this concurrent_idempotent_requests); the same key with a different body returns 409 idempotency_payload_mismatch (Resend: invalid_idempotent_request).

Responses

  • 201 Success
  • 400 Validation error
  • 401 Missing API key
  • 403 Forbidden
  • 404 Not found
  • 409 Conflict
  • 429 Rate limited
  • 500 Internal server error

Response headers

  • ratelimit-limit — Messages this API key may spend in one 60-second window.
  • ratelimit-remaining — Messages left in the current window.
  • ratelimit-reset — Seconds until the current window resets and the budget refills.

201 body

FieldTypeRequiredNotes
broadcastobjectyes
broadcast.archived_atstring | nullyes
broadcast.contentobject | nullyes
broadcast.created_atstringyes
broadcast.from_addressstring | nullyes
broadcast.idstringyes
broadcast.namestringyes
broadcast.scheduled_atstring | nullyes
broadcast.segment_idstring | nullyes
broadcast.sent_atstring | nullyes
broadcast.sent_countintegeryes
broadcast.statusstringyes
broadcast.subjectstring | nullyes
broadcast.template_idstring | nullyes
broadcast.updated_atstringyes
sentintegeryes
skippedintegeryes

Errors

Codes in the catalogue that answer with one of this operation’s error statuses. Every one of them carries a fix.