records.deleteOne
Permanently deletes a specific record from the module using its unique record ID.
records.upsert
The Upsert API allows you to insert a new record or update an existing one based on duplicate check field values.
records.listDeleted
Retrieve the deleted records for the module. This endpoint can retrieve both permanently deleted records and temporarily deleted records from the recycle bin.
records.clone
To clone a record in a module.
records.search
Searches records matching your criteria within a Recruit module. Supports criteria queries, email/phone/word searches. At least one search parameter required. Max 2,000 records, 15 criteria conditions. Newly created records may have indexing delays.
notes.list
Retrieves a list of notes.
notes.create
Creates one or more note records.
notes.update
Updates one or more existing note records. Either note content or note title must be provided (at least one is mandatory) for each note.
notes.delete
Permanently deletes one or more notes using comma-separated note IDs.
notes.get
Retrieves details of a specific note by its ID.
notes.updateOne
Updates a specific note by its ID. Either note content or note title must be provided (at least one is mandatory).
notes.deleteOne
Permanently deletes a specific note by its ID.
attachments.download
Download the file content of a specific attachment by its ID. This endpoint returns the actual file (image, PDF, document, etc.). For link attachments, an error is returned as they cannot be downloaded.
attachments.delete
Delete a link attachment associated with a specific record in a module.
attachments.list
Retrieve all attachments associated with a specific record.
attachments.upload
Upload an attachment by providing either a file or a valid URL. Maximum request body size: 100MB.
related.list
Retrieves a paginated list of records from a specific related list of a parent record in a Recruit module. Supports filtering by fields and conditional requests using If-Modified-Since header.
related.update
Updates multiple related records' specific properties in a specified related list.
related.delink
Removes relationships between a parent record and multiple records in a specified related list, identified by their IDs in the query parameter. This operation deletes only the relationship links, not the actual records themselves. The target records remain intact in their respective modules.
related.get
Retrieves details of a specific record that is related to a parent record. Returns the record data along with pagination information if applicable.
related.updateOne
Updates a specific related record's properties.
related.delinkOne
Deletes the association between a parent record and a specific related record. This operation deletes only the relationship link, not the actual record itself.
related.listDeleted
Retrieves a list of records that were previously related to a parent record but have since been deleted. Useful for audit trails and data recovery scenarios.
related.count
Retrieves the count of related records for a specific parent record. Supports filtering by various criteria including approval status, conversion status, and custom field filters. This operation is useful for analytics and UI display purposes where you need to show counts without fetching the actual related records.
metadata.fields.list
Retrieve all fields metadata for modules. Examples and schemas derived from provided sample and schema files.
metadata.fields.create
To create custom fields in a module in your Zoho Recruit account.
metadata.fields.update
To update custom fields in your Zoho Recruit account.
metadata.fields.get
Retrieve metadata of a specific custom field in a module using the field ID.
metadata.fields.updateOne
Update a Custom Field with related to specific module of Zoho Recruit Account
metadata.fields.delete
Delete a custom field from a module. Field must not be used in workflows, approvals, scoring rules, or other configurations. Only one field can be deleted per request.
users.list
To get all users based on the provided parameters.
users.create
Create a new user in the organization. API exposed to customers
users.update
Update multiple users. API exposed to customers
users.get
To get a single user based on the provided user ID.
users.updateOne
Update single user by ID. API exposed to customers
users.delete
Delete a user by ID. API exposed to customers
coql.query
Executes a COQL select query to fetch records data.
tags.list
to get tags from a module
tags.create
This endpoint is used to create tags
tags.update
Put API with Tag id in request body
tags.updateOne
This endpoint is used to update the tag details
tags.delete
This endpoint is used to delete Tags
org.get
To get the Company Details
metadata.modules.list
Fetches metadata for Recruit modules including configuration, capabilities, and structural information. Supports filtering by feature name to retrieve modules associated with specific features, or by status (e.g., `system_hidden`) to return modules matching that status. When both `status` and `feature_name` are provided, modules must satisfy both criteria (AND logic). Expected latency: ~60ms.
metadata.modules.create
Creates a single custom module in Recruit. Requires the Recruit_Implied_Customize_Zoho_Recruit permission. This operation is not idempotent; submitting the same api_name multiple times will result in validation errors. Only one module can be created per request; batch creation is not supported.
metadata.modules.update
Updates existing modules in Recruit. Allows modification of module labels and profile assignments. This operation is idempotent; the same request can be safely repeated. Supports batch updates - multiple modules can be updated in a single request. Returns 200 when all modules update successfully, or 207 Multi-Status when some succeed and others fail.
metadata.modules.get
Retrieves complete metadata for a specific Recruit module identified by its API name. Returns comprehensive configuration including fields, layouts, profiles, related lists, custom views, and module capabilities.
metadata.modules.updateOne
Partially updates a module's display labels (singular and plural) and associated profile permissions. This operation only modifies the specified fields without affecting other module configuration. The operation is idempotent - calling it multiple times with the same payload produces the same result.
metadata.customViews.list
Get all custom views of a module
metadata.customViews.get
Get a specific custom view of a module using custom view ID
metadata.customViews.changeSort
Change the sort order of a custom view
metadata.customViews.changeSortOne
Change the sort order of a custom view
metadata.relatedLists.list
Get the configuration of related lists for a specific module and layout
metadata.profiles.list
Retrieves the list of Recruit profiles with metadata.
**Scopes:**
* ZohoRecruit.settings.profiles.all
* ZohoRecruit.settings.profiles.read
metadata.profiles.clone
Creates a clone of the specified profile.
**Scopes:**
* ZohoRecruit.settings.profiles.all
* ZohoRecruit.settings.profiles.read
metadata.profiles.get
Retrieves the details of a specific Recruit profile by ID.
**Scopes:**
* ZohoRecruit.settings.profiles.all
* ZohoRecruit.settings.profiles.read
metadata.profiles.updateOne
Updates an existing Recruit profile by ID.
**Scopes:**
* ZohoRecruit.settings.profiles.all
* ZohoRecruit.settings.profiles.read
metadata.profiles.delete
Deletes an existing Recruit profile by ID.
**Scopes:**
* ZohoRecruit.settings.profiles.all
* ZohoRecruit.settings.profiles.delete
metadata.roles.list
Retrieve a list of all Recruit roles in the organization
metadata.roles.create
Create one or more new Recruit roles in the organization
metadata.roles.update
Update multiple Recruit roles in the organization
metadata.roles.get
Retrieve details of a specific Recruit role by its identifier
metadata.roles.updateOne
Update an existing Recruit role with new information
metadata.roles.delete
Delete an existing Recruit role and transfer users to another role
interviews.cancel
Cancel an interview record. Module must be Interviews. The body specifies the reason for cancellation.
candidates.associate
Associate one or more candidates to a target Job Opening, Client, or Contact. The body's `data` array contains `Jobids` (or `Clientids` / `Contactids`) plus `ids` of candidates to associate.
records.listAssociated
Returns the records associated to a given Candidate / Job Opening / Client / Contact. For example, Job Openings associated to a Candidate.
records.changeStatus
Update the status of a record. Works on Offers, Candidates (candidate status), Job Openings, and similar status-bearing modules. The body's `data` array contains the new status value.
submissions.create
Create a Submission record linking a Candidate to a Job Opening for client review.
submissions.changeStatus
Update the status of a Submission (e.g. Submitted, Client Reviewed, Rejected, Hired).
assessments.create
Create an Assessment record (test/quiz attached to a candidate).
assessments.update
Update one or more Assessment records.
reviews.create
Create a Review record (interviewer feedback on a candidate).
reviews.update
Update one or more Review records.
candidates.uploadResume
Upload a resume (PDF/DOCX) and parse it into a new Candidate record.