Zapmail
latest
  • latest
  • v1
  1. placement test
Zapmail
latest
  • latest
  • v1
  • Zapmail Docs
  • users
    • Retrieve User Details
      GET
  • workspaces
    • Retrieve all workspaces
      GET
    • Create new workspace
      POST
    • Update workspace
      PUT
  • 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
    • Remove Mailboxes Instantly
      POST
    • Custom OAuth
      POST
  • payments & wallet
    • Add balance to wallet
      POST
    • Get wallet balance
      GET
    • Enable auto recharge
      POST
  • export
    • Export mailboxes
    • Add third party account details
    • Update third party account details
  • subscriptions
    • Get all subscriptions
    • Cancel subscription
    • Upgrade existing subscription
    • Purchase 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
  • dns
    • Get dns records
    • Add dns records
    • Update dns records
    • Delete dns records
  • aged domains
    • Get available domains
    • Purchase aged domains
  • prewarmed domains
    • Get prewarmed domains
    • purchase prewarmed subscription
    • Assign prewarmed mailboxes
  • placement test
    • Get subscriptions
      GET
    • Get Overall Report
      GET
    • Get placement test orders
      GET
    • Get report by cart order id
      GET
    • Get Eligible Mailboxes for Placement Tests
      POST
    • Get Available Placement Test Credits
      GET
    • Purchase Placement Test
      POST
    • Purchase plan
      POST
  • 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
  • Schemas
    • domain with filter
  1. placement test

Purchase Placement Test

Testing
POST
/v2/placement-tests/purchase
Run placement tests on selected mailboxes. Supports two payment modes:
MONTHLY: Uses credits from active subscriptions (no additional charge)
ONE_TIME: Pay-per-test at $2 per mailbox (wallet payment)
Tests can be run on specific mailboxes or filtered by tags, status, and search terms.

Request

Header Params

Body Params application/jsonRequired

Example
{
  "placementType": "ONE_TIME",
  "testName": "Campaign Deliverability Check",
  "mailboxIds": [
    "02ff3709-831d-4920-945a-6d36e3c8f3e7"
  ]
}

Request Code Samples

Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request POST 'https://api.zapmail.ai/api/v2/placement-tests/purchase' \
--header 'x-auth-zapmail;' \
--header 'x-workspace-key;' \
--header 'x-service-provider;' \
--header 'Content-Type: application/json' \
--data-raw '{
  "placementType": "ONE_TIME",
  "testName": "Campaign Deliverability Check",
  "mailboxIds": [
    "02ff3709-831d-4920-945a-6d36e3c8f3e7"
  ]
}'

Responses

🟢200Success
application/json
Body

Example
{
    "status": 200,
    "message": "Payment link",
    "data": {
        "checkoutUrl": "https://invoice.stripe.com/i/acct_xxx",
        "checkoutSession": false,
        "walletUsed": true
    }
}
Modified at 2025-12-24 13:03:02
Previous
Get Available Placement Test Credits
Next
Purchase plan
Built with