curl --request POST \
--url https://api.hubapi.com/contacts/v1/contact/batch/ \
--header 'Content-Type: application/json' \
--data '
[
{
"vid": "<string>",
"email": "<string>",
"properties": [
{
"property": "<string>",
"value": "<string>"
}
]
}
]
'import requests
url = "https://api.hubapi.com/contacts/v1/contact/batch/"
payload = [
{
"vid": "<string>",
"email": "<string>",
"properties": [
{
"property": "<string>",
"value": "<string>"
}
]
}
]
headers = {"Content-Type": "application/json"}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'Content-Type': 'application/json'},
body: JSON.stringify([
{
vid: '<string>',
email: '<string>',
properties: [{property: '<string>', value: '<string>'}]
}
])
};
fetch('https://api.hubapi.com/contacts/v1/contact/batch/', 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://api.hubapi.com/contacts/v1/contact/batch/",
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([
[
'vid' => '<string>',
'email' => '<string>',
'properties' => [
[
'property' => '<string>',
'value' => '<string>'
]
]
]
]),
CURLOPT_HTTPHEADER => [
"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://api.hubapi.com/contacts/v1/contact/batch/"
payload := strings.NewReader("[\n {\n \"vid\": \"<string>\",\n \"email\": \"<string>\",\n \"properties\": [\n {\n \"property\": \"<string>\",\n \"value\": \"<string>\"\n }\n ]\n }\n]")
req, _ := http.NewRequest("POST", url, payload)
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://api.hubapi.com/contacts/v1/contact/batch/")
.header("Content-Type", "application/json")
.body("[\n {\n \"vid\": \"<string>\",\n \"email\": \"<string>\",\n \"properties\": [\n {\n \"property\": \"<string>\",\n \"value\": \"<string>\"\n }\n ]\n }\n]")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.hubapi.com/contacts/v1/contact/batch/")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request.body = "[\n {\n \"vid\": \"<string>\",\n \"email\": \"<string>\",\n \"properties\": [\n {\n \"property\": \"<string>\",\n \"value\": \"<string>\"\n }\n ]\n }\n]"
response = http.request(request)
puts response.read_body"[ { \"vid\": \"259429\", \"properties\": [ { \"property\": \"firstname\", \"value\": \"Harper\" }, { \"property\": \"lastname\", \"value\": \"Wolfberg\" }, { \"property\": \"website\", \"value\": \" }, { \"property\": \"company\", \"value\": \"HubSpot\" }, { \"property\": \"phone\", \"value\": \"555-122-2323\" }, { \"property\": \"address\", \"value\": \"25 First Street\" }, { \"property\": \"city\", \"value\": \"Cambridge\" }, { \"property\": \"state\", \"value\": \"MA\" }, { \"property\": \"zip\", \"value\": \"02139\" } ] }, { \"email\": \"testingapis@hubspot.com\", \"properties\": [ { \"property\": \"firstname\", \"value\": \"Codey\" }, { \"property\": \"lastname\", \"value\": \"Huang\" }, { \"property\": \"website\", \"value\": \" }, { \"property\": \"company\", \"value\": \"HubSpot\" }, { \"property\": \"phone\", \"value\": \"555-122-2323\" }, { \"property\": \"address\", \"value\": \"25 First Street\" }, { \"property\": \"city\", \"value\": \"Cambridge\" }, { \"property\": \"state\", \"value\": \"MA\" }, { \"property\": \"zip\", \"value\": \"02139\" } ] } ]"Create or update a group of contacts
This endpoint is used to create a group of contacts or update existing ones. Performance is best when batch size is limited to 100 contacts or fewer. Use case for this endpoint: It’s particularly useful for periodic syncs from another contacts database to HubSpot. When using this endpoint, please keep in mind that any errors with a single contact in your batch will prevent the entire batch from processing. If this happens, we’ll return a 400 response with additional details as to the cause. Note: Changes made through this endpoint are processed asynchronously, so can take several minutes for changes to be applied to contact records. Note: The batch size should not exceed 1000 contacts per request.
curl --request POST \
--url https://api.hubapi.com/contacts/v1/contact/batch/ \
--header 'Content-Type: application/json' \
--data '
[
{
"vid": "<string>",
"email": "<string>",
"properties": [
{
"property": "<string>",
"value": "<string>"
}
]
}
]
'import requests
url = "https://api.hubapi.com/contacts/v1/contact/batch/"
payload = [
{
"vid": "<string>",
"email": "<string>",
"properties": [
{
"property": "<string>",
"value": "<string>"
}
]
}
]
headers = {"Content-Type": "application/json"}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'Content-Type': 'application/json'},
body: JSON.stringify([
{
vid: '<string>',
email: '<string>',
properties: [{property: '<string>', value: '<string>'}]
}
])
};
fetch('https://api.hubapi.com/contacts/v1/contact/batch/', 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://api.hubapi.com/contacts/v1/contact/batch/",
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([
[
'vid' => '<string>',
'email' => '<string>',
'properties' => [
[
'property' => '<string>',
'value' => '<string>'
]
]
]
]),
CURLOPT_HTTPHEADER => [
"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://api.hubapi.com/contacts/v1/contact/batch/"
payload := strings.NewReader("[\n {\n \"vid\": \"<string>\",\n \"email\": \"<string>\",\n \"properties\": [\n {\n \"property\": \"<string>\",\n \"value\": \"<string>\"\n }\n ]\n }\n]")
req, _ := http.NewRequest("POST", url, payload)
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://api.hubapi.com/contacts/v1/contact/batch/")
.header("Content-Type", "application/json")
.body("[\n {\n \"vid\": \"<string>\",\n \"email\": \"<string>\",\n \"properties\": [\n {\n \"property\": \"<string>\",\n \"value\": \"<string>\"\n }\n ]\n }\n]")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.hubapi.com/contacts/v1/contact/batch/")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request.body = "[\n {\n \"vid\": \"<string>\",\n \"email\": \"<string>\",\n \"properties\": [\n {\n \"property\": \"<string>\",\n \"value\": \"<string>\"\n }\n ]\n }\n]"
response = http.request(request)
puts response.read_body"[ { \"vid\": \"259429\", \"properties\": [ { \"property\": \"firstname\", \"value\": \"Harper\" }, { \"property\": \"lastname\", \"value\": \"Wolfberg\" }, { \"property\": \"website\", \"value\": \" }, { \"property\": \"company\", \"value\": \"HubSpot\" }, { \"property\": \"phone\", \"value\": \"555-122-2323\" }, { \"property\": \"address\", \"value\": \"25 First Street\" }, { \"property\": \"city\", \"value\": \"Cambridge\" }, { \"property\": \"state\", \"value\": \"MA\" }, { \"property\": \"zip\", \"value\": \"02139\" } ] }, { \"email\": \"testingapis@hubspot.com\", \"properties\": [ { \"property\": \"firstname\", \"value\": \"Codey\" }, { \"property\": \"lastname\", \"value\": \"Huang\" }, { \"property\": \"website\", \"value\": \" }, { \"property\": \"company\", \"value\": \"HubSpot\" }, { \"property\": \"phone\", \"value\": \"555-122-2323\" }, { \"property\": \"address\", \"value\": \"25 First Street\" }, { \"property\": \"city\", \"value\": \"Cambridge\" }, { \"property\": \"state\", \"value\": \"MA\" }, { \"property\": \"zip\", \"value\": \"02139\" } ] } ]"Scope requirements
Scope requirements
クエリパラメータ
A string that allows you to represent these change sources however you'd like.
ボディ
レスポンス
Successful response - This endpoint is used to create a group of contacts or update existing ones
The response is of type object.