Booking · Events
Add event pattern
Adds a repeat pattern to the course of a specific event. The pattern repeats by the given rule from the given first date, whose time and length all its dates have, at the given place. Its dates are copies of a date of the course and reach as far ahead as the course has dates. Attendees who booked the whole course are added to the new dates at no extra charge, unless they are booked as single dates only, which needs an event that takes both.
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
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
-
-
-
wholeCoursebooleandefault
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' \
--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", {
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', 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[]
{
"inserted": [
"000000000000000000000001"
]
}
Errors
No errors of its own are known for this endpoint.
Errors nearly every request can meet are listed under Errors.