Donation · Forms
Create donation form
Creates a donation form for a given mandate. The sections of its form are fixed, only fields without the built-in x: prefix of the given form are kept
Permissions
Send an API key of the organization in the path, using the X-API-Key header.
Permission checks in detail
Required permissions
mandate.readdonationForm.insert
Request
Path parameters
-
organizationIdidrequired -
mandateIdidrequired
Body
Content-Type: application/json
-
namestringrequired1–64 characters
-
availablebooleanrequired -
campaignidrequirednullable -
contactTypestringrequiredmemberaddresscustomersponsorcontributoremployeesupplier -
createContactsForOneTimebooleanrequired -
contentobjectrequired4 properties
-
titlestringrequired1–100 characters
-
introTextstringrequiredat most 4000 characters
-
pageModestringrequiredsegmentsflowflowWithProgress -
showCampaignProgressbooleanrequired
-
-
oneTimeobjectrequired6 properties
-
enabledbooleanrequired -
amountsobjectrequired5 properties
-
suggestionsinteger[]requiredat most 6 items · each at most 9999999999
-
defaultAmountintegerrequirednullableat most 9999999999
-
allowCustomAmountbooleanrequired -
minimumAmountintegerrequirednullableat most 9999999999
-
maximumAmountintegerrequirednullableat most 9999999999
-
-
accountintegerrequirednullable1–999999999
-
costCenter1numberrequirednullable1–99999999
-
costCenter2numberrequirednullable1–99999999
-
descriptionstringrequired1–200 characters
-
-
recurringobjectrequired3 properties
-
enabledbooleanrequired -
plansobject[]requiredat most 10 items
4 properties
-
planidrequired -
labelstringrequired1–64 characters
-
descriptionstringrequiredat most 300 characters
-
amountsobjectrequired5 properties
-
suggestionsinteger[]requiredat most 6 items · each at most 9999999999
-
defaultAmountintegerrequirednullableat most 9999999999
-
allowCustomAmountbooleanrequired -
minimumAmountintegerrequirednullableat most 9999999999
-
maximumAmountintegerrequirednullableat most 9999999999
-
-
-
requireReviewbooleanrequired
-
-
feeCoverageobjectrequirednullable3 properties
-
percentagenumberrequired0–20
-
fixedAmountintegerrequired0–9999999999
-
preSelectedbooleanrequired
-
-
donorobjectrequired4 properties
-
addressModestringrequirednoneoptionalrequired -
applicantTypestringrequiredpersonorganizationboth -
requirePhonebooleanrequired -
askForConfirmationbooleanrequired
-
-
paymentMethodsobjectrequired4 properties
-
sepaCreditTransferobjectrequirednullable3 properties
-
internalbooleanrequired -
cashAccountidrequired -
notestringrequiredat most 300 characters
-
-
sepaDirectDebitobjectrequirednullable3 properties
-
internalbooleanrequired -
cashAccountidrequired -
notestringrequiredat most 300 characters
-
-
onlineobjectrequirednullable4 properties
-
internalbooleanrequired -
notestringrequiredat most 300 characters
-
stripebooleannullabledefault
true -
paypalbooleannullabledefault
false
-
-
cashobjectrequirednullable2 properties
-
internalbooleanrequired -
notestringrequiredat most 300 characters
-
-
-
formobjectrequired5 properties
-
groupsobject[]required12 properties
-
idstringrequired1–24 characters
-
pageIdstring1–24 characters
-
labelstringrequiredat most 140 characters
-
hintstringat most 280 characters
-
fieldsobject[]required -
disabledboolean | object2 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
-
-
-
hiddenboolean | object2 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
-
-
-
minItemsintegerat least 0
-
maxItemsinteger -
addItemCaptionstringat most 64 characters
-
itemCaptionstringat most 100 characters
-
itemModestringnoHeaderdraggable
-
-
pagesobject[]3 properties
-
idstringrequired1–24 characters
-
labelstringrequired1–40 characters
-
hintstringat most 280 characters
-
-
submitCaptionstring -
appearanceobject5 properties
-
accentColorstring -
accentTextColorstring -
boxobject6 properties
-
borderobject3 properties
-
widthnumber -
colorstringpattern
^#[0-9A-F]{6,8}$ -
radiusnumber
-
-
backgroundobject1 property
-
colorstringpattern
^#[0-9A-F]{6,8}$
-
-
fontobject3 properties
-
colorstringpattern
^#[0-9A-F]{6,8}$ -
sizenumberat least 1
-
weightnumber
-
-
shadowsobject[]5 properties
-
xnumberrequired -
ynumberrequired -
blurnumberrequiredat least 0
-
spreadnumberrequiredat least 0
-
colorstringrequiredpattern
^#[0-9A-F]{6,8}$
-
-
paddingobject4 properties
-
leftnumberat least 0
-
rightnumberat least 0
-
topnumberat least 0
-
bottomnumberat least 0
-
-
marginobject4 properties
-
leftnumberat least 0
-
rightnumberat least 0
-
topnumberat least 0
-
bottomnumberat least 0
-
-
-
groupBoxobject6 properties
-
borderobject3 properties
-
widthnumber -
colorstringpattern
^#[0-9A-F]{6,8}$ -
radiusnumber
-
-
backgroundobject1 property
-
colorstringpattern
^#[0-9A-F]{6,8}$
-
-
fontobject3 properties
-
colorstringpattern
^#[0-9A-F]{6,8}$ -
sizenumberat least 1
-
weightnumber
-
-
shadowsobject[]5 properties
-
xnumberrequired -
ynumberrequired -
blurnumberrequiredat least 0
-
spreadnumberrequiredat least 0
-
colorstringrequiredpattern
^#[0-9A-F]{6,8}$
-
-
paddingobject4 properties
-
leftnumberat least 0
-
rightnumberat least 0
-
topnumberat least 0
-
bottomnumberat least 0
-
-
marginobject4 properties
-
leftnumberat least 0
-
rightnumberat least 0
-
topnumberat least 0
-
bottomnumberat least 0
-
-
-
inputBoxobject8 properties
-
borderobject3 properties
-
widthnumber -
colorstringpattern
^#[0-9A-F]{6,8}$ -
radiusnumber
-
-
backgroundobject1 property
-
colorstringpattern
^#[0-9A-F]{6,8}$
-
-
fontobject3 properties
-
colorstringpattern
^#[0-9A-F]{6,8}$ -
sizenumberat least 1
-
weightnumber
-
-
shadowsobject[]5 properties
-
xnumberrequired -
ynumberrequired -
blurnumberrequiredat least 0
-
spreadnumberrequiredat least 0
-
colorstringrequiredpattern
^#[0-9A-F]{6,8}$
-
-
paddingobject4 properties
-
leftnumberat least 0
-
rightnumberat least 0
-
topnumberat least 0
-
bottomnumberat least 0
-
-
marginobject4 properties
-
leftnumberat least 0
-
rightnumberat least 0
-
topnumberat least 0
-
bottomnumberat least 0
-
-
labelFontobject3 properties
-
colorstringpattern
^#[0-9A-F]{6,8}$ -
sizenumberat least 1
-
weightnumber
-
-
heightnumberat least 0
-
-
-
validationsobject[]2 properties
-
conditionobjectrequired2 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
-
-
-
messagestring1–500 characters
-
-
-
submitobjectrequired5 properties
-
submitCaptionstringrequiredat least 1 characters
-
useCaptchabooleanrequired -
submittedTextstringrequired1–4000 characters
-
navigateUrlstring · uri | stringrequired -
navigateWaitSecondsintegerrequiredat least 0
-
-
confirmationobjectrequired3 properties
-
oneTimeMailobjectrequirednullable2 properties
-
subjectstringrequired1–998 characters
-
messagestringrequired1–10000 characters
-
-
recurringMailobjectrequirednullable2 properties
-
subjectstringrequired1–998 characters
-
messagestringrequired1–10000 characters
-
-
acceptedMailobjectrequirednullable2 properties
-
subjectstringrequired1–998 characters
-
messagestringrequired1–10000 characters
-
-
-
notificationsobjectrequired2 properties
-
oneTimeDonationsbooleanrequired -
minimumAmountintegerrequirednullableat most 9999999999
-
-
reviewerUserIdsstring[]requiredat most 20 items · each at least 16 characters
-
reviewerRulesobject[]requiredat most 50 items
2 properties
-
conditionobjectrequired2 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
-
-
-
reviewerUserIdsstring[]required1–50 items · each at least 16 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/forms' \
--header 'X-API-Key: YOUR_API_KEY'const response = await fetch("https://cloud.campai.com/api/YOUR_ORGANIZATION_ID/YOUR_MANDATE_ID/donation/forms", {
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/forms', 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
-
_idid
{
"_id": "000000000000000000000001"
}
Errors
No errors of its own are known for this endpoint.
Errors nearly every request can meet are listed under Errors.