Assign websites to a Broken Links Checker global configuration

POST

https://api.modulards.com/api/public/v1/preset-broken-links/:preset_broken_link/sites/sync

POST

/api/public/v1/preset-broken-links/:preset_broken_link/sites/sync

curl -X POST https://api.modulards.com/api/public/v1/preset-broken-links/preset_broken_link/sites/sync \
     -H "Authorization: Bearer <token>" \
     -H "Content-Type: application/json" \
     -d '{
  "sites": [
    12,
    34
  ]
}'

200Assign websites to a Broken Links Checker global configuration

{
  "jsonapi": {
    "version": "1.1"
  },
  "meta": {
    "skipped": [
      {
        "message": "This website already uses this Broken Links Checker global configuration.",
        "reason_code": "ALREADY_APPLIED",
        "site_id": 12,
        "site_name": "Already there",
        "site_preset_broken_link_id": 880
      }
    ],
    "status": "applied",
    "updated": [
      {
        "site_id": 34,
        "site_name": "New shop",
        "site_preset_broken_link_id": 901
      }
    ]
  }
}

Assigns the websites you list in sites to one Broken Links Checker global configuration. The change is immediate: the answer lists the websites that changed and the ones left out, so there is nothing to follow up.

What happens to each website:

A website with no configuration gets this one. A website that used another one moves to this one and takes its schedule.
Every assigned website is left with automatic scans enabled and its next scan scheduled, even if it was paused. To change the configuration of one website and keep it paused, use “Update a website’s Broken Links Checker settings” instead.
Websites you do not list are never unassigned: a website leaves a configuration by moving to another one.
A website that already uses this configuration (ALREADY_APPLIED), or that your token cannot reach (PERMISSION_DENIED, with a null site_name), is reported in meta.skipped with a reason_code and a message instead of failing the call.

Each website in meta.updated carries site_preset_broken_link_id, the id that “Retrieve a website’s Broken Links Checker settings” and “Update a website’s Broken Links Checker settings” take.

Body

sites (array of integers, required): ids of the websites to act on, 1 to 50.

Errors

422: an id that is not a website.

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.

siteslist of doublesOptional

Response

200 - Websites assigned, one skipped

jsonapiobjectOptional

metaobjectOptional