Set Plan Schedule
set_plan_scheduleGive a plan a schedule so it fires on its own, change it, or clear it. Pick a cadence: hourly (at minute past each hour), daily (at hour:minute), weekly (also weekday, MON to SUN) or monthly (also day, 1 to 28), in timezone (an IANA name such as America/Los_Angeles; omitted means UTC). Pass cadence 'none' to clear the schedule, after which the plan fires only when somebody fires it. ONCE SET, EVERY FIRING RUNS WITH NOBODY CONFIRMING IT, spending what the plan's steps spend each time, so read the plan with get_plan first. Scheduling needs every permission the plan's steps call, and each firing runs with your permissions as they stand when it fires: if you lose one the steps need, or your access is revoked, the schedule stops and the workspace's admins are told. Only an active plan can be scheduled, and a plan with a create step that refreshes nobody (update_cap 0) is refused. The response says when it fires and which steps ask the provider about their whole scope on every firing.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| day | No | Day of the month, 1 to 28. Monthly only. | |
| hour | No | 0 to 23. Needed for daily, weekly and monthly. | |
| minute | No | 0 to 59. Defaults to 0. | |
| cadence | Yes | How often it fires, or 'none' to clear the schedule. | |
| plan_id | Yes | The plan to schedule. | |
| weekday | No | MON, TUE, WED, THU, FRI, SAT or SUN. Weekly only. | |
| timezone | No | An IANA time zone name, e.g. America/New_York. Omitted means UTC. | |
| connection_id | Yes | The CRM connection. Call list_crm_connections first. |