Create new hire packet

post

https://{companyDomain}.bamboohr.com/api/v1/new-hire-packets

Creates a new hire packet instance (draft) for an employee. Company configuration is applied for default inclusion flags.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

Optional fields that may be set when creating or updating a new hire packet instance. All properties are optional for PUT; for POST, employeeId is required and supplied via a second schema in the request body allOf.

contactEmployeeId

integer | null

Contact employee for the packet, if any.

requiresPersonalInformation

boolean

Whether personal information collection is required.

requiresPhoto

boolean

Whether a photo is required.

requiresPersonalQuestions

boolean

Whether personal questions are required.

arriveByTime

string | null

Expected arrival time (time portion).

location

string | null

Work location label for the new hire.

sendGetToKnowYouEmail

boolean

Whether to send the Get To Know You email.

showPayrollState

boolean

Whether to show state payroll fields.

showPayrollFederal

boolean

Whether to show federal payroll fields.

showPayrollDirectDeposit

boolean

Whether to show direct deposit payroll fields.

nhpTemplateId

integer | null

Linked new hire packet template id, if any.

employeeId

integer

required

Employee to attach the new packet to.

Responses

400

Bad request

403

Forbidden

500

Internal server error

Language

Credentials

OAuth2

URL

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

201Created