Create/Update Session

API Documentation (v5)

Method	Endpoint	Description
`POST`	/v5/oauth/token	Generate an OAuth access token
`GET`	/v5/forms/attendeeFields	Retrieve attendee form fields
`POST`	/v5/users/attendees	Create or update an attendee
`GET`	/v5/users/attendees	Retrieve all attendees
`POST`	/v5/users/attendees/{attendeeId}/resume	Upload an attendee's resume
`DELETE`	/v5/users/attendees/{attendeeId}/delete	Remove an attendee
`POST`	/v5/sessions/sessionTracks	Create or update a session track
`GET`	/v5/sessions/sessionTracks	Retrieve all session tracks
`DELETE`	/v5/sessions/sessionTracks/{id}	Delete a session track
`POST`	/v5/sessions	Create or update a session
`GET`	/v5/sessions	Retrieve all sessions
`DELETE`	/v5/sessions/{id}	Delete a session
`POST`	/v5/sessions/sessionHandouts	Upload or update a session handout
`GET`	/v5/sessions/sessionHandouts	Retrieve all session handouts
`DELETE`	/v5/sessions/sessionHandouts/{id}	Remove a session handout
`GET`	/v5/forms/speakerFields	Retrieve speaker form fields
`POST`	/v5/users/speakers	Create or update a speaker profile
`GET`	/v5/users/speakers	Retrieve all speakers
`DELETE`	/v5/users/speakers	Remove a speaker profile
`GET`	/v5/event/languages	Retrieve available event languages
`GET`	/v5/event/getEventDetails	Get detailed event information
`GET`	/v5/reports/qrScanAnalytics	Retrieve QR scan analytics
`GET`	/v5/reports/userJourneyAnalytics	Retrieve user journey analytics
`POST`	/v5/booths	Create or update a booth
`GET`	/v5/booths	Retrieve all booths
`DELETE`	/v5/booths	Remove a booth and optionally its representatives
`GET`	/v5/forms/boothRepFields	Retrieve booth representative form fields
`POST`	/v5/users/boothReps	Create or update a booth representative
`GET`	/v5/users/boothReps	Retrieve all booth representatives
`DELETE`	/v5/users/boothReps/{boothRepId}	Remove a booth representative
`POST`	/v5/floors	Create or update a floor
`GET`	/v5/floors	Retrieve all floors
`DELETE`	/v5/floors/{floorId}	Remove a floor and all its associated booths
`POST`	/v5/booths/documents	Create or update a booth document
`GET`	/v5/booths/documents	Retrieve all booth documents
`DELETE`	/v5/booths/documents/{documentId}	Remove a booth document
`POST`	/v5/booths/videos	Create or update a booth video
`GET`	/v5/booths/videos	Retrieve all booth videos
`DELETE`	/v5/booths/videos/{videoId}	Remove a booth video

Download OpenAPI description

Download Postman

Download OpenApi

Overview

Integrations

integrations@vfairs.com

Servers

https://api.vfairs.com/rest/

https://api.vfairs.ca/rest/

https://api-eu.vfairs.com/rest/

https://api-uk.vfairs.com/rest/

KSA

https://api-ksa.vfairs.com/rest/

OAuth Access Token

Endpoints for obtaining and managing OAuth access tokens for API authentication.

Operations

Attendees

Manages attendee data for events, including registration, profile updates, resume uploads, and form field configuration. These endpoints enable comprehensive attendee lifecycle management from registration through event participation.

Operations

Session Tracks

Manages session tracks for multi-language events. Session tracks organize sessions by categories, dates, or themes and support localization through language-specific configurations.

Operations

Sessions

Manages event sessions including creation, updates, retrieval, and deletion. Sessions can be linked to tracks and speakers, support multi-language configurations, and offer various session types for different event formats.

Operations

Create/Update Session

Request

Creates a new session or updates an existing one. For multi-language events, create separate sessions for each language using different language_id values.

Security

default

Bodyapplication/jsonrequired

session_idinteger

Unique identifier of the session. Use 0 or null for creating new sessions, or provide existing session_id for updates.

Example: 0

titlestringrequired

Title of the session displayed to attendees.

Example: "How Amadeus Uses a Global Event Mesh to Make Travel Work Better"

mode_of_attendancestringrequired

Attendance mode determining how participants can join the session.

Enum"VIRTUAL""ON_SITE""HYBRID"

Example: "HYBRID"

speaker_idsArray of stringsrequired

Array of speaker identifiers to associate with this session. Obtain valid speaker IDs from the Get Session Speakers endpoint.

Example: [642234153]

is_activestringrequired

Session status. Use "1" to activate/publish the session, "0" to deactivate/unpublish.

