files

Update File

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.
patch/files/{file_id}

Request

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

Path parameters

file_idinteger required

File identifier

Request body

namestring

New file name

isActiveboolean

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

folderIdinteger nullable

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

phaseInstanceIdinteger

Phase instance to move the file to the root of.

Response

Successful response

idinteger required

File identifier

namestring required

File name

downloadUrlstring required

URL to download the file

typestring required

File type

updatedAtstring date-time required

Last update timestamp

createdAtstring date-time required

Creation timestamp

companyIdinteger

Owning company identifier

metaDataFileUpdateResponseMetaData

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

sourcestring

File source (e.g., INTERNAL)

isActiveboolean required

Whether the file is active (false if archived)

folderIdinteger nullable

Folder this file is filed in, if any

phaseInstanceIdinteger nullable

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

Changes

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