Skip to main content

​
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

HeaderValueRequired
Content-Typeapplication/jsonYes
AuthorizationToken {YOUR_API_KEY}Yes
X-API-Version2020-09-22Yes

​
Request Body

FieldTypeRequiredDescription
user_idstringYesUnique identifier for the user
metadataobjectNoKey-value pairs describing the user
companyobjectNoObject with at least an id field for company association

​
Example

{
  "user_id": "user_001",
  "metadata": {
    "name": "Jane Doe",
    "email": "jane@example.com"
  },
  "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.