Yleisten tiedotteiden API-referenssi

Yleiset tiedotteet ovat statussivullasi näkyviä pysyviä banneriviestejä (erillään häiriöistä ja huolloista). Näiden päätepisteiden avulla voit hallita niitä ohjelmallisesti.

Hae kaikki yleiset tiedotteet

Päätepiste:

GET /v1/:page_id/generic-notices?page=:page&per_page=:per_page

• Oletussivunumero on 1.
• Oletusarvo per_page on 50 ja enimmäismäärä on 100 kohdetta sivua kohden.

Esimerkkivastaus:

[
  {
    "id": "cl9mq0ah50646mpvlmbrvf979",
    "name": "Scheduled DNS migration",
    "message": "We are migrating our DNS provider over the next week.",
    "messageHtml": "<p>We are migrating our DNS provider over the next week.</p>",
    "notify": false,
    "isCollapsed": false,
    "createdAt": "2022-10-24T11:53:46.505Z",
    "updatedAt": "2022-10-24T11:53:46.505Z",
    "siteId": "cl9fzgilx14063qjvl5oqdtxtg",
    "importedFrom": null
  }
]

Hae yleinen tiedote

Päätepiste:

GET /v1/:page_id/generic-notices/:generic_notice_id

Esimerkkivastaus:

{
  "id": "cl9mq0ah50646mpvlmbrvf979",
  "name": "Scheduled DNS migration",
  "message": "We are migrating our DNS provider over the next week.",
  "messageHtml": "<p>We are migrating our DNS provider over the next week.</p>",
  "notify": false,
  "isCollapsed": false,
  "createdAt": "2022-10-24T11:53:46.505Z",
  "updatedAt": "2022-10-24T11:53:46.505Z",
  "siteId": "cl9fzgilx14063qjvl5oqdtxtg",
  "importedFrom": null
}

Lisää yleinen tiedote

Päätepiste:

POST /v1/:page_id/generic-notices

Sisällön parametrit:

• name (pakollinen) — tiedotteen otsikko.
• message — tiedotteen sisältö. HTML on tuettu.
• notify — ilmoitetaanko tilaajille. Oletusarvo on false.
• isCollapsed — onko tiedote oletuksena tiivistettynä. Oletusarvo on false.
• translations — valinnaiset käännökset kentille name ja message, avaimena kielikoodi.

Esimerkkipyyntö:

{
  "name": "Scheduled DNS migration",
  "message": "We are migrating our DNS provider over the next week.",
  "notify": false,
  "isCollapsed": false,
  "translations": {
    "name": {
      "fr": "Migration DNS planifiée"
    },
    "message": {
      "fr": "Nous migrons notre fournisseur DNS au cours de la semaine prochaine."
    }
  }
}

Esimerkkivastaus:

{
  "id": "cl9xobpoe00614tvldhh90t0w",
  "name": "Scheduled DNS migration",
  "message": "We are migrating our DNS provider over the next week.",
  "messageHtml": "<p>We are migrating our DNS provider over the next week.</p>",
  "notify": false,
  "isCollapsed": false,
  "createdAt": "2022-11-01T03:52:08.126Z",
  "updatedAt": "2022-11-01T03:52:08.126Z",
  "siteId": "cl9fzgilx14063qjvl5oqdtxtg",
  "importedFrom": null,
  "translations": {
    "name": {
      "fr": "Migration DNS planifiée"
    },
    "message": {
      "fr": "Nous migrons notre fournisseur DNS au cours de la semaine prochaine."
    }
  }
}

Päivitä yleinen tiedote

Päätepiste:

PUT /v1/:page_id/generic-notices/:generic_notice_id

Vain lähettämäsi kentät päivitetään.

Esimerkkipyyntö:

{
  "name": "Scheduled DNS migration (rescheduled)",
  "message": "The migration has been rescheduled to next month.",
  "isCollapsed": true
}

Esimerkkivastaus:

{
  "id": "cl9xobpoe00614tvldhh90t0w",
  "name": "Scheduled DNS migration (rescheduled)",
  "message": "The migration has been rescheduled to next month.",
  "messageHtml": "<p>The migration has been rescheduled to next month.</p>",
  "notify": false,
  "isCollapsed": true,
  "createdAt": "2022-11-01T03:52:08.126Z",
  "updatedAt": "2022-11-02T09:14:22.501Z",
  "siteId": "cl9fzgilx14063qjvl5oqdtxtg",
  "importedFrom": null
}

Poista yleinen tiedote

Päätepiste:

DELETE /v1/:page_id/generic-notices/:generic_notice_id

Esimerkkivastaus:

{
  "id": "cl9xobpoe00614tvldhh90t0w",
  "name": "Scheduled DNS migration (rescheduled)",
  "message": "The migration has been rescheduled to next month.",
  "messageHtml": "<p>The migration has been rescheduled to next month.</p>",
  "notify": false,
  "isCollapsed": true,
  "createdAt": "2022-11-01T03:52:08.126Z",
  "updatedAt": "2022-11-02T09:14:22.501Z",
  "siteId": "cl9fzgilx14063qjvl5oqdtxtg",
  "importedFrom": null
}