# AcelleMail API > Reference of the REST API of AcelleMail, the self-hosted email marketing application from https://acellesend.com. Every AcelleMail installation serves the API on its own domain at https://your-domain/api/v1; calls carry a user's API token in `Authorization: Bearer YOUR_API_TOKEN` and send `Accept: application/json`. Each endpoint page gives the method and path, its parameters and request body, a curl request, the PHP SDK call (`acelle/sdk-php`) where the SDK has one, and example answers. Customer API endpoints work with a customer's token; Admin API endpoints need an admin's token. This reference was generated from AcelleMail 4.2.0-p180. The whole reference in one file, every guide and endpoint in full: https://api.acellesend.com/llms-full.txt ## Guides - [Getting started](https://api.acellesend.com/guides/getting-started): Every call goes to the API's base URL, with your API token. - [Authentication](https://api.acellesend.com/guides/authentication): Send your API token with every request, in a header. - [Errors](https://api.acellesend.com/guides/errors): The HTTP status says what went wrong. ## Customer API: Authentication Get an API token, or a link that signs a user in. - [Get the API token of a user](https://api.acellesend.com/authentication/login-user): `POST /api/v1/user/login`, no API token needed - [Get a link that signs a user in](https://api.acellesend.com/authentication/create-login-token): `POST /api/v1/login-token` ## Customer API: Account The user a token belongs to and their account. - [Get the user of the token](https://api.acellesend.com/account/get-me): `GET /api/v1/me` - [Get the name and picture of the user](https://api.acellesend.com/account/get-user-info): `GET /api/v1/user/info` - [Get the account's totals](https://api.acellesend.com/account/get-dashboard): `GET /api/v1/dashboard` ## Customer API: Lists Contact lists and their fields. - [List the lists](https://api.acellesend.com/lists/list-lists): `GET /api/v1/lists` - [Create a list](https://api.acellesend.com/lists/create-list): `POST /api/v1/lists` - [Get a list](https://api.acellesend.com/lists/get-list): `GET /api/v1/lists/{uid}` - [Delete a list](https://api.acellesend.com/lists/delete-list): `DELETE /api/v1/lists/{uid}` - [Add a field to a list](https://api.acellesend.com/lists/add-list-field): `POST /api/v1/lists/{uid}/add-field` ## Customer API: Subscribers Contacts inside a list, one at a time or in bulk. - [List the contacts of a list](https://api.acellesend.com/subscribers/list-subscribers): `GET /api/v1/subscribers` - [Add a contact to a list](https://api.acellesend.com/subscribers/create-subscriber): `POST /api/v1/subscribers` - [Get a contact](https://api.acellesend.com/subscribers/get-subscriber): `GET /api/v1/subscribers/{id}` - [Change a contact](https://api.acellesend.com/subscribers/update-subscriber): `PATCH /api/v1/subscribers/{id}` - [Delete a contact](https://api.acellesend.com/subscribers/delete-subscriber): `DELETE /api/v1/subscribers/{id}` - [Find a contact in every list](https://api.acellesend.com/subscribers/find-subscribers-by-email): `GET /api/v1/subscribers/email/{email}` - [Add tags to a contact](https://api.acellesend.com/subscribers/add-subscriber-tags): `POST /api/v1/subscribers/{id}/add-tag` - [Remove tags from a contact](https://api.acellesend.com/subscribers/remove-subscriber-tags): `POST /api/v1/subscribers/{id}/remove-tag` - [Subscribe a contact](https://api.acellesend.com/subscribers/subscribe-subscriber): `PATCH /api/v1/lists/{list_uid}/subscribers/{id}/subscribe` - [Unsubscribe a contact](https://api.acellesend.com/subscribers/unsubscribe-subscriber): `PATCH /api/v1/lists/{list_uid}/subscribers/{id}/unsubscribe` - [Unsubscribe an address from a list](https://api.acellesend.com/subscribers/unsubscribe-by-email): `PATCH /api/v1/lists/{list_uid}/subscribers/email/{email}/unsubscribe` - [Import contacts, in the request](https://api.acellesend.com/subscribers/import-subscribers): `POST /api/v1/lists/{list_uid}/subscribers/bulk` - [Import contacts, in the background](https://api.acellesend.com/subscribers/start-subscriber-import): `POST /api/v1/lists/{list_uid}/subscribers/bulk/async` - [List the recent imports of a list](https://api.acellesend.com/subscribers/list-import-jobs): `GET /api/v1/lists/{list_uid}/import-jobs` - [Follow an import](https://api.acellesend.com/subscribers/get-import-job): `GET /api/v1/import-jobs/{job_uid}` - [Cancel an import](https://api.acellesend.com/subscribers/cancel-import-job): `DELETE /api/v1/import-jobs/{job_uid}` - [Sign a contact up, without a token](https://api.acellesend.com/subscribers/sign-up-subscriber): `POST /api/v1/public/subscribers`, no API token needed ## Customer API: Campaigns Campaigns, their delivery logs and their webhooks. - [List the campaigns](https://api.acellesend.com/campaigns/list-campaigns): `GET /api/v1/campaigns` - [Create a campaign](https://api.acellesend.com/campaigns/create-campaign): `POST /api/v1/campaigns` - [Get a campaign](https://api.acellesend.com/campaigns/get-campaign): `GET /api/v1/campaigns/{uid}` - [Change a campaign](https://api.acellesend.com/campaigns/update-campaign): `PATCH /api/v1/campaigns/{uid}` - [Delete a campaign](https://api.acellesend.com/campaigns/delete-campaign): `DELETE /api/v1/campaigns/{uid}` - [Send a campaign](https://api.acellesend.com/campaigns/run-campaign): `POST /api/v1/campaigns/{uid}/run` - [Pause a campaign](https://api.acellesend.com/campaigns/pause-campaign): `POST /api/v1/campaigns/{uid}/pause` - [Resume a paused campaign](https://api.acellesend.com/campaigns/resume-campaign): `POST /api/v1/campaigns/{uid}/resume` - [Download the delivery log of a campaign](https://api.acellesend.com/campaigns/download-campaign-tracking-log): `GET /api/v1/campaigns/{uid}/tracking-log/download` - [Download the opens of a campaign](https://api.acellesend.com/campaigns/download-campaign-open-log): `GET /api/v1/campaigns/{uid}/open-log/download` - [Download the clicks of a campaign](https://api.acellesend.com/campaigns/download-campaign-click-log): `GET /api/v1/campaigns/{uid}/click-log/download` - [Download the bounces of a campaign](https://api.acellesend.com/campaigns/download-campaign-bounce-log): `GET /api/v1/campaigns/{uid}/bounce-log/download` - [Download the complaints of a campaign](https://api.acellesend.com/campaigns/download-campaign-feedback-log): `GET /api/v1/campaigns/{uid}/feedback-log/download` - [Download the unsubscribes of a campaign](https://api.acellesend.com/campaigns/download-campaign-unsubscribe-log): `GET /api/v1/campaigns/{uid}/unsubscribe-log/download` - [List the webhooks of a campaign](https://api.acellesend.com/campaigns/list-campaign-webhooks): `GET /api/v1/campaigns/{uid}/webhooks` - [Add a webhook to a campaign](https://api.acellesend.com/campaigns/create-campaign-webhook): `POST /api/v1/campaigns/{uid}/webhooks` - [Get a webhook of a campaign](https://api.acellesend.com/campaigns/get-campaign-webhook): `GET /api/v1/campaigns/{uid}/webhooks/{webhook_uid}` - [Change a webhook of a campaign](https://api.acellesend.com/campaigns/update-campaign-webhook): `PATCH /api/v1/campaigns/{uid}/webhooks/{webhook_uid}` - [Delete a webhook of a campaign](https://api.acellesend.com/campaigns/delete-campaign-webhook): `DELETE /api/v1/campaigns/{uid}/webhooks/{webhook_uid}` ## Customer API: Automations Automations, and starting one for a contact. - [List the automations](https://api.acellesend.com/automations/list-automations): `GET /api/v1/automations` - [Start an automation for a contact](https://api.acellesend.com/automations/start-automation): `POST /api/v1/automations/{uid}/execute` ## Customer API: Bounces and complaints Report a bounce or a complaint for a message that was sent. - [Report a hard bounce](https://api.acellesend.com/bounces-and-complaints/report-bounce): `POST /api/v1/notification/bounce` - [Report a complaint](https://api.acellesend.com/bounces-and-complaints/report-complaint): `POST /api/v1/notification/feedback` ## Admin API: Customers Customer accounts. Admin token only. - [List the customers](https://api.acellesend.com/customers/list-customers): `GET /api/v1/customers` - [Create a customer](https://api.acellesend.com/customers/create-customer): `POST /api/v1/customers` - [Get a customer](https://api.acellesend.com/customers/get-customer): `GET /api/v1/customers/{uid}` - [Change a customer](https://api.acellesend.com/customers/update-customer): `PATCH /api/v1/customers/{uid}` - [Delete a customer](https://api.acellesend.com/customers/delete-customer): `DELETE /api/v1/customers/{uid}` - [Find a customer by a user's email address](https://api.acellesend.com/customers/find-customer-by-email): `GET /api/v1/customers/by-email/{email}` - [Enable a customer](https://api.acellesend.com/customers/enable-customer): `PATCH /api/v1/customers/{uid}/enable` - [Disable a customer](https://api.acellesend.com/customers/disable-customer): `PATCH /api/v1/customers/{uid}/disable` ## Admin API: Subscriptions Customers' plans. Admin token only. - [Assign a plan to a customer](https://api.acellesend.com/subscriptions/assign-plan): `POST /api/v1/customers/{uid}/assign-plan/{plan_uid}` - [Change the plan of a customer's active subscription](https://api.acellesend.com/subscriptions/change-plan): `POST /api/v1/customers/{uid}/change-plan/{plan_uid}` - [Replace a customer's subscription](https://api.acellesend.com/subscriptions/replace-subscription): `POST /api/v1/customers/{uid}/subscription/update` - [List the subscriptions](https://api.acellesend.com/subscriptions/list-subscriptions): `GET /api/v1/subscriptions` - [Subscribe a customer to a plan](https://api.acellesend.com/subscriptions/create-subscription): `POST /api/v1/subscriptions` ## Admin API: Sending servers The sending servers of the platform. Admin token only. - [List the sending servers](https://api.acellesend.com/sending-servers/list-sending-servers): `GET /api/v1/sending_servers` ## Admin API: Maintenance Version, license, plugins and upgrades of the installation. Admin token only. - [Get the version of the installation](https://api.acellesend.com/maintenance/get-whoami): `GET /api/v1/whoami` - [Refresh the license](https://api.acellesend.com/maintenance/refresh-license): `POST /api/v1/license/refresh` - [Install a plugin from a URL](https://api.acellesend.com/maintenance/install-plugin): `POST /api/v1/plugins/install` - [Put an upgrade package in place](https://api.acellesend.com/maintenance/stage-upgrade): `POST /api/v1/upgrade/stage` - [Check what an upgrade would do](https://api.acellesend.com/maintenance/get-upgrade-preflight): `GET /api/v1/upgrade/preflight` - [Start a launch test](https://api.acellesend.com/maintenance/start-upgrade-launch-test): `POST /api/v1/upgrade/launch-test` - [Follow a launch test](https://api.acellesend.com/maintenance/get-upgrade-launch-test): `GET /api/v1/upgrade/launch-test/{id}` - [Start the upgrade](https://api.acellesend.com/maintenance/start-upgrade): `POST /api/v1/upgrade/start` - [Follow an upgrade](https://api.acellesend.com/maintenance/get-upgrade-progress): `GET /api/v1/upgrade/progress/{id}` - [Download the log of an upgrade](https://api.acellesend.com/maintenance/download-upgrade-log): `GET /api/v1/upgrade/progress/{id}/log` - [Clear the code cache after an upgrade](https://api.acellesend.com/maintenance/clear-upgrade-code-cache): `POST /api/v1/upgrade/code-cache/clear` ## Optional - [AcelleMail](https://acellesend.com): Self-hosted email marketing platform with full source code included. Send unlimited campaigns through your own Amazon SES, SendGrid, or any SMTP service — one-time license, no recurring fees. - [Pricing](https://acellesend.com/pricing): licenses and what they include - [Live demo](https://acellesend.com/demo): try AcelleMail before installing it - [Installation guides](https://acellesend.com/kb/category/installation-setup): install AcelleMail on a VPS or a control-panel host - [Developer guide](https://acellesend.com/kb/category/developer-guide): plugins, webhooks and integrations - [PHP SDK](https://packagist.org/packages/acelle/sdk-php): `composer require acelle/sdk-php` - [Contact](https://acellesend.com/contact): support and sales