Schedule Campaign

POST 
/emails/locations/:locationId/campaigns/emails/:campaignId/schedule

Schedule or start an email campaign. The campaign must be in draft, cancelled, or paused status.

Request

Version stringrequired

API Version

Available optionsv3

locationId stringrequired

Location ID

campaignId stringrequired

Campaign ID

application/json

application/json

Body

Bodyrequired

scheduleTypestringrequired
How to schedule the campaign
Available optionsimmediatescheduledbatchrsssmart_send
timeZonestringrequired

IANA timezone

userIdstringrequired

ID of the user performing this action

userNamestring

Name of the user performing this action

emailMetaobjectrequired

Email subject, sender, and content metadata

recipientsobjectrequired

Who receives the email. Must provide either contactIds or filter.

sendDaysstring[]
Days of the week to allow sending. Used for batch and RSS scheduleTypes.
Available optionsMonTueWedThuFriSatSun
scheduleConfigobject

Schedule configuration for immediate, scheduled, batch, and smart_send types. Required when scheduleType is not rss.

rssConfigobject

RSS feed configuration. Required when scheduleType is rss.

abTestConfigobject

A/B test configuration. Can be combined with any scheduleType except rss.

Example (auto)

{
  "scheduleType": "immediate",
  "timeZone": "America/New_York",
  "userId": "507f1f77bcf86cd799439099",
  "userName": "John Doe",
  "emailMeta": {
    "subject": "Our February Newsletter",
    "fromName": "John Doe",
    "fromEmail": "[email protected]"
  },
  "recipients": {
    "type": "contact",
    "contactIds": [
      "contactId1",
      "contactId2"
    ]
  },
  "sendDays": [
    "Mon",
    "Tue",
    "Wed",
    "Thu",
    "Fri",
    "Sat",
    "Sun"
  ],
  "scheduleConfig": {
    "sendAt": "2026-04-01 09:00 AM"
  },
  "rssConfig": {
    "name": "Weekly Digest",
    "rssFeedURL": "https://example.com/rss",
    "repeatAfter": "every_day",
    "repeatAfterTime": "09:00 AM"
  },
  "abTestConfig": {
    "testType": "subjectLine",
    "testDuration": 3600,
    "variationCount": 2,
    "testSize": 30,
    "winningCriteria": "openRate",
    "variations": [
      {
        "subject": "Subject A"
      },
      {
        "subject": "Subject B"
      }
    ]
  }
}

application/json

Success

application/json

Schema

Schema

campaignIdstringrequired

Campaign ID

sourceIdstringnullablerequired

Source ID for fetching campaign statistics

traceIdstring

Trace ID of the request

Example (auto)

{
  "campaignId": "67f15c2ae99226d5bcccb8f3",
  "sourceId": "B67vyPIAfq3Bnk3FVioE",
  "traceId": "019e4ef5-a65e-4198-8cf9-8e93dca9bda4"
}