iVvy Developer API
  • API Documentation
  • Getting Started
    • Obtaining Keys
    • Creating the request
      • Method/URI Header
      • Request Headers
        • Standard Headers
        • Custom Headers
      • Signing the request
      • Query Parameters
    • Test Ping
    • Interpreting the response
      • Collections
      • Pagination
      • Filtering
      • Exceptions
      • Response Headers
      • Dates
    • Batch
      • Run
      • Progress
      • Result
      • Restart
      • Repost
    • Use Cases
      • CRM Systems
      • Financial Accounting Systems
      • Point Of Sale
      • Property Management Systems
  • Contacts & Companies
    • Get Contact List
    • Get Contact
    • Get Contact Note List
    • Add or Update Contact
    • Get Contact Custom Field Definition
    • Get Company Custom Field Definition
    • Get Subscription Group List
    • Add Contacts To Subscription Group
    • Remove Contacts From Subscription Group
    • Get Company List
    • Get Company
    • Get Company Note List
    • Add or Update Company
    • Add or Update Lead
    • Add or Update Contact Note
    • Add or Update Company Note
  • Event
    • Add or Update Event
    • Get Event List
    • Get Event
    • Get Registration
    • Get Registration List
    • Get Attendee
    • Get Attendee List
    • Get Invited Contact List
    • Invite Contacts
    • Get Sponsorship List
    • Get Speaker List
    • Get Session List
    • Create Login Token
  • Venue
    • Venue Setup Data
      • Get Venue
      • Get Venue List
      • Get Venue Room List
      • Get Venue Room Option List
      • Get Venue Rate Plan List
      • Get Venue Rate Plan Rate List
      • Get Venue Rate Plan Room Rate List
      • Get Resource List
      • Get Resource Availability
      • Get Menu List
      • Get Beverage Package List
      • Get Function Space List
      • Get Space Blockout List
      • Get Function Space Category List
      • Get Function Space Availability
      • Get Function Space Hire Plan Rate List
      • Get Function Space Hire Plan Rate
      • Get Cost Center List
      • Get Session Type List
      • Get Revenue Template List
      • Get Tax List
      • Add or Update Function Space
      • Get Event Type List
      • Add or Update Function Space Category
      • Add or Update Guest Room
      • Get Booking Custom Field List
      • Get Space Hire Plans
      • Get Venue Package List
      • Get Venue Package
    • Booking Data
      • Convert Lead To Opportunity
      • Add or Update Opportunity
      • Get Booking
      • Get Booking List
      • Get Booking List For Account
      • Get Booking Notes
      • Get Booking Session List
      • Get Booking Session Menu List
      • Get Booking Changelog List
      • Get Booking Attendee (By Hash)
      • Get Booking Attendee List
      • Get Booking Release Schedule
      • Add or Update Booking
      • Change Booking Status
      • Add Items To Booking
      • Add Payment To Booking
      • Add Refund To Booking
      • Add or Update Booking Attendee
      • Add or Update Booking Note
      • Add or Update Booking Session
      • Add or Update Booking Session Beverage
      • Add or Update Booking Session Menu
      • Add or Update Booking Session Resource
      • Remove Booking Session
      • Remove Booking Session Beverage
      • Remove Booking Session Menu
      • Remove Booking Session Resource
      • Get Space Blockout List
      • Add or Update Blockout Space
      • Remove Blockout Space
      • Get Booking Tax List
      • Add or Update Opportunity Note
      • Upload Booking Document
    • Booking Accommodation Data
      • Get Booking Accommodation List
      • Add or Update Booking Accommodation
      • Remove Booking Accommodation
      • Get Booking Room Reservation List
      • Add or Update Booking Room Reservation
      • Update Room Reservation Guest Contact
      • Remove Booking Room Reservation
      • Confirm Booking Room Reservation
      • Cancel Booking Room Reservation
      • Change Status of Booking Room Reservation
      • Add or Update Room Counts
      • Add or Update Room Dynamic Rates
      • Remove Room Dynamic Rates
      • Add or Update Rate Plan Booking Rules
  • Partner
    • Get Venue List
    • Get Venue
  • Invoice
    • Get Invoice List
    • Get Invoice
    • Get Options
    • Add Payment
    • Get Credit Note List
    • Get Credit Note
  • Account
    • Add or Update Cost Center
    • Get Cost Center List
    • Get Email Log List
    • Add Error Report
    • Get Account User List
  • CRM
    • Get Lead List
    • Get Opportunity List
    • Get Opportunity Note List
    • Get Task List
    • Get Activity List
    • Get Lead Stage List
    • Get Lead Type List
    • Get Lead Quality List
    • Get Lead Source List
    • Get Lead Channel List
    • Get Lead Note List
    • Add or Update Activity Purpose
    • Add or Update Activity
    • Add or Update Task
    • Add or Update Lead Quality
    • Add or Update Lead Stage
    • Add or Update Lead Channel
    • Add or Update Lead Type
    • Add or Update Lead Source
    • Add or Update Lead Note
  • Notifications
    • Company Endpoint
    • Contact Endpoint
    • CRM Endpoint
    • Invoice Endpoint
    • Booking Endpoint
    • Event Endpoint
  • Development Reference
    • Calculating md5
    • HMAC-SHA1
    • JSON Encoding
    • Timestamp Format
    • Date Format
    • Time Format
    • Address Format
    • URLEncoding
    • Timezone List
  • Announcements
    • Room Reservation Contact Changes
    • Contact Customfield Changes
    • Booking Accommodation API Changes
