Skip to main content
POST
Create a schedule

Authorizations

Authorization
string
header
required

User API key: Authorization: Bearer mx_live_*. The X-API-KEY: mx_live_* header is also accepted.

X-Organization-ID
string
header
required

Required organization context for org-scoped endpoints.

Body

application/json
workflow_id
string<uuid>
required
name
string
required
Required string length: 1 - 255
schedule_type
enum<string>
required
Available options:
interval,
cron
description
string | null
interval_seconds
integer | null

Required for interval schedules (>= 60).

Required range: x >= 60
cron_expression
string | null

Required for cron schedules.

Maximum string length: 100
Example:

"0 9 * * *"

timezone
string
default:UTC
Maximum string length: 50
input
object
config
object

Response

The created schedule.

A workflow schedule.

id
string<uuid>
workflow_id
string<uuid>
organization_id
string<uuid>
name
string
description
string | null
schedule_type
enum<string>
Available options:
interval,
cron
interval_seconds
integer | null
cron_expression
string | null
Example:

"0 9 * * *"

timezone
string
input
object
config
object
is_active
boolean
next_run_at
string<date-time> | null
last_run_at
string<date-time> | null
last_run_status
string | null
total_runs
integer
successful_runs
integer
failed_runs
integer
created_at
string<date-time>
updated_at
string<date-time>