API ReferenceFile

Update File

Updates information about a File uploaded to your Workspace. ProjectManager allows you to store Files connected to other elements of your Workspace such as a Project, a Task, or Home. Files are maintained separately based on the location where the file was stored. When you upload a File, please allow a few moments for the File to be processed and verified. ProjectManager may reject File uploads that contain problems such as malware. Once a File has completed the upload the process, you may retrieve it using the DownloadFile API. This API returns a JSON response indicating success or failure.

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Path parameters

fileIdstringRequiredformat: "uuid"
The unique identifier of the File to update

Headers

x-integration-namestringOptional
The name of the calling system passed along as a header parameter

Request

Information to change about the File and its location
namestringOptional
The new name for the File.
taskIdstring or nullOptionalformat: "uuid"
To assign this File to a Task, specify the TaskId here.
folderIdstring or nullOptionalformat: "uuid"
To move this File to a new Folder, specify the Folder's unique identifier here.

Response

Success
errorobject or null
If the API call failed, this will contain information about the error that occurred.
successboolean or null

True if the API call succeeded; false otherwise.

hasErrorboolean or null
True if the API call failed.
statusCodeenum or null
The HTTP code of the response.