broadcasts

Send now, or schedule it with scheduled_at/scheduledAt — the same time grammar as PATCH /broadcasts/:id, refused if it is in the past.

Returns 200 when the broadcast has finished or was scheduled, and 202 while it is still sending. A 202 has status sending. warnings names anything worth knowing that did not stop the send — for example, recipients with no consent on file.

post/broadcasts/{id}/send

Request

  • Base URL: https://api.agentisend.com
  • URL: https://api.agentisend.com/broadcasts/{id}/send
  • Auth: HTTP bearer

Path parameters

idstring uuid required

Headers

Idempotency-Keystring

Makes 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). Resend-Idempotency-Key is accepted as the same header.

Resend-Idempotency-Keystring

Alias of Idempotency-Key. Idempotency-Key wins if both are sent.

Request body

scheduled_atstring

A time to schedule for instead of sending now. ISO 8601 or a short phrase ("in 1 hour", "tomorrow 9am"). Refused if it is in the past.

scheduledAtstring

Resend Node SDK name for scheduled_at.

Response

The send finished, or scheduled_at/scheduledAt scheduled it instead.

idstring uuid required
sentinteger required
skippedinteger required

Changes

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