Identify Visitors

Define visitor properties on an existing visitor or create a new visitor. This fires a $identify event, making the call visible in the event stream. For top-level visitor properties: null clears the existing value, while undefined, omitted fields, and empty strings are ignored. For entries inside custom_properties: null, undefined, and empty strings are all ignored (custom_properties use merge semantics). See https://docs.oursprivacy.com/docs/data-types for details and common pitfalls.

POST
/identify
*object
object

Request Body

application/json

The payload to identify a visitor

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

application/json

application/json

application/json

curl -X POST "https://api.oursprivacy.com/api/v1/identify" \  -H "Content-Type: application/json" \  -d '{    "token": "string",    "userProperties": {}  }'
{
  "success": true
}
{
  "success": false
}
{
  "success": false
}
{
  "success": false
}
{
  "success": false
}

How is this guide?