This API is used to get text to give module setting information on the Admin Console. The host can use the values on this page to modify which will be applicable on client side of their event.
Path Parameters
eventUrl
Body Parameters
Not Required
Authentication Required - ✅
Role wise accessibility
Super Admin - ✅
Admin - ✅
Staff - ❌
Attendee - ❌
Exhibitor - ❌
Speaker - ❌
Modules
Display - ❌
Portal - ❌
Host - ✅
Here is the description of response attributes, which returns to the form of JSON.
Attribute | Description |
|---|---|
donationAmountA | Amount A for donation page.This refers one of 4 default donation amounts which are created by default. The host can edit this value if desired. |
donationAmountB | Amount B for donation page.This refers one of 4 default donation amounts which are created by default. The host can edit this value if desired. |
donationAmountC | Amount C for donation page.This refers one of 4 default donation amounts which are created by default. The host can edit this value if desired. |
donationAmountD | Amount D for donation page.This refers one of 4 default donation amounts which are created by default. The host can edit this value if desired. |
donationGoalAmount | This represents the total donation goal of the Text to Give fundraising module. |
absorbAEFees | This represents whether the Accelevents fees will be absorbed by the host organization or passed to the donor. If "true" then the fees will be absorbed by the host organization. If "false" then the fees will be paid by the donor. |
donationPageDescription | This represents the description that the host creates for their event site's donation page. |
enableRecurringDonations | This represents whether whether or not the host wants to give donors the option to automatically repeat their donation monthly. If "true" donors can select this option, if "false" it will not be visible to them. |
showDonorName | This represents the option to show or hide donor names on fundraising webpage views. If "true" the names will be shown, if "false", they will be hidden. |
enableScrollOnGoalPage | This represents the option to enable a scrolling carousel of donor names on the Text to Give goal page. If "true" the names & donations will scroll, if "false" then the carousel will not appear. |
donationViewBackgroundImage | This represents the main image for the donation goal page background. The recommended size is a 1920 X 1080px image. |
customThermometerImage | This represents the main image for donation goal page custom thermometer image. The recommended size is a 352 x 240px image. |
hideDonationGoal | This represents whether the donation goal will be shown or hidden on the client side. If "true" then donation goal amount will not be displayed, if "false" the goal amount will be displayed. |
txtMsgBidInstShown | This represents the option to include the text message bidding instructions on the client side. If "true" then the instructions will show. If "false", then they will not. |
showMainDonationPageImage | This represents the image that will be used as the custom thermometer for the donation goal. If "true" then main donation image will be shown. If "false" then it will not. |
additionalInfo | This represents a field allowing donors to add additional information about their donation. |
requireUserAddress | This represents the option to collect fundraising participant mailing addresses when donating. If "true" the addresses will be collected. If "false" they will not be. |