Donation · Donations
Create donation confirmations
Creates confirmations for pending donations of a given mandate. Pending donations of the same donator are combined into one collective confirmation per calendar year, donators below the thank-you threshold can get a thank-you letter instead. Donations which can not be confirmed, e.g. because of a missing address, are returned with the reason instead of being confirmed. The texts of the settings can be replaced for one run and confirmations can be sent as letters instead of emails
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.edit
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 -
textsobject2 properties
-
confirmationobjectrequired3 properties
-
documentContentstringrequiredat most 4000 characters
-
subjectstringrequired1–998 characters
-
messagestringrequired1–10000 characters
-
-
thankYouobjectrequired3 properties
-
documentContentstringrequiredat most 4000 characters
-
subjectstringrequired1–998 characters
-
messagestringrequired1–10000 characters
-
-
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/createDonationConfirmations' \
--header 'X-API-Key: YOUR_API_KEY'const response = await fetch("https://cloud.campai.com/api/YOUR_ORGANIZATION_ID/YOUR_MANDATE_ID/donation/donations/createDonationConfirmations", {
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/createDonationConfirmations', 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
-
confirmationCountintegerat least 0
-
failuresobject[]3 properties
-
donationNumbersstring[]each at least 1 characters
-
donatorNamestring1–81 characters
-
messagestring
-
{
"confirmationCount": 0,
"failures": [
{
"donationNumbers": [
"string"
],
"donatorName": "string",
"message": "string"
}
]
}
Errors
No errors of its own are known for this endpoint.
Errors nearly every request can meet are listed under Errors.