---
canonical_url: "https://docs.composio.dev/toolkits/zoho_recruit"
markdown_url: "https://docs.composio.dev/toolkits/zoho_recruit.md"
product: "platform"
version: null
last_updated: null
---

# Zoho Recruit

Zoho Recruit is an applicant tracking and recruitment platform for managing candidates, job openings, interviews, applications, and hiring workflows.

- **Category:** hr talent & recruitment
- **Auth:** OAUTH2
- **Composio-managed OAuth available?** No
- **Tools:** 62
- **Triggers:** 0
- **Slug:** `ZOHO_RECRUIT`
- **Version:** 00000000_00

## Tools

### Add Tags To Records

**Slug:** `ZOHO_RECRUIT_ADD_TAGS_TO_RECORDS`

Add 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `tag_names` | array | Yes | Names of existing tags to add to every selected record. |
| `record_ids` | array | Yes | Record IDs receiving the tags. One ID uses the single-record route; two to 500 IDs use the bulk route. |
| `module_api_name` | string | Yes | Module API name containing the records. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Associate Candidates With Jobs

**Slug:** `ZOHO_RECRUIT_ASSOCIATE_CANDIDATES_WITH_JOBS`

Associate 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `associations` | array | Yes | Association groups containing job-opening IDs, candidate IDs, and an optional comment. IDs must be provided as strings. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Cancel Interview

**Slug:** `ZOHO_RECRUIT_CANCEL_INTERVIEW`

Cancel 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `reason` | string | No | Optional reason for cancelling the scheduled interview. |
| `feedback` | string | No | Optional feedback to record with the interview cancellation. |
| `record_id` | string | Yes | Scheduled interview ID to cancel. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Change Job Opening Pipeline

**Slug:** `ZOHO_RECRUIT_CHANGE_JOB_OPENING_PIPELINE`

Assign 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `pipeline_id` | string | Yes | Destination hiring-pipeline ID. |
| `change_history` | boolean | Yes | Whether existing stage history should move to the destination hiring pipeline. Migrating history may rewrite it irreversibly. |
| `job_opening_id` | string | Yes | Job-opening ID whose assigned hiring pipeline will change. |
| `pipeline_display_value` | string | No | Optional display name of the destination hiring pipeline. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Change Offer Status

**Slug:** `ZOHO_RECRUIT_CHANGE_OFFER_STATUS`

Change 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `fields` | object | No | Additional account-specific fields required by this Offer status action. Offer_Status is always taken from offer_status. |
| `offer_id` | string | Yes | Offer record ID whose status will change. |
| `offer_status` | string | Yes | Destination Offer status configured in the connected Recruit account. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Change Record Status

**Slug:** `ZOHO_RECRUIT_CHANGE_RECORD_STATUS`

Change 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `changes` | array | Yes | Status changes containing string ids, the module-specific status field, optional jobids, and optional comments. |
| `module_api_name` | string ("Candidates" | "Applications" | "Job_Openings") | Yes | Module whose records change status. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create Assessments

**Slug:** `ZOHO_RECRUIT_CREATE_ASSESSMENTS`

Create 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `assessments` | array | Yes | 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create Notes

**Slug:** `ZOHO_RECRUIT_CREATE_NOTES`

Create 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `notes` | array | Yes | Notes to create and attach to Zoho Recruit records. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create Pipeline

**Slug:** `ZOHO_RECRUIT_CREATE_PIPELINE`

Create 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `stages` | array | Yes | Ordered hiring stages and statuses. Include the mandatory Hired, Rejected, and Archived stage/status mappings. |
| `default` | boolean | No | Whether to make this the organization's default hiring pipeline. Setting this to true changes the current organization-wide default. |
| `display_value` | string | Yes | Unique display name for the new Job Openings hiring pipeline. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create Records

**Slug:** `ZOHO_RECRUIT_CREATE_RECORDS`

Create up to 100 records in a supported Zoho Recruit module. Returns every per-record outcome because Zoho may report validation failures inside an HTTP 200 or 202 response.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `records` | array | Yes | 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. |
| `trigger` | array | No | Automation triggers such as workflow, approval, or blueprint. Pass an empty list to suppress automation. |
| `module_api_name` | string ("Candidates" | "Job_Openings" | "Interviews" | "Clients" | "Contacts") | Yes | Recruit module API name in which to create records; Applications cannot be created through this endpoint. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create Reviews

**Slug:** `ZOHO_RECRUIT_CREATE_REVIEWS`

