Newsletter-Abonnenten | xoPort REST API

Newsletter-Abonnenten-Endpunkt

v2.8.0 · CRUD · Newsletter-Abonnenten

Newsletter Subscribers

Newsletter-Abonnenten verwalten mit Double-Opt-In (DOI), automatischer Provider-Synchronisation und DSGVO-konformem Privacy-Logging.

GET    /Export/JSON/newsletter_subscribers
GET    /Export/JSON/newsletter_subscriber/{id}
POST   /Import/JSON/newsletter_subscribers
PUT    /Import/JSON/newsletter_subscribers
DELETE /Delete/JSON/newsletter_subscriber/{id}

Endpoints

Methode	Endpoint	Scope	Beschreibung
GET	`/Export/JSON/newsletter_subscribers`	`newsletter:read`	Alle Abonnenten auflisten (mit Filtern)
GET	`/Export/JSON/newsletter_subscriber/{id}`	`newsletter:read`	Einzelnen Abonnenten abrufen
POST	`/Import/JSON/newsletter_subscribers`	`newsletter:write`	Neuen Abonnenten anlegen (DOI-Support)
PUT	`/Import/JSON/newsletter_subscribers`	`newsletter:write`	Bestehenden Abonnenten aktualisieren
DELETE	`/Delete/JSON/newsletter_subscriber/{id}`	`newsletter:delete`	Abonnent löschen (DSGVO-Cascade)

Query-Filter (Export)

Parameter	Beschreibung	Beispiel
`?status=confirmed`	Nach Bestätigungsstatus filtern	`confirmed` oder `unconfirmed`
`?email=test@example.com`	Nach E-Mail-Adresse filtern	Exact Match
`?customer_id=42`	Nur Abonnenten eines Kunden	Kunden-ID als Integer
`?language_id=1`	Nach Sprache filtern	Language-ID
`?last_modified=2026-01-01`	Seit Datum geändert	YYYY-MM-DD Format

Features

Double-Opt-In

Respektiert die Shop-Konfiguration SHOP_NEWSLETTER_DOUBLE_OPT_IN. Bei aktiviertem DOI wird automatisch eine Bestätigungs-E-Mail versendet.

Provider-Sync

Automatische Synchronisation mit externen Newsletter-Providern (Cleverreach, Mailchimp, Optimizely) via xoNewsletter.

DSGVO-Compliance

Privacy-Logging bei Import und Delete. Cascade-Löschung dokumentiert alle Schritte datenschutzkonform.

Beispiel: Abonnent anlegen

# POST - Neuen Abonnenten mit DOI anlegen
curl -X POST "https://shop.de/xpanel/xoport/Import/JSON/newsletter_subscribers" \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "type": "newsletter_subscribers",
    "data": [{
      "subscribe_email": "kunde@example.com",
      "subscribe_firstname": "Max",
      "subscribe_lastname": "Mustermann",
      "subscribe_language_id": 1
    }]
  }'

Hinweis: Bei aktiviertem DOI wird der Abonnent zunächst als "unconfirmed" angelegt und erhält eine Bestätigungs-E-Mail. Das Feld subscribe_status_key (Sicherheitstoken) wird nicht im Export zurückgegeben.

Bulk-Delete

# Mehrere Abonnenten per JSON-Body löschen
curl -X DELETE "https://shop.de/xpanel/xoport/Delete/JSON/newsletter_subscribers" \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "type": "newsletter_subscribers",
    "data": [
      {"subscribe_id": 5},
      {"subscribe_email": "abmelden@example.com"}
    ]
  }'

Abonnenten können per subscribe_id oder subscribe_email identifiziert werden. Jede Löschung wird als DSGVO-Privacy-Event protokolliert.

Newsletter-Abonnenten über die xoPort REST API verwalten. Unterstützt Double-Opt-In, Provider-Synchronisation (Cleverreach, Mailchimp, Optimizely) und DSGVO-konformes Privacy-Logging. Verfügbar seit Version 2.8.0.