PUT
/users/{user_id}/folders/0Transfer owned folders
Move all of the items (files, folders and workflows) owned by a user into another user's account.
Only the root folder (0) can be transferred.
Folders can only be moved across users by users with administrative permissions.
All existing shared links and folder-level collaborations are transferred during the operation. Please note that while collaborations at the individual file-level are transferred during the operation, the collaborations are deleted when the original user is deleted.
If the user has a large number of items across all folders, the call will be run asynchronously. If the operation is not completed within 10 minutes, the user will receive a 200 OK response, and the operation will continue running.
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.
Please make sure the destination user has access to Relay or Relay Lite,
and has access to the files and folders involved in the workflows being
transferred.
Admins will receive an email when the operation is completed.
- RetriesRetries up to 2×, 500ms backoff, 30s timeout.
user_idstringrequired
The ID of the user.
fieldsarray<string>optional
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.
notifybooleanoptional
Determines if users should receive email notification
for the action performed.
owned_byobjectrequired
The user who the folder will be transferred to.
200Returns the information for the newly created
destination folder.
idstringrequired
The unique identifier that represent a folder.
The ID for any folder can be determined
by visiting a folder in the web application
and copying the ID from the URL. For example,
for the URL `https://*.app.box.com/folders/123`
the `folder_id` is `123`.
etagstringoptional
The HTTP `etag` of this folder. This can be used within some API
endpoints in the `If-Match` and `If-None-Match` headers to only
perform changes on the folder if (no) changes have happened.
typestringrequired
The value will always be `folder`.
sequence_idobjectoptional
namestringoptional
The name of the folder.
created_atstringoptional
The date and time when the folder was created. This value may
be `null` for some folders such as the root folder or the trash
folder.
modified_atstringoptional
The date and time when the folder was last updated. This value may
be `null` for some folders such as the root folder or the trash
folder.
descriptionobjectoptional
sizeintegeroptional
The folder size in bytes.
Be careful parsing this integer as its
value can get very large.
path_collectionobjectoptional
created_byobjectoptional
modified_byobjectoptional
trashed_atstringoptional
The time at which this folder was put in the trash.
purged_atstringoptional
The time at which this folder is expected to be purged
from the trash.
content_created_atstringoptional
The date and time at which this folder was originally
created.
content_modified_atstringoptional
The date and time at which this folder was last updated.
owned_byobjectoptional
shared_linkobjectoptional
folder_upload_emailobjectoptional
The `folder_upload_email` parameter is not `null` if one of the following options is **true**:
* The **Allow uploads to this folder via email** and the **Only allow email uploads from collaborators in this folder** are [enabled for a folder in the Admin Console](https://support.box.com/hc/en-us/articles/360043697534-Upload-to-Box-Through-Email), and the user has at least **Upload** permissions granted.
* The **Allow uploads to this folder via email** setting is enabled for a folder in the Admin Console, and the **Only allow email uploads from collaborators in this folder** setting is deactivated (unchecked).
If the conditions are not met, the parameter will have the following value: `folder_upload_email: null`.
parentobjectoptional
item_statusstringoptional
Defines if this item has been deleted or not.
* `active` when the item has is not in the trash
* `trashed` when the item has been moved to the trash but not deleted
* `deleted` when the item has been permanently deleted.
item_collectionobjectoptional
sync_stateobjectoptional
has_collaborationsbooleanoptional
Specifies if this folder has any other collaborators.
permissionsobjectoptional
tagsobjectoptional
can_non_owners_inviteobjectoptional
is_externally_ownedbooleanoptional
Specifies if this folder is owned by a user outside of the
authenticated enterprise.
metadataobjectoptional
is_collaboration_restricted_to_enterpriseobjectoptional
allowed_shared_link_access_levelsarray<SharedLinkAccessLevel>optional
The shared link access levels the authenticated user is allowed to
use when creating or updating a shared link for this folder.
The list depends on item policy and user authorization. For some
folders, like the root folder, this is always empty as sharing is
not allowed at that level.
allowed_invitee_rolesarray<string>optional
A list of the types of roles that user can be invited at
when sharing this folder.
watermark_infoobjectoptional
is_accessible_via_shared_linkbooleanoptional
Specifies if the folder can be accessed
with the direct shared link or a shared link
to a parent folder.
can_non_owners_view_collaboratorsbooleanoptional
Specifies if collaborators who are not owners
of this folder are restricted from viewing other
collaborations on this folder.
It also restricts non-owners from inviting new
collaborators.
classificationobjectoptional
is_associated_with_app_itembooleanoptional
This field will return true if the folder or any ancestor of the
folder is associated with at least one app item. Note that this will
return true even if the context user does not have access to the
app item(s) associated with the folder.
collectionsarray<Collection>optional
The collections that this folder belongs to.
For more information, see the
[collections guide](https://developer.box.com/guides/collections).
403Returns an error when folder ownership cannot be
transferred to another user.
* `forbidden_by_policy`: Returned if ownership transfer
is forbidden due to information barrier restrictions.
* `Cannot transfer files from/to higher privileged accounts`: You can only transfer content to or from managed users or your own account,
not other co-admins or admins. Admins can transfer content between any users, including co-admins and managed users.
typestringoptional
The value will always be `error`.
statusintegeroptional
The HTTP status of the response.
codestringoptional
A Box-specific error code.
messagestringoptional
A short message describing the error.
context_infoobjectoptional
A free-form object that contains additional context
about the error. The possible fields are defined on
a per-endpoint basis. `message` is only one example.
help_urlstringoptional
A URL that links to more information about why this error occurred.
request_idstringoptional
A unique identifier for this response, which can be used
when contacting Box support.
defaultAn unexpected client error.
typestringoptional
The value will always be `error`.
statusintegeroptional
The HTTP status of the response.
codestringoptional
A Box-specific error code.
messagestringoptional
A short message describing the error.
context_infoobjectoptional
A free-form object that contains additional context
about the error. The possible fields are defined on
a per-endpoint basis. `message` is only one example.
help_urlstringoptional
A URL that links to more information about why this error occurred.
request_idstringoptional
A unique identifier for this response, which can be used
when contacting Box support.
Error handling
A 403 is returned: Returns an error when folder ownership cannot be transferred to another user.
forbidden_by_policy: Returned if ownership transfer is forbidden due to information barrier restrictions.Cannot transfer files from/to higher privileged accounts: You can only transfer content to or from managed users or your own account, not other co-admins or admins. Admins can transfer content between any users, including co-admins and managed users. Any other status is an error: An unexpected client error.