Sign in

v14

latestOpenAPI 3.0.0raw.githubusercontent.com2026-05-279719892.3 MB
Batch

Create or update a batch of objects by unique property values

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/{objectType}/batch/upsert

Path parameters

objectTypestring 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. Can be: "PENDING", "PROCESSING", "CANCELED", or "COMPLETE".