> For clean Markdown of any page, append .md to the page URL. > For a complete documentation index, see https://api.docs.modulards.com/llms.txt. > For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://api.docs.modulards.com/_mcp/server. # Update a website's Broken Links Checker settings PATCH https://api.modulards.com/api/public/v1/broken-link-services/{site_preset_broken_link} Content-Type: application/json Changes how one website is checked for broken links. Send only the fields you want to change, and at least one. A field you send must carry a value: an explicit `null` or a blank string answers 422, like omitting it. **Body** - `status` (`enabled` or `disabled`, optional): turns automatic scans on or pauses them. A paused website can still be scanned on demand. - `preset` (integer, optional): id of another Broken Links Checker global configuration to move the website to. The website takes that configuration's schedule and keeps its status. - `max_pages` (integer, optional): the page cap for a scan, 1 to 10000. - `excluded` (object, optional): what discovery leaves out. Each list you send replaces only that list; an empty list clears it. - `url_patterns` (array of strings, optional): URL patterns, max 500 characters each. - `source_types` (array of strings, optional): WordPress content types such as `page`, `post` or `product`, max 50 characters each. **Errors** - **404**: `preset` belongs to another organization. - **422**: no field is sent (the message is "Send at least one field to update: status, preset, max_pages or excluded."), or `schedule` is sent (the schedule belongs to the global configuration). Reference: https://api.docs.modulards.com/modular-ds-public-api/broken-links-checker/broken-links-settings/update-a-website-s-broken-links-checker-settings ## Authentication - `Authorization` header (bearer token, required) — Personal access token created in the Modular DS dashboard; read-only tokens can only call GET endpoints. ## Request ### Path parameters - `site_preset_broken_link` (string, required) ### Query parameters - `include` (string, optional) — Relations to add to the answer: `preset` (the global configuration the website uses). Without `include` it is answered; an empty `include=` answers none. Any other name answers 400. ### Body (application/json) This endpoint expects an object. - `excluded` (ApiPublicV1BrokenLinkServicesSitePresetBrokenLinkPatchRequestBodyContentApplicationJsonSchemaExcluded, optional) - `max_pages` (double, optional) - `status` (string, optional) ## Response ### 200 200 - Broken Links service updated - `data` (ApiPublicV1BrokenLinkServicesSitePresetBrokenLinkPatchResponsesContentApplicationJsonSchemaData, optional) - `included` (list of ApiPublicV1BrokenLinkServicesSitePresetBrokenLinkPatchResponsesContentApplicationJsonSchemaIncludedItems, optional) - `jsonapi` (ApiPublicV1BrokenLinkServicesSitePresetBrokenLinkPatchResponsesContentApplicationJsonSchemaJsonapi, optional) ## Errors ### 422 Unprocessable Entity Error 422 - Empty body / 422 - Explicit null - `errors` (list of ApiPublicV1BrokenLinkServicesSitePresetBrokenLinkPatchResponsesContentApplicationJsonSchemaErrorsItems, optional) - `jsonapi` (ApiPublicV1BrokenLinkServicesSitePresetBrokenLinkPatchResponsesContentApplicationJsonSchemaJsonapi, optional) ## Types ### ApiPublicV1BrokenLinkServicesSitePresetBrokenLinkPatchRequestBodyContentApplicationJsonSchemaExcluded - `url_patterns` (list of string, optional) ### ApiPublicV1BrokenLinkServicesSitePresetBrokenLinkPatchResponsesContentApplicationJsonSchemaData - `attributes` (ApiPublicV1BrokenLinkServicesSitePresetBrokenLinkPatchResponsesContentApplicationJsonSchemaDataAttributes, optional) - `id` (string, optional) - `links` (ApiPublicV1BrokenLinkServicesSitePresetBrokenLinkPatchResponsesContentApplicationJsonSchemaDataLinks, optional) - `relationships` (ApiPublicV1BrokenLinkServicesSitePresetBrokenLinkPatchResponsesContentApplicationJsonSchemaDataRelationships, optional) - `type` (string, optional) ### ApiPublicV1BrokenLinkServicesSitePresetBrokenLinkPatchResponsesContentApplicationJsonSchemaIncludedItems - `attributes` (ApiPublicV1BrokenLinkServicesSitePresetBrokenLinkPatchResponsesContentApplicationJsonSchemaIncludedItemsAttributes, optional) - `id` (string, optional) - `links` (ApiPublicV1BrokenLinkServicesSitePresetBrokenLinkPatchResponsesContentApplicationJsonSchemaIncludedItemsLinks, optional) - `type` (string, optional) ### ApiPublicV1BrokenLinkServicesSitePresetBrokenLinkPatchResponsesContentApplicationJsonSchemaJsonapi - `version` (string, optional) ### ApiPublicV1BrokenLinkServicesSitePresetBrokenLinkPatchResponsesContentApplicationJsonSchemaErrorsItems - `detail` (string, optional) - `source` (ApiPublicV1BrokenLinkServicesSitePresetBrokenLinkPatchResponsesContentApplicationJsonSchemaErrorsItemsSource, optional) - `status` (string, optional) - `title` (string, optional) ### ApiPublicV1BrokenLinkServicesSitePresetBrokenLinkPatchResponsesContentApplicationJsonSchemaDataAttributes - `broken_links_count` (double, optional) - `created_at` (string, optional) - `excluded` (ApiPublicV1BrokenLinkServicesSitePresetBrokenLinkPatchResponsesContentApplicationJsonSchemaDataAttributesExcluded, optional) - `issues_count` (double, optional) - `last_request` (string, optional) - `last_scan_at` (string, optional) - `max_pages` (double, optional) - `mixed_content_count` (double, optional) - `next_request` (string, optional) - `pages_scanned` (double, optional) - `scan_status` (string, optional) - `schedule` (ApiPublicV1BrokenLinkServicesSitePresetBrokenLinkPatchResponsesContentApplicationJsonSchemaDataAttributesSchedule, optional) - `status` (string, optional) - `updated_at` (string, optional) ### ApiPublicV1BrokenLinkServicesSitePresetBrokenLinkPatchResponsesContentApplicationJsonSchemaDataLinks - `self` (string, optional) ### ApiPublicV1BrokenLinkServicesSitePresetBrokenLinkPatchResponsesContentApplicationJsonSchemaDataRelationships - `preset` (ApiPublicV1BrokenLinkServicesSitePresetBrokenLinkPatchResponsesContentApplicationJsonSchemaDataRelationshipsPreset, optional) ### ApiPublicV1BrokenLinkServicesSitePresetBrokenLinkPatchResponsesContentApplicationJsonSchemaIncludedItemsAttributes - `check_external` (boolean, optional) - `check_internal` (boolean, optional) - `check_mixed_content` (boolean, optional) - `created_at` (string, optional) - `is_default` (boolean, optional) - `mode` (string, optional) - `name` (string, optional) - `resource_types` (list of string, optional) - `schedule` (ApiPublicV1BrokenLinkServicesSitePresetBrokenLinkPatchResponsesContentApplicationJsonSchemaIncludedItemsAttributesSchedule, optional) - `status` (string, optional) - `updated_at` (string, optional) ### ApiPublicV1BrokenLinkServicesSitePresetBrokenLinkPatchResponsesContentApplicationJsonSchemaIncludedItemsLinks - `self` (string, optional) ### ApiPublicV1BrokenLinkServicesSitePresetBrokenLinkPatchResponsesContentApplicationJsonSchemaErrorsItemsSource - `parameter` (string, optional) ### ApiPublicV1BrokenLinkServicesSitePresetBrokenLinkPatchResponsesContentApplicationJsonSchemaDataAttributesExcluded - `source_types` (list of string, optional) - `url_patterns` (list of string, optional) ### ApiPublicV1BrokenLinkServicesSitePresetBrokenLinkPatchResponsesContentApplicationJsonSchemaDataAttributesSchedule - `day_month` (double, optional) - `day_week` (any, optional, nullable) - `frequency` (string, optional) - `start_hour` (string, optional) - `timezone` (string, optional) ### ApiPublicV1BrokenLinkServicesSitePresetBrokenLinkPatchResponsesContentApplicationJsonSchemaDataRelationshipsPreset - `data` (ApiPublicV1BrokenLinkServicesSitePresetBrokenLinkPatchResponsesContentApplicationJsonSchemaDataRelationshipsPresetData, optional) ### ApiPublicV1BrokenLinkServicesSitePresetBrokenLinkPatchResponsesContentApplicationJsonSchemaIncludedItemsAttributesSchedule - `day_month` (double, optional) - `day_week` (any, optional, nullable) - `frequency` (string, optional) - `start_hour` (string, optional) - `timezone` (string, optional) ### ApiPublicV1BrokenLinkServicesSitePresetBrokenLinkPatchResponsesContentApplicationJsonSchemaDataRelationshipsPresetData - `id` (string, optional) - `type` (string, optional) ## Examples ### 200 - Broken Links service updated **Response** ```json { "data": { "attributes": { "broken_links_count": 10, "created_at": "2026-08-01T09:00:00.000000Z", "excluded": { "source_types": [ "attachment" ], "url_patterns": [ "/author/", "/feed/" ] }, "issues_count": 12, "last_request": "2026-09-10T03:00:00.000000Z", "last_scan_at": "2026-09-10T03:12:00.000000Z", "max_pages": 800, "mixed_content_count": 2, "next_request": "2026-10-04T03:17:00.000000Z", "pages_scanned": 240, "scan_status": "done", "schedule": { "day_month": 4, "day_week": null, "frequency": "monthly", "start_hour": "03:00", "timezone": "UTC" }, "status": "enabled", "updated_at": "2026-09-17T11:20:00.000000Z" }, "id": "901", "links": { "self": "https://api.modulards.com/api/public/v1/broken-link-services/901" }, "relationships": { "preset": { "data": { "id": "42", "type": "preset-broken-links" } } }, "type": "site-preset-broken-links" }, "included": [ { "attributes": { "check_external": false, "check_internal": true, "check_mixed_content": true, "created_at": "2026-09-17T10:00:00.000000Z", "is_default": true, "mode": "plain", "name": "Monthly check", "resource_types": [ "link", "image", "script", "stylesheet" ], "schedule": { "day_month": 4, "day_week": null, "frequency": "monthly", "start_hour": "03:00", "timezone": "UTC" }, "status": "enabled", "updated_at": "2026-09-17T10:00:00.000000Z" }, "id": "42", "links": { "self": "https://api.modulards.com/api/public/v1/preset-broken-links/42" }, "type": "preset-broken-links" } ], "jsonapi": { "version": "1.1" } } ``` **SDK Code** ```python 200 - Broken Links service updated import requests url = "https://api.modulards.com/api/public/v1/broken-link-services/site_preset_broken_link" headers = {"Authorization": "Bearer "} response = requests.patch(url, headers=headers) print(response.json()) ``` ```javascript 200 - Broken Links service updated const url = 'https://api.modulards.com/api/public/v1/broken-link-services/site_preset_broken_link'; const options = {method: 'PATCH', headers: {Authorization: 'Bearer '}}; try { const response = await fetch(url, options); const data = await response.json(); console.log(data); } catch (error) { console.error(error); } ``` ```go 200 - Broken Links service updated package main import ( "fmt" "net/http" "io" ) func main() { url := "https://api.modulards.com/api/public/v1/broken-link-services/site_preset_broken_link" req, _ := http.NewRequest("PATCH", url, nil) req.Header.Add("Authorization", "Bearer ") res, _ := http.DefaultClient.Do(req) defer res.Body.Close() body, _ := io.ReadAll(res.Body) fmt.Println(res) fmt.Println(string(body)) } ``` ```ruby 200 - Broken Links service updated require 'uri' require 'net/http' url = URI("https://api.modulards.com/api/public/v1/broken-link-services/site_preset_broken_link") http = Net::HTTP.new(url.host, url.port) http.use_ssl = true request = Net::HTTP::Patch.new(url) request["Authorization"] = 'Bearer ' response = http.request(request) puts response.read_body ``` ```java 200 - Broken Links service updated import com.mashape.unirest.http.HttpResponse; import com.mashape.unirest.http.Unirest; HttpResponse response = Unirest.patch("https://api.modulards.com/api/public/v1/broken-link-services/site_preset_broken_link") .header("Authorization", "Bearer ") .asString(); ``` ```php 200 - Broken Links service updated request('PATCH', 'https://api.modulards.com/api/public/v1/broken-link-services/site_preset_broken_link', [ 'headers' => [ 'Authorization' => 'Bearer ', ], ]); echo $response->getBody(); ``` ```csharp 200 - Broken Links service updated using RestSharp; var client = new RestClient("https://api.modulards.com/api/public/v1/broken-link-services/site_preset_broken_link"); var request = new RestRequest(Method.PATCH); request.AddHeader("Authorization", "Bearer "); IRestResponse response = client.Execute(request); ``` ```swift 200 - Broken Links service updated import Foundation let headers = ["Authorization": "Bearer "] let request = NSMutableURLRequest(url: NSURL(string: "https://api.modulards.com/api/public/v1/broken-link-services/site_preset_broken_link")! as URL, cachePolicy: .useProtocolCachePolicy, timeoutInterval: 10.0) request.httpMethod = "PATCH" request.allHTTPHeaderFields = headers let session = URLSession.shared let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in if (error != nil) { print(error as Any) } else { let httpResponse = response as? HTTPURLResponse print(httpResponse) } }) dataTask.resume() ``` ### Update a website's Broken Links Checker settings **Request** ```json { "excluded": { "url_patterns": [ "/author/", "/feed/" ] }, "max_pages": 800, "status": "enabled" } ``` **Response** ```json { "data": { "attributes": { "broken_links_count": 10, "created_at": "2026-08-01T09:00:00.000000Z", "excluded": { "source_types": [ "attachment" ], "url_patterns": [ "/author/", "/feed/" ] }, "issues_count": 12, "last_request": "2026-09-10T03:00:00.000000Z", "last_scan_at": "2026-09-10T03:12:00.000000Z", "max_pages": 800, "mixed_content_count": 2, "next_request": "2026-10-04T03:17:00.000000Z", "pages_scanned": 240, "scan_status": "done", "schedule": { "day_month": 4, "day_week": null, "frequency": "monthly", "start_hour": "03:00", "timezone": "UTC" }, "status": "enabled", "updated_at": "2026-09-17T11:20:00.000000Z" }, "id": "901", "links": { "self": "https://api.modulards.com/api/public/v1/broken-link-services/901" }, "relationships": { "preset": { "data": { "id": "42", "type": "preset-broken-links" } } }, "type": "site-preset-broken-links" }, "included": [ { "attributes": { "check_external": false, "check_internal": true, "check_mixed_content": true, "created_at": "2026-09-17T10:00:00.000000Z", "is_default": true, "mode": "plain", "name": "Monthly check", "resource_types": [ "link", "image", "script", "stylesheet" ], "schedule": { "day_month": 4, "day_week": null, "frequency": "monthly", "start_hour": "03:00", "timezone": "UTC" }, "status": "enabled", "updated_at": "2026-09-17T10:00:00.000000Z" }, "id": "42", "links": { "self": "https://api.modulards.com/api/public/v1/preset-broken-links/42" }, "type": "preset-broken-links" } ], "jsonapi": { "version": "1.1" } } ``` **SDK Code** ```python Update a website's Broken Links Checker settings import requests url = "https://api.modulards.com/api/public/v1/broken-link-services/site_preset_broken_link" payload = { "excluded": { "url_patterns": ["/author/", "/feed/"] }, "max_pages": 800, "status": "enabled" } headers = { "Authorization": "Bearer ", "Content-Type": "application/json" } response = requests.patch(url, json=payload, headers=headers) print(response.json()) ``` ```javascript Update a website's Broken Links Checker settings const url = 'https://api.modulards.com/api/public/v1/broken-link-services/site_preset_broken_link'; const options = { method: 'PATCH', headers: {Authorization: 'Bearer ', 'Content-Type': 'application/json'}, body: '{"excluded":{"url_patterns":["/author/","/feed/"]},"max_pages":800,"status":"enabled"}' }; try { const response = await fetch(url, options); const data = await response.json(); console.log(data); } catch (error) { console.error(error); } ``` ```go Update a website's Broken Links Checker settings package main import ( "fmt" "strings" "net/http" "io" ) func main() { url := "https://api.modulards.com/api/public/v1/broken-link-services/site_preset_broken_link" payload := strings.NewReader("{\n \"excluded\": {\n \"url_patterns\": [\n \"/author/\",\n \"/feed/\"\n ]\n },\n \"max_pages\": 800,\n \"status\": \"enabled\"\n}") req, _ := http.NewRequest("PATCH", url, payload) req.Header.Add("Authorization", "Bearer ") req.Header.Add("Content-Type", "application/json") res, _ := http.DefaultClient.Do(req) defer res.Body.Close() body, _ := io.ReadAll(res.Body) fmt.Println(res) fmt.Println(string(body)) } ``` ```ruby Update a website's Broken Links Checker settings require 'uri' require 'net/http' url = URI("https://api.modulards.com/api/public/v1/broken-link-services/site_preset_broken_link") http = Net::HTTP.new(url.host, url.port) http.use_ssl = true request = Net::HTTP::Patch.new(url) request["Authorization"] = 'Bearer ' request["Content-Type"] = 'application/json' request.body = "{\n \"excluded\": {\n \"url_patterns\": [\n \"/author/\",\n \"/feed/\"\n ]\n },\n \"max_pages\": 800,\n \"status\": \"enabled\"\n}" response = http.request(request) puts response.read_body ``` ```java Update a website's Broken Links Checker settings import com.mashape.unirest.http.HttpResponse; import com.mashape.unirest.http.Unirest; HttpResponse response = Unirest.patch("https://api.modulards.com/api/public/v1/broken-link-services/site_preset_broken_link") .header("Authorization", "Bearer ") .header("Content-Type", "application/json") .body("{\n \"excluded\": {\n \"url_patterns\": [\n \"/author/\",\n \"/feed/\"\n ]\n },\n \"max_pages\": 800,\n \"status\": \"enabled\"\n}") .asString(); ``` ```php Update a website's Broken Links Checker settings request('PATCH', 'https://api.modulards.com/api/public/v1/broken-link-services/site_preset_broken_link', [ 'body' => '{ "excluded": { "url_patterns": [ "/author/", "/feed/" ] }, "max_pages": 800, "status": "enabled" }', 'headers' => [ 'Authorization' => 'Bearer ', 'Content-Type' => 'application/json', ], ]); echo $response->getBody(); ``` ```csharp Update a website's Broken Links Checker settings using RestSharp; var client = new RestClient("https://api.modulards.com/api/public/v1/broken-link-services/site_preset_broken_link"); var request = new RestRequest(Method.PATCH); request.AddHeader("Authorization", "Bearer "); request.AddHeader("Content-Type", "application/json"); request.AddParameter("application/json", "{\n \"excluded\": {\n \"url_patterns\": [\n \"/author/\",\n \"/feed/\"\n ]\n },\n \"max_pages\": 800,\n \"status\": \"enabled\"\n}", ParameterType.RequestBody); IRestResponse response = client.Execute(request); ``` ```swift Update a website's Broken Links Checker settings import Foundation let headers = [ "Authorization": "Bearer ", "Content-Type": "application/json" ] let parameters = [ "excluded": ["url_patterns": ["/author/", "/feed/"]], "max_pages": 800, "status": "enabled" ] as [String : Any] let postData = JSONSerialization.data(withJSONObject: parameters, options: []) let request = NSMutableURLRequest(url: NSURL(string: "https://api.modulards.com/api/public/v1/broken-link-services/site_preset_broken_link")! as URL, cachePolicy: .useProtocolCachePolicy, timeoutInterval: 10.0) request.httpMethod = "PATCH" request.allHTTPHeaderFields = headers request.httpBody = postData as Data let session = URLSession.shared let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in if (error != nil) { print(error as Any) } else { let httpResponse = response as? HTTPURLResponse print(httpResponse) } }) dataTask.resume() ```