Create a Pending Hire

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…

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.

Form Data
string
required
string
required
string
required
string
required
string
required
string
required
string
required
string
required
string
required
string
required
string
required
Headers
string
Defaults to Bearer {token}
Response

Language
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json