Skip to main content
Zoho Recruit logo
  • Category: hr talent & recruitment
  • Auth: OAUTH2
  • Composio-managed OAuth available? No
  • Tools: 62
  • Triggers: 0
  • Slug: ZOHO_RECRUIT
  • Version: 20261101_00

Tools

Slug: ZOHO_RECRUIT_ADD_TAGS_TO_RECORDSAdd existing tags by name to one or up to 500 records in a Zoho Recruit module. One record uses the live-verified single route; multiple records use the documented bulk route. Inspect every outcome because item failures can appear inside an HTTP success response.

Input Parameters

array
required
Names of existing tags to add to every selected record.
array
required
Record IDs receiving the tags. One ID uses the single-record route; two to 500 IDs use the bulk route.
string
required
Module API name containing the records.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_RECRUIT_ASSOCIATE_CANDIDATES_WITH_JOBSAssociate candidate IDs with job-opening IDs and optionally add a comment. Returns every provider outcome because Zoho can report item-level failures inside a successful HTTP response. This documented mutation was not live-probed.

Input Parameters

array
required
Association groups containing job-opening IDs, candidate IDs, and an optional comment. IDs must be provided as strings.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_RECRUIT_CANCEL_INTERVIEWCancel one scheduled Zoho Recruit interview with an optional reason and feedback. Cancellation is irreversible. Returns the provider outcome because locked candidates, submitted recorded-video interviews, and blueprint-managed interviews cannot be cancelled. This documented mutation was not live-probed.

Input Parameters

string
Optional reason for cancelling the scheduled interview.
string
Optional feedback to record with the interview cancellation.
string
required
Scheduled interview ID to cancel.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_RECRUIT_CHANGE_JOB_OPENING_PIPELINEAssign a different hiring pipeline to one Zoho Recruit job opening and choose whether to migrate its existing stage history. History migration may be irreversible. Returns every provider outcome because business validation can be reported inline.

Input Parameters

string
required
Destination hiring-pipeline ID.
boolean
required
Whether existing stage history should move to the destination hiring pipeline. Migrating history may rewrite it irreversibly.
string
required
Job-opening ID whose assigned hiring pipeline will change.
string
Optional display name of the destination hiring pipeline.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_RECRUIT_CHANGE_OFFER_STATUSChange one Zoho Recruit Offer record’s status. Valid status values and additional required fields depend on the organization’s Offer workflow. The transition may irreversibly trigger workflows, approvals, or notifications. Returns every item outcome because validation errors can appear inside an HTTP 202 response.

Input Parameters

object
Additional account-specific fields required by this Offer status action. Offer_Status is always taken from offer_status.
string
required
Offer record ID whose status will change.
string
required
Destination Offer status configured in the connected Recruit account.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_RECRUIT_CHANGE_RECORD_STATUSChange Candidate, Application, or Job Opening status for one or more record IDs. Returns every provider outcome because Zoho Recruit can report item errors inside a successful HTTP response. Status transitions may irreversibly trigger workflows, approvals, blueprints, or notifications. This documented mutation was not live-probed.

Input Parameters

array
required
Status changes containing string ids, the module-specific status field, optional jobids, and optional comments.
string ("Candidates" | "Applications" | "Job_Openings")
required
Module whose records change status.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_RECRUIT_CREATE_ASSESSMENTSCreate one or more Zoho Recruit assessment definitions, including optional sections and questions, through the v2.1 Assessments API. Inspect every outcome because item validation errors may appear inside a successful HTTP response.

Input Parameters

array
required
Assessment definitions keyed by Zoho Recruit v2.1 API field name. Include Assessment_Name, Category, and Type; optional fields include Rating_Type, Description, and nested $sections.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_RECRUIT_CREATE_NOTESCreate one or more notes attached to Zoho Recruit records. Creating a note with a new title may also create a matching note type. Inspect every outcome because Zoho Recruit can report item validation failures in a successful HTTP response.

Input Parameters

array
required
Notes to create and attach to Zoho Recruit records.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_RECRUIT_CREATE_PIPELINECreate one organization-wide Job Openings hiring pipeline from existing stage and status IDs. The pipeline persists until explicitly changed or deleted; this action does not provide automatic rollback. Setting default to true replaces the organization’s current default pipeline. Include the mandatory Hired, Rejected, and Archived mappings, and inspect every outcome because Zoho Recruit can report validation failures inside a 2xx response.

