Skip to content

Rippling: Create bulk draft hire

Rippling restApi.createDraftHires: arguments, response, policy and SDK examples.

← Rest API operations · Get started

Operation rippling.rest_api.create_draft_hires

Provider route: POST /draft-hires/. Alter supplies the connection’s credentials and routing.

Install @alter-ai/sdk @alter-ai/rippling with npm, or alter-sdk-rippling with pip. Supply your connected customer’s grant ID and the arguments described below.

import { App } from "@alter-ai/sdk";
import { RipplingIntegration } from "@alter-ai/rippling";
async function execute(input: Parameters<RipplingIntegration["restApi"]["createDraftHires"]>[0]) {
const app = new App({ apiKey: process.env.ALTER_API_KEY! });
try {
const provider = new RipplingIntegration(app, { grantId: process.env.PROVIDER_GRANT_ID! });
const call = await provider.restApi.createDraftHires(input);
const result = await call.wait();
return result.bodyJson();
} finally {
await app.close();
}
}
import os
from alter_sdk import App
from alter_sdk_rippling import RipplingIntegration
async def execute(arguments):
async with App(api_key=os.environ["ALTER_API_KEY"]) as app:
provider = RipplingIntegration(app, {"grant_id": os.environ["PROVIDER_GRANT_ID"]})
call = await provider.rest_api.create_draft_hires(arguments)
result = await call.wait()
return result.body_json()
FieldTypePresenceDescription and constraints
$objectRootAdditional keys: not allowed
bodyModelOptionalExpand Create bulk draft hire — request body — body

Referenced models: Create bulk draft hire — request body — body

Response media type: application/json. The table describes the pinned successful response. Referenced models link to their complete fields.

FieldTypePresenceDescription and constraints
$objectRootResponse model for bulk draft hire creation.
invalid_itemsarrayOptionalList of invalid draft hire requests
Default: []
invalid_items[]ModelEach itemExpand Create bulk draft hire — response body — invalid items item
successful_resultsarrayOptionalDetailed results for each draft hire item
successful_results[]ModelEach itemExpand Create bulk draft hire — response body — invalid items item

Referenced models: Create bulk draft hire — response body — invalid items item

5 more schemas are linked from the tables above, on the schema pages.

Create bulk draft hire — response body — invalid items item
FieldTypePresenceDescription and constraints
$objectRootResult for an individual draft hire creation.
draft_hire_role_idstringOptionalGenerated draft hire ID if successful
errorsarrayOptionalList of validation errors if any
errors[]stringEach item
messagestringOptionalSuccess or error message
statusstringRequired within parentStatus of the creation (success, error, warning)
Create bulk draft hire — request body — body
FieldTypePresenceDescription and constraints
$objectRoot
draft_hiresarrayRequired within parentList of draft hires
draft_hires[]ModelEach itemExpand Create bulk draft hire — request body — body draft hires item

Referenced models: Create bulk draft hire — request body — body draft hires item

