setMonitoringSchedule
Create, adjust, pause, or remove recurring website audit schedules. Set frequency, run time, timezone, page scope, and notifications while keeping existing settings.
Instructions
Turn recurring audits on, change their settings, or turn them off for a website.
THIS COMMITS ONGOING SPEND. Each scheduled run consumes the organization's page quota indefinitely until the schedule is changed or removed, and completed runs can trigger alert email. Confirm with the user before enabling or changing a schedule.
Set enabled: false to stop monitoring. That DELETES the schedule configuration — frequency, timing and options are not retained, and re-enabling means setting them again. To pause temporarily and keep the configuration, use paused: true instead.
Settings you do not pass are carried over from the stored schedule, so you can change one field without re-sending the rest. Alert recipients cannot be set here; they are managed in the dashboard. Requires the Site Audit scheduling entitlement — the call fails with a plan message without it.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| paused | No | Pause without deleting — the configuration is kept and can be resumed. | |
| enabled | No | false removes the schedule and stops recurring audits. Defaults to true. | |
| runHour | No | Hour of day to run (0–23). Anchoring needs runHour and timezone together. | |
| timezone | No | IANA zone, e.g. 'America/New_York'. Runs stay at the same wall-clock time across DST. | |
| dayOfWeek | No | Day for a weekly schedule — 0 is Sunday. | |
| frequency | No | How often the audit runs. Required when enabling. | |
| runMinute | No | Minute of the hour. | |
| websiteId | Yes | Website ID from listWebsites. | |
| dayOfMonth | No | Day for a monthly schedule (1–28, so the day exists in every month). | |
| pageScopeMode | No | Which pages each run covers. | |
| includeNewPages | No | Audit pages discovered after the schedule was created. Increases quota use over time. | |
| notificationMode | No | When alert email is sent for this schedule. | |
| autoAdvanceBaseline | No | Move the comparison baseline forward after each run, so changes are measured against the previous run rather than a fixed point. |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| enabled | Yes | ||
| schedule | No | ||
| websiteId | Yes |