Create an onboarding for an existing employee
Start the onboarding of an employee who already exists in Primo: creates the onboarding, its ticket and the “Confirm onboarding information” task, then the admins run the email, SaaS provisioning and equipment steps from the cockpit according to the onboarding settings. The employee must exist first — createEmployee only creates the record and never starts an onboarding, so call it, then this operation with the returned id. Refused when the employee already has an open onboarding (ONBOARDING_ALREADY_EXISTS), is synchronised from a connected HRIS (EMPLOYEE_MANAGED_BY_HRIS — that HRIS drives their onboarding), is hidden or has already left, when no start date is known (send startDate or set it on the employee first), or when onboarding tickets are not enabled for the company. A start date in the past is accepted for a joiner already in post. To act on an onboarding that already exists, use getOnboardings, completeOnboarding, ignoreOnboarding or executeOnboardingEquipment instead.
Authorizations
Use your Primo API key in the Authorization header as Bearer <API_KEY>.
Body
Primo employee id of the joiner. Get it from getEmployees or createEmployee.
^[a-f\d]{24}$First day of the joiner (ISO 8601), past or future. Omit to use the start date already on the employee record; when sent, the employee record is updated to match.
^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z))$Response
PENDING, SCHEDULED, IN_PROGRESS, CLOSED, CANCELED COCKPIT, MERGE, KOMBO, API ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z))$HR records from the connected HRIS (Kombo) for this onboarding
^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z))$