Update website settings
update_website_settingsChange one website's stored audit settings: level, max_pages, render, external_links, max_depth, scope, include_patterns and exclude_patterns, and schedule (off, daily, weekly or monthly) for its recurring audits. Omitted fields are left unchanged. Values are checked the same way the dashboard's settings are and held to the organization's plan; the result reports what is stored afterwards, which fields were applied, and any plan clamp. Turning recurring audits on, changing their cadence, or a change that raises the most one audit can cost returns status "confirmation_required" with the estimated credit cost and changes nothing until it is sent again with the same arguments plus confirm: true. schedule: "off" and changes that cost nothing more apply at once.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| level | No | Audit level preset. Setting one resets the level's settings to the preset, with any max_pages, render or external_links in the same call applied on top. | |
| scope | No | 'discover' follows links from the pages it finds; 'sitemap' audits only the URLs the site's sitemap publishes. | |
| render | No | Rendering: off fetches over HTTP only, auto renders the pages that need JavaScript, all renders every page. | |
| confirm | No | Approve a change that turns recurring audits on, changes their cadence, or raises the most one audit can cost. Without it such a change returns the estimate and is not applied. | |
| schedule | No | Recurring audits: off, daily, weekly or monthly. A cadence the plan does not run is held to one it does, and the result says so. | |
| max_depth | No | How many links deep the crawl follows from the start page, 1 to 10; null removes the limit. | |
| max_pages | No | Page budget of each audit, 1 to 10000. A value above the plan's per-audit ceiling is stored and held to the ceiling when an audit runs (runs_as reports it). | |
| website_id | Yes | Website id from list_websites, run_audit or add_website. | |
| external_links | No | Check links that leave the site. In the cloud each distinct destination costs a credit. | |
| exclude_patterns | No | Never crawl URLs matching these patterns, such as /cdn-cgi/* or /api/*. Replaces the stored list; an empty list clears it. | |
| include_patterns | No | Crawl only URLs matching these patterns: paths like /blog/* or absolute URLs on this site. Replaces the stored list; an empty list removes the restriction. |