API · Broadcasts

Update Broadcast

Edit a draft or canceled broadcast, or rename a broadcast in any other state (requires full access). Use the send endpoint to schedule delivery; send and scheduled_at fields are ignored here.

PATCH/broadcasts/{id}Full access

Request parameters

Parameter	Type	Description
`id` path · required	`string`	Opaque resource id.
`name` body · optional	`string \| null`	Broadcast name, up to 1000 characters.
`from` body · optional	`string \| null`	Sender email address, up to 1000 characters.
`subject` body · optional	`string \| null`	Email subject, up to 998 characters.
`html` body · optional	`string \| null`	HTML content, up to 256 KiB; provide nonempty HTML or text when creating the broadcast.
`text` body · optional	`string \| null`	Plain text content, up to 256 KiB; provide nonempty text or HTML when creating the broadcast.
`preview_text` body · optional	`string \| null`	Email preview text, up to 1000 characters.
`reply_to` body · optional	`string \| (string)[]`	Up to 50 valid reply-to addresses, with the first address limited to 1000 characters.
`segment_id` body · optional	`string \| null`	Recipient segment ID; null selects all contacts unless audience_id is supplied, and omission keeps the existing selection.
`audience_id` body · optional	`string \| null`	Alternative recipient segment ID used when segment_id is null or omitted.
`topic_id` body · optional	`string \| null`	Topic whose subscription preferences are checked before delivery.

Request example

Set OPENSEND_BASE_URL=https://api.example.com and OPENSEND_API_KEY=os_replace_me on your server.

bash

curl -X PATCH "$OPENSEND_BASE_URL/broadcasts/YOUR_id" \
  -H "Authorization: Bearer $OPENSEND_API_KEY" \
  -H 'Content-Type: application/json' \
  -d '{"name":"September update"}'

Response

200 · application/json. Example IDs stand for IDs returned by your installation.

json

{
  "object": "broadcast",
  "id": "YOUR_ID"
}

Behavior and errors

Drafts and canceled campaigns can be edited. Other statuses only allow a name change. Use the send operation to change scheduling.

Use a full-access credential. Resource IDs belong to your team; an unknown or foreign resource returns 404. See authentication, errors, rate limits, and compatibility for the shared contract.