Overview
Process multiple records with a single request using batch functionality.
Batch requests allow you to process multiple records within a single API request. Batch processing is completed asynchronously, so when a batch is created, a batch ID will be returned in the response, and this batch ID can be queried periodically to determine the batch's status.

Limitations

  • Batch requests are limited to 100 records per batch. Each batch request will only count as 1 request for the purposes of API call limits, regardless of the number of records in the batch.
  • A batch request is limited to one of the following batch methods for the entire request.

Batch methods

Method name
Description
GET
Retrieve records.
POST
Create records.
PUT
Update records.
DELETE
Delete records.
EXECUTE-WORKFLOW
Execute workflow actions on records.

Batch options

Name
Value
Description
cancelIfRecordFails
true/false
If a record fails to meet criteria to process, do not process any of the records in the batch.

Batch statuses

Status
Description
Created
Batch created.
InProgress
Batch is processing.
Error
Batch resulted in an error.
Cancelled
Batch was cancelled. See cancelIfRecordFails batch option.
Complete
Batch completed successfully.