CampaignsVersion: v3New

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.

Authorizations

Authorizationstringheaderrequired

Bearer authentication header of the form Bearer <token>, where <token> is your access token.

Scope:emails/campaigns.write

Auth methods:OAuthPrivate Integration

Token type:Sub-Account Token

Request

Headers

Versionstringrequired

API Version

Available optionsv3

Example:v3

Path Parameters

locationIdstringrequired

Location ID

Example:ve9EPM428h8vShlRW1KT

campaignIdstringrequired

Campaign ID

Example:67f15c2ae99226d5bcccb8f3

Body

application/json

scheduleTypestringrequired

How to schedule the campaign

Available optionsimmediatescheduledbatchrsssmart_send

Example:immediate

timeZonestringrequired

IANA timezone

Example:America/New_York

userIdstringrequired

ID of the user performing this action

Example:507f1f77bcf86cd799439099

userNamestring

Name of the user performing this action

Example:John Doe

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

Example:["Mon","Tue","Wed","Thu","Fri","Sat","Sun"]

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.

Response

application/json

Success

campaignIdstringrequired

Campaign ID

Example:67f15c2ae99226d5bcccb8f3

sourceIdstringnullablerequired

Source ID for fetching campaign statistics

Example:B67vyPIAfq3Bnk3FVioE

traceIdstring

Trace ID of the request

Example:019e4ef5-a65e-4198-8cf9-8e93dca9bda4