Create or update a group of contacts

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>"
      }
    ]
  }
]
'

"[ { \"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.

POST

contacts

contact

batch

Create or update a group of contacts

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>"
      }
    ]
  }
]
'

"[ { \"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

Query Parameters

auditId

string

A string that allows you to represent these change sources however you'd like.

Body

application/json

vid

string

Contact ID for updating existing contact.

string

Email address for identifying contact.

properties

object[]

Show child attributes

Response

202 - application/json

Successful response - This endpoint is used to create a group of contacts or update existing ones

The response is of type object.