Zapmail
OverviewAPI Reference
OverviewAPI Reference
  1. Zap Sites
  • Domains
    • DNS
      • Get DNS Records
      • Add DNS Records
      • Check DNS Records
      • Add DNS Records to Multiple Domains
      • Update DNS Record
      • Delete DNS Record
    • Register
      • Search Available Domains
      • Buy Domains
      • Check Availability of Multiple Domains
      • Find Domains With AI
    • Connect
      • List Domain Connection Requests
      • Connect Domains
      • Get Nameservers to Connect a Domain
      • Verify Nameservers to Connect a Domain
      • Add Google Client ID to Domains
      • Remove Domain Connection Requests
    • Tag
      • List Domain Tags
      • Assign Tags to Domains
      • Create Domain Tags
      • Remove Tags from Domains
      • Delete Domain Tag
      • Update Domain Settings
    • Renewals
      • Search Domains Due for Renewal
      • Get Domain Renewal Prices
      • Renew Domains
      • Update Domain Auto-Renew
      • List Domains Due for Renewal
    • List Assignable Domains
      GET
    • Get Domain Health Score
      GET
    • Search Mailboxes and Domains
      GET
    • List Domains
      POST
    • Move Domains to Another Workspace
      POST
    • Remove Connected Domains
      DELETE
  • Mailbox
    • Get Authenticator Code
      GET
    • Get Mailbox
      GET
    • List Mailboxes
      POST
    • Provision Mailboxes
      POST
    • Update Mailboxes
      PUT
    • Schedule Mailbox Removal
      PUT
    • Retry Failed Mailboxes
      PUT
  • Export
    • List Third-Party Workspaces
      GET
    • Add Sequencer Details
      POST
    • Get Export Status
      GET
    • Update Sequencer Account Details
      PUT
    • Add Google Client ID To Domain
      POST
    • Connect Third-Party Account
      POST
    • Connect Mailboxes With Custom OAuth
      POST
    • Fetch Workspaces by App
      GET
    • Export Mailboxes
      POST
    • Update Third-Party Account
      PUT
    • Get Export Status
      GET
    • Export Mailboxes
      POST
  • Quick Setup
    • List Quick Setup Entries
    • Start Quick Setup
  • Pre-Warmed
    • List Pre-Warmed Domains
    • Count Pre-Warmed Domains
    • List Pre-Warmed Subscriptions
    • Assign Pre-Warmed Domains
    • Purchase Pre-Warmed Plan
  • Zapbox
    • List Zapbox Connected Accounts
    • List Zapbox Threads
    • Get Zapbox Thread Messages
    • Search Zapbox Emails
    • Send Zapbox Email
    • Apply Zapbox Email Action
    • Download Zapbox Attachment
    • Create Zapbox Label
    • Delete Zapbox Label
    • Rename Zapbox Label
  • User
    • Get Current User
  • Billing Details
    • Add Billing Details
    • Update Billing Details
  • Payments & Wallet
    • Get Wallet Balance
    • Add Wallet Balance
    • Enable or Disable Auto Recharge
    • Buy Add-On Mailboxes
    • Get Subscription Invoice URL
  • Subscriptions and Workspaces
    • List Workspace Members
    • List Workspace Invitations
    • List Workspaces
    • List Subscriptions
    • Create Workspace
    • Send Workspace Invitation
    • Cancel Subscription
    • List Subscription Mailboxes
    • Update Member Role
    • Update Workspace
    • Revoke Workspace Access
  • High Reputation Domains
    • List Aged Domains
    • Purchase Aged Domains
  • Deliverability
    • ZapShield
      • List ZapShield Subscriptions
      • List ZapShield Eligible Domains
      • List ZapShield Allocated Domains
      • Get ZapShield Available Slots
      • Cancel ZapShield Subscription
      • Purchase ZapShield
      • Upgrade ZapShield Plan
      • Allocate Domains to ZapShield
    • Deliverability Test
      • Get Deliverability Test Overall Report
      • List Deliverability Test Orders
      • Get Deliverability Test Report
      • List Deliverability Test Subscriptions
      • Get Deliverability Test Available Slots
      • List Deliverability Test Eligible Mailboxes
      • Purchase Deliverability Test
      • Generate Deliverability Test Spintax
      • Purchase Deliverability Test Plan
      • Cancel Deliverability Test Subscription
    • AI Insight
      • Get AI Insight Credits
      • Get AI Insight Analysis
      • Get Shared AI Insight Analysis
      • List AI Insight Eligible Mailboxes
      • Generate AI Insight Analysis
      • Calculate AI Insight Pricing
      • Purchase AI Insight Plan
      • Purchase AI Insight For Mailboxes
      • Email AI Insight Analysis
      • Share AI Insight Analysis
      • List AI Insight Analyses
      • Upgrade AI Insight Plan
    • Zap Care
      • List Zap Care Allocated Domains
      • Get Zap Care Available Slots
      • List Zap Care Subscriptions
      • List Zap Care Eligible Domains
      • Cancel Zap Care Subscription
      • Allocate Domains to Zap Care
      • Purchase Zap Care
  • Webhooks
    • List Webhook Event Types
    • List Webhook Endpoints
    • List Webhook Deliveries
    • Get Webhook Endpoint
    • Create Webhook Endpoint
    • Resend Webhook Delivery
    • Send Test Webhook Event
    • Update Webhook Endpoint
    • Delete Webhook Endpoint
  • Zap Sites
    • Get Zap Site
      GET
    • Create Zap Site
      POST
    • Regenerate Zap Site
      POST
    • Deploy Zap Site
      POST
    • Scan Zap Site Destination
      POST
    • Update Zap Site
      PATCH
  • Zapwarm
    • List mailboxes eligible for warmup
    • Get the Zapwarm quote for selected mailboxes
    • Start Zapwarm on selected mailboxes
    • Turn off Zapwarm on selected mailboxes
    • Edit Zapwarm settings
    • Get zapwarm score
  • ZapPulse
    • Get ZapPulse Overview
    • Get ZapPulse Insights
    • List ZapPulse Mailboxes
    • Get ZapPulse Mailbox Report
    • Create ZapPulse Report Share Link
  1. Zap Sites

