- Overview
- Authentication
- 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
- Timesheet API
- Onboarding API
- Announcements API
- Leave API
- Attendance 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
- LMS API
- Files API
- View API
- Status Codes
- Error Codes API
- HTTP Request Methods
Trigger Onboarding API
This API is used to trigger onboarding for an existing candidate or employee.
Request URL:
https://people.zoho.com/api/<Employee|Candidate>/triggerOnboarding
Header:
Authorization: Zoho-oauthtoken 1000.8cb99dxxxxxxxx9be93.9b8xxxxxxf
Request Parameter:
userId | Specify the record ID of the candidate employee |
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.
Request URL
Copiedhttps://people.zoho.com/api/<Employee|Candidate>/triggerOnboarding
Header
CopiedAuthorization: Zoho-oauthtoken 1000.8cb99dxxxxxxxx9be93.9b8xxxxxxf
Response
Copied{
"msg": "success"
}
© 2025, Zoho Corporation Pvt. Ltd. All Rights Reserved.