1. Deploy & Deployments
  • Welcome to the Cold Mail Reseller API
  • Get Started
    • Overview
    • Authentication
    • Quick Start
  • Core Concepts
    • Onebox
    • Users
    • Domains
    • DNS Management
    • Pre-Warmup
    • Mailbox Warmup
    • OAuth Exports
    • Platform Exports
    • Mailboxes
    • Sandbox API
    • 1+ Year Subscriptions
    • Subscriptions
    • Domain Renewal
  • API Reference
    • Users
      • List Users
      • Get User
      • Create User
      • Update User
      • Delete User
    • Geo
      • List Countries
      • List States
    • Domains
      • Domain Protection
      • Domain Renewal
        • Get Domain Renewal Prices
        • Renew Domains
        • Toggle Domain Auto-Renew
      • Get Domain
      • List Available Aged Domains
      • Order Aged Domains
      • Get Domains by User
      • Check Domain Availability
      • Check Single Domain Availability
      • Check Workspace Existence
      • Set Domain Forwarding
      • Set Email Forwarding
      • Delete Domains
      • Enable Domain Protection
      • Cancel Domain Protection
    • DNS
      • Get DNS Records
      • Add DNS Records
      • Update DNS Record
      • Update Nameservers
      • Delete DNS Record
    • Mailboxes
      • List Mailboxes
      • Get Mailboxes by User
      • Get Mailbox
      • Get Admin Mailbox Details
      • Update Mailbox Details
      • Delete Mailbox
    • Mailbox Warmup
      • Add Warmup to Mailbox
      • Toggle Warmup
      • Update Warmup Settings
      • Delete Warmup Subscription
    • Orders
      • Get Order Status
      • Get Order Details
      • Create Order
      • Create Order (JSON)
      • Create Mailbox Order (JSON)
      • Process Order
    • Subscriptions
      • 1+ Year Subscription
        • Recreate Subscription
      • Get Subscriptions
      • Renew Subscriptions
      • Cancel Subscription
      • Toggle Auto-Renewal
    • Exports
      • Platform Exports
        • Get Platform Credentials
        • Get Platform Workspaces
        • Add Platform Credential
        • Export Mailboxes to Platform
        • Update Platform Credential
        • Remove Platform Credential
      • OAuth Exports
        • Perform OAuth
        • Add Client ID to Domains
    • Pre-Warmup
      • Sandbox
        • Get Sandbox Pre-warmup Domains
        • Order Sandbox Pre-warmup
        • Reset Sandbox Pre-warmup
      • Get Pre-warmup Domains
      • Order Pre-warmup
    • Placement Test
      • Create Placement Order
      • Get Placement Reports
    • Onebox
      • Connect Mailbox
      • List Connected Mailboxes
      • List Emails
      • Get Thread
      • Search Emails
      • Act On Thread
      • List Labels
      • Create Label
      • Rename Label
      • Delete Label
      • Send Email
      • Disconnect Mailbox
    • ZapSites
      • ZapSites: how the flow fits together
      • Page
        • Scan Destination
        • Check Existing Sites For Destination
        • List ZapSites
        • Create ZapSite
        • Get ZapSite
        • Update ZapSite
        • Delete ZapSite
        • Duplicate ZapSite
      • Copy & Versions
        • Regenerate ZapSite Copy
        • List ZapSite Versions
        • Preview ZapSite Version
        • Rollback ZapSite
      • Preview & Leads
        • Preview ZapSite
        • List ZapSite Leads
        • Send Test Lead Alert
      • Deploy & Deployments
        • Deploy ZapSite
          POST
        • Update Deployment Settings
          PATCH
        • Remove Deployment
          DELETE
  • Resources
    • Errors
    • Rate Limits
    • Pagination
    • Sandbox
    • MCP
  • Webhooks
    • Overview
    • Events
      • DNS Events
      • Subscription Events
      • Prewarmup Events
      • Mailbox Warmup Events
      • Mailbox Events
      • Domain Events
  • Schemas
    • Error
    • Success
    • MessageResponse
    • User
    • Domain
    • ErrorResponse
    • Mailbox
    • Subscription
    • DnsRecord
    • Error Response
    • Pagination Meta
    • Action Error Response
    • PrewarmupOrderResult
    • OrderCreationResult
  1. Deploy & Deployments

Deploy ZapSite

POST
/zap-sites/{id}/deploy
Use this once the page's copy has been generated (status DRAFT) and you're ready to put it on a real domain. It puts this ZapSite live on 1 to 100 of the customer's own domains.
Domain protection is the one all-or-nothing gate: every domain in the list must already have domain protection ACTIVE (check or enable it via the domain-protection endpoints first). This is checked up front, so if even one domain lacks active protection the whole request is rejected with a 400 and nothing is queued. Other ineligible domains do NOT fail the call: a domain that isn't found, isn't ACTIVE, or is already serving another live or in-progress deployment is skipped individually and reported in data.skipped[] with a reason, while the rest still deploy. So a 202 can come back with some domains in data.queued[] and others in data.skipped[].
Page generation must have finished first (the site needs copy), otherwise you get a 400 telling you to generate it. Each accepted domain is created as a QUEUED deployment and progresses QUEUED -> AWAITING_DNS -> DNS_WRITTEN -> DEPLOYING -> LIVE (or FAILED); poll GET /:id and watch deployments[].status.
Deploying writes real DNS A records on the domain (@/www) and clears any existing forwarding on it first. This is a real go-live action, not a preview.

Example#

POST /zap-sites/SITECCHMN86W734P8PMM3E53EW82HCC2/deploy?userId=H8M9JV2S9HMPYFQW393AZHQVD4XM
{"domains": ["example.com"]}

Request

Authorization
API Key
Add parameter in header
cmr-x-api-key
Example:
cmr-x-api-key: ********************
or
Path Params

Query Params

Body Params application/jsonRequired

Examples

Responses

🟢202Accepted
application/json
ZapSite deployment started
Bodyapplication/json

🟠401Unauthorized
🟠404Not Found
🟠400Domain Protection Required
🟠400Not Generated Yet
🟠422Validation Error
Request Request Example
Shell
JavaScript
Java
Swift
curl --location 'https://customers.coldmailreseller.com/api/v1/integration/zap-sites/SITECCHMN86W734P8PMM3E53EW82HCC2/deploy?userId=H8M9JV2S9HMPYFQW393AZHQVD4XM' \
--header 'cmr-x-api-key: <api-key>' \
--header 'Content-Type: application/json' \
--data '{
    "domains": [
        "example.com"
    ],
    "indexing": true,
    "tracking": true,
    "form_enabled": true
}'
Response Response Example
202 - Example 1
{
    "status": 202,
    "message": "ZapSite deployment started",
    "data": {
        "queued": [
            {
                "id": "6bbaaa0a-d8a7-4619-b329-9cde8820fd19",
                "domain": "example.com",
                "status": "QUEUED",
                "lastError": null,
                "indexing": true,
                "tracking": true,
                "formEnabled": true,
                "createdAt": "string",
                "updatedAt": "string"
            }
        ],
        "skipped": [
            {
                "domain": "string",
                "reason": "Domain not found"
            }
        ]
    }
}
Modified at 2026-10-26 10:06:21
Previous
Send Test Lead Alert
Next
Update Deployment Settings
Built with