Actions22
- Record APIs Actions
- Submissions API Actions
- Assessments API Actions
- Reviews APIs Actions
- Notes APIs Actions
- Files & Attachments APIs Actions
- Bulk API Actions
Bulk API → Create Bulk Read Job
AI-generatedSummary
Create a bulk read job in Zoho Recruit to export data asynchronously using either a guided form with module and field selections or raw JSON request body.
Inputs
- Bulk Input Mode — Choose between a guided interface to build the bulk-read job request or provide a raw JSON request body.
- Use Custom Bulk Module — Enable to manually specify a custom module API name instead of selecting from a list (only in guided mode).
- Bulk Module (required) — Select the Zoho Recruit module API name to export data from when using guided mode and not using a custom module.
- Custom Bulk Module (required) — Specify the module API name manually (e.g., Candidates, Contacts) when using custom module option in guided mode.
- Fields — Optionally list specific field API names to include in the export when using guided mode.
- Set Page — Enable to explicitly specify the page number for paginated results in guided mode.
- Page — Page number to export data from, used only if Set Page is enabled in guided mode.
- Filter Type — Choose the filtering mechanism for exported records: none, custom view by CVID, criteria group, or both.
- Custom View ID (CVID) (required) — Provide the custom view ID to filter records when filter type includes CVID.
- Criteria Group Operator — Logical operator (AND/OR) to combine criteria conditions when using criteria filter.
- Criteria Conditions (required) — Define one or more filtering conditions using field API name, comparator, and value when filtering by criteria.
- Show Advanced Options — Reveal additional JSON options for advanced use cases and unsupported Bulk Read keys in guided mode.
- Bulk Advanced Options (JSON) — JSON object with extra keys merged into the request body; guided mode fields take precedence for conflicts.
- Request Body (JSON) (required) — The exact JSON request body sent to the API when using raw JSON input mode.
Output shape
a single record containing the created bulk read job details, including job ID and status
The output includes the API response for the created bulk read job. In guided mode, the node builds the request body from provided parameters; if the request fails due to API pattern matching, it retries with a compatibility fallback format. Errors are reported per item if continue on failure is enabled.
Examples
Example 1: Create a bulk read job using guided input mode selecting the Candidates module, specifying fields and filter criteria.
Set Bulk Input Mode to 'guided', select 'Candidates' as Bulk Module (or enter custom), list fields to export, configure filter type and criteria, and execute to receive the job creation response.
Example 2: Create a bulk read job using raw JSON input mode.
Set Bulk Input Mode to 'rawJson', provide the complete request body JSON as per Zoho Recruit Bulk API specification, and execute to get the job creation response.
