Uploads a file to a company file category. 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. Uploading to read-only categories is not permitted. Uploading to implementation categories is not permitted on companies that have completed implementation.
OAuth Scopes: company_file.write
| Time | Status | User Agent | |
|---|---|---|---|
Retrieving recent requests… | |||
Sample Request
POST /api/v1/files/ HTTP/1.0
Host: {companyDomain}.bamboohr.com
Content-Type: multipart/form-data; boundary=----BambooHR-MultiPart-Mime-Boundary----
Content-Length: 520
------BambooHR-MultiPart-Mime-Boundary----
Content-Disposition: form-data; name="category"
112
------BambooHR-MultiPart-Mime-Boundary----
Content-Disposition: form-data; name="fileName"
readme.txt
------BambooHR-MultiPart-Mime-Boundary----
Content-Disposition: form-data; name="share"
yes
------BambooHR-MultiPart-Mime-Boundary----
Content-Disposition: form-data; name="file"; filename="readme.txt"
Content-Type: text/plain
This is a sample text file.
------BambooHR-MultiPart-Mime-Boundary------Submission Fields
category - the category ID to place the new file in.
fileName - the file name to associate with the file.
share - whether to make the file available to employees (options are "yes" and "no").
file - the file to upload. Note that the field must be named "file".
Special Notes
The file upload methods accept multi-part forms. To build a multi-part form concatenate the individual sections together separated by a boundary. Then take the length of the resulting body and use that as the Content-Length for the submission.
The file was uploaded successfully. The Location header contains the URL of the new file resource.
The request is invalid: missing file name, missing file, zero-byte file, or unsupported file extension.
The API user does not have permission to upload files, or the target category is read-only.
The specified category ID was not found.
The file exceeds the 20MB limit or the company's storage limit.
The file storage API is temporarily unavailable.