Deutsch English

Prüfen, ob eine Adresse abonniert ist

POST /api/v1/subscribers/check

Prüft, ob eine E-Mail-Adresse auf dieser Statusseite als Abonnent eingetragen ist. Die Adresse wird im Request-Body übermittelt; die Antwort enthält den Status des Abonnements und die abonnierten Komponenten. Die Adresse erscheint darin nur maskiert.

Erforderliche Berechtigung

subscribers.manage Abonnenten verwalten

Body Parameter (application/json)

Name Format Beschreibung Optional
email String Die zu prüfende E-Mail-Adresse. —

Beispiel-Request (application/json) 

{
  "email": "…"
}

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

Response (application/json) 

{1 Eigenschaft
  "data": {2 Eigenschaften
    "subscribed": true,
    "subscriber": {9 Eigenschaften
      "id": 87,
      "email_masked": "an***@example.com",
      "locale": "de",
      "channel": "email",
      "confirmed": true,
      "confirmed_at": "2026-06-02T09:31:00Z",
      "subscribe_all_components": false,
      "component_ids": [2 Elemente
        3,
        4
      ],
      "created_at": "2026-06-02T09:28:00Z"
    }
  }
}
{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 email field must be a valid email address.",
  "errors": {1 Eigenschaft
    "email": [1 Element
      "The email field must be a valid email address."
    ]
  },
  "documentation_url": "https://docs.firestatus.de"
}

cURL

curl -X POST 'https://status.example.com/api/v1/subscribers/check' \
  -H 'Authorization: Bearer fs_YOUR_API_KEY' \
  -H 'Content-Type: application/json' \
  -d '{"email":"…"}'