Organizations
Remove public profile
Removes an organization's Community-App public profile, including its cover and locations, so the organization is no longer discoverable. It takes an organizationId and returns no content.
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.
- The caller needs the
organization.editpermission.
Request
Path parameters
-
organizationIdidrequired
Request
curl --fail-with-body --silent --show-error --max-time 30 --globoff \
--request POST 'https://cloud.campai.com/api/connect/organizations/YOUR_ORGANIZATION_ID/public-profile/remove' \
--header 'X-API-Key: YOUR_API_KEY'const response = await fetch("https://cloud.campai.com/api/connect/organizations/YOUR_ORGANIZATION_ID/public-profile/remove", {
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/connect/organizations/YOUR_ORGANIZATION_ID/public-profile/remove', 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;
Response
200 Successful response
No response body is specified.
What else happens
- Sets the organization's
publicProfileto null. - Sets the organization's
hasPublicConnectProfileto false. - If the organization previously had a public Connect profile, clears its Connect user organizations cache.
- Cleans up storage resources after the update.
Errors
Other errors
| Status | Error | When |
|---|---|---|
| 404 | No fixed message | If the organization is not found, the endpoint returns HTTP 404 (NOT_FOUND). |
Errors nearly every request can meet are listed under Errors.