Newsletter Subscribers

Newsletter Subscriber Endpoint

v2.8.0 · CRUD · Newsletter Subscribers

Manage newsletter subscribers with double opt-in (DOI), automatic provider synchronization, and GDPR-compliant 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

Method	Endpoint	Scope	Description
GET	`/Export/JSON/newsletter_subscribers`	`newsletter:read`	List all subscribers (with filters)
GET	`/Export/JSON/newsletter_subscriber/{id}`	`newsletter:read`	Retrieve a single subscriber
POST	`/Import/JSON/newsletter_subscribers`	`newsletter:write`	Create a new subscriber (DOI support)
PUT	`/Import/JSON/newsletter_subscribers`	`newsletter:write`	Update existing subscribers
DELETE	`/Delete/JSON/newsletter_subscriber/{id}`	`newsletter:delete`	Delete Subscriber (GDPR Cascade)

Query Filter (Export)

Parameters	Description	Example
`?status=confirmed`	Filter by confirmation status	`confirmed` or `unconfirmed`
`?email=test@example.com`	Filter by email address	Exact Match
`?customer_id=42`	Only subscribers of a specific customer	Customer ID as an integer
`?language_id=1`	Filter by language	Language ID
`?last_modified=2026-01-01`	Date Modified	YYYY-MM-DD format

Features

Double Opt-In

Respects the store configuration SHOP_NEWSLETTER_DOUBLE_OPT_IN. When DOI is enabled, a confirmation email is sent automatically.

Provider Sync

Automatic synchronization with external newsletter providers (CleverReach, Mailchimp, Optimizely) via xoNewsletter.

GDPR Compliance

Privacy logging during import and deletion. Cascade deletion documents all steps in compliance with data protection regulations.

Example: Create a subscriber

# POST - Create a new subscriber with a DOI
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
    }]
  }'

Note: If DOI is enabled, the subscriber is initially created as "unconfirmed" and receives a confirmation email. The subscribe_status_key field (security token) is not returned in the export.

Bulk Delete

# Delete multiple subscribers via JSON body
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"} 
    ]
  }'

Subscribers can be identified by their subscribe_id or subscribe_email. Each deletion is logged as a GDPR privacy event.

Manage newsletter subscribers via the xoPort REST API. Supports double opt-in, provider synchronization (Cleverreach, Mailchimp, Optimizely), and GDPR-compliant privacy logging. Available since version 2.8.0.

Newsletter Subscriber Endpoint