Sign in

v1

latestOpenAPI 3.0.12026-07-14182037.3 KB
Folders

Update folder properties

Update properties of folder by given ID. This action happens asynchronously and will update all of the folder's children as well.

post/files/v3/folders/update/async

Request body

idstring required

Id of the folder to change.

namestring

New name. If specified the folder's name and fullPath will change. All children of the folder will be updated accordingly.

parentFolderIdinteger

New parent folder ID. If changed, the folder and all it's children will be moved into the specified folder. parentFolderId and parentFolderPath cannot be specified at the same time.

Response

accepted

idstring required

The ID of the task

linksobject

Links for where to check information related to the task. The status link gives the URL for where to check the status of the task.

Example response

{
  "id": "57122e26-59f8-4cfc-ba53-96e30c816762",
  "links": [
    {
      "status": "https://api.hubspot.com/files/v3/folders/update/async/tasks/57122e26-59f8-4cfc-ba53-96e30c816762/status"
    }
  ]
}