Event and Design details

This API used to get event and its design related information.
This API can be access by event admin and super admin. It will return data like eventFormat, eventId, eventListingStatus, eventPhoneNumber, eventUrl, fundANeedEnabled, eventCountryCode, eventDesignDetail and many more.
User have to pass their authentication key for user authentication.
This API used at host side to get event and its design related information.

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

Attribute

Description

eventId

This event ID represent unique ID of each event. It will generate automatically when it's create new event.

eventName

It's contains the name of event.

eventUrl

Event url is unique identifier for your event. E.g https://www.accelevents.com/events/demo. Here demo is the event url.

eventPhoneNumber

It's contains the country wise event phone number.

eventCountryCode

It contains the country code of event, e.g. US, IN, ID.

noModuleActivate

It's contains the true if non of module active.

auctionEnabled

It will return the auction enabled or not.

fundANeedEnabled

It's contains the fund a need module active.

raffleEnabled

It's contains the raffle module active.

donationEnabled

It's contains the donation module active.

ticketingEnabled

It's contains the ticketing module active.

textToGiveEnabled

It's contains the text to give module active.

currencySymbol

It's contains the currency symbol for event.

enableBidderRegistration

Enable bidder registration or credit card registration flag.

eventDesignDetailDto

It's contains the Event Design Details.
logoEnabled: It's contains the Is logo enabled?
logoImage: It's contains the logo image for event design.
headerLogoImage: Is header logo enabled?
notificationPopupImage: It's contains the notification popup image.
headerColor: It's contains the header color.
headerFontColor: It's contains the header font color.
bannerImageEnabled: It's contains the Is banner enabled?
bannerImage: It's contains the banner Image.
descripation: It's contains the description for event design details.
totalFundRaisedShow: Is total fund raised show?
socialSharingEnabled: Is social sharing enabled?
intercomActivated: It's contains the Is intercom activated?
helpCenterActivated: Is help center activated?
poweredByAeActivated: Is powered by Ae activated?
biillingPageEnabled: Is billing page enabeld?
marketingOptInHidden: Is marketing Option Hidden?
marketingOptInChecked: Is marketing Option Checked?
defaultItemImage: It's contains the default item image.
hideFundRaisingModuleToggle: It's contains the hide fund raising module toggle?
showEnableModulePopup: It's contains the show enable modules popup?
faviconDirectory: Fav Icon Directory name for white label.
fbAppId: It's contains the Facebook App Id.
whiteLabelHostBaseUrl: It's contains the white label host base url.
footerText: It's contains the footer text.
whiteLabelUrl: The white label Url for white label event.
whiteLabelName: It's contains the White Label name for white label event.
auctionTabTitle: It's contains the auction tab title.
fundANeedTabTitle: It's contains the FundANeed tab title.
raffleTabTitle: It's contains the raffle tab title.
ticketingTabTitle: It's contains the ticketing Tab Title.
donationTabTitle: It's contains the donation Tab Title.
helpCenterURL: It's contains the help center url.
stripeDocumentationURL: It's contains the Stripe guideline document URL.
signUpText: It's contains the sign up text.
emailTemplateId: It's contains the default email template Id for contact email.
sponsorSection: It's event sponsor section, if not passed will set empty string.
eventTagLine: It's event tag line for display pages.
displayBackgroundColor: It's contains the background color for the display.
displayTextColor: It's contains the text color for the display.
hideSponsorSection: It's hide sponsor section.
getStartedUrl: It's contains the get Started Url.
ticketingBuyButtonText: It's contains the but button text. It will return data like button color, label, font and hide button.
raffleBuyButtonText: It's contains the raffle but button text. It will return data like button color, label, font and hide button.
trackingScript: It's contains the tracking Script.
virtualEventScript: It's virtual event script.
themeId: It's contains the theme id.
orderConfirmationText: Order confirmation text is success message to user on ticket purchase.
enableSessionsSpeakers: It's contains the enable sessions speakers.
enableAutoAssignedSequence: It's enable auto assigned attendee number.
hideGoogleMap: It's contains the hide google map.
donationButtonText: It's contains the donation button text. It will return data like Donation Button Color, Donation Button hidden or not and Button label.
eventType: It's contains the event type.
configureTabsAsJson: Configure this tabs. About, Agenda, Sponsor, Speakers, Exhibitors. Json contains Order of the tab, name of the Tab, hide or unhide for the tab in JSON format.
allowEndedEventAccess: Allow attendees from accessing event after event ends.
hideCreateEventButton: It's contains the hide create event button.
hideProductUpdateNotification: It's contains the hide product update notification.
eventCalendarInvite: It's event calendar invite.
displayTabsColor: It's contains the tabs color for the display.
displayTabsTextColor: It's contains the tabs color for the display.
showOrganizer: It's ability to show organizer.
adBlockerDocumentUrl: It's Ad blocker document URL.
adBlockerLogoImage: It's ad blocker logo Image.
exitIntentContent: It's exit Intent content.

organizerURL

It's contains the organizer URL.

countryCode

It contains the country code of event, e.g. US, IN, ID.

equivalentTimezone

This is timezone equivalent to custom timezone, e.g. Asia/Karachi, Asia/Calcutta, America/New_York.

auctionModuleShow

It will return the auction module show or hide.

fundANeedModuleShow

It's contains the fundANeed module show or hide.

raffleModuleShow

It's contains the raffle nodule hide or show.

stripeKey

It's contains the key for stripe or square.

creditCardEnabled

It's check credit card are enabled or not.

paymentGateway

It's contains the payment gateway stripe or square.

squareLocationId

It's contains the location Id of Square.

processingFeesToPurchaser

is processing fees to purchaser.

eventListingStatus

It's contains the event listing status. It will return data like PRIVATE, PUBLIC, PREVIEW, PUBLISHED and POSTPONED.

eventFormat

It's contains the event format. It will return data like Virtual, Hybrid and In-Person.

supportEnabled

It's contains the support enabled or not.

accountActivatedTriggerStatus

It's contains the account activated trigger status for facebook pixel.

recurring

It's contains the check if recurring event or not.

Here is the possible error messages, which return if any condition gets failed or required data is missing for processing.

Error Code

Error Description

200

Return event and its design related information.

400

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

401

You are not authorized to view the resource.

403

Accessing the resource you were trying to reach is forbidden.

404

The resource you were trying to reach is not found.

4030201

Not Event Host.

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