ProMailDispatch API

Store a reusable HTML template under your API key. content should be uploaded as an HTML file.

curl -X POST https://promaildispatch.cloud/api/v3/mail/template/create \
  -F 'api_key=YOUR_API_KEY' \
  -F 'sender_name=Your team' \
  -F 'subject=Your meeting invitation' \
  -F 'content=@template.html;type=text/html'

{
  "error": false,
  "message": "Template created.",
  "data": {
    "id": 12,
    "sender_name": "Your team",
    "subject": "Your meeting invitation",
    "content": "<p>Hello __name:</p>"
  }
}

Example shows the fields needed for sending. Save data.id and pass it as template_id when sending.

Returns the templates created under your API key. The v2 template URLs also remain available.

{
  "error": false,
  "message": "Found 1 Templates(s)",
  "data": [ { "id": 12, "subject": "Your meeting invitation" } ]
}

Template fields are shortened in this example. When no templates exist, data is null and the message explains that no templates were found.

Send one message built from a stored template.

api_key=YOUR_API_KEY
template_id=12
recipient=user@example.com

recipient=user@example.com__id:123__meetingName:Conference__meetingDate:2026-07-20__meetingBanner:https://example.com/banner.jpg

Use matching tokens in the message body: __meetingName: becomes Conference. See custom parameters for a complete example and format limits.

Send an ad-hoc message by passing the subject and HTML content inline.

Use this mode for one recipient. Bulk sending requires a saved template.

api_key=YOUR_API_KEY
recipient=user@example.com
subject=Welcome
reply_to=support@yourdomain.com
content=<h1>Hello</h1><p>Welcome onboard.</p>

Send to many recipients in one call. Bulk requests are queued; use POST /api/v3/mail/process with your api_key and returned batch_id to import and send them in chunks.

recipient=user1@example.com,user2@example.com,user3@example.com

one@example.com__name:Jordan__meetingName:Conference
two@example.com__name:Casey__meetingName:Workshop

The file may contain one email per line or comma-separated emails. Each line can carry __key:value params, just like single sends.

curl -X POST https://promaildispatch.cloud/api/v3/mail/send \
  -F 'api_key=YOUR_API_KEY' \
  -F 'template_id=12' \
  -F 'is_bulk=true' \
  -F 'reply_to=replies@example.com' \
  -F 'recipient=@recipients.txt;type=text/plain'

The API upload field is recipient. Supply either the file or the text list. The optional Reply-To address applies to every message in the batch.

{
  "error": false,
  "message": "V3 bulk file request accepted. Use /api/v3/mail/process to import and send in chunks.",
  "data": {
    "batch_id": 42,
    "fileName": "recipients.txt",
    "fileSize": "150 B",
    "fileMime": "text/plain"
  }
}

File details reflect your upload. A text-list request returns data.batch_id and data.queued instead. Acceptance means the batch was submitted; delivery is shown separately in Tracking. Keep the batch ID to check its progress. Review the dashboard limits and workflow when sending from the console.

Add values after each recipient address using __key:value. Place the matching __key: token in the HTML body.

one@example.com__name:Jordan__meetingName:Conference__id:123

<p>Hello __name:,</p>
<p>Your invitation to __meetingName:. Reference: __id:</p>

Hello Jordan,
Your invitation to Conference. Reference: 123

• Names are case sensitive. Use letters and digits for simple parameter names.
• Personalization applies to the body. The subject stays the same for every recipient.
• Unmatched tokens stay in the message. Supply every value used in your template.
• To include the address in the body, supply it explicitly, for example __email:one@example.com, and use __email: in the body.
• __id: also sets the recipient's custom ID.
• Values must not contain underscores, commas, semicolons, or line breaks. These characters are used to parse the list and its values. URLs with colons and slashes are supported.
• Values are inserted as supplied. Use trusted values and HTML suitable for the place where each token appears.

Template previews show the saved HTML before recipient values are applied.

Check an address for valid syntax, a resolvable domain (MX), and disposable/role patterns.

api_key=YOUR_API_KEY
email=user@example.com

{
  "error": false,
  "message": "Verification complete.",
  "data": {
    "email": "user@example.com",
    "valid": true,
    "reason": "ok",
    "has_mx": true,
    "is_disposable": false,
    "is_role": false
  }
}

Aggregate delivery and engagement funnel for a scope.

api_key=YOUR_API_KEY
batch_id=20

{
  "total": 1000,   "queued": 0,
  "accepted": 980, "delivered": 920,
  "opened": 400,   "clicked": 70,
  "bounced": 30,   "complained": 0,
  "failed": 10,    "skipped": 10,
  "open_count": 540, "click_count": 90
}

Recipient-level delivery and engagement status.

Recent event history for one tracked recipient, returned newest record first.

Tracking is included when emails are sent through v3. An open pixel and tracked links are added automatically.

Delivery results may arrive after acceptance. Open Tracking and leave Auto refresh on to see updates. Summary counts overlap: one message can count as accepted, delivered, and opened. Times in the dashboard timeline are shown in UTC.

Add your PMD API key on the API access page to use these tools.

1. For one recipient, choose a saved template or write inline HTML. For bulk email, choose a saved template.
2. Paste the addresses or upload a .txt list. Leave the text box empty when uploading. Bulk recipient files in the dashboard are limited to 5 MB.
3. Review the subject, recipient count, and optional Reply-To address. The dashboard removes invalid addresses and duplicates before confirmation. If an address appears more than once, its first set of custom values is kept.
4. Confirm the reviewed email once, then follow its results in Tracking. Keep the tracking page open until batch processing finishes; return to the saved batch to continue if needed.

Drafts save while you work. A file upload must be selected again when you return to a draft. Saved template previews show the HTML before personalization.

Check one address, paste a list, or upload a .txt file up to 1 MB. Each list supports up to 500 unique valid-format addresses and 2,000 entries before duplicates are removed. Duplicates are checked once; invalid-format entries appear in the results. Pause or resume a list as needed.

An unavailable check is marked for retry and is not counted as an invalid address. Use Retry unavailable to try again. Keep the page open while checks run. Verification describes the address at the time of the check and does not guarantee future delivery.

Verification CSV exports include every row in the current saved list. Tracking CSV exports include the latest 200 matching recipient records, matching the displayed list. Choose Events beside a recipient to view its timeline. Use the batch ID to return to a bulk send.

Dashboard review and upload limits apply to the console. Direct API integrations should validate and deduplicate their own lists.

Check the HTTP status and the JSON error field. PMD returns a message explaining a rejected request; correct the relevant input before trying again.

Keep API keys private. Use your application's server to call PMD; do not place a key in public JavaScript or a shared screenshot.