Deutsch English

Ankündigung aktualisieren

PUT /api/v1/announcements/{announcement}

Partiell. Ein ends_at in der Vergangenheit beendet ein laufendes Banner sofort.

Erforderliche Berechtigung

announcements.manage Ankündigungen verwalten

URL Variablen

Name Beschreibung
announcement ULID.

Body Parameter (application/json)

Name Format Beschreibung Optional
title Mehrsprachiger Text als Objekt je Sprache, z. B. {"de": "…", "en": "…"}. Ein einfacher String wird in der Hauptsprache der Statusseite gespeichert. Bei PATCH partiell: eine weggelassene Sprache bleibt unverändert, ein ausdrückliches null löscht sie. —
body Mehrsprachiger Text als Objekt je Sprache, z. B. {"de": "…", "en": "…"}. Ein einfacher String wird in der Hauptsprache der Statusseite gespeichert. Bei PATCH partiell: eine weggelassene Sprache bleibt unverändert, ein ausdrückliches null löscht sie.
level
dismissible Boolean
starts_at String Ohne Angabe unbefristet.
ends_at String Exklusiv. Ohne Angabe unbefristet.

Beispiel-Request (application/json) 

{
  "title": {
    "de": "Störung im Netz",
    "en": "Network issue"
  },
  "body": {
    "de": "Wir untersuchen erhöhte Latenzen.",
    "en": "We are investigating elevated latencies."
  },
  "level": "info",
  "dismissible": true,
  "starts_at": "…",
  "ends_at": "2026-08-03T00:00:00Z"
}

Werte sind Beispiele — Pflichtfelder stehen in der Tabelle. Der Body wird als JSON gesendet.

Response (application/json) 

{1 Eigenschaft
  "data": {10 Eigenschaften
    "id": "01kyhjx7hxggqfaekf2b5sy61x",
    "title": {2 Eigenschaften
      "de": "Wartungsfenster am Sonntag",
      "en": "Maintenance window on Sunday"
    },
    "body": {2 Eigenschaften
      "de": "Zwischen 02:00 und 04:00 Uhr kann es zu kurzen Unterbrechungen kommen.",
      "en": null
    },
    "level": "warning",
    "dismissible": true,
    "starts_at": "2026-07-24T00:00:00Z",
    "ends_at": "2026-07-28T00:00:00Z",
    "is_active": true,
    "created_at": "2026-07-23T10:00:00Z",
    "updated_at": "2026-07-23T10:00:00Z"
  }
}
{2 Eigenschaften
  "message": "Announcement not found.",
  "documentation_url": "https://docs.firestatus.de"
}
{2 Eigenschaften
  "message": "This API accepts JSON only. Send the request body as application/json (received application/x-www-form-urlencoded).",
  "documentation_url": "https://docs.firestatus.de"
}

cURL

curl -X PUT 'https://status.example.com/api/v1/announcements/{announcement}' \
  -H 'Authorization: Bearer fs_YOUR_API_KEY' \
  -H 'Content-Type: application/json' \
  -d '{"title":{"de":"Störung im Netz","en":"Network issue"},"body":{"de":"Wir untersuchen erhöhte Latenzen.","en":"We are investigating elevated latencies."},"level":"info","dismissible":true,"starts_at":"…","ends_at":"2026-08-03T00:00:00Z"}'