v4

latestOpenAPI 3.0.12026-07-13113471.2 KB

Batch

Create a batch of communications

Create a batch of messages. The inputs array can contain a properties object to define property values for each message, along with an associations array to define associations with other CRM records.

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

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 processing 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 batch operation.

requestedAtstring date-time

The timestamp when the batch request was initially made, in ISO 8601 format.

startedAtstring date-time required

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

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

The status of the batch processing request: "PENDING", "PROCESSING", "CANCELLED", or "COMPLETE"