Mailing – Create Schedule

This method can only be applied to mailings of type REGULAR Create a new scheduling for a given mailing, using the given date. Make sure this method is called at the end of your script. If changing content after setting/updating the schedule, the mail will not be sent.

PUT https://api.maileon.com/1.0/mailings/:mailingid/schedule?date={date}&hour={hour}&minutes={minutes}

Attributes

Parameter	Description
date	The SQL conform date of the schedule day in the format YYYY-MM-DD
hours	The schedule hour in the format of HH, 24 hours format
minutes	The schedule minutes in the format MM
dispatchOption	The time distribution strategy to choose from {‘hour’, ‘weekdayhour’, ‘uniform’}.
dispatchEndInHours	Number of hours begining from the dispatch start util which the dispatch distribution over the time has to be finished. Used in case of ‘hour’ dispatch option and ‘uniform’ option. Allowed values for the ‘uniform’ distribution are in [2..96], whereas for ‘hour’ strategy thery are ranging from [2..24].
dispatchEndInDays	Number of days begining from the dispatch start util which the dispatch distribution over the time has to be finished. Used only with dispatch option ‘weekdayhour’ and its acceptable range is [1..7].
dispatchEndExactDatetime	The exact end date util which the dispatch time distribution has to be finished. It is used when none of the arguments above dispatchEndInHours, dispatchEndInDays aren’t set i.e. equals 0. Note that one of dispatchEndInHours, dispatchEndInDays, dispatchEndExactDatetime argument should be used in the request according to the selected dispatch option. Format: yyyy-MM-dd HH:mm
clicksAsResponseReference	The parameter determines the inclusion/exclusion of clicks as a response criteria when selecting {‘hour’, ‘weekdayhour’} options.
dispatchWavesGroup	The number determines how many consecutive sending waves will be grouped when using {‘hour’, ‘weekdayhour’} distribution. Supported values are {1, 2, 3 (default)}.
dispatchUniformInterval	The arguments controls the interval {‘hour’, ’30m’, ’20m’, ’15m’, ’10m’} for the ‘uniform’ strategy indicating the frequency of mailing distribution over time. It should equals null for {‘hour’, ‘weekdayhour’} dispatch options.
allowedHours	The value represents the allowed hours. Comma separated values for the allowed hours and can be combined with a range of hours. The required format looks like 0,3,5,17-21 as an example. The acceptable values rane is 0..23. Note that the if this argument is not provided, all 24H of the day will be considered as acceptable dispatch hours.

Response Codes

HTTP status code	Description
200 OK	if there is a schedule set for this mailing and it was removed
400 Bad request	if the request was invalid: planned date is already in the past or planned date is not a date
405 Method not allowed	if the mailing has already been sent out (sealed)
409 Conflict	if the mailing already has an associated schedule

Example

PUT https://api.maileon.com/1.0/mailings/1/schedule?date=2045-08-23&hours=16&minutes=15

PUT /1.0/mailings/593/schedule?date=2021-03-20&hours=14&minutes=1&dispatchOption=uniform&dispatchEndInHours=24&dispatchWavesGroup=1&allowedHours=13-15,18,20

PUT https://api.maileon.com/1.0/mailings/1/schedule?date=2021-03-20&hours=14&minutes=1&dispatchOption=weekdayhour&dispatchEndExactDatetime=2021-03-25+18%3A00&dispatchWavesGroup=2