Batch

Create or update a batch of deals by unique property values

Changed on

Create or update records identified by a unique property value as specified by the idProperty query param. idProperty query param refers to a property whose values are unique for the object.

post/crm/objects/2026-03/0-3/batch/upsert

Request

  • Base URL
    https://api.hubapi.com
  • Auth
    none required

Request body

Response

successful operation

completedAtstring date-time required

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.

startedAtstring date-time required

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

status'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING' required

The status of the batch processing request. The expected value is "COMPLETE".

Changes

  • 2026-03ae1f062de6b3Revision changes
    • info

      the endpoint scheme security oauth2 was removed from the API

  • 2026-038c12e5df4449Revision changes
    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status