DocumentationAPI Reference
API Reference
Start typing to search…

Update Employee File

post
https://{companyDomain}.bamboohr.com/api/v1/employees//files/

Updates metadata for an existing employee file. Supports renaming the file, moving it to a different category, and toggling employee visibility. Accepts JSON or XML; only fields present in the request body are updated. An empty XML document no-ops successfully, while an empty JSON body is treated as malformed JSON.

Path Params
integer
required

The ID of the employee whose file is being updated.

integer
required

The ID of the employee file to update.

Body Params
string

The new display name for the file.

integer

The ID of the file category (section) to move the file into.

string
enum

Whether the file is shared with the employee. Also accepted as 'shareWithEmployees'.

Allowed:
string
enum

Alias for shareWithEmployee. Whether the file is shared with the employee.

Allowed:
Responses
200

The employee file was updated successfully.

400

The request body contains malformed JSON or XML.

403

The API user does not have permission to modify the requested employee's file or its category.

404

The requested employee file or target category was not found.

500

An internal server error occurred.

Updated 23 days ago

Language
Credentials
:
URL
Response 
Click Try It! to start a request and see the response here!
Updated 23 days ago