PilotFoxDocs

Identify a visitor

POST
/api/v1/sites/{siteId}/users/identify

Links a visitor id (a visitor_id as the reports show it; 400 otherwise) to a user id by hand, as the tracker's identify does, with optional traits merged into the profile's.

Requires users:write on the site (an API key, or a signed-in member's role). Share links: 401.

Authorization

headerx-api-key<token>

An organization API key (ak_…), with the permissions and the sites it was created with. For servers and scripts: no cookie and no Origin check. Also accepted as Authorization: Bearer ak_… (apiKeyBearer). A request carries one credential: a key sent with a share token or a live session cookie is 400 (details.reason: ambiguous_credentials).

Scope: users:write

Path Parameters

siteId*string

Request Body

application/json
  1. body
visitorId*string
Lengthlength <= 20
userId*string
Length1 <= length <= 255
traits?

Response Body

No Content

Example Request
curl -X POST 'https://pilotfox.app/api/v1/sites/string/users/identify' \  -H 'Content-Type: application/json' \  -d '{  "visitorId": "string",  "userId": "string"}'
Example Response204
Empty