Newsletter
Business+Manage newsletter subscribers.
Required scopes:
newsletter
Endpoints
GET
/api/v1/newsletter
List all subscribers
POST
/api/v1/newsletter
Subscribe an email address
DELETE
/api/v1/newsletter/{id}
Unsubscribe by subscriber ID
DELETE
/api/v1/newsletter
Unsubscribe by email address
Query Parameters
| Parameter | Description |
|---|---|
search
|
Search term to filter results |
status
|
Filter by subscriber status (confirmed, pending, unsubscribed) |
from_date
|
Filter subscribers from this date (ISO 8601) |
to_date
|
Filter subscribers until this date (ISO 8601) |
sort
|
Sort field (email, name, created_at, confirmed_at) |
order
|
Sort direction (ASC or DESC, default: DESC) |
Request Schema
| Parameter | Type | Required | Description |
|---|---|---|---|
email
|
string | Yes | Email address to subscribe (required) |
name
|
string | No | Subscriber name |
send_confirmation
|
boolean | No | Whether to send the double opt-in confirmation email (default: true). The subscriber stays pending until the link in the email is confirmed. Use false only for imports of addresses whose consent was already obtained elsewhere; false never reactivates an address that has unsubscribed (409) |
language
|
string | No | Language of the confirmation email and link, e.g. de or en (default: tenant default language) |
consent_ip
|
string | No | IP address of the subscriber when your system forwards a sign-up (stored as consent evidence; default: the API client IP) |
consent_user_agent
|
string | No | Browser user agent of the subscriber when your system forwards a sign-up (default: the API client user agent) |
Response Schema
| Field | Type |
|---|---|
id
|
integer |
email
|
string |
name
|
string|null |
contact_id
|
integer|null |
status
|
string |
confirmed_at
|
string|null |
unsubscribed_at
|
string|null |
created_at
|
string |
Code Examples
curl -X GET "https://your-tenant.plandocket.com/api/v1/newsletter" \
-H "Authorization: Bearer YOUR_API_KEY" \
-H "Accept: application/json"<?php
$apiKey = 'YOUR_API_KEY';
$baseUrl = 'https://your-tenant.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://your-tenant.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://your-tenant.plandocket.com'
headers = {
'Authorization': f'Bearer {api_key}',
}
response = requests.get(f'{base_url}/api/v1/newsletter', headers=headers)
data = response.json()
print(data)Sample Response
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
}
}