Dropbox

Links

    Dropbox API

    Getting access, Developing, Testing

    Back to Dropbox

    Files - Copy V2

    Copy a file or folder to a different location in the user's Dropbox. If the source path is a folder all its contents will be copied.

    Input

    type: object properties: data: type: object description: > from_path: Path in the user's Dropbox to be copied or moved. to_path: Path in the user's Dropbox that is the destination. allow_shared_folder: If true, :route:`copy` will copy contents in shared folder, otherwise :field:`RelocationError.cant_copy_shared_folder` will be returned if :field:`from_path` contains shared folder. This field is always true for :route:`move`. autorename: If there's a conflict, have the Dropbox server try to autorename the file to avoid the conflict. allow_ownership_transfer: Allow moves by owner even if it would result in an ownership transfer for the content being moved. This does not apply to copies. properties: allow_ownership_transfer: type: boolean description: >- Allow moves by owner even if it would result in an ownership transfer for the content being moved. This does not apply to copies. from_path: type: string description: Path in the user's Dropbox to be copied or moved. to_path: type: string description: Path in the user's Dropbox that is the destination. autorename: type: boolean description: >- If there's a conflict, have the Dropbox server try to autorename the file to avoid the conflict. allow_shared_folder: type: boolean description: >- If true, :route:`copy` will copy contents in shared folder, otherwise :field:`RelocationError.cant_copy_shared_folder` will be returned if :field:`from_path` contains shared folder. This field is always true for :route:`move`. title: Data

    Output

    type: object description: | metadata: Metadata of the relocated 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.