Skip to main content
POST
/
v1
/
identify
Identify
curl --request POST \
  --url https://{environment}.userpilot.io/v1/identify \
  --header 'Authorization: <authorization>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "user_id": "user_789456",
  "metadata": {
    "name": "Sarah Johnson",
    "email": "[email protected]",
    "job_title": "Product Manager",
    "department": "Product",
    "location": "New York, NY",
    "hire_date": "2022-03-15",
    "years_experience": 8,
    "skills": "Product Strategy, User Research, Agile",
    "subscription_plan": "Pro",
    "last_login": "2024-01-15T10:30:00Z",
    "preferences_language": "en",
    "preferences_timezone": "America/New_York",
    "preferences_notifications": "email"
  },
  "company": {
    "company_id": "comp_techstartup_2024",
    "name": "TechStartup Inc.",
    "industry": "SaaS",
    "size": "50-100",
    "location": "New York, NY",
    "website": "https://techstartup.com",
    "subscription_tier": "Enterprise",
    "annual_revenue": "$5M-$10M",
    "founded_year": "2020",
    "primary_product": "Project Management Platform",
    "customer_count": 2500,
    "team_engineering": 25,
    "team_sales": 15,
    "team_marketing": 8,
    "team_support": 12
  }
}
'
{
  "errors": [
    {
      "details": "<string>",
      "error": "<string>",
      "error_code": "<string>",
      "message": "<string>"
    }
  ]
}

Headers

​
Content-Type
string
default:application/json
​
Accept
string
default:application/json
​
Authorization
string
default:Token ABC_1234_EFGH_5678
required

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

Body

application/json
​
user_id
string
required

The unique identifier for the user. This is the ID that Userpilot uses to identify the user.

Example:

"123987"

​
metadata
object

Optional user metadata. You can add, remove, or modify any properties as needed for your use case. Note: Only string values are supported (numbers and dates should be sent as strings).

​
company
object

Company information. If provided, company_id is required. Additional company properties are optional metadata.

Response

401 - application/json

Unauthorized - Invalid API key

​
errors
object[]