update_scheduled_run
Update an existing scheduled model run. schedule_id is required (from list_scheduled_runs). Pass only the fields you want to change: cadence (new cron expression), enabled (pause or resume), branch (switch target branch), model_name (switch target model). Cadence validation: 5-field UTC cron, minimum 15-minute interval. Returns: schedule (dict) — updated schedule summary; message (str) — update summary.
Parameters
Section titled “Parameters”| Name | Type | Required | Default | Description |
|---|---|---|---|---|
schedule_id | Annotated[str, Field(description='UUID of the scheduled run to manage.')] | Yes | — | |
cadence | `Annotated[str | None, Field(description=“Cron expression or interval string defining when the run executes (e.g. ‘0 9 * * 1’ for Mondays at 9am UTC).”)]` | No | None |
enabled | `Annotated[bool | None, Field(description=‘Whether the scheduled run is active.’)]` | No | None |
branch | `Annotated[str | None, Field(description=“Branch to execute the scheduled run from. Defaults to the project’s default branch.”)]` | No | None |
model_name | `Annotated[str | None, Field(description=“Model file to execute on the schedule (without .py extension). Defaults to ‘run’.”)]` | No | None |
Returns
Section titled “Returns”Returns a structured object. Top-level fields:
schedule(object)message(string)
See the response example below for the full payload shape.
Example
Section titled “Example”Tool Call
Section titled “Tool Call”{ "name": "update_scheduled_run", "arguments": { "schedule_id": "20202020-2020-2020-2020-202020202020", "cadence": "0 9 * * 1" }}Response
Section titled “Response”{ "schedule": { "schedule_id": "20202020-2020-2020-2020-202020202020", "project_name": "forecasts", "model_name": null, "branch": null, "cadence": "0 9 * * 1", "enabled": true, "next_run_at": "2026-05-12T09:00:00+00:00", "last_run_at": "2026-05-05T08:00:00+00:00", "last_run_id": "66666666-6666-6666-6666-666666666666", "last_run_status": "success", "consecutive_failure_count": 0, "created_at": "2026-04-28T10:00:00+00:00" }, "message": "Schedule updated."}- Module:
Scheduled Runs - Requires authentication via API token or Auth0 JWT.