SDK ReferenceBatch

Process Batch

Start processing a filled batch. Repeated calls return a conflict.

Path parameters

batchIdstringRequired
The batch ID.

Response

Batch processing state
batch_idstringOptional
completed_atstringOptional
created_atstringOptional
ignore_roleslist of enumsOptional
item_countintegerOptional
metadatamap from strings to anyOptional
processed_atstringOptional
progressobjectOptional
statusenumOptional
updated_atstringOptional

Errors

400
Bad Request Error
403
Forbidden Error
404
Not Found Error
409
Conflict Error
500
Internal Server Error