Get donation item details on display page

This API is used to get the Donation module details by an event. This contains all basic details of the donation campaign which will be displayed to end users.

Path Parameters

  • Event URL

Body Parameters - Not Required

Response
Details / Check response object

Authentication required - ❌

Modules
Display - ✅
Portal - ❌

Host - ❌

Here is the description of response attributes, which returns to the form of JSON.

Attributes

Description

customThermometerImage

This is the main image for donation custom thermometer image. Recommended size is 352 x 240px image.

donationViewBackgroundImage

This is the main image for the donation goal webpage background. Recommended size is 1920 X 1080px image.

items

An array consisting of the following information:
-donorName: Name of donor
-textToGiveAmount: Represents the donation amount given by the donor.
-note: Optional Field. Any extra information donors add while donating.
-recurring : boolean value, if it returns "true" then the donation will be repeated monthly.

showDonorName

boolean field (true or false) states whether the donor name will be displayed or not. If "true" the donor name will show.

goalAmount

This is the total expected goal amount.

totalRaised

This is the total donation amount raised by all donors.

numberOfDonors

This is the total number of unique donors.

enableScroll

Boolean field. If "true" then donor names & donation values will scroll on the donation goal webpage.

showTotalFundRaised

Boolean true. If "true" then the total funds raised will be displayed.

viewScrollSpeed

The time amount at which donor names & donation values will scroll. This will show only if enableScroll is true.

donationViewBackgroundImage

This is the main image for the donation goal webpage background. Recommended size is 1920 X 1080px image.

customThermometerImage

This is the main image for donation custom thermometer image. Recommended size is 352 x 240px image.

hideDonationGoal

boolean field. If "true" then the donation goal amount will not be displayed on the client side, otherwise the goal amount will be displayed.

Error Code

Error Description

400

The request could not be understood by the server due to malformed syntax.

4040200

Event Not Found

Language
Authentication
Header
Click Try It! to start a request and see the response here!