Update Broadcast

Update a broadcast. Only broadcasts in draft status can be updated.

PATCH/broadcasts/{broadcast_id}

Requires a full_access API key.

Path Parameters

broadcast_idstringrequired

The broadcast ID (UUID).

Body Parameters

segment_idstring

The new target segment ID.

fromstring

Sender email address.

subjectstring

Email subject.

htmlstring

HTML content. If updating content, either html or text must be provided.

textstring

Plain text content. If updating content, either html or text must be provided.

reply_tostring | string[]

Reply-to email address(es).

namestring

Internal broadcast name.

topic_idstring | null

Topic ID to scope the broadcast. Pass null to remove the topic scope.

Response Fields

idstring

The broadcast ID.

curl -X PATCH 'https://api.postflare.app/broadcasts/d4e5f6a7-b8c9-0123-defa-234567890123' \
  -H 'Authorization: Bearer re_xxxxxxxxx' \
  -H 'Content-Type: application/json' \
  -d '{
    "subject": "Our Updated Monthly Newsletter",
    "html": "<p>Hello, updated content!</p>"
  }'

const response = await fetch(
  'https://api.postflare.app/broadcasts/d4e5f6a7-b8c9-0123-defa-234567890123',
  {
    method: 'PATCH',
    headers: {
      'Authorization': 'Bearer re_xxxxxxxxx',
      'Content-Type': 'application/json',
    },
    body: JSON.stringify({
      subject: 'Our Updated Monthly Newsletter',
      html: '<p>Hello, updated content!</p>',
    }),
  }
);

const data = await response.json();

Response

{
  "id": "d4e5f6a7-b8c9-0123-defa-234567890123"
}