post http://example.com/.saplingapp.io/api/v1/beta/pendinghires
Create a new pending hire in Sapling. Once created, a Sapling user can initiate onboarding for this pending hire, converting them to a User.
Required fields in the payload are:
- personalEmail (personal email of the pending hire)
- firstName (first name of the pending hire)
- lastName (last name of the pending hire)
- startDate (expected start date of the pending hire)
- source (caller's root web URL e.g. https://www.saplinghr.com)
Note that you may want to supply preferredName equal to firstName if preferredName isn't explicitly defined in the source application to improve searchability and display of the pending hire in Sapling.