BAbamboohr
Onboarding
Public API

Send new hire packet

Changed on

Sends the new hire packet for that packet's employee (email or onboarding experience workflow, depending on company configuration). The packet must be in draft state.

OAuth Scopes: onboarding.write

post/api/v1/new-hire-packets/{id}/send

Request

Path parameters

idinteger required

Response

Success

idinteger nullable

Primary key of the new hire packet instance.

employeeIdinteger

Employee this packet belongs to.

contactEmployeeIdinteger nullable

Contact employee for the packet, if any.

requiresPersonalInformationboolean
requiresPhotoboolean
requiresPersonalQuestionsboolean
arriveByTimestring nullable

Expected arrival time (time portion).

locationstring nullable

Work location label for the new hire.

sentDatetimestring nullable

When the packet was sent (datetime string).

viewedDatetimestring nullable

When the packet was first viewed (datetime string).

completedDatetimestring nullable

When the packet was completed (datetime string).

createdByUserIdinteger nullable
createdDatetimestring nullable

When the packet row was created (datetime string).

sendGetToKnowYouEmailboolean
getToKnowYouEmailSentboolean nullable
showPayrollStateboolean nullable
showPayrollFederalboolean nullable
showPayrollDirectDepositboolean nullable
nhpConfigurationIdinteger nullable

Linked new hire packet configuration id, if any.

nhpTemplateIdinteger nullable
countNhpGtkySentinteger nullable
cancelledboolean
includePhotoOptionboolean

Whether photo collection is offered based on configuration.

status'cancelled' | 'completed' | 'sent' | 'draft'

Derived lifecycle status for the instance.

Changes

  • 922fc15f43a7Revision changes
    • info

      api operation id f49b0f1f2fb1ef2c408ba12916ee9baa removed and replaced with 6f433434e0de016ffdbf74bea0950cbe