Ignore or restore broken link issues

PATCH

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

PATCH

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

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

{
  "jsonapi": {
    "version": "1.1"
  },
  "meta": {
    "skipped": [
      {
        "issue_id": 702,
        "message": "This finding is already ignored.",
        "reason_code": "ALREADY_APPLIED",
        "site_id": 12,
        "site_name": "Example site"
      }
    ],
    "status": "applied",
    "updated": [
      {
        "issue_id": 701,
        "site_id": 12,
        "site_name": "Example site"
      }
    ]
  }
}

Mutes broken link issues you decided not to fix (ignored: true), so they no longer count as open issues, or brings muted ones back (ignored: false). The change is immediate: the answer lists the issues that changed and the ones left out, so there is nothing to follow up.

Only existence is validated. Issues 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 (an issue your token cannot reach, with a null site_name), NOT_FOUND (an issue already resolved: the crawler no longer finds it) and ALREADY_APPLIED (an issue already in the requested state).

Body

issues (array of integers, required): ids of the issues to change, 1 to 50, no duplicates.
ignored (boolean, required): true ignores the issues, 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

issueslist of doublesOptional

Response

200 - One ignored, one skipped

jsonapiobjectOptional

metaobjectOptional

Errors

422

Unprocessable Entity Error