Input Parameters

array
required
Ordered hiring stages and statuses. Include the mandatory Hired, Rejected, and Archived stage/status mappings.
boolean
Whether to make this the organization’s default hiring pipeline. Setting this to true changes the current organization-wide default.
string
required
Unique display name for the new Job Openings hiring pipeline.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_RECRUIT_CREATE_RECORDSCreate up to 100 records in Candidates, Job Openings, Interviews, Clients, or Contacts. Returns per-record outcomes because Zoho may report validation failures inside an HTTP 200 or 202 response.

Input Parameters

array
required
One to 100 records keyed by tenant-specific field API names. Values may be any JSON type, and each record may include $state as draft or save.
array
Automation triggers such as workflow, approval, or blueprint. Pass an empty list to suppress automation.
string ("Candidates" | "Job_Openings" | "Interviews" | "Clients" | "Contacts")
required
Recruit module API name in which to create records; Applications cannot be created through this endpoint.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_RECRUIT_CREATE_REVIEWSCreate candidate, recruiter, or interviewer reviews with dynamic assessment answers. A review can also change candidate, application, or interview status through $status_info, which may trigger irreversible workflow effects. Inspect every outcome because Zoho Recruit can return validation or permission failures inside HTTP 202 responses.

Input Parameters

array
required
Review objects keyed by Zoho Recruit field API name. Include Rating and the applicable Candidate_Name, Application_Name, or Interview_Name; assessment reviews can include Assessment_Name, $answers, and nested $status_info fields.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_RECRUIT_CREATE_STAGECreate one organization-wide Zoho Recruit hiring stage. This persistent configuration change has no automatic rollback. Zoho Recruit allows at most 10 stages and requires each stage to use a unique name and color combination. Inspect every outcome because limit and duplicate failures can be returned inside an HTTP 202 response.

Input Parameters

string
required
Unique name for the organization-wide hiring stage.
string ("coral" | "violet" | "chocolate" | "gray" | "yellow" | "lightgreen" | "skyblue" | "darkblue" | "darkgreen" | "pink" | "cavernpink" | "blueviolet")
required
Supported Zoho Recruit color assigned to the hiring stage.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_RECRUIT_CREATE_SUBMISSIONSSubmit candidates or applications to a client contact or hiring manager. The selected medium can send email or share content externally, and the toolkit has no proven way to retract it. Inspect every outcome because Zoho Recruit can report item validation errors inside a successful HTTP response.

Input Parameters

array
required
Submission objects keyed by Zoho Recruit field API name. Include Submitted_To and the candidate or application, client or department, and job references required for the chosen submission medium.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_RECRUIT_CREATE_TAGSCreate one or more tags for a Zoho Recruit module. Tag names are limited to 25 characters. Inspect every outcome because Zoho can report item validation failures in a successful HTTP response.

Input Parameters

array
required
Tags to create. Each name must contain 1 to 25 characters.
string
required
Module API name in which to create the tags.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_RECRUIT_DELETE_ATTACHMENTDelete one attachment from a Zoho Recruit record. Returns every provider outcome and preserves the caller-supplied attachment ID as a string. Inspect all_succeeded because item failure can appear inside a successful HTTP response.

Input Parameters

string
required
Zoho Recruit ID of the record containing the attachment.
string
required
Zoho Recruit attachment ID to delete.
string
required
API name of the module containing the parent record.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_RECRUIT_DELETE_NOTESDelete one or more Zoho Recruit notes. One ID uses the single-note route and multiple IDs use the bulk route. Returns every provider outcome; inspect all_succeeded because item failures may appear inside a successful HTTP response.

Input Parameters

array
required
Zoho Recruit note IDs to delete. One ID uses the single-note route; multiple IDs use the bulk route.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_RECRUIT_DELETE_PHOTODelete the photo from a Zoho Recruit Candidate or Contact record.

Input Parameters

string
required
Candidate or Contact record ID whose photo will be deleted.
string ("Candidates" | "Contacts")
required
Photo-owning Zoho Recruit module.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_RECRUIT_DELETE_RECORDSDelete one record or up to 100 records from a Zoho Recruit module. One ID uses the single-record route and multiple IDs use the bulk route. Inspect every outcome because Zoho may report per-record failures inside an HTTP success response.

