Donation · Donations
Get donation confirmation preview
Returns a preview of the confirmation or thank-you letter for the first donator of a confirmation run with the given texts, i.e. before creating the confirmations of the filtered pending donations. Sample data is used when no donator of the run gets this kind of document
Permissions
Send an API key of the organization in the path, using the X-API-Key header.
Permission checks in detail
Required permissions
mandate.readdonation.read
Request
Path parameters
-
organizationIdidrequired -
mandateIdidrequired
Body
Content-Type: application/json
-
searchTermstring -
selectionobject2 properties
-
excludeIdsid[]1–1000 items
-
idsid[]1–1000 items
-
-
austrianReportingStatusstringnotReportedprocessingreportedchangederrornotReportable -
donatorAccountinteger1–999999999
-
campaignid -
periodobject2 properties
-
fromstring · date-timerequired -
tostring · date-timerequired
-
-
sendConfirmationbooleanrequired -
useThankYouLettersbooleanrequired -
sendAsLettersbooleandefault
false -
thankYoubooleanrequired -
textsobjectrequired3 properties
-
documentContentstringrequiredat most 4000 characters
-
subjectstringrequired1–998 characters
-
messagestringrequired1–10000 characters
-
Request
curl --fail-with-body --silent --show-error --max-time 30 --globoff \
--request POST 'https://cloud.campai.com/api/YOUR_ORGANIZATION_ID/YOUR_MANDATE_ID/donation/donations/getDonationConfirmationPreview' \
--header 'X-API-Key: YOUR_API_KEY'const response = await fetch("https://cloud.campai.com/api/YOUR_ORGANIZATION_ID/YOUR_MANDATE_ID/donation/donations/getDonationConfirmationPreview", {
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/donation/donations/getDonationConfirmationPreview', 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
-
documentstring -
pagesintegerat least 0
-
donatorNamestring1–81 characters
-
sampleboolean -
subjectstring -
messagestring
Response200
{
"document": "string",
"pages": 0,
"donatorName": "string",
"sample": true,
"subject": "string",
"message": "string"
}
Errors
No errors of its own are known for this endpoint.
Errors nearly every request can meet are listed under Errors.