> For clean Markdown of any page, append .md to the page URL.
> For a complete documentation index, see https://api.docs.modulards.com/modular-ds-public-api/broken-links-checker/broken-links-global-configurations/create-a-broken-links-checker-global-configuration/llms.txt.
> For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://api.docs.modulards.com/_mcp/server.

# Create a Broken Links Checker global configuration

POST https://api.modulards.com/api/public/v1/preset-broken-links
Content-Type: application/json

Creates a Broken Links Checker global configuration: a named scan schedule you then assign to websites. Creating it scans nothing yet: assign websites with "Assign websites to a Broken Links Checker global configuration".

The global configuration is always enabled and has no status: scans are paused per website, with "Update a website's Broken Links Checker settings". The page cap and the exclusions are per website too. A field you send must carry a value: an explicit `null` or a blank string answers 422, like leaving a required field out.

**Body**
- `name` (string, required): the configuration's name, at most 255 characters.
- `schedule` (object, required): when scans run.
  - `frequency` (`weekly` or `monthly`, required): your plan decides which are available.
  - `start_hour` (`HH:MM`, required): 24 hours.
  - `timezone` (string, required): IANA name, for example `UTC`.
  - `day_week` (`monday` to `sunday`, required for a weekly schedule, refused otherwise).
  - `day_month` (integer from 1 to 31, required for a monthly schedule, refused otherwise).
- `check_internal`, `check_external`, `check_mixed_content` (boolean, optional): default `true`.
- `resource_types` (array of strings, optional): what discovery extracts, at least one of `link`, `image`, `script`, `stylesheet`, `og_image` or `canonical`. Default `link`, `image`, `script`, `stylesheet`.
- `mode` (`plain` or `render`, optional): default `plain`. `render` runs WordPress filters on the page content first and loads the website more.
- `default` (boolean, optional): `true` makes it the configuration new websites receive.

**Errors**
- **422**: `max_pages` or `excluded` is sent, or a field is sent as `null` or blank.

Reference: https://api.docs.modulards.com/modular-ds-public-api/broken-links-checker/broken-links-global-configurations/create-a-broken-links-checker-global-configuration

## Authentication

- `Authorization` header (bearer token, required) — Personal access token created in the Modular DS dashboard; read-only tokens can only call GET endpoints.

## Request

### Body (application/json)

This endpoint expects an object.

- `check_external` (boolean, optional)
- `default` (boolean, optional)
- `name` (string, optional)
- `schedule` (ApiPublicV1PresetBrokenLinksPostRequestBodyContentApplicationJsonSchemaSchedule, optional)

## Response

### 201

201 - Broken Links configuration created

- `data` (ApiPublicV1PresetBrokenLinksPostResponsesContentApplicationJsonSchemaData, optional)
- `jsonapi` (ApiPublicV1PresetBrokenLinksPostResponsesContentApplicationJsonSchemaJsonapi, optional)

## Errors

### 422 Unprocessable Entity Error

422 - Per-website field refused / 422 - Blank field

- `errors` (list of ApiPublicV1PresetBrokenLinksPostResponsesContentApplicationJsonSchemaErrorsItems, optional)
- `jsonapi` (ApiPublicV1PresetBrokenLinksPostResponsesContentApplicationJsonSchemaJsonapi, optional)

## Types

### ApiPublicV1PresetBrokenLinksPostRequestBodyContentApplicationJsonSchemaSchedule

- `day_month` (double, optional)
- `frequency` (string, optional)
- `start_hour` (string, optional)
- `timezone` (string, optional)

### ApiPublicV1PresetBrokenLinksPostResponsesContentApplicationJsonSchemaData

- `attributes` (ApiPublicV1PresetBrokenLinksPostResponsesContentApplicationJsonSchemaDataAttributes, optional)
- `id` (string, optional)
- `links` (ApiPublicV1PresetBrokenLinksPostResponsesContentApplicationJsonSchemaDataLinks, optional)
- `type` (string, optional)

