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:

userIdSpecify 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"
 }