Update Folder | Coperniq API

Rename, move, or archive a doc folder.

Notes:

All fields are optional; only fields present in the request body are applied.
parentId and phaseInstanceId are mutually exclusive.
Moving a folder that has subfolders is rejected.
Archiving a folder cascades the archived state to its subfolders and their files.

Rename, move, or archive a doc folder. Notes: - All fields are optional; only fields present in the request body are applied. - `parentId` and `phaseInstanceId` are mutually exclusive. - Moving a folder that has subfolders is rejected. - Archiving a folder cascades the archived state to its subfolders and their files.

Authentication

x-api-keystring

API Key authentication via header

Path parameters

folder_idintegerRequired

Folder identifier

Request

This endpoint expects an object.

namestringOptional

New folder name

parentIdinteger or nullOptional

New parent folder id. Pass null to move the folder to the root of its phase/project.

phaseInstanceIdinteger or nullOptional

New phase instance id. Pass null to detach from a phase.

isActivebooleanOptional

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

Response

Successful response

idinteger

Folder identifier

namestring

Folder name

projectIdinteger

Project (or opportunity/account, under the hood) this folder belongs to

isActiveboolean

Whether the folder is active (false if archived)

createdAtstringformat: "date-time"

Creation timestamp

updatedAtstringformat: "date-time"

Last update timestamp

companyIdintegerOptional

Owning company identifier

parentIdinteger or nullOptional

Parent folder id, if this folder is nested under another folder. Mutually exclusive with phaseInstanceId. Folders nest at most 2 levels deep.

phaseInstanceIdinteger or nullOptional

Phase instance id, if this folder sits at the root of a phase. Mutually exclusive with parentId.

createdByinteger or nullOptional

User who created the folder

Errors

400

Bad Request Error

404

Not Found Error

500

Internal Server Error

1	const url = 'https://api.coperniq.io/v1/folders/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	"projectId": 1,
5	"isActive": true,
6	"createdAt": "2024-01-15T09:30:00Z",
7	"updatedAt": "2024-01-15T09:30:00Z",
8	"companyId": 1,
9	"parentId": 1,
10	"phaseInstanceId": 1,
11	"createdBy": 1
12	}