The Identify User API allows you to create or update user profiles in real time, either individually or in bulk. Use this API to keep your user data in sync with Userpilot for analytics, segmentation, and personalized experiences.
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 |
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 |
user_id
field is required. If you include a company
object, it must
have at least an id
field.