Scan Destination

POST

/zap-sites/scan

Use this when you need page content and brand details before generating a ZapSite. It fetches a URL and extracts title, headings, button copy, brand colors, logo, and fonts, plus an AI-suggested audience and CTA label.

Call it first in the flow. It doesn't create anything yet, pass its data object straight into the scan field of POST /zap-sites (create) so the page generator doesn't have to re-fetch the page.

Rate limit (per CMR user, resets about 24h after the first scan of the day): 5 + (1 per domain you currently have domain protection ACTIVE on). A user with no protected domains gets 5 scans a day, and one with domain protection active on 10 domains gets 15 a day. Going over returns a 429.

Example

POST /zap-sites/scan?userId=H8M9JV2S9HMPYFQW393AZHQVD4XM
{"url": "https://www.example.com"}

Request

Authorization

API Key

Add parameter in header

cmr-x-api-key

Example:

cmr-x-api-key: ********************

Query Params

Body Params application/jsonRequired

Examples

Responses

🟢200Success

application/json

Destination scanned successfully

Bodyapplication/json

🟠401Unauthorized

🟠422Validation Error

🟠429Too Many Requests

🔴503Service Unavailable

Request Example

Shell

JavaScript

Java

Swift

curl --location 'https://customers.coldmailreseller.com/api/v1/integration/zap-sites/scan?userId=H8M9JV2S9HMPYFQW393AZHQVD4XM' \
--header 'cmr-x-api-key: <api-key>' \
--header 'Content-Type: application/json' \
--data '{
    "url": "https://www.example.com"
}'

Response Example

200 - Example 1

{
    "status": 200,
    "message": "Destination scanned successfully",
    "data": {
        "url": "https://www.example.com",
        "final_url": "https://www.example.com/",
        "fetched_at": "2026-10-21T14:57:29.379Z",
        "title": "Example | Grow your business",
        "description": "Infrastructure to grow your business.",
        "h1s": [
            "string"
        ],
        "h2s": [
            "string"
        ],
        "buttons": [
            "string"
        ],
        "colors": [
            "string"
        ],
        "logo_url": "string",
        "logo_svg": null,
        "icon_url": "string",
        "font_family": null,
        "font_css_url": null,
        "text_excerpt": "string",
        "suggested_audiences": [
            "string"
        ],
        "suggested_cta_label": "string"
    }
}

Modified at 2026-10-26 10:06:25

ZapSites: how the flow fits together

Check Existing Sites For Destination

Scan Destination

Example#

Request

Responses

Example