This page documents the original routes, which keep working. For new integrations, use the
/v1 routes in Workflow Schedules. Legacy maps each original route to its /v1 replacement.API Reference
See the full request/response schema and parameters in the API Reference.
Schedule definition
A schedule binds aworkflow_id to a cron_expression and timezone:
workflow_id: the workflow to run. It must belong to your team.name: required, up to 200 characters.cron_expression: standard 5-field cron (minute hour day month weekday), up to 1,000 characters.timezone: IANA timezone, e.g.America/Los_Angeles. Defaults toUTC.description: optional free-form text, up to 2,000 characters.is_active: defaults totrue. Set tofalseto save a schedule without activating it.
disabled_reason set, when the API key it runs as is revoked or expires, when its team is archived, or when its creator is removed and the admin chooses to pause their schedules.
Overlapping and missed runs
- Every scheduled time starts a run, even when the schedule’s previous run is still going, so runs can overlap. Keep the interval longer than a typical run.
- A run that cannot start at its scheduled time, such as during an outage, starts late if it can start within 1 hour; otherwise it is skipped.
- There is no minimum interval.
* * * * *starts a run every minute, and each run is billed.
Create schedule
Create a new schedule for a workflow.workflow_id, name, and cron_expression. Returns 201 with the schedule, including up to three upcoming next_run_times.
Example request
Example response
List schedules
Retrieve your team’s schedules.workflow_id filters to schedules for a single workflow.
Get schedule
Retrieve a single schedule by ID.Update schedule
Update a schedule’s name, cadence, timezone, description, or active state.name, cron_expression, timezone, description, is_active) are optional. Only include what you want to change.
Setting
is_active: true makes the caller, user or API key, the schedule’s owner (created_by, api_key_id) and clears disabled_reason. The schedule stays in its team.Example request
Delete schedule
Permanently delete a schedule. Returns{"success": true, "id": "SCHEDULE_ID"}.
Deleting a schedule does not affect the underlying workflow or its run history.