Skip to content
campaiDeveloper
campai.com

Misc ยท Drive

POST/{organizationId}/misc/drive/move

Move items

Moves the specified folders and files into a target folder, or to the top level when targetFolderId is null. The input includes organizationId, unique folderIds and fileIds arrays of up to 500 IDs each, and targetFolderId. The endpoint returns no body.

Permissions

Send an API key of the organization in the path, using the X-API-Key header.

Who may call it

  • Callers need organization access and the drive.edit permission.
  • For assigned-only drive access, the target folder and the current parent folders of the items must be shared with the caller. Moving to the top level is not allowed with this access.

Request

Path parameters

  • organizationIdidrequired

Body

Content-Type: application/json

  • folderIdsid[]required

    at most 500 items

  • fileIdsid[]required

    at most 500 items

  • targetFolderIdidrequirednullable
Request
curl --fail-with-body --silent --show-error --max-time 30 --globoff \
  --request POST 'https://cloud.campai.com/api/YOUR_ORGANIZATION_ID/misc/drive/move' \
  --header 'X-API-Key: YOUR_API_KEY'

No request that worked has been recorded yet, so the body is not shown.

Response

200 Successful response

No response body is specified.

What else happens

  • Moved folders have their parent and ancestors updated. Their descendant folders and files also have their ancestors updated.
  • Moved files have their folder and ancestors updated.
  • A former ancestor folder's coverFile is cleared if the cover no longer lies inside that folder.
  • The target folder, former parent folders of moved items, and their ancestors have contentUpdatedAt updated.

Errors

Other errors

StatusErrorWhen
400A folder cannot be moved into itselfMoving a folder into itself or one of its descendants returns 400 BAD_REQUEST with key misc.drive.invalidMove.
403You can only work inside folders shared with youFor assigned-only drive access, a target or current parent folder that is not shared with the caller causes a 403 FORBIDDEN error with key misc.drive.sharedFoldersOnly.
404The folder was not foundIf the target folder is not found, the endpoint returns 404 NOT_FOUND with key misc.drive.noFolder, provided the access check passes.
404The folder was not foundIf a requested folder is not found, the endpoint returns 404 NOT_FOUND with key misc.drive.noFolder, provided the access check passes.
404The file was not foundIf a requested file is not found, the endpoint returns 404 NOT_FOUND with key misc.drive.noFile, provided the access check passes.

Errors nearly every request can meet are listed under Errors.