Identify a visitor

Attach an email to the anonymous visitor so their whole browsing history — every touchpoint before the signup — is merged into that person's profile. From the browser, `hyax('identify', { email })` posts this for you. The link only happens when a person with that email already exists on the team; to create the person and identify in one call, use `POST /hyax-api/v1/people/add` with the visitor's `ip` instead, which matches them to a visitor seen from the same IP in the last 30 days. Like all tracking calls, this returns 200 with `{ success: false }` on validation errors rather than a 4xx.

Base URL: https://platform.hyax.com · Replace YOUR_API_KEY with your team API key.

Request body

Field	Required	Description
`teamId`	Required	Not required when using Bearer API key auth
`visitorId`	Required	From `hyax.getVisitorId()`
`email`	Required	Linked to an existing person on the team
`event`	No	Label for the call; `identify` by convention

Request

curl -X POST 'https://platform.hyax.com/hyax-api/v1/track/event' \
  -H 'Authorization: Bearer YOUR_API_KEY' \
  -H 'Content-Type: application/json' \
  -d '{
    "teamId": "clx_team_id",
    "visitorId": "hyax_vid_abc123",
    "email": "[email protected]",
    "event": "identify"
  }'

Response

// Equivalent hyax.js call
hyax('identify', { email: '[email protected]' });

// Response
{
  "success": true
}

Request

curl -X POST 'https://platform.hyax.com/hyax-api/v1/track/event' \
  -H 'Authorization: Bearer YOUR_API_KEY' \
  -H 'Content-Type: application/json' \
  -d '{
    "teamId": "clx_team_id",
    "visitorId": "hyax_vid_abc123",
    "email": "[email protected]",
    "event": "identify"
  }'

Response

// Equivalent hyax.js call
hyax('identify', { email: '[email protected]' });

// Response
{
  "success": true
}