Skip to content
Alter

Rippling: Create hire — request body — body hires item employment probation

Create hire: request body, field body / hires / item / employment / probation. Complete fields and constraints for contract 2026-10-28.

API reference · Contract 2026-10-28

SDK schema: Create hire — request body — body hires item employment probation

FieldTypePresenceDescription and constraints
$objectRootProbation arrangement for the employment: standard, a shorter custom period, or none.
Additional keys: not allowed
quantityintegerOptionalNumber of probation units. Required for SHORTER_PROBATION; omit otherwise.
typestringRequired within parentProbation arrangement for the employment. STANDARD_PROBATION applies the standard period, SHORTER_PROBATION supplies a shorter custom period, and FORGO_PROBATION means no probation.
One of: STANDARD_PROBATION, SHORTER_PROBATION, FORGO_PROBATION
unitstringOptionalUnit for the custom probation length: DAYS, WEEKS, MONTHS, or YEARS. Required for SHORTER_PROBATION; omit otherwise.
One of: DAYS, WEEKS, MONTHS, YEARS

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.

LinkedInTwitter