Skip to main content
POST
/
v1
/
companies
/
bulk_identify
Companies - Bulk Identify and Update
curl --request POST \
  --url https://{environment}.userpilot.io/v1/companies/bulk_identify \
  --header 'Authorization: <authorization>' \
  --header 'Content-Type: application/json' \
  --data '{
  "companies": [
    {
      "company_id": "comp_techstartup_2024",
      "metadata": {
        "subscription_status": "active",
        "subscription_plan": "enterprise",
        "deal_size": "$50,000",
        "monthly_active_users": 1500,
        "platform_usage_score": 85,
        "account_manager": "Sarah Wilson"
      }
    },
    {
      "company_id": "comp_saas_corp_2024",
      "metadata": {
        "subscription_status": "trial",
        "subscription_plan": "pro",
        "deal_size": "$10,000",
        "monthly_active_users": 500,
        "platform_usage_score": 65,
        "account_manager": "Mike Thompson"
      }
    }
  ]
}'
{
  "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
​
companies
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