Zapmail
latest
  • latest
  • v1
latest
  • latest
  • v1
Sign In
latest
  • latest
  • v1
Root
Root
  1. Zapsites
  • 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 Mailbox Details by ID
    • Assign New Mailboxes to Domains
    • Update mailbox
    • Remove mailboxes on next renewal
    • Get Authenticator code
    • Custom OAuth
    • schedule mailbox creation
    • retry creation of failed mailboxes
  • 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
  • placement 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
      GET
    • Create a New Zapsite
      POST
    • Fetch A Zapsite
      GET
    • Edit a Zapsite
      PATCH
    • Regenerate a Zapsite
      POST
    • Deploy a Zapsite
      GET
    • Bulk create ZapSites
      POST
  • 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
  • Schemas
    • domain with filter
  1. Zapsites

Bulk create ZapSites

POST
/zap-sites/bulk
Creates a ZapSite for each domain, scans each destination URL, queues page-copy generation and optionally deploys each site to its domain. Replies 202 before generation finishes. Poll each siteId with GET /zap-sites/{id}. Per-item problems are returned in data.skipped and the call still returns 202. Large requests can be slow because destination URLs are scanned before the 202 is sent. A per-user site cap applies, so valid items may be skipped. Deploying clears any existing redirect/forwarding on the domain.

Request

Header Params

Body Params application/jsonRequired

Examples

Responses

🟢202
application/json
Accepted. Page generation has started for each queued item.
Bodyapplication/json

🟠401
🟠422
🟠429
Request Request Example
Shell
JavaScript
Java
Swift
cURL
curl --location 'https://api.zapmail.ai/api/zap-sites/bulk' \
--header 'x-workspace-key;' \
--header 'x-service-provider;' \
--header 'Content-Type: application/json' \
--data '{
    "deploy": true,
    "sites": [
        {
            "domainId": "6b7dfb5d-00cd-4431-ba8b-d2f02f5b040b",
            "destination_url": "https://www.northpeakconsulting.com",
            "name": "Advisor Playbook – Free Strategy Call",
            "campaign_context": "Help independent financial advisors book more discovery calls with a short, clear page that explains our free 30-minute strategy session.",
            "audience": [
                "Financial advisors",
                "Wealth managers"
            ],
            "cta_label": "Book a free call",
            "theme": "slate"
        },
        {
            "domainId": "e5e0c558-efd0-436b-bf02-18b5eac962b8",
            "destination_url": "https://www.northpeakconsulting.com",
            "name": "Arrow Firm – Growth Consulting",
            "campaign_context": "Introduce our growth consulting for B2B companies that want more qualified meetings from outbound email.",
            "audience": [
                "Founders",
                "Sales teams"
            ],
            "cta_label": "Get in touch"
        }
    ]
}'
Response Response Example
202 - Success
{
    "status": 202,
    "message": "ZapSites created — page generation started for each domain",
    "data": {
        "queued": [
            {
                "index": 0,
                "domainId": "6b7dfb5d-00cd-4431-ba8b-d2f02f5b040b",
                "domain": "advisorplaybook.co",
                "siteId": "3f9c2a71-5b8e-4d0a-9c14-7e2a6b1d8f40",
                "deploymentId": "a41d7c92-0e63-4b58-8f1a-2c9d5e7b3a06"
            },
            {
                "index": 1,
                "domainId": "e5e0c558-efd0-436b-bf02-18b5eac962b8",
                "domain": "arrowfirm.co",
                "siteId": "c82e5d14-9a37-4f6b-b0d2-61f8a3e94c75",
                "deploymentId": "7d03b6e8-4c15-49a2-a6f9-d18e2b5c0397"
            }
        ],
        "skipped": []
    }
}
Modified at 2026-10-20 15:58:54
Previous
Deploy a Zapsite
Next
Global mailbox-domain search
Built with