v1

latestOpenAPI 3.0.0MIT2026-07-2620028.0 KB
Real-time

Users - Bulk Identify and Update

post/v1/users/bulk_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

Example request

{
  "users": [
    {
      "user_id": "123987",
      "company_id": "company_123"
    }
  ]
}

Response

Accepted - Bulk identify

{"stackTrail":"paths:/v1/users/bulk_identify:post:responses:202:content:application/json:schema:properties:end_time","oasType":"schema","type":"unknown","nullable":true}
file_sizeinteger
filenamestring
job_idstring uri
linksstring style
start_timestring
status'queued' | 'validating' | 'processing' | 'pending_refresh' | 'completed' | 'failed'
total_rowsinteger
typestring