sendsend.email
Sign inStart building

Update a broadcast

PATCH/v1/broadcasts/{id}

Only while it is a draft.

Required scope: broadcasts:manage

Parameters

NameInDescription
idrequiredpathThe broadcast id.

Request body

FieldType
nameoptionalstring
audience_idoptionalstring
topic_idoptionalstring
segment_idoptionalany
fromoptionalstring
subjectoptionalstring
reply_tooptionalstring
preview_textoptionalstring
htmloptionalstring
textoptionalstring
designoptionalobject
ab_testoptionalany

Unknown fields are rejected, so a typo never silently does nothing.

Example

curl -X PATCH 'https://api.sendsend.email/v1/broadcasts/ID' \
  -H "Authorization: Bearer $SENDSEND_API_KEY" \
  -H 'Content-Type: application/json' \
  -d '{
  "subject": "October update"
}'

Response 200

{
  "id": "bcast_Tz8…",
  "object": "broadcast",
  "name": "October update",
  "audience_id": "aud_7Qe2…",
  "topic_id": null,
  "from": "Acme <news@mail.acme.com>",
  "subject": "October update",
  "status": "draft",
  "status_reason": null,
  "scheduled_at": null,
  "sent": 0,
  "skipped": 0,
  "failed": 0,
  "created_at": "2026-10-06T15:00:00.000Z"
}

Errors

StatusCodeWhen
400validation_errorThe request body or parameters are invalid. The message says which field.
404not_foundNo such resource in this project.
409validation_errorThe broadcast is no longer a draft.
401unauthorizedThe API key is missing, invalid or revoked.
403forbiddenThe key does not have the scope this endpoint needs.

Every error has the same shape. See Errors.