Post /crm/v3/objects/contacts/batch/upsert Upsert

Create or update a batch of contacts

POST/crm/v3/objects/contacts/batch/upsert

Use it in a workflow

Add a step and choose the HubSpot connector.
Pick the Post /crm/v3/objects/contacts/batch/upsert Upsert action (under Contacts).
Fill in the fields below, then reference the result from later steps as {{postCrmV3ObjectsContactsBatchUpsertUpsert.response.data}}.

Request

Request body

Enter the body as JSON in the step's Body field.

inputsarray<object>required

idstringrequired

The unique ID of the object.

idPropertystring

The name of a property whose values are unique for this object

objectWriteTraceIdstring

An identifier for tracing the creation request.

propertiesobjectrequired

Key value pairs representing the properties of the object.

json

{
  "inputs": [
    {
      "id": "string",
      "properties": {},
      "idProperty": "string",
      "objectWriteTraceId": "string"
    }
  ]
}

Response

Returns 200 with an object. Read it in later steps with {{postCrmV3ObjectsContactsBatchUpsertUpsert.response.data.<field>}}.

completedAtstring (date-time)

The timestamp when the batch process was completed, in ISO 8601 format.

linksobject

An object containing relevant links related to the batch request.

requestedAtstring (date-time)

The timestamp when the batch process was initiated, in ISO 8601 format.

resultsarray<object>

archivedbooleanrequired

Whether the object is archived.

archivedAtstring (date-time)

The timestamp when the object was archived, in ISO 8601 format.

createdAtstring (date-time)required

The timestamp when the object was created, in ISO 8601 format.

idstringrequired

The unique ID of the object.

newbooleanrequired

Whether the property is new.

objectWriteTraceIdstring

An identifier for tracing the creation request.

propertiesobjectrequired

Key value pairs representing the properties of the object.

propertiesWithHistoryobject

Key-value pairs representing the properties of the object along with their history.

updatedAtstring (date-time)required

The timestamp when the object was last updated, in ISO 8601 format.

urlstring

The URL associated with the object.

warningsarray<object>3 fields

startedAtstring (date-time)

The timestamp when the batch process began execution, in ISO 8601 format.

statusstring

The status of the batch processing request. Can be: "PENDING", "PROCESSING", "CANCELED", or "COMPLETE".

One ofCANCELEDCOMPLETEPENDINGPROCESSING

json

{
  "completedAt": "2025-01-01T00:00:00Z",
  "results": [
    {
      "archived": false,
      "createdAt": "2025-01-01T00:00:00Z",
      "id": "string",
      "new": false,
      "properties": {},
      "updatedAt": "2025-01-01T00:00:00Z",
      "archivedAt": "2025-01-01T00:00:00Z",
      "objectWriteTraceId": "string",
      "propertiesWithHistory": {},
      "url": "string",
      "warnings": [
        {
          "category": "string",
          "context": {},
          "message": "string"
        }
      ]
    }
  ],
  "startedAt": "2025-01-01T00:00:00Z",
  "status": "CANCELED",
  "links": {},
  "requestedAt": "2025-01-01T00:00:00Z"
}

Need more? See the HubSpot guide for connection setup and behaviour shared by every action.

Was this page helpful?