Create 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `reviews` | array | Yes | 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create Stage

**Slug:** `ZOHO_RECRUIT_CREATE_STAGE`

Create 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

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

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create Submissions

**Slug:** `ZOHO_RECRUIT_CREATE_SUBMISSIONS`

Submit 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `submissions` | array | Yes | 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create Tags

**Slug:** `ZOHO_RECRUIT_CREATE_TAGS`

Create 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `tags` | array | Yes | Tags to create. Each name must contain 1 to 25 characters. |
| `module` | string | Yes | Module API name in which to create the tags. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete Attachment

**Slug:** `ZOHO_RECRUIT_DELETE_ATTACHMENT`

Delete 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `record_id` | string | Yes | Zoho Recruit ID of the record containing the attachment. |
| `attachment_id` | string | Yes | Zoho Recruit attachment ID to delete. |
| `module_api_name` | string | Yes | API name of the module containing the parent record. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete Notes

**Slug:** `ZOHO_RECRUIT_DELETE_NOTES`

Delete 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `note_ids` | array | Yes | Zoho Recruit note IDs to delete. One ID uses the single-note route; multiple IDs use the bulk route. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete Photo

**Slug:** `ZOHO_RECRUIT_DELETE_PHOTO`

Delete the photo from a Zoho Recruit Candidate or Contact record.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `record_id` | string | Yes | Candidate or Contact record ID whose photo will be deleted. |
| `module_api_name` | string ("Candidates" | "Contacts") | Yes | Photo-owning Zoho Recruit module. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete Records

**Slug:** `ZOHO_RECRUIT_DELETE_RECORDS`

Delete 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

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

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete Stage

**Slug:** `ZOHO_RECRUIT_DELETE_STAGE`

Permanently 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `stage_id` | string | Yes | Unique ID of the hiring stage to permanently delete. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete Tag

**Slug:** `ZOHO_RECRUIT_DELETE_TAG`

Delete one tag from Zoho Recruit settings and return the provider's singular deletion outcome.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `tag_id` | string | Yes | Zoho Recruit tag ID to delete. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Download Attachment

**Slug:** `ZOHO_RECRUIT_DOWNLOAD_ATTACHMENT`

Download 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `record_id` | string | Yes | Zoho Recruit ID of the record containing the attachment. |
| `attachment_id` | string | Yes | File attachment ID returned by List Attachments. |
| `module_api_name` | string | Yes | API name of the module containing the parent record. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Download Photo

**Slug:** `ZOHO_RECRUIT_DOWNLOAD_PHOTO`

Download the photo for one Zoho Recruit Candidate or Contact. Returns no file when the record has no photo.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `record_id` | string | Yes | Zoho Recruit ID of the Candidate or Contact whose photo to download. |
| `module_api_name` | string ("Candidates" | "Contacts") | Yes | Photo-owning module. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Application Pipeline Transitions

**Slug:** `ZOHO_RECRUIT_GET_APPLICATION_PIPELINE_TRANSITIONS`

Get 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `record_id` | string | Yes | Application ID whose grouped hiring-pipeline transitions are requested. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Custom Views

**Slug:** `ZOHO_RECRUIT_GET_CUSTOM_VIEWS`

List a Zoho Recruit module's custom views or return one custom view with its criteria, sharing details, and selected fields.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `custom_view_id` | string | No | Custom-view ID to return. Omit to list every view for the module. |
| `module_api_name` | string | Yes | Module API name whose custom views are requested. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Module Metadata

**Slug:** `ZOHO_RECRUIT_GET_MODULE_METADATA`

Get one Zoho Recruit module's capabilities, layouts, attachment categories, custom views, and related-list metadata. Use List Fields for field definitions.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `module_api_name` | string | Yes | Module API name to inspect. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Organization

**Slug:** `ZOHO_RECRUIT_GET_ORGANIZATION`

Return identity, locale, currency, company, and license details for the connected Zoho Recruit organization.

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Profiles

**Slug:** `ZOHO_RECRUIT_GET_PROFILES`

List Zoho Recruit permission profiles or return one profile with detailed permissions by ID.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `profile_id` | string | No | Profile ID to return. Omit to list every permission profile. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Record

**Slug:** `ZOHO_RECRUIT_GET_RECORD`

Get one Zoho Recruit record, including subform details, by module and record ID.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `fields` | string | No | Comma-separated field API names to return. |
| `record_id` | string | Yes | Record ID to retrieve. |
| `module_api_name` | string | Yes | Recruit module API name containing the record. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Roles

