Rippling: Create bulk draft hire — request body — body draft hires item

API reference · Contract 2026-10-28

SDK schema: Create bulk draft hire — request body — body draft hires item

Field	Type	Presence	Description and constraints
$	object	Root	A draft hire represents a candidate who has been offered a position but hasn’t started yet. This class provides Platform API access to draft hire data stored as RoleWithCompany instances in a candidate state, allowing external systems to create and manage draft hires.
custom_fields	array	Optional	Custom fields for the draft hire
custom_fields[]	Model	Each item	Expand Create bulk draft hire — request body — body draft hires item custom fields item
documents	array	Optional	Documents to attach to this draft hire
documents[]	Model	Each item	Expand Create a new employee document — response body — items item documents item
employment_info	object	Required within parent	Employment information for the draft hire position
employment_info.contract_end_date	string	Optional	Contract end date
employment_info.currency	string	Optional	Currency
employment_info.department_id	string	Optional	Department ID
employment_info.duties	string	Optional	Duties
employment_info.eeoc_job_classification	string	Optional	EEOC job classification (e.g., EXECUTIVE, MID_LEVEL, PROFESSIONALS, TECHNICIANS, SALES_WORKERS, SUPPORT_WORKERS, CRAFT_WORKERS, OPERATIVES, HELPERS, SERVICE_WORKERS)
employment_info.employment_type_id	string	Required within parent	Employment type ID
employment_info.equity_num_shares	integer	Optional	Equity number of shares
employment_info.equity_value	number	Optional	Equity value
employment_info.equity_vesting_schedule	Model	Optional	Expand Create bulk draft hire — request body — body draft hires item employment info equity vesting schedule
employment_info.job_family_id	string	Optional	Job family ID
employment_info.job_title	string	Optional	Job title
employment_info.legal_entity_id	string	Optional	Legal entity ID
employment_info.level_id	string	Optional	Level ID
employment_info.manager_id	string	Optional	Manager ID
employment_info.offer_expiration_date	string	Optional	Offer expiration date
employment_info.on_target_commission	number	Optional	On target commission
employment_info.overtime_exemption	string	Optional	Overtime exemption One of: exempt, non-exempt
employment_info.probation_end_date	string	Optional	Probation end date
employment_info.relocation_reimbursement	number	Optional	Relocation reimbursement
employment_info.salary_per_unit	number	Optional	Salary per unit
employment_info.salary_unit	string	Optional	Salary unit
employment_info.signing_bonus	number	Optional	Signing bonus
employment_info.start_date	string	Optional	Start date
employment_info.target_annual_bonus	number	Optional	Target annual bonus
employment_info.target_annual_bonus_percent	number	Optional	Target annual bonus as a percentage
employment_info.teams_ids	array	Optional	Teams IDs
employment_info.teams_ids[]	string	Each item
employment_info.title	string	Required within parent	Title
employment_info.weekly_hours	number	Optional	Weekly hours
employment_info.work_email	string	Optional	Work email
headcount_info	object	Optional	Headcount planning info for hiring into a position. If provided, the draft hire will be linked to the specified open headcount allocation. Requires headcount planning to be enabled for the company.
headcount_info.position_id	string	Required within parent	The Position ID (PID) of the headcount allocation to fill (e.g., PID100615)
personal_info	object	Required within parent	Personal information for the draft hire candidate
personal_info.citizenship	string	Optional	Citizenship of the candidate
personal_info.date_of_birth	string	Optional	Date of birth
personal_info.emergency_contact_name	string	Optional	Emergency contact name
personal_info.emergency_contact_phone	Model	Optional	Expand Create bulk draft hire — request body — body draft hires item personal info emergency contact phone
personal_info.ethnicity	string	Optional	Ethnicity of the candidate
personal_info.gender	string	Optional	Gender of the candidate
personal_info.home_address	Model	Optional	Expand Create bulk draft hire — request body — body draft hires item personal info home address
personal_info.invite_email	string	Required within parent	Invite email of the candidate
personal_info.locale	Model	Optional	Expand Create bulk draft hire — request body — body draft hires item personal info locale
personal_info.name	Model	Required within parent	Expand Create bulk draft hire — request body — body draft hires item personal info name
personal_info.personal_phone	Model	Optional	Expand Create bulk draft hire — request body — body draft hires item personal info personal phone
personal_info.race	string	Optional	Race of the candidate
personal_info.ssn	string	Optional	Social security number of the candidate
work_location_info	object	Required within parent	Work location information
work_location_info.country_code	string	Optional	Country code of the work location
work_location_info.is_remote	boolean	Optional	Whether the work location is remote
work_location_info.location_id	string	Optional	Work location ID
work_location_info.state_code	string	Optional	State code of the work location

Referenced models: Create a new employee document — response body — items item documents item, Create bulk draft hire — request body — body draft hires item personal info home address, Create bulk draft hire — request body — body draft hires item custom fields item, Create bulk draft hire — request body — body draft hires item employment info equity vesting schedule, Create bulk draft hire — request body — body draft hires item personal info locale, Create bulk draft hire — request body — body draft hires item personal info name, Create bulk draft hire — request body — body draft hires item personal info personal phone, Create bulk draft hire — request body — body draft hires item personal info emergency contact phone