Input Parameters

string
Reason for deleting Applications records. Required and sent as a query parameter only when module_api_name is Applications.
array
required
Record IDs to delete. One ID uses the single-record route; two to 100 IDs use the bulk route.
boolean
Whether Zoho Recruit deletion workflows should run.
string
required
Recruit module API name containing the records.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_RECRUIT_DELETE_STAGEPermanently delete one Zoho Recruit hiring stage. This destructive action cannot be undone and may affect configured hiring pipelines. Zoho Recruit refuses to delete the organization’s last remaining stage. Inspect every outcome because a validation failure can be returned inside HTTP 202.

Input Parameters

string
required
Unique ID of the hiring stage to permanently delete.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_RECRUIT_DELETE_TAGDelete one tag from Zoho Recruit settings and return the provider’s singular deletion outcome.

Input Parameters

string
required
Zoho Recruit tag ID to delete.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_RECRUIT_DOWNLOAD_ATTACHMENTDownload a file attachment from a Zoho Recruit record. Linked URL attachments cannot be downloaded with this action. Binary success follows the provider’s documented contract but was not live-probed.

Input Parameters

string
required
Zoho Recruit ID of the record containing the attachment.
string
required
File attachment ID returned by List Attachments.
string
required
API name of the module containing the parent record.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_RECRUIT_DOWNLOAD_PHOTODownload the photo for one Zoho Recruit Candidate or Contact. Returns no file when the record has no photo.

Input Parameters

string
required
Zoho Recruit ID of the Candidate or Contact whose photo to download.
string ("Candidates" | "Contacts")
required
Photo-owning module.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_RECRUIT_GET_APPLICATION_PIPELINE_TRANSITIONSGet stage-grouped hiring-pipeline transitions for one Zoho Recruit application. Zoho may require account feature or user permissions beyond the documented OAuth grant for this operation.

Input Parameters

string
required
Application ID whose grouped hiring-pipeline transitions are requested.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_RECRUIT_GET_CUSTOM_VIEWSList a Zoho Recruit module’s custom views or return one custom view with its criteria, sharing details, and selected fields.

Input Parameters

string
Custom-view ID to return. Omit to list every view for the module.
string
required
Module API name whose custom views are requested.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_RECRUIT_GET_MODULE_METADATAGet one Zoho Recruit module’s capabilities, layouts, attachment categories, custom views, and related-list metadata. Use List Fields for field definitions.

Input Parameters

string
required
Module API name to inspect.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_RECRUIT_GET_ORGANIZATIONReturn identity, locale, currency, company, and license details for the connected Zoho Recruit organization.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_RECRUIT_GET_PROFILESList Zoho Recruit permission profiles or return one profile with detailed permissions by ID.

Input Parameters

string
Profile ID to return. Omit to list every permission profile.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_RECRUIT_GET_RECORDGet one Zoho Recruit record, including subform details, by module and record ID.

Input Parameters

string
Comma-separated field API names to return.
string
required
Record ID to retrieve.
string
required
Recruit module API name containing the record.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_RECRUIT_GET_ROLESList all Recruit organization roles or return one role by ID.

Input Parameters

string
Role ID to return. Omit to list every organization role.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_RECRUIT_GET_TAG_RECORD_COUNTGet the number of Zoho Recruit records using a tag and optionally return the areas where the tag is configured.

Input Parameters

string
required
Tag ID whose record usage is counted.
boolean
Whether to include the areas where the tag is configured.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_RECRUIT_IMPORT_CANDIDATE_DOCUMENTImport one resume document into the Zoho Recruit candidate parser using the filename parameter and a base64-encoded multipart document field. Parsing may create candidate records, and the provider does not guarantee that their IDs are returned for cleanup. The complete JSON response object is returned.

Input Parameters

object
required
Resume document to read and send as the base64 document parameter to the Zoho Recruit candidate parser.
string
required
Original resume filename, including its extension.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_RECRUIT_LIST_ASSOCIATED_RECORDSList one page of job openings associated with a candidate or candidates associated with a job opening.

Input Parameters

