v1

latestOpenAPI 3.1.02026-07-26294215839.4 KB

Onboarding

Public API

Cancel new hire packet

Cancels the new hire packet. Completed packets cannot be cancelled.

OAuth Scopes: onboarding.write

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

idinteger required

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.