Donation · Donations
Update donation
Updates a donation which has no confirmation yet. Postings of booked positions are replaced as long as they are not committed
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
Required for some requests, where input is what the request sends
posting.edit, ifinput.positions.some((position) => position.booking)
Request
Path parameters
-
organizationIdidrequired -
mandateIdidrequired
Body
Content-Type: application/json
-
donationIdidrequired -
donatorobjectrequired5 properties
-
namestringrequired1–81 characters
-
typestringrequiredbusinessperson -
addressobjectrequirednullable7 properties
-
countrystringrequired -
statestring -
zipstringrequiredat most 10 characters
-
citystringrequiredat most 45 characters
-
addressLinestringrequiredat most 45 characters
-
details1stringat most 45 characters
-
details2stringat most 45 characters
-
-
emailstringrequired -
accountintegerrequirednullable1–999999999
-
-
positionsobject[]requiredat least 1 items
7 properties
-
typestringrequiredcashmembershipFeeassetStockrefundnonCash -
valueintegerrequiredat most 9999999999
-
datestringrequired -
nonCashobject2 properties
-
sourcestringrequiredbusinessprivateunknown -
hasPapersbooleanrequired
-
-
descriptionstringrequiredat most 400 characters
-
campaignidrequirednullable -
bookingobjectrequirednullable2 properties
-
expenseAccountintegerrequirednullable1–999999999
-
accountintegerrequired1–999999999
-
-
-
confirmationSendMethodstringrequirednoneemailpostal -
confirmationRequestedbooleanrequired
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/updateDonation' \
--header 'X-API-Key: YOUR_API_KEY'const response = await fetch("https://cloud.campai.com/api/YOUR_ORGANIZATION_ID/YOUR_MANDATE_ID/donation/donations/updateDonation", {
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/updateDonation', 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
No response body is specified.
Errors
No errors of its own are known for this endpoint.
Errors nearly every request can meet are listed under Errors.