---
title: "Update new hire packet"
method: PUT
path: "/api/v1/new-hire-packets/{id}"
tags: ["Onboarding", "Public API"]
---

# Update new hire packet

`PUT /api/v1/new-hire-packets/{id}`

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

OAuth Scopes: onboarding.write

## Path parameters

- `id` integer, required

## Request body

- NewHirePacketPublicApiWritableBody — 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, nullable — 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, nullable — Expected arrival time (time portion).
  - `location` string, nullable — 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, nullable — Linked new hire packet template id, if any.

## Response `200`

Success

- NewHirePacketPublicApi — Flat new hire packet instance for public read APIs (list and detail).
  - `id` integer, nullable — Primary key of the new hire packet instance.
  - `employeeId` integer — Employee this packet belongs to.
  - `contactEmployeeId` integer, nullable — Contact employee for the packet, if any.
  - `requiresPersonalInformation` boolean
  - `requiresPhoto` boolean
  - `requiresPersonalQuestions` boolean
  - `arriveByTime` string, nullable — Expected arrival time (time portion).
  - `location` string, nullable — Work location label for the new hire.
  - `sentDatetime` string, nullable — When the packet was sent (datetime string).
  - `viewedDatetime` string, nullable — When the packet was first viewed (datetime string).
  - `completedDatetime` string, nullable — When the packet was completed (datetime string).
  - `createdByUserId` integer, nullable
  - `createdDatetime` string, nullable — When the packet row was created (datetime string).
  - `sendGetToKnowYouEmail` boolean
  - `getToKnowYouEmailSent` boolean, nullable
  - `showPayrollState` boolean, nullable
  - `showPayrollFederal` boolean, nullable
  - `showPayrollDirectDeposit` boolean, nullable
  - `nhpConfigurationId` integer, nullable — Linked new hire packet configuration id, if any.
  - `nhpTemplateId` integer, nullable
  - `countNhpGtkySent` integer, nullable
  - `cancelled` boolean
  - `includePhotoOption` boolean — Whether photo collection is offered based on configuration.
  - `status` 'cancelled' | 'completed' | 'sent' | 'draft' — Derived lifecycle status for the instance.

## Other responses

- `400` — Bad request
- `403` — Forbidden
- `404` — Not found
- `500` — Internal server error

---

[API](https://skmtc.net/bamboohr/apis/bamboohr-api.md) · [All operations](https://skmtc.net/bamboohr/apis/bamboohr-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/bamboohr/bamboohr-api/revisions/19ebf391a399/schema)