POST /v1/durable/schedules - Create a new schedule

POST

/v1/durable/schedules

• Production API

Request Body ^required

Create schedule request

object

catch_up_missed

Whether to catch up missed triggers (default: false)

boolean

cron_expression

required

Cron expression (5-field or 7-field)

string

description

Optional description

string | null

enabled

Whether schedule is enabled (default: true)

boolean

max_catch_up

Max catch-up executions

integer | null format: int32

max_concurrent

Max concurrent executions

integer | null format: int32

name

required

Unique name for the schedule

string

retry_policy

Retry policy for failed executions

target

required

Target to trigger

object

input

Input JSON for the workflow/activity

name

required

Workflow type name or activity type name

string

type

required

Target type: “workflow” or “activity”

string

timezone

Timezone (default: UTC)

string

Responses

201

Schedule created

Schedule response

object

catch_up_missed

required

boolean

created_at

required

string format: date-time

cron_expression

required

string

description

string | null

enabled

required

boolean

id

required

string format: uuid

last_triggered_at

string | null format: date-time

max_catch_up

integer | null format: int32

max_concurrent

integer | null format: int32

name

required

string

next_trigger_at

string | null format: date-time

retry_policy

target

required

Schedule target response

object

input

required

name

required

string

type

required

string

timezone

required

string

updated_at

required

string format: date-time

400

Invalid request

Standard error response for API endpoints.

object

error

required

Error message describing what went wrong.

string

409

Schedule name already exists

Standard error response for API endpoints.

object

error

required

Error message describing what went wrong.

string

500

Internal server error

Standard error response for API endpoints.

object

error

required

Error message describing what went wrong.

string