PlaneMail API Documentation

Integrate PlaneMail programmatically using our API.

Authentication

All API requests must be authenticated using an API key. Pass your API key as a Bearer token in the Authorization header.

Authorization: Bearer YOUR_API_KEY

You can generate and manage your API keys from the Integrations page (requires login) . Keep your API keys secure and do not share them publicly.

API Endpoints

Subscribers API

POST/api/v1/subscribers

Adds a new subscriber to your list.

Headers

HeaderDescription
AuthorizationBearer token containing your API key. Example: Bearer YOUR_API_KEY
Content-Typeapplication/json

Request Body (JSON)

{
  "email": "subscriber@example.com",  // Required, must be a valid email
  "name": "John Doe",                 // Optional, string
  "status": "active",                 // Optional, 'active' | 'unsubscribed' | 'pending' | 'bounced'
                                      // Defaults to 'active' if not provided
  "segmentNames": ["Segment Name 1"]  // Optional, array of existing segment names
}

If segmentNames are provided, the subscriber will be added to those existing segments. Segments that do not exist for your account will be ignored.

Responses