Crm · Passes · Templates
Save pass print design
Validates and saves the native print design, preserving the configured card format and optionally marking issued passes for printing.
Permissions
Send an API key of the organization in the path, using the X-API-Key header.
Permission checks in detail
Required permissions
contactPassTemplate.edit
Also checked, depending on the request and the records it touches
mandate.readcontact:member.readcontact:address.readcontact:customer.readcontact:sponsor.readcontact:contributor.readcontact:employee.readcontact:supplier.read
Request
Path parameters
-
organizationIdidrequired -
mandateIdidrequired -
templateIdidrequired
Body
Content-Type: application/json
-
expectedRevisionintegerrequiredat least 0
-
designobjectrequired8 properties
-
versionnumberrequired -
channelstringrequired -
containerobjectrequired6 properties
-
typestringrequired -
idstringrequiredpattern
^[a-zA-Z0-9_-]+$ -
repeatobjectrequirednullable1 property
-
sourceobjectrequired1 property
-
variablestringrequiredat least 1 characters
-
-
-
pageSizeobjectrequired3 properties
-
widthnumberrequired -
heightnumberrequired -
landscapebooleanrequired
-
-
fontFamilystringrequired -
itemsobject[]required11 properties
-
idstringrequiredpattern
^[a-zA-Z0-9_-]+$ -
namestringrequiredat most 32 characters
-
hiddenbooleanrequired -
lockedbooleanrequired -
conditionobjectrequirednullable2 properties
-
operatorstringrequiredandor -
conditions(object (recursive) | object)[]requiredat least 1 items
4 properties
-
leftobject | object of anyrequiredVariant 1: 1 property
-
variablestringrequiredat least 1 characters
Variant 2: 4 properties
-
sourceobjectrequired1 property
-
variablestringrequiredat least 1 characters
-
-
lookupobjectrequirednullable1 property
-
variablestringrequiredat least 1 characters
-
-
arraybooleanrequired -
selectobject (recursive)required
Variant 3: 2 properties
-
funcstringrequired33 values
concatifEmptylowercaseuppercasesubstringtrimabsceilfloorminmaxmodsumsubmuldivavgmedparseNumberformatNumberdateOnlydateTimedateOnlyPartdateTimePartagedateOnlyDifferencedateTimeDifferencesetDateOnlysetDateTimeaddDateOnlyaddDateTimeformatDateOnlyformatDateTime -
paramsobject (recursive)[]
Variant 4: 1 property
-
literalnumber[] | numberrequired
Variant 5: 3 properties
-
ifobject (recursive)required -
thenobject (recursive)required -
elseobject (recursive)required
-
-
cmpFuncstringrequired15 values
eqisSetltltegtgteincludescontainsstartsWithendsWithbeforebeforeAtafterafterAtisToday -
rightobject | object of anyVariant 1: 1 property
-
variablestringrequiredat least 1 characters
Variant 2: 4 properties
-
sourceobjectrequired1 property
-
variablestringrequiredat least 1 characters
-
-
lookupobjectrequirednullable1 property
-
variablestringrequiredat least 1 characters
-
-
arraybooleanrequired -
selectobject (recursive)required
Variant 3: 2 properties
-
funcstringrequired33 values
concatifEmptylowercaseuppercasesubstringtrimabsceilfloorminmaxmodsumsubmuldivavgmedparseNumberformatNumberdateOnlydateTimedateOnlyPartdateTimePartagedateOnlyDifferencedateTimeDifferencesetDateOnlysetDateTimeaddDateOnlyaddDateTimeformatDateOnlyformatDateTime -
paramsobject (recursive)[]
Variant 4: 1 property
-
literalnumber[] | numberrequired
Variant 5: 3 properties
-
ifobject (recursive)required -
thenobject (recursive)required -
elseobject (recursive)required
-
-
negateboolean
-
-
-
typestringrequired -
repeatobjectrequirednullable1 property
-
sourceobjectrequired1 property
-
variablestringrequiredat least 1 characters
-
-
-
marginany[]requiredexactly 4 items
-
backgroundobjectrequired3 properties
-
backgroundColorobjectrequired2 properties
-
colorstringrequiredpattern
^#[0-9A-F]{6}$ -
hidebooleanrequired
-
-
backgroundGradientobjectrequired3 properties
-
hidebooleanrequired -
stopsobject[]required2 properties
-
colorstringrequiredpattern
^#[0-9A-F]{6,8}$ -
positionnumberrequiredat least 0
-
-
angleintegerrequired
-
-
backgroundImageobjectrequired4 properties
-
hidebooleanrequired -
imageobjectrequirednullable -
sizestringrequiredcovercontainfilltile -
positionstringrequiredtop lefttop centertop rightmiddle leftmiddle centermiddle rightbottom leftbottom centerbottom right
-
-
-
foldingMarksobject[]required3 properties
-
topnumberrequired -
leftnumberrequired -
widthnumberrequired
-
-
itemsobject[]required
-
-
-
unitstringrequiredpxptmmin -
languagesstring[]requiredat least 1 items · each at least 2 characters
-
onlineLetterbooleanrequired -
resourcesobject[]required5 properties
-
resourcestringrequiredat least 1 characters
-
fileNamestringat most 128 characters
-
contentTypestringat most 75 characters
-
fileSizeBytesintegerat least 0
-
idstringrequiredexactly 6 characters
-
-
attachmentobjectrequirednullable3 properties
-
resourceIdstringrequiredexactly 6 characters
-
modestringrequiredoverlayprependappend -
pagesintegerrequired
-
-
-
markPassesAsPendingbooleanrequired
curl --fail-with-body --silent --show-error --max-time 30 --globoff \
--request POST 'https://cloud.campai.com/api/YOUR_ORGANIZATION_ID/YOUR_MANDATE_ID/crm/passes/templates/YOUR_TEMPLATE_ID/print-design' \
--header 'X-API-Key: YOUR_API_KEY'const response = await fetch("https://cloud.campai.com/api/YOUR_ORGANIZATION_ID/YOUR_MANDATE_ID/crm/passes/templates/YOUR_TEMPLATE_ID/print-design", {
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/crm/passes/templates/YOUR_TEMPLATE_ID/print-design', 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
-
designRevisionintegerat least 0
{
"designRevision": 0
}
Errors
No errors of its own are known for this endpoint.
Errors nearly every request can meet are listed under Errors.