Ignore or restore broken link pages

PATCH

https://api.modulards.com/api/public/v1/site-broken-link-pages/bulk-ignore

PATCH

/api/public/v1/site-broken-link-pages/bulk-ignore

curl -X PATCH https://api.modulards.com/api/public/v1/site-broken-link-pages/bulk-ignore \
     -H "Authorization: Bearer <token>" \
     -H "Content-Type: application/json" \
     -d '{
  "ignored": true,
  "pages": [
    501,
    502
  ]
}'

{
  "jsonapi": {
    "version": "1.1"
  },
  "meta": {
    "skipped": [
      {
        "message": "This page no longer exists on the website; it was not touched.",
        "page_id": 502,
        "reason_code": "NOT_FOUND",
        "site_id": 12,
        "site_name": "Example site"
      }
    ],
    "status": "applied",
    "updated": [
      {
        "page_id": 501,
        "site_id": 12,
        "site_name": "Example site"
      }
    ]
  }
}

Mutes broken link pages you decided not to fix (ignored: true): their issues are detached and the page is no longer re-checked; or brings muted pages back (ignored: false). Ignoring a page detaches every issue still attached to it in the same call; restoring does not reattach them: the next scan that visits the page finds its issues again. The change is immediate: the answer lists the pages that changed and the ones left out, so there is nothing to follow up.

Only existence is validated. Pages that cannot be changed are reported in meta.skipped, each with a reason_code and a message, and do not fail the call: PERMISSION_DENIED (a page your token cannot reach, with a null site_name), NOT_FOUND (a page already resolved: gone from the website) and ALREADY_APPLIED (a page already in the requested state).

Body

pages (array of integers, required): ids of the pages to change, 1 to 50, no duplicates.
ignored (boolean, required): true ignores the pages, false restores them.

Errors

422: an id does not exist.

Authentication

AuthorizationBearer

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

Request

This endpoint expects an object.

ignoredbooleanOptional

pageslist of doublesOptional

Response

200 - One ignored, one skipped

jsonapiobjectOptional

metaobjectOptional

Errors

422

Unprocessable Entity Error