Create/Update User Segment Rule

API Documentation

Method	Endpoint	Description
`POST`	/v5/oauth/token	Generate an OAuth access token
`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/users/speakers	Create or update a speaker profile
`GET`	/v5/users/speakers	Retrieve all speakers
`DELETE`	/v5/users/speakers	Remove a speaker profile
`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/users/segments	Create or update a segment
`GET`	/v5/users/segments	Retrieve all segments
`DELETE`	/v5/users/segments/{segmentId}	Remove a segment
`POST`	/v5/users/segments/rules	Create or update a segment rule
`GET`	/v5/users/segments/rules	Retrieve all segment rules
`DELETE`	/v5/users/segments/rules/{ruleId}	Remove a segment rule
`GET`	/v5/forms/attendeeFields	Retrieve attendee form fields
`GET`	/v5/forms/speakerFields	Retrieve speaker form fields
`GET`	/v5/forms/boothRepFields	Retrieve booth representative form fields
`POST`	/v5/sessions	Create or update a session
`GET`	/v5/sessions	Retrieve all sessions
`DELETE`	/v5/sessions/{id}	Delete a session
`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/sessionHandouts	Upload or update a session handout
`GET`	/v5/sessions/sessionHandouts	Retrieve all session handouts
`DELETE`	/v5/sessions/sessionHandouts/{id}	Remove a session handout
`POST`	/v5/booths	Create or update a booth
`GET`	/v5/booths	Retrieve all booths
`DELETE`	/v5/booths	Remove a booth and optionally its representatives
`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
`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
`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

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

User Segments

Manages user segments for the current event. User segments are used to target specific groups of users for marketing and communication purposes.

Operations

User Segment Rules

Manages user segment rules for the current event. User segment rules define criteria-based targeting for specific groups of users.

Operations

Create/Update User Segment Rule

Request

Creates a new user segment rule or updates an existing rule based on whether id is provided.

Security

BearerToken

Bodyapplication/jsonrequired

segment_rule_idinteger or null

Unique identifier of an existing user segment rule to update. Leave empty when creating a new rule.

Example: 123

titlestringrequired

Name of the user segment rule. Must be unique and descriptive. Must not be greater than 255 characters.

Example: "VIP Content Access Rule"

segment_idintegerrequired

Unique identifier of the user segment this rule applies to. Must correspond to an existing user segment in the current event.

Example: 456

target_entitiesArray of stringsrequired

Individual entity type to target. Must be a valid entity type supported by the system. Entity type should be one of the following values: sessions, booths, session_tracks.

Items Enum"sessions""booths""session_tracks"

Example: ["sessions"]

entitiesArray of objectsrequired

Array of entity configurations that define what content or features are affected by this rule.

Example: null

entities[].typestringrequired

Type of entity being configured. Must match one of the target entity types. Entity type should be one of the following values: sessions, booths, session_tracks.

Enum"sessions""booths""session_tracks"

Example: "sessions"

entities[].idsArray of integers

Individual entity ID. Must correspond to an existing entity of the specified type in the current event.

Example: [1]

entities[].hide_selectedbooleanrequired

Whether to hide the selected entities from users in this segment. True hides the entities, false shows them exclusively.

Example: false

curl -i -X POST \
  https://api.vfairs.com/rest/v5/users/segments/rules \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "segment_rule_id": 123,
    "title": "VIP Content Access Rule",
    "segment_id": 456,
    "target_entities": [
      "sessions"
    ],
    "entities": null
  }'

Responses

Success

Bodyapplication/json

statusboolean

Example: true

messagestring

Example: "User Segment Rule created successfully."

rule_idinteger

Example: 123

Response

application/json

{
  "status": true,
  "message": "User Segment Rule created successfully.",
  "rule_id": 123
}

Get User Segment Rules

Request

Retrieves a paginated list of user segment rules for the current event.

Security

BearerToken

Query

pageinteger

Page number for pagination. Defaults to 1 if not provided.

Example: page=1

limitinteger

Number of items per page. Maximum 100, defaults to 15.

Example: limit=15

titlestring

Search term to filter user segment rules by title.

Example: title=VIP attendees

audiencestring

Filter user segment rules by audience type. Valid values: attendee, exhibitor, speaker.

Example: audience=attendee

curl -i -X GET \
  'https://api.vfairs.com/rest/v5/users/segments/rules?audience=attendee&limit=15&page=1&title=VIP%20attendees' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

Bodyapplication/json

statusboolean

Example: true

messagestring

Example: "User Segment Rule(s) fetched successfully."

segment_rulesArray of objects

Example: [{"segment_rule_id":2913,"app_id":15032,"title":"Segment A","target_entities":["sessions","booths","session_tracks"],"segment":{"segment_id":6617,"title":"User Segment"},"sessions":[{"session_id":2639134,"title":"High-speed in-vivo 3D microscopy across scales","type":"BREAKOUT_WEBINAR","visibility":"visible"}],"booths":[{"booth_id":292638,"title":"Booth B","visibility":"visible"}],"session_tracks":[{"session_track_id":40003,"title":"Some","visibility":"visible"}]}]

metaobject

Example: {"current_page":1,"from":1,"last_page":5,"path":"https://api.vfairs.com/rest/v5/users/segments/rules","per_page":1,"to":1,"total":5}

Response

application/json

{
  "status": true,
  "message": "User Segment Rule(s) fetched successfully.",
  "segment_rules": [
    { … }
  ],
  "meta": {
    "current_page": 1,
    "from": 1,
    "last_page": 5,
    "path": "https://api.vfairs.com/rest/v5/users/segments/rules",
    "per_page": 1,
    "to": 1,
    "total": 5
  }
}

Delete User Segment Rule

Request

Permanently removes a user segment rule and all associated data.

Security

BearerToken

Path

ruleIdintegerrequired

Unique identifier of the user segment rule to delete. Must correspond to an existing rule.

Example: 123

curl -i -X DELETE \
  https://api.vfairs.com/rest/v5/users/segments/rules/123 \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

Success

Bodyapplication/json

statusboolean

Example: true

messagestring

Example: "User Segment Rule deleted successfully."

rule_idinteger

Example: 123

Response

application/json

{
  "status": true,
  "message": "User Segment Rule deleted successfully.",
  "rule_id": 123
}

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

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 Representatives

Manages booth representatives who interact with visitors in virtual exhibition booths. Representatives can be assigned to multiple booths and have specific roles and 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

OAuth Access Token

Attendees

User Segments

User Segment Rules

Create/Update User Segment Rule

Request

Responses

Was this helpful?

Get User Segment Rules

Request

Responses

Was this helpful?

Delete User Segment Rule

Request

Responses

Was this helpful?

Session Tracks

Sessions

Session Handouts

Speakers

Booths

Booth Representatives

Booth Documents

Booth Videos

Floors

Event

Reports

API Documentation

OAuth Access Token

Attendees

User Segments

User Segment Rules

Create/Update User Segment Rule

RequestExpand all

Responses

Was this helpful?

Get User Segment Rules

Request

Responses

Was this helpful?

Delete User Segment Rule

Request

Responses

Was this helpful?

Session Tracks

Sessions

Session Handouts

Speakers

Booths

Booth Representatives

Booth Documents

Booth Videos

Floors

Event

Reports

Request