--- canonical_url: "https://docs.composio.dev/toolkits/zoho_people" markdown_url: "https://docs.composio.dev/toolkits/zoho_people.md" product: "platform" version: null last_updated: null --- # Zoho People Zoho People is a cloud HR platform for employee records, leave, attendance, shifts, timesheets, performance, files, learning, compensation, and HR workflows. - **Category:** human resources - **Auth:** OAUTH2 - **Composio-managed OAuth available?** No - **Tools:** 160 - **Triggers:** 0 - **Slug:** `ZOHO_PEOPLE` - **Version:** 00000000_00 ## Tools ### Add leave balance **Slug:** `ZOHO_PEOPLE_ADD_LEAVE_BALANCE` Add legacy leave balance for the documented employees and leave types. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `date_format` | string | No | Format used by each balance date; organization format is used when omitted. | | `balance_data` | object | Yes | Employee IDs mapped to leave type IDs and dated balance changes. | #### 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 | ### Add LMS trainers **Slug:** `ZOHO_PEOPLE_ADD_LMS_TRAINERS` Add the supplied employees as Zoho People LMS trainers. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `employee_record_numbers` | array | Yes | Employee record numbers to add as LMS trainers. | #### 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 | ### Add timer comment **Slug:** `ZOHO_PEOPLE_ADD_TIMER_COMMENT` Add a comment to a legacy time log or timer. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `comment` | string | Yes | Specify the comment | | `time_log_id` | string | Yes | Specify the timeLogId | #### 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 | ### Apply hourly permission **Slug:** `ZOHO_PEOPLE_APPLY_HOURLY_PERMISSION` Submit an hourly-permission request. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `date` | string | Yes | Permission date in organization format. | | `reason` | string | No | Reason for the permission request. | | `to_time` | integer | Yes | Permission end time in minutes from midnight. | | `from_time` | integer | Yes | Permission start time in minutes from midnight. | | `permission_id` | string | Yes | Configured permission type ID. | | `employee_record_number` | string | Yes | Employee record number. | #### 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 | ### Approve on-duty request **Slug:** `ZOHO_PEOPLE_APPROVE_ON_DUTY_REQUEST` Approve or reject an on-duty request using the documented decision fields. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `record_id` | string | Yes | On-duty record ID. | | `approval_status` | integer ("0" | "1") | Yes | Decision: 0 rejected or 1 approved. | | `detail_decisions` | object | No | On-duty detail IDs mapped to rejection or approval decisions. | #### 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 | ### Approve timesheet **Slug:** `ZOHO_PEOPLE_APPROVE_TIMESHEET` Approve or reject one legacy timesheet using the documented decision fields. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `comments` | string | No | Specify the approval comments. | | `time_logs` | object | No | Map time-log IDs to typed approval decisions. Omit it to apply approval_status to every time log in the timesheet. | | `timesheet_id` | string | Yes | Specify the timesheet Id | | `approval_status` | string ("approved" | "rejected") | Yes | Specify the approval status | | `is_all_level_approve` | boolean | No | false | To approve the timesheet on behalf of all the approvers. | #### 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 | ### Bulk cancel leave requests **Slug:** `ZOHO_PEOPLE_BULK_CANCEL_LEAVE_REQUESTS` Cancel the explicitly supplied set of V3 leave request IDs. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `leave_cancellation_data` | array | Yes | Leave IDs and cancellation reasons; at most 200 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 | ### Cancel compensatory request **Slug:** `ZOHO_PEOPLE_CANCEL_COMPENSATORY_REQUEST` Cancel a V3 compensatory-off request by record ID. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `record_id` | string | Yes | Compensatory request record 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 | ### Cancel hourly permission **Slug:** `ZOHO_PEOPLE_CANCEL_HOURLY_PERMISSION` Cancel an hourly-permission request by record and form ID. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `form_id` | string | Yes | Permission form ID. | | `record_id` | string | Yes | Permission record 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 | ### Cancel leave grant **Slug:** `ZOHO_PEOPLE_CANCEL_LEAVE_GRANT` Cancel a V3 leave grant request by record ID. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `record_id` | string | Yes | Leave grant record 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 | ### Cancel leave request **Slug:** `ZOHO_PEOPLE_CANCEL_LEAVE_REQUEST` Cancel one V3 leave request by record ID. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `reason` | string | No | Reason for cancellation. | | `record_id` | string | Yes | Leave request record 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 | ### Cancel on-duty request **Slug:** `ZOHO_PEOPLE_CANCEL_ON_DUTY_REQUEST` Cancel an on-duty request using the documented record fields. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `form_id` | string | Yes | On-duty form ID. | | `on_duty_id` | string | Yes | On-duty record 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 | ### Create and tag employee KRAs **Slug:** `ZOHO_PEOPLE_CREATE_AND_TAG_EMPLOYEE_KRAS` Create a KRA and tag it to selected employees in one Zoho operation. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `kra_name` | string | Yes | KRA name. | | `employees` | array | Yes | Employee record identifiers to receive the KRA. | | `weightage` | number | No | KRA weightage. | | `description` | string | No | KRA description. | | `include_in_library` | boolean | No | Whether to add the KRA to the organization library. | #### 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 attendance entries **Slug:** `ZOHO_PEOPLE_CREATE_ATTENDANCE_ENTRIES` Create attendance entries using the V3 provider-native batch contract. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `punch_details` | array | Yes | Attendance entries to create. | | `datetime_format` | string | Yes | Timestamp format, such as yyyy-MM-dd HH:mm:ss. | | `entries_timezone` | string | No | Timezone in which supplied entry timestamps were recorded. | | `storage_timezone` | string | No | Timezone in which Zoho People should store the entries. | #### 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 attendance regularization **Slug:** `ZOHO_PEOPLE_CREATE_ATTENDANCE_REGULARIZATION` Submit an attendance regularization request using the documented legacy contract. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | object | Yes | Regularization details keyed by organization-formatted date; used by addData. | | `period` | string ("Day" | "Week" | "Month") | No | Regularization period. | | `end_date` | string | Yes | Last regularization date in organization format. | | `operation` | string | No | Create a regularization request. | | `start_date` | string | Yes | First regularization date in organization format. | | `employee_record_number` | string | No | Employee record number; applicable to administrators. | | `approver_employee_record_number` | string | No | Chosen approver record number when company settings require it. | #### 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 compensatory request **Slug:** `ZOHO_PEOPLE_CREATE_COMPENSATORY_REQUEST` Create a V3 compensatory-off request. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `unit` | string ("Days" | "Hours") | Yes | Compensatory request unit. | | `reason` | string | No | Reason for the request. | | `duration` | string | Yes | For Days, FULL_DAY, HALF_DAY, or QUARTER_DAY; for Hours, HH:MM or a numeric number of hours. | | `expiry_date` | string | No | Compensatory request expiry date. | | `worked_date` | string | Yes | Date on which the employee worked. | | `worked_time_to` | string | No | Worked end time in HH:MM format. | | `employee_zoho_id` | string | Yes | Employee Zoho record number. | | `worked_time_from` | string | No | Worked start time in HH:MM format. | #### 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 employee salary **Slug:** `ZOHO_PEOPLE_CREATE_EMPLOYEE_SALARY` Add a salary record for an employee. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `date_format` | string | Yes | Date format used by the effective date, such as dd-MMM-yy. | | `breakup_data` | string | No | JSON array of component rows. For salary creation this may be omitted; when salary structure is enabled, Zoho uses the selected package breakup. | | `revision_data` | string | Yes | JSON object containing employee, revised CTC, effective date, reason, and currency. | #### 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 file folder **Slug:** `ZOHO_PEOPLE_CREATE_FILE_FOLDER` Create a Zoho People V3 file folder. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `latitude` | string | No | Request latitude. | | `longitude` | string | No | Request longitude. | | `folder_name` | string | Yes | Name of the folder to create. | | `parent_folder` | string | No | Parent folder ID, omitted for a root folder. | #### 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 form record **Slug:** `ZOHO_PEOPLE_CREATE_FORM_RECORD` Create a record in a supported Zoho People form or create an employee record. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `is_draft` | boolean | No | Whether to save the general form record as a draft. | | `password` | string | No | Initial password; required when is_direct_add is true. | | `input_data` | string | Yes | JSON object of form label names and values accepted by the selected Zoho form. | | `is_non_user` | boolean | No | Whether to add an employee profile without adding a user account. | | `record_type` | string ("form_record" | "employee") | Yes | Select a general form record or the dedicated employee record contract. | | `is_direct_add` | boolean | No | Whether to add the employee directly with active status instead of sending an invitation. | | `form_link_name` | string | No | Form link name; required only for record_type form_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 | ### Create HR process record **Slug:** `ZOHO_PEOPLE_CREATE_HR_PROCESS_RECORD` Create a V3 HR process record for selected employees using documented process data. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | object | Yes | Typed process field values keyed by their Zoho field API names. | | `reason` | string | Yes | Reason for starting this HR process. | | `process_id` | string | Yes | Zoho People HR process definition ID to start. | | `employee_ids` | array | Yes | Zoho employee IDs for whom the process is created. | | `effective_date` | string | Yes | Effective date in the format configured for the 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 | ### Create job schedule **Slug:** `ZOHO_PEOPLE_CREATE_JOB_SCHEDULE` Create a legacy job schedule and optionally publish it. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `date` | string | Yes | Schedule date in yyyy-MM-dd format. | | `job_id` | string | Yes | Specify the Job Id | | `totime` | string | Yes | Schedule end time in 24-hour HH:mm format. | | `fromtime` | string | Yes | Schedule start time in 24-hour HH:mm format. | | `is_repeat` | boolean | No | false | Specify if the job schedule needs to be repeated | | `is_publish` | boolean | No | false | Specify if the job schedule needs to be published | | `assigned_to` | string | No | Specify the user for whom the job schedule needs to be added | | `description` | string | No | Specify the description of the job schedule | | `repeat_type` | string ("daily" | "weekly" | "monthly") | No | monthly> | Specify how often the job schedule should be repeated based on the repeat interval | | `repeat_until` | string | No | Last date in the repeat series, in yyyy-MM-dd format. | | `repeat_interval` | integer ("1" | "2" | "3" | "4" | "5" | "6" | "7" | "8" | "9" | "10" | "11" | "12") | No | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 10 | 11 | 12> | Specify the interval for which the job schedule needs to be repeated | | `skip_max_log_hrs_validation` | boolean | No | false | This key will be considered only if maximum log hours restriction is enabled in the settings. Specify true if the scheduled hours can exceed the maximum log hours configured in the settings | #### 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 leave grant **Slug:** `ZOHO_PEOPLE_CREATE_LEAVE_GRANT` Create a V3 leave grant request. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `reason` | string | No | Reason for the grant request. | | `grant_count` | number | No | Number of days or hours to grant. | | `leave_type_id` | string | No | Grant leave type ID. | | `employee_zoho_id` | string | No | Employee Zoho record number. | | `effective_from_date` | string | No | Date from which the grant takes effect. | | `supporting_document` | object | No | Supporting document with file_id, source, and file_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 | ### Create leave request **Slug:** `ZOHO_PEOPLE_CREATE_LEAVE_REQUEST` Create a V3 leave request. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `days` | object | No | Per-date leave count, session, and time details. | | `unit` | string ("Days" | "Hours") | Yes | Leave unit. | | `reason` | string | No | Reason for the leave request. | | `to_date` | string | Yes | Leave end date. | | `from_date` | string | Yes | Leave start date. | | `approver_id` | string | No | Approver Zoho record number when employees choose an approver. | | `employee_id` | string | No | Employee ID. | | `custom_fields` | object | No | Custom leave-form field API names mapped to scalar values. Standard request parameter names are not allowed. | | `leave_type_id` | string | Yes | Leave type ID. | | `employee_zoho_id` | string | No | Employee Zoho record number. | | `employee_email_id` | string | No | Employee email address. | #### 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 leave setting **Slug:** `ZOHO_PEOPLE_CREATE_LEAVE_SETTING` Create a V3 holiday, pay-period policy, or work calendar using a closed typed contract. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `days` | object | No | Per-date holiday count and session details. | | `name` | string | No | Pay-period policy name. | | `to_date` | string | No | Holiday end date. | | `frequency` | string ("WEEKLY" | "MONTHLY" | "HALF_MONTHLY") | No | Pay-period frequency: WEEKLY, MONTHLY, or HALF_MONTHLY. | | `from_date` | string | No | Holiday start date. | | `operation` | string ("holiday" | "pay_period_policy" | "work_calendar") | Yes | Setting type to create. | | `description` | string | No | Holiday description. | | `location_id` | string | No | Location ID for the work calendar. | | `holiday_name` | string | No | Holiday name. | | `calendar_year` | object | No | Custom calendar start and optional end date. | | `email_reminder` | object | No | Email reminder template and lead days. | | `is_custom_year` | boolean | No | Use a custom calendar year. | | `week_start_day` | string | No | First day of the work week. | | `weekend_pattern` | array | No | Weekend pattern objects encoded by Zoho as a JSON array. | | `notify_via_feeds` | boolean | No | Notify employees through feeds. | | `employee_shift_ids` | array | No | Applicable shift IDs. | | `pay_period_end_day` | string | No | Day on which the pay period ends. | | `payroll_cutoff_day` | string | No | Payroll cutoff day. | | `applicable_role_ids` | array | No | Role IDs to which the policy applies. | | `employee_location_ids` | array | No | Applicable location IDs. | | `is_restricted_holiday` | boolean | No | Whether this is a restricted holiday. | | `statutory_weekend_days` | array | No | Statutory weekend day names. | | `applicable_location_ids` | array | No | Location IDs to which the policy applies. | | `lock_data_on_cutoff_day` | boolean | No | Lock attendance data on cutoff day. | | `convert_absences_to_leave` | object | No | Absence-to-leave conversion configuration. | | `enable_encashment_process` | boolean | No | Enable leave encashment processing. | | `holiday_classification_id` | string | No | Holiday classification ID. | | `second_payroll_cutoff_day` | string | No | Second payroll cutoff day for HALF_MONTHLY policies. | | `recalculate_impacted_leaves` | boolean | No | Reprocess leaves affected by this holiday. | | `payroll_report_generation_day` | string | No | Payroll report generation day. | | `applicable_employment_type_ids` | array | No | Employment type IDs to which the policy applies. | | `cutoff_pending_approval_action` | string ("APPROVE" | "REJECT") | No | APPROVE or REJECT pending requests at cutoff. | | `second_payroll_report_generation_day` | string | No | Second report generation day for HALF_MONTHLY policies. | | `apply_location_holidays_to_shift_employees` | boolean | No | Apply location holidays to shift employees. | #### 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 legacy time-tracker client **Slug:** `ZOHO_PEOPLE_CREATE_LEGACY_TIME_TRACKER_CLIENT` Create a client using the legacy time-tracker contract. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `city` | string | No | Specify the city name | | `state` | string | No | Specify the state name | | `fax_no` | string | No | Specify the fax number | | `country` | string | No | Specify the country name (Example INDIA for India) | | `pincode` | string | No | Specify the pin code | | `compsize` | string | No | Specify the company size | | `currency` | string | Yes | Specify the currency code (Example INR for India) | | `email_id` | string | No | Specify the email Id | | `industry` | string | No | Specify the industry name | | `phone_no` | string | No | Specify the phone number | | `last_name` | string | No | Specify the last name | | `mobile_no` | string | No | Specify the mobile number | | `first_name` | string | No | Specify the first name | | `client_name` | string | Yes | Specify the client name | | `description` | string | No | Specify the description | | `street_addr` | string | No | Specify the street address | | `billing_method` | string | No | Optional hourly-job-rate mode using Zoho's verified compact wire token. Omit this field to use the provider default. Zoho names other modes but does not publish their exact legacy wire tokens. | #### 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 LMS batch **Slug:** `ZOHO_PEOPLE_CREATE_LMS_BATCH` Create a batch in a blended-learning Zoho People LMS course. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `course_id` | string | Yes | Opaque blended-learning course ID. | | `batch_data` | object | Yes | Typed batch fields serialized as Zoho's required batchData JSON string. | #### 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 LMS course **Slug:** `ZOHO_PEOPLE_CREATE_LMS_COURSE` Create a Zoho People LMS course using the documented JSON contract. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `name` | string | Yes | Course name. | | `duration` | integer | No | Course duration. | | `categories` | array | No | LMS category IDs assigned to the course. | | `course_code` | string | No | Course code. | | `course_type` | integer ("1" | "2" | "3") | Yes | Course type: 1 self-paced, 2 blended learning, or 3 e-material. | | `description` | string | No | Course description. | | `about_course` | string | No | Detailed overview of the course content. | | `course_admins` | array | No | Employee record numbers of course administrators. | | `duration_unit` | string ("minute" | "hour" | "day") | No | Course duration unit: minute, hour, or day. | | `permission_settings` | object | No | Enrollment and completion rules. | #### 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 LMS module **Slug:** `ZOHO_PEOPLE_CREATE_LMS_MODULE` Create a module through the documented self-paced course or blended-learning batch route. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `target` | string ("self_paced_course" | "batch") | Yes | Use the self-paced course route or the blended-learning batch route. | | `batch_id` | string | No | Opaque LMS batch ID; required only when target is batch. | | `course_id` | string | Yes | Opaque Zoho People LMS course ID. | | `module_data` | object | Yes | Typed module fields serialized as Zoho's required moduleData JSON string. | #### 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 LMS session **Slug:** `ZOHO_PEOPLE_CREATE_LMS_SESSION` Create a session in a module of a blended-learning LMS batch. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `date` | string | Yes | Session date; Zoho examples use DD-MM-YYYY. | | `name` | string | Yes | Session name. | | `room_id` | string | No | Opaque LMS room ID. | | `batch_id` | string | Yes | Opaque LMS batch ID. | | `end_time` | string | Yes | End time in 12-hour clock format. | | `course_id` | string | Yes | Opaque LMS course ID. | | `module_id` | string | Yes | Opaque LMS module ID. | | `lock_until` | string | No | Provider-formatted lock date. | | `start_time` | string | Yes | Start time in 12-hour clock format. | | `description` | string | No | Session description. | | `session_type` | string ("0" | "1") | Yes | Session type: 0 classroom or 1 e-learning. | | `trainer_erecno` | string | Yes | Trainer employee record number. | | `grade_category_id` | string | No | Opaque LMS grade category 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 | ### Create on-duty request **Slug:** `ZOHO_PEOPLE_CREATE_ON_DUTY_REQUEST` Submit an on-duty request using the documented legacy contract. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `unit` | integer ("0" | "1") | Yes | Request unit: 0 days or 1 hours. | | `period` | string ("Day" | "Week" | "Month") | No | On-duty period. | | `end_date` | string | Yes | Last on-duty date in organization format. | | `operation` | string | No | Create an on-duty request. | | `start_date` | string | Yes | First on-duty date in organization format. | | `day_details` | object | Yes | On-duty details keyed by organization-formatted date. | | `on_duty_type_id` | string | Yes | Configured on-duty type ID. | | `employee_record_number` | string | No | Employee record number; applicable to administrators. | | `approver_employee_record_number` | string | No | Chosen approver record number when required by settings. | #### 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 performance library items **Slug:** `ZOHO_PEOPLE_CREATE_PERFORMANCE_LIBRARY_ITEMS` Create up to 20 competencies, KRAs, skills, or review questions. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `kras` | array | No | KRAs to create. | | `skills` | array | No | Skills to create. | | `resource` | string ("competencies" | "kras" | "skills" | "review_questions") | Yes | Library resource to create. | | `questions` | array | No | Review questions to create. | | `competencies` | array | No | Competencies to create. | #### 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 shift mapping **Slug:** `ZOHO_PEOPLE_CREATE_SHIFT_MAPPING` Map a shift to one employee using the V3 multipart contract. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `approver` | string | No | Approver employee Zoho ID when employee-selected approvers are enabled. | | `shift_id` | string | No | Shift ID. | | `shift_name` | string | No | Shift name; mapping by name ignores existing mapping conflicts. | | `description` | string | No | Mapping description. | | `employee_id` | string | No | Employee ID to map. | | `update_to_date` | string | No | Last mapping date in the organization's date format. | | `ignore_conflict` | boolean | No | Map the shift despite existing mapping conflicts. | | `update_from_date` | string | Yes | First mapping date in the organization's date format. | | `update_attendance` | boolean | No | Update attendance data based on the new shift. | #### 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 time log **Slug:** `ZOHO_PEOPLE_CREATE_TIME_LOG` Create a legacy time log; supplying new project or job names also creates those resources. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `user` | string | Yes | Employee-ID > | Specify the user for whom timelog needs to be added | | `hours` | string | No | Decimal-2.5 or Time format-2:30 | | `timer` | string | No | To add the timer log | | `job_id` | string | No | Existing job ID; provide this or job_name. | | `to_time` | string | No | Time format-2:30PM or 14:30 | | `job_name` | string | No | Specifying job name will create a new job based on the form add permission of the user | | `client_id` | string | No | Specify the client Id of the project if needed, will be considered only if projectName param is specified | | `from_time` | string | No | Time format-2:30PM or 14:30 | | `work_date` | string | Yes | Work date in yyyy-MM-dd format, or in date_format when supplied. | | `work_item` | string | No | Specify the workitem | | `project_id` | string | No | Specify the project Id of the job if needed | | `client_name` | string | No | Specify the client name of the project if needed, will be considered only if projectName param is specified | | `date_format` | string | No | Caller-supplied company date format for work_date; defaults to yyyy-MM-dd. | | `description` | string | No | Specify the description | | `project_name` | string | No | Specifying project name will create a new project based on the form add permission of the user | | `billing_status` | string | No | Specify billable or non-billable status; Zoho's example uses Billable. | #### 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 timesheet **Slug:** `ZOHO_PEOPLE_CREATE_TIMESHEET` Create a legacy timesheet from time logs and optionally submit it for approval. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `user` | string | Yes | Specify the user for whom timesheet has to be created | | `job_id` | string | No | all | Specify the job Id | | `to_date` | string | Yes | Specify the to date | | `client_id` | string | No | all | Specify the client Id | | `from_date` | string | Yes | Specify the from date | | `attachment` | object | No | Optional file to attach to the new timesheet. | | `project_id` | string | No | all | Specify the project Id | | `date_format` | string | No | Specify the format in which the dates should be provided | | `description` | string | No | Specify the description | | `timesheet_name` | string | Yes | Specify the timesheet name | | `billable_status` | string ("billable" | "non-billable" | "all") | No | Select billable, non-billable, or all time logs. | | `sendfor_approval` | boolean | No | false | To submit the timesheet for approval | #### 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 variable **Slug:** `ZOHO_PEOPLE_CREATE_VARIABLE` Create a V3 Zoho People variable. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `name` | string | Yes | Human-readable variable name, 2-100 characters using only letters, numbers, spaces, and underscores. | | `type` | string ("text" | "textarea" | "email" | "number" | "currency" | "phone" | "checkbox" | "date" | "decimal" | "url" | "datetime") | Yes | Zoho variable datatype. | | `value` | string | No | Initial value formatted for the selected datatype. | | `api_name` | string | Yes | Stable API name for the variable, 2-100 characters using only letters, numbers, and underscores. | | `description` | string | No | Optional variable description, up to 2000 characters. | | `variable_group` | object | Yes | Variable group identified by exactly one of id or 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 | ### Create variable group **Slug:** `ZOHO_PEOPLE_CREATE_VARIABLE_GROUP` Create a V3 variable group. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `name` | string | Yes | Human-readable variable-group name, 2-100 characters using only letters, numbers, spaces, and underscores. | | `api_name` | string | Yes | Stable API name for the variable group, 2-100 characters using only letters, numbers, and underscores. | | `description` | string | No | Optional variable-group description, up to 2000 characters. | #### 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 attendance entries **Slug:** `ZOHO_PEOPLE_DELETE_ATTENDANCE_ENTRIES` Delete one V3 attendance entry by ID or a provider-supported filtered set of entries. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `date` | string | No | Origin date in organization format. | | `entry_id` | string | No | Attendance entry ID; required for operation one. | | `operation` | string ("one" | "filtered_set") | Yes | Delete one entry by ID or a filtered employee/date set. | | `employee_zoho_id` | string | No | Employee Zoho ID for operation filtered_set. | #### 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 attendance regularizations **Slug:** `ZOHO_PEOPLE_DELETE_ATTENDANCE_REGULARIZATIONS` Delete one explicitly supplied attendance regularization record. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `record_id` | string | Yes | Regularization record ID to delete; sent in Zoho's recordId field. | #### 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 compensatory request **Slug:** `ZOHO_PEOPLE_DELETE_COMPENSATORY_REQUEST` Delete a V3 compensatory-off request by record ID. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `record_id` | string | Yes | Compensatory request record 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 | ### Delete employee performance items **Slug:** `ZOHO_PEOPLE_DELETE_EMPLOYEE_PERFORMANCE_ITEMS` Permanently remove selected tagged KRAs, competencies, or skills from an employee. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `employee` | string | Yes | Employee record identifier. | | `resource` | string ("kras" | "competencies" | "skills") | Yes | Tagged resource to remove. | | `assignment_ids` | array | Yes | Tagged assignment IDs to permanently remove. | #### 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 files **Slug:** `ZOHO_PEOPLE_DELETE_FILES` Permanently delete up to 100 explicitly supplied Zoho People file IDs. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `latitude` | string | No | Request latitude. | | `longitude` | string | No | Request longitude. | | `delete_file_ids` | array | Yes | File IDs 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 | ### Delete job schedule **Slug:** `ZOHO_PEOPLE_DELETE_JOB_SCHEDULE` Delete one legacy job schedule. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `del_repeat_type` | integer ("1" | "2") | No | 1 | This will be considered only if isDeleteRepeat is true. 1 - Delete current and the following schedules in the repeat series 2 - Delete all the schedules in the repeat series (allowed only for admin/data admin) | | `job_schedule_id` | string | Yes | Specify the job schedule id to be deleted | | `is_delete_repeat` | boolean | No | false | If true, the repeat series will be deleted based on delRepeatType. If false, then only the mentioned schedule will be deleted | #### 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 leave grant **Slug:** `ZOHO_PEOPLE_DELETE_LEAVE_GRANT` Delete a V3 leave grant request by record ID. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `record_id` | string | Yes | Leave grant record 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 | ### Delete leave request **Slug:** `ZOHO_PEOPLE_DELETE_LEAVE_REQUEST` Delete one V3 leave request by record ID. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `record_id` | string | Yes | Leave request record 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 | ### Delete leave setting **Slug:** `ZOHO_PEOPLE_DELETE_LEAVE_SETTING` Delete a V3 holiday, pay-period policy, or work calendar by ID. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `operation` | string ("holiday" | "pay_period_policy" | "work_calendar") | Yes | Setting type to delete. | | `holiday_id` | string | No | Holiday ID for the holiday branch. | | `pay_period_id` | string | No | Pay-period policy ID for that branch. | | `work_calendar_id` | string | No | Work calendar ID for that branch. | #### 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 legacy time-tracker client **Slug:** `ZOHO_PEOPLE_DELETE_LEGACY_TIME_TRACKER_CLIENT` Delete a client using the legacy time-tracker contract. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `client_id` | string | Yes | Specify the client Ids (separated by commas). Note: Maximum number of Ids allowed is 1000. | #### 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 legacy time-tracker resource **Slug:** `ZOHO_PEOPLE_DELETE_LEGACY_TIME_TRACKER_RESOURCE` Delete legacy projects or jobs using the selected documented contract. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `job_id` | string | No | Specify the job Id (separated by commas). Maximum number of Ids allowed is 100. | | `operation` | string ("project" | "job") | Yes | Documented operation to execute. | | `project_id` | string | No | Specify the projectIds (seperated by commas max count of 1000) | #### 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 on-duty request **Slug:** `ZOHO_PEOPLE_DELETE_ON_DUTY_REQUEST` Delete explicitly supplied on-duty requests. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `record_ids` | array | Yes | On-duty record IDs 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 | ### Delete performance library items **Slug:** `ZOHO_PEOPLE_DELETE_PERFORMANCE_LIBRARY_ITEMS` Request deletion of selected performance library records. Zoho's success response is an acknowledgement and does not verify that each record was removed. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `ids` | array | Yes | Library record IDs for which Zoho should process a deletion request. | | `resource` | string ("competencies" | "kras" | "skills" | "review_questions") | Yes | Library resource to delete from. | #### 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 shift mapping **Slug:** `ZOHO_PEOPLE_DELETE_SHIFT_MAPPING` Delete or end one V3 shift mapping with documented date and attendance options. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `map_id` | string | Yes | Shift mapping ID to delete or end. | | `approver` | string | No | Approver employee Zoho ID when configured. | | `shift_id` | string | No | Shift ID. | | `shift_name` | string | No | Shift name. | | `description` | string | No | Deletion or end-mapping description. | | `employee_id` | string | No | Employee ID. | | `update_to_date` | string | No | Last affected date in the organization's date format. | | `ignore_conflict` | boolean | No | Apply despite mapping conflicts. | | `update_from_date` | string | Yes | First affected date in the organization's date format. | | `update_attendance` | boolean | No | Update attendance data for the affected dates. | #### 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 time log **Slug:** `ZOHO_PEOPLE_DELETE_TIME_LOG` Delete one legacy time log. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `time_log_id` | string | Yes | Specify the timeLogId (seperated by commas).Note: Maximum number of IDs allowed is 1000. | #### 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 timer comment **Slug:** `ZOHO_PEOPLE_DELETE_TIMER_COMMENT` Delete one legacy time-tracker comment. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `comment_id` | string | Yes | Specify the commentId 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 | ### Delete timesheet **Slug:** `ZOHO_PEOPLE_DELETE_TIMESHEET` Delete up to 1,000 comma-separated legacy timesheet IDs; fails loudly if Zoho skips any ID after partially deleting others. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `timesheet_id` | string | Yes | Specify the timesheet Ids (separated by commas). Maximum number of Ids allowed is 1000. | #### 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 time-tracker resources **Slug:** `ZOHO_PEOPLE_DELETE_TIME_TRACKER_RESOURCES` Delete the explicitly supplied V3 client, project, or job IDs. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `job_ids` | array | No | Job IDs to delete (maximum 200). | | `operation` | string ("clients" | "projects" | "jobs") | Yes | Documented operation to execute. | | `client_ids` | array | No | Client IDs to delete (maximum 200). | | `project_ids` | array | No | Project IDs to delete (maximum 200). | #### 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 variable **Slug:** `ZOHO_PEOPLE_DELETE_VARIABLE` Delete one V3 variable by numeric ID or API name. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `group` | string | No | Variable-group ID or API name; required only for API-name deletion. | | `identifier` | string | Yes | Variable ID or API name to delete. | | `identifier_kind` | string ("id" | "api_name") | Yes | Whether identifier is a numeric variable ID or a variable 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 | ### Delete variable group **Slug:** `ZOHO_PEOPLE_DELETE_VARIABLE_GROUP` Delete one V3 variable group by group ID or API name. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `identifier_kind` | string ("id" | "api_name") | Yes | Whether group_identifier is a group ID or API name. | | `group_identifier` | string | Yes | Variable-group ID or API name 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 file **Slug:** `ZOHO_PEOPLE_DOWNLOAD_FILE` Download one Zoho People V3 file and return a file reference. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `file_id` | string | Yes | ID of the file to download. | | `latitude` | string | No | Request latitude. | | `longitude` | string | No | Request longitude. | #### 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 time-tracker attachment **Slug:** `ZOHO_PEOPLE_DOWNLOAD_TIME_TRACKER_ATTACHMENT` Download one attachment from a documented time-tracker entity and return a file reference. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `entity` | string ("project" | "job" | "timelog" | "timesheet") | Yes | Type of parent record that owns the attachment. | | `record_id` | string | Yes | ID of the project, job, time log, or timesheet that owns the attachment. | | `attachment_id` | string | Yes | ID of the attachment to download. | #### 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 | ### Enroll LMS learners **Slug:** `ZOHO_PEOPLE_ENROLL_LMS_LEARNERS` Create externally visible learner enrollments in a course or a specific blended-learning batch. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `target` | string ("self_paced_course" | "batch") | Yes | Use the self-paced course route or the blended-learning batch route. | | `batch_id` | string | No | Opaque LMS batch ID; required only when target is batch. | | `course_id` | string | Yes | Opaque Zoho People LMS course ID. | | `employee_record_numbers` | array | Yes | Employee record numbers serialized as Zoho's required JSON array string. | #### 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 attendance entry **Slug:** `ZOHO_PEOPLE_GET_ATTENDANCE_ENTRY` Fetch one V3 attendance entry by entry ID. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `date` | string | No | Origin date in organization format, required when it is outside the current year. | | `entry_id` | string | Yes | Attendance entry 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 | ### Get attendance regularization fields **Slug:** `ZOHO_PEOPLE_GET_ATTENDANCE_REGULARIZATION_FIELDS` Return configured fields for attendance regularization requests. #### 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 compensatory request **Slug:** `ZOHO_PEOPLE_GET_COMPENSATORY_REQUEST` Return one specific V3 compensatory-off request by record ID. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `record_id` | string | Yes | Compensatory-off request record ID to retrieve. | #### 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 file **Slug:** `ZOHO_PEOPLE_GET_FILE` View one Zoho People V3 file and return a file reference. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `file_id` | string | Yes | ID of the file to view. | | `latitude` | string | No | Request latitude. | | `longitude` | string | No | Request longitude. | #### 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 file sharing options **Slug:** `ZOHO_PEOPLE_GET_FILE_SHARING_OPTIONS` Return allowed folders or organization-file share targets. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `option` | string ("allowed_folders" | "share_targets") | Yes | The documented sharing option to retrieve. | | `latitude` | string | No | Request latitude. | | `longitude` | string | No | Request longitude. | #### 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 form fields **Slug:** `ZOHO_PEOPLE_GET_FORM_FIELDS` Get the field components and label names needed to read or write records in a Zoho People form. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `form_link_name` | string | Yes | Form link name returned by List forms, such as employee. | #### 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 form record **Slug:** `ZOHO_PEOPLE_GET_FORM_RECORD` Fetch one form record, a section-wise record, or records from a saved employee view. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `lookup` | string ("record" | "section_wise_record" | "employee_view_record") | Yes | Select the documented record lookup contract. | | `record_id` | string | No | Zoho form record ID; required for record and section_wise_record lookups. | | `view_name` | string | No | Saved employee view name; required for employee_view_record. | | `start_index` | integer | No | One-based start index for the employee view lookup. | | `record_limit` | integer | No | Employee-view records to return, from 10 through 200. | | `search_value` | string | No | Employee ID or email matched against search_column. | | `modified_time` | integer | No | Return employee-view records added or modified after this Unix timestamp in milliseconds. | | `search_column` | string | No | Employee-view search column: EMPLOYEEID or EMPLOYEEMAILALIAS. | | `form_link_name` | string | No | Form link name; required for record and section_wise_record lookups. | #### 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 holiday **Slug:** `ZOHO_PEOPLE_GET_HOLIDAY` Fetch one V3 holiday by holiday ID. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `holiday_id` | string | Yes | Holiday 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 | ### Get hourly permission options **Slug:** `ZOHO_PEOPLE_GET_HOURLY_PERMISSION_OPTIONS` Return applicable permission types, balance, or configured details for an hourly-permission request. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `date` | string | No | Date in organization format for balance. | | `form_id` | string | No | Permission form ID for details. | | `operation` | string ("applicable_types" | "balance" | "details") | Yes | Permission metadata to return. | | `record_id` | string | No | Permission record ID for details. | | `permission_id` | string | No | Permission type ID for balance. | | `user_type_ids` | array | No | Active-user type IDs for details. | | `employee_record_number` | string | No | Employee record number for applicable types or balance. | #### 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 HR process record **Slug:** `ZOHO_PEOPLE_GET_HR_PROCESS_RECORD` Fetch one V3 HR process record by its documented record ID. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `record_id` | string | Yes | Numeric Zoho People HR process record 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 | ### Get leave grant **Slug:** `ZOHO_PEOPLE_GET_LEAVE_GRANT` Fetch one V3 leave grant request by record ID. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `record_id` | string | Yes | Leave grant record 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 | ### Get leave report **Slug:** `ZOHO_PEOPLE_GET_LEAVE_REPORT` Return one page of a selected V3 or documented legacy leave report. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `unit` | string | No | Legacy report unit: Day or Hour. | | `cursor` | string | No | Continuation cursor from a previous paginated report response. | | `to_date` | string | No | V3 report end date. | | `employee` | string | No | Employee Zoho record number for the legacy user report. | | `from_date` | string | No | V3 report start date. | | `legacy_to` | string | No | End date for a legacy aggregate report. | | `operation` | string ("v3_leave_type_summary" | "legacy_user" | "legacy_booked_and_balance" | "legacy_encashment" | "legacy_loss_of_pay") | Yes | Documented report contract to run. | | `legacy_from` | string | No | Start date for a legacy aggregate report. | | `leave_type_id` | string | No | Leave type ID for the V3 leave-type summary. | | `department_ids` | array | No | Legacy department IDs as a JSON array. | | `leave_type_ids` | array | No | Legacy leave type IDs as a JSON array. | | `user_report_to` | string | No | End date for the legacy user report. | | `employee_status` | array | No | V3 employee statuses: ACTIVE_USERS, ACTIVE_EMPLOYEE_PROFILES, EX_EMPLOYEES, or LOGIN_DISABLED. | | `employee_role_ids` | array | No | V3 role IDs as a JSON array. | | `employee_zoho_ids` | array | No | V3 employee Zoho record numbers as a JSON array. | | `legacy_date_format` | string | No | Date format for the legacy loss-of-pay report. | | `legacy_employee_ids` | array | No | Legacy employee Zoho record numbers as a JSON array. | | `employee_location_ids` | array | No | V3 location IDs as a JSON array. | | `legacy_employee_status` | array | No | Legacy employee statuses: ACTIVE_USERS, ACTIVE_EMPLOYEE_PROFILES, EX_EMPLOYEES, or LOGIN_DISABLED. | | `employee_department_ids` | array | No | V3 department IDs as a JSON array. | | `employee_designation_ids` | array | No | V3 designation IDs as a JSON array. | | `legacy_pay_period_setting_id` | string | No | Legacy pay-period setting 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 | ### Get leave request **Slug:** `ZOHO_PEOPLE_GET_LEAVE_REQUEST` Fetch one V3 leave request by record ID. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `record_id` | string | Yes | Leave request record 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 | ### Get leave setting **Slug:** `ZOHO_PEOPLE_GET_LEAVE_SETTING` Fetch one V3 pay-period policy or work calendar by ID. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `operation` | string ("pay_period_policy" | "work_calendar") | Yes | Setting type to fetch. | | `pay_period_id` | string | No | Pay-period policy ID for that branch. | | `work_calendar_id` | string | No | Work calendar ID for that branch. | #### 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 legacy time-tracker resource **Slug:** `ZOHO_PEOPLE_GET_LEGACY_TIME_TRACKER_RESOURCE` Fetch one legacy client, project, or job by ID. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `job_id` | string | No | Specify the job Id | | `client_id` | string | No | Specify the client Id | | `operation` | string ("client" | "project" | "job") | Yes | Documented operation to execute. | | `project_id` | string | No | Specify the project id of the project of which the details needs to be fetched | | `date_format` | string | No | Specify the date format | | `include_dept` | boolean | No | false | To get the departments that are assigned to the project | | `is_job_count` | boolean | No | false | To get the number of jobs mapped to the project | | `is_user_count` | boolean | No | false | To get the number of users assigned to the project | | `fetch_rec_perm` | boolean | No | This key fetches whether there is delete permission for the individual record. | | `include_work_items` | boolean | No | false | To fetch the workItems that are assigned to the jobs | #### 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 LMS settings **Slug:** `ZOHO_PEOPLE_GET_LMS_SETTINGS` Return organization-level Zoho People LMS settings. #### 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 my compensation **Slug:** `ZOHO_PEOPLE_GET_MY_COMPENSATION` Return compensation details for the connected employee. #### 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 on-duty details **Slug:** `ZOHO_PEOPLE_GET_ON_DUTY_DETAILS` Fetch details for one on-duty request. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `form_id` | string | Yes | On-duty form ID. | | `record_id` | string | Yes | On-duty record ID. | | `user_type_ids` | array | No | Active user and active non-user type IDs. | #### 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_PEOPLE_GET_ORGANIZATION` Return the connected Zoho People organization's details. #### 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 pay-period settings **Slug:** `ZOHO_PEOPLE_GET_PAY_PERIOD_SETTINGS` Return legacy payroll pay-period settings. #### 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 running timer **Slug:** `ZOHO_PEOPLE_GET_RUNNING_TIMER` Return the connected user's currently running time-tracker timer. #### 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 shift mapping **Slug:** `ZOHO_PEOPLE_GET_SHIFT_MAPPING` Fetch one V3 shift mapping by mapping ID. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `map_id` | string | Yes | Shift mapping 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 | ### Get shift schedule **Slug:** `ZOHO_PEOPLE_GET_SHIFT_SCHEDULE` Return V3 shift schedules for an employee and date range. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `to_date` | string | Yes | End date in the organization's date format. | | `from_date` | string | Yes | Start date in the organization's date format. | | `employee_id` | string | No | Employee ID. | | `employee_email_id` | string | No | Employee email address. | | `employee_biometric_mapper_id` | string | No | Employee biometric mapper 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 | ### Get suggested LMS course count **Slug:** `ZOHO_PEOPLE_GET_SUGGESTED_LMS_COURSE_COUNT` Return the number of LMS courses suggested to the connected learner. #### 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 time log **Slug:** `ZOHO_PEOPLE_GET_TIME_LOG` Fetch one legacy time log with optional timer and comment counts. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `timelog_id` | string | Yes | Specify the time log id whose details need to be fetched | | `is_timer_details` | boolean | No | false | Set true to fetch the timer intervals if the time log is of type 2 (timer time log) | | `is_comments_count` | boolean | No | false | Set true to fetch the number of comments/notes added for the timer time log | #### 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 timesheet **Slug:** `ZOHO_PEOPLE_GET_TIMESHEET` Fetch one legacy timesheet by ID. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `date_format` | string | No | Specify the format in which the dates should be provided | | `timesheet_id` | string | Yes | Specify the timesheet 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 | ### Get time-tracker reports and settings **Slug:** `ZOHO_PEOPLE_GET_TIME_TRACKER_REPORTS_AND_SETTINGS` Return a payroll report page, pay-period details, or general time-tracker settings. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `limit` | integer | No | Specify the number of records to be fetched. Maximum value is 100 | | `cursor` | string | No | Opaque payroll-report cursor returned by the previous call. | | `s_index` | integer | No | Specify from which record the response should be fetched | | `to_date` | string | No | Payroll range end in yyyy-MM-dd format, or in date_format when supplied. | | `from_date` | string | No | Payroll range start in yyyy-MM-dd format, or in date_format when supplied. | | `operation` | string ("payroll_report" | "pay_period_details" | "general_settings") | Yes | Documented operation to execute. | | `date_format` | string | No | Caller-supplied format for from_date and to_date; omit it for yyyy-MM-dd. | | `location_id` | string | No | Used to fetch pay period details based on location Id | | `user_erec_no` | string | No | Email-ID | Employee-ID > | all | Specify the user whose payroll data needs to be fetched | | `location_name` | string | No | Used to fetch pay period details based on location Name | | `pay_period_id` | string | No | Specify the pay period Id for which payroll data needs to be fetched | | `approval_status` | string ("approved" | "unapproved" | "all") | No | all > | all | Specify the approval Status based on which payroll data needs to be fetched | | `employee_status` | string ("all" | "users" | "employeeprofiles" | "exemployees" | "logindisabled") | No | employeeprofiles | exemployees | logindisabled> | all | Specify the employee status based on which payroll needs to be fetched | | `is_direct_sub_only_needed` | boolean | No | false | Used to get reportees, considered only when userErecno parameter value is all | | `employee_date_of_exit_based` | boolean | No | false | Fetches ex-employees whose data of exit is on or after from date specified | #### 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 time-tracker resource **Slug:** `ZOHO_PEOPLE_GET_TIME_TRACKER_RESOURCE` Fetch one V3 client, project, or job by ID with resource-specific include options. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `job_id` | string | No | Provider value for job_id. | | `client_id` | string | No | Provider value for client_id. | | `operation` | string ("client" | "project" | "job") | Yes | Documented operation to execute. | | `project_id` | string | No | Provider value for project_id. | | `date_format` | string | No | Specify the format in which the dates should be provided | | `include_job_count` | boolean | No | Fetches the number of jobs mapped to the project | | `include_user_count` | boolean | No | Fetches the number of users assigned to the project | | `include_departments` | boolean | No | To get the departments that are assigned to the project | | `include_logged_hours` | boolean | No | Fetches the total hours logged for the jobs | | `include_record_permissions` | boolean | No | This key fetches whether there is delete permission for the individual 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 variable **Slug:** `ZOHO_PEOPLE_GET_VARIABLE` Fetch one V3 variable by numeric ID or API name. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `group` | string | No | Variable-group ID or API name; required when identifier_kind is api_name. | | `identifier` | string | Yes | Variable ID or API name selected by identifier_kind. | | `identifier_kind` | string ("id" | "api_name") | Yes | Whether identifier is a numeric Zoho variable ID or a variable 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 | ### Get variable group **Slug:** `ZOHO_PEOPLE_GET_VARIABLE_GROUP` Fetch one V3 variable group by group ID or API name. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `identifier_kind` | string ("id" | "api_name") | Yes | Whether group_identifier is a group ID or API name. | | `group_identifier` | string | Yes | Variable-group ID or 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 attendance entries **Slug:** `ZOHO_PEOPLE_LIST_ATTENDANCE_ENTRIES` Return one V3 page of attendance entries with employee, date, and modification filters. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `cursor` | string | No | Opaque cursor returned by a previous call; pass it back unchanged. | | `to_date` | string | No | End date in organization format; use with from_date instead of last_modified_within. | | `from_date` | string | No | Start date in organization format; use with to_date instead of last_modified_within. | | `employee_id` | string | No | Employee ID. | | `employee_zoho_id` | string | No | Employee Zoho ID. | | `employee_email_id` | string | No | Employee email address. | | `last_modified_within` | integer | No | Return entries modified within this many minutes instead of filtering by date. | | `group_entries_by_date` | boolean | No | Group entries by date. | | `group_entries_by_employee` | boolean | No | Group entries by employee, with date grouping nested when both grouping flags are true. | | `employee_biometric_mapper_id` | string | No | Employee biometric mapper 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 | ### List attendance regularization reasons **Slug:** `ZOHO_PEOPLE_LIST_ATTENDANCE_REGULARIZATION_REASONS` Return configured reasons available for attendance regularization. #### 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 attendance regularization records **Slug:** `ZOHO_PEOPLE_LIST_ATTENDANCE_REGULARIZATION_RECORDS` Return one page of attendance regularization records using documented filters. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `range` | integer | No | Number of regularization records requested on this page. | | `cursor` | string | No | Cursor returned by a previous call; omit for the first page. | | `status` | integer ("-3" | "1" | "-1" | "0") | No | Regularization status filter. Zoho accepts only -3, 1, -1, or 0. | | `to_date` | string | No | End date for the regularization search. | | `from_date` | string | No | Start date for the regularization search. | | `record_id` | string | No | Attendance regularization record ID filter. | | `date_format` | string | No | Format used by from_date and to_date, such as yyyy-MM-dd. | | `employee_id` | string | No | Employee ID filter. | | `start_index` | integer | No | Provider start index for this page. | | `employee_record_number` | string | No | Employee record number 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 compensation reference data **Slug:** `ZOHO_PEOPLE_LIST_COMPENSATION_REFERENCE_DATA` Return compensation components, packages, currencies, reasons, or settings. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `status` | string ("active" | "inactive") | No | Enabled status filter for components or packages. | | `resource` | string ("components" | "packages" | "currencies" | "reasons" | "settings") | Yes | Compensation reference-data collection to return. | | `location_ids` | string | No | JSON array of location IDs for component or package filtering. | | `component_type` | string ("benefit" | "ctc") | No | Component type; mandatory when filtering components by location. | | `designation_ids` | string | No | JSON array of designation IDs for package filtering. | | `home_currency_only` | boolean | No | For currencies, return only the organization's home currency when true. | #### 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 compensation revisions **Slug:** `ZOHO_PEOPLE_LIST_COMPENSATION_REVISIONS` Return one page of compensation revisions with date and status filters. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `cursor` | string | No | Cursor returned by a previous call; omit for the first page. | | `status` | string ("pending" | "processed" | "rejected" | "cancelled") | No | Approval status filter. | | `to_date` | string | No | Latest revision creation or modification date. | | `from_date` | string | No | Earliest revision creation or modification date. | | `start_index` | integer | No | One-based starting revision index. | #### 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 compensatory requests **Slug:** `ZOHO_PEOPLE_LIST_COMPENSATORY_REQUESTS` Return one V3 page of compensatory-off requests with employee, date, approval, and status filters. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `sort` | string ("worked_date" | "-worked_date" | "expiry_date" | "-expiry_date" | "employee" | "-employee") | No | Sort field; prefix with '-' for descending order. | | `cursor` | string | No | Continuation cursor from a previous response. | | `to_date` | string | No | Worked-date range end. | | `from_date` | string | No | Worked-date range start. | | `data_select` | string ("MINE" | "SUBORDINATES" | "DIRECT_SUBORDINATES" | "MINE,SUBORDINATES" | "ALL") | No | Data ownership selection such as MINE, SUBORDINATES, or ALL. | | `record_status` | array | No | Compensatory record statuses as a JSON-array filter. | | `approval_status` | string ("APPROVED" | "PENDING" | "REJECTED" | "CANCELLED" | "CANCEL_PENDING" | "ALL") | No | Approval status filter. | | `employee_status` | array | No | Employee statuses as a JSON-array filter. | | `employee_zoho_ids` | array | No | Employee Zoho record numbers as a JSON-array filter. | | `employee_location_ids` | array | No | Location IDs as a JSON-array filter. | | `employee_department_ids` | array | No | Department IDs as a JSON-array 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 employee performance items **Slug:** `ZOHO_PEOPLE_LIST_EMPLOYEE_PERFORMANCE_ITEMS` Return one page of an employee's KRAs, competencies, or skills. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `limit` | integer | No | Maximum records to return, up to 200. | | `cursor` | string | No | Opaque cursor returned by the previous page. Pass it unchanged. | | `employee` | string | No | Employee record identifier. Required on the first page. | | `resource` | string ("kras" | "competencies" | "skills") | No | Employee performance resource to list. Required on the first page. | | `is_revision` | boolean | No | For skills, whether to show skill revisions. | #### 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 employee salaries **Slug:** `ZOHO_PEOPLE_LIST_EMPLOYEE_SALARIES` Return one page of employee salary records for team or all visibility. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `mode` | string ("team" | "all") | Yes | Salary visibility mode: team or all. | | `cursor` | string | No | Cursor returned by a previous call; omit for the first page. | | `start_index` | integer | No | One-based starting salary record index. | #### 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 file acknowledgements **Slug:** `ZOHO_PEOPLE_LIST_FILE_ACKNOWLEDGEMENTS` Return one acknowledgement-details page or user acknowledgement statuses. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `view` | string ("details" | "user_status") | Yes | Acknowledgement view to retrieve. | | `limit` | integer | No | Maximum details to return. | | `cursor` | integer | No | Start index returned by a previous details page. | | `file_id` | string | No | File ID for acknowledgement details. | | `employee` | string | No | Employee record number for user status. | | `file_ids` | array | No | File IDs for user acknowledgement status. | | `latitude` | string | No | Request latitude. | | `longitude` | string | No | Request longitude. | #### 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 file folders **Slug:** `ZOHO_PEOPLE_LIST_FILE_FOLDERS` Return all Zoho People V3 file folders matching an optional name. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `name` | string | No | Optional folder or category name filter. | | `latitude` | string | No | Request latitude. | | `longitude` | string | No | Request longitude. | #### 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 files **Slug:** `ZOHO_PEOPLE_LIST_FILES` Return one page from a documented Zoho People V3 file view. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `view` | string ("all_files" | "folder" | "subfolder") | Yes | Documented file view to list. | | `limit` | integer | No | Maximum records to return, up to 200. | | `cursor` | integer | No | Start index returned by the previous page. | | `role_id` | string | No | Role ID filter. | | `to_date` | string | No | Modified-through date in Zoho's format. | | `unit_id` | string | No | Business unit ID. | | `employee` | string | No | Employee ID filter. | | `latitude` | string | No | Request latitude. | | `file_type` | integer ("0" | "1" | "2") | Yes | 0 employee, 1 organization, or 2 personal files. | | `folder_id` | string | No | Folder ID filter. | | `from_date` | string | No | Modified-from date in Zoho's format. | | `longitude` | string | No | Request longitude. | | `company_id` | string | No | Organization entity ID. | | `division_id` | string | No | Division ID. | | `location_id` | string | No | Location ID filter. | | `file_sort_by` | integer ("1" | "3") | No | 1 sorts by name; 3 sorts by modified time. | | `department_id` | string | No | Department ID. | | `employee_erecno` | string | No | Employee record number for subfolder view. | | `parent_folder_id` | string | No | Required parent folder ID for subfolder view. | | `is_file_sort_desc` | boolean | No | Whether to sort descending. | | `search_file_by_name` | string | No | File-name search text. | | `is_expired_files_view` | boolean | No | Whether to return only expired files. | | `search_file_by_extension` | string | No | File-extension filter. | | `employee_file_filter_view` | string ("all" | "my" | "subordinates" | "allrole" | "myrole" | "inactiveemp" | "logindisabled" | "allsubordinates") | No | Employee-file view filter. | | `organization_file_filter_view` | string ("location" | "entity" | "unit" | "division" | "department") | No | Organization hierarchy 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 form records **Slug:** `ZOHO_PEOPLE_LIST_FORM_RECORDS` Return one page of records from a named Zoho People form. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `cursor` | string | No | Cursor returned by a previous call; omit for the first page. | | `start_index` | integer | No | One-based starting record index. | | `search_value` | string | No | Employee ID or email value matched against search_column. | | `modified_time` | integer | No | Return records added or modified after this Unix timestamp in milliseconds. | | `search_column` | string | No | Employee search column, such as EMPLOYEEID or EMPLOYEEMAILALIAS. | | `form_link_name` | string | Yes | Zoho form link name whose records are 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 forms **Slug:** `ZOHO_PEOPLE_LIST_FORMS` List forms and their identifiers, link names, views, visibility, and permissions in Zoho People. #### 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 holidays **Slug:** `ZOHO_PEOPLE_LIST_HOLIDAYS` Return one V3 page of holidays. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `cursor` | string | No | Continuation cursor from a previous response. | | `to_date` | string | No | Holiday range end date. | | `from_date` | string | No | Holiday range start date. | | `employee_shift_ids` | array | No | Shift IDs as a JSON-array filter. | | `employee_location_ids` | array | No | Location IDs as a JSON-array filter. | | `holiday_classification_ids` | array | No | Holiday classification IDs as a JSON-array 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 hourly permission requests **Slug:** `ZOHO_PEOPLE_LIST_HOURLY_PERMISSION_REQUESTS` Return one page of hourly-permission requests or approvals for the connected user's role. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `cursor` | string | No | Start-index cursor returned by a previous call. | | `end_date` | string | No | Request end date in organization format. | | `operation` | string ("requests" | "approvals") | Yes | Connected-user requests or approvals requiring action. | | `start_date` | string | No | Request start date in organization format. | | `approval_status` | integer ("-3" | "1" | "-1" | "0") | No | Approval status: -3 all, 1 approved, -1 pending, or 0 rejected. | | `request_statuses` | array | No | Request approval statuses: 1 approved, -1 pending, or 0 rejected. | | `employee_record_numbers` | array | No | Employee record numbers for requests. | #### 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 job schedules **Slug:** `ZOHO_PEOPLE_LIST_JOB_SCHEDULES` Return one legacy page of job schedules by user and date range. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `user` | string | No | Specify the user whose job schedule needs to be fetched | | `limit` | integer | No | Number of employee schedule groups to return; maximum 200. | | `cursor` | string | No | Opaque cursor returned by the previous call. | | `s_index` | integer | No | Zero-based first record offset. | | `to_date` | string | Yes | Last schedule date in yyyy-MM-dd company-date format. | | `from_date` | string | Yes | First schedule date in yyyy-MM-dd company-date format. | #### 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 leave grants **Slug:** `ZOHO_PEOPLE_LIST_LEAVE_GRANTS` Return one V3 page of leave grant requests with employee, date, approval, and sort filters. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `sort` | string ("effective_date" | "-effective_date" | "leave_type" | "-leave_type" | "employee" | "-employee") | No | Sort field; prefix with '-' for descending order. | | `cursor` | string | No | Continuation cursor from a previous response. | | `to_date` | string | No | End date for grant records. | | `from_date` | string | No | Start date for grant records. | | `data_select` | string ("MINE" | "SUBORDINATES" | "DIRECT_SUBORDINATES" | "MINE,SUBORDINATES" | "ALL") | No | Data ownership selection such as MINE, SUBORDINATES, or ALL. | | `leave_type_ids` | array | No | Leave type IDs as a provider JSON-array filter. | | `approval_status` | string ("APPROVED" | "PENDING" | "REJECTED" | "CANCELLED" | "CANCEL_PENDING" | "ALL") | No | Approval status filter. | | `employee_zoho_ids` | array | No | Employee Zoho record numbers as a provider JSON-array filter. | | `employee_location_ids` | array | No | Location IDs as a provider JSON-array filter. | | `employee_department_ids` | array | No | Department IDs as a provider JSON-array 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 leave requests **Slug:** `ZOHO_PEOPLE_LIST_LEAVE_REQUESTS` Return one V3 page of leave requests with employee, date, type, approval, and status filters. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `sort` | string ("leave_type" | "-leave_type" | "employee" | "-employee" | "from_date" | "-from_date" | "to_date" | "-to_date") | No | Sort field; prefix with '-' for descending order. | | `cursor` | string | No | Continuation cursor from a previous response. | | `to_date` | string | Yes | End date for leave records. | | `from_date` | string | Yes | Start date for leave records. | | `data_select` | string ("MINE" | "SUBORDINATES" | "DIRECT_SUBORDINATES" | "MINE,SUBORDINATES" | "ALL") | No | Data ownership selection such as MINE, SUBORDINATES, or ALL. | | `type_of_leave` | array | No | Leave categories as a JSON-array filter. | | `leave_type_ids` | array | No | Leave type IDs as a JSON-array filter. | | `approval_status` | string ("APPROVED" | "PENDING" | "REJECTED" | "CANCELLED" | "CANCEL_PENDING" | "ALL") | No | Approval status filter. | | `employee_status` | array | No | Employee statuses as a JSON-array filter. | | `employee_zoho_ids` | array | No | Employee Zoho record numbers as a JSON-array filter. | | `employee_location_ids` | array | No | Location IDs as a JSON-array filter. | | `employee_department_ids` | array | No | Department IDs as a JSON-array 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 leave settings **Slug:** `ZOHO_PEOPLE_LIST_LEAVE_SETTINGS` List V3 pay-period policies or work calendars. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `operation` | string ("pay_period_policies" | "work_calendars") | Yes | Setting collection to list. | #### 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 legacy V2 holidays **Slug:** `ZOHO_PEOPLE_LIST_LEGACY_HOLIDAYS` Return holidays from the V2 all-holidays API using its employee, location, shift, and upcoming filters. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `shift` | string | No | Shift name filter. | | `to_date` | string | No | Holiday range end date. | | `employee` | string | No | Employee ID, email address, or Zoho record number. | | `location` | string | No | Location name filter. | | `upcoming` | boolean | No | Return holidays in the next 365 days. | | `from_date` | string | No | Holiday range start date. | | `date_format` | string | No | Format used by the from and to date values. | #### 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 legacy time-tracker resources **Slug:** `ZOHO_PEOPLE_LIST_LEGACY_TIME_TRACKER_RESOURCES` Return one legacy page of clients, projects, or jobs with legacy filters. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `limit` | integer | No | Specify the number of records to be fetched. Maximum value is 200 | | `cursor` | string | No | Opaque cursor returned by the previous call. | | `s_index` | integer | No | Specify from which record the response should be fetched | | `client_id` | string | No | Specify the client Id to get the projects associated with it. | | `operation` | string ("clients" | "projects" | "jobs") | Yes | Documented operation to execute. | | `job_status` | string ("all" | "in-progress" | "completed") | No | Legacy job status filter. | | `project_id` | string | No | all | Specify the project Id which the jobs are associated with | | `assigned_by` | string | No | all | Specify the user by whom the jobs are assigned | | `assigned_to` | string | No | Email-ID | Employee-ID > | Specify the user whose projects should be listed. | | `date_format` | string | No | Specify the format in which the dates should be provided | | `is_job_count` | boolean | No | false | Fetches the number of jobs mapped to the project | | `is_user_count` | boolean | No | false | Fetches the number of users assigned to the project | | `project_status` | string ("all" | "inprogress" | "completed") | No | Legacy project status filter. | | `project_manager` | string | No | Email-ID | Employee-ID > | all | Specify the project manager | | `fetch_logged_hrs` | boolean | No | false | Fetches the total hours logged for the job | | `is_assignee_count` | boolean | No | false | Fetches the number of users mapped to the job | | `search_project_key` | string ("all" | "equal" | "notEqual" | "startsWith" | "endsWith" | "contains" | "notContains") | No | notEqual | startsWith | endsWith | contains | notContains | all | Specify the condition to get the projects whose names match the value given in 'searchProjectKey' | | `search_project_name` | string | No | Only the projects whose names match this value based on the condition given in 'searchProject-Key' will be listed ('searchProject-Key' must always accompany 'searchProject-Name parameter) | #### 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 LMS batch sessions **Slug:** `ZOHO_PEOPLE_LIST_LMS_BATCH_SESSIONS` Fetch one page of sessions from a blended-learning LMS batch. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `cursor` | string | No | Opaque cursor returned by the previous page. Pass it unchanged. | | `batch_id` | string | No | Opaque LMS batch ID. Required on the first page. | | `course_id` | string | No | Opaque LMS course ID. Required on the first page. | | `start_index` | integer | No | Zero-based first-page record index. Do not combine with cursor. | #### 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 LMS categories **Slug:** `ZOHO_PEOPLE_LIST_LMS_CATEGORIES` Return one page of Zoho People LMS course categories. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `next_cursor` | string | No | Zero-based continuation startIndex; omit for the first 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 LMS courses **Slug:** `ZOHO_PEOPLE_LIST_LMS_COURSES` Return one page of all LMS courses or the connected user's courses with documented filters. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `state` | string ("drafted" | "published" | "disabled") | No | Filter by course state. | | `search` | string | No | Match course names containing this text. | | `sort_by` | string ("name" | "-name") | No | Sort course names ascending or descending. | | `end_date` | string | No | Filter courses through this provider-formatted date or Unix epoch-millisecond value. | | `collection` | string ("all" | "mine") | Yes | Choose all visible courses or courses joined by the connected user. | | `start_date` | string | No | Filter courses starting at this provider-formatted date or Unix epoch-millisecond value. | | `trainer_id` | string | No | Filter by trainer ID. | | `category_id` | string | No | Filter by category ID; Zoho also accepts MyfavouriteCategories. | | `course_type` | integer ("1" | "2" | "3") | No | Filter by course type: 1 self-paced, 2 blended, or 3 e-material. | | `next_cursor` | string | No | Opaque cursor from a previous response. Omit for the first page. | | `shared_to_me` | boolean | No | Filter to courses shared with the connected user. | | `suggested_to_me` | boolean | No | Filter to courses suggested to the connected user. | #### 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 LMS modules **Slug:** `ZOHO_PEOPLE_LIST_LMS_MODULES` Fetch one page of modules from a self-paced course or a fixed blended-learning batch route. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `cursor` | string | No | Opaque cursor returned by the previous page. Pass it unchanged. | | `target` | string ("self_paced_course" | "batch") | No | Module collection to list. Required on the first page. | | `batch_id` | string | No | Opaque LMS batch ID; required for a batch on the first page. | | `course_id` | string | No | Opaque LMS course ID. Required on the first page. | | `start_index` | integer | No | Zero-based first-page record index. Do not combine with cursor. | #### 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 LMS rooms **Slug:** `ZOHO_PEOPLE_LIST_LMS_ROOMS` Return one page of up to 25 rooms available for LMS sessions. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `next_cursor` | string | No | Zero-based continuation startIndex; omit for the first 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 LMS trainers **Slug:** `ZOHO_PEOPLE_LIST_LMS_TRAINERS` Return one page of LMS trainers with employee-status and sort filters. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `sort_by` | string ("asc" | "desc") | No | Sort direction. | | `next_cursor` | string | No | Opaque cursor from a previous response; omit for the first page. | | `employee_status` | string ("active" | "inactive") | No | Filter trainers by employee 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 | ### List on-duty requests **Slug:** `ZOHO_PEOPLE_LIST_ON_DUTY_REQUESTS` Return one page of on-duty requests or approvals for the connected user's role. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `cursor` | string | No | Start-index cursor returned by a previous call. | | `end_date` | string | No | Request end date in organization format. | | `operation` | string ("requests" | "approvals") | Yes | Connected-user requests or approvals requiring action. | | `start_date` | string | No | Request start date in organization format. | | `approval_status` | integer ("-3" | "1" | "-1" | "0") | No | Approval status: -3 all, 1 approved, -1 pending, or 0 rejected. | | `request_statuses` | array | No | Request statuses in Zoho's documented encoded set. | | `employee_record_numbers` | array | No | Employee record numbers for requests. | #### 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 on-duty types **Slug:** `ZOHO_PEOPLE_LIST_ON_DUTY_TYPES` Return configured on-duty request types. #### 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 performance library items **Slug:** `ZOHO_PEOPLE_LIST_PERFORMANCE_LIBRARY_ITEMS` Return one page of competencies, KRAs, skills, or review questions. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `limit` | integer | No | Maximum records to return, up to 200. | | `cursor` | string | No | Opaque cursor returned by the previous page. Pass it unchanged. | | `resource` | string ("competencies" | "kras" | "skills" | "review_questions") | No | Performance-library resource to list. Required on the first 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 related form records **Slug:** `ZOHO_PEOPLE_LIST_RELATED_FORM_RECORDS` Return one page of records related through a parent module and lookup field. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `cursor` | string | No | Cursor returned by a previous call; omit for the first page. | | `start_index` | integer | No | One-based starting record index. | | `parent_module` | string | Yes | Parent module from which the relationship is traversed. | | `form_link_name` | string | Yes | Zoho form link name containing the related records. | | `parent_record_id` | string | Yes | Parent record ID whose related records are returned. | | `lookup_field_name` | string | No | Lookup field defining the relationship, when required. | #### 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 shift mappings **Slug:** `ZOHO_PEOPLE_LIST_SHIFT_MAPPINGS` Return one V3 page of employee shift mappings. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `cursor` | string | No | Zero-based offset cursor returned by a previous call. | | `to_date` | string | Yes | End date in the organization's date format. | | `from_date` | string | Yes | Start date in the organization's date format. | | `employee_zoho_id` | string | No | Employee Zoho 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 | ### List time logs **Slug:** `ZOHO_PEOPLE_LIST_TIME_LOGS` Return one legacy page of time logs with employee, project, job, date, billing, and approval filters. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `user` | string | Yes | Email-ID | Employee-ID > | Specify user whose timelogs needs to be fetched | | `limit` | string | No | Specify the number of records to be fetched.Maximum value is 200 | | `cursor` | string | No | Continuation offset returned by the previous call. | | `job_id` | string | No | Specify jobId for which timelogs needs to be fetched | | `s_index` | string | No | Specify from which record the response should be fetched | | `to_date` | string | No | Range end in yyyy-MM-dd or the company date format named by date_format. | | `client_id` | string | No | Specify the client id for which timelogs needs to be fetched | | `from_date` | string | No | Range start in yyyy-MM-dd or the company date format named by date_format. | | `project_id` | string | No | Specify the project Id based on which timelogs needs to be fetched | | `date_format` | string | No | Format used by from_date and to_date; defaults to the company's date format. | | `billing_status` | string | No | Filter by billable, non-billable (also non billable or nonbillable), all, or the documented aliases 0, 1, and -1. | | `approval_status` | string ("approved" | "unapproved" | "all") | No | all > | all | Specify the approvalStatus based on which timelogs needs to be fetched | | `is_comments_count` | boolean | No | false | Fetches the comments count of the timer timelog | #### 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 timesheets **Slug:** `ZOHO_PEOPLE_LIST_TIMESHEETS` Return one legacy timesheet page for a required user with documented status and date filters. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `user` | string | Yes | Email ID, employee ID, employee record number, or all. | | `limit` | integer | No | Records to return; maximum 200. | | `cursor` | string | No | Opaque cursor from the previous page. | | `s_index` | integer | No | Zero-based first record offset. | | `to_date` | string | No | End of the timesheet date range. | | `from_date` | string | No | Start of the timesheet date range. | | `date_format` | string | No | Format used by from_date and to_date. | | `approval_status` | string ("draft" | "pending" | "approved" | "rejected" | "all") | No | Timesheet approval status. | | `employee_status` | string ("users" | "nonusers" | "usersandnonusers" | "logindisabled") | No | Employee status to include. | #### 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 time-tracker resources **Slug:** `ZOHO_PEOPLE_LIST_TIME_TRACKER_RESOURCES` Return one V3 page of clients, projects, or jobs with resource-specific filters. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `limit` | integer | No | Specify the number of records to be fetched. Maximum value is 200 | | `cursor` | string | No | Opaque cursor returned by the previous call. | | `offset` | integer | No | Specify from which record the response should be fetched | | `owners` | string | No | Employee-ID > String JSON Array | all | Specify the users by whom the jobs are assigned. The maximum number of Ids allowed is 10. | | `operation` | string ("clients" | "projects" | "jobs") | Yes | Documented operation to execute. | | `client_ids` | array | No | Specify the client Ids to get the projects associated with it. The maximum number of Ids allowed is 10. | | `job_status` | string ("IN_PROGRESS" | "COMPLETED" | "all") | No | Job status. Use all to omit the filter and return every status. | | `date_format` | string | No | Specify the format in which the dates should be provided | | `project_ids` | array | No | Specify the project Ids which the jobs are associated with. Maximum allowed is 1. | | `search_text` | string | No | Only the clients whose names match this value based on the condition given in 'search_match_type' will be listed ('search_match_type' must always accompany 'search_text' parameter) | | `project_heads` | string | No | Employee-ID > String JSON Array | all | Specify the project heads. The maximum number of Ids allowed is 10. | | `assigned_users` | string | No | Email-ID | Employee-ID > String JSON Array | current user | Specify the users whose projects should be listed. The maximum number of Ids allowed is 10. | | `project_status` | string ("IN_PROGRESS" | "COMPLETED" | "all") | No | Project status. Use all to omit the filter and return every status. | | `project_managers` | string | No | Employee-ID > String JSON Array | all | Specify the project managers. The maximum number of Ids allowed is 10. | | `include_job_count` | boolean | No | Fetches the number of jobs mapped to the project | | `search_match_type` | string ("EQUAL" | "NOT_EQUAL" | "STARTS_WITH" | "ENDS_WITH" | "CONTAINS" | "NOT_CONTAINS") | No | STARTS_WITH | ENDS_WITH | CONTAINS | NOT_CONTAINS | CONTAINS | Specify the condition to get the clients whose names match the value given in 'search_match_type' | | `include_user_count` | boolean | No | Fetches the number of users assigned to the project | | `include_logged_hours` | boolean | No | Fetches the total hours logged for the jobs | | `include_client_details` | boolean | No | Specify whether to include client details of jobs or not | #### 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 untagged performance items **Slug:** `ZOHO_PEOPLE_LIST_UNTAGGED_PERFORMANCE_ITEMS` Return one page of KRAs or competencies not tagged to selected employees. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `limit` | integer | No | Maximum records to return, up to 200. | | `cursor` | string | No | Opaque cursor returned by the previous page. Pass it unchanged. | | `resource` | string ("kras" | "competencies") | No | Untagged performance resource to list. Required on the first page. | | `employees` | array | No | Employee record identifiers used for the untagged lookup. Required on the first 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 variable groups **Slug:** `ZOHO_PEOPLE_LIST_VARIABLE_GROUPS` Return one page of variable groups using the V3 index selector. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `index` | integer | No | Zero-based provider start index. | | `cursor` | string | No | Cursor returned by a previous call; omit for the first 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 variables **Slug:** `ZOHO_PEOPLE_LIST_VARIABLES` Return one page of variables using the V3 index selector. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `index` | integer | No | Zero-based provider index at which to start returning variables. | | `cursor` | string | No | Cursor returned by a previous call; omit for the first 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 views **Slug:** `ZOHO_PEOPLE_LIST_VIEWS` Return the default and custom Zoho People views available to the connected user. #### 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 work items **Slug:** `ZOHO_PEOPLE_LIST_WORK_ITEMS` Return one legacy page of work items for an employee or job. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `limit` | string | No | Specify the number of records to be fetched. Maximum value is 200 | | `cursor` | string | No | Continuation offset returned by the previous call. | | `erecno` | string | No | Specify the erecno of the employee | | `job_id` | string | No | Specify the job ID | | `s_index` | string | No | Specify from which record the response should be fetched | | `include_default_workitems` | boolean | No | false | To fetch the default workItems | #### 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 | ### Mark LMS session attendance **Slug:** `ZOHO_PEOPLE_MARK_LMS_SESSION_ATTENDANCE` Record Present or Absent for one learner in a completed LMS session; this externally visible attendance mutation is not a read operation. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `status` | string ("Present" | "Absent") | Yes | Attendance value to record. | | `batch_id` | string | Yes | Opaque LMS batch ID. | | `course_id` | string | Yes | Opaque LMS course ID. | | `module_id` | string | Yes | Opaque LMS module ID. | | `session_id` | string | Yes | Opaque LMS session ID. | | `learner_erecno` | string | Yes | Employee record number of the enrolled learner. | #### 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 | ### Publish LMS course or batch **Slug:** `ZOHO_PEOPLE_PUBLISH_LMS_RESOURCE` Publish a self-paced course or blended-learning batch. This changes external learner visibility and can irreversibly notify applicable users. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `target` | string ("self_paced_course" | "batch") | Yes | Use the self-paced course route or the blended-learning batch route. | | `batch_id` | string | No | Opaque LMS batch ID; required only when target is batch. | | `course_id` | string | Yes | Opaque Zoho People LMS course ID. | | `notify_applicable_users` | boolean | No | Whether Zoho should notify applicable users. Batch publication defaults to true when omitted; the course page documents no default. | #### 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 LMS course learner **Slug:** `ZOHO_PEOPLE_REMOVE_LMS_COURSE_LEARNER` Remove one learner enrollment from a Zoho People LMS course. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `course_id` | string | Yes | Opaque LMS course ID. | | `learner_id` | string | Yes | Opaque LMS learner ID returned by an enrollment operation. | #### 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 form records **Slug:** `ZOHO_PEOPLE_SEARCH_FORM_RECORDS` Return one page of employee form records matching a field, operator, and value. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `cursor` | string | No | Cursor returned by a previous call; omit for the first page. | | `start_index` | integer | No | One-based starting record index. | | `search_params` | string | Yes | Pipe-separated Zoho search objects with searchField, searchText, optional searchOperator, and optional searchCriteria (AND or OR). Operators: True, False, Is, Is_Not, Is_Empty, Is_Not_Empty, Starts_With, Ends_With, Like, Contains, Not_Contains, Lesser_Than, Greater_Than, Lesser_than_or_equal_to, Before, Greater_than_or_equal_to, After, Between, Yesterday, Today, Tomorrow, Last_7_Days, Last_30_Days, Last_60_Days, Last_90_Days, Last_120_Days, Next_7_Days, Next_30_Days, Next_60_Days, Next_90_Days, Next_120_Days, Last_Month, This_Month, Next_Month, Current_and_Previous_Month, Current_and_Next_Month, Last_Year, This_Year, Next_Year, Last_2_Years, Next_2_Years, Current_and_Previous_Year, Current_and_Next_Year. searchOperator defaults to Contains and searchCriteria defaults to AND; Between takes two semicolon-separated searchText values. Example: {searchField:'Employeestatus',searchOperator:'Is',searchText:'Active',searchCriteria:'AND'}|{searchField:'Role',searchOperator:'Is',searchText:'Team Member'}. | #### 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 | ### Set file acknowledgement **Slug:** `ZOHO_PEOPLE_SET_FILE_ACKNOWLEDGEMENT` Acknowledge a Zoho People V3 policy file or revoke its acknowledgement. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `file_id` | string | Yes | Policy file ID to acknowledge or revoke acknowledgement for. | | `latitude` | string | No | Request latitude. | | `longitude` | string | No | Request longitude. | #### 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 | ### Start timer **Slug:** `ZOHO_PEOPLE_START_TIMER` Start a legacy timer for a documented time-tracker item. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `user` | string | Yes | Employee-ID > | Specify the current user's value | | `timer` | string | No | Fixed start operation; injected when omitted. | | `job_id` | string | Yes | Specify jobId for which timer needs to be started | | `work_date` | string | Yes | Work date in yyyy-MM-dd or the company date format named by date_format. | | `work_item` | string | No | Specify the workitem (maximum length is 500) | | `project_id` | string | No | Specify the project Id based on which timer needs to be started | | `date_format` | string | No | Format used by work_date; defaults to the company's date format. | | `description` | string | No | Specify the description(maximum length is 250) | | `billing_status` | string | Yes | Specify the billing status. Documented aliases include non billable, nonbillable, all, 0, 1, and -1; Zoho's example uses Billable. | #### 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 | ### Tag employee performance items **Slug:** `ZOHO_PEOPLE_TAG_EMPLOYEE_PERFORMANCE_ITEMS` Tag up to 20 existing KRAs, competencies, or skills to one employee. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `kras` | array | No | KRAs to tag. | | `skills` | array | No | Skills to tag. | | `employee` | string | Yes | Employee record identifier. | | `resource` | string ("kras" | "competencies" | "skills") | Yes | Performance resource to tag. | | `competencies` | array | No | Competencies to 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 | ### Update attendance entry **Slug:** `ZOHO_PEOPLE_UPDATE_ATTENDANCE_ENTRY` Edit one V3 attendance entry by entry ID. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `date` | string | No | Origin date in organization format when outside the current year. | | `entry_id` | string | Yes | Attendance entry ID. | | `punch_in` | string | No | Punch-in timestamp in the organization's date-time format. | | `punch_out` | string | No | Punch-out timestamp in the organization's date-time format. | | `punch_in_note` | string | No | Punch-in note. | | `punch_out_note` | string | No | Punch-out note. | #### 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 compensatory request **Slug:** `ZOHO_PEOPLE_UPDATE_COMPENSATORY_REQUEST` Edit a V3 compensatory-off request by record ID. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `unit` | string ("Days" | "Hours") | Yes | Compensatory request unit. | | `reason` | string | No | Reason for the request. | | `duration` | string | Yes | For Days, FULL_DAY, HALF_DAY, or QUARTER_DAY; for Hours, HH:MM or a numeric number of hours. | | `record_id` | string | Yes | Compensatory request record ID. | | `expiry_date` | string | No | Compensatory request expiry date. | | `worked_date` | string | Yes | Date on which the employee worked. | | `worked_time_to` | string | No | Worked end time in HH:MM format. | | `employee_zoho_id` | string | Yes | Employee Zoho record number. | | `worked_time_from` | string | No | Worked start time in HH:MM format. | #### 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 currencies **Slug:** `ZOHO_PEOPLE_UPDATE_CURRENCIES` Update one named compensation currency or multiple currencies. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | JSON object for one currency or JSON array for many; each entry needs currency_id and exchange_rate or format_type. | | `operation` | string ("one" | "many") | Yes | Select the documented single-currency or multi-currency update contract. | | `currency_id` | string | No | Currency ID in the single-currency endpoint path. | #### 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 employee performance items **Slug:** `ZOHO_PEOPLE_UPDATE_EMPLOYEE_PERFORMANCE_ITEMS` Update an employee's tagged KRAs, competencies, or skills. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `kras` | array | No | Tagged KRAs to update. | | `skills` | array | No | Tagged skills to update. | | `employee` | string | Yes | Employee record identifier. | | `resource` | string ("kras" | "competencies" | "skills") | Yes | Tagged resource to update. | | `competencies` | array | No | Tagged competencies 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 employee salary **Slug:** `ZOHO_PEOPLE_UPDATE_EMPLOYEE_SALARY` Update an employee salary record. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `date_format` | string | Yes | Date format used by the effective date, such as dd-MMM-yy. | | `breakup_data` | string | No | Optional JSON array of component rows for organizations with salary structure enabled; omit for employee-pay-only mode. | | `revision_data` | string | Yes | JSON object containing employee, revised CTC, effective date, reason, and currency. | #### 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 file **Slug:** `ZOHO_PEOPLE_UPDATE_FILE` Update a V3 file's metadata or content and optionally send email or feed notifications. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `file_id` | string | Yes | ID of the file to edit. | | `role_id` | array | No | Role IDs for an employee file. | | `latitude` | string | No | Request latitude. | | `file_name` | string | No | Updated file name. | | `file_type` | integer ("0" | "1" | "2") | No | 0 employee, 1 organization, or 2 personal file. | | `folder_id` | string | No | Destination folder ID. | | `longitude` | string | No | Request longitude. | | `folder_name` | string | No | New destination folder name. | | `notify_mail` | boolean | Yes | Whether to send an email notification. | | `upload_file` | object | Yes | Required replacement file, up to 5000 KB. | | `valid_until` | string | No | File expiry date in Zoho's date format. | | `notify_feeds` | boolean | No | Whether to send a feed notification. | | `is_from_zapier` | boolean | No | Whether the edit originated from Zapier. | | `file_description` | string | No | Updated description. | | `view_download_permission` | integer ("0" | "1" | "2") | Yes | Required view and download permission code: 0 enables both, 1 disables both, and 2 enables viewing only. | | `reporting_manager_permission` | integer ("0" | "1" | "2") | No | Reporting-manager permission code. | #### 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 file folder **Slug:** `ZOHO_PEOPLE_UPDATE_FILE_FOLDER` Rename or move a Zoho People V3 file folder. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `latitude` | string | No | Request latitude. | | `folder_id` | string | Yes | Folder ID to edit. | | `longitude` | string | No | Request longitude. | | `folder_name` | string | Yes | New folder name. | | `parent_folder_id` | string | No | New parent folder ID when moving the folder. | #### 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 form record **Slug:** `ZOHO_PEOPLE_UPDATE_FORM_RECORD` Update field values and optional tabular rows on an existing Zoho People form record. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `is_draft` | boolean | No | Whether to save the updated record as a draft. | | `record_id` | string | Yes | Record ID returned by the form records API. Keep the full ID as a string. | | `input_data` | object | Yes | JSON object mapping form label names to their replacement values. | | `tabular_data` | object | No | JSON data for tabular-section rows to add, update, or delete. | | `form_link_name` | string | Yes | Form link name containing the record, such as employee. | #### 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 job schedule **Slug:** `ZOHO_PEOPLE_UPDATE_JOB_SCHEDULE` Edit or publish a legacy job schedule using the selected operation. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `date` | string | No | Replacement schedule date in yyyy-MM-dd format. | | `user` | string | No | Specify the user whose job schedules needs to be published. | | `job_id` | string | No | Specify the job id if the existing job needs to be modified | | `todate` | string | No | Specify the date till which the job schedule needs to be published. | | `totime` | string | No | Replacement end time in 24-hour HH:mm format. | | `fromtime` | string | No | Replacement start time in 24-hour HH:mm format. | | `from_date` | string | No | Specify the date from which the job schedule needs to be published. | | `is_repeat` | boolean | No | false | Specify true to repeat this job schedule (if isRepeat is true, then isEditRepeat should not be set as the complete series will be created afresh) | | `operation` | string ("edit" | "publish") | Yes | Documented operation to execute. | | `is_publish` | boolean | No | false | Specify true if the job schedule needs to be published | | `description` | string | No | Specify the description if the existing needs to be modified | | `repeat_type` | string ("daily" | "weekly" | "monthly") | No | monthly> | Specify how often the job schedule should be repeated based on the repeat interval | | `repeat_until` | string | No | Last date in the replacement repeat series, in yyyy-MM-dd format. | | `is_edit_repeat` | boolean | No | false | Specify this key only when the job schedule in the repeat series has to be edited. true - Changes will be applied to the repeat series based on editRepeatType false - Only the mentioned schedule will be updated | | `job_schedule_id` | string | No | Specify the job schedule id whose details needs to be modified | | `repeat_interval` | integer ("1" | "2" | "3" | "4" | "5" | "6" | "7" | "8" | "9" | "10" | "11" | "12") | No | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 10 | 11 | 12> | Specify the interval for which the job schedule needs to be repeated | | `edit_repeat_type` | integer ("1" | "2") | No | 1 | This will be considered only if isEditRepeat is true. 1 - Changes will be applied to the current and the following schedules in the repeat series 2 - Changes will be applied to all the schedules in the repeat series (Allowed only for admin/data admin) | | `skip_max_log_hrs_validation` | boolean | No | false | This key will be considered only if maximum log hours restriction is enabled in the settings. Specify true if the scheduled hours can exceed the maximum log hours configured in the settings | #### 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 leave grant **Slug:** `ZOHO_PEOPLE_UPDATE_LEAVE_GRANT` Edit a V3 leave grant request by record ID. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `reason` | string | No | Reason for the grant request. | | `record_id` | string | Yes | Leave grant record ID. | | `grant_count` | number | No | Number of days or hours to grant. | | `leave_type_id` | string | No | Grant leave type ID. | | `employee_zoho_id` | string | No | Employee Zoho record number. | | `effective_from_date` | string | No | Date from which the grant takes effect. | | `supporting_document` | object | No | Supporting document with file_id, source, and file_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 | ### Update leave setting **Slug:** `ZOHO_PEOPLE_UPDATE_LEAVE_SETTING` Update a V3 holiday, pay-period policy, or work calendar by ID using a closed typed contract. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `days` | object | No | Per-date holiday count and session details. | | `name` | string | No | Pay-period policy name. | | `to_date` | string | No | Holiday end date. | | `frequency` | string ("WEEKLY" | "MONTHLY" | "HALF_MONTHLY") | No | Pay-period frequency. | | `from_date` | string | No | Holiday start date. | | `operation` | string ("holiday" | "pay_period_policy" | "work_calendar") | Yes | Setting type to update. | | `holiday_id` | string | No | Holiday ID for the holiday branch. | | `description` | string | No | Holiday description. | | `holiday_name` | string | No | Holiday name. | | `calendar_year` | object | No | Custom calendar year dates. | | `pay_period_id` | string | No | Pay-period policy ID for that branch. | | `email_reminder` | object | No | Email reminder template and lead days. | | `is_custom_year` | boolean | No | Use a custom calendar year. | | `week_start_day` | string | No | First day of the work week. | | `weekend_pattern` | array | No | Weekend pattern objects encoded as a JSON array. | | `notify_via_feeds` | boolean | No | Notify employees through feeds. | | `work_calendar_id` | string | No | Work calendar ID for that branch. | | `employee_shift_ids` | array | No | Applicable shift IDs. | | `pay_period_end_day` | string | No | Pay period end day. | | `payroll_cutoff_day` | string | No | Payroll cutoff day. | | `applicable_role_ids` | array | No | Applicable role IDs. | | `employee_location_ids` | array | No | Applicable location IDs. | | `is_restricted_holiday` | boolean | No | Whether this is a restricted holiday. | | `statutory_weekend_days` | array | No | Statutory weekend day names. | | `applicable_location_ids` | array | No | Applicable location IDs. | | `lock_data_on_cutoff_day` | boolean | No | Lock attendance data on cutoff day. | | `convert_absences_to_leave` | object | No | Absence-to-leave conversion configuration. | | `enable_encashment_process` | boolean | No | Enable leave encashment processing. | | `holiday_classification_id` | string | No | Holiday classification ID. | | `second_payroll_cutoff_day` | string | No | Second payroll cutoff day for HALF_MONTHLY policies. | | `recalculate_impacted_leaves` | boolean | No | Reprocess affected leaves. | | `payroll_report_generation_day` | string | No | Payroll report generation day. | | `applicable_employment_type_ids` | array | No | Applicable employment type IDs. | | `cutoff_pending_approval_action` | string ("APPROVE" | "REJECT") | No | APPROVE or REJECT pending requests at cutoff. | | `second_payroll_report_generation_day` | string | No | Second report generation day for HALF_MONTHLY policies. | | `apply_location_holidays_to_shift_employees` | boolean | No | Apply location holidays to shift employees. | #### 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 legacy time-tracker client **Slug:** `ZOHO_PEOPLE_UPDATE_LEGACY_TIME_TRACKER_CLIENT` Update a client using the legacy time-tracker contract. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `city` | string | No | Specify the city name | | `state` | string | No | Specify the state name | | `fax_no` | string | No | Specify the fax number | | `country` | string | No | Specify the country name (Example INDIA for India) | | `pincode` | string | No | Specify the pin code | | `compsize` | string | No | Specify the company size | | `currency` | string | No | Specify the currency code (Example INR for India) | | `email_id` | string | No | Specify the email Id | | `industry` | string | No | Specify the industry name | | `phone_no` | string | No | Specify the phone number | | `client_id` | string | Yes | Specify the client Id | | `last_name` | string | No | Specify the last name | | `mobile_no` | string | No | Specify the mobile number | | `first_name` | string | No | Specify the first name | | `client_name` | string | No | Specify the client name | | `description` | string | No | Specify the description | | `street_addr` | string | No | Specify the street address | | `billing_method` | string | No | Optional hourly-job-rate mode using Zoho's verified compact wire token. Omit this field to keep the current method. Zoho names other modes but does not publish their exact legacy wire tokens. | #### 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 legacy time-tracker status **Slug:** `ZOHO_PEOPLE_UPDATE_LEGACY_TIME_TRACKER_STATUS` Change a legacy project or job status. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `job_id` | string | No | Specify the job Id | | `status` | string ("inprogress" | "In-progress" | "Inprogress" | "completed") | No | Legacy project status: inprogress, In-progress, Inprogress, or completed. | | `operation` | string ("project" | "job") | Yes | Documented operation to execute. | | `job_status` | string ("In-Progress" | "Completed") | No | Legacy job status to set. | | `project_id` | string | No | Specify the project ID for which you would like to change the 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 | ### Update LMS session **Slug:** `ZOHO_PEOPLE_UPDATE_LMS_SESSION` Update fields on an existing blended-learning LMS session. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `date` | string | No | Replacement date; Zoho examples use DD-MM-YYYY. | | `name` | string | No | Replacement name. | | `room_id` | string | No | Replacement opaque room ID. | | `batch_id` | string | Yes | Opaque LMS batch ID. | | `end_time` | string | No | Replacement end time in 12-hour clock format. | | `course_id` | string | Yes | Opaque LMS course ID. | | `module_id` | string | Yes | Opaque LMS module ID. | | `lock_until` | string | No | Replacement provider-formatted lock date. | | `session_id` | string | Yes | Opaque LMS session ID. | | `start_time` | string | No | Replacement start time in 12-hour clock format. | | `description` | string | No | Replacement description. | | `session_type` | string ("0" | "1") | No | Replacement type: 0 classroom or 1 e-learning. | | `trainer_erecno` | string | No | Replacement trainer employee record number. | | `grade_category_id` | string | No | Replacement opaque grade category 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 performance library items **Slug:** `ZOHO_PEOPLE_UPDATE_PERFORMANCE_LIBRARY_ITEMS` Update up to 20 competencies, KRAs, skills, or review questions. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `kras` | array | No | KRAs to update. | | `skills` | array | No | Skills to update. | | `resource` | string ("competencies" | "kras" | "skills" | "review_questions") | Yes | Library resource to update. | | `questions` | array | No | Review questions to update. | | `competencies` | array | No | Competencies 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 time log **Slug:** `ZOHO_PEOPLE_UPDATE_TIME_LOG` Edit one legacy time log. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `user` | string | Yes | Employee-ID > | Specify the user | | `hours` | string | No | Decimal-2.5 or Time format-2:30 | | `job_id` | string | No | Specify the job Id if needed to be modified. | | `to_time` | string | No | Time format-2:30PM or 14:30 | | `from_time` | string | No | Time format-2:30PM or 14:30 | | `work_date` | string | No | Replacement work date in yyyy-MM-dd format, or in date_format when supplied. | | `work_item` | string | No | Specify the workitem | | `date_format` | string | No | Specify the date format. If not specified, yyyy-MM-dd format will be taken | | `description` | string | No | Specify the description | | `time_log_id` | string | Yes | Specify the timelog Id whose details needs to be modified | | `billing_status` | string | No | Specify billable or non-billable status if needed; Zoho's example uses Billable. | #### 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 timesheet **Slug:** `ZOHO_PEOPLE_UPDATE_TIMESHEET` Edit a legacy timesheet or replace its attachment. This action can irreversibly submit it for approval or permanently remove its attachment. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `attachment` | object | No | Optional replacement file for the timesheet attachment. | | `description` | string | No | Specify the description | | `timesheet_id` | string | Yes | Specify the timesheet Id | | `timesheet_name` | string | No | Specify the timesheet name | | `sendfor_approval` | boolean | No | Set true to submit for approval. Submission changes workflow state and cannot be undone by this action. | | `remove_attachment` | boolean | No | Set true to permanently remove the current attachment. This cannot be undone. | #### 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 time-tracker status **Slug:** `ZOHO_PEOPLE_UPDATE_TIME_TRACKER_STATUS` Change the status of one V3 project or job. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `job_id` | string | No | Provider value for job_id. | | `operation` | string ("project" | "job") | Yes | Documented operation to execute. | | `job_status` | string ("IN_PROGRESS" | "COMPLETED") | No | New job status. | | `project_id` | string | No | Provider value for project_id. | | `project_status` | string ("IN_PROGRESS" | "COMPLETED") | No | New project 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 | ### Update variable **Slug:** `ZOHO_PEOPLE_UPDATE_VARIABLE` Update one V3 variable by numeric ID or API name. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `name` | string | No | Replacement variable name, 2-100 characters using only letters, numbers, spaces, and underscores. | | `value` | string | No | Replacement value formatted for the variable datatype. | | `api_name` | string | No | Replacement variable API name, 2-100 characters using only letters, numbers, and underscores. | | `identifier` | string | Yes | Variable ID or API name to update. | | `description` | string | No | Replacement variable description, up to 2000 characters. | | `variable_group` | object | No | Variable group identified by exactly one of id or api_name; required for API-name updates. | | `identifier_kind` | string ("id" | "api_name") | Yes | Select the documented ID route or API-name 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 variable group **Slug:** `ZOHO_PEOPLE_UPDATE_VARIABLE_GROUP` Update one V3 variable group by group ID or API name. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `name` | string | Yes | Replacement variable-group name, 2-100 characters using only letters, numbers, spaces, and underscores. | | `api_name` | string | Yes | Replacement variable-group API name, 2-100 characters using only letters, numbers, and underscores. | | `description` | string | No | Replacement group description, up to 2000 characters. | | `identifier_kind` | string ("id" | "api_name") | Yes | Whether group_identifier is a group ID or API name. | | `group_identifier` | string | Yes | Variable-group ID or API name 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 | ### Upgrade employee skills **Slug:** `ZOHO_PEOPLE_UPGRADE_EMPLOYEE_SKILLS` Upgrade a skill for selected employees, optionally attaching a certificate. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `skill` | string | Yes | Skill record ID. | | `employees` | array | Yes | Employee record identifiers whose skill will be upgraded. | | `certificate` | object | No | Optional supporting certificate document. | | `upgrade_reason` | string | No | Reason for the skill upgrade. | #### 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 file **Slug:** `ZOHO_PEOPLE_UPLOAD_FILE` Upload and optionally share a V3 file, notify people, or require acknowledgement by a deadline. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `role_id` | array | No | Role IDs for an employee file. | | `employee` | string | No | Employee record number for an employee file. | | `latitude` | string | No | Upload latitude. | | `file_name` | string | Yes | Name to store for the file. | | `file_type` | integer ("0" | "1" | "2") | No | 0 employee, 1 organization, or 2 personal file. | | `folder_id` | string | No | Existing destination folder ID. | | `longitude` | string | No | Upload longitude. | | `folder_name` | string | No | New destination folder name. | | `notify_mail` | boolean | No | Whether to send an email notification. | | `upload_file` | object | Yes | File to upload, up to 5000 KB. | | `valid_until` | string | No | File expiry date in Zoho's documented date format. | | `notify_feeds` | boolean | No | Whether to send a feed notification. | | `file_description` | string | No | Optional file description. | | `file_acknowledgement` | integer ("0" | "1") | No | Set to 1 to require acknowledgement. | | `share_with_organization` | object | No | Organization entity names mapped to entity IDs for sharing. | | `acknowledgement_deadline` | string | No | Acknowledgement due date in Zoho's date format. | | `view_download_permission` | integer ("0" | "1" | "2") | No | 0 view/download, 1 neither, or 2 view only. | | `reporting_manager_permission` | integer ("0" | "1" | "2") | No | Reporting-manager access code for employee files. | #### 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 time and attendance file **Slug:** `ZOHO_PEOPLE_UPLOAD_TIME_ATTENDANCE_FILE` Upload an attachment for a documented time, attendance, or leave resource. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `file` | object | Yes | Attachment to upload to Zoho People. | | `purpose` | string ("leave_grant" | "leave_request" | "compensatory_request" | "attendance_entry" | "client" | "project" | "job") | Yes | Documented resource that will consume the returned local file 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 | ### Create or update legacy file folder **Slug:** `ZOHO_PEOPLE_UPSERT_LEGACY_FILE_FOLDER` Create or rename a legacy Zoho People file folder using its documented GET mutation. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `folder_id` | string | No | Existing folder ID to rename; omit to create. | | `new_folder_name` | string | Yes | New or replacement folder name. | | `parent_folder_id` | string | No | Parent folder ID; omit to create a root folder. | #### 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 |