Sign in
Onboarding
Public API

Update new hire packet

Updates an existing new hire packet instance. Sent, viewed, and completed timestamps are not changed through this endpoint.

OAuth Scopes: onboarding.write

put/api/v1/new-hire-packets/{id}

Path parameters

idinteger required

Request body

contactEmployeeIdinteger nullable

Contact employee for the packet, if any.

requiresPersonalInformationboolean

Whether personal information collection is required.

requiresPhotoboolean

Whether a photo is required.

requiresPersonalQuestionsboolean

Whether personal questions are required.

arriveByTimestring nullable

Expected arrival time (time portion).

locationstring nullable

Work location label for the new hire.

sendGetToKnowYouEmailboolean

Whether to send the Get To Know You email.

showPayrollStateboolean

Whether to show state payroll fields.

showPayrollFederalboolean

Whether to show federal payroll fields.

showPayrollDirectDepositboolean

Whether to show direct deposit payroll fields.

nhpTemplateIdinteger nullable

Linked new hire packet template id, if any.

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

No recorded changes to this endpoint across all 1 revision of this API.