Zapmail
latest
  • latest
  • v1
latest
  • latest
  • v1
Sign In
latest
  • latest
  • v1
Root
Root
  1. ZapPulse
  • Zapmail Docs
  • Webhooks
  • MCP
  • Unified Provider Launch — Oct 13, 2026
  • users
    • Retrieve User Details
      GET
  • quick setup
    • Quick Setup
      POST
  • workspaces
    • Delete A Workspace
      DELETE
    • Retrieve all workspaces
      GET
    • Create new workspace
      POST
    • Update workspace
      PUT
    • List all workspace members
      GET
    • Update user role
      PUT
    • Revoke User Access
      DELETE
    • Send invitiation to join workspace
      POST
    • List all invitations
      GET
    • Revoke invitation
      DELETE
    • Update Domain Renewal Settings
      POST
  • billing
    • Add Billing Details
      POST
    • Update Billing Details
      PUT
  • mailbox
    • Retrieve All Mailboxes
      GET
    • Get Mailbox Details by ID
      GET
    • Assign New Mailboxes to Domains
      POST
    • Update mailbox
      PUT
    • Remove mailboxes on next renewal
      PUT
    • Get Authenticator code
      GET
    • Custom OAuth
      POST
    • schedule mailbox creation
      POST
    • retry creation of failed mailboxes
      PUT
  • payments & wallet
    • Add balance to wallet
    • Get wallet balance
    • Enable auto recharge
    • Purchase add on mailboxes
    • get invoices for subscription
  • export
    • Export mailboxes
    • Add third party account details
    • Update third party account details
    • Get Export Status
    • Fetch Workspaces by App
    • List all third-party accounts
  • subscriptions
    • Get all subscriptions
    • Cancel subscription
    • Upgrade existing subscription
    • Purchase subscription
    • Get Mailboxes in a Subscription
  • domains
    • Retrieve All Domains
    • List Assignable Domains
    • Add DMARC record
    • Add Domain forwarding
    • Get Name servers to connect domain
    • Verify Name Server Propagation
    • Connect Domain with Zapmail
    • Enable email forwarding
    • Remove email forwarding
    • Enable catch all emails
    • Remove catch all emails
    • Check DNS records
    • Remove unused domains
    • Get available domains for registration
    • Get domains purchase payment link
    • Get domain connection requests
    • Remove domain connection requests
    • Connect Domain with Zapmail (New)
    • Add Google Client ID to Domain
    • Get availability of multiple domain names.
    • Retrieve Domain Health Score
    • Retrieve All Domains (With filters)
    • AI Domain Finder
    • Move Domains Across workspace
    • Assign Domain Tag
    • list domain tags
    • Create Domain Tags
    • Remove Domain Forwarding
    • List Domains Eligible for Renewal
    • Get Renewal Price
    • Renew Domains
    • Delete Tag
    • Remove Tags From Domains
    • Update Auto Renew Preference
  • dns
    • Get dns records
    • Add dns records
    • Update dns records
    • Delete dns records
  • High Reputation Domains
    • Get available domains
    • Purchase high reputation domains
  • prewarmed domains
    • Get prewarmed domains
    • purchase prewarmed subscription
    • Assign prewarmed mailboxes
    • Get Available Domains Count
    • Get Prewarm Subscriptions
  • Deliverability Test
    • Get subscriptions
    • Get Overall Report
    • Get placement test orders
    • Get report by cart order id
    • Get Eligible Mailboxes for Placement Tests
    • Get Available Placement Test Credits
    • Purchase Placement Test
    • Purchase plan
    • Cancel Subscription
  • dns shield
    • Get eligible domains
    • Get available slots
    • Get subscriptions
    • Get Allocated Domains for Subscription
    • Allocate Domains to DNS Shield
    • Purchase DNS Shield
    • Upgrade DNS Shield LTD Plan
    • Cancel subscription
  • Zapsites
    • Scan A Site
    • Create a New Zapsite
    • Fetch A Zapsite
    • Edit a Zapsite
    • Regenerate a Zapsite
    • Deploy a Zapsite
    • Bulk create ZapSites
  • global
    • Global mailbox-domain search
  • zapbox
    • Send Email
    • List Connected Accounts
    • Fetch emails
    • get emails from a thread
    • Search emails
    • Download Attachment
    • Create New Label
    • Delete Label
    • Rename Label
  • Webhooks
    • Get Event Types
    • Get Webhook Endpoints/Destinations
    • Create New Webhook Endpoint/Destination
    • Update a Specific Endpoint
  • Zapwarm
    • List mailboxes eligible for warmup
    • Get the Zapwarm quote for selected mailboxes
    • Start Zapwarm on selected mailboxes
    • Turn off Zapwarm on selected mailboxes
    • Edit Zapwarm settings
    • Get zapwarm score
  • ZapPulse
    • Get ZapPulse Overview
      GET
    • Get ZapPulse Insights
      GET
    • List ZapPulse Mailboxes
      GET
    • Get ZapPulse Mailbox Report
      GET
    • Create ZapPulse Report Share Link
      POST
  • Schemas
    • domain with filter
  1. ZapPulse

