Skip to main content
PUT
Update Schedule
Integration Prompt for AI Agents
Given the schedule ID and updated configuration, this endpoint updates your schedule and returns the updated schedule.

Headers

X-Organization-Id
string
X-API-Key
string
required

API key required to authenticate requests.

Path Parameters

schedule_id
string
required

Body

application/json
timezone
string | null

IANA timezone the cron expression is read in. Null means UTC.

schedule
EveryNMinutesSchedule · object

The new schedule for the cron job.

enabled
boolean | null

Whether to enable or disable the cron job.

Response

Successful Response

id
string
required

The unique identifier for the updated cron job.

simulation_id
string
required

The unique identifier for the associated simulation.

cron_expression
string
required

The cron expression defining the job schedule.

created_at
string
required

The timestamp when the cron job was created.

enabled
boolean | null

Whether the cron job is enabled.

timezone
string | null

IANA timezone the cron expression is read in. Null means UTC.