Update File | Coperniq API

Rename, archive/unarchive, and/or move a file. Moving isn’t a separate operation — set folderId and/or phaseInstanceId in the same request.

Notes:

All fields are optional; only fields present in the request body are applied.
folderId accepts null to un-file (remove from its current folder).
The target folder must belong to the same project as the file.
A file sits in either a folder or the root of a phase, never both. Setting phaseInstanceId clears folderId (and vice versa) unless you explicitly set both in the same request, which is rejected with 400.

Rename, archive/unarchive, and/or move a file. Moving isn't a separate operation — set `folderId` and/or `phaseInstanceId` in the same request. Notes: - All fields are optional; only fields present in the request body are applied. - `folderId` accepts `null` to un-file (remove from its current folder). - The target folder must belong to the same project as the file. - A file sits in either a folder or the root of a phase, never both. Setting `phaseInstanceId` clears `folderId` (and vice versa) unless you explicitly set both in the same request, which is rejected with `400`.

Authentication

x-api-keystring

API Key authentication via header

Path parameters

file_idintegerRequired

File identifier

Request

This endpoint expects an object.

namestringOptional

New file name

isActivebooleanOptional

Set to false to archive the file, or true to unarchive it

folderIdinteger or nullOptional

Folder to move the file into. Pass null to un-file it.

phaseInstanceIdintegerOptional

Phase instance to move the file to the root of.

Response

Successful response

idinteger

File identifier

namestring

File name

downloadUrlstring

URL to download the file

typestring

File type

updatedAtstringformat: "date-time"

Last update timestamp

createdAtstringformat: "date-time"

Creation timestamp

isActiveboolean

Whether the file is active (false if archived)

companyIdintegerOptional

Owning company identifier

metaDataobjectOptional

File metadata (size, MIME type, etc.) — see the File schema for the full shape

sourcestringOptional

File source (e.g., INTERNAL)

folderIdinteger or nullOptional

Folder this file is filed in, if any

phaseInstanceIdinteger or nullOptional

Phase instance this file sits at the root of, if any

createdByUserobjectOptional

Errors

400

Bad Request Error

404

Not Found Error

500

Internal Server Error

1	const url = 'https://api.coperniq.io/v1/files/1';
2	const options = {
3	method: 'PATCH',
4	headers: {'x-api-key': '<apiKey>', 'Content-Type': 'application/json'},
5	body: '{}'
6	};
7
8	try {
9	const response = await fetch(url, options);
10	const data = await response.json();
11	console.log(data);
12	} catch (error) {
13	console.error(error);
14	}

1	{
2	"id": 1,
3	"name": "string",
4	"downloadUrl": "string",
5	"type": "string",
6	"updatedAt": "2024-01-15T09:30:00Z",
7	"createdAt": "2024-01-15T09:30:00Z",
8	"isActive": true,
9	"companyId": 1,
10	"metaData": {},
11	"source": "string",
12	"folderId": 1,
13	"phaseInstanceId": 1,
14	"createdByUser": {
15	"id": 1,
16	"firstName": "string",
17	"lastName": "string"
18	}
19	}