Sign in

v4

latestOpenAPI 3.0.12026-07-13113471.2 KB
Batch

Create or update a batch of communications 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-09/{objectType}/batch/upsert

Path parameters

objectTypestring required

The type of CRM object to query. Supported values include 'CONTACT' (0-1), 'TICKET' (0-5), 'DEAL' (0-3), 'COMPANY' (0-2), or custom object type IDs.

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.

numErrorsinteger

The total number of errors that occurred during the operation.

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".

Example response

{
  "numErrors": 10
}