Deutsch English

Abonnent hinzufügen

POST /api/v1/subscribers

Legt einen bestätigten Abonnenten ohne Double-Opt-in an, etwa beim Umzug einer bestehenden Liste. Erfordert acknowledge_consent: true als Bestätigung, dass die Einwilligung der Person vorliegt. Für ein Abonnement mit Double-Opt-in das öffentliche Formular der Statusseite nutzen.

Erforderliche Berechtigung

subscribers.manage Abonnenten verwalten

Body Parameter (application/json)

Name Format Beschreibung Optional
email String —
locale String
subscribe_all_components Boolean
component_ids Begrenzt das Abonnement. Die Komponenten müssen abonnierbar sein.
acknowledge_consent Boolean Muss true sein. Bestätigt, dass die Einwilligung dieser Person vorliegt; der Eintrag wird ohne Double-Opt-in als bestätigt angelegt. —

Beispiel-Request (application/json) 

{
  "email": "[email protected]",
  "locale": "text",
  "subscribe_all_components": true,
  "component_ids": [
    3,
    4
  ],
  "acknowledge_consent": true
}

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

Response (application/json) 

{1 Eigenschaft
  "data": {9 Eigenschaften
    "id": 88,
    "email_masked": "an***@example.com",
    "locale": "de",
    "channel": "email",
    "confirmed": true,
    "confirmed_at": "2026-07-27T14:00:00Z",
    "subscribe_all_components": false,
    "component_ids": [2 Elemente
      3,
      4
    ],
    "created_at": "2026-07-27T14:00:00Z"
  }
}
{2 Eigenschaften
  "message": "This address is already subscribed.",
  "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": "Set acknowledge_consent to true to confirm you have this person's consent. This endpoint creates a confirmed subscriber without double opt-in.",
  "errors": {1 Eigenschaft
    "acknowledge_consent": [1 Element
      "Set acknowledge_consent to true to confirm you have this person's consent. This endpoint creates a confirmed subscriber without double opt-in."
    ]
  },
  "documentation_url": "https://docs.firestatus.de"
}

cURL

curl -X POST 'https://status.example.com/api/v1/subscribers' \
  -H 'Authorization: Bearer fs_YOUR_API_KEY' \
  -H 'Content-Type: application/json' \
  -d '{"email":"[email protected]","locale":"text","subscribe_all_components":true,"component_ids":[3,4],"acknowledge_consent":true}'