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

Deploy a Zapsite

GET
/v2/zap-sites/{id}/deploy
Deploys a generated ZapSite to one or more domains. Domains must be active, owned by the caller, and not already serving a ZapSite. Per-domain outcomes are reported — this is not all-or-nothing.
Path params
FieldTypeRequired
idstring (UUID)Yes
Request body
FieldTypeRequiredNotes
domainIdsstring[] (UUID)Yes1–500 domain UUIDs owned by the caller.
indexingbooleanNoAllow search engine indexing. Defaults to false.
trackingbooleanNoEnable pageview/CTA tracking. Defaults to true.
form_enabledbooleanNoEnable the lead-capture form. Defaults to true.

Request

Path Params

Header Params

Body Params application/jsonRequired

Examples

Responses

🟢200Success
application/json
Bodyapplication/json

🟠400Site has no Generated Copy Yet
🟠422Invalid domainIds
🟠404Not found
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request GET 'https://api.zapmail.ai/api/v2/zap-sites//deploy' \
--header 'x-auth-zapmail: YOUR_API_KEY' \
--header 'x-workspace-id: workspace_123' \
--header 'x-service-provider: GOOGLE' \
--header 'Content-Type: application/json' \
--data '{
    "domainIds": [
        "c1a2b3c4-d5e6-4f70-8a9b-1c2d3e4f5a6b",
        "a2b3c4d5-e6f7-4081-9a0b-2c3d4e5f6a7b"
    ],
    "indexing": false,
    "tracking": true,
    "form_enabled": true
}'
Response Response Example
200 - Success
{
    "status": 202,
    "message": "ZapSite deployment started",
    "data": {
        "site": {
            "id": "5b1e0c2a-4f3e-4a9d-9c7c-6a2b6e1a7d10",
            "status": "LIVE",
            "version": 2
        },
        "queued": [
            {
                "domainId": "c1a2b3c4-d5e6-4f70-8a9b-1c2d3e4f5a6b",
                "domain": "example-outreach.com",
                "deploymentId": "d3f1a2b4-5c6d-4e7f-8a9b-0c1d2e3f4a5b"
            }
        ],
        "skipped": [
            {
                "domainId": "a2b3c4d5-e6f7-4081-9a0b-2c3d4e5f6a7b",
                "domain": "already-live-outreach.com",
                "reason": "Domain is already serving a ZapSite"
            }
        ]
    }
}
Modified at 2026-09-07 11:27:37
Previous
Regenerate a Zapsite
Next
Global mailbox-domain search
Built with