Move all of the items owned by a user into a new folder in another user’s account.
Only the root folder (0
) can be transferred.
Folders can only be moved across users by users with administrative permissions.
This call will be performed synchronously which might lead to a slow response when the source user has a large number of items in all of its folders.
If the destination path has a metadata cascade policy attached to any of the parent folders, a metadata cascade operation will be kicked off asynchronously.
There is currently no way to check for when this operation is finished.
The destination folder's name will be in the format {User}'s Files and Folders
, where {User}
is the display name of the user.
To make this API call your application will need to have the "Read and write all files and folders stored in Box" scope enabled.
12345
The ID of the user.
id,type,name
A comma-separated list of attributes to include in the response. This can be used to request fields that are not normally returned in a standard response.
Be aware that specifying this parameter will have the effect that none of the standard fields are returned in the response unless explicitly specified, instead only fields for the mini representation are returned, additional to the fields requested.
true
Determines if users should receive email notification for the action performed.
The user who the folder will be transferred to
1232234
The ID of the user who the folder will be transferred to
Returns the information for the newly created destination folder.
An unexpected client error.