> 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 Broken Links service

PATCH https://api.modulards.com/api/public/v1/broken-link-services/{site_preset_broken_link}
Content-Type: application/json

Changes ONE website's Broken Links Checker settings. Send only what changes (at least one of `status`, `preset`, `max_pages` or `excluded` - sending none of them answers 422 "Send at least one field to update: status, preset, max_pages or excluded."); answers **200** with the Broken Links Checker service document. Accepts PUT as well as PATCH, with the same body; PATCH is the documented method.

**Body** (JSON), every field optional but at least one required:
- `status` (`enabled`, `disabled`) - a paused website can still be scanned on demand.
- `preset` (integer) - id of another Broken Links Checker global configuration to move the website to. Moves the website, copies that configuration's schedule and keeps the website's status; an id of another organization answers 404.
- `max_pages` (integer, 1-10000) - the page cap for a scan.
- `excluded` (object): `url_patterns` (array of strings, max 500 each) and/or `source_types` (array of WordPress content types such as `page`, `post`, `product`, max 50 each). Each list you send replaces only that list; an empty list clears it.

A sent field must carry a value: an explicit `null` or a blank string answers 422, the same as omitting it.

The schedule belongs to the configuration and any global configuration field is unknown here: sending `schedule` answers 422.

The response's `preset` relationship carries the configuration the website uses (canonical shape, its own nested `schedule`), included by default.

Requires a full-access token (read-only tokens answer 403). A service or a configuration of another organization answers 404.

Reference: https://api.docs.modulards.com/modular-ds-public-api/broken-links-checker/update-broken-links-service

## 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)

### Body (application/json)

This endpoint expects an object.

- `excluded` (object, optional)
  - `url_patterns` (list of string, optional)
- `max_pages` (double, optional)
- `status` (string, optional)

## Response

### 200

200 - Broken Links service updated

- `data` (object, optional)
  - `attributes` (object, optional)
    - `broken_links_count` (double, optional)
    - `created_at` (string, optional)
    - `excluded` (object, optional)
      - `source_types` (list of string, optional)
      - `url_patterns` (list of string, 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` (object, optional)
      - `day_month` (double, optional)
      - `day_week` (any, optional, nullable)
      - `frequency` (string, optional)
      - `start_hour` (string, optional)
      - `timezone` (string, optional)
    - `status` (string, optional)
    - `updated_at` (string, optional)
  - `id` (string, optional)
  - `links` (object, optional)
    - `self` (string, optional)
  - `relationships` (object, optional)
    - `preset` (object, optional)
      - `data` (object, optional)
        - `id` (string, optional)
        - `type` (string, optional)
  - `type` (string, optional)
- `included` (list of object, optional)
  - `attributes` (object, optional)
    - `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` (object, optional)
      - `day_month` (double, optional)
      - `day_week` (any, optional, nullable)
      - `frequency` (string, optional)
      - `start_hour` (string, optional)
      - `timezone` (string, optional)
    - `status` (string, optional)
    - `updated_at` (string, optional)
  - `id` (string, optional)
  - `links` (object, optional)
    - `self` (string, optional)
  - `type` (string, optional)
- `jsonapi` (object, optional)
  - `version` (string, optional)

## Errors

### 422 Unprocessable Entity Error

422 - Empty body / 422 - Explicit null

- `errors` (list of object, optional)
  - `detail` (string, optional)
  - `source` (object, optional)
    - `parameter` (string, optional)
  - `status` (string, optional)
  - `title` (string, optional)
- `jsonapi` (object, optional)
  - `version` (string, optional)

## Examples

### 200 - Broken Links service updated

**Request**

```json
undefined
```

**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 <token>"}

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 <token>'}};

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 <token>")

	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 <token>'

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<String> response = Unirest.patch("https://api.modulards.com/api/public/v1/broken-link-services/site_preset_broken_link")
  .header("Authorization", "Bearer <token>")
  .asString();
```

```php 200 - Broken Links service updated
<?php
require_once('vendor/autoload.php');

$client = new \GuzzleHttp\Client();

$response = $client->request('PATCH', 'https://api.modulards.com/api/public/v1/broken-link-services/site_preset_broken_link', [
  'headers' => [
    'Authorization' => 'Bearer <token>',
  ],
]);

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 <token>");
IRestResponse response = client.Execute(request);
```

```swift 200 - Broken Links service updated
import Foundation

let headers = ["Authorization": "Bearer <token>"]

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 Broken Links service

**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 Broken Links service
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 <token>",
    "Content-Type": "application/json"
}

response = requests.patch(url, json=payload, headers=headers)

print(response.json())
```

```javascript Update Broken Links service
const url = 'https://api.modulards.com/api/public/v1/broken-link-services/site_preset_broken_link';
const options = {
  method: 'PATCH',
  headers: {Authorization: 'Bearer <token>', '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 Broken Links service
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 <token>")
	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 Broken Links service
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 <token>'
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 Broken Links service
import com.mashape.unirest.http.HttpResponse;
import com.mashape.unirest.http.Unirest;

HttpResponse<String> response = Unirest.patch("https://api.modulards.com/api/public/v1/broken-link-services/site_preset_broken_link")
  .header("Authorization", "Bearer <token>")
  .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 Broken Links service
<?php
require_once('vendor/autoload.php');

$client = new \GuzzleHttp\Client();

$response = $client->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 <token>',
    'Content-Type' => 'application/json',
  ],
]);

echo $response->getBody();
```

```csharp Update Broken Links service
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 <token>");
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 Broken Links service
import Foundation

let headers = [
  "Authorization": "Bearer <token>",
  "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()
```