v1
latestOpenAPI 3.1.02026-07-26294215839.4 KBCreate new hire packet
Creates a new hire packet instance (draft) for an employee. Company configuration is applied for default inclusion flags.
OAuth Scopes: onboarding.write
Request body
Contact employee for the packet, if any.
Whether personal information collection is required.
Whether a photo is required.
Whether personal questions are required.
Expected arrival time (time portion).
Work location label for the new hire.
Whether to send the Get To Know You email.
Whether to show state payroll fields.
Whether to show federal payroll fields.
Whether to show direct deposit payroll fields.
Linked new hire packet template id, if any.
Employee to attach the new packet to.
Response
Created
Primary key of the new hire packet instance.
Employee this packet belongs to.
Contact employee for the packet, if any.
Expected arrival time (time portion).
Work location label for the new hire.
When the packet was sent (datetime string).
When the packet was first viewed (datetime string).
When the packet was completed (datetime string).
When the packet row was created (datetime string).
Linked new hire packet configuration id, if any.
Whether photo collection is offered based on configuration.
Derived lifecycle status for the instance.