DocumentationAPI Reference
API Reference

Update GTKY answer visibility for a new hire packet

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

Shows or hides get-to-know-you (GTKY) question answers for the packet. Omit questionIds to toggle all answers (same as the legacy BFF POST /onboarding/questions/visibility/{newHirePacketId} with a visible query flag). Send questionIds to toggle only specific personal questions linked to this new hire packet. Requires the same edit access as other NHP writes. When the employee has a hire date set, updates are rejected once the company-local calendar date is on or after that date (same rule as GET /onboarding/questions/{newHirePacketId}, which redirects to expired in that case). Draft employees without a hire date are not blocked.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
integer
required
Body Params
boolean
required

When true, answers are hidden from typical manager views; when false, answers are shown.

questionIds
array of int64s | null

Optional. When omitted or null, hidden applies to every GTKY answer row for the packet. When a non-empty array of employee personal question ids, only those questions (must belong to this packet) are updated.

questionIds
Responses

400

Bad request — invalid body (e.g. hidden type, questionIds shape, ids not linked to this packet), or visibility change not allowed on or after the employee hire date when a hire date is set

403

Forbidden

404

Not found

500

Internal server error

Updated 18 days ago

Language
Credentials
OAuth2
Missing 1 required scope
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 18 days ago