Rippling: Create hire — request body — body hires item related records
Create hire: request body, field body / hires / item / related_records. Complete fields and constraints for contract 2026-10-28.
API reference · Contract 2026-10-28
SDK schema: Create hire — request body — body hires item related records
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | References that associate this hire with recruiting, headcount planning, a prior employment record, or an existing Rippling hiring process. These references control hiring behavior; they are not arbitrary metadata. Omit the object when no association applies. Additional keys: not allowed |
ats_applicant_id | string | Optional | Rippling Recruiting applicant/application ID for the ATS application that produced this hire. Obtain it from GET /candidate-applications/. Omit when the hire is not linked to a Rippling ATS application. |
existing_role_id | string | Optional | Rippling role ID for an in-progress hire to continue instead of starting another hiring process. Use the ID returned by a prior hire result when instructed to continue that hire. |
headcount_position_id | string | Optional | Rippling headcount-position ID for the approved or open position this person will fill. Obtain it from GET /headcount-positions/. |
rehire_choice | string | Optional | How to initialize the rehire identified by rehire_role_id. REUSE_WORKER_DETAILS prefills eligible non-compensation details from the prior employment record, while NEW_WORKER_DETAILS starts those hiring questions without that prefill. Both choices rehire the existing person identified by rehire_role_id. The request’s required first_name and last_name do not replace that person’s identity; invite_email or invite_phone supplies the invitation destination for the new role. Required with rehire_role_id; omit otherwise. One of: REUSE_WORKER_DETAILS, NEW_WORKER_DETAILS |
rehire_role_id | string | Optional | Rippling role ID for this person’s prior employment record: the previous role being rehired. When POST /hires/ reports a possible_rehire next action, use its target_id here. Providing this ID starts a rehire and also requires rehire_choice. |