Misc ยท Drive
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.editpermission. - 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[]requiredat most 500 items
-
fileIdsid[]requiredat 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'const response = await fetch("https://cloud.campai.com/api/YOUR_ORGANIZATION_ID/misc/drive/move", {
method: "POST",
headers: {
"X-API-Key": "YOUR_API_KEY"
},
redirect: 'error',
signal: AbortSignal.timeout(30_000),
});
if (!response.ok) throw new Error(`campai HTTP ${response.status}`);
const text = await response.text();
const result = text ? JSON.parse(text) : null;
console.log(JSON.stringify(result, null, 2));<?php
$context = stream_context_create(['http' => [
'method' => 'POST',
'header' => [
'X-API-Key: YOUR_API_KEY',
],
'timeout' => 30,
'follow_location' => 0,
'ignore_errors' => true,
]]);
$text = @file_get_contents('https://cloud.campai.com/api/YOUR_ORGANIZATION_ID/misc/drive/move', false, $context);
preg_match('/^HTTP\/\S+ (\d{3})/', $http_response_header[0] ?? '', $match);
$status = (int) ($match[1] ?? 0);
if ($text === false || $status < 200 || $status >= 300) {
throw new RuntimeException("campai HTTP $status (0 means no response)");
}
$result = $text === '' ? null : json_decode($text, true, 512, JSON_THROW_ON_ERROR);
echo json_encode($result, JSON_PRETTY_PRINT | JSON_THROW_ON_ERROR), PHP_EOL;
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
coverFileis cleared if the cover no longer lies inside that folder. - The target folder, former parent folders of moved items, and their ancestors have
contentUpdatedAtupdated.
Errors
Other errors
| Status | Error | When |
|---|---|---|
| 400 | A folder cannot be moved into itself | Moving a folder into itself or one of its descendants returns 400 BAD_REQUEST with key misc.drive.invalidMove. |
| 403 | You can only work inside folders shared with you | For 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. |
| 404 | The folder was not found | If the target folder is not found, the endpoint returns 404 NOT_FOUND with key misc.drive.noFolder, provided the access check passes. |
| 404 | The folder was not found | If a requested folder is not found, the endpoint returns 404 NOT_FOUND with key misc.drive.noFolder, provided the access check passes. |
| 404 | The file was not found | If 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.