Example: "1"

descriptionstringrequired

Detailed description of the session content and objectives.

Example: "Seven years ago, Amadeus embarked on the transformative journey of embracing."

session_typestringrequired

Type of session determining the delivery format and platform requirements.

Enum"PREC""ONDEMAND""ZOOM""Poster""CUSTOM_EMBED""IN_PERSON_WEBINAR""Message_Title"

Example: "ZOOM"

start_timestringrequired

Scheduled start time of the session. Format: YYYY-MM-DD HH:mm:ss.

Example: "2024-12-11 00:00:00"

durationstring

Total duration of the session. Format: HH:mm:ss.

Example: "00:00:00"

tracking_durationstring

Duration used for attendance tracking purposes. Should match duration value. Format: HH:mm:ss.

Example: "00:00:00"

track_idinteger

Unique identifier of the session track. Must correspond to an existing track. Obtain valid track IDs from the Get Session Track endpoint.

Example: 30408

language_idintegerrequired

Unique identifier of the session language. Must correspond to an existing language. Obtain valid language IDs from the Get Languages endpoint.

Example: 1

show_in_agendainteger

Controls session visibility in the event agenda. Use 1 to show, 0 to hide.

Example: 0

enable_qainteger

Enables Q&A functionality for the session. Use 1 to enable, 0 to disable.

Example: 0

urlstring

External URL for the session content (e.g., YouTube, Vimeo, Zoom link).

Example: "https://www.youtube.com/watch?v=nP731V0bdmM"

url_ali_babastring

Alternative URL for the session content, typically used for regional access or backup streaming.

Example: "https://example.com/session-backup"

early_join_buffer_in_secondsinteger

Buffer time in seconds allowing attendees to join before the scheduled start time. Maximum value: 30000 seconds.

Example: 120

customer_webinar_idstring

External webinar identifier from third-party systems for integration purposes.

Example: "12312"

survey_idinteger

Unique identifier of the survey to associate with this session. Must correspond to an existing survey for collecting attendee feedback.

Example: 123123

keywordsstring

Keywords or tags associated with the session for search and categorization purposes.

Example: "technology, innovation, digital transformation"

location_namestring

Physical location name for hybrid or in-person sessions.

Example: "Conference Room A"

location_urlstring

URL providing additional location information or directions.

Example: "https://example.com/venue-map"

poster_thumbnailstring

URL of the poster or thumbnail image representing the session.

Example: "https://example.com/session-poster.jpg"

curl -i -X POST \
  https://api.vfairs.com/rest/v5/sessions \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "session_id": 0,
    "title": "How Amadeus Uses a Global Event Mesh to Make Travel Work Better",
    "mode_of_attendance": "HYBRID",
    "speaker_ids": [
      642234153
    ],
    "is_active": "1",
    "description": "Seven years ago, Amadeus embarked on the transformative journey of embracing.",
    "session_type": "ZOOM",
    "start_time": "2024-12-11 00:00:00",
    "duration": "00:00:00",
    "tracking_duration": "00:00:00",
    "track_id": 30408,
    "language_id": 1,
    "show_in_agenda": 0,
    "enable_qa": 0,
    "url": "https://www.youtube.com/watch?v=nP731V0bdmM",
    "url_ali_baba": "https://example.com/session-backup",
    "early_join_buffer_in_seconds": 120,
    "customer_webinar_id": "12312",
    "survey_id": 123123,
    "keywords": "technology, innovation, digital transformation",
    "location_name": "Conference Room A",
    "location_url": "https://example.com/venue-map",
    "poster_thumbnail": "https://example.com/session-poster.jpg"
  }'

Responses

Bodyapplication/json

statusboolean

Example: true

messagestring

Example: "Session(s) created successfully."

session_idinteger

Example: 192073

Response

application/json

{
  "status": true,
  "message": "Session(s) created successfully.",
  "session_id": 192073
}

Get Sessions

Request

Retrieves a paginated list of event sessions with optional filtering capabilities. Use session_id parameter to fetch details for a specific session.

Security

default

Query

pageinteger

Page number for pagination.

Example: page=1

limitinteger

Number of records to return per page.

Example: limit=50

session_idinteger

Unique identifier of the session to filter by. Use this to retrieve a specific session.

Example: session_id=2171860

session_typestring

Type of session to filter by. Determines the session format and delivery method.

Enum"PREC""ONDEMAND""ZOOM""Poster""CUSTOM_EMBED""IN_PERSON_WEBINAR""Message_Title"

Example: session_type=ZOOM

statusstring

Session status filter. Use "active" for published sessions, "inactive" for unpublished, or "ALL" for both.

Enum"active""inactive""ALL"

