Update Broken Links configuration | Modular DS

curl -X PATCH https://api.modulards.com/api/public/v1/preset-broken-links/preset_broken_link \
     -H "Authorization: Bearer <token>" \
     -H "Content-Type: application/json" \
     -d '{
  "mode": "render"
}'

{
  "data": {
    "attributes": {
      "check_external": false,
      "check_internal": true,
      "check_mixed_content": true,
      "created_at": "2026-09-17T10:00:00.000000Z",
      "is_default": true,
      "mode": "render",
      "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-17T11:15: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"
  }
}

Edits one Broken Links Checker global configuration. Send only what changes; answers 200 with the configuration document. Accepts PUT as well as PATCH, with the same body; PATCH is the documented method.

Body (JSON), every field optional: name, schedule, check_internal, check_external, check_mixed_content, resource_types, mode, default - the same fields and values as “Create Broken Links configuration” (the response reads default back as is_default).

schedule is replaced whole: when it is sent it carries every field its frequency needs (frequency, start_hour, timezone and the day its frequency asks for); when it is left out the stored one stays.
A new schedule reaches every website that uses the configuration and reschedules their next scan.
default: true makes it the configuration new websites receive and takes the mark off the previous one; default: false clears it.
A sent field must carry a value: an explicit null or a blank string answers 422.

The page cap and exclusions are per website, never here: sending max_pages or excluded answers 422, and so does status - the configuration is always enabled.

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

Edits one Broken Links Checker global configuration. Send only what changes; answers **200** with the configuration document. Accepts PUT as well as PATCH, with the same body; PATCH is the documented method. **Body** (JSON), every field optional: `name`, `schedule`, `check_internal`, `check_external`, `check_mixed_content`, `resource_types`, `mode`, `default` - the same fields and values as "Create Broken Links configuration" (the response reads `default` back as `is_default`). - `schedule` is replaced whole: when it is sent it carries every field its frequency needs (`frequency`, `start_hour`, `timezone` and the day its frequency asks for); when it is left out the stored one stays. - A new schedule reaches every website that uses the configuration and reschedules their next scan. - `default: true` makes it the configuration new websites receive and takes the mark off the previous one; `default: false` clears it. - A sent field must carry a value: an explicit `null` or a blank string answers 422. The page cap and exclusions are per website, never here: sending `max_pages` or `excluded` answers 422, and so does `status` - the configuration is always enabled. Requires a full-access token (read-only tokens answer 403). A configuration of another organization answers 404.

Authentication

AuthorizationBearer

Personal access token created in the Modular DS dashboard; read-only tokens can only call GET endpoints.

Path parameters

preset_broken_linkstringRequired

Request

This endpoint expects an object.

modestringOptional

Response

200 - Broken Links configuration updated

dataobjectOptional

jsonapiobjectOptional

Errors

422

Unprocessable Entity Error

schedule is replaced whole: when it is sent it carries every field its frequency needs (frequency, start_hour, timezone and the day its frequency asks for); when it is left out the stored one stays.
A new schedule reaches every website that uses the configuration and reschedules their next scan.
default: true makes it the configuration new websites receive and takes the mark off the previous one; default: false clears it.
A sent field must carry a value: an explicit null or a blank string answers 422.

The page cap and exclusions are per website, never here: sending max_pages or excluded answers 422, and so does status - the configuration is always enabled.

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