Creates a new company file for the company with the specified id..

POST

Uploads a new company file for the company with the specified id. Use this to upload a file as a form value along with the basic file meta data. The file size must not exceed 1GB.

Path parameters

companyIdstringRequired

The id of the company.

Request

This endpoint expects a multipart form containing a file.
FilefileRequired

Response

Success

namestringOptional

The user-specified name of the file.

descriptionstringOptional

The description of the file.

idstringOptional

The id of the file info.

entityIdstringOptional

The id of the linked entity.

fileNamestringOptional

The name of the file.

entityTypestringOptional

The name of the linked entity type.

mimeTypestringOptional

The MIME type of the file.

createdOndatetimeOptional

The date this file was created.

createdBystringOptional

The id of the user who created this file.

updatedOndatetimeOptional

The date this file was last modified.

updatedBystringOptional

The id of the user who last modified this file.

fileVersionslist of objectsOptional

List of all versions.

isCommentFilebooleanOptional

Whether the file is related to a comment.

externalProviderstringOptional

The external provider for the file. Like ‘google’ or ‘onedrive’.

externalFileUrlstringOptional

The file url of the external provider.

Errors

Deletes the files of the specified company.
Built with