Skip to content
campaiDeveloper
campai.com

Donation · Forms

POST/{organizationId}/{mandateId}/donation/forms/{donationFormId}

Update donation form

Updates a donation form. The sections of its form are fixed, only fields without the built-in x: prefix of the given form are kept. Donations already given are not changed

Permissions

Send an API key of the organization in the path, using the X-API-Key header.

Permission checks in detail
Required permissions
  • mandate.read
  • donationForm.edit

Request

Path parameters

  • organizationIdidrequired
  • mandateIdidrequired
  • donationFormIdidrequired

Body

Content-Type: application/json

  • namestringrequired

    1–64 characters

  • availablebooleanrequired
  • campaignidrequirednullable
  • contactTypestringrequired
    member address customer sponsor contributor employee supplier
  • createContactsForOneTimebooleanrequired
  • contentobjectrequired
    4 properties
    • titlestringrequired

      1–100 characters

    • introTextstringrequired

      at most 4000 characters

    • pageModestringrequired
      segments flow flowWithProgress
    • showCampaignProgressbooleanrequired
  • oneTimeobjectrequired
    6 properties
    • enabledbooleanrequired
    • amountsobjectrequired
      5 properties
      • suggestionsinteger[]required

        at most 6 items · each at most 9999999999

      • defaultAmountintegerrequirednullable

        at most 9999999999

      • allowCustomAmountbooleanrequired
      • minimumAmountintegerrequirednullable

        at most 9999999999

      • maximumAmountintegerrequirednullable

        at most 9999999999

    • accountintegerrequirednullable

      1–999999999

    • costCenter1numberrequirednullable

      1–99999999

    • costCenter2numberrequirednullable

      1–99999999

    • descriptionstringrequired

      1–200 characters

  • recurringobjectrequired
    3 properties
    • enabledbooleanrequired
    • plansobject[]required

      at most 10 items

      4 properties
      • planidrequired
      • labelstringrequired

        1–64 characters

      • descriptionstringrequired

        at most 300 characters

      • amountsobjectrequired
        5 properties
        • suggestionsinteger[]required

          at most 6 items · each at most 9999999999

        • defaultAmountintegerrequirednullable

          at most 9999999999

        • allowCustomAmountbooleanrequired
        • minimumAmountintegerrequirednullable

          at most 9999999999

        • maximumAmountintegerrequirednullable

          at most 9999999999

    • requireReviewbooleanrequired
  • feeCoverageobjectrequirednullable
    3 properties
    • percentagenumberrequired

      0–20

    • fixedAmountintegerrequired

      0–9999999999

    • preSelectedbooleanrequired
  • donorobjectrequired
    4 properties
    • addressModestringrequired
      none optional required
    • applicantTypestringrequired
      person organization both
    • requirePhonebooleanrequired
    • askForConfirmationbooleanrequired
  • paymentMethodsobjectrequired
    4 properties
    • sepaCreditTransferobjectrequirednullable
      3 properties
      • internalbooleanrequired
      • cashAccountidrequired
      • notestringrequired

        at most 300 characters

    • sepaDirectDebitobjectrequirednullable
      3 properties
      • internalbooleanrequired
      • cashAccountidrequired
      • notestringrequired

        at most 300 characters

    • onlineobjectrequirednullable
      4 properties
      • internalbooleanrequired
      • notestringrequired

        at most 300 characters

      • stripebooleannullable

        default true

      • paypalbooleannullable

        default false

    • cashobjectrequirednullable
      2 properties
      • internalbooleanrequired
      • notestringrequired

        at most 300 characters

  • formobjectrequired
    5 properties
    • groupsobject[]required
      12 properties
      • idstringrequired

        1–24 characters

      • pageIdstring

        1–24 characters

      • labelstringrequired

        at most 140 characters

      • hintstring

        at most 280 characters

      • fieldsobject[]required
      • disabledboolean | object
        2 properties
        • operatorstringrequired
          and or
        • conditions(object (recursive) | object)[]required

          at least 1 items

          4 properties
          • leftobject | object of anyrequired
            Variant 1: 1 property
            • variablestringrequired

              at least 1 characters

            Variant 2: 4 properties
            • sourceobjectrequired
              1 property
              • variablestringrequired

                at least 1 characters

            • lookupobjectrequirednullable
              1 property
              • variablestringrequired

                at least 1 characters

            • arraybooleanrequired
            • selectobject (recursive)required
            Variant 3: 2 properties
            • funcstringrequired
              33 values
              concat ifEmpty lowercase uppercase substring trim abs ceil floor min max mod sum sub mul div avg med parseNumber formatNumber dateOnly dateTime dateOnlyPart dateTimePart age dateOnlyDifference dateTimeDifference setDateOnly setDateTime addDateOnly addDateTime formatDateOnly formatDateTime
            • paramsobject (recursive)[]
            Variant 4: 1 property
            • literalnumber[] | numberrequired
            Variant 5: 3 properties
            • ifobject (recursive)required
            • thenobject (recursive)required
            • elseobject (recursive)required
          • cmpFuncstringrequired
            15 values
            eq isSet lt lte gt gte includes contains startsWith endsWith before beforeAt after afterAt isToday
          • rightobject | object of any
            Variant 1: 1 property
            • variablestringrequired

              at least 1 characters

            Variant 2: 4 properties
            • sourceobjectrequired
              1 property
              • variablestringrequired

                at least 1 characters

            • lookupobjectrequirednullable
              1 property
              • variablestringrequired

                at least 1 characters

            • arraybooleanrequired
            • selectobject (recursive)required
            Variant 3: 2 properties
            • funcstringrequired
              33 values
              concat ifEmpty lowercase uppercase substring trim abs ceil floor min max mod sum sub mul div avg med parseNumber formatNumber dateOnly dateTime dateOnlyPart dateTimePart age dateOnlyDifference dateTimeDifference setDateOnly setDateTime addDateOnly addDateTime formatDateOnly formatDateTime
            • paramsobject (recursive)[]
            Variant 4: 1 property
            • literalnumber[] | numberrequired
            Variant 5: 3 properties
            • ifobject (recursive)required
            • thenobject (recursive)required
            • elseobject (recursive)required
          • negateboolean
      • hiddenboolean | object
        2 properties
        • operatorstringrequired
          and or
        • conditions(object (recursive) | object)[]required

          at least 1 items

          4 properties
          • leftobject | object of anyrequired
            Variant 1: 1 property
            • variablestringrequired

              at least 1 characters

            Variant 2: 4 properties
            • sourceobjectrequired
              1 property
              • variablestringrequired

                at least 1 characters

            • lookupobjectrequirednullable
              1 property
              • variablestringrequired

                at least 1 characters

            • arraybooleanrequired
            • selectobject (recursive)required
            Variant 3: 2 properties
            • funcstringrequired
              33 values
              concat ifEmpty lowercase uppercase substring trim abs ceil floor min max mod sum sub mul div avg med parseNumber formatNumber dateOnly dateTime dateOnlyPart dateTimePart age dateOnlyDifference dateTimeDifference setDateOnly setDateTime addDateOnly addDateTime formatDateOnly formatDateTime
            • paramsobject (recursive)[]
            Variant 4: 1 property
            • literalnumber[] | numberrequired
            Variant 5: 3 properties
            • ifobject (recursive)required
            • thenobject (recursive)required
            • elseobject (recursive)required
          • cmpFuncstringrequired
            15 values
            eq isSet lt lte gt gte includes contains startsWith endsWith before beforeAt after afterAt isToday
          • rightobject | object of any
            Variant 1: 1 property
            • variablestringrequired

              at least 1 characters

            Variant 2: 4 properties
            • sourceobjectrequired
              1 property
              • variablestringrequired

                at least 1 characters

            • lookupobjectrequirednullable
              1 property
              • variablestringrequired

                at least 1 characters

            • arraybooleanrequired
            • selectobject (recursive)required
            Variant 3: 2 properties
            • funcstringrequired
              33 values
              concat ifEmpty lowercase uppercase substring trim abs ceil floor min max mod sum sub mul div avg med parseNumber formatNumber dateOnly dateTime dateOnlyPart dateTimePart age dateOnlyDifference dateTimeDifference setDateOnly setDateTime addDateOnly addDateTime formatDateOnly formatDateTime
            • paramsobject (recursive)[]
            Variant 4: 1 property
            • literalnumber[] | numberrequired
            Variant 5: 3 properties
            • ifobject (recursive)required
            • thenobject (recursive)required
            • elseobject (recursive)required
          • negateboolean
      • minItemsinteger

        at least 0

      • maxItemsinteger
      • addItemCaptionstring

        at most 64 characters

      • itemCaptionstring

        at most 100 characters

      • itemModestring
        noHeader draggable
    • pagesobject[]
      3 properties
      • idstringrequired

        1–24 characters

      • labelstringrequired

        1–40 characters

      • hintstring

        at most 280 characters

    • submitCaptionstring
    • appearanceobject
      5 properties
      • accentColorstring
      • accentTextColorstring
      • boxobject
        6 properties
        • borderobject
          3 properties
          • widthnumber
          • colorstring

            pattern ^#[0-9A-F]{6,8}$

          • radiusnumber
        • backgroundobject
          1 property
          • colorstring

            pattern ^#[0-9A-F]{6,8}$

        • fontobject
          3 properties
          • colorstring

            pattern ^#[0-9A-F]{6,8}$

          • sizenumber

            at least 1

          • weightnumber
        • shadowsobject[]
          5 properties
          • xnumberrequired
          • ynumberrequired
          • blurnumberrequired

            at least 0

          • spreadnumberrequired

            at least 0

          • colorstringrequired

            pattern ^#[0-9A-F]{6,8}$

        • paddingobject
          4 properties
          • leftnumber

            at least 0

          • rightnumber

            at least 0

          • topnumber

            at least 0

          • bottomnumber

            at least 0

        • marginobject
          4 properties
          • leftnumber

            at least 0

          • rightnumber

            at least 0

          • topnumber

            at least 0

          • bottomnumber

            at least 0

      • groupBoxobject
        6 properties
        • borderobject
          3 properties
          • widthnumber
          • colorstring

            pattern ^#[0-9A-F]{6,8}$

          • radiusnumber
        • backgroundobject
          1 property
          • colorstring

            pattern ^#[0-9A-F]{6,8}$

        • fontobject
          3 properties
          • colorstring

            pattern ^#[0-9A-F]{6,8}$

          • sizenumber

            at least 1

          • weightnumber
        • shadowsobject[]
          5 properties
          • xnumberrequired
          • ynumberrequired
          • blurnumberrequired

            at least 0

          • spreadnumberrequired

            at least 0

          • colorstringrequired

            pattern ^#[0-9A-F]{6,8}$

        • paddingobject
          4 properties
          • leftnumber

            at least 0

          • rightnumber

            at least 0

          • topnumber

            at least 0

          • bottomnumber

            at least 0

        • marginobject
          4 properties
          • leftnumber

            at least 0

          • rightnumber

            at least 0

          • topnumber

            at least 0

          • bottomnumber

            at least 0

      • inputBoxobject
        8 properties
        • borderobject
          3 properties
          • widthnumber
          • colorstring

            pattern ^#[0-9A-F]{6,8}$

          • radiusnumber
        • backgroundobject
          1 property
          • colorstring

            pattern ^#[0-9A-F]{6,8}$

        • fontobject
          3 properties
          • colorstring

            pattern ^#[0-9A-F]{6,8}$

          • sizenumber

            at least 1

          • weightnumber
        • shadowsobject[]
          5 properties
          • xnumberrequired
          • ynumberrequired
          • blurnumberrequired

            at least 0

          • spreadnumberrequired

            at least 0

          • colorstringrequired

            pattern ^#[0-9A-F]{6,8}$

        • paddingobject
          4 properties
          • leftnumber

            at least 0

          • rightnumber

            at least 0

          • topnumber

            at least 0

          • bottomnumber

            at least 0

        • marginobject
          4 properties
          • leftnumber

            at least 0

          • rightnumber

            at least 0

          • topnumber

            at least 0

          • bottomnumber

            at least 0

        • labelFontobject
          3 properties
          • colorstring

            pattern ^#[0-9A-F]{6,8}$

          • sizenumber

            at least 1

          • weightnumber
        • heightnumber

          at least 0

    • validationsobject[]
      2 properties
      • conditionobjectrequired
        2 properties
        • operatorstringrequired
          and or
        • conditions(object (recursive) | object)[]required

          at least 1 items

          4 properties
          • leftobject | object of anyrequired
            Variant 1: 1 property
            • variablestringrequired

              at least 1 characters

            Variant 2: 4 properties
            • sourceobjectrequired
              1 property
              • variablestringrequired

                at least 1 characters

            • lookupobjectrequirednullable
              1 property
              • variablestringrequired

                at least 1 characters

            • arraybooleanrequired
            • selectobject (recursive)required
            Variant 3: 2 properties
            • funcstringrequired
              33 values
              concat ifEmpty lowercase uppercase substring trim abs ceil floor min max mod sum sub mul div avg med parseNumber formatNumber dateOnly dateTime dateOnlyPart dateTimePart age dateOnlyDifference dateTimeDifference setDateOnly setDateTime addDateOnly addDateTime formatDateOnly formatDateTime
            • paramsobject (recursive)[]
            Variant 4: 1 property
            • literalnumber[] | numberrequired
            Variant 5: 3 properties
            • ifobject (recursive)required
            • thenobject (recursive)required
            • elseobject (recursive)required
          • cmpFuncstringrequired
            15 values
            eq isSet lt lte gt gte includes contains startsWith endsWith before beforeAt after afterAt isToday
          • rightobject | object of any
            Variant 1: 1 property
            • variablestringrequired

              at least 1 characters

            Variant 2: 4 properties
            • sourceobjectrequired
              1 property
              • variablestringrequired

                at least 1 characters

            • lookupobjectrequirednullable
              1 property
              • variablestringrequired

                at least 1 characters

            • arraybooleanrequired
            • selectobject (recursive)required
            Variant 3: 2 properties
            • funcstringrequired
              33 values
              concat ifEmpty lowercase uppercase substring trim abs ceil floor min max mod sum sub mul div avg med parseNumber formatNumber dateOnly dateTime dateOnlyPart dateTimePart age dateOnlyDifference dateTimeDifference setDateOnly setDateTime addDateOnly addDateTime formatDateOnly formatDateTime
            • paramsobject (recursive)[]
            Variant 4: 1 property
            • literalnumber[] | numberrequired
            Variant 5: 3 properties
            • ifobject (recursive)required
            • thenobject (recursive)required
            • elseobject (recursive)required
          • negateboolean
      • messagestring

        1–500 characters

  • submitobjectrequired
    5 properties
    • submitCaptionstringrequired

      at least 1 characters

    • useCaptchabooleanrequired
    • submittedTextstringrequired

      1–4000 characters

    • navigateUrlstring · uri | stringrequired
    • navigateWaitSecondsintegerrequired

      at least 0

  • confirmationobjectrequired
    3 properties
    • oneTimeMailobjectrequirednullable
      2 properties
      • subjectstringrequired

        1–998 characters

      • messagestringrequired

        1–10000 characters

    • recurringMailobjectrequirednullable
      2 properties
      • subjectstringrequired

        1–998 characters

      • messagestringrequired

        1–10000 characters

    • acceptedMailobjectrequirednullable
      2 properties
      • subjectstringrequired

        1–998 characters

      • messagestringrequired

        1–10000 characters

  • notificationsobjectrequired
    2 properties
    • oneTimeDonationsbooleanrequired
    • minimumAmountintegerrequirednullable

      at most 9999999999

  • reviewerUserIdsstring[]required

    at most 20 items · each at least 16 characters

  • reviewerRulesobject[]required

    at most 50 items

    2 properties
    • conditionobjectrequired
      2 properties
      • operatorstringrequired
        and or
      • conditions(object (recursive) | object)[]required

        at least 1 items

        4 properties
        • leftobject | object of anyrequired
          Variant 1: 1 property
          • variablestringrequired

            at least 1 characters

          Variant 2: 4 properties
          • sourceobjectrequired
            1 property
            • variablestringrequired

              at least 1 characters

          • lookupobjectrequirednullable
            1 property
            • variablestringrequired

              at least 1 characters

          • arraybooleanrequired
          • selectobject (recursive)required
          Variant 3: 2 properties
          • funcstringrequired
            33 values
            concat ifEmpty lowercase uppercase substring trim abs ceil floor min max mod sum sub mul div avg med parseNumber formatNumber dateOnly dateTime dateOnlyPart dateTimePart age dateOnlyDifference dateTimeDifference setDateOnly setDateTime addDateOnly addDateTime formatDateOnly formatDateTime
          • paramsobject (recursive)[]
          Variant 4: 1 property
          • literalnumber[] | numberrequired
          Variant 5: 3 properties
          • ifobject (recursive)required
          • thenobject (recursive)required
          • elseobject (recursive)required
        • cmpFuncstringrequired
          15 values
          eq isSet lt lte gt gte includes contains startsWith endsWith before beforeAt after afterAt isToday
        • rightobject | object of any
          Variant 1: 1 property
          • variablestringrequired

            at least 1 characters

          Variant 2: 4 properties
          • sourceobjectrequired
            1 property
            • variablestringrequired

              at least 1 characters

          • lookupobjectrequirednullable
            1 property
            • variablestringrequired

              at least 1 characters

          • arraybooleanrequired
          • selectobject (recursive)required
          Variant 3: 2 properties
          • funcstringrequired
            33 values
            concat ifEmpty lowercase uppercase substring trim abs ceil floor min max mod sum sub mul div avg med parseNumber formatNumber dateOnly dateTime dateOnlyPart dateTimePart age dateOnlyDifference dateTimeDifference setDateOnly setDateTime addDateOnly addDateTime formatDateOnly formatDateTime
          • paramsobject (recursive)[]
          Variant 4: 1 property
          • literalnumber[] | numberrequired
          Variant 5: 3 properties
          • ifobject (recursive)required
          • thenobject (recursive)required
          • elseobject (recursive)required
        • negateboolean
    • reviewerUserIdsstring[]required

      1–50 items · each at least 16 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/forms/YOUR_DONATION_FORM_ID' \
  --header 'X-API-Key: YOUR_API_KEY'

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.