**Slug:** `ZOHO_RECRUIT_GET_ROLES`

List all Recruit organization roles or return one role by ID.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `role_id` | string | No | Role ID to return. Omit to list every organization role. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Tag Record Count

**Slug:** `ZOHO_RECRUIT_GET_TAG_RECORD_COUNT`

Get the number of Zoho Recruit records using a tag and optionally return the areas where the tag is configured.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `tag_id` | string | Yes | Tag ID whose record usage is counted. |
| `configurations` | boolean | No | Whether to include the areas where the tag is configured. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Import Candidate Document

**Slug:** `ZOHO_RECRUIT_IMPORT_CANDIDATE_DOCUMENT`

Import 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `document` | object | Yes | Resume document to read and send as the base64 document parameter to the Zoho Recruit candidate parser. |
| `filename` | string | Yes | Original resume filename, including its extension. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Associated Records

**Slug:** `ZOHO_RECRUIT_LIST_ASSOCIATED_RECORDS`

List one page of job openings associated with a candidate or candidates associated with a job opening.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `page` | integer | No | Provider page number. |
| `per_page` | integer | No | Maximum records in this page. |
| `record_id` | string | Yes | Candidate or job-opening ID. |
| `posting_title` | string | No | Filter by job posting title. |
| `module_api_name` | string ("Candidates" | "Job_Openings") | Yes | Side of the association to start from. |
| `candidate_statuses` | string | No | Comma-separated candidate statuses. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Attachments

**Slug:** `ZOHO_RECRUIT_LIST_ATTACHMENTS`

List attachments and linked URLs on one Zoho Recruit record.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `record_id` | string | Yes | Parent record ID. |
| `module_api_name` | string ("Candidates" | "Applications" | "Job_Openings" | "Interviews" | "Clients" | "Contacts") | Yes | Parent module API name. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Deleted Records

**Slug:** `ZOHO_RECRUIT_LIST_DELETED_RECORDS`

Return one provider page of recycle-bin or permanently deleted records from a Zoho Recruit module.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `page` | integer | No | Provider page number to return. |
| `type` | string ("all" | "recycle" | "permanent") | No | Deletion class to return. Values must be lowercase; omit to use the provider default. |
| `per_page` | integer | No | Maximum deleted records in this page. |
| `module_api_name` | string | Yes | Recruit module API name whose deleted records should be returned. |
| `if_modified_since` | string | No | ISO-8601 timestamp for returning recently deleted records. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Fields

**Slug:** `ZOHO_RECRUIT_LIST_FIELDS`

List field API names and metadata for a Zoho Recruit module across layouts. Runtime create validation may impose additional layout requirements.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `module` | string | Yes | Module API name whose field metadata is requested. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Hiring Pipeline History

**Slug:** `ZOHO_RECRUIT_LIST_HIRING_PIPELINE_HISTORY`

Return one page of hiring-pipeline history for a Candidate, Application, or Job Opening.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `page` | integer | No | Provider page number. |
| `job_id` | string | No | Job-opening ID filter for Candidates only. |
| `sort_by` | string | No | Transition field used for sorting. |
| `per_page` | integer | No | Maximum transitions in this page. |
| `record_id` | string | Yes | Record ID whose history is requested. |
| `sort_order` | string ("asc" | "desc") | No | Sort direction. |
| `candidate_id` | string | No | Candidate ID filter for JobOpenings only. |
| `module_api_name` | string ("Candidates" | "Applications" | "JobOpenings") | Yes | Module API name; JobOpenings is the documented spelling. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Modules

**Slug:** `ZOHO_RECRUIT_LIST_MODULES`

List modules available to the connected user with their API names, access profiles, display fields, and supported operations.

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Notes

**Slug:** `ZOHO_RECRUIT_LIST_NOTES`

Return one page of Zoho Recruit notes.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `page` | integer | No | Provider page number. |
| `per_page` | integer | No | Maximum notes in this page. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Note Types

**Slug:** `ZOHO_RECRUIT_LIST_NOTE_TYPES`

Return one page of configured Zoho Recruit note types.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `page` | integer | No | Provider page number. |
| `per_page` | integer | No | Maximum note types in this page. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Records

**Slug:** `ZOHO_RECRUIT_LIST_RECORDS`

Return one page of records from a supported Zoho Recruit module. Empty modules return an empty data list.

#### Input Parameters

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

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Related Lists

