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"
}
}
]
}
'import requests
url = "https://{environment}.userpilot.io/v1/companies/bulk_identify"
payload = { "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"
}
}
] }
headers = {
"Authorization": "<authorization>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: '<authorization>', 'Content-Type': 'application/json'},
body: JSON.stringify({
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'
}
}
]
})
};
fetch('https://{environment}.userpilot.io/v1/companies/bulk_identify', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://{environment}.userpilot.io/v1/companies/bulk_identify",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'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'
]
]
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: <authorization>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://{environment}.userpilot.io/v1/companies/bulk_identify"
payload := strings.NewReader("{\n \"companies\": [\n {\n \"company_id\": \"comp_techstartup_2024\",\n \"metadata\": {\n \"subscription_status\": \"active\",\n \"subscription_plan\": \"enterprise\",\n \"deal_size\": \"$50,000\",\n \"monthly_active_users\": 1500,\n \"platform_usage_score\": 85,\n \"account_manager\": \"Sarah Wilson\"\n }\n },\n {\n \"company_id\": \"comp_saas_corp_2024\",\n \"metadata\": {\n \"subscription_status\": \"trial\",\n \"subscription_plan\": \"pro\",\n \"deal_size\": \"$10,000\",\n \"monthly_active_users\": 500,\n \"platform_usage_score\": 65,\n \"account_manager\": \"Mike Thompson\"\n }\n }\n ]\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "<authorization>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://{environment}.userpilot.io/v1/companies/bulk_identify")
.header("Authorization", "<authorization>")
.header("Content-Type", "application/json")
.body("{\n \"companies\": [\n {\n \"company_id\": \"comp_techstartup_2024\",\n \"metadata\": {\n \"subscription_status\": \"active\",\n \"subscription_plan\": \"enterprise\",\n \"deal_size\": \"$50,000\",\n \"monthly_active_users\": 1500,\n \"platform_usage_score\": 85,\n \"account_manager\": \"Sarah Wilson\"\n }\n },\n {\n \"company_id\": \"comp_saas_corp_2024\",\n \"metadata\": {\n \"subscription_status\": \"trial\",\n \"subscription_plan\": \"pro\",\n \"deal_size\": \"$10,000\",\n \"monthly_active_users\": 500,\n \"platform_usage_score\": 65,\n \"account_manager\": \"Mike Thompson\"\n }\n }\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://{environment}.userpilot.io/v1/companies/bulk_identify")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = '<authorization>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"companies\": [\n {\n \"company_id\": \"comp_techstartup_2024\",\n \"metadata\": {\n \"subscription_status\": \"active\",\n \"subscription_plan\": \"enterprise\",\n \"deal_size\": \"$50,000\",\n \"monthly_active_users\": 1500,\n \"platform_usage_score\": 85,\n \"account_manager\": \"Sarah Wilson\"\n }\n },\n {\n \"company_id\": \"comp_saas_corp_2024\",\n \"metadata\": {\n \"subscription_status\": \"trial\",\n \"subscription_plan\": \"pro\",\n \"deal_size\": \"$10,000\",\n \"monthly_active_users\": 500,\n \"platform_usage_score\": 65,\n \"account_manager\": \"Mike Thompson\"\n }\n }\n ]\n}"
response = http.request(request)
puts response.read_body{
"end_time": null,
"file_size": 123,
"filename": "<string>",
"job_id": "<string>",
"links": "<string>",
"start_time": "<string>",
"total_rows": 123,
"type": "<string>"
}Endpoints
Bulk Companies Update
Create or update multiple company profiles in a single API request using the bulk_identify endpoint.
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"
}
}
]
}
'import requests
url = "https://{environment}.userpilot.io/v1/companies/bulk_identify"
payload = { "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"
}
}
] }
headers = {
"Authorization": "<authorization>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: '<authorization>', 'Content-Type': 'application/json'},
body: JSON.stringify({
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'
}
}
]
})
};
fetch('https://{environment}.userpilot.io/v1/companies/bulk_identify', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://{environment}.userpilot.io/v1/companies/bulk_identify",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'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'
]
]
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: <authorization>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://{environment}.userpilot.io/v1/companies/bulk_identify"
payload := strings.NewReader("{\n \"companies\": [\n {\n \"company_id\": \"comp_techstartup_2024\",\n \"metadata\": {\n \"subscription_status\": \"active\",\n \"subscription_plan\": \"enterprise\",\n \"deal_size\": \"$50,000\",\n \"monthly_active_users\": 1500,\n \"platform_usage_score\": 85,\n \"account_manager\": \"Sarah Wilson\"\n }\n },\n {\n \"company_id\": \"comp_saas_corp_2024\",\n \"metadata\": {\n \"subscription_status\": \"trial\",\n \"subscription_plan\": \"pro\",\n \"deal_size\": \"$10,000\",\n \"monthly_active_users\": 500,\n \"platform_usage_score\": 65,\n \"account_manager\": \"Mike Thompson\"\n }\n }\n ]\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "<authorization>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://{environment}.userpilot.io/v1/companies/bulk_identify")
.header("Authorization", "<authorization>")
.header("Content-Type", "application/json")
.body("{\n \"companies\": [\n {\n \"company_id\": \"comp_techstartup_2024\",\n \"metadata\": {\n \"subscription_status\": \"active\",\n \"subscription_plan\": \"enterprise\",\n \"deal_size\": \"$50,000\",\n \"monthly_active_users\": 1500,\n \"platform_usage_score\": 85,\n \"account_manager\": \"Sarah Wilson\"\n }\n },\n {\n \"company_id\": \"comp_saas_corp_2024\",\n \"metadata\": {\n \"subscription_status\": \"trial\",\n \"subscription_plan\": \"pro\",\n \"deal_size\": \"$10,000\",\n \"monthly_active_users\": 500,\n \"platform_usage_score\": 65,\n \"account_manager\": \"Mike Thompson\"\n }\n }\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://{environment}.userpilot.io/v1/companies/bulk_identify")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = '<authorization>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"companies\": [\n {\n \"company_id\": \"comp_techstartup_2024\",\n \"metadata\": {\n \"subscription_status\": \"active\",\n \"subscription_plan\": \"enterprise\",\n \"deal_size\": \"$50,000\",\n \"monthly_active_users\": 1500,\n \"platform_usage_score\": 85,\n \"account_manager\": \"Sarah Wilson\"\n }\n },\n {\n \"company_id\": \"comp_saas_corp_2024\",\n \"metadata\": {\n \"subscription_status\": \"trial\",\n \"subscription_plan\": \"pro\",\n \"deal_size\": \"$10,000\",\n \"monthly_active_users\": 500,\n \"platform_usage_score\": 65,\n \"account_manager\": \"Mike Thompson\"\n }\n }\n ]\n}"
response = http.request(request)
puts response.read_body{
"end_time": null,
"file_size": 123,
"filename": "<string>",
"job_id": "<string>",
"links": "<string>",
"start_time": "<string>",
"total_rows": 123,
"type": "<string>"
}Headers
API authentication token in the format: Token {{API_KEY}}
Obtain your API key from the Userpilot Environment Settings.
Body
application/json
Show child attributes
Show child attributes
Response
202 - application/json
Accepted - Bulk identify
Was this page helpful?
āI