Broadcasts
POST
Create Broadcast
POST /v1/broadcastsCreate a new broadcast draft in your workspace.
Use Cases:
- Create a broadcast for later editing and scheduling
- Set up a campaign with initial settings
- Prepare a broadcast before adding email content
- Create broadcasts programmatically for workflows
Behavior:
- Creates a broadcast in DRAFT status
- Email content fields are optional at creation
- From address is validated if provided
- Topic and segment associations are optional
- Returns the complete broadcast object with generated ID
- Broadcast can be edited and scheduled later
Required Scope: write:broadcasts
Fields:
- name (required): Broadcast name for identification
- from: Sender email address (must be from verified domain)
- emailContent: Subject, HTML, text, preview text, and editor content
- replyTo: Reply-to email address
- topicId: Associate with a topic for subscription management
- segmentId: Target a specific segment of contacts
Next Steps After Creation:
- Update broadcast with email content via PUT /v1/broadcasts/{broadcastId}
- Schedule send time via PUT /v1/broadcasts/{broadcastId}
- Send the broadcast via POST /v1/broadcasts/{broadcastId}/send
Bodyrequired
namestringrequiredMin length: 1Max length: 255
fromstringemailContentobjectreplyTostring<email>topicIdstringsegmentIdstringResponse
201Broadcast created successfully in DRAFT status. Returns the complete broadcast object.
objectstringrequiredidstringrequirednamestringrequiredstatusstringrequiredfromanyrequiredemailContentanyrequiredreplyToanyrequiredtopicIdanyrequiredsegmentIdanyrequiredsendAtanyrequiredcreatedAtstringrequired