Skip to main content
POST
/
v1
/
users
/
bulk_identify
Users - Bulk Identify and Update
curl --request POST \
  --url https://{environment}.userpilot.io/v1/users/bulk_identify \
  --header 'Authorization: <authorization>' \
  --header 'Content-Type: application/json' \
  --data '{
  "users": [
    {
      "user_id": "user_123",
      "company_id": "comp_techstartup_2024",
      "metadata": {
        "name": "John Smith",
        "email": "john.smith@techstartup.com",
        "job_title": "Support Manager",
        "tickets_created": "2024-01-15T08:00:00Z",
        "tickets_resolved": "2024-01-15T16:30:00Z",
        "tickets_pending": 3,
        "avg_resolution_time": 3.25,
        "customer_satisfaction": "95%",
        "escalation_count": 10
      }
    },
    {
      "user_id": "user_456",
      "company_id": "comp_techstartup_2024",
      "metadata": {
        "name": "Emma Davis",
        "email": "emma.davis@techstartup.com",
        "job_title": "Support Specialist",
        "tickets_created": "2024-01-15T09:15:00Z",
        "tickets_resolved": "2024-01-15T17:45:00Z",
        "tickets_pending": 5,
        "avg_resolution_time": 4.5,
        "customer_satisfaction": "92%",
        "escalation_count": 8
      }
    }
  ]
}'
{
  "end_time": "<any>",
  "file_size": 123,
  "filename": "<string>",
  "job_id": "<string>",
  "links": "<string>",
  "start_time": "<string>",
  "status": "queued",
  "total_rows": 123,
  "type": "<string>"
}

Headers

​
Content-Type
string
default:application/json
​
Accept
string
default:application/json
​
Authorization
string
default:Token ABC_1234_EFGH_5678
required

API authentication token in the format: Token {{API_KEY}} Obtain your API key from the Userpilot Environment Settings.

Body

application/json
​
users
object[]

Response

202 - application/json

Accepted - Bulk identify

​
end_time
any
​
file_size
integer
​
filename
string
​
job_id
string<uri>
​
links
string<style>
​
start_time
string
​
status
enum<string>
Available options:
queued,
validating,
processing,
pending_refresh,
completed,
failed
​
total_rows
integer
​
type
string