Sign in
latestOpenAPI 3.0.32026-08-10362374.4 KB

98c494325aae

Campaign

Schedule Campaign

Schedule Campaign to be sent at a specific date and time. Only Campaigns which have a Detail, Design, EmailTemplate and Credentials can be scheduled. Also, an already sent Campaign cannot be scheduled.

The schedule time should be given in regards to UTC Time Zone!

Details for the body of the request:

  • id id of the Campaign
  • publishDate the date to schedule the Campaign
post/campaign/schedule

Headers

api-versionstring required

The API version. Current version is 3.3. This value has to be set in every request.

Request body

idstring required
publishDatestring required

Schedule date in UTC (format: YYYY-MM-DD HH:mm)

Response

Successful response

messagestring nullable
hasErrorboolean
validationErrorsstring[]
{"stackTrail":"components:schemas:ApiResponse:properties:data","oasType":"schema","type":"unknown"}
{"stackTrail":"components:schemas:ApiResponse:properties:content","oasType":"schema","type":"unknown","nullable":true}