PRprocess
Files

Update a file

Changed on

Changes a file's name, description, folder, and sharing settings without replacing the document. Send the complete set of fields, including values you want to keep. Returns the updated file.

put/files/{fileId}

Request

  • Base URL
    https://public-api.process.st/api/v1.1
  • URL
    https://public-api.process.st/api/v1.1/files/{fileId}
  • Auth
    • API key in header X-API-Key
    • or HTTP bearer

Path parameters

fileIdstring required

File ID

Request body

namestring required

Display name.

descriptionstring

Optional free-form description of the file.

folderIdstring required

The ID of the Folder.

shareLevel'None' | 'View' required

Controls who can view this file. None — only organization members can view this file. View — anyone with the link can view this file.

referenceIdstring

Version prefix used when version control is enabled on this file. Combined with the version number to form the full version identifier.

Response

Example response

{
  "data": {
    "createdBy": {
      "id": "paiZa0_oyxEBoZxtatp33g",
      "email": "jane.doe@example.com",
      "username": "Jane Doe"
    },
    "updatedBy": {
      "id": "paiZa0_oyxEBoZxtatp33g",
      "email": "jane.doe@example.com",
      "username": "Jane Doe"
    },
    "links": [
      {
        "href": "https://api.process.st/api/v1.1/resource/XXX"
      }
    ]
  },
  "links": [
    {
      "href": "https://api.process.st/api/v1.1/resource/XXX"
    }
  ]
}

Changes