Skip to content

Rippling: Evaluate a leave program evaluation — request body — body

Evaluate a leave program evaluation: request body, field body. Complete fields and constraints for contract 2026-10-28.

API reference · Contract 2026-10-28

SDK schema: Evaluate a leave program evaluation — request body — body

FieldTypePresenceDescription and constraints
$objectRoot
birth_typestringOptionalOptional delivery type for birthing-parent disability evaluations. Used to estimate postpartum disability windows for programs such as CA-SDI and CA-PDL.
One of: VAGINAL, C_SECTION, UNKNOWN
child_entered_family_datestringOptionalOptional date the child entered the family for bonding leave programs.
claim_end_datestringOptionalOptional requested leave end date. When set, leave_plan.pay_periods includes estimated per-paycheck amounts for programs that publish pay rates.
claim_start_datestringRequired within parentRequested leave start date.
evidence_overrideobjectOptionalDemo/test-company only evidence overrides for exercising eligibility scenarios when the role’s real data would not qualify.
leave_reasonstringRequired within parentNormalized leave reason to evaluate against statutory and custom leave programs.
One of: BONDING, PREGNANCY_DISABILITY, PREGNANCY_ACCOMMODATION, MEDICAL, VACATION, OTHER
parental_leave_typestringOptionalOptional parental leave relationship type for parental leave programs. Deprecated for most bonding evaluations, but still accepted for backwards compatibility with 2024-08-01 SDK callers.
One of: birthing_parent, non_birthing_parent, adoption_parent, supporting_person, foster_parent
program_codesarrayOptionalOptional leave program codes to evaluate. When omitted, every registered leave program runs in dependency order.
program_codes[]stringEach item
role_idstringRequired within parentRole ID for the employee whose leave request should be evaluated.
supplemental_evidenceobjectOptionalAnswers for evidence keys returned in missing_evidence. These answers only fill facts that the evaluation reported as missing.

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.