folders

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.
post/opportunities/{opportunity_id}/folders

Request

  • Base URL: https://api.coperniq.io/v1
  • URL: https://api.coperniq.io/v1/opportunities/{opportunity_id}/folders
  • Auth: API key in header x-api-key

Path parameters

opportunity_idinteger required

Opportunity identifier

Request body

namestring required

Folder name

parentIdinteger

Optional. Parent folder id to nest this folder under.

phaseInstanceIdinteger

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

Response

Folder created successfully

idinteger required

Folder identifier

namestring required

Folder name

companyIdinteger

Owning company identifier

parentIdinteger nullable

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

phaseInstanceIdinteger nullable

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

isActiveboolean required

Whether the folder is active (false if archived)

createdByinteger nullable

User who created the folder

createdAtstring date-time required

Creation timestamp

updatedAtstring date-time required

Last update timestamp

Changes

No recorded changes to this operation across all 1 revision of this API.