Schedule campaign
POST/v1/public/campaigns/:campaignId/schedule
Starts a campaign draft: the campaign goes to moderation and is sent right after approval, or at the specified time (scheduledStartDate) if provided. The draft must already have a template, a sender, a subject and at least one contact list (set them via campaign create/update); an A/B campaign must also have abTest.percent set. Regular campaigns support two optional, mutually exclusive start modes: followUp — resend the email under a different subject to contacts who did not open it; chunkSettings — send in daily chunks of growing size. Neither mode is available for A/B campaigns.
Request
Responses
- 200
- 400
- 401
- 403
- 404
- 422
- 429
- 500
Scheduled campaign.
The request is invalid.
A valid Public API token is required.
The endpoint requires a scope that is not granted to the token.
The requested resource was not found.
Campaign cannot be scheduled: the campaign is not in DRAFT status, or the template, sender, subject or lists are missing.
The current API key exceeded the configured rate limit.
Response Headers
Number of seconds after which the request may be retried safely.
Internal server error.