Powered by GitBook
On this page
  • Add or Update Booking Attendee
  • Booking Attendee
  • Add Or Update
  • Menu Item
  • Updating items
  • Example Request
  • Returns
  • Throws
  1. Venue
  2. Booking Data

Add or Update Booking Attendee

Add or Update Booking Attendee

POST [PlatformAddress]/api/1.0/venue?action=addOrUpdateBookingAttendee

Adds or updates the details of a venue booking attendee. NOTE: The venue must have access to add or update booking attendee in order to call this api action.

{
  "success": true,
  "id": 8821,
}
{
  "errorCode": 400,
  "message": "The request contains invalid data",
  "specificCode": 24413,
  "additionalMessages": [
      "firstName: *Value is required and can't be empty*"
  ]
}
{
  "errorCode": 500,
  "message": "An error has occurred",
  "specificCode": 24412,
  "additionalMessages": []
}

Booking Attendee

Property
Type
Required
Description

id

integer

optional

The unique id of the booking attendee to update.

hash

string

optional

The unique hash of the booking attendee to update.

venueId

integer

required

The id of the venue to which the booking attendee belongs

bookingId

integer

required

The id of the booking to which the new booking attendee will be assigned.

firstName

string

required

The first name of the booking attendee.

lastName

string

required

The last name of the booking attendee.

phone

string

required

The phone number of the booking attendee.

email

string

required

The email address of the booking attendee.

dietaryRequirement

string

optional

The dietary requirements of the booking attendee.

menuItems

array

optional

Add Or Update

When id or hash are not provided, it will create new booking attendee. Other wise it will update booking attendee based on hash/id. When id and hash both are present in the request, hash will be ignored.

Menu Item

A menu item is an object with the following details.

Property
Type
Required
Description

sessionId

integer

required

The id of the session to which the booking menu belongs

menuId

integer

required

The id of the attendee to which the booking attendee belongs

inventoryId

integer

required

The id of the attendee to which the booking attendee belongs

Updating items

While updating you can skip the menuItems parameter, this will not change any of the menu items. Passing menuItems will replace the menu items with the given items.

Example Request

{
    "venueId": 1,
    "bookingId": 4407,
    "firstName": "First Name",
    "lastName": "Last Name",
    "phone": "123456",
    "dietaryRequirement": "Something required for my diet",
    "email" : "test@email.com",
    "menuItems": [
    {
        "sessionId": "2447",
        "menuId": 225,
        "inventoryId": 14
    },
    {
        "sessionId": "2447",
        "menuId": 225,
        "inventoryId": 15
    },
    {
        "sessionId": "2448",
        "menuId": 226,
        "inventoryId": 16
    }
  ]
}

Returns

Property
Description

success

Whether or not the booking attendee was added/updated

id

The unique id of the booking attendee that was added/updated

Throws

Code
Description

Specific Code: 24410

The booking does not exist

Specific Code: 24411

The booking attendee does not exist

Specific Code: 24412

An error has occurred

Specific Code: 24413

The request contains invalid data

Specific Code: 24414

The request contains invalid data

PreviousAdd Refund To BookingNextAdd or Update Booking Note

Last updated 8 months ago

The list of menu items that is included in the booking attendee menu. See section for details of each item

Menu Item