Move folder to another parent folder or as a root folder

Moves one or more folders to a new parent folder or to the root.

This endpoint requires the "Platform management: Sites" permission.

To move folders, you'll need to provide the destination parent (or specify root) and the IDs of the folders to move.
If selected folders have descendants, these folders will be moved too.
The destination parent must be at the same label level as the current parent. If the destination is root (Nil/Empty UUID provided), there are no label level restrictions.
Folder hierarchies support up to five levels.
Each request can include up to 100 folders in total. The total includes the folders you specify and all of their descendants.

If you receive an error 400 (bad request) response, it could be due to one of the following reasons:

  • The destination parent is not at the same label level as the current parent.
  • The move would create a circular relationship (for example, moving a folder under its own descendant).
  • The move would exceed the maximum depth of five levels.
  • The total number of folders in the request exceeds 100 when descendants are counted.
  • A folder ID or parent folder ID is invalid.

Requires the "Platform management: Sites" permission.

Body Params

The parameters for MoveFoldersRequest

The parameters for MoveFoldersRequest

ids
array of strings
required

Required. An array of folder IDs to move under the new parent.

ids*
string

Optional. New parent folder ID. If unspecified, the folder will be moved as
a root folder

string

domain represents the type/domain/hierarchy for the folder. This is used
for deleting folders within a specified domain. Defaults to site

Responses

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