Update Folder

Allows the requester to modify certain fields on a folder.

When updating the parent field, the folder moves to the new parent location while its contents remain intact. The requesting user must have both edit and share access to both the old and new parent folders, or the entire update will fail.

It is not permitted to update the parent field on Team Folders. Moving folders into or out of Team Folders may encounter permission-related errors, but once a folder is within a Team Folder, reorganization among descendants within that Team Folder can proceed without permission issues.

Allows the requester to modify certain fields on a folder.

  • Updating the parent field will cause the folder to be moved into the new folder. The contents of the folder will remain within it during the move.
    • The requesting user must have edit and share access to the old and new parent folders or else the entire update will fail.
    • It is an error to update the parent field on a Team Folder.
    • Moving folders into or out of a Team Folder can fail for a variety of permission-related reasons. Once within a Team Folder, a folder and all of its descendants can be reorganized within that Team Folder without causing any permission errors.

Valid Authentication Methods

API Key Grants:

  • FolderEdit

OAuth 2.0 User Token Scopes:

  • folder

Path Params
number
required

ID of the folder to be updated.

Body Params
string

New name for the folder being updated.

number | null

New parent for the folder being updated. Causes the folder to be moved into another folder if an ID is provided or into the user's root folder ("My Documents") if null is provided. If the parent field is not included in the request, the folder will not be moved. Cannot be provided for Team Folders.

Responses

400

Bad Request if the parent field is included in a request for a team folder, or if invalid input types are provided for id, name, or parent.

403

Forbidden if the app making the request does not have permission to the folder, the folder has been deleted or does not exist, or the request was not authorized to move the folder.

Language
Credentials
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json