Sign in

v4

latestOpenAPI 3.0.12026-07-13113469.4 KB
Batch

Update a batch of leads by internal ID, or unique property values

Update multiple lead records using their internal IDs or unique property values. This endpoint allows batch processing of updates, where each lead's properties can be modified based on the provided input. Ensure that the properties being updated exist on the lead objects to avoid errors.

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

Path parameters

objectTypestring required

Object type.

Request body

Example request

{
  "inputs": [
    {
      "idProperty": "my_unique_property_name"
    }
  ]
}

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"