Misc ยท Drive
Delete items
Deletes the specified drive files and folders, including everything inside the folders. Provide organizationId, folderIds, and fileIds; each ID array must contain unique IDs and may have at most 500 entries. The endpoint returns no value.
Permissions
Send an API key of the organization in the path, using the X-API-Key header.
Who may call it
- The caller must have organization access and the
drive.removepermission.
Request
Path parameters
-
organizationIdidrequired
Body
Content-Type: application/json
-
folderIdsid[]requiredat most 500 items
-
fileIdsid[]requiredat most 500 items
Request
curl --fail-with-body --silent --show-error --max-time 30 --globoff \
--request POST 'https://cloud.campai.com/api/YOUR_ORGANIZATION_ID/misc/drive/delete' \
--header 'X-API-Key: YOUR_API_KEY'const response = await fetch("https://cloud.campai.com/api/YOUR_ORGANIZATION_ID/misc/drive/delete", {
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/delete', 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
- Matching file records, including files inside selected folders, are deleted from
driveFiles. - When files are deleted, references to them as folder cover files are cleared.
- Matching folder records, including descendants of selected folders, are deleted from
driveFolders. - The
contentUpdatedAttimestamp is updated on affected parent folders and their ancestors. - Deleting files reduces cached
driveStorageusage by their stored file and thumbnail bytes. - Deleted files' storage resources and thumbnails are removed after the transaction.
Errors
Other errors
| Status | Error | When |
|---|---|---|
| 403 | You can only work inside folders shared with you | For assigned-only drive access, if a requested item's parent folder is not shared with the caller, the endpoint returns 403 FORBIDDEN with key misc.drive.sharedFoldersOnly. |
Errors nearly every request can meet are listed under Errors.