integer
Provider page number.
integer
Maximum records in this page.
string
required
Candidate or job-opening ID.
string
Filter by job posting title.
string ("Candidates" | "Job_Openings")
required
Side of the association to start from.
string
Comma-separated candidate statuses.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_RECRUIT_LIST_ATTACHMENTSList attachments and linked URLs on one Zoho Recruit record.

Input Parameters

string
required
Parent record ID.
string ("Candidates" | "Applications" | "Job_Openings" | "Interviews" | "Clients" | "Contacts")
required
Parent module API name.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_RECRUIT_LIST_DELETED_RECORDSReturn one provider page of recycle-bin or permanently deleted records from a Zoho Recruit module.

Input Parameters

integer
Provider page number to return.
string ("all" | "recycle" | "permanent")
Deletion class to return. Values must be lowercase; omit to use the provider default.
integer
Maximum deleted records in this page.
string
required
Recruit module API name whose deleted records should be returned.
string
ISO-8601 timestamp for returning recently deleted records.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_RECRUIT_LIST_FIELDSList field API names and metadata for a Zoho Recruit module across layouts. Runtime create validation may impose additional layout requirements.

Input Parameters

string
required
Module API name whose field metadata is requested.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_RECRUIT_LIST_HIRING_PIPELINE_HISTORYReturn one page of hiring-pipeline history for a Candidate, Application, or Job Opening.

Input Parameters

integer
Provider page number.
string
Job-opening ID filter for Candidates only.
string
Transition field used for sorting.
integer
Maximum transitions in this page.
string
required
Record ID whose history is requested.
string ("asc" | "desc")
Sort direction.
string
Candidate ID filter for JobOpenings only.
string ("Candidates" | "Applications" | "JobOpenings")
required
Module API name; JobOpenings is the documented spelling.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_RECRUIT_LIST_MODULESList modules available to the connected user with their API names, access profiles, display fields, and supported operations.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_RECRUIT_LIST_NOTESReturn one page of Zoho Recruit notes. Only admin users can fetch records from the Notes module.

Input Parameters

integer
Provider page number.
integer
Maximum notes in this page.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_RECRUIT_LIST_NOTE_TYPESReturn one page of configured Zoho Recruit note types.

Input Parameters

integer
Provider page number.
integer
Maximum note types in this page.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_RECRUIT_LIST_RECORDSReturn one page of records from Candidates, Applications, Job Openings, Interviews, Clients, or Contacts in Zoho Recruit. Empty responses return an empty data list.

Input Parameters

string
Custom-view ID; provider IDs remain strings.
integer
Provider page number to return.
string ("draft" | "save")
Select draft or saved records.
string
Comma-separated field API names to return.
string
Field API name used to sort records.
string ("true" | "false" | "both")
Filter approval state.
integer
Maximum records in this page.
string ("true" | "false" | "both")
Filter candidate conversion state.
string ("asc" | "desc")
Sort direction used with sort_by.
string
Territory ID used to filter records.
boolean
Include child territories when territory_id is set.
string ("Candidates" | "Applications" | "Job_Openings" | "Interviews" | "Clients" | "Contacts")
required
Recruit module API name to list.
string
ISO-8601 timestamp for conditional retrieval.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_RECRUIT_LIST_STAGESReturn one page of Zoho Recruit hiring stages and the statuses mapped to each stage. Unmapped statuses appear under the Others stage.

Input Parameters

integer
Provider page number to return.
integer
Maximum stages in this page.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_RECRUIT_LIST_TAGSList tags configured for a Recruit module, including counts and the module’s allowed tag count.

Input Parameters

string
required
Module API name whose configured tags are requested.
string
Provider tag ownership filter.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_RECRUIT_LIST_USERSList Recruit users by status group or return the connected current user.

Input Parameters

string ("AllUsers" | "ActiveUsers" | "DeactiveUsers" | "ConfirmedUsers" | "NotConfirmedUsers" | "DeletedUsers" | "ActiveConfirmedUsers" | "AdminUsers" | "ActiveConfirmedAdmins" | "CurrentUser")
required
User group to return. Use CurrentUser to identify the user connected to this account.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_RECRUIT_MERGE_TAGSIrreversibly merge two Zoho Recruit tags and move their associated records under the resulting tag. Provide the primary tag as tag_id and the second tag as conflict_id. Returns the provider outcome.

Input Parameters

