When to Use
Use the HTTP Identify API when:
- Creating users from server-side code (e.g., after signup in your backend)
- Updating user properties without a page load
- Syncing user data from external systems
- Your application doesn’t run in a browser (backend services, mobile apps without SDK)
PII Data NoticeBefore passing any Personally Identifiable Information (PII) such as names, emails, or other sensitive user data to Userpilot:
-
Security & Compliance: Verify internally with your legal, security, and compliance teams that doing so aligns with your organization’s data privacy policies and applicable regulations (e.g., GDPR, CCPA).
-
Data Type Mapping: Ensure correct data type mapping for all properties. Userpilot supports String, Numeric, and Date types. Make sure dates are in ISO8601 format and numeric values are properly formatted. Incorrect type mapping can cause issues with segmentation, analytics, and debugging.
-
Debugging: Proper data formatting is crucial for effective debugging and troubleshooting. Verify that your data maps correctly to Userpilot’s expected formats before implementation.
- Users are interacting with your web application in a browser
- You need to display Userpilot content immediately after identification
Prerequisites
Individual Identify
Endpoint
[POST] https://analytex.userpilot.io/v1/identify
The endpoint URL uses the analytex environment. For EU data residency, use
analytex-eu instead. See Environment
Settings for your specific endpoint. | Header | Value | Required |
|---|
Content-Type | application/json | Yes |
Authorization | Token {YOUR_API_KEY} | Yes |
X-API-Version | 2020-09-22 | Yes |
Request Body
| Field | Type | Required | Description |
|---|
user_id | string | Yes | Unique identifier for the user |
metadata | object | No | Key-value pairs describing the user |
company | object | No | Object with at least an id field for company association |
Example
{
"user_id": "user_001",
"metadata": {
"name": "Jane Doe",
"email": "[email protected]"
},
"company": {
"id": "company_001"
}
}
Response
A successful identification returns HTTP status code 202 Accepted.
The user_id field is required. If you include a company object, it must
have at least an id field.
Bulk Operations
For bulk user identification and updates, see the dedicated documentation:
These articles provide comprehensive details on endpoints, authentication, request/response examples, limitations, best practices, and troubleshooting for large-scale data synchronization.
Common Issues
| Error | Cause | Solution |
|---|
| 401 Unauthorized | Invalid API key | Verify API key (not App Token) from Environment settings |
| 400 Bad Request | Missing user_id | Include user_id field in request body |
| 400 Bad Request | Company without id | If company object included, it must have id field |
| User not appearing | Wrong environment | Verify endpoint matches your environment (US vs EU) |