Example: status=active

mode_of_attendancestring

Attendance mode filter. Determines how attendees can participate in the session.

Enum"VIRTUAL""ON_SITE""HYBRID""ALL"

Example: mode_of_attendance=ALL

start_datestring

Start date for filtering sessions by creation date. Must be used with end_date. Format: YYYY-MM-DD.

Example: start_date=2024-01-01

end_datestring

End date for filtering sessions by creation date. Must be used with start_date. Format: YYYY-MM-DD.

Example: end_date=2024-01-10

curl -i -X GET \
  'https://api.vfairs.com/rest/v5/sessions?end_date=2024-01-10&limit=50&mode_of_attendance=ALL&page=1&session_id=2171860&session_type=ZOOM&start_date=2024-01-01&status=active' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

Bodyapplication/json

statusboolean

Example: true

messagestring

Example: "Successful retrieval of sessions."

sessionsArray of objects

Example: [{"session_id":580384,"app_id":8995,"sequence":1,"is_active":0,"show_in_agenda":1,"enable_qa":1,"title":"Incident Command System for Industrial Control Systems Workshop","description":"xyz","session_type":"ZOOM","track_id":25702,"start_time":"2024-06-17 08:30:00","tracking_duration":null,"end_time":"08:00:00","language_id":1,"url":"","url_ali_baba":"","early_join_buffer_in_seconds":null,"customer_webinar_id":"","survey_id":null,"mode_of_attendance":"ON_SITE","keywords":"","location_name":"Savoy Place | Flowers Room","location_url":"","poster_thumbnail":"","handouts":[{"handout_id":16181,"handout_title":"Security by Design - A Communication Problem?","handout_link":"https://vfairs-core-backend-prod.s3.amazonaws.com/8995/sessions/P5Drei3VP0EVTFvz3PT01JAk84IL79I2cIWjJGXk.pdf"}],"speakers":[]}]

metaobject

Example: {"current_page":1,"from":1,"last_page":39,"path":"http://api.vfairs.com/rest/v5/sessions","per_page":1,"to":1,"total":39}

Response

application/json

{
  "status": true,
  "message": "Successful retrieval of sessions.",
  "sessions": [
    { … }
  ],
  "meta": {
    "current_page": 1,
    "from": 1,
    "last_page": 39,
    "path": "http://api.vfairs.com/rest/v5/sessions",
    "per_page": 1,
    "to": 1,
    "total": 39
  }
}

Delete Session

Request

Permanently removes a session from the event.

Security

default

Path

idstringrequired

The ID of the session.

Example: non

sessionIdintegerrequired

Unique identifier of the session to be deleted.

Example: 2222386

curl -i -X DELETE \
  https://api.vfairs.com/rest/v5/sessions/non \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

Bodyapplication/json

statusboolean

Example: true

messagestring

Example: "Session deleted successfully."

session_idinteger

Example: 2222386

Response

application/json

{
  "status": true,
  "message": "Session deleted successfully.",
  "session_id": 2222386
}

Session Handouts

Endpoints for managing session handouts - documents associated with sessions that attendees can view or download.

Operations

Speakers

Endpoints for managing speaker profiles and their session associations. Speakers can be created, updated, retrieved, and deleted, with support for dynamic form configurations and session linking.

Operations

Booths

Manages virtual exhibition booths where exhibitors showcase products, services, and company information. Booths are organized within floors and can include representatives, videos, documents, and interactive features with customizable layouts and access permissions.

Operations

Booth Documents

Manage booth documents including PDFs, Word documents, Excel spreadsheets, and PowerPoint presentations. Exhibitors can share these documents with booth visitors, and documents can be automatically added to visitor briefcases.

Operations

Booth Videos

Manages booth videos for events. Videos can showcase products, provide demonstrations, or share company information. Supported formats include MP4, MOV, WMV, AVI, and FLV.

Operations

Floors

Manages virtual floors within events. Floors organize booths in a virtual event space and can be customized with different layouts and themes.

Operations

Event

This section provides endpoints to retrieve event metadata, including available languages for multi-language configuration and detailed event information. These endpoints are essential for localizing content such as sessions and tracks and integrating event-specific settings to ensure a seamless and customized event experience.

Operations

Reports

Endpoints for retrieving event analytics and reporting data including QR scan analytics and user journey reports.

Operations

API Documentation (v5)

OAuth Access Token

Attendees

Session Tracks

Sessions

Create/Update Session

Request

Responses

Was this helpful?

Get Sessions

Request

Responses

Was this helpful?

Delete Session

Request

Responses

Was this helpful?

Session Handouts

Speakers

Booths

Booth Documents

Booth Videos

Floors

Event

Reports