Zapmail
latest
  • latest
  • v1
latest
  • latest
  • v1
Sign In
latest
  • latest
  • v1
Root
Root
  1. Zapsites
  • Zapmail Docs
  • users
    • Retrieve User Details
      GET
  • quick setup
    • Quick Setup
      POST
  • workspaces
    • 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
  • 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
  • global
    • Global mailbox-domain search
  • zapbox
    • List Connected Accounts
    • Fetch emails
    • get emails from a thread
    • Search emails
    • Send Email
    • Download Attachment
    • Create New Label
    • Delete Label
    • Rename Label
  • Schemas
    • domain with filter
  1. Zapsites

Create a New Zapsite

POST
/v2/zap-sites
Creates a new ZapSite. Kicks off asynchronous AI copy generation; the site is returned immediately in GENERATING status, before copy/logo are ready.
Poll for status: copy generation runs in the background. Poll GET /:id with the id from this response until status moves off GENERATING (→ DRAFT once ready, or ERROR with lastError populated if generation failed) and copy/logoUrl are populated.
Limit: 50 ZapSites per user.
Request body
FieldTypeRequiredNotes
destination_urlstringYesMax 2048 chars. The real destination the page's CTA links to.
namestringNoMax 255 chars. Defaults to a name derived from the destination host.
campaign_contextstringNoMax 4000 chars. Plain-language description of the campaign; primary generation input.
audiencestring[]NoTarget audience labels.
cta_labelstringNoMax 255 chars. Defaults to "Get in touch".
themestringNoOne of auto, slate, mint, carbon. Defaults to auto.

Request

Header Params

Responses

🟢201Success
application/json
Bodyapplication/json

🟠422Missing Destination URL
🟠409Max Sites Reached
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request POST 'https://api.zapmail.ai/api/v2/zap-sites' \
--header 'x-auth-zapmail: YOUR_API_KEY' \
--header 'x-workspace-id: workspace_123' \
--header 'x-service-provider: GOOGLE'
Response Response Example
201 - Success
{
  "status": 201,
  "message": "ZapSite created — page generation started",
  "data": {
    "id": "5b1e0c2a-4f3e-4a9d-9c7c-6a2b6e1a7d10",
    "userId": "8a2f9d3e-1b2c-4d5e-8f6a-2c3d4e5f6a7b",
    "workspaceId": "8a2f9d3e-1b2c-4d5e-8f6a-2c3d4e5f6a7b",
    "name": "Example Q4 Cold Outreach",
    "destinationUrl": "https://example.com/pricing",
    "campaignContext": "Targeting VP Sales at 50-500 person B2B SaaS companies for our Q4 outbound push.",
    "audience": ["VP Sales", "RevOps"],
    "ctaLabel": "Book a demo",
    "theme": "auto",
    "status": "GENERATING",
    "version": 0,
    "scan": {
      "title": "Example — Modern SaaS for Sales Teams",
      "primary_color": "#1F6FEB",
      "secondary_color": "#0B1220"
    },
    "copy": null,
    "logoUrl": null,
    "formFields": null,
    "notifyEmail": null,
    "slackWebhook": null,
    "lastError": null,
    "createdAt": "2026-09-04T10:15:32.421Z",
    "updatedAt": "2026-09-04T10:15:32.421Z",
    "deletedAt": null,
    "deployments": [],
    "counts": {
      "leads": 0,
      "visitors": 0
    }
  }
}
Modified at 2026-09-07 11:25:56
Previous
Scan A Site
Next
Fetch A Zapsite
Built with