Crm · Passes · Templates
Get pass wallet design
Returns the native wallet design and permitted synthetic composition sample without changing the template.
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
Request
curl --fail-with-body --silent --show-error --max-time 30 --globoff \
--request GET 'https://cloud.campai.com/api/YOUR_ORGANIZATION_ID/YOUR_MANDATE_ID/crm/passes/templates/YOUR_TEMPLATE_ID/wallet-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/wallet-design", {
method: "GET",
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' => 'GET',
'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/wallet-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;
Response
200 Successful response
Content-Type: application/json
-
designobject -
sampleobject9 properties
-
languagestring -
passConstraintsobjectnullable2 properties
-
barcodeobjectnullable2 properties
-
formatstringqrcodecode128pdf417aztec -
contentobject1 property
-
variablestringat least 1 characters
-
-
-
expiresAtobjectnullable1 property
-
variablestringat least 1 characters
-
-
-
fixedPaperFormatobjectnullable4 properties
-
unitstringpxptmmin -
widthnumber -
heightnumber -
landscapeboolean
-
-
variablesobject of object -
propertiesobject of object -
collectionsobject of object -
richContentobject of stringmarkdownhtml -
stackobject of one of 5 types[] -
displayStackobject of one of 5 types[]
-
-
designRevisionintegerat least 0
Response200
{
"design": {
"version": 1,
"channel": "pass",
"id": "string",
"languages": [
"string"
],
"resources": [
{
"resource": "string",
"id": "string"
}
],
"isSingleUse": true,
"expiresAt": {
"variable": "string"
},
"locations": [
{
"latitude": -90,
"longitude": -180
}
],
"issuerName": {
"mode": "plain",
"values": {
"key": [
{
"kind": "literal",
"value": "string"
}
]
},
"fallbackLanguage": "string"
},
"logoImage": {
"type": "resource",
"resourceId": "string"
},
"mainImage": {
"type": "resource",
"resourceId": "string"
},
"textFields": {
"key": {
"type": "header",
"label": {
"mode": "plain",
"values": {
"key": [
{
"kind": "literal",
"value": "string"
}
]
},
"fallbackLanguage": "string"
},
"value": {
"mode": "plain",
"values": {
"key": [
{
"kind": "literal",
"value": "string"
}
]
},
"fallbackLanguage": "string"
}
}
},
"barcode": {
"format": "qrcode",
"content": {
"mode": "plain",
"values": {
"key": [
{
"kind": "literal",
"value": "string"
}
]
},
"fallbackLanguage": "string"
},
"text": {
"mode": "plain",
"values": {
"key": [
{
"kind": "literal",
"value": "string"
}
]
},
"fallbackLanguage": "string"
}
},
"apple": {
"showIssuerName": true,
"textColor": "string",
"hideMainFields": true
},
"google": {
"renderWideLogo": true
},
"type": "custom",
"custom": {
"header": {
"mode": "plain",
"values": {
"key": [
{
"kind": "literal",
"value": "string"
}
]
},
"fallbackLanguage": "string"
},
"subheader": {
"mode": "plain",
"values": {
"key": [
{
"kind": "literal",
"value": "string"
}
]
},
"fallbackLanguage": "string"
},
"backgroundColor": {
"mode": "plain",
"values": {
"key": [
{
"kind": "literal",
"value": "string"
}
]
},
"fallbackLanguage": "string"
}
}
},
"sample": {
"language": "string",
"passConstraints": {
"barcode": {
"format": "qrcode",
"content": {
"variable": "string"
}
},
"expiresAt": {
"variable": "string"
}
},
"fixedPaperFormat": {
"unit": "px",
"width": 1,
"height": 1,
"landscape": true
},
"variables": {
"key": {
"type": "string"
}
},
"properties": {
"key": {
"path": "string",
"property": {
"name": "string",
"format": "string"
}
}
},
"collections": {
"key": {
"path": "string",
"group": {
"groupName": "string",
"properties": {
"key": {
"name": "string",
"format": "string"
}
},
"array": true,
"name": "string"
}
}
},
"richContent": {
"key": "markdown"
},
"stack": [
{
"key": "string"
}
],
"displayStack": [
{
"key": "string"
}
]
},
"designRevision": 0
}
Errors
No errors of its own are known for this endpoint.
Errors nearly every request can meet are listed under Errors.