Add websites to a notification configuration

POST

https://api.modulards.com/api/public/v1/alerts/:alert_id/sites/sync

POST

/api/public/v1/alerts/:alert_id/sites/sync

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

{
  "jsonapi": {
    "version": "1.1"
  },
  "meta": {
    "skipped": [
      {
        "alert_id": 12,
        "message": "This website already uses this notification configuration.",
        "reason_code": "ALREADY_APPLIED",
        "site_id": 12,
        "site_name": "Already there"
      }
    ],
    "status": "applied",
    "updated": [
      {
        "alert_id": 12,
        "site_id": 34,
        "site_name": "New shop"
      }
    ]
  }
}

Adds the websites you list in sites to a notification configuration. It only adds: websites already in the configuration stay, and none is ever removed. Use it to bring new websites under an existing configuration.

The answer arrives at once, with nothing to follow. meta.status is applied when at least one website was added and skipped when none was. Websites that cannot be processed are reported in meta.skipped, each with a reason_code and a message, and do not fail the call. A website is skipped as ALREADY_APPLIED when it is already in the configuration, and as PERMISSION_DENIED (with a null site_name) when your token cannot reach it.

Body

sites (array of integers, required): ids of the websites to add, 1 to 50. Each must be an existing website.

Errors

422: sites is missing, empty, has more than 50 ids or contains an id that is not a website. The body is checked before the configuration, so a configuration of another organization answers 404 only when the body is valid.

Authentication

AuthorizationBearer

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

Path parameters

alert_idstringRequired

Request

This endpoint expects an object.

siteslist of doublesOptional

Response

200 - Websites added, one skipped

jsonapiobjectOptional

metaobjectOptional

Errors

422

Unprocessable Entity Error