Booking · Events
Update event pattern
Changes a repeat pattern of the course of a specific event from the day of the given first date on: its rule, the time and length of its dates and its place. Earlier dates stay as they are. When only the time, length or place change, the pattern's dates move with it, booked ones too. Otherwise its dates without bookings and without changes of their own are replaced by the dates it now generates.
Permissions
Send an API key of the organization in the path, using the X-API-Key header.
Permission checks in detail
Required permissions
mandate.readevent.edit
Request
Path parameters
-
organizationIdidrequired -
mandateIdidrequired -
eventIdidrequired -
patternIdstringrequiredexactly 10 characters
Body
Content-Type: application/json
-
rrulestringrequired -
periodobjectrequired2 properties
-
fromstring · date-timerequired -
tostring · date-timerequired
-
-
placeobjectrequirednullable5 properties
-
typestringrequiredresourceaddressonline -
resourceobject6 properties
-
siteidrequired -
siteNamestringrequiredat least 1 characters
-
siteAddressobjectrequired7 properties
-
countrystringrequired -
statestring -
zipstringrequiredat most 10 characters
-
citystringrequiredat most 45 characters
-
addressLinestringrequiredat most 45 characters
-
details1stringat most 45 characters
-
details2stringat most 45 characters
-
-
resourceidrequired -
resourceNamestringrequired -
quantityintegerdefault
1
-
-
addressobject7 properties
-
countrystringrequired -
statestring -
zipstringrequiredat most 10 characters
-
citystringrequiredat most 45 characters
-
addressLinestringrequiredat most 45 characters
-
details1stringat most 45 characters
-
details2stringat most 45 characters
-
-
locationobjectnullable2 properties
-
latitudenumberrequired-90–90
-
longitudenumberrequired-180–180
-
-
onlineobject2 properties
-
urlstring · urirequiredat most 300 characters
-
instructionsstringrequiredat most 400 characters
-
-
-
notifyAttendeesbooleandefault
true
curl --fail-with-body --silent --show-error --max-time 30 --globoff \
--request POST 'https://cloud.campai.com/api/YOUR_ORGANIZATION_ID/YOUR_MANDATE_ID/booking/events/YOUR_EVENT_ID/patterns/YOUR_PATTERN_ID' \
--header 'X-API-Key: YOUR_API_KEY'const response = await fetch("https://cloud.campai.com/api/YOUR_ORGANIZATION_ID/YOUR_MANDATE_ID/booking/events/YOUR_EVENT_ID/patterns/YOUR_PATTERN_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/YOUR_MANDATE_ID/booking/events/YOUR_EVENT_ID/patterns/YOUR_PATTERN_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
Content-Type: application/json
-
insertedid[] -
updatedid[] -
deletedid[] -
blockedintegerat least 0
{
"inserted": [
"000000000000000000000001"
],
"updated": [
"000000000000000000000001"
],
"deleted": [
"000000000000000000000001"
],
"blocked": 0
}
Errors
No errors of its own are known for this endpoint.
Errors nearly every request can meet are listed under Errors.