How To: Create & Update Entities In Batch
For information about prerequisites, see Integrate with Entities. Batch endpoints are provided to create and update Entities in batches. The Batch endpoints support two methods to supply the Entity data:
- JSON
- CSV file upload
To create Entities in batch, call the Create Batch Request endpoint and specify the entityTypePluralName in the path parameter.
Learn more about the necessary attributes listed for creating Entities in Batch using the JSON.
The following examples show a request body for creating a Batch Entities request:
To create Entities in batch through CSV, call the File Upload Create Request endpoint and specify entityTypePluralName in the path parameter. Upload the CSV file with all the details as shown in the sample CSV.
To update Entities in batch, call the Update Batch Request endpoint and specify entityTypePluralName in the path parameter. The following examples show a request body for updating a Batch Entity request:
To update Entities in batch through CSV, call the File Upload to Update Entities Request endpoint and specify entityTypePluralName in the path parameter. Upload the CSV file with all the details as shown in the sample CSV.
To retrieve the information about Entities in Batch processing, call the Get the Status of Batch Request endpoint and pass the entityTypePluralName, BatchId in the path parameter. This process is common to both JSON and CSV-based APIs.