This API call is new and breaking changes may be made before it is finalized.
Schedules one or more API calls to be made at one or more points in time in the
future depending on the format of the
schedule parameter provided for a
particular project defined by the API key used.
events key must contain an array of one or more events to schedule. These
can have a user-supplied
uid identifier used to make changes or to later
delete the scheduled event. The
uid value is an arbitrary string and will
default to a server-generated UUID value if not specified.
metadata payload of each event is an arbitrary PostageApp
send_message request. The project’s API key
will be merged in automatically and can be omitted.
schedule parameter is very flexible, but must take one of the following
forms to be interpreted correctly:
YYYY-MM-DD HH:MM:SSin 24-hour UTC time)
"in 5 minutes"where intervals supported are
"5 days from now"or
crontab-compatible specification like
0 * * * *(every hour at 0 on the hour) or
0 0 * * *(every day at midnight). This also includes directives like
"every 3 hours"or
"every day at 1am"
In all cases times are UTC.
Upon successful creation a response of the following form is sent:
scheduled_at field shows the execution time (UTC) of the event.
If the UID is taken an error of the following form will be returned:
Each UID value must be unique per-project. Existing events can be updated
on an individual basis with the