Newsletter
Business+Verwalten Sie Newsletter-Abonnenten.
Erforderliche Bereiche:
newsletter
Zugriffsstufe:
GET
newsletter:read
POST / PUT / PATCH / DELETE
newsletter:write
Mehr zu Zugriffsstufen
Endpunkte
GET
/api/v1/newsletter
Alle Abonnenten auflisten
POST
/api/v1/newsletter
E-Mail-Adresse abonnieren
DELETE
/api/v1/newsletter/{id}
Nach Abonnenten-ID abmelden
DELETE
/api/v1/newsletter
Nach E-Mail-Adresse abmelden
Abfrageparameter
| Parameter | Beschreibung |
|---|---|
search
|
Suchbegriff zum Filtern der Ergebnisse |
status
|
Nach Abonnentenstatus filtern (confirmed, pending, unsubscribed) |
from_date
|
Abonnenten ab diesem Datum filtern (ISO 8601) |
to_date
|
Abonnenten bis zu diesem Datum filtern (ISO 8601) |
sort
|
Sortierfeld (email, name, created_at, confirmed_at) |
order
|
Sortierrichtung (ASC oder DESC, Standard: DESC) |
Request-Schema
| Parameter | Typ | Erforderlich | Beschreibung |
|---|---|---|---|
email
|
string | Ja | E-Mail-Adresse zum Abonnieren (erforderlich) |
name
|
string | Nein | Name des Abonnenten |
send_confirmation
|
boolean | Nein | Ob die Double-Opt-in-Bestätigungs-E-Mail gesendet werden soll (Standard: true). Der Abonnent bleibt ausstehend, bis der Link in der E-Mail bestätigt wurde. false nur für Importe von Adressen verwenden, deren Einwilligung bereits anderweitig eingeholt wurde; false reaktiviert niemals eine abgemeldete Adresse (409) |
language
|
string | Nein | Sprache der Bestätigungs-E-Mail und des Links, z. B. de oder en (Standard: Standardsprache des Mandanten) |
consent_ip
|
string | Nein | IP-Adresse des Abonnenten, wenn Ihr System eine Anmeldung weiterleitet (wird als Einwilligungsnachweis gespeichert; Standard: IP des API-Clients) |
consent_user_agent
|
string | Nein | Browser-User-Agent des Abonnenten, wenn Ihr System eine Anmeldung weiterleitet (Standard: User-Agent des API-Clients) |
Response-Schema
| Feld | Typ |
|---|---|
id
|
integer |
email
|
string |
name
|
string|null |
contact_id
|
integer|null |
status
|
string |
confirmed_at
|
string|null |
unsubscribed_at
|
string|null |
created_at
|
string |
Codebeispiele
curl -X GET "https://ihr-mandant.plandocket.com/api/v1/newsletter" \
-H "Authorization: Bearer YOUR_API_KEY" \
-H "Accept: application/json"<?php
$apiKey = 'YOUR_API_KEY';
$baseUrl = 'https://ihr-mandant.plandocket.com';
$ch = curl_init();
curl_setopt_array($ch, [
CURLOPT_URL => $baseUrl . '/api/v1/newsletter',
CURLOPT_RETURNTRANSFER => true,
CURLOPT_HTTPHEADER => [
'Authorization: Bearer ' . $apiKey,
],
]);
$response = curl_exec($ch);
curl_close($ch);
$data = json_decode($response, true);
print_r($data);const apiKey = 'YOUR_API_KEY';
const baseUrl = 'https://ihr-mandant.plandocket.com';
const response = await fetch(`${baseUrl}/api/v1/newsletter`, {
method: 'GET',
headers: {
'Authorization': `Bearer ${apiKey}`,
},
});
const data = await response.json();
console.log(data);import requests
api_key = 'YOUR_API_KEY'
base_url = 'https://ihr-mandant.plandocket.com'
headers = {
'Authorization': f'Bearer {api_key}',
}
response = requests.get(f'{base_url}/api/v1/newsletter', headers=headers)
data = response.json()
print(data)Beispiel-Antwort
200 OK
{
"data": [
{
"id": 1,
"email": "string",
"name": "string",
"contact_id": 1,
"status": "string",
"confirmed_at": "2026-01-15T10:00:00+01:00",
"unsubscribed_at": "2026-01-15T10:00:00+01:00",
"created_at": "2026-01-15T10:00:00+01:00"
}
],
"meta": {
"current_page": 1,
"per_page": 25,
"total": 1,
"total_pages": 1
}
}