Schedules an API call to be made at one or more points in time in the future
depending on the format of the
schedule parameter provided the same project
as the API key used to make this call.
schedule parameter is very flexible, but must take one of the following
forms to be interpreted correctly:
- An ISO-8601 formatted date or
date-time string (e.g.
YYYY-MM-DD HH:MM:SSin 24-hour UTC time)
- An expression of the form
"in 5 minutes"where intervals supported are
- A date expression like
"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
- A repeating expression like
"every 3 hours"or
"every day at 1am"
In all cases times are UTC.
These are passed in at the top level of the request.
|A user-specified identifier to refer to this scheduled event on subsequent API calls.
Default: Generated UUID
|schedule||string||Defines the schedule to follow when sending this batch. Must conform to one of the supported schedule formats.|
Response 200 OK
Upon successful creation a response of the following form is sent:
scheduled_at field shows the execution time (UTC) of the event.
Response 400 Bad Request
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