API reference

Campaigns

List campaigns and start sending a draft.

List your campaigns and trigger sending.

List campaigns

GET/v1/campaignsfull access

Returns your campaigns with their status and engagement summary (sent, delivered, opened, clicked, complained, unsubscribed).

bash
curl https://mailer123.com/api/v1/campaigns \
-H "Authorization: Bearer m123_your_api_key"

Start sending a campaign

POST/v1/campaigns/{id}/sendfull access

Starts a draft or scheduled campaign sending now. It flips to sending and its recipients are queued in the background, so this returns 202 immediately. The campaign must already have a subject, sender, body, and recipients, and its sender domain must still be verified.

bash
curl -X POST https://mailer123.com/api/v1/campaigns/CAMPAIGN_ID/send \
-H "Authorization: Bearer m123_your_api_key"
json
HTTP/1.1 202 Accepted

{ "data": { "id": "CAMPAIGN_ID", "status": "sending" } }

Errors

not_found (404), validation_error (400 — incomplete campaign), forbidden (403 — stale or blocked sender, or auto-pause), conflict (409 — not in a sendable state). See the error reference.