Getting Started

License Activation

Cleanmails requires a valid license key to access outreach features. The license is bound to your server's hardware ID for anti-piracy protection.

Activating Your License

  1. Login to your Cleanmails dashboard
  2. Navigate to Settings → License
  3. Enter your license key (format: CK-XXXX-XXXX-XXXX)
  4. Click Activate

The system will contact Dodo Payments to validate and bind the key to your machine.

Hardware binding

Your license is bound to the server's unique hardware ID. If you migrate to a new server, you'll need to contact support to transfer the license.

License Validation

Cleanmails re-validates your license every 24 hours against the Dodo Payments API. If the API is unreachable (network issue), the license remains active (fail-safe). If the license is explicitly revoked, it will be marked as expired.

API Endpoints

Check license status

bash
curl http://YOUR_SERVER/v1/license/status

Returns:

json
{"status": "active", "key": "CK-XX****XX"}

Activate license

bash
curl -X POST http://YOUR_SERVER/v1/license/activate \
  -H "Content-Type: application/json" \
  -d '{"key": "YOUR_LICENSE_KEY"}'

License-Protected Features

Without an active license, the following endpoints return 401 license_required:

  • Email verification (/v1/verify, /v1/bulk)
  • All outreach endpoints (/v1/outreach/*)
  • AI copilot (/v1/ai/*)
  • System updates (/v1/system/*)

Auth, setup, and license endpoints themselves are always accessible.