v1

latestOpenAPI 3.0.0MIT2026-07-2620028.0 KB

Real-time

Identify

post/v1/identify

Headers

Content-Typestring

Acceptstring

Authorizationstring required

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

Request body

user_idstring required

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

Example request

{
  "user_id": "user_789456",
  "metadata": {
    "name": "Sarah Johnson",
    "email": "sarah.johnson@techstartup.com",
    "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
  }
}