Create Opportunity Folder

Create a new doc folder in an opportunity.

Notes:

name is required.
parentId and phaseInstanceId are mutually exclusive — a folder sits either at the root of a phase, or nested under another folder, not both.
Folders nest at most 2 levels deep.
Update and delete a folder via PATCH/DELETE /folders/{folder_id}, same as project folders.

Create a new doc folder in an opportunity. Notes: - `name` is required. - `parentId` and `phaseInstanceId` are mutually exclusive — a folder sits either at the root of a phase, or nested under another folder, not both. - Folders nest at most 2 levels deep. - Update and delete a folder via `PATCH`/`DELETE /folders/{folder_id}`, same as project folders.

Authentication

x-api-keystring

API Key authentication via header

Path parameters

opportunity_idintegerRequired

Opportunity identifier

Request

This endpoint expects an object.

namestringRequired

Folder name

parentIdintegerOptional

Optional. Parent folder id to nest this folder under.

phaseInstanceIdintegerOptional

Optional. Phase instance id this folder should sit at the root of.

Response

Folder created successfully

idinteger

Folder identifier

namestring

Folder name

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/opportunities/1/folders';
2	const options = {
3	method: 'POST',
4	headers: {'x-api-key': '<apiKey>', 'Content-Type': 'application/json'},
5	body: '{"name":"string"}'
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	"isActive": true,
5	"createdAt": "2024-01-15T09:30:00Z",
6	"updatedAt": "2024-01-15T09:30:00Z",
7	"companyId": 1,
8	"parentId": 1,
9	"phaseInstanceId": 1,
10	"createdBy": 1
11	}