Post Ats Candidates Push Candidate

Pushes a candidate from an applicant tracking system directly into the Rippling onboarding flow. Please note, this endpoint is only available to applications integrating with OAuth2.0.

​

Parameters

Parameter	Description
Attachments	-
Candidate ID	The unique identifier of the candidate from the ATS.
Currency	A string field of the ofifcial currency doe as listed in ISO 4217.
Department	The department name as a string.
Email	The candidate’s email.
Employment Type	The ENUM type of employment the user will have within Rippling.
Equity Shares	The number of shares that will be given to the candidate.
Job Title	The candidate’s job title.
Name	The candidate’s name.
Phone Number	The candidate’s phone number.
Salary Per Unit	The decimal value that the candidate gets paid every salaryUnit time period.
Salary Unit	An ENUM string value, denoting the frequency at which the candidate should be paid once the role begins. Note, the PAY_PERIOD ENUM implies the candidate is paid as per a custom pay period.
Signing Bonus	The bonus cash given to the candidate as a part of a one time payment, with two decimal digit precision.
Start Date	The would-be start date of the candidate.

​

Example Output

{
	"attachments": [
		{
			"file_name": "The file name.",
			"file_url": "The public URL and name of a pdf/docx/doc/odt file containing documents pertaining to the candidate."
		}
	],
	"candidateId": "The unique identifier of the candidate from the ATS.",
	"currency": "A string field of the ofifcial currency doe as listed in ISO 4217.",
	"department": "The department name as a string.",
	"email": "The candidate's email.",
	"employmentType": "The ENUM type of employment the user will have within Rippling.",
	"equityShares": 0,
	"jobTitle": "The candidate's job title.",
	"name": "The candidate's name.",
	"phoneNumber": "The candidate's phone number.",
	"salaryPerUnit": 0,
	"salaryUnit": "An ENUM string value, denoting the frequency at which the candidate should be paid once the role begins. Note, the PAY_PERIOD ENUM implies the candidate is paid as per a custom pay period.",
	"signingBonus": 0,
	"startDate": "The would-be start date of the candidate."
}