Scan A Site

GET

/v2/zap-sites/scan

Scans a destination URL and returns page metadata (title, brand colors, tone) without creating or persisting a ZapSite.

Request

Header Params

Body Params application/jsonRequired

Examples

Responses

🟢200Success

application/json

Bodyapplication/json

🟠422Invalid/Missing URL

🟠400Unreachable/blocked destination

Request Example

Shell

JavaScript

Java

Swift

curl --location --request GET 'https://api.zapmail.ai/api/v2/zap-sites/scan' \
--header 'x-auth-zapmail;' \
--header 'Content-Type: application/json' \
--data '{
  "url": "https://yourwebsite.com"
}'

Response Example

200 - Success

{
  "status": 200,
  "message": "Destination site scanned successfully",
  "data": {
    "title": "Example — Modern SaaS for Sales Teams",
    "description": "Example helps sales teams book more meetings with less busywork.",
    "logo_url": "https://yourwebsite.com/assets/logo.png",
    "primary_color": "#1F6FEB",
    "secondary_color": "#0B1220",
    "accent_color": "#F5A623",
    "tone_summary": "Confident, direct, product-led B2B SaaS voice",
    "suggested_audiences": [
      "Founders",
      "Sales teams",
      "Marketing leaders",
      "Agencies",
      "Ecommerce",
      "Enterprise IT"
    ],
    "suggested_cta_label": "Get started"
  }
}

Modified at 2026-09-07 11:25:53

Cancel subscription

Create a New Zapsite