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
| Time | Status | User Agent | |
|---|---|---|---|
Retrieving recent requests… | |||
Sample Request
{
"name": "This is a new name for the file",
"categoryId": "4",
"shareWithEmployee": "no"
}File Attributes That Can Be Updated
name - rename the file
categoryId - move the file to a different category
shareWithEmployee - update whether this file is shared or not
200The employee file metadata was updated successfully. No response body is returned.
400The request body contains malformed JSON or XML.
403The API user does not have permission to modify the requested employee's file, its category, or the file belongs to a read-only section.
404The requested employee file or target category was not found.
500An internal server error occurred.
