Sign in

v1

latestOpenAPI 3.1.0Apache 2.0raw.githubusercontent.com2026-05-044743166.6 KB
schedules

Create a schedule

Create a new IMPERATIVE schedule based on the specified options.

post/api/v1/schedules

Request body

taskstring required
cronstring required
deduplicationKeystring required
externalIdstring
timezonestring

Defaults to "UTC". In IANA format ("America/New_York"). If set then it will trigger at the CRON frequency in that timezone and respect daylight savings time.

Example request

{
  "timezone": "America/New_York"
}

Response

Schedule created successfully

idstring

The unique ID of the schedule, prefixed with 'sched_'

taskstring

The id of the scheduled task that will be triggered by this schedule

typestring

The type of schedule, DECLARATIVE or IMPERATIVE. Declarative schedules are declared in your code by setting the cron property on a schedules.task. Imperative schedules are created in the dashboard or by using the imperative SDK functions like schedules.create().

activeboolean

Whether the schedule is active or not

deduplicationKeystring

The deduplication key used to prevent creating duplicate schedules

externalIdstring

The external ID of the schedule. Can be anything that is useful to you (e.g., user ID, org ID, etc.)

timezonestring

Defaults to UTC. In IANA format, if set then it will trigger at the CRON frequency in that timezone and respect daylight savings time.

nextRunstring date-time

The next time the schedule will run

Example response

{
  "id": "sched_1234",
  "task": "my-scheduled-task",
  "type": "IMPERATIVE",
  "active": true,
  "deduplicationKey": "dedup_key_1234",
  "externalId": "user_1234",
  "generator": {
    "expression": "0 0 * * *",
    "description": "Every day at midnight"
  },
  "timezone": "America/New_York",
  "nextRun": "2024-04-01T00:00:00Z"
}