Get ZapPulse Mailbox Report

GET
/zappulse/mailboxes/{mailboxId}
Returns the full ZapPulse report for one mailbox: status, measurements, the nine sending practices, inbox placement, blacklist findings, recommended fixes and the AI report. Fields are null when the mailbox has no completed test.

Request

Path Params

Query Params

Header Params

Responses

🟢200
application/json
Report fetched
Bodyapplication/json

Request Request Example
Shell
JavaScript
Java
Swift
curl --location 'https://api.zapmail.ai/api/zappulse/mailboxes/?runId=' \
--header 'x-auth-zapmail;' \
--header 'x-workspace-key;'
Response Response Example
{
  "status": 200,
  "message": "Zappulse mailbox fetched successfully",
  "data": {
    "mailbox": {
      "id": "2c6f0a52-1f0e-4d7e-9d73-3f2b0d3f1a11",
      "email": "sam@example-sender.com",
      "firstName": "Sam",
      "lastName": "Carter",
      "profilePicture": "https://example.com/photos/sam.jpg",
      "domain": "example-sender.com",
      "provider": "GOOGLE",
      "status": "fix_sending",
      "lastTestedAt": "2026-11-05T18:30:02.586Z",
      "nextRunAt": null,
      "tier": null,
      "inFlight": false
    },
    "history": [
      {
        "runId": "0d8f6c1e-6a52-4c8e-8f4e-6c2b1d9a7e33",
        "kind": "result",
        "status": "fix_sending",
        "reason": null,
        "at": "2026-11-05T18:30:02.586Z",
        "digest": {
          "google": "inbox",
          "microsoft": "inbox",
          "metrics": { "coldSent": 168, "coldPerDayMax": 25, "medianGapMinutes": 1.6, "replyRateWarmup": 19.7, "bounceRate": 1.2 },
          "practicesMet": 6,
          "practicesUnknown": 0,
          "practicesTotal": 9
        }
      }
    ],
    "run": {
      "id": "0d8f6c1e-6a52-4c8e-8f4e-6c2b1d9a7e33",
      "status": "fix_sending",
      "skipReason": null,
      "testedAt": "2026-11-05T18:30:02.586Z",
      "windowStart": "2026-10-16T18:37:09.415Z",
      "windowEnd": "2026-11-05T18:37:09.415Z"
    },
    "measurements": {
      "coldSent": 168,
      "coldPerDayMax": 25,
      "medianGapMinutes": 1.6,
      "warmupEnabled": false,
      "warmupScore": null,
      "replyRateWarmup": 19.7,
      "campaignReplyRate": 1.3,
      "bounceRate": 1.2,
      "spamReplies": 0,
      "firstEmails": { "sampled": 20, "html": 0, "links": 0, "signature": 0, "pixel": 0 },
      "prospectShare": { "google": 6.5, "microsoft": 47 }
    },
    "practices": {
      "volume": true, "spacing": false, "warmupRunning": false, "replyRate": false,
      "plainText": true, "noLinks": true, "noSignature": true, "noTrackingPixel": true, "bounceRate": true
    },
    "unverified": [],
    "placement": {
      "google": "inbox",
      "microsoft": "inbox",
      "rows": [
        { "accountType": "GOOGLE", "placement": "INBOX", "status": "SUCCESS" },
        { "accountType": "MICROSOFT365", "placement": "INBOX", "status": "SUCCESS" }
      ]
    },
    "blacklist": {
      "listed": true,
      "highest": "medium",
      "listings": [ { "name": "SURBL multi", "severity": "medium", "action": "Request delisting" } ]
    },
    "advice": {
      "verdict": {
        "headline": "3 sending practices need fixing",
        "reason": "Inbox today, but 3 sending practices are off. Fix them before it turns into spam."
      },
      "fixes": [
        { "key": "spacing", "action": "Space sends at least 12 minutes apart.", "evidence": "The median gap was 1.6 minutes." },
        { "key": "warmupRunning", "action": "Run warmup alongside your campaigns.", "evidence": "Zapwarm warmup is off for this mailbox." },
        { "key": "replyRate", "action": "Lift your reply rate above 30%.", "evidence": "19.7% of recipients replied, warmup included." }
      ],
      "nothingToChange": false,
      "outcome": { "reachable": 53.5, "atRisk": 0, "unknown": 46.5 }
    },
    "aiReport": {
      "id": "9a1b2c3d-4e5f-4a6b-8c7d-0e1f2a3b4c5d",
      "status": "SUCCESS",
      "generatedAt": "2026-11-05T18:32:25.404Z",
      "report": "Your mailbox health score is 89.5 out of 100, which reflects strong foundational technical health...",
      "mailboxHealth": 100,
      "domainHealth": 100,
      "overallScore": 89.5,
      "sendingHealth": 78.5,
      "listQuality": 98,
      "engagementHealth": 75,
      "riskFlags": []
    }
  }
}
Modified at 2026-11-10 11:59:45
Previous
List ZapPulse Mailboxes
Next
Create ZapPulse Report Share Link
Built with