POST
/
v1
/
identify
Identify
curl --request POST \
  --url https://analytix.userpilot.io/v1/identify \
  --header 'Authorization: <authorization>' \
  --header 'Content-Type: application/json' \
  --data '{
  "user_id": "<string>",
  "metadata": {
    "Job title": "<string>",
    "Name": "<string>",
    "Hiring date": "<string>",
    "Years of experience": 123,
    "Specialization": "<string>",
    "Email": "jsmith@example.com"
  },
  "company": {
    "id": "<string>"
  }
}'
{
  "errors": [
    {
      "details": "<string>",
      "error": "<string>",
      "error_code": "<string>",
      "message": "<string>"
    }
  ]
}

Headers

Content-Type
string
Accept
string
Authorization
string
required

API authentication token in the format: Token {{API_KEY}} Obtain your API key from the Userpilot Environment Settings.

Body

application/json

Response

401 - application/json

Unauthorized - Invalid API key

The response is of type object.