Bulk Insert APIs

Overview

Bulk Insert API allows you to insert a large volume of records efficiently in a form. This API is useful when you need to insert data in bulk from external systems or migrate data into your application, optimizing API usage and reducing overhead.

This is an asynchronous API, which means the data insertion does not happen immediately. Instead, a job is created and processed in the background. You must periodically monitor the job status to track progress and know when the operation is complete.

How it works

Step 1: Create a bulk insert job
Create a bulk insert job using the create job API. This returns a unique identifier (job_id) for further processing and to track the job.

Step 2: Upload the input file
Upload a CSV or ZIP file containing the records using the upload file API.

Step 3: Start the job
Start the job by updating its status using the start/abort job API.

Step 4: Monitor the job
Monitor the job progress by using the get job status API.

Step 5: Download the result
After completion, the result file will be provided. Use the get result file API to download a ZIP file containing a CSV with the operation results.