Create Bulk Insert job

Table of Contents

Overview

This API creates a new bulk insert job for processing records. It defines the job and prepares the system to receive the input file for processing.

Request Details

Request URL

https://<base_url>/creator/v2.1/bulk/<account_owner_name>/<app_link_name>/form/<form_link_name>/insert

Request method

POST

Header

KeyValueDescription
Authorization

Zoho-oauthtoken10

00.8cb99dxxxxx

xxxxxxxx9be93.9b

8xxxxxxxxxxxxxxxf

An authentication token (oauthtoken) allows users to access apps and APIs without entering their login credentials each time.
environmentdevelopment/stageSpecifies the environment.

Scope

scope=ZohoCreator.bulk.CREATE

where,

base_urlthe base URL of your Creator account
For example, it's www.zohoapis.com if your account belongs to Zoho's US DC, and is www.zohoapis.eu if it belongs to Zoho's EU DC.
account_owner_namethe username of the Creator account's owner
app_link_namethe link name of the target application
form_link_namethe link name of the target form

Response Structure

details JSON 
  • object - Contains the details of the bulk insert job.
  • created_time (string) - Specifies the date and time when the bulk insert job was created.
  • job_id (string) - A unique identifier assigned to a bulk insert job. This job_id should be used in all subsequent insert API requests related to that job.
  • created_by (string) - Specifies the name of the user who created the bulk insert job. Sample - "created_by": "jason18".
  • status (string) - Specifies the status of the bulk insert job. Example, "state": "CREATED".

Note: To know about the Bulk API limits, refer this page.

Sample Request

CurlDelugeJavaJavaScriptPython
Copiedcurl "https://www.zohoapis.com/creator/v2.1/bulk/jason18/zylker-store/form/Employee_Details/insert" \
  -X POST \
  -H "Authorization: Zoho-oauthtoken 1000.8cb99dxxxxxxxxxxxxx9be93.9b8xxxxxxxxxxxxxxxf"
Copiedresponse = invokeUrl [
  url: "https://www.zohoapis.com/creator/v2.1/bulk/jason18/zylker-store/form/Employee_Details/insert",
  type: POST,
  connection: "creatorconnection"
];

CopiedHttpUrl.Builder urlBuilder = HttpUrl.parse(
  "https://www.zohoapis.com/creator/v2.1/bulk/jason18/zylker-store/form/Employee_Details/insert"
).newBuilder();

Request request = new Request.Builder()
  .url(urlBuilder.toString())
  .method("POST", RequestBody.create("", null))
  .addHeader("Authorization", "Zoho-oauthtoken 1000.8cb99dxxxxxxxxxxxxx9be93.9b8xxxxxxxxxxxxxxxf")
  .build();

Response response = client.newCall(request).execute();

Copiedlet api_headers = {
  "Authorization": "Zoho-oauthtoken 1000.8cb99dxxxxxxxxxxxxx9be93.9b8xxxxxxxxxxxxxxxf"
};

fetch("https://www.zohoapis.com/creator/v2.1/bulk/jason18/zylker-store/form/Employee_Details/insert", {
  method: "POST",
  headers: api_headers
});

Copiedapi_headers = {
  "Authorization": "Zoho-oauthtoken 1000.8cb99dxxxxxxxxxxxxx9be93.9b8xxxxxxxxxxxxxxxf"
}

response = requests.post(
  "https://www.zohoapis.com/creator/v2.1/bulk/jason18/zylker-store/form/Employee_Details/insert",
  headers=api_headers
)

Sample Response

Copied {
       "code": 3000,
       "details": {
           "created_time": "04-Aug-2025 18:54:00",
           "id": "2000000018002",
           "operation": "insert",
           "created_by": "jason18",
           "status": "CREATED"
       }
   }