Templates
Preview booking template change
Previews the effect of the proposed standard, ticketEnabled and passEnabled settings for a booking template. Returns whether tickets, passes and QR check-in would turn on or off, the number of upcoming events or resources affected, and the number of issued passes. Nothing is saved.
Permissions
Send an API key of the organization in the path, using the X-API-Key header.
Who may call it
- An organization caller must have
template.read.
Request
Path parameters
-
organizationIdidrequired -
templateIdidrequired
Body
Content-Type: application/json
-
standardbooleanrequired -
ticketEnabledbooleanrequired -
passEnabledbooleanrequired
curl --fail-with-body --silent --show-error --max-time 30 --globoff \
--request POST 'https://cloud.campai.com/api/YOUR_ORGANIZATION_ID/templates/booking/YOUR_TEMPLATE_ID/outputsChange' \
--header 'X-API-Key: YOUR_API_KEY'const response = await fetch("https://cloud.campai.com/api/YOUR_ORGANIZATION_ID/templates/booking/YOUR_TEMPLATE_ID/outputsChange", {
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/templates/booking/YOUR_TEMPLATE_ID/outputsChange', 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
-
changesobject3 properties
-
ticketstringnullableonoffchanges.ticketis null when the ticket output does not change. -
passstringnullableonoffchanges.passis null when the pass output does not change. -
qrCheckInstringnullableonoffchanges.qrCheckInis null when the QR check-in output does not change.
-
-
countintegerat least 0
countis zero when no ticket or pass output changes. -
issuedPassesintegerat least 0
issuedPassesis zero when no ticket or pass output changes, even if passes were previously issued.
{
"changes": {
"ticket": "on",
"pass": "on",
"qrCheckIn": "on"
},
"count": 0,
"issuedPasses": 0
}
Errors
Other errors
| Status | Error | When |
|---|---|---|
| 404 | No fixed message | Returns HTTP 404 (NOT_FOUND) if the booking template is not found for the organization. |
Errors nearly every request can meet are listed under Errors.