v1

latestOpenAPI 3.1.02026-08-066984441.1 MB

documentFiles

Updates the metadata of the document file with the specified id.

<Check title="Required Permissions" icon="key">Any authenticated user.</Check>

put/documents/{documentId}/files/{fileId}

Path parameters

documentIdstring uuid required

The id of the document.

fileIdstring uuid required

The id of the file.

Headers

Authorizationstring required

Bearer authentication

Request body

namestring nullable

The user-specified name of the file.

descriptionstring nullable

The description of the file.

Response

namestring nullable

The user-specified name of the file.

descriptionstring nullable

The description of the file.

idstring uuid

The id of the file info.

entityIdstring uuid nullable

Deprecated. The id of the linked entity derived from entity specific owner ids.

projectIdstring uuid nullable

projectTemplateIdstring uuid nullable

companyIdstring uuid nullable

taskIdstring uuid nullable

taskTemplateIdstring uuid nullable

userIdstring uuid nullable

documentIdstring uuid nullable

fileNamestring nullable

The name of the file.

entityTypestring nullable

The name of the linked entity type.

mimeTypestring nullable

The MIME type of the file.

createdOnstring date-time

The date this file was created.

createdBystring uuid

The id of the user who created this file.

updatedOnstring date-time

The date this file was last modified.

updatedBystring uuid

The id of the user who last modified this file.

isCommentFileboolean

Whether the file is related to a comment.

externalProviderstring nullable

The external provider for the file. Like 'google' or 'onedrive'.

externalFileUrlstring nullable

The file url of the external provider.

isHiddenForConnectUsersboolean

Whether the file is hidden for connect users.