Skip to Content
Alienmail Docs

Overview

Every endpoint of the Alienmail REST API, with a playground to try it.

The reference is generated from the same schemas the API validates requests with, so it always matches what the API accepts.

Base URL

https://app.alienmail.io/api/v1

Send your API key on every request as Authorization: Bearer <your API key>. See Authentication.

Try it

Each endpoint page has a playground. Enter your API key in Authorization, fill in the parameters and body, and press Send to call the live API and see the response. Requests go through this site to the API, and your key is not stored.

Requests from the playground are real. Starting a campaign sends email, and adding, updating and removing leads change your data.

Endpoints

MethodPathPermission
GET/campaignsCAMPAIGN_READ
POST/campaigns/{id}/startCAMPAIGN_START
POST/campaigns/{id}/pauseCAMPAIGN_STATUS_UPDATE
GET/campaigns/{id}/leadsCAMPAIGN_READ
POST/campaigns/{id}/leadsLEAD_CAMPAIGN_ENROLL
PATCH/campaigns/{id}/leads/{email}LEAD_CAMPAIGN_ENROLL
DELETE/campaigns/{id}/leads/{email}LEAD_CAMPAIGN_ENROLL
DELETE/campaigns/{id}/leadsLEAD_CAMPAIGN_ENROLL
GET/mailboxesSMTP_READ
PATCH/mailboxes/{id}SMTP_UPDATE

Download the spec

/openapi.json is the OpenAPI 3.1 spec. Import it into Postman or Insomnia, or generate a typed client with a tool like openapi-typescript.

On this page