Sign in

v4

latestOpenAPI 3.0.12026-07-131437116.1 KB
Batch

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

Update multiple products in a single request using their internal IDs or unique property values. This batch operation allows for efficient modifications of product records by specifying the properties to be updated. Ensure that the provided property values are correct, as read-only and non-existent properties will result in an error.

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"