Zapmail
Overview
API Reference
Overview
API Reference
  1. Capabilities
  • Introduction
  • Quickstart
  • Authentication
  • MCP
  • Versioning
  • Errors
  • Webhooks
  • Rate Limits
  • Pagination
  • Changelog
  • Capabilities
    • Mailboxes
    • Pre-Warmed
    • Deliverability
    • Domains
    • Export to Sequencer
    • Zapbox
    • Team Management
    • ZapShield
    • ZapCare
    • AI Insight
    • Deliverability Tests
    • ZapSites
    • Zapwarm
    • ZapPulse
  • Billing
    • Understanding Zapmail billing
    • Wallet
  1. Capabilities

ZapSites

A Zap Site is a one-page campaign site that Zapmail writes for a destination URL. Instead of sending visitors to a bare redirect, you can serve the page from your sending domains. This page covers the full lifecycle: scan a destination, create a site, review and edit it, regenerate its copy, and deploy it to domains.
Before you start: you need at least one ACTIVE domain in your account to deploy to (see Domains). An account can hold at most 50 Zap Sites by default; beyond that, creation returns 409.

Create and deploy a site#

1
Scan the destination (optional)
POST /zap-sites/scan fetches the page at url and returns its title, headings, buttons, colors, logo, fonts, a text excerpt, suggested audiences and a suggested call-to-action label. Use it to prefill the create call. Nothing is saved. The fetch is synchronous and can be slow. Unreachable hosts, timeouts, non-HTML pages and private or reserved addresses return 400 with the reason.
2
Create
POST /zap-sites with destination_url. You can add campaign_context, name, audience, cta_label and theme (auto, slate, mint or carbon). The destination is scanned during the request, so the call can be slow. It returns 201 with status GENERATING.
3
Wait for copy
Generation runs in the background. Poll GET /zap-sites/{id} until status is DRAFT, or ERROR with the reason in lastError. The site is not served anywhere yet.
4
Review and edit
GET /zap-sites/{id} returns the generated copy. Change settings with PATCH /zap-sites/{id} (see Edit a site).
5
Deploy
POST /zap-sites/{id}/deploy with domainIds. Each domain gets its own deployment that serves the same page. The call returns 202. Poll GET /zap-sites/{id} and watch each deployments[].status move from PENDING to DEPLOYING and then LIVE or FAILED.
Deploy options are tracking (default true), form_enabled (default true) and indexing (default false). Domains that are not active, not yours, or already serving a Zap Site are returned in skipped, and the rest are queued. The site must have generated copy, otherwise the call returns 400.
Deploying replaces forwarding
Deploying a Zap Site replaces any existing forwarding or redirect on the domain, and undeploying later does not restore it.

Edit a site#

PATCH /zap-sites/{id} changes the name, button label (cta_label), theme, campaign_context, lead-alert targets (notify_email, slack_webhook) or contact-form fields (form_fields). Send only the fields to change.
Changing theme re-renders the page without regenerating copy.
Changing campaign_context only stores the new text. Call Regenerate to apply it to the copy.
form_fields replaces the whole form. Send null to restore the default form.
Send an empty string or null for notify_email or slack_webhook to clear it.
A theme outside the allowed list returns 422.

Regenerate or roll back copy#

POST /zap-sites/{id}/regenerate rewrites the copy or restores an earlier version. Both outcomes return 202.
Without versionId, regeneration is queued and the site goes to GENERATING. Optional notes guide the rewrite, and campaign_context replaces the stored campaign text. Poll GET /zap-sites/{id} until status is DRAFT or ERROR.
With versionId, that earlier copy is restored immediately as a new version, and notes and campaign_context are ignored. An unknown version returns 404.
Every rewrite creates a new version and earlier versions stay restorable. There is no endpoint that lists versions, so use numbers from 1 up to the current version on the site.

Reading a site#

GET /zap-sites/{id} returns the site with its copy, deployments, lead and traffic totals, the latest leads and visitors, and a 14-day traffic series. leads and visitors return at most the 200 newest records each, and counts holds the full totals. Reading a site whose deployment is DEPLOYING may check the SSL certificate and move it to LIVE or FAILED.
Related: Domains.
Previous
Deliverability Tests
Next
Zapwarm
Built with