API Reference

Add Event Challenge Details

This API is used to create event challenge details for gamification.

This API can be accessed by event admins and super admins for creating new event challenges.

Users have to pass an authentication key to access this API.

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

Attribute

Description

area

Returns the area of the challenge. It will return an area like Expo, Sessions, Networking and Event.

action

Returns the action of the challenge.

  • If select Expo area to pass an action like Visit, Chat, Watch, Link Click, Document Download, Request Meeting or All.
  • If select Sessions area to pass an action like Watch, Visit or All.
  • If select Networking area to pass an action like Matches, Connections or All.

trigger

Returns the trigger of the challenge.

  • If select Expo area to pass this type of action like exhibitor and category or All.
  • If select Sessions area to pass this type of action like main_stage, breakout_session, workshop or All.
  • If select Networking area to pass this type of action like Networking or All.

eventChallengeId

Returns the event challenge ID.

name

Returns the challenge name. Only 255 characters are allowed.

startDate

Returns the challenge start date in yyyy/MM/dd HH:mm format.

endDate

Returns the challenge end date in yyyy/MM/dd HH:mm format.

goal

Returns the goal (in point format) of the challenge.

ticketTypeAllowInChallenge

Returns the ticket types allowed to participate in the challenge. It will return a list of ticket type IDs.

gamificationTabDisabled

Returns if the gamification tab is enabled or disabled in virtual event hub.

startDateUtc

Returns the start date UTC format.

endDateUtc

Returns the end date UTC format.

subArea

Returns the sub-area of challenges.

type

Returns the challenge type. It will return either STANDARD, EARLY_BIRD, SCAVENGER_HUNT.

filter

Returns the challenge of the filter.

maxPoints

Returns the maximum point configuration.

Here is 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.

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