Move upload folder

moveUploadFolder(input: MoveUploadFolderInput!): UploadFolderMoveResult!

Requires project.uploads.write.

Arguments

ArgumentTypeRequired
inputMoveUploadFolderInput!Yes

Input fields

input

MoveUploadFolderInput

FieldTypeRequiredDescription
projectReferenceString!YesProject UUID, slug or configured domain.
folderPathString!YesFolder to move; a trailing slash is appended when absent.
destinationPathString!YesUnused destination folder path; a trailing slash is appended when absent.

Response

Returns UploadFolderMoveResult!. Open the type for its fields and nested types.

FieldTypeDescription
sourcePathString!Folder path before the move, with a trailing slash.
destinationPathString!Folder path after the move, with a trailing slash.
foldersMovedInt!Folder records moved, including the source folder.
uploadsMovedInt!Active uploads moved.

Types marked with ! cannot be null. Lists use [Type] notation. The type index lists all published input and response types.

Example

graphql
mutation MoveUploadFolder($input: MoveUploadFolderInput!) {
  moveUploadFolder(input: $input) {
    destinationPath
    foldersMoved
    sourcePath
    uploadsMoved
  }
}
json
{
  "input": {
    "projectReference": "00000000-0000-4000-8000-000000000001",
    "folderPath": "example",
    "destinationPath": "example"
  }
}