### ApiPublicV1PresetBrokenLinksPostResponsesContentApplicationJsonSchemaJsonapi

- `version` (string, optional)

### ApiPublicV1PresetBrokenLinksPostResponsesContentApplicationJsonSchemaErrorsItems

- `detail` (string, optional)
- `source` (ApiPublicV1PresetBrokenLinksPostResponsesContentApplicationJsonSchemaErrorsItemsSource, optional)
- `status` (string, optional)
- `title` (string, optional)

### ApiPublicV1PresetBrokenLinksPostResponsesContentApplicationJsonSchemaDataAttributes

- `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` (ApiPublicV1PresetBrokenLinksPostResponsesContentApplicationJsonSchemaDataAttributesSchedule, optional)
- `status` (string, optional)
- `updated_at` (string, optional)

### ApiPublicV1PresetBrokenLinksPostResponsesContentApplicationJsonSchemaDataLinks

- `self` (string, optional)

### ApiPublicV1PresetBrokenLinksPostResponsesContentApplicationJsonSchemaErrorsItemsSource

- `parameter` (string, optional)

### ApiPublicV1PresetBrokenLinksPostResponsesContentApplicationJsonSchemaDataAttributesSchedule

- `day_month` (double, optional)
- `day_week` (any, optional, nullable)
- `frequency` (string, optional)
- `start_hour` (string, optional)
- `timezone` (string, optional)

## Examples

### 201 - Broken Links configuration created

**Response**

```json
{
  "data": {
    "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 201 - Broken Links configuration created
import requests

url = "https://api.modulards.com/api/public/v1/preset-broken-links"

headers = {"Authorization": "Bearer <token>"}

response = requests.post(url, headers=headers)

print(response.json())
```

```javascript 201 - Broken Links configuration created
const url = 'https://api.modulards.com/api/public/v1/preset-broken-links';
const options = {method: 'POST', 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 201 - Broken Links configuration created
package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.modulards.com/api/public/v1/preset-broken-links"

	req, _ := http.NewRequest("POST", 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 201 - Broken Links configuration created
require 'uri'
require 'net/http'

url = URI("https://api.modulards.com/api/public/v1/preset-broken-links")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body
```

```java 201 - Broken Links configuration created
import com.mashape.unirest.http.HttpResponse;
import com.mashape.unirest.http.Unirest;

HttpResponse<String> response = Unirest.post("https://api.modulards.com/api/public/v1/preset-broken-links")
  .header("Authorization", "Bearer <token>")
  .asString();
```

```php 201 - Broken Links configuration created
<?php
require_once('vendor/autoload.php');

$client = new \GuzzleHttp\Client();

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

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

```csharp 201 - Broken Links configuration created
using RestSharp;

var client = new RestClient("https://api.modulards.com/api/public/v1/preset-broken-links");
var request = new RestRequest(Method.POST);
request.AddHeader("Authorization", "Bearer <token>");
IRestResponse response = client.Execute(request);
```

```swift 201 - Broken Links configuration created
import Foundation

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

let request = NSMutableURLRequest(url: NSURL(string: "https://api.modulards.com/api/public/v1/preset-broken-links")! as URL,
                                        cachePolicy: .useProtocolCachePolicy,
                                    timeoutInterval: 10.0)
