Subscribers

Manage your subscribers programmatically

GET
/api/v1/subscribers

List all subscribers with optional filtering

Query Parameters

  • page - Page number (default: 1)
  • limit - Results per page (max: 100, default: 50)
  • status - Filter by status (subscribed, pending, unsubscribed, bounced)
  • groupId - Filter by group ID
  • email - Search by email
GET
/api/v1/subscribers/:id

Get a specific subscriber by ID

POST
/api/v1/subscribers

Create a new subscriber

Example Request

{
  "email": "[email protected]",
  "name": "John Doe",
  "metadata": { "source": "website" },
  "groupIds": ["group-uuid"],
  "bypassDoubleOptIn": true
}
POST
/api/v1/subscribers/bulk

Create multiple subscribers at once (max 1000)

Example Request

{
  "subscribers": [
    { "email": "[email protected]", "name": "User 1" },
    { "email": "[email protected]", "name": "User 2" }
  ],
  "groupIds": ["group-uuid"],
  "bypassDoubleOptIn": true
}
PATCH
/api/v1/subscribers/:id

Update a subscriber

Example Request

{
  "name": "John Updated",
  "metadata": { "source": "api", "plan": "pro" }
}
DELETE
/api/v1/subscribers/:id

Delete a subscriber

⚠️ Note: This is a soft delete - the subscriber is marked as unsubscribed but the record is retained.