Developer Reference

API Reference

Complete REST API documentation for developers. Manage your audiences, subscribers, and automated triggers programmatically using secure JSON protocols.

Technical Index

Authentication

Identity Verification

Bearer Token Flow

Include your API Key in the Authorization header. For security, keys are stored as non-reversible SHA-256 hashes; the raw key is only shown once during creation.

Authorization: Bearer YOUR_API_KEY

Audience Management

Logic Segmentation

GET/api/v1/lists

Fetch all audiences owned by your brand.

POST/api/v1/lists

Create a new audience list.

Payload Schema

{
  "name": "string",
  "description": "string (optional)"
}

GET/api/v1/lists/{listId}

Retrieve detailed configuration for a specific list.

Subscriber Management

Entity Control

POST/api/v1/subscribers

Create or update a subscriber record. Matching is performed on Email + ListId.

Payload Schema

{
  "email": "string",
  "listId": "uuid",
  "name": "string (optional)",
  "customFields": "object (optional)",
  "status": "active | unsubscribed | bounced"
}

GET/api/v1/subscribers/{id_or_email}

Fetch a single subscriber record by their unique ID or email address.

GET/api/v1/subscribers/{listId}

Fetch all subscribers within a specific list with pagination.

Query Attributes

pageinteger

limitinteger

DELETE/api/v1/subscribers/{id_or_email}

Permanently delete a subscriber record.

Tag Management

Behavioral Labeling

GET/api/v1/subscribers/{id_or_email}/tags

Get all tags currently applied to a specific subscriber.

POST/api/v1/subscribers/{id_or_email}/tags

Add one or more tags to a subscriber. Existing tags are preserved.

Payload Schema

{
  "tags": [
    "string"
  ]
}

DELETE/api/v1/subscribers/{id_or_email}/tags?name={tagName}

Remove a specific tag from a subscriber.

PATCH/api/v1/subscribers/{id_or_email}/tags?name={oldName}

Rename an existing tag for a specific subscriber.

Payload Schema

{
  "newName": "string"
}

GET/api/v1/tags

Fetch all unique tags used across your entire brand population.

Error Response Protocol

Validation Handshake

{
  "success": false,
  "error": "Validation Error",
  "details": {
    "email": { "_errors": ["Invalid email address"] }
  }
}

400

Bad Request

401

Unauthorized

404

Not Found

500

Server Error

Own your audience.

Stop paying every month for your own subscriber list. Join smart marketers who own their system and save thousands every year.