Resend API (unofficial showcase)
POST/broadcasts

Create a broadcast

Creates a broadcast with sender, subject, and segment details. Include from, subject, and segment_id; optionally provide message content, reply addresses, a topic, or sending and scheduling settings.

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

12 body fields

Broadcast configuration. Include from, subject, and segment_id; other fields configure the message and delivery.

namestringoptional
Name of the broadcast.
segment_idstringrequired
Unique identifier of the segment this broadcast will be sent to.
audience_idstringdeprecatedoptional
Use `segment_id` instead. Unique identifier of the segment this broadcast will be sent to.
fromstringrequired
The email address of the sender.
subjectstringrequired
The subject line of the email.
reply_toarray<string>optional
The email addresses to which replies should be sent.
preview_textstringoptional
The preview text of the email.
htmlstringoptional
The HTML version of the message.
textstringoptional
The plain text version of the message.
topic_idstringoptional
The topic ID that the broadcast will be scoped to.
sendbooleanoptional
Whether to send the broadcast immediately or keep it as a draft.
scheduled_atstringoptional
Schedule time to send the broadcast. Can only be used if `send` is true.

1 status code
201Returns the created broadcast's ID and the response object type.
idstringoptional
The ID of the broadcast.
objectstringoptional
The object type of the response.

Error handling

from, subject, and segment_id are required. Use segment_id instead of the deprecated audience_id; provide scheduled_at only when send is true.