Update Zap Site

PATCH
https://api.zapmail.ai/api/v3/zap-sites/{id}
Changes a Zap Site's name, button label, theme, campaign text, lead-alert targets or contact-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 POST /zap-sites/{id}/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 is rejected with 422.
Related: GET /zap-sites/{id}.

Request

Path Params

Header Params

Body Params application/jsonRequired

Examples

Responses

🟢200Success
application/json
Bodyapplication/json

🟠401Unauthorized
🟠403Forbidden
🟠404NotFound
🟠422UnprocessableEntity
🟠429TooManyRequests
🔴500ServerError
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request PATCH 'https://api.zapmail.ai/api/v3/zap-sites/6a2d9f40-1c7b-4e35-8d92-0b5e3a7c1f68' \
--header 'x-auth-zapmail;' \
--header 'Content-Type: application/json' \
--data-raw '{
  "theme": "mint",
  "notify_email": "leads@acme.com"
}'
Response Response Example
200 - Updated
{
  "status": 200,
  "message": "ZapSite updated successfully",
  "data": {
    "id": "6a2d9f40-1c7b-4e35-8d92-0b5e3a7c1f68",
    "userId": "0b71d8dd-55c3-4bf8-b4ed-bfe9697d5af1",
    "workspaceId": "0b71d8dd-55c3-4bf8-b4ed-bfe9697d5af1",
    "name": "acme.com - spring promo",
    "destinationUrl": "https://acme.com/",
    "campaignContext": "Spring promotion for B2B SaaS founders",
    "audience": [
      "Founders",
      "Sales teams"
    ],
    "ctaLabel": "Get in touch",
    "theme": "mint",
    "status": "DRAFT",
    "version": 1,
    "scan": {
      "url": "https://acme.com/",
      "title": "Acme"
    },
    "copy": {
      "brand_name": "Acme",
      "headline": "Outbound that lands in the inbox"
    },
    "logoUrl": null,
    "formFields": null,
    "notifyEmail": "leads@acme.com",
    "slackWebhook": null,
    "lastError": null,
    "createdAt": "2026-10-26T09:14:03.000Z",
    "updatedAt": "2026-10-26T09:21:10.000Z",
    "deletedAt": null,
    "deployments": [],
    "counts": {
      "leads": 0,
      "visitors": 0,
      "ctaClicks": 0
    }
  }
}
Previous
Scan Zap Site Destination
Next
List mailboxes eligible for warmup
Built with