v1

latestOpenAPI 3.1.02026-07-26294215839.4 KB
Employee Files
Public API

Update Employee File

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 returns 400. The categoryId field is silently ignored when the caller authenticated as the file creator but lacks full file permissions. Moving a file to a new category requires view/edit access to both the current and target category. Returns 403 if the file belongs to a read-only file section. Use 'List Employee Files' to obtain file IDs and category IDs.

OAuth Scopes: employee:file.write

post/api/v1/employees/{id}/files/{fileId}

Path parameters

idinteger required

The internal employee ID of the employee whose file is being updated.

fileIdinteger required

The ID of the employee file to update.

Request body

namestring

The new display name for the file.

categoryIdinteger

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

shareWithEmployee'yes' | 'no'

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

shareWithEmployees'yes' | 'no'

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

Response

The employee file metadata was updated successfully. No response body is returned.