folders

Update Folder

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.
patch/folders/{folder_id}

Request

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

Path parameters

folder_idinteger required

Folder identifier

Request body

namestring

New folder name

parentIdinteger nullable

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

phaseInstanceIdinteger nullable

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

isActiveboolean

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

Response

Successful response

idinteger required

Folder identifier

namestring required

Folder name

companyIdinteger

Owning company identifier

projectIdinteger required

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

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.