request.httpMethod = "POST"
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()
```

### Create a Broken Links Checker global configuration

**Request**

```json
{
  "check_external": false,
  "default": true,
  "name": "Monthly check",
  "schedule": {
    "day_month": 4,
    "frequency": "monthly",
    "start_hour": "03:00",
    "timezone": "UTC"
  }
}
```

**Response**

```json
{
  "data": {
    "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 Create a Broken Links Checker global configuration
import requests

url = "https://api.modulards.com/api/public/v1/preset-broken-links"

payload = {
    "check_external": False,
    "default": True,
    "name": "Monthly check",
    "schedule": {
        "day_month": 4,
        "frequency": "monthly",
        "start_hour": "03:00",
        "timezone": "UTC"
    }
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

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

print(response.json())
```

```javascript Create a Broken Links Checker global configuration
const url = 'https://api.modulards.com/api/public/v1/preset-broken-links';
const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: '{"check_external":false,"default":true,"name":"Monthly check","schedule":{"day_month":4,"frequency":"monthly","start_hour":"03:00","timezone":"UTC"}}'
};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}
```

```go Create a Broken Links Checker global configuration
package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.modulards.com/api/public/v1/preset-broken-links"

	payload := strings.NewReader("{\n  \"check_external\": false,\n  \"default\": true,\n  \"name\": \"Monthly check\",\n  \"schedule\": {\n    \"day_month\": 4,\n    \"frequency\": \"monthly\",\n    \"start_hour\": \"03:00\",\n    \"timezone\": \"UTC\"\n  }\n}")

	req, _ := http.NewRequest("POST", 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 Create a Broken Links Checker global configuration
require 'uri'
require 'net/http'

url = URI("https://api.modulards.com/api/public/v1/preset-broken-links")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"check_external\": false,\n  \"default\": true,\n  \"name\": \"Monthly check\",\n  \"schedule\": {\n    \"day_month\": 4,\n    \"frequency\": \"monthly\",\n    \"start_hour\": \"03:00\",\n    \"timezone\": \"UTC\"\n  }\n}"

response = http.request(request)
puts response.read_body
```

```java Create a Broken Links Checker global configuration
import com.mashape.unirest.http.HttpResponse;
import com.mashape.unirest.http.Unirest;

HttpResponse<String> response = Unirest.post("https://api.modulards.com/api/public/v1/preset-broken-links")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"check_external\": false,\n  \"default\": true,\n  \"name\": \"Monthly check\",\n  \"schedule\": {\n    \"day_month\": 4,\n    \"frequency\": \"monthly\",\n    \"start_hour\": \"03:00\",\n    \"timezone\": \"UTC\"\n  }\n}")
  .asString();
```

```php Create a Broken Links Checker global configuration
<?php
require_once('vendor/autoload.php');

$client = new \GuzzleHttp\Client();

$response = $client->request('POST', 'https://api.modulards.com/api/public/v1/preset-broken-links', [
  'body' => '{
  "check_external": false,
  "default": true,
  "name": "Monthly check",
  "schedule": {
    "day_month": 4,
    "frequency": "monthly",
    "start_hour": "03:00",
    "timezone": "UTC"
  }
}',
  'headers' => [
    'Authorization' => 'Bearer <token>',
    'Content-Type' => 'application/json',
  ],
]);

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

```csharp Create a Broken Links Checker global configuration
using RestSharp;

var client = new RestClient("https://api.modulards.com/api/public/v1/preset-broken-links");
var request = new RestRequest(Method.POST);
request.AddHeader("Authorization", "Bearer <token>");
request.AddHeader("Content-Type", "application/json");
request.AddParameter("application/json", "{\n  \"check_external\": false,\n  \"default\": true,\n  \"name\": \"Monthly check\",\n  \"schedule\": {\n    \"day_month\": 4,\n    \"frequency\": \"monthly\",\n    \"start_hour\": \"03:00\",\n    \"timezone\": \"UTC\"\n  }\n}", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);
```

```swift Create a Broken Links Checker global configuration
import Foundation

let headers = [
  "Authorization": "Bearer <token>",
  "Content-Type": "application/json"
]
let parameters = [
  "check_external": false,
  "default": true,
  "name": "Monthly check",
  "schedule": [
    "day_month": 4,
    "frequency": "monthly",
    "start_hour": "03:00",
    "timezone": "UTC"
  ]
] as [String : Any]

let postData = JSONSerialization.data(withJSONObject: parameters, options: [])

let request = NSMutableURLRequest(url: NSURL(string: "https://api.modulards.com/api/public/v1/preset-broken-links")! as URL,
                                        cachePolicy: .useProtocolCachePolicy,
                                    timeoutInterval: 10.0)
request.httpMethod = "POST"
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()
```