Newsletter - API Reference - PlanDocket Documentation

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 a confirmation email (default: true)

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 "Content-Type: 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,
        'Content-Type: application/json',
    ],
]);

$response = curl_exec($ch);
$data = json_decode($response, true);
curl_close($ch);

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}`,
    'Content-Type': 'application/json',
  },
});

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}',
    'Content-Type': 'application/json',
}

response = requests.get(f'{base_url}/api/v1/newsletter', headers=headers)
data = response.json()
print(data)

Sample Response

200 OK

{
  "data": {
    "newsletter_id": 1,
    "created_at": 1704067200,
    "updated_at": 1704067200
  },
  "meta": {
    "request_id": "req_abc123"
  }
}