Broadcasts
PUT
Update Broadcast
PUT /v1/broadcasts/{broadcastId}Update an existing broadcast's settings and email content.
Use Cases:
- Add or modify email content (subject, HTML, text)
- Change sender address or reply-to
- Update topic or segment targeting
- Schedule or reschedule send time
- Toggle open and click tracking
Behavior:
- Only provided fields are updated (partial updates supported)
- Only DRAFT or QUEUED broadcasts can be updated
- Email content can be set or cleared
- Send time can be set or removed
- Returns the complete updated broadcast object
Required Scope: write:broadcasts
Updatable Fields:
- name: Broadcast display name
- from: Sender email address
- emailContent: Subject, HTML, text, preview text, editor content
- replyTo: Reply-to email address
- topicId: Topic association (set to null to remove)
- segmentId: Segment targeting (set to null to remove)
- sendAt: Scheduled send time (ISO 8601)
- trackClicks: Enable/disable click tracking
- trackOpens: Enable/disable open tracking
Note: Cannot update broadcasts that have already been sent or are currently sending.
Path parameters
broadcastIdstringrequiredBroadcast ID
Bodyrequired
namestringMin length: 1Max length: 255
fromstringemailContentanyreplyTostring<email>replyToIdentityIdanytopicIdanysegmentIdanysendAtanytrackClicksanytrackOpensanyResponse
200Broadcast updated successfully with refreshed settings
objectstringrequiredidstringrequirednamestringrequiredstatusstringrequiredfromanyrequiredemailContentanyrequiredreplyToanyrequiredtopicIdanyrequiredsegmentIdanyrequiredsendAtanyrequiredcreatedAtstringrequired