v5

latestOpenAPI 3.0.12026-07-13133674.3 KB
Batch

Create or update a batch of contacts

Upsert a batch of contacts. The inputs array can contain a properties object to define property values for each record.

post/crm/objects/2026-09/{objectType}/batch/upsert

Path parameters

objectTypestring required

Object Type

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
}