⌘ K

Genel Duyurular API Referansı

Genel duyurular, durum sayfanızda gösterilen kalıcı bantlardır (olaylardan ve bakımlardan ayrıdır). Bunları programatik olarak yönetmek için bu uç noktaları kullanın.

Tüm genel duyuruları getirin

Uç nokta:

GET /v1/:page_id/generic-notices?page=:page&per_page=:per_page
  • Varsayılan sayfa numarası 1'dir.
  • Varsayılan per_page değeri 50'dir; sayfa başına en fazla 100 öğedir.

Örnek yanıt:

[
  {
    "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
  }
]

Bir genel duyuruyu getirin

Uç nokta:

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

Örnek yanıt:

{
  "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
}

Genel duyuru ekleyin

Uç nokta:

POST /v1/:page_id/generic-notices

Gövde parametreleri:

  • name (zorunlu) — duyurunun başlığı.
  • message — duyurunun gövdesi. HTML desteklenir.
  • notify — abonelere bildirim gönderilip gönderilmeyeceği. Varsayılan değer false.
  • isCollapsed — duyurunun varsayılan olarak daraltılıp daraltılmayacağı. Varsayılan değer false.
  • translations — name ve message için dil koduna göre anahtarlanmış isteğe bağlı çeviriler.

Örnek istek:

{
  "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."
    }
  }
}

Örnek yanıt:

{
  "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."
    }
  }
}

Genel duyuruyu güncelleyin

Uç nokta:

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

Yalnızca gönderdiğiniz alanlar güncellenir.

Örnek istek:

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

Örnek yanıt:

{
  "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
}

Genel duyuruyu silin

Uç nokta:

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

Örnek yanıt:

{
  "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
}