Mailivery API — Quick Start (5-Minute Demo)

1. Prerequisites

Item	Detail
API key	Assigned by Admin. Request a demo call first.
Base URL	https://app.mailivery.io/api/v1
Auth header	Authorization: Bearer YOUR_API_KEY
HTTP tool	cURL, Postman, or any client you like (examples use cURL).

---

2. Make sure your key works (10 seconds)

Bash

curl -X GET https://app.mailivery.io/api/v1/campaigns \
     -H "Authorization: Bearer $MAILIVERY_API_KEY"

• 200 OK → key is valid (list may be empty).
• 401 → check the header format.

---

3. Add a mailbox (campaign) – SMTP example

Bash

curl -X POST https://app.mailivery.io/api/v1/campaigns/smtp \
  -H "Authorization: Bearer $MAILIVERY_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
        "firstName": "Ada",
        "lastName":  "Lovelace",
        "email":     "[email protected]",
        "ownerEmail":"[email protected]",
        "smtp": { "host": "smtp.example.com", "port": 587,
                  "username": "[email protected]", "password": "••••••••", "secure": false },
        "imap": { "host": "imap.example.com", "port": 993,
                  "username": "[email protected]", "password": "••••••••", "secure": true },
        "emailsPerDay": 40,
        "responseRate": 30,
        "timezone": "America/Chicago"
      }'

Returns 200 with a JSON body that includes id → save this.

For Gmail or SendGrid, swap the path to /campaigns/gmail or /campaigns/sendgrid.

---

4. Start warm-up

Bash

curl -X PATCH https://app.mailivery.io/api/v1/campaigns/$ID/start-warmup \
     -H "Authorization: Bearer $MAILIVERY_API_KEY"

Success message: { "message": "Warm-up started" }

---

5. (Optional) Check the health score

Bash

curl -X PATCH https://app.mailivery.io/api/v1/campaigns/$ID/get-health-score \
     -H "Authorization: Bearer $MAILIVERY_API_KEY"

You’ll see DNS grade, SPF/DMARC status, and reputation signals. Call this daily to monitor progress.

---

6. What next?

Task	Endpoint
Pause / resume warm-up	/campaigns/{id}/pause-warmup, /resume-warmup
Tweak volume or reply-rate	/update-email-per-day, /update-response-rate
Fetch detailed metrics	/campaigns/{id}/get-metrics
Receive live events	Set up Settings → Webhooks