Update Broken Links service | Modular DS

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.

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.

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

Request

This endpoint expects an object.

excludedobjectOptional

max_pagesdoubleOptional

statusstringOptional

Response

200 - Broken Links service updated

Errors

422

Unprocessable Entity Error