Organizations
Update public profile
Publishes or updates an organization's Community-App profile using its ID, introduction, about text and sites, with optional email, phone and cover. Omitted email, phone and cover retain their current values; site addresses are used to determine locations. The endpoint returns no response body.
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. - Child organizations cannot have their own Community-App profile.
Request
Path parameters
-
organizationIdidrequired
Body
Content-Type: application/json
-
introductionstringrequired1–140 characters
-
aboutstringrequired1–4000 characters
-
emailstring -
phonestring | string · phone -
coverobjectnullable2 properties
-
fileNamestringat most 128 characters
-
resourcestringrequired
-
-
sitesobject[]required1–64 items
4 properties
-
namestringrequired1–24 characters
-
descriptionstringrequiredat most 280 characters
-
addressobjectrequired7 properties
-
countrystringrequired -
statestring -
zipstringrequiredat most 10 characters
-
citystringrequiredat most 45 characters
-
addressLinestringrequiredat most 45 characters
-
details1stringat most 45 characters
-
details2stringat most 45 characters
-
-
openingobjectrequirednullable2 properties
-
hoursobjectrequired2 properties
-
fromobjectrequired2 properties
-
hoursintegerrequired0–23
-
minutesintegerrequired0–59
-
-
toobjectrequired2 properties
-
hoursintegerrequired0–23
-
minutesintegerrequired0–59
-
-
-
daysstring[]required1–7 items
montuewedthufrisatsun
-
-
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' \
--header 'X-API-Key: YOUR_API_KEY'const response = await fetch("https://cloud.campai.com/api/connect/organizations/YOUR_ORGANIZATION_ID/public-profile", {
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', 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
- The organization's
publicProfileis updated. - The organization is marked as having a public Connect profile.
- The organization's
checks.connectSetupis set to true. - When publishing a new profile, the endpoint clears the organization's Connect user organizations cache.
- When
coveris provided, the endpoint updates its storage resources and runs resource cleanup after saving.
Errors
Other errors
| Status | Error | When |
|---|---|---|
| 403 | No fixed message | If the organization is a child organization, the endpoint returns HTTP 403 (FORBIDDEN). |
| 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.