update_schedule
Change a schedule’s cadence, its name, or the instruction it runs with. Only the fields you pass change.
Parameters#
| Name | Type | Required | Default | Description |
|---|---|---|---|---|
schedule_id | string | yes | The schedule id | |
name | string | null | no | New name | |
message | string | null | no | New instruction for an agent target | |
frequency | string | null | no | hourly, daily, weekdays, weekly, monthly | |
hour | integer | no | 9 | Hour of day, 0–23 |
minute | integer | no | 0 | Minute of the hour, 0–59 |
weekday | integer | null | no | 0=Sunday … 6=Saturday, for frequency: weekly | |
day_of_month | integer | null | no | 1–28, for frequency: monthly | |
cron_expression | string | null | no | A 5-field cron expression, instead of frequency | |
timezone | string | null | no | IANA name | |
description | string | null | no | New description | |
interval | integer | null | no | Repeat every N days/weeks/months (2 on a weekly cadence = every other week). Re-anchors on the next fire when it changes |
Pass at most one of frequency / cron_expression.
Returns#
The same shape as create_schedule — including the updated human_readable and next_runs, so you can confirm the new cadence.
Errors#
error_type | When |
|---|---|
auth_error | Missing / invalid API key |
feature_not_available | Your plan does not include schedules |
not_found | Unknown schedule id, or one outside your organization |
invalid_input | Both cadence forms passed; a malformed cron; unknown timezone |