Deutsch English

Abonnent aktualisieren

PUT /api/v1/subscribers/{subscriber}

Aktualisiert die Benachrichtigungssprache und die abonnierten Komponenten eines Abonnenten. Nicht übermittelte Felder bleiben unverändert. Die E-Mail-Adresse kann nicht geändert werden; dafür ist ein neues Abonnement erforderlich.

Erforderliche Berechtigung

subscribers.manage Abonnenten verwalten

URL Variablen

Name Beschreibung
subscriber

Body Parameter (application/json)

Name Format Beschreibung Optional
locale String Benachrichtigungssprache. Muss eine der Sprachen der Statusseite sein.
subscribe_all_components Boolean true abonniert alle Komponenten; false begrenzt das Abonnement auf die Komponenten aus component_ids.
component_ids String JSON-Array von Komponenten-IDs. Ersetzt die bisherige Auswahl; eine Liste ohne subscribe_all_components begrenzt das Abonnement auf diese Komponenten. Die Komponenten müssen abonnierbar sein.

Beispiel-Request (application/json) 

{
  "locale": "…",
  "subscribe_all_components": true,
  "component_ids": "…"
}

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

Response (application/json) 

{1 Eigenschaft
  "data": {9 Eigenschaften
    "id": 87,
    "email_masked": "an***@example.com",
    "locale": "en",
    "channel": "email",
    "confirmed": true,
    "confirmed_at": "2026-06-02T09:31:00Z",
    "subscribe_all_components": false,
    "component_ids": [1 Element
      3
    ],
    "created_at": "2026-06-02T09:28:00Z"
  }
}
{2 Eigenschaften
  "message": "Subscriber 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"
}
{3 Eigenschaften
  "message": "The selected locale is invalid.",
  "errors": {1 Eigenschaft
    "locale": [1 Element
      "The selected locale is invalid."
    ]
  },
  "documentation_url": "https://docs.firestatus.de"
}

cURL

curl -X PUT 'https://status.example.com/api/v1/subscribers/{subscriber}' \
  -H 'Authorization: Bearer fs_YOUR_API_KEY' \
  -H 'Content-Type: application/json' \
  -d '{"locale":"…","subscribe_all_components":true,"component_ids":"…"}'