Create bulk draft hire — request body — body draft hires item
FieldTypePresenceDescription and constraints
$objectRoot
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_fieldsarrayOptionalCustom fields for the draft hire
custom_fields[]ModelEach itemExpand Create bulk draft hire — request body — body draft hires item custom fields item
documentsarrayOptionalDocuments to attach to this draft hire
documents[]ModelEach itemExpand Create a new employee document — response body — items item documents item
employment_infoobjectRequired within parentEmployment information for the draft hire position
employment_info.contract_end_datestringOptionalContract end date
employment_info.currencystringOptionalCurrency
employment_info.department_idstringOptionalDepartment ID
employment_info.dutiesstringOptionalDuties
employment_info.eeoc_job_classificationstringOptionalEEOC job classification (e.g., EXECUTIVE, MID_LEVEL, PROFESSIONALS, TECHNICIANS, SALES_WORKERS, SUPPORT_WORKERS, CRAFT_WORKERS, OPERATIVES, HELPERS, SERVICE_WORKERS)
employment_info.employment_type_idstringRequired within parentEmployment type ID
employment_info.equity_num_sharesintegerOptionalEquity number of shares
employment_info.equity_valuenumberOptionalEquity value
employment_info.equity_vesting_scheduleModelOptionalExpand Create bulk draft hire — request body — body draft hires item employment info equity vesting schedule
employment_info.job_family_idstringOptionalJob family ID
employment_info.job_titlestringOptionalJob title
employment_info.legal_entity_idstringOptionalLegal entity ID
employment_info.level_idstringOptionalLevel ID
employment_info.manager_idstringOptionalManager ID
employment_info.offer_expiration_datestringOptionalOffer expiration date
employment_info.on_target_commissionnumberOptionalOn target commission
employment_info.overtime_exemptionstringOptionalOvertime exemption
One of: exempt, non-exempt
employment_info.probation_end_datestringOptionalProbation end date
employment_info.relocation_reimbursementnumberOptionalRelocation reimbursement
employment_info.salary_per_unitnumberOptionalSalary per unit
employment_info.salary_unitstringOptionalSalary unit
employment_info.signing_bonusnumberOptionalSigning bonus
employment_info.start_datestringOptionalStart date
employment_info.target_annual_bonusnumberOptionalTarget annual bonus
employment_info.target_annual_bonus_percentnumberOptionalTarget annual bonus as a percentage
employment_info.teams_idsarrayOptionalTeams IDs
employment_info.teams_ids[]stringEach item
employment_info.titlestringRequired within parentTitle
employment_info.weekly_hoursnumberOptionalWeekly hours
employment_info.work_emailstringOptionalWork email
headcount_infoobjectOptionalHeadcount 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_idstringRequired within parentThe Position ID (PID) of the headcount allocation to fill (e.g., PID100615)
personal_infoobjectRequired within parentPersonal information for the draft hire candidate
personal_info.citizenshipstringOptionalCitizenship of the candidate
personal_info.date_of_birthstringOptionalDate of birth
personal_info.emergency_contact_namestringOptionalEmergency contact name
personal_info.emergency_contact_phoneModelOptionalExpand Create bulk draft hire — request body — body draft hires item personal info emergency contact phone
personal_info.ethnicitystringOptionalEthnicity of the candidate
personal_info.genderstringOptionalGender of the candidate
personal_info.home_addressModelOptionalExpand Create bulk draft hire — request body — body draft hires item personal info home address
personal_info.invite_emailstringRequired within parentInvite email of the candidate
personal_info.localeModelOptionalExpand Create bulk draft hire — request body — body draft hires item personal info locale
personal_info.nameModelRequired within parentExpand Create bulk draft hire — request body — body draft hires item personal info name
personal_info.personal_phoneModelOptionalExpand Create bulk draft hire — request body — body draft hires item personal info personal phone
personal_info.racestringOptionalRace of the candidate
personal_info.ssnstringOptionalSocial security number of the candidate
work_location_infoobjectRequired within parentWork location information
work_location_info.country_codestringOptionalCountry code of the work location
work_location_info.is_remotebooleanOptionalWhether the work location is remote
work_location_info.location_idstringOptionalWork location ID
work_location_info.state_codestringOptionalState 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

Create a new employee document — response body — items item documents item
FieldTypePresenceDescription and constraints
$objectRootA document to attach to a draft hire, referencing a pre-uploaded file.
file_idstringRequired within parentId of a FileUploadTracker in ACTIVE status whose file should become a document on the hire
namestringOptionalDocument name. Defaults to the uploaded file name when omitted.
signature_datestringOptionalSignature date in YYYY-MM-DD format.
Create bulk draft hire — request body — body draft hires item custom fields item
FieldTypePresenceDescription and constraints
$objectRootCustom field information for a draft hire.

Custom fields are associated with RoleWithCompany model.
field_namestringRequired within parentName of the custom field
field_valueobjectRequired within parentValue of the custom field
Create bulk draft hire — request body — body draft hires item employment info equity vesting schedule
FieldTypePresenceDescription and constraints
$objectRootEquity vesting schedule
_namestringOptionalName of the vesting schedule
cliffMonthsintegerOptionalNumber of cliff months before vesting begins
company_idstringRequired within parentRequired company ID for the vesting schedule
continuousVestingMonthsintegerOptionalNumber of continuous vesting months
percentageInitialVestingnumberOptionalPercentage of initial vesting as decimal
Format: decimal
spokeIdstringOptionalSpoke ID for the vesting schedule
totalVestingMonthsintegerOptionalTotal number of vesting months
totalVestingYearsintegerOptionalTotal number of vesting years
vestingTypestringOptionalType of vesting schedule

SDK function policy ID: rippling.rest_api.create_draft_hires. Catalog operation: create-draft-hires. Rules can name either ID; function rules distinguish managed calls and conservatively cover raw calls sharing the route. Existing grant permissions and policy rules apply. wait() returns an immediate result or waits for a required approval; it never approves the request itself. Persist the approval ID to resume after a restart.

Provider errors retain their response; JSON decoding raises ProviderAPIError for provider failures. ManagedOperationError identifies contract/input/retention errors. See error handling and provider-specific behavior. Sensitive input may be refused before approval storage. A decoding error never resubmits a write.

Required provider scopes: ["draft-hires.read-write"]

Provider entitlements: ["API_Tier_1"]

Pinned headers: {"Rippling-Api-Version": "2024-08-01"}

Official provider source

Report an issue with this page

Necessary

Required for sign-in, security, authorization, and remembering your choices.

Always active

Analytics

Helps us understand which product and documentation features are useful.

Performance diagnostics

Uses performance tracing and privacy-masked session replay to diagnose problems.

You can change these choices at any time from Cookie settings.