API Reference

Create a New Hire

post
https://{hostname}/talent/onboarding/v2/tenants//new-hires

Create a single New Hire

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

Unique identifier of the tenant to interact with. Can be either the tenant alias or tenant ID.

Body Params

New Hire object to be added.

contactInformation
object

Contact information for the new hire

job
object

Job information for the new hire

organizationLevels
array of objects
organizationLevels
compensation
object

Compensation information for the new hire

string

External user identifier of the onboarding owner

string

Customer-provided identifier to track the new hire against their own system

date-time | null

Hire date of the new hire

date-time | null

Orientation date of the new hire

date-time | null

Start date of the new hire

string | null

Reason why the new hire start date is 4 or more business days in the past

mentor
object | null

Mentor for the new hire

string
length ≤ 250

Personal message for the new hire

platformConfigurationFields
array of objects

An array of Platform Configuration Field values to set on the new hire.

platformConfigurationFields
Headers
string
enum
Defaults to application/json

Generated from available response content types

Allowed:
Responses

Updated 7 days ago

Did this page help you?
Language
Credentials
OAuth2
URL
LoadingLoading…
Response
Choose an example:
application/json
application/problem+json

Updated 7 days ago

Did this page help you?