Skip to Content
Identification APIWebsites

Websites API

Create and manage websites for visitor identification and tracking.

Required Headers

HeaderDescription
x-access-keyYour Warm AI API key
x-user-idYour Warm AI user ID
x-idempotency-keyUnique key to prevent duplicate requests
Content-Typeapplication/json

For better prospect matching and visitor scoring, link your Ideal Customer Profiles (ICPs) to your website when creating it. This ensures visitors are automatically scored against your target profiles.

{
  "action": "create_website",
  "domain": "example.com",
  "name": "My Website",
  "icp_ids": ["icp_abc123", "icp_def456"]
}

Installing the Tracking Script

After creating a website, add the following script to the <head> tag of your site:

<script src="https://cdn.warmai.uk/warm.js" data-id="YOUR_TRACKING_ID" async></script>

Replace YOUR_TRACKING_ID with the tracking_id returned when you create a website.

Endpoints

Create Website

POST https://api.warmai.uk/api-website-action

Creates a new website for visitor identification.

Request Body

FieldTypeRequiredDescription
actionstringYesMust be "create_website"
domainstringYesThe domain of your website (e.g. example.com)
namestringNoA display name for the website
icp_idsstring[]NoArray of ICP IDs to link for visitor scoring

Example Request

{
  "action": "create_website",
  "domain": "example.com",
  "name": "My Marketing Site",
  "icp_ids": ["icp_abc123"]
}

Response Fields

FieldTypeDescription
idstringUnique website ID
domainstringThe website domain
namestringDisplay name
tracking_idstringID used in the tracking script
statusstringWebsite status
created_atstringISO 8601 timestamp
linked_icp_idsstring[]ICP IDs linked to this website

Example Response

{
  "id": "ws_a1b2c3d4",
  "domain": "example.com",
  "name": "My Marketing Site",
  "tracking_id": "trk_x9y8z7",
  "status": "active",
  "created_at": "2026-03-19T12:00:00Z",
  "linked_icp_ids": ["icp_abc123"]
}

List Websites

POST https://api.warmai.uk/api-website-action

Retrieve all websites associated with your account.

Request Body

FieldTypeRequiredDescription
actionstringYesMust be "list_websites"
user_idstringNoFilter websites by a specific user ID

Example Request

{
  "action": "list_websites"
}

Response Fields

FieldTypeDescription
websitesarrayList of website objects
websites[].idstringUnique website ID
websites[].domainstringThe website domain
websites[].namestringDisplay name
websites[].tracking_script_idstringID used in the tracking script
websites[].statusstringWebsite status (active, paused, archived)
websites[].created_atstringISO 8601 timestamp
websites[].linked_icp_idsstring[]ICP IDs linked to this website

Example Response

{
  "websites": [
    {
      "id": "ws_a1b2c3d4",
      "domain": "example.com",
      "name": "My Marketing Site",
      "tracking_script_id": "trk_x9y8z7",
      "status": "active",
      "created_at": "2026-03-19T12:00:00Z",
      "linked_icp_ids": ["icp_abc123"]
    },
    {
      "id": "ws_e5f6g7h8",
      "domain": "blog.example.com",
      "name": "Company Blog",
      "tracking_script_id": "trk_w6v5u4",
      "status": "active",
      "created_at": "2026-03-18T09:30:00Z",
      "linked_icp_ids": []
    }
  ]
}
Last updated on
Visitors