Update a website's Broken Links Checker settings

PATCH

https://api.modulards.com/api/public/v1/broken-link-services/:site_preset_broken_link

PATCH

/api/public/v1/broken-link-services/:site_preset_broken_link

curl -X PATCH https://api.modulards.com/api/public/v1/broken-link-services/site_preset_broken_link \
     -H "Authorization: Bearer <token>" \
     -H "Content-Type: application/json" \
     -d '{
  "excluded": {
    "url_patterns": [
      "/author/",
      "/feed/"
    ]
  },
  "max_pages": 800,
  "status": "enabled"
}'

{
  "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"
  }
}

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

Authentication

AuthorizationBearer

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

Path parameters

site_preset_broken_linkstringRequired

Query parameters

includestringOptional

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.

Request

This endpoint expects an object.

excludedobjectOptional

max_pagesdoubleOptional

statusstringOptional

Response

200 - Broken Links service updated

dataobjectOptional

includedlist of objectsOptional

jsonapiobjectOptional

Errors

422

Unprocessable Entity Error