Misc · Drive
Share folder
Replaces the shares for a folder using the supplied organization ID, folder ID and shares. Users, contacts, contact segments, contact types and teams can access the folder and its subfolders in the Connect app; teams can only view. The endpoint returns no content.
Permissions
Send an API key of the organization in the path, using the X-API-Key header.
Who may call it
- Organization access with the
drive.editpermission is required. - Callers with assigned-only access to
drivecannot share folders.
Request
Path parameters
-
organizationIdidrequired -
folderIdidrequired
Body
Content-Type: application/json
-
sharesobject[]requiredat most 200 items
4 properties
-
typestringrequiredusercontactsegmentcontactTypeteam -
idstringrequired1–64 characters
-
namestringrequired1–200 characters
-
accessstringrequiredviewaddsubmit
-
Request
curl --fail-with-body --silent --show-error --max-time 30 --globoff \
--request POST 'https://cloud.campai.com/api/YOUR_ORGANIZATION_ID/misc/drive/folders/YOUR_FOLDER_ID/shares' \
--header 'X-API-Key: YOUR_API_KEY'const response = await fetch("https://cloud.campai.com/api/YOUR_ORGANIZATION_ID/misc/drive/folders/YOUR_FOLDER_ID/shares", {
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/folders/YOUR_FOLDER_ID/shares', 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 share checks pass, the endpoint replaces the matching folder's
shares.
Errors
Other errors
| Status | Error | When |
|---|---|---|
| 400 | One of the contacts was not found | If a shared contact is not found in the organization, the endpoint returns HTTP 400 with routes.misc.drive.invalidShare. |
| 400 | Teams can only view shared folders | If a team share requests access other than view, the endpoint returns HTTP 400 with routes.misc.drive.teamShareViewOnly. |
| 400 | Folders can only be shared with teams, not with subteams | If a shared team is not found as a top-level team in the organization, the endpoint returns HTTP 400 with routes.misc.drive.invalidTeamShare. |
| 403 | You cannot share folders | Assigned-only access to drive returns HTTP 403 with routes.misc.drive.noSharing. |
| 404 | The folder was not found | If the folder is not found in the organization, the endpoint returns HTTP 404 with routes.misc.drive.noFolder. |
Errors nearly every request can meet are listed under Errors.