Rippling: POST New Candidate — response body

API reference · Contract 2026-10-28

SDK schema: POST New Candidate — response body

Field	Type	Presence	Description and constraints
$	object	Root	The Rippling candidate model.
attachments	array	Optional
attachments[]	object	Each item	An array of json objects containing file names and public file URLs containing documents pertaining to the candidate.
attachments[].file_name	string	Optional	The file name.
attachments[].file_url	string	Optional	The public URL and name of a pdf/docx/doc/odt file containing documents pertaining to the candidate.
candidateId	string	Optional	The unique identifier of the candidate from the ATS.
currency	string	Optional	A string field of the official currency as listed in ISO 4217.
department	string	Optional	This is the id of the department from GET/departments.
email	string	Optional	The candidate’s email.
employmentType	string	Optional	An ENUM of employment type. Will default to one of these six values unless the employee’s profile has a job display name configured. Known values: CONTRACTOR, SALARIED_PT, SALARIED_FT, HOURLY_FT, HOURLY_PT, TEMP
equityShares	JSON	Optional
equityShares (anyOf 1)	integer	Alternative	The number of shares that will be given to the candidate.
equityShares (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
jobTitle	string	Optional	The candidate’s job title.
name	string	Optional	The candidate’s name.
phoneNumber	string	Optional	The candidate’s phone number.
salaryPerUnit	JSON	Optional
salaryPerUnit (anyOf 1)	number	Alternative	The decimal value that the candidate gets paid every salaryUnit time period.
salaryPerUnit (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
salaryUnit	string	Optional	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. Known values: HOUR, DAY, WEEK, MONTH, PAY_PERIOD
signingBonus	JSON	Optional
signingBonus (anyOf 1)	number	Alternative	The bonus cash given to the candidate as a part of a one time payment, with two decimal digit precision. Format: double
signingBonus (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
startDate	string	Optional	The would-be start date of the candidate. Format: date
workLocation	string	Optional	This is the id of the worklocation from GET/work_locations.