**Slug:** `ZOHO_RECRUIT_LIST_RELATED_LISTS`

Discover related-list API names and route templates available for a Zoho Recruit module.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `module_api_name` | string | Yes | Module API name whose related-list metadata should be returned. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Related Records

**Slug:** `ZOHO_RECRUIT_LIST_RELATED_RECORDS`

Return one page from a named related list such as Notes, Attachments, Interviews, Contacts, or Reviews.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `ids` | string | No | Comma-separated related-record IDs to return. |
| `page` | integer | No | Provider page number. |
| `fields` | string | No | Comma-separated field API names to return. |
| `sort_by` | string | No | Related-record field API name to sort by. |
| `per_page` | integer | No | Maximum records in this page. |
| `record_id` | string | Yes | Parent record ID. |
| `sort_order` | string ("asc" | "desc") | No | Sort direction. |
| `related_module` | string | Yes | Related-list API name from module metadata. |
| `module_api_name` | string | Yes | Parent module API name. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Stages

**Slug:** `ZOHO_RECRUIT_LIST_STAGES`

Return one page of Zoho Recruit hiring stages and the statuses mapped to each stage. Unmapped statuses appear under the Others stage.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `page` | integer | No | Provider page number to return. |
| `per_page` | integer | No | Maximum stages in this page. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Tags

**Slug:** `ZOHO_RECRUIT_LIST_TAGS`

List tags configured for a Recruit module, including counts and the module's allowed tag count.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `module` | string | Yes | Module API name whose configured tags are requested. |
| `my_tags` | string | No | Provider tag ownership filter. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Users

**Slug:** `ZOHO_RECRUIT_LIST_USERS`

List Recruit users by status group or return the connected current user.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `type` | string ("AllUsers" | "ActiveUsers" | "DeactiveUsers" | "ConfirmedUsers" | "NotConfirmedUsers" | "DeletedUsers" | "ActiveConfirmedUsers" | "AdminUsers" | "ActiveConfirmedAdmins" | "CurrentUser") | Yes | User group to return. Use CurrentUser to identify the user connected to this account. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Merge Tags

**Slug:** `ZOHO_RECRUIT_MERGE_TAGS`

Irreversibly 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `tag_id` | string | Yes | Primary tag ID placed in the merge URL. |
| `conflict_id` | string | Yes | ID of the second tag to merge with the primary tag. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Remove Tags From Records

**Slug:** `ZOHO_RECRUIT_REMOVE_TAGS_FROM_RECORDS`

Remove 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `tag_names` | array | Yes | Names of existing tags to remove from every requested record. |
| `record_ids` | array | Yes | Record IDs from which to remove tags. One ID uses the single-record route; two to 500 IDs use the bulk route. |
| `module_api_name` | string | Yes | Recruit module API name containing the records. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Review Submission

**Slug:** `ZOHO_RECRUIT_REVIEW_SUBMISSION`

Approve 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

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

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Revoke Blueprint

**Slug:** `ZOHO_RECRUIT_REVOKE_BLUEPRINT`

Irreversibly 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `record_id` | string | Yes | ID of the single record to remove from its active blueprint process. |
| `module_api_name` | string | Yes | API name of the module containing the record. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Search Records

**Slug:** `ZOHO_RECRUIT_SEARCH_RECORDS`

Search one Zoho Recruit module using exactly one selector and return one provider page of up to 49 matching records.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `page` | integer | No | Provider page number to return. |
| `word` | string | No | Free-text value to search for. |
| `email` | string | No | Exact email address to search for. |
| `phone` | string | No | Phone number to search for. |
| `approved` | string ("true" | "false" | "both") | No | Approval-state filter. |
| `criteria` | string | No | Zoho criteria expression containing at most 10 criteria. |
| `per_page` | integer | No | Maximum records to return in this page (1-49). |
| `converted` | string ("true" | "false" | "both") | No | Candidate conversion-state filter. |
| `module_api_name` | string ("Candidates" | "Applications" | "Job_Openings" | "Interviews" | "Clients" | "Contacts") | Yes | Module API name to search. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Transfer and Delete Pipeline

**Slug:** `ZOHO_RECRUIT_TRANSFER_AND_DELETE_PIPELINE`

Permanently 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `pipeline_id` | string | Yes | Source pipeline ID. Zoho Recruit permanently deletes this pipeline after transferring its stages, statuses, and records. |
| `transfer_to` | string | Yes | Different destination pipeline ID that receives the source pipeline's data. |
| `change_history` | boolean | No | Whether to update historical status-audit information during the transfer. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update Assessments

