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,
}

Booking Attendee

PropertyTypeRequiredDescription

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

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

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.

A menu item is an object with the following details.

PropertyTypeRequiredDescription

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

PropertyDescription

success

Whether or not the booking attendee was added/updated

id

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

Throws

CodeDescription

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

Last updated