Get raffle details on display page

This API is used to get the Raffle module display page setting by an event. This contains all basic details of raffle which will be displayed to end users.

Path Parameters

  • Event URL

Body Parameters - Not required

Details / Check response object

Authentication required - ❌

Display - ✅
Portal - ❌

Host - ❌

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

categoriesThis represents raffle item categories, raffle items may or may not belong to a particular category.
categoriesEnabledIf this is true then users can browse items by category, otherwise not.
countDownTimeShowIf this is true then users can see remaining time of the raffle end.
endDateThis contains raffle end time. it will return in yyyy/MM/dd HH:mm:sss format.
instructionContains instructions on how to submit raffle tickets.
marketValueEnabledSpecify the market value of each item
moduleActivatedWhether the raffle is activated or not. Users can buy tickets only if this is true (activated)
moduleEndedReturns true if the module already ended, then users can't buy tickets. The default value is false.
pledgeButtonNameDisplay button text for end-users
requireUserAddressIf this is true then users must provide address details while purchasing tickets.
socialSharingEnabledWhether social share allowed or not for a raffle item
totalFundRaisedAmount of total funds collected by raffle.
txtMsgBidInstShownIf this is true then show text message bidding instructions
complimantaryCodeAvailableIf a Complimentary code is available, this returns true
autoSubmitOnPurchaseif this is true, then if the user purchases at that time tickets will be auto-submitted for raffle
availableTicketsThis indicates available tickets for sale
ticketPackagesThis contains a number of tickets price-wise, including:
- numberOfTickets : Total number of tickets available
- price : Describes price of an individual ticket.
- id: Represents unique identifier of a ticket
- complementary -: boolean type represents - if complementary is enabled then it returns true, otherwise false.
descriptionThis contains a raffle description
raffleBuyButtonTextContains properties of raffle button for display like color, label, font, hidden (true or false)
Error CodeError Description
400The request could not be understood by the server due to malformed syntax.
4040200Event Not Found
Click Try It! to start a request and see the response here!