Booking · Settings
Update booking settings
Updates an organization's booking settings using organizationId, retention, waitlist, electronicInvoices, and instructorsCancelDates. Retention controls anonymization, while waitlist sets the default for new events. 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
- The caller must have access to the organization.
- The caller needs the
organization.editpermission. - The caller also needs the
booking.editpermission.
Request
Path parameters
-
organizationIdidrequired
Body
Content-Type: application/json
-
retentionobjectrequired1 property
-
anonymizeAfterMonthsintegerrequirednullable1–120
-
-
waitlistobjectrequirednullable2 properties
-
modestringrequiredorderedrandommanual -
offerAvailableHoursnumberrequirednullable
-
-
electronicInvoicesbooleanrequired -
instructorsCancelDatesbooleanrequired
Request
curl --fail-with-body --silent --show-error --max-time 30 --globoff \
--request POST 'https://cloud.campai.com/api/YOUR_ORGANIZATION_ID/booking/settings/update' \
--header 'X-API-Key: YOUR_API_KEY'const response = await fetch("https://cloud.campai.com/api/YOUR_ORGANIZATION_ID/booking/settings/update", {
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/booking/settings/update', 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
- If a
bookingSettingsrecord exists for the organization, its settings are updated. - If no
bookingSettingsrecord exists for the organization, one is created.
Errors
No errors of its own are known for this endpoint.
Errors nearly every request can meet are listed under Errors.