Get Event Design Settings

This API is used to get event data with design details associated with the specified event.

This API can be accessed by event admin and super admin. It will return event data like accessToken, eventId, eventStatus, eventURL, address, eventDesignDetails, organizerName, createdDate and many more.

To call this API, the user has to pass query param with API URLs like eventurl, userKey and authentication key to authenticate the user.

Path Parameters
eventUrl

Body Parameters
Not Required

Response
Details / Check response object

Authentication required - ✅

Role wise accessibility 

Super Admin - ✅
Organizer Admin - ✅
Staff - ❌
Attendee - ❌
Exhibitor - ❌
Speaker - ❌

Modules
Display - ❌
Portal - ❌
Host - ✅

Here is the description of response attributes, which returns to the form of JSON.
It will return a success message if API executes it successfully.

AttributeDescription
eventName This is the name of your event
eventUrl Event URL is a unique identifier for your event. E.g https://www.accelevents.com/events/demo. Here demo is the event URL.
logoEnabled This is for enabling the event logo, if not passed, it will set true
logoImage This is an event logo URL, if not passed, it will set null
bannerImageEnabled This is for enabling the event banner, if not passed, it will set true
bannerImage This is a banner Image URL, if not passed, it will set null
desc This is the event description, if not passed, it will set empty string
totalFundRaisedShow This shows the total fundraised, if not passed, it will set true
socialSharingEnabled This is for showing social sharing, if not passed, it will set true
organizerId This is the Organizer Id of the event
organizerName This is the Organizer name of the event
organizerPageURL This is the Organizer page URL of the event
displayBackgroundColor Background color for the display
displayTextColor Text color for the display
sponsorSection The event sponsor section, if not passed, it will set an empty string
eventTagLine This is the event tagline for display pages
hideSponsorSection This is for hiding the sponsor section or not (if true, section will be hidden)
startDate This is the event start date in yyyy/MM/dd HH:mm format
endDate This is the event end date in yyyy/MM/dd HH:mm format
equivalentTimezone This is timezone equivalent to custom timezone
eventAddress This is the Location or Address of the Event
ticketingBuyButtonText This is a JSON array of ticket button attributes and its fields information like button's color, label, font, and visibility.
raffleBuyButtonText This is a JSON array of Raffle button attributes and its fields information like button's color, label, font, and visibility.
trackingScript This contains Tracking Script
virtualEventScript This contains virtual event Script
themeId This is the theme id of your event
enableSessionsSpeakers This is a setting for enabling session speakers or not.
eventType This is the event type of your event
enableEventType This is a setting for enabling the event type or not
auctionTabTitle This is the Auction tab title
fundANeedTabTitle This is the Fund A Need tab title
raffleTabTitle This is the Raffle tab title
ticketingTabTitle This is the the Ticketing tab title
donationTabTitle This is the Donation tab title
hideGoogleMap This is for if we hide Google Maps or not for the event site.
auctionInstruction This is the auction instructions for an SMS bid or submits ticket or pledge
raffleInstruction This is the Raffle instructions for an SMS bid or submits ticket or pledge
fundANeedInstruction This is the Fund A Need instructions for an SMS bid or submits ticket or pledge
donationButtonText This is a JSON array of Donation button attributes and its fields information like button's color, label, and visibility.
eventFormat This contains Event formats like virtual, person, or hybrid
configureTabsAsJson This Configures these tabs: About, Agenda, Sponsor, Speakers, Exhibitors. Front-end needs to pass OrderOfTheTab, name of the Tab, hide/unhide for the tab in JSON format.
allowEndedEventAccess This allows accessing ended events.
eventCalendarInvite This is the event calendar invite description. If not passed, it will set empty string
displayTabsColor This is the Tabs color for the display
displayTabsTextColor This is the Tabs text color for the display
showOrganizer This is if you want to show organizer or not (if yes, organizer will show)
preEventAccessMinutes This is Pre-event access in minutes before event start time that attendees can access it

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

Error CodeError Description
200OK
401You are not authorized to view the resource
403Accessing the resource you were trying to reach is forbidden
404The resource you were trying to reach is not found.
4040200No Event could be found
4010101Not authorized
Language
Authorization
Header
Click Try It! to start a request and see the response here!