Sign in

v4

latestOpenAPI 3.0.12026-07-131235214.0 KB
Batch

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

Batch update multiple appointments with a single request.

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

Path parameters

objectTypestring required

objectTypeId of 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 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"