Skip to main content

​
Request Body

​
name
STRING
required
Campaign internal name
​
subject
STRING
required
Email subject line
​
sender_email_id
UUID
required
Fetch from /sender-emails
​
template_id
UUID
required
Fetch from /templates
​
preview_text
STRING
Preview/Snippet text in inbox
​
recipient_list_ids
ARRAY<UUID>
Lists to target
​
recipients
ARRAY<OBJECT>
Inline recipients []
​
scheduled_date
DATETIME
ISO format for scheduling
​
status
STRING
Initial status (usually ‘draft’)
​
settings
OBJECT
{track_opens: bool, track_clicks: bool, unsubscribe_link: bool}
{
  "name": "Summer Sale 2024",
  "subject": "Exclusive 50% Off for you, {{name}}!",
  "sender_email_id": "b7e1-9283-acde-4912-8839",
  "template_id": "441b-99ef-8872-acde-11b2",
  "preview_text": "Don't miss our hottest sale of the year!"
}

{
  "success": true,
  "data": {
    "id": "7722-11bc"
  }
}