Identify User

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.

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.

Headers

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": "[e-mail]"
  },
  "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:

• Bulk Identify Users - For bulk user operations

These articles provide comprehensive details on endpoints, authentication, request/response examples, limitations, best practices, and troubleshooting for large-scale data synchronization.

---