File

Update File

PUT

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.

Path parameters

fileIdstringRequired
The unique identifier of the File to update

Request

This endpoint expects an object.
name
stringOptional
The new name for the File.
taskId
stringOptional
To assign this File to a Task, specify the TaskId here.
folderId
stringOptional
To move this File to a new Folder, specify the Folder's unique identifier here.

Response

This endpoint returns an object
error
objectOptional
If the API call failed, this will contain information about the error that occurred.
success
booleanOptional
True if the API call succeeded; false otherwise.
hasError
booleanOptional
True if the API call failed.
statusCode
enumOptional
The HTTP code of the response.
PUT
$curl -X PUT /api/data/files/fileId \
>     -H "Authorization: Bearer <token>" \
>     -H "Content-Type: application/json" \
>     -d '{}'
Response
1{
2  "error": {
3    "technicalError": "technicalError",
4    "additionalErrors": [
5      "additionalErrors"
6    ],
7    "message": "message"
8  },
9  "success": true,
10  "hasError": true,
11  "statusCode": "Continue"
12}
Built with