This API is used to get Raffle host side setting information. This API can be accessed by event admin and super admin. It will return Raffle data like accessToken, raffle status, event timezone, and many more. We need to pass an authentication token to authorize the user, event URL in path param, and get all the settings of the raffle.
Here is the description of response attributes, which returns to the form of JSON.
Attribute | Description |
|---|---|
activated | Is the Raffle module activated? If not passed, will be set to false. |
categoryEnabled | Is category enabled? If not passed will be set to false. |
raffleStatus | It contains raffle Status like: Event Happening, Processing Winner, Winner Announced, Bidding Extended, Event Module Deleted. |
countDownTimeShow | Display the count down, if not passed will set true. |
equivalentTimeZone | This is timezone equivalent to selected timezone. |
eventTimeZone | Selected Event Time Zone Id |
moduleShow | Show module tab on display page? if not passed will be set to false. |
pledgeButtonName | Used to set the custom label of pledge button. |
requireUserAddress | Are the fundraising participant's mailing addresses to be collected? |
showItemTotals | Is Item totals shown on the event landing page? |
timeZones | Returns list of available timezones. |
txtMsgBidInstShown | Show Text Message Bidding Instructions. |
userTime | End time of Fund A Need to submit a pledge. |
allowMultipleWinnersPerItem | Do we allow multiple winners per item? the default value will be false. |
compTicketCode | List of Complimentary Ticket Code that you wish to accept. |
sweepstakes | Are sweepstakes allowed in raffles? |
availableTickets | Available tickets for sale in the raffle? |
autoSubmitOnPurchase | Is it directly auto-submit on the purchase button? |
displayTotalTicketSubmitted | Display total tickets on the display page? |
isEnableMarketValue | Is market value enabled? If this toggle is on, then the user can enter the market value for the item. |
description | General description of the raffle. This is what will show on the event landing page. |