Assign websites to a Broken Links configuration | Modular DS

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
  ]
}'

{
  "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 an explicit selection of websites to one Broken Links Checker global configuration. Answers 200 with meta.status (applied when at least one website changed, skipped when none did), meta.updated and meta.skipped; the change is immediate, there is nothing to poll.

Body (JSON):

sites (array of website ids, required, 1 to 200).

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 Broken Links service” instead.
Websites left out of the selection are never unassigned: a website leaves a configuration by moving to another one.
A website that already uses this configuration is answered in meta.skipped with reason_code ALREADY_APPLIED. A website the token cannot reach is answered in meta.skipped with reason_code PERMISSION_DENIED and a null site_name.

meta.updated entries carry site_id, site_name and site_preset_broken_link_id, the id “Show Broken Links service” and “Update Broken Links service” take.

Requires a full-access token (read-only tokens answer 403). An id that is not a website answers 422.

Assigns an explicit selection of websites to one Broken Links Checker global configuration. Answers **200** with `meta.status` (`applied` when at least one website changed, `skipped` when none did), `meta.updated` and `meta.skipped`; the change is immediate, there is nothing to poll. **Body** (JSON): - `sites` (array of website ids, required, 1 to 200). 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 Broken Links service" instead. - Websites left out of the selection are never unassigned: a website leaves a configuration by moving to another one. - A website that already uses this configuration is answered in `meta.skipped` with `reason_code` `ALREADY_APPLIED`. A website the token cannot reach is answered in `meta.skipped` with `reason_code` `PERMISSION_DENIED` and a null `site_name`. `meta.updated` entries carry `site_id`, `site_name` and `site_preset_broken_link_id`, the id "Show Broken Links service" and "Update Broken Links service" take. Requires a full-access token (read-only tokens answer 403). An id that is not a website answers 422.

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

Body (JSON):

sites (array of website ids, required, 1 to 200).

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 Broken Links service” instead.
Websites left out of the selection are never unassigned: a website leaves a configuration by moving to another one.
A website that already uses this configuration is answered in meta.skipped with reason_code ALREADY_APPLIED. A website the token cannot reach is answered in meta.skipped with reason_code PERMISSION_DENIED and a null site_name.

meta.updated entries carry site_id, site_name and site_preset_broken_link_id, the id “Show Broken Links service” and “Update Broken Links service” take.

Requires a full-access token (read-only tokens answer 403). An id that is not a website answers 422.