Misc · Drive
Rename file
Renames an organization's file using the supplied organizationId, fileId, and name, while keeping its existing extension. The name is limited to 128 characters, including any preserved extension. 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 access to the organization and the
drive.editpermission. - For callers with assigned-only drive access, the file must be inside a folder shared with them.
Request
Path parameters
-
organizationIdidrequired -
fileIdidrequired
Body
Content-Type: application/json
-
namestringrequired1–128 characters
Request
curl --fail-with-body --silent --show-error --max-time 30 --globoff \
--request POST 'https://cloud.campai.com/api/YOUR_ORGANIZATION_ID/misc/drive/files/YOUR_FILE_ID' \
--header 'X-API-Key: YOUR_API_KEY'const response = await fetch("https://cloud.campai.com/api/YOUR_ORGANIZATION_ID/misc/drive/files/YOUR_FILE_ID", {
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/files/YOUR_FILE_ID', 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
- After the access check and file lookup succeed, the endpoint updates the file's name in
driveFiles.
Errors
Other errors
| Status | Error | When |
|---|---|---|
| 403 | You can only work inside folders shared with you | If a caller with assigned-only drive access tries to rename a file outside a folder shared with them, the endpoint returns 403 FORBIDDEN with key misc.drive.sharedFoldersOnly. |
| 404 | The file was not found | If the file is not found in the organization, the endpoint returns 404 NOT_FOUND with key routes.misc.drive.noFile. |
Errors nearly every request can meet are listed under Errors.