Zapmail
OverviewAPI Reference
OverviewAPI Reference
  1. Deliverability Test
  • Domains
    • DNS
      • Get DNS Records
      • Add DNS Records
      • Check DNS Records
      • Add DNS Records to Multiple Domains
      • Update DNS Record
      • Delete DNS Record
    • Register
      • Search Available Domains
      • Buy Domains
      • Check Availability of Multiple Domains
      • Find Domains With AI
    • Connect
      • List Domain Connection Requests
      • Connect Domains
      • Get Nameservers to Connect a Domain
      • Verify Nameservers to Connect a Domain
      • Add Google Client ID to Domains
      • Remove Domain Connection Requests
    • Tag
      • List Domain Tags
      • Assign Tags to Domains
      • Create Domain Tags
      • Remove Tags from Domains
      • Delete Domain Tag
      • Update Domain Settings
    • Renewals
      • Search Domains Due for Renewal
      • Get Domain Renewal Prices
      • Renew Domains
      • Update Domain Auto-Renew
      • List Domains Due for Renewal
    • List Assignable Domains
      GET
    • Get Domain Health Score
      GET
    • Search Mailboxes and Domains
      GET
    • List Domains
      POST
    • Move Domains to Another Workspace
      POST
    • Remove Connected Domains
      DELETE
  • Mailbox
    • Get Authenticator Code
      GET
    • Get Mailbox
      GET
    • List Mailboxes
      POST
    • Provision Mailboxes
      POST
    • Update Mailboxes
      PUT
    • Schedule Mailbox Removal
      PUT
    • Retry Failed Mailboxes
      PUT
  • Export
    • List Third-Party Workspaces
    • Add Sequencer Details
    • Get Export Status
    • Update Sequencer Account Details
    • Add Google Client ID To Domain
    • Connect Third-Party Account
    • Connect Mailboxes With Custom OAuth
    • Fetch Workspaces by App
    • Export Mailboxes
    • Update Third-Party Account
    • Get Export Status
    • Export Mailboxes
  • Quick Setup
    • List Quick Setup Entries
    • Start Quick Setup
  • Pre-Warmed
    • List Pre-Warmed Domains
    • Count Pre-Warmed Domains
    • List Pre-Warmed Subscriptions
    • Assign Pre-Warmed Domains
    • Purchase Pre-Warmed Plan
  • Zapbox
    • List Zapbox Connected Accounts
    • List Zapbox Threads
    • Get Zapbox Thread Messages
    • Search Zapbox Emails
    • Send Zapbox Email
    • Apply Zapbox Email Action
    • Download Zapbox Attachment
    • Create Zapbox Label
    • Delete Zapbox Label
    • Rename Zapbox Label
  • User
    • Get Current User
  • Billing Details
    • Add Billing Details
    • Update Billing Details
  • Payments & Wallet
    • Get Wallet Balance
    • Add Wallet Balance
    • Enable or Disable Auto Recharge
    • Buy Add-On Mailboxes
    • Get Subscription Invoice URL
  • Subscriptions and Workspaces
    • List Workspace Members
    • List Workspace Invitations
    • List Workspaces
    • List Subscriptions
    • Create Workspace
    • Send Workspace Invitation
    • Cancel Subscription
    • List Subscription Mailboxes
    • Update Member Role
    • Update Workspace
    • Revoke Workspace Access
  • High Reputation Domains
    • List Aged Domains
    • Purchase Aged Domains
  • Deliverability
    • ZapShield
      • List ZapShield Subscriptions
      • List ZapShield Eligible Domains
      • List ZapShield Allocated Domains
      • Get ZapShield Available Slots
      • Cancel ZapShield Subscription
      • Purchase ZapShield
      • Upgrade ZapShield Plan
      • Allocate Domains to ZapShield
    • Deliverability Test
      • Get Deliverability Test Overall Report
        GET
      • List Deliverability Test Orders
        GET
      • Get Deliverability Test Report
        GET
      • List Deliverability Test Subscriptions
        GET
      • Get Deliverability Test Available Slots
        GET
      • List Deliverability Test Eligible Mailboxes
        POST
      • Purchase Deliverability Test
        POST
      • Generate Deliverability Test Spintax
        POST
      • Purchase Deliverability Test Plan
        POST
      • Cancel Deliverability Test Subscription
        POST
    • AI Insight
      • Get AI Insight Credits
      • Get AI Insight Analysis
      • Get Shared AI Insight Analysis
      • List AI Insight Eligible Mailboxes
      • Generate AI Insight Analysis
      • Calculate AI Insight Pricing
      • Purchase AI Insight Plan
      • Purchase AI Insight For Mailboxes
      • Email AI Insight Analysis
      • Share AI Insight Analysis
      • List AI Insight Analyses
      • Upgrade AI Insight Plan
    • Zap Care
      • List Zap Care Allocated Domains
      • Get Zap Care Available Slots
      • List Zap Care Subscriptions
      • List Zap Care Eligible Domains
      • Cancel Zap Care Subscription
      • Allocate Domains to Zap Care
      • Purchase Zap Care
  • Webhooks
    • List Webhook Event Types
    • List Webhook Endpoints
    • List Webhook Deliveries
    • Get Webhook Endpoint
    • Create Webhook Endpoint
    • Resend Webhook Delivery
    • Send Test Webhook Event
    • Update Webhook Endpoint
    • Delete Webhook Endpoint
  • Zap Sites
    • Get Zap Site
    • Create Zap Site
    • Regenerate Zap Site
    • Deploy Zap Site
    • Scan Zap Site Destination
    • Update Zap Site
  • 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 ZapPulse Insights
    • List ZapPulse Mailboxes
    • Get ZapPulse Mailbox Report
    • Create ZapPulse Report Share Link
  1. Deliverability Test

Generate Deliverability Test Spintax

POST
https://api.zapmail.ai/api/v3/placement-tests/generate-spintax
Starts AI generation of spintax variants of an email subject and body for a deliverability test. Use the result as subject and body in Purchase Deliverability Test with enableSpintax set to true.
Asynchronous: the call returns 202 with a jobId at once. The generated subject and body are published to the realtime channel spintax_<jobId> (events spintax.chunk and spintax.done); this API has no endpoint to fetch them later, and failures are not reported.
One variant is requested per target mailbox. Select mailboxes with mailboxIds, or with tagIds, contains and status.
Spintax groups use the form {option1/option2/option3}.
Does not consume credits and is not charged.

Request

Header Params

Body Params application/json

Examples

Responses

🟢202Success
application/json
Generation started.
Bodyapplication/json

🟠400BadRequest
🟠401Unauthorized
🟠403Forbidden
🟠422UnprocessableEntity
🟠429TooManyRequests
🔴500ServerError
Request Request Example
Shell
JavaScript
Java
Swift
curl --location 'https://api.zapmail.ai/api/v3/placement-tests/generate-spintax' \
--header 'x-auth-zapmail;' \
--header 'Content-Type: application/json' \
--data '{
    "subject": "Quick question about Q4",
    "body": "Hi {{firstName}}, do you have a minute this week to talk about outbound?",
    "mailboxIds": [
        "a1b2c3d4-5e6f-4071-8a9b-0c1d2e3f4a5b",
        "7c9e6f10-2b3a-4c5d-9e8f-1a2b3c4d5e6f"
    ]
}'
Response Response Example
202 - Started
{
    "jobId": "5d1f0c52-8a7e-4b3d-9f6a-2c4e8b1a7d90",
    "message": "Spintax generation started"
}
Previous
Purchase Deliverability Test
Next
Purchase Deliverability Test Plan
Built with