Authentication#
AcelleMail uses Bearer token authentication. Generate a token at Settings → API Tokens → Create.
Include the token in every request header:
Authorization: Bearer your_token_here
Base URL#
https://yourdomain.com/api/v1/
Core Endpoints#
| Method |
Endpoint |
Description |
| GET |
/lists |
List all mailing lists |
| POST |
/subscribers |
Add a subscriber |
| GET |
/subscribers/{uid} |
Get subscriber details |
| DELETE |
/subscribers/{uid} |
Delete a subscriber |
| GET |
/campaigns |
List campaigns |
| POST |
/campaigns/{uid}/send |
Send a campaign |
Curl Examples#
Add a subscriber:
curl -X POST https://mail.yourdomain.com/api/v1/subscribers \
-H "Authorization: Bearer TOKEN" \
-H "Content-Type: application/json" \
-d '{"email":"user@example.com","first_name":"Jane","list_uid":"LIST_UID"}'
Get all lists:
curl https://mail.yourdomain.com/api/v1/lists \
-H "Authorization: Bearer TOKEN"
Unsubscribe by email:
curl -X PATCH https://mail.yourdomain.com/api/v1/subscribers/unsubscribe \
-H "Authorization: Bearer TOKEN" \
-d '{"email":"user@example.com","list_uid":"LIST_UID"}'
Response Format#
All responses return JSON with a status field (success or error) and a data object. Errors include a message field describing the issue. HTTP status codes follow REST conventions (200, 201, 400, 401, 404, 422).