**Slug:** `ZOHO_RECRUIT_UPDATE_ASSESSMENTS`

Update 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `record_id` | string | No | 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. |
| `assessments` | array | Yes | 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update Notes

**Slug:** `ZOHO_RECRUIT_UPDATE_NOTES`

Update one Zoho Recruit note by ID. Returns every provider outcome because note validation failures may be reported within a successful HTTP response.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `notes` | array | Yes | Exactly one note update containing a new title, content, or both. Zoho requires the payload to use a one-item data array. |
| `note_id` | string | Yes | ID of the note to update. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update Note Type

**Slug:** `ZOHO_RECRUIT_UPDATE_NOTE_TYPE`

Rename 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name` | string | Yes | New name for the note type. It must not duplicate another note type. |
| `note_type_id` | string | Yes | ID of the configured Zoho Recruit note type to rename. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update Pipelines

**Slug:** `ZOHO_RECRUIT_UPDATE_PIPELINES`

Update 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `pipelines` | array | Yes | Pipeline updates. Every item requires its pipeline id and may rename the pipeline, change its default setting, or update stage and status ordering. |
| `pipeline_id` | string | No | 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update Records

**Slug:** `ZOHO_RECRUIT_UPDATE_RECORDS`

Update 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `records` | array | Yes | 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. |
| `trigger` | array | No | Automation triggers such as workflow, approval, or blueprint. Pass an empty list to suppress these automations. |
| `record_id` | string | No | 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. |
| `module_api_name` | string | Yes | Recruit module API name containing the records. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update Reviews

**Slug:** `ZOHO_RECRUIT_UPDATE_REVIEWS`

Update 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `reviews` | array | Yes | 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. |
| `record_id` | string | No | Review ID for a single-review update. Omit it to update multiple reviews whose items each contain a non-empty string id. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update Stage

**Slug:** `ZOHO_RECRUIT_UPDATE_STAGE`

Rename 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name` | string | No | Optional new name for the stage. |
| `color` | string ("coral" | "violet" | "chocolate" | "gray" | "yellow" | "lightgreen" | "skyblue" | "darkblue" | "darkgreen" | "pink" | "cavernpink" | "blueviolet") | No | Optional supported color to assign to the stage. |
| `stage_id` | string | Yes | Unique ID of the existing hiring stage to update. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update Tag

**Slug:** `ZOHO_RECRUIT_UPDATE_TAG`

Rename 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name` | string | No | New tag name, limited to 25 characters. Omit to keep the current name. |
| `tag_id` | string | Yes | ID of the Zoho Recruit tag to update. |
| `color_code` | string | No | New tag color as a six-digit hexadecimal value such as #4A90E2. Omit to keep the current color. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Upload Attachment

**Slug:** `ZOHO_RECRUIT_UPLOAD_ATTACHMENT`

Attach 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `file` | object | No | File to upload, excluding .exe files, with a maximum size of 20 MB. |
| `record_id` | string | Yes | Zoho Recruit ID of the record that will receive the attachment. |
| `attachment_url` | string | No | Public URL to attach instead of uploading a file. |
| `module_api_name` | string | Yes | API name of the module containing the parent record. |
| `attachment_categories` | array | No | Attachment category labels. Provide these, category IDs, or both. |
| `attachment_category_ids` | array | No | Attachment category IDs. Provide these, category labels, or both. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Upload Photo

**Slug:** `ZOHO_RECRUIT_UPLOAD_PHOTO`

Upload 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `file` | object | Yes | Image file to upload as the record photo. |
| `record_id` | string | Yes | Zoho Recruit ID of the Candidate or Contact that will receive the photo. |
| `module_api_name` | string ("Candidates" | "Contacts") | Yes | Photo-owning Zoho Recruit module. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Upsert Records

**Slug:** `ZOHO_RECRUIT_UPSERT_RECORDS`

Insert or update up to 100 Zoho Recruit records by duplicate-check fields without changing record status.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `records` | array | Yes | Records keyed by tenant field API name. |
| `trigger` | array | No | Automation triggers to run, such as workflow, approval, or blueprint. |
| `module_api_name` | string ("Candidates" | "Job_Openings" | "Interviews" | "Clients" | "Contacts") | Yes | Module API name supporting upsert. |
| `duplicate_check_fields` | array | No | Field API names used to detect an existing record. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |