Rippling: Create a new draft transition — request body — body items item

API reference · Contract 2026-10-28

SDK schema: Create a new draft transition — request body — body items item

Field	Type	Presence	Description and constraints
$	object	Root
changes	object	Required within parent	Requested role/profile changes for this item.
changes.country_specific_info	object	Optional	Country-specific field changes supported by current draft transition flows.
changes.employment_info	object	Optional	Employment information changes for the target role.
changes.employment_info.annual_salary_equivalent	number	Optional	New annual salary equivalent.
changes.employment_info.currency	string	Optional	New compensation currency.
changes.employment_info.department_id	string	Optional	New department identifier for the target role.
changes.employment_info.employment_type_id	string	Optional	New company employment type identifier for the target role.
changes.employment_info.equity_num_shares	integer	Optional	New offer letter equity share count.
changes.employment_info.equity_value	number	Optional	New offer letter equity value.
changes.employment_info.equity_vesting_package_id	string	Optional	New equity vesting package identifier.
changes.employment_info.job_family_id	string	Optional	New job family identifier for the target role.
changes.employment_info.level_id	string	Optional	New level identifier for the target role.
changes.employment_info.manager_id	string	Optional	New manager role identifier for the target role.
changes.employment_info.on_target_commission	number	Optional	New annual on-target commission amount.
changes.employment_info.relocation_reimbursement	number	Optional	New relocation reimbursement amount.
changes.employment_info.salary_per_unit	number	Optional	New compensation amount per salary unit.
changes.employment_info.salary_unit	string	Optional	New salary unit.
changes.employment_info.start_date	string	Optional	New start date for the target role.
changes.employment_info.target_annual_bonus	number	Optional	New target annual bonus amount.
changes.employment_info.target_annual_bonus_payment_frequency_unit	string	Optional	New target annual bonus payment frequency. One of: MONTH, QUARTER, YEAR, SEMI_ANNUAL
changes.employment_info.target_annual_bonus_percent	number	Optional	New target annual bonus percentage.
changes.employment_info.teams_ids	array	Optional	New team identifiers for the target role.
changes.employment_info.teams_ids[]	string	Each item
changes.employment_info.title	string	Optional	New job title for the target role.
changes.work_location_info	object	Optional	Work location changes for the target role.
changes.work_location_info.country_code	string	Optional	New work country code for the target role.
changes.work_location_info.location_id	string	Optional	New work location identifier for the target role.
draft_grouping_preference	string	Optional	Controls whether this item should append to a compatible existing draft or create a new draft. One of: APPEND_TO_MATCHING_DRAFT, CREATE_NEW_DRAFT
role_id	string	Required within parent	Target role identifier for this draft transition item.