Resend API (unofficial showcase)
PATCH/broadcasts/{id}

Update a broadcast

Updates the name, audience, sender, content, or topic of an existing broadcast. Supply only the fields you want to change; use segment_id instead of the deprecated audience_id field.

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

1 parameter · 10 body fields
idstringrequired
The unique identifier of the broadcast to update.

Fields to update on the broadcast; all fields are optional.

namestringoptional
Name of the broadcast.
audience_idstringdeprecatedoptional
Use `segment_id` instead. Unique identifier of the audience this broadcast will be sent to.
segment_idstringoptional
Unique identifier of the segment this broadcast will be sent to.
fromstringoptional
The email address of the sender.
subjectstringoptional
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.

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

Error handling

The id path parameter must identify the broadcast you want to update. Use segment_id rather than the deprecated audience_id field to specify the target segment.