Create Schedule
Authorizations
The Mergent API uses API keys to authenticate requests. Your API keys carry many privileges, so be sure to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, client-side code, and so forth. All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail.
Body
The params for creating or updating a schedule.
The name of the schedule.
The description of the schedule.
500The name of the of the task queue.
The params for creating or updating a task request.
A cron expression describing when the schedule should be invoked (UTC).
Note: invocation n + 1 of a schedule will not begin until invocation n has completed successfully.
You must pass either cron or rrule when creating a new schedule.
An iCal RRule expression describing when the schedule should be invoked (UTC).
Note: invocation n + 1 of a schedule will not begin until invocation n has completed successfully.
You must pass either cron or rrule when creating a new schedule.
The ISO 8601 timestamp denoting the start of an RRULE schedule.
When not set, it will be set to the current time, and the schedule will be invoked immediately.
Ignored for cron-type schedules.
A boolean indicating whether or not the schedule is paused.
Response
A schedule.
The unique ID for the schedule.
The name of the of the task queue.
A task request.
A boolean indicating whether or not the schedule is paused.
The ISO 8601 timestamp representing when the schedule was created.
The name of the schedule.
The description of the schedule.
A cron expression describing when the schedule should be invoked (UTC).
Note: invocation n + 1 of a schedule will not begin until invocation n has completed successfully.
You must pass either cron or rrule when creating a new schedule.
An iCal RRule expression describing when the schedule should be invoked (UTC).
Note: invocation n + 1 of a schedule will not begin until invocation n has completed successfully.
You must pass either cron or rrule when creating a new schedule.
The ISO 8601 timestamp denoting the start of an RRULE schedule.
When not set, it will be set to the current time, and the schedule will be invoked immediately.
Ignored for cron-type schedules.
The ISO 8601 timestamp for when the schedule is scheduled to be executed.
Was this page helpful?