Update an existing broadcast

PATCH/broadcasts/{id}Update an existing broadcast

Parameters

idstringpathrequired

The Broadcast ID.

Request body

application/json

objectUpdateBroadcastOptions

audience_idstring

Use `segment_id` instead. Unique identifier of the audience this broadcast will be sent to.

fromstring

The email address of the sender.

htmlstring

The HTML version of the message.

namestring

Name of the broadcast.

preview_textstring

The preview text of the email.

reply_toarray of string

The email addresses to which replies should be sent.

Show child attributes

segment_idstring

Unique identifier of the segment this broadcast will be sent to.

subjectstring

The subject line of the email.

textstring

The plain text version of the message.

topic_idstring

The topic ID that the broadcast will be scoped to.

Example request

{
  "audience_id": "string",
  "from": "string",
  "html": "string",
  "name": "string",
  "preview_text": "string",
  "reply_to": [
    "string"
  ],
  "segment_id": "string",
  "subject": "string",
  "text": "string",
  "topic_id": "string"
}

Responses

objectUpdateBroadcastResponseSuccess

idstring

The ID of the broadcast.

objectstring

The object type of the response.

Example response

{
  "id": "78261eea-8f8b-4381-83c6-79fa7120f1cf",
  "object": "broadcast"
}

Examples

idrequiredpath parameter

curl -X PATCH 'https://api.resend.com/broadcasts/string' \
  -H 'Content-Type: application/json' \
  -d '{"audience_id":"string","from":"string","html":"string","name":"string","preview_text":"string","reply_to":["string"],"segment_id":"string","subject":"string","text":"string","topic_id":"string"}'

const response = await fetch('https://api.resend.com/broadcasts/string', {
  method: 'PATCH',
  headers: { 'Content-Type': 'application/json' },
  body: JSON.stringify({"audience_id":"string","from":"string","html":"string","name":"string","preview_text":"string","reply_to":["string"],"segment_id":"string","subject":"string","text":"string","topic_id":"string"}),
});
const data = await response.json();

const response = await fetch('https://api.resend.com/broadcasts/string', { method: 'PATCH', headers: { 'Content-Type': 'application/json' }, body: "{\"audience_id\":\"string\",\"from\":\"string\",\"html\":\"string\",\"name\":\"string\",\"preview_text\":\"string\",\"reply_to\":[\"string\"],\"segment_id\":\"string\",\"subject\":\"string\",\"text\":\"string\",\"topic_id\":\"string\"}" });
console.log(await response.json());

import requests

response = requests.request(
    "PATCH",
    "https://api.resend.com/broadcasts/string",
    headers={"Content-Type": "application/json"},
    data='{"audience_id":"string","from":"string","html":"string","name":"string","preview_text":"string","reply_to":["string"],"segment_id":"string","subject":"string","text":"string","topic_id":"string"}',
)
print(response.json())

package main

import (
	"context"
	"net/http"
	"strings"
)

func main() {
	ctx := context.Background()
	body := strings.NewReader(`{"audience_id":"string","from":"string","html":"string","name":"string","preview_text":"string","reply_to":["string"],"segment_id":"string","subject":"string","text":"string","topic_id":"string"}`)
	req, err := http.NewRequestWithContext(ctx, "PATCH", "https://api.resend.com/broadcasts/string", body)
	if err != nil {
		panic(err)
	}
	req.Header.Set("Content-Type", "application/json")
	resp, err := http.DefaultClient.Do(req)
	if err != nil {
		panic(err)
	}
	defer resp.Body.Close()
}

<?php
$request = curl_init("https://api.resend.com/broadcasts/string");
curl_setopt($request, CURLOPT_CUSTOMREQUEST, "PATCH");
curl_setopt($request, CURLOPT_POSTFIELDS, "{\"audience_id\":\"string\",\"from\":\"string\",\"html\":\"string\",\"name\":\"string\",\"preview_text\":\"string\",\"reply_to\":[\"string\"],\"segment_id\":\"string\",\"subject\":\"string\",\"text\":\"string\",\"topic_id\":\"string\"}");
curl_setopt($request, CURLOPT_HTTPHEADER, ['Content-Type: application/json']);
$response = curl_exec($request);
curl_close($request);

var request = HttpRequest.newBuilder(URI.create("https://api.resend.com/broadcasts/string"))
    .method("PATCH", HttpRequest.BodyPublishers.noBody())
    .header("Content-Type", "application/json")
    .method("PATCH", HttpRequest.BodyPublishers.ofString("{\"audience_id\":\"string\",\"from\":\"string\",\"html\":\"string\",\"name\":\"string\",\"preview_text\":\"string\",\"reply_to\":[\"string\"],\"segment_id\":\"string\",\"subject\":\"string\",\"text\":\"string\",\"topic_id\":\"string\"}"))
    .build();
var response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());

require 'net/http'

uri = URI("https://api.resend.com/broadcasts/string")
request = Net::HTTPGenericRequest.new("PATCH", true, true, uri)
request['Content-Type'] = 'application/json'
request.body = "{\"audience_id\":\"string\",\"from\":\"string\",\"html\":\"string\",\"name\":\"string\",\"preview_text\":\"string\",\"reply_to\":[\"string\"],\"segment_id\":\"string\",\"subject\":\"string\",\"text\":\"string\",\"topic_id\":\"string\"}"
response = Net::HTTP.start(uri.hostname, uri.port, use_ssl: true) { |http| http.request(request) }

using var client = new HttpClient();
using var request = new HttpRequestMessage(HttpMethod.Patch, "https://api.resend.com/broadcasts/string");
request.Content = new StringContent("{\"audience_id\":\"string\",\"from\":\"string\",\"html\":\"string\",\"name\":\"string\",\"preview_text\":\"string\",\"reply_to\":[\"string\"],\"segment_id\":\"string\",\"subject\":\"string\",\"text\":\"string\",\"topic_id\":\"string\"}", Encoding.UTF8, "application/json");
using var response = await client.SendAsync(request);

{
  "id": "78261eea-8f8b-4381-83c6-79fa7120f1cf",
  "object": "broadcast"
}

Search documentation

Emails

Domains

Audiences

Contacts

Receiving Emails

Webhooks

Templates

Broadcasts

Segments

Topics

Contact Properties

Logs

Automations

Events

API keys