Deutsch English

Ankündigung aktualisieren

PATCH /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 string Locale-Objekt, z. B. {"de": "Störung", "en": "Outage"}. Bei PATCH partiell; ein explizites null löscht die Übersetzung. —
body string Locale-Objekt wie bei title. Markdown erlaubt.
level
dismissible boolean
starts_at string Ohne Angabe unbegrenzt.
ends_at string Exklusiv. Ohne Angabe unbegrenzt.

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"
  }
}
{1 Eigenschaft
  "message": "Announcement not found."
}

cURL

curl -X PATCH 'https://status.example.com/api/v1/announcements/:announcement' \
  -H 'Authorization: Bearer fs_YOUR_API_KEY' \
  -H 'Content-Type: application/json' \
  -d '{"title":"VALUE","body":"VALUE","level":"VALUE","dismissible":"VALUE","starts_at":"VALUE","ends_at":"VALUE"}'