Create Campaign

{
  "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"
}

{
  "success": true,
  "data": {
    "id": "7722-11bc",
    "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",
    "status": "draft",
    "createdAt": "2024-03-18T10:00:00Z"
  }
}

POST

campaigns

{
  "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"
}

{
  "success": true,
  "data": {
    "id": "7722-11bc",
    "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",
    "status": "draft",
    "createdAt": "2024-03-18T10:00:00Z"
  }
}

Request Body

string

required

Campaign internal name

string

required

Email subject line

string

required

Fetch from /sender-emails

string

required

Fetch from /templates

string[]

List of recipient list UUIDs to target (Fetch from /lists)

object[]

Inline recipients, e.g. [{"email": "john@domain.com", "name": "John"}]

string

ISO format for scheduling

string

Initial status (usually ‘draft’)

{
  "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"
}

{
  "success": true,
  "data": {
    "id": "7722-11bc",
    "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",
    "status": "draft",
    "createdAt": "2024-03-18T10:00:00Z"
  }
}

Overview

Senders

Campaigns

Audience & Lists

Templates

Univox Inbox

Transactional API

Request Body

​Request Body

Request Body