Create a bulk read job

POST/read

Use it in a workflow

Add a step and choose the Zoho CRM connector.
Pick the Create a bulk read job action (under Bulk Read).
Fill in the fields below, then reference the result from later steps as {{createABulkReadJob.response.data}}.

Request

Request body

Enter the body as JSON in the step's Body field.

callbackobject

Specify the callback configuration to receive a POST notification when the bulk read job completes or fails.

urlstring (uri)required

Specify a valid URL that accepts HTTP POST requests to receive the bulk read job completion notification.

methodstringrequired

Specify the HTTP method for the callback request. Possible values: **post** - Sends the callback notification as an HTTP POST request.

One ofpost

queryobjectrequired

Specify the query parameters for the bulk read job, including the target module, optional field selection, optional Custom View, and optional filter criteria.

moduleobjectrequired1 fields

Specify the CRM module from which to export records. Refer to the [Get Modules](modules.json#$.paths./settings/modules.get) resource for valid values.

cvidstring | null

Represents the unique ID of the Custom View to filter records for the bulk read job. Refer to the [Get Custom Views](custom_views.json#$.paths./settings/custom_views.get) resource for valid values.

fieldsarray<string>

Specify the list of field API names to include in the exported records. Refer to the [Get Fields](fields.json#$.paths./settings/fields.get) resource for valid values. **Note:** If exporting Events as an **ICS file**, do not include this key.

pageinteger | null

Specify the page number of records to export in the bulk read job. The default value is **1** and means that the first **200,000** records matching your query will get exported. If you want to fetch the records from the range **200,001 to 400,000**, then mention the value as **'2'.**

criteriaobject2 fields

Specify the filter criteria to narrow down the records exported in the bulk read job.

file_typestring

Specify the file format for the exported records. Possible values: **csv** - Exports records in CSV format. **ics** - Exports records in ICS format, applicable only when exporting from the **Events** module.

One ofcsvics

json

{
  "query": {
    "module": {
      "api_name": "string"
    },
    "cvid": "string",
    "fields": [
      "string"
    ],
    "page": 0,
    "criteria": {
      "group_operator": "or",
      "group": [
        {
          "field": {
            "api_name": "string"
          },
          "value": "string",
          "comparator": "equal",
          "type": "value"
        }
      ]
    }
  },
  "callback": {
    "url": "string",
    "method": "post"
  },
  "file_type": "csv"
}

Response

Returns 201 with an object. Read it in later steps with {{createABulkReadJob.response.data.<field>}}.

dataarray<object>

Represents the list of job creation result objects.

statusstringrequired

Represents the status of the job creation request. Possible values: **success** - Zoho CRM created the bulk read job successfully.

One ofsuccess

codestringrequired

Represents the status code for the job creation result. Possible values: **ADDED_SUCCESSFULLY** - Zoho CRM created the bulk read job successfully.

One ofADDED_SUCCESSFULLY

messagestringrequired

Represents the result message for the job creation. Possible values: **Added successfully.** - Zoho CRM created the bulk read job successfully.

One ofAdded successfully.

detailsobjectrequired5 fields

Represents the details of the newly created bulk read job.

infoobject

Represents additional metadata about the bulk read job creation response.

json

{
  "data": [
    {
      "status": "success",
      "code": "ADDED_SUCCESSFULLY",
      "message": "Added successfully.",
      "details": {
        "id": "string",
        "operation": "read",
        "state": "COMPLETED",
        "created_by": {
          "id": "string",
          "name": "string"
        },
        "created_time": "2025-01-01T00:00:00Z"
      }
    }
  ],
  "info": {}
}

Need more? See the Zoho CRM guide for connection setup and behaviour shared by every action.

Was this page helpful?