This API is used to create an exhibitor from the Host side of an event.
Response
Here is the description of response attributes, which returns to the form of JSON.
Attribute | Description |
|---|---|
id | The unique ID of the exhibitor. |
staffUserIds | Contains a list of userIds of exhibitor staff in comma separated values. |
exhibitorName | Full name of the exhibitor. |
leadRetrieversAllowed | Returns if lead retrieving is set to allow for the exhibitor. |
seeAllLeads | Returns if the exhibitor can see all leads. |
maxLeadRetrievers | The number of Maximum Lead Retrievers. |
linkToSite | Contains a comma-separated link to the exhibitor website. |
videoURL | Contains the videoURL of the exhibitor. |
logo | Contains the key to the logo image. |
socialLinks | Contains social media links like Facebook, Instagram, Twitter, LinkedIn. |
exhibitorDescription | Contains a brief introduction of the exhibitor. |
offer | Contains the offer(s) within the exhibitor booth. |
offerLink | Contains the offer link(s) within the exhibitor booth. |
position | Contains the position of the exhibitor. |
exhibitorLinkClicks | Contains the number of clicks on exhibitor links. |
liveStreamUrl | Contains the live stream URL of the exhibitor. |
proAccount | Returns true if the exhibitor has a pro exhibitor account. |
companyDetails | Contains exhibitor's company details. |
boothSize | Contains booth size: SMALL, MEDIUM, LARGE. This setting can only be updated by event host. |
preferredExhibitor | Returns if the exhibitor is a preferred exhibitor. This setting can only be updated by event host. |
autoGenerateLead | Shows if the auto generate lead is set to allow from expo page. This setting can only be updated by event host. |
includeInExhibitorCarousel | Shows if exhibitor booth logo is included in Exhibitor Carousel. This flag is used to slide show logos or to display exhibitor logo. |
scanByQRCode | This determines if the exhibitor's sales reps can use the QR code to scan leads in the mobile app. |
categoryIdList | Contains the ID of the exhibitor category. |
categoryName | Contains the name of the exhibitor category. |
documentKeyValue | Contains the exhibitor's documents. key=Uploaded document's key and value as the document name. |
documentKeyPosition | Contains the exhibitor's documents. key=Uploaded document's key and value as document position |
eventURL | Contains the event URL. |
eventId | Contains a unique id of the event. |
externalLiveStreamingEnabled | Returns if external live streaming is enabled. |
exhibitorFieldsInJson | Contains fields of information like tabList,requestMeeting,companyRepresentativeTitle. |
addLinksInJson | Contains the add links for exhibitor store in key-value. |
documentIds | Contains the exhibitor's documents ids |
streamProvider | Contains the stream provider of the session. |
chatEnabled | Shows if chat is enabled for exhibitors. |
acceleventsStreamingEnabled | Shows if Accelevents streaming (pro exhibitor) is enabled for exhibitors. |
meetingPassword | Contains the password of the zoom meeting. |
showStatusIndicator | Returns if the Show status indicator on the expo page is enabled. |
showDownloadLeadBtn | Returns if the Show download lead button in my booth is enabled. |
countBoothVisitorAsLead | Returns if the Count every booth visitor as a lead is enabled. |
carouselLogoSliderDelaySeconds | Contains the Number of seconds for the carousel logo to change. |
shortDescription | Contains the exhibitor's short description. |
expoCardImage | Contains the expo card image link. |
colorConfig | Contains the Exhibitor name and short description color. |
expoBannerImage | Contains the URL of expo banner image. |
visitedTime | Contains the current date the exhibitor booth was visited. |
pollEnabled | Shows if polling enabled for the exhibitor. |
quesAndAnsEnabled | Shows if Q&A setting is enabled for the exhibitor |
featured | Shows if the exhibitor a featured booth |
categoryPositionJson | Contains the exhibitors category position details. |
showBoothName | Returns if the Show Booth Name option is enabled. |
currency | Contains the currency used for the exhibitor. |
createSponsor | Returns if the setting is on to allow creating a sponsor from the exhibitor. |
gamification | Contains if the exhibitor booth is part of an expo challenge in Gamification. |
qnAPrivate | Shows if the Q&A is Private |
requireApprovalBeforeAttendeesCanJoin | Returns if the setting is on to require approval before an attendee can join the live stream. |
meetingEntryExitNotificationOn | Shows if the meeting exit and entry notification is on or off. |
Error Code
Here are the possible error messages, which return if any condition gets failed or required data is missing for processing.
Error Code | Error Description |
|---|---|
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 |
4040200 | No Event could be found |
4030201 | it is for the only host that can add a category and it is not then it will show this error Not Event Host |
4044002 | Event Challenge Not Found. |
4060923 | Exhibitor already exists |