update_scheduled_run

Update an existing scheduled model run. Pass only the fields you want to change; omitted fields are left unchanged.

Parameters

Name	Type	Required	Default	Description
schedule_id	str	Yes	—	UUID of the schedule to update (from list_scheduled_runs).
cadence	str | None	No	None	New 5-field UTC cron expression. Omit to keep existing.
enabled	bool | None	No	None	False to pause, True to resume. Omit to keep existing.
branch	str | None	No	None	New target branch. Pass "" to clear (revert to project default).
model_name	str | None	No	None	New target model. Pass "" to clear (revert to project entrypoint).

Returns

Returns a structured object. Top-level fields:

• schedule (object) — the updated schedule summary (see list_scheduled_runs for field descriptions)
• message (string) — "Schedule updated."

Example

Pause a schedule

{
  "name": "update_scheduled_run",
  "arguments": {
    "schedule_id": "20202020-2020-2020-2020-202020202020",
    "enabled": false
  }
}

Change cadence

{
  "name": "update_scheduled_run",
  "arguments": {
    "schedule_id": "20202020-2020-2020-2020-202020202020",
    "cadence": "0 0 1 * *"
  }
}

Response

{
  "schedule": {
    "schedule_id": "20202020-2020-2020-2020-202020202020",
    "project_name": "forecasts",
    "model_name": null,
    "branch": null,
    "cadence": "0 0 1 * *",
    "enabled": true,
    "next_run_at": "2026-06-01T00:00:00+00:00",
    "last_run_at": "2026-05-05T08:00:00+00:00",
    "last_run_id": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa",
    "last_run_status": "success",
    "consecutive_failure_count": 0,
    "created_at": "2026-04-28T10:00:00+00:00"
  },
  "message": "Schedule updated."
}

Notes

• Module: Scheduled Runs
• Requires authentication via API token or Auth0 JWT.
• Cadence validation: 5-field UTC cron, minimum 15-minute interval.
• Re-enabling a paused schedule (setting enabled=True) recomputes next_run_at from the current time.