Overview
Broadcasts enable you to:- Send mass email campaigns to segments
- Schedule campaigns for future delivery
- Create draft campaigns for review
- Track campaign status and delivery
- Manage campaign lifecycle from creation to deletion
Creating a Broadcast
Create a broadcast campaign targeting a specific segment.Request Parameters
string
required
The ID of the segment to send the broadcast to. All contacts in this segment will receive the email.
string
required
The sender email address (e.g., “sender@example.com” or “Sender Name <sender@example.com>”).
string
required
The email subject line.
string
The HTML version of the email content.
string
The plain text version of the email content.
string
Internal name for the broadcast campaign (for your reference).
[]string
Array of reply-to email addresses.
bool
If
true, sends the broadcast immediately. If false or omitted, creates a draft.string
Schedule the broadcast for later delivery. Accepts ISO 8601 format (e.g., “2024-08-05T11:52:01.858Z”) or natural language (e.g., “in 1 hour”). Only valid when
Send is true.Deprecated:
AudienceId is still supported for backward compatibility, but use SegmentId for new integrations.Retrieving a Broadcast
Get details about a specific broadcast including its status and content.Get Broadcast
Broadcast Status Values
Broadcasts can have the following statuses:draft- Created but not sentscheduled- Scheduled for future deliverysending- Currently being sentsent- Successfully sent to all recipientsfailed- Failed to send
Listing Broadcasts
Retrieve all broadcasts in your account with optional pagination.Updating a Broadcast
Update a draft broadcast before sending. Only draft broadcasts can be updated.Update Broadcast
Sending a Broadcast
Send a draft broadcast immediately or schedule it for later.Canceling a Scheduled Broadcast
To cancel a scheduled broadcast, delete it before it’s sent.Cancel Scheduled Broadcast
Deleting a Broadcast
Delete a draft broadcast. Only draft broadcasts can be deleted.Delete Broadcast
Complete Example
Here’s a complete workflow demonstrating broadcast campaign management:Complete Broadcast Workflow
Broadcast Campaign Patterns
Newsletter Campaign
Newsletter Pattern
Product Announcement
Product Announcement
Scheduled Campaign Series
Drip Campaign
Error Handling
Robust Error Handling
Best Practices
Test Before Sending
Create a test segment with your own email to preview broadcasts before sending to large audiences.
Use Descriptive Names
Give broadcasts clear internal names to track campaigns effectively (e.g., “Q1 Newsletter - March 2024”).
Include Plain Text
Always include a
Text version for better deliverability and accessibility.Set Reply-To Addresses
Configure
ReplyTo to handle customer responses effectively.Schedule Wisely
Schedule campaigns for optimal send times based on your audience’s timezone and habits.
Monitor Status
Check broadcast status and use webhooks to track delivery and engagement.
Next Steps
Segments
Learn how to organize contacts into segments
Webhooks
Track broadcast events with webhooks
Broadcasts Example
View the complete broadcasts example
API Reference
View the complete Broadcasts API reference