string
required
Primary tag ID placed in the merge URL.
string
required
ID of the second tag to merge with the primary tag.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_RECRUIT_REMOVE_TAGS_FROM_RECORDSRemove named tags from one Zoho Recruit record or up to 500 records in a module. Returns every provider outcome; details.tags names the affected tags rather than the tags remaining on each record.

Input Parameters

array
required
Names of existing tags to remove from every requested record.
array
required
Record IDs from which to remove tags. One ID uses the single-record route; two to 500 IDs use the bulk route.
string
required
Recruit module API name containing the records.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_RECRUIT_REVIEW_SUBMISSIONApprove or reject one Zoho Recruit submission with a rating and optional reviewer details. The review decision is not reversible. Returns the provider outcome because archived, previously reviewed, or invalid rating/status combinations may be reported inline.

Input Parameters

integer
required
Review rating from 0 to 5. Approval statuses require 3 to 5; rejection statuses require 0 to 2.
string
required
Submission ID to review.
string
Reviewer client-contact user ID, preserved as a string.
string
Optional reviewer comments. Comments are required when the status is Rejected by hiring manager.
string
required
Submission review status supported by the connected Recruit edition, such as Approved by hiring manager or Rejected by client.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_RECRUIT_REVOKE_BLUEPRINTIrreversibly remove one Zoho Recruit record from its active blueprint process. This cannot be undone. Returns every provider outcome because Zoho Recruit can report CANNOT_PERFORM_ACTION inside a successful HTTP response when the record is not in a blueprint process.

Input Parameters

string
required
ID of the single record to remove from its active blueprint process.
string
required
API name of the module containing the record.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_RECRUIT_SEARCH_RECORDSSearch one Zoho Recruit module using exactly one selector and return one provider page of up to 49 matching records.

Input Parameters

integer
Provider page number to return.
string
Free-text value to search for.
string
Exact email address to search for.
string
Phone number to search for.
string ("true" | "false" | "both")
Approval-state filter.
string
Zoho criteria expression containing at most 10 criteria.
integer
Maximum records to return in this page (1-49).
string ("true" | "false" | "both")
Candidate conversion-state filter.
string ("Candidates" | "Applications" | "Job_Openings" | "Interviews" | "Clients" | "Contacts")
required
Module API name to search.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_RECRUIT_TRANSFER_AND_DELETE_PIPELINEPermanently delete one Zoho Recruit hiring pipeline after transferring all of its associated stages, statuses, and records to a different pipeline. This destructive operation cannot be undone and may run asynchronously.

Input Parameters

string
required
Source pipeline ID. Zoho Recruit permanently deletes this pipeline after transferring its stages, statuses, and records.
string
required
Different destination pipeline ID that receives the source pipeline’s data.
boolean
Whether to update historical status-audit information during the transfer.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_RECRUIT_UPDATE_ASSESSMENTSUpdate one Zoho Recruit assessment by path ID or multiple assessments carrying their own IDs through Recruit v2.1. Returns every provider outcome; inspect all_succeeded because item errors can appear inside a successful HTTP response. This documented mutation was not live-probed because no guaranteed assessment cleanup operation is available.

Input Parameters

string
Single assessment ID. Provide this to update one assessment by path, or omit it to update multiple assessments whose items each contain a string id.
array
required
Assessment updates keyed by Recruit v2.1 field API name. For a single-assessment update, provide exactly one item without id. For a bulk update, every item must contain a non-empty string id.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_RECRUIT_UPDATE_NOTESUpdate one Zoho Recruit note by ID. Returns every provider outcome because note validation failures may be reported within a successful HTTP response.

Input Parameters

array
required
Exactly one note update containing a new title, content, or both. Zoho requires the payload to use a one-item data array.
string
required
ID of the note to update.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_RECRUIT_UPDATE_NOTE_TYPERename one configured Zoho Recruit note type. Inspect every outcome because duplicate names and validation failures may be reported in a successful HTTP response. This documented mutation was not live-probed to avoid renaming account configuration.

Input Parameters

string
required
New name for the note type. It must not duplicate another note type.
string
required
ID of the configured Zoho Recruit note type to rename.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_RECRUIT_UPDATE_PIPELINESUpdate one Zoho Recruit hiring pipeline by path ID or update pipeline definitions carrying their own IDs through the collection route. This can rename pipelines, change the organization default, and add, remove, or reorder stage and status mappings. These configuration changes may be irreversible. Inspect all_succeeded because validation failures can appear inside successful HTTP responses.

Input Parameters

array
required
Pipeline updates. Every item requires its pipeline id and may rename the pipeline, change its default setting, or update stage and status ordering.
string
Optional path ID for a single-pipeline update. When supplied, pipelines must contain exactly one item with the same id. Omit it to use the collection route.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_RECRUIT_UPDATE_RECORDSUpdate one Zoho Recruit record by path ID or up to 100 records carrying their own IDs. Returns every provider validation outcome; inspect all_succeeded rather than assuming an HTTP 2xx response means every item passed.

Input Parameters

array
required
One to 100 dynamic field updates keyed by tenant field API name. For a single-record update, provide exactly one item without id. For a bulk update, every item must contain a non-empty string id.
array
Automation triggers such as workflow, approval, or blueprint. Pass an empty list to suppress these automations.
string
Single record ID. Provide this to update one record by path, or omit it to update multiple records whose items each contain a string id.
string
required
Recruit module API name containing the records.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_RECRUIT_UPDATE_REVIEWSUpdate one owned Zoho Recruit review by path ID or multiple owned reviews carrying their own IDs. Returns every provider outcome because review validation failures may be reported within a successful HTTP response. This documented mutation was not live-probed because it requires probe-owned review fixtures.

Input Parameters

array
required
Owned review updates keyed by Zoho Recruit field API name. A single-review item must omit id; every bulk item must include a non-empty string id.
string
Review ID for a single-review update. Omit it to update multiple reviews whose items each contain a non-empty string id.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_RECRUIT_UPDATE_STAGERename or recolor one existing Zoho Recruit hiring stage. This changes organization-wide configuration and does not provide automatic rollback. Inspect every outcome because validation failures can be returned in a successful HTTP response.

Input Parameters

string
Optional new name for the stage.
string ("coral" | "violet" | "chocolate" | "gray" | "yellow" | "lightgreen" | "skyblue" | "darkblue" | "darkgreen" | "pink" | "cavernpink" | "blueviolet")
Optional supported color to assign to the stage.
string
required
Unique ID of the existing hiring stage to update.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_RECRUIT_UPDATE_TAGRename or recolor one tag in a Zoho Recruit module. Inspect every outcome because validation failures may be returned inside a successful HTTP response.

Input Parameters

string
New tag name, limited to 25 characters. Omit to keep the current name.
string
required
ID of the Zoho Recruit tag to update.
string
New tag color as a six-digit hexadecimal value such as #4A90E2. Omit to keep the current color.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_RECRUIT_UPLOAD_ATTACHMENTAttach either one file or one public URL to a Zoho Recruit record. Choose the attachment category by ID, label, or both. URL mode is live verified; multipart file mode follows the provider’s documented transport contract. Inspect every outcome because Zoho Recruit can report item failures inside a successful HTTP response.

Input Parameters

object
File to upload, excluding .exe files, with a maximum size of 20 MB.
string
required
Zoho Recruit ID of the record that will receive the attachment.
string
Public URL to attach instead of uploading a file.
string
required
API name of the module containing the parent record.
array
Attachment category labels. Provide these, category IDs, or both.
array
Attachment category IDs. Provide these, category labels, or both.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_RECRUIT_UPLOAD_PHOTOUpload one image as the photo for a Zoho Recruit Candidate or Contact. The file is sent as multipart/form-data field file. The multipart success contract is documented but has not been live verified.

Input Parameters

object
required
Image file to upload as the record photo.
string
required
Zoho Recruit ID of the Candidate or Contact that will receive the photo.
string ("Candidates" | "Contacts")
required
Photo-owning Zoho Recruit module.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_RECRUIT_UPSERT_RECORDSInsert or update up to 100 Zoho Recruit records using duplicate-check fields in Candidates, Clients, Contacts, Job Openings, or Interviews.

Input Parameters

array
required
Records keyed by tenant field API name.
array
Automation triggers to run, such as workflow, approval, or blueprint.
string ("Candidates" | "Job_Openings" | "Interviews" | "Clients" | "Contacts")
required
Module API name supporting upsert.
array
Field API names used to detect an existing record.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not