AcelleMail REST API
The AcelleMail API (version 1) is organized around REST. It has predictable resource-oriented URLs, accepts form-encoded or JSON request bodies, returns JSON-encoded responses, and uses standard HTTP response codes, authentication, and verbs.
The API is part of every AcelleMail installation: it answers on your own server, at https://your-domain/api/v1. To install AcelleMail, follow the installation guides for a VPS or a control-panel host such as cPanel or Plesk.
The API can differ between versions. This reference is generated from AcelleMail 4.2.0-p180; the API page of your installation shows its base URL and your API token.
Visit acellesend.com for the latest releases, and the knowledge base for guides.
Not a developer?
AcelleMail is made for users without programming experience. Follow the installation guides to set it up on a VPS (Virtual Private Server) or on a managed server with a control panel such as cPanel or Plesk, or try the live demo first.
Custom development & integration
AcelleMail is built for rebranding, customization and integration. The AcelleMail PHP SDK wraps the most common calls, and any programming language that speaks HTTP can use the REST API. The developer guide covers plugins and webhooks.
composer require acelle/sdk-php
sudo apt install curl
Guides
Customer API
Called with a customer's API token: that customer's lists, contacts, campaigns and automations.
Authentication
Get an API token, or a link that signs a user in.
Account
The user a token belongs to and their account.
Lists
Contact lists and their fields.
Subscribers
Contacts inside a list, one at a time or in bulk.
/api/v1/subscribers
List the contacts of a list
POST
/api/v1/subscribers
Add a contact to a list
GET
/api/v1/subscribers/{id}
Get a contact
PATCH
/api/v1/subscribers/{id}
Change a contact
DELETE
/api/v1/subscribers/{id}
Delete a contact
GET
/api/v1/subscribers/email/{email}
Find a contact in every list
POST
/api/v1/subscribers/{id}/add-tag
Add tags to a contact
POST
/api/v1/subscribers/{id}/remove-tag
Remove tags from a contact
PATCH
/api/v1/lists/{list_uid}/subscribers/{id}/subscribe
Subscribe a contact
PATCH
/api/v1/lists/{list_uid}/subscribers/{id}/unsubscribe
Unsubscribe a contact
PATCH
/api/v1/lists/{list_uid}/subscribers/email/{email}/unsubscribe
Unsubscribe an address from a list
POST
/api/v1/lists/{list_uid}/subscribers/bulk
Import contacts, in the request
POST
/api/v1/lists/{list_uid}/subscribers/bulk/async
Import contacts, in the background
GET
/api/v1/lists/{list_uid}/import-jobs
List the recent imports of a list
GET
/api/v1/import-jobs/{job_uid}
Follow an import
DELETE
/api/v1/import-jobs/{job_uid}
Cancel an import
POST
/api/v1/public/subscribers
Sign a contact up, without a token
Campaigns
Campaigns, their delivery logs and their webhooks.
/api/v1/campaigns
List the campaigns
POST
/api/v1/campaigns
Create a campaign
GET
/api/v1/campaigns/{uid}
Get a campaign
PATCH
/api/v1/campaigns/{uid}
Change a campaign
DELETE
/api/v1/campaigns/{uid}
Delete a campaign
POST
/api/v1/campaigns/{uid}/run
Send a campaign
POST
/api/v1/campaigns/{uid}/pause
Pause a campaign
POST
/api/v1/campaigns/{uid}/resume
Resume a paused campaign
GET
/api/v1/campaigns/{uid}/tracking-log/download
Download the delivery log of a campaign
GET
/api/v1/campaigns/{uid}/open-log/download
Download the opens of a campaign
GET
/api/v1/campaigns/{uid}/click-log/download
Download the clicks of a campaign
GET
/api/v1/campaigns/{uid}/bounce-log/download
Download the bounces of a campaign
GET
/api/v1/campaigns/{uid}/feedback-log/download
Download the complaints of a campaign
GET
/api/v1/campaigns/{uid}/unsubscribe-log/download
Download the unsubscribes of a campaign
GET
/api/v1/campaigns/{uid}/webhooks
List the webhooks of a campaign
POST
/api/v1/campaigns/{uid}/webhooks
Add a webhook to a campaign
GET
/api/v1/campaigns/{uid}/webhooks/{webhook_uid}
Get a webhook of a campaign
PATCH
/api/v1/campaigns/{uid}/webhooks/{webhook_uid}
Change a webhook of a campaign
DELETE
/api/v1/campaigns/{uid}/webhooks/{webhook_uid}
Delete a webhook of a campaign
Automations
Automations, and starting one for a contact.
Bounces and complaints
Report a bounce or a complaint for a message that was sent.
Admin API
Called with an admin's API token: customers, subscriptions, sending servers and maintenance.
Customers
Customer accounts. Admin token only.
/api/v1/customers
List the customers
POST
/api/v1/customers
Create a customer
GET
/api/v1/customers/{uid}
Get a customer
PATCH
/api/v1/customers/{uid}
Change a customer
DELETE
/api/v1/customers/{uid}
Delete a customer
GET
/api/v1/customers/by-email/{email}
Find a customer by a user's email address
PATCH
/api/v1/customers/{uid}/enable
Enable a customer
PATCH
/api/v1/customers/{uid}/disable
Disable a customer
Subscriptions
Customers' plans. Admin token only.
/api/v1/customers/{uid}/assign-plan/{plan_uid}
Assign a plan to a customer
POST
/api/v1/customers/{uid}/change-plan/{plan_uid}
Change the plan of a customer's active subscription
POST
/api/v1/customers/{uid}/subscription/update
Replace a customer's subscription
GET
/api/v1/subscriptions
List the subscriptions
POST
/api/v1/subscriptions
Subscribe a customer to a plan
Sending servers
The sending servers of the platform. Admin token only.
Maintenance
Version, license, plugins and upgrades of the installation. Admin token only.
/api/v1/whoami
Get the version of the installation
POST
/api/v1/license/refresh
Refresh the license
POST
/api/v1/plugins/install
Install a plugin from a URL
POST
/api/v1/upgrade/stage
Put an upgrade package in place
GET
/api/v1/upgrade/preflight
Check what an upgrade would do
POST
/api/v1/upgrade/launch-test
Start a launch test
GET
/api/v1/upgrade/launch-test/{id}
Follow a launch test
POST
/api/v1/upgrade/start
Start the upgrade
GET
/api/v1/upgrade/progress/{id}
Follow an upgrade
GET
/api/v1/upgrade/progress/{id}/log
Download the log of an upgrade
POST
/api/v1/upgrade/code-cache/clear
Clear the code cache after an upgrade