Back to DropboxFiles - Delete V2
Delete the file or folder at a given path.
If the path is a folder, all its contents will be deleted too.
A successful response indicates that the file or folder was deleted. The returned metadata will be the corresponding :type:FileMetadata
or :type:FolderMetadata
for the item at time of deletion, and not a :type:DeletedMetadata
object.
Input
type: object
properties:
data:
type: object
description: >
path: Path in the user's Dropbox to delete.
parent_rev: Perform delete if given "rev" matches the existing file's
latest "rev". This field does not support deleting a folder.
properties:
path:
type: string
description: Path in the user's Dropbox to delete.
parent_rev:
type: string
description: >-
Perform delete if given "rev" matches the existing file's latest
"rev". This field does not support deleting a folder.
title: Data
Output
type: object
description: |
metadata: Metadata of the deleted object.
properties:
metadata:
type: object
description: >
Metadata for a file or folder.
name: The last component of the path (including extension). This never
contains a slash.
path_lower: The lowercased full path in the user's Dropbox. This always
starts with a slash. This field will be null if the file or folder is not
mounted.
path_display: The cased path to be used for display purposes only. In rare
instances the casing will not correctly match the user's filesystem, but
this behavior will match the path provided in the Core API v1, and at
least the last path component will have the correct casing. Changes to
only the casing of paths won't be returned by
:route:`list_folder/continue`. This field will be null if the file or
folder is not mounted.
parent_shared_folder_id: Please use
:field:`FileSharingInfo.parent_shared_folder_id` or
:field:`FolderSharingInfo.parent_shared_folder_id` instead.
properties:
parent_shared_folder_id:
type: string
description: >-
Please use :field:`FileSharingInfo.parent_shared_folder_id` or
:field:`FolderSharingInfo.parent_shared_folder_id` instead.
name:
type: string
description: >-
The last component of the path (including extension). This never
contains a slash.
path_display:
type: string
description: >-
The cased path to be used for display purposes only. In rare instances
the casing will not correctly match the user's filesystem, but this
behavior will match the path provided in the Core API v1, and at least
the last path component will have the correct casing. Changes to only
the casing of paths won't be returned by
:route:`list_folder/continue`. This field will be null if the file or
folder is not mounted.
path_lower:
type: string
description: >-
The lowercased full path in the user's Dropbox. This always starts
with a slash. This field will be null if the file or folder is not
mounted.