Invoke Standalone Function | Zoho People API

Overview
Authentication
- OAuth Authentication
Organization
- GETGet Organization Info API
API Limits
Forms API
- POSTInsert Record API
- POSTInsert Record API for Adding Employees
- POSTUpdate Record API
- GETGet Bulk Records API
- POSTAdd Department API
- GETFetch Forms API
- GETFetch Single Record API
- GETFetch Single Record API (Section Wise)
- GETGet Related Records API
- GETSearch Records Based on Record Values
- Appendix
- GETGet Fields of Form API
Cases API
- POSTAdd Case API
- GETView Case API
- GETView Case Listing API
- GETView List of Categories API
Timesheet API
- Client API
- Projects API
- Jobs API
- Job Schedule API
- Time Logs API
- Timer API
- Timesheets API
- Payroll Report API
- Pay Period Settings API
- Pay Period Details API
- General Settings API
Onboarding API
- POSTTrigger Onboarding API
- POSTAdd Candidate API
- POSTUpdate Candidate API
- POSTReopen API
Announcements API
- POSTAdd Announcements API
- POSTUpdate Announcements API
- GETGet All Announcements API
- GETGet Single Announcement by ID API
- POSTFilter Announcements API
- POSTDelete Announcements API
- POSTEnable or Disable Announcements API
- POSTAdd Announcement Comment API
- POSTDelete Announcement Comment API
Leave API
- Leave Records
- Compensatory Off
- Reports
- Holidays
  - GETGet All Holidays API
- Leave Type Balance Customization
  - POSTCustomize Leave Balance API
  - POSTAdd Leave Balance API
- To Be Deprecated
  - GETGet Leave Types API
  - GETGet Holidays API
Attendance API
- POSTBulk Import API
- GETFetch Last Attendance Entries API
- POSTAttendance Check In Check Out API
- POSTAttendance Entries API
- POSTAttendance User Report API
- POSTEmployee Shift Mapping API
- GETGetting Shift Details Of Employee API
- GETGet Regularization Records API
Compensation API
- GETFetch Components API
- GETFetch Components by ID API
- GETFetch Salary Components API
- GETFetch Packages API
- GETFetch Package by ID API
- GETFetch Package Components API
- GETFetch Currencies API
- GETFetch Currency by ID
- GETFetch Revisions API
- GETFetch Revisions by ERECNO API
- GETFetch Revision Letters by ERECNO API
- GETPreview Revision Letter by Revision ID API
- GETDownload Revision Letter by Revision ID API
- GETFetch My Compensation API
- GETFetch Reasons API
- GETFetch Settings API
- PUTCancel Revision API
- GETFetch Salary API
- GETFetch Single Employee Salary API
- POSTAdd Salary API
- PUTUpdate Salary API
- Compensation API Error Codes
Record Count API
- GETGet Record Count API
LMS API
- Courses API
  - POSTCreate Course API
  - PATCHUpdate Course API
  - DELETEDelete Course API
  - GETFetch Single Course API
  - GETFetch All Course API
  - GETFetch My Courses API
  - GETList Requisite Course Entities API
- Pre Learning Activities API
  - POSTAdd Pre Learning Activity - Online Test
  - PATCHEdit Pre Learning Activity - Online Test
  - DELETEDelete Pre Learning Activity - Online Test
- Post Learning Activities API
  - POSTAdd Post Learning Activity - Online Test
  - PATCHEdit Post Learning Activity - Online Test
  - DELETEDelete Post Learning Activity - Online Test
- Course Action API
  - POSTPublish Course API
  - POSTUnpublish Course API
  - POSTEnable Course API
  - POSTDisable Course API
  - POSTFavourite Course API
  - POSTUnfavourite Course API
  - PUTShare Course API
  - DELETERemove Shared User API
  - GETGet Shared Users List API
  - POSTSuggest Course API
  - GETGet Suggested Course Count API
- Course Learner API
  - POSTEnroll Learner To Course API
  - POSTEnroll Learner To Batch API
  - POSTUnenroll Learner From Course API
  - POSTUnenroll Learner From Batch
  - DELETERemove Learner From Course
  - DELETERemove Learner From Batch
- Batch API
  - POSTCreate Batch API
  - PATCHUpdate Batch API
  - DELETEDelete Batch API
  - GETFetch Single Batch API
  - GETFetch Course Batch List API
- Batch Scheduler API
  - POSTCreate Batch Scheduler API
  - PATCHUpdate Batch Scheduler API
  - DELETEDelete Batch Scheduler API
  - GETFetch Batch Scheduler API
  - GETFetch Batch Scheduler List API
- Batch Action API
  - POSTPublish Batch
  - POSTUnpublish Batch
  - POSTMark Batch As Complete
  - POSTMark Batch As Incomplete API
- Module API
  - POSTCreate Modules API
  - PATCHUpdate Modules API
  - DELETEDelete Modules API
  - GETFetch Single Module API
  - GETFetch Course Module API
- File API
  - POSTCreate Files API
  - PATCHUpdate Files API
  - DELETEDelete Files API
  - GETFetch Single File API
  - GETFetch Module File API
  - GETFetch Course or Batch Files API
- Content API
  - GETFetch Single Content API
  - GETFetch Module Contents API
  - GETFetch Course or Batch Contents API
- Link API
  - POSTCreate Link API
  - PATCHUpdate Link API
  - DELETEDelete Link API
  - GETFetch Single Link API
  - GETFetch Module Links API
  - GETFetch Course or Batch Links API
- Session API
  - POSTCreate Session API
  - PATCHUpdate Session API
  - DELETEDelete Session API
  - GETFetch Single Session API
  - GETFetch Module Sessions API
  - GETFetch Course Batch Sessions API
  - POSTMatk Attendance API
- Offline Test API
  - POSTCreate Offline Test API
  - PATCHUpdate Offline Test API
  - DELETEDelete Offline Test API
  - GETFetch Single Offline Test API
  - GETFetch Module Offline Tests API
  - GETFetch Course or Batch Offline Tests API
  - POSTUpdate Offline Test Marks API
- Online Test API
  - POSTCreate Online Test API
  - PATCHUpdate Online Test API
  - DELETEDelete Online Test API
  - GETFetch Single Online Test API
  - GETFetch Module Online Tests API
- Assignment API
  - POSTCreate Assignment API
  - PATCHUpdate Assignment API
  - DELETEDelete Assignment API
  - GETFetch Single Assignment API
  - GETFetch Module Assignments API
  - POSTUpdate Assignment Marks API
- Settings API
  - POSTFetch Settings API
  - GETFetch Course Settings API
- Trainer API
  - POSTAdd Trainer API
  - DELETEDelete Trainer API
  - GETFetch Single Trainer API
  - GETFetch Trainers List API
- Rooms API
  - GETFetch Single Room API
  - GETFetch Rooms API
- Categories API
  - GETFetch Categories API
- LMS Api Error Codes
Files API
- POSTEdit File API
- GETGetFiles API
- POSTView File API
- POSTDelete Files API
- POSTAdd And Upload File API
- GETFile Acknowledgement Status API
- POSTDownload File API
- GETAdd and Edit Folder API
- GETGetFiles Categories API
- Add File API (Deprecated)
- Upload File API (Deprecated)
View API
- GETDefault And Custom View API
- GETFetch View of a Specific Form API
- GETFetch Record API
Standalone Function
- POSTInvoke Standalone Function
Status Codes
Error Codes API
HTTP Request Methods

Invoke Standalone Function via API

This API is used invoke standalone function in Zoho People.

Request URL:

https://people.zoho.com/api/v3/function/(\w+)/execute

Scope:

ZOHOPEOPLE.automation.ALL

Possible Operation Types:

ALL - Complete access to data

Request Method:

POST

Request Parameters

Parameters	Values Allowed	Description
arguments	<optional parameters in JSON Object>	JSON Input

Error Codes and Descriptions

Status Codes	Description
400	Incorrect function name, invalid method type or runtime deluge error
403	Permission denied to access this api
500	Internal Server Error occurred

Threshold Limit: 30 requests | Lock period: 5 minutes

Threshold Limit - Number of API calls allowed within a minute.
Lock Period - Wait time before consecutive API requests.

Sample Request

Copiedhttps://people.zoho.com/api/v3/function/(\w+)/execute

Header

CopiedAuthorization:Zoho-oauthtoken 1000.8cb99dxxxxxxxxxxxxx9be93.9b8xxxxxxxxxxxxxxxf

Sample Response

CopiedNo response, the HTTP status code will be 204

Invoke Standalone Function via API

Sample Request

Header

Sample Response

Features

Integrated solutions

Partner resources

Quick links

Resources

Help documentation

Let's talk