Upload Employee File

Uploads a file to an employee's file section. The request must be a multipart/form-data POST. On success, a Location header is returned with the URL of the newly created file resource. The file must be under 20MB and use a supported extension. Pass 0 as the employee ID to use the employee associated with the API key. Employees may upload to their own folder if the company has employee document uploads enabled.

Path Params
string
required
Defaults to 0

{id} is an employee ID. The special employee ID of zero (0) means to use the employee ID associated with the API key (if any).

Body Params
string
required

The display name for the uploaded file.

integer
required

The ID of the employee file section to upload the file into.

string
enum

Whether to share the file with the employee. Accepted values: yes or no. Defaults to no.

Allowed:
file
required

The file to upload.

Responses
201

The file was uploaded successfully. The Location header contains the URL of the new file resource.

400

The request is invalid: missing file name, missing file, zero-byte file, or unsupported file extension.

403

The API user does not have permission to access the requested employee or their file section.

404

The employee or the specified file category was not found.

413

The file exceeds the 20MB limit or the company's storage limit.

503

The file storage API is temporarily unavailable.

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