Sign in

v4

latestOpenAPI 3.0.12026-07-13113470.7 KB
Batch

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

Update a batch of payments by ID (objectId) or unique property value (idProperty). Provided property values will be overwritten. Read-only and non-existent properties will result in an error. Properties values can be cleared by passing an empty string.

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

Path parameters

objectTypestring required

The CRM object type corresponding to the data objects being updated. This is COMMERCE_PAYMENT or 0-101

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 number of errors

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"