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
  • What is changing?
  • How might you be affected?
  • What is changing in the iVvy API?
  • getBookingRoomReservationList
  • addOrUpdateBookingRoomReservation
  • updateBookingRoomReservationGuestContact
  • getContactList, getContact
  • addOrUpdateContact
  • What should you do?
  1. Announcements

Room Reservation Contact Changes

PreviousAnnouncementsNextContact Customfield Changes

Last updated 2 years ago

What is changing?

iVvy currently records guest details on room reservations as contacts. See .

These contact details are currently contacts in the crm database. iVvy is planning a change to the system in the future that will remove these contacts from the crm database, and replace them with a new database. The contact details, including the unique id of the contact, will remain unchanged during this transition.

iVvy is also planning future product changes that will make it possible to anonymise guest details within the system.

How might you be affected?

You might be affected by this change in the following ways if you use the iVvy API:

  • If you use the following contact APIs to manage guest details, these will stop working.

    • or to fetch guest details

    • to add/update guest details.

  • The contact messages published to subscribed https endpoints will no longer work for guests.

    • ContactAdded

    • ContactUpdated

    • ContactDeleted

  • If you update systems with the guest details, this could result in invalid data once the guest is anonymised in iVvy.

  • If you use the unique guest id to add new guests to reservations, the API request will fail if the guest has been anonymised in iVvy.

What is changing in the iVvy API?

getBookingRoomReservationList

  1. There is a possibility that isAnonymised can be true, in which case the personal guest contact details will be empty as per documentation.

  2. The contact property will be removed. This will apply to all properties that are of type Guest.

addOrUpdateBookingRoomReservation

  1. The contact property will be removed.

Anonymised guests cannot be added to a reservation. If you use the guest id to add a new guest to the reservation (any Guest type property) the request will fail and an error will be returned. The best way to avoid this error is to never use the guest id to add new guests to a reservation, but instead always pass the contact details. This also applies when adding a new reservation. Changes to an existing anonymised guest on a reservation will be ignored by iVvy and not produce an error.

If a guest has been anonymised in iVvy, and you pass the contact details of that guest then a new guest contact will be created with a new unique id.

Response Object

The contactId property of the guest objects (mainGuest, guest, additionalGuests) will be removed. Use guestContactId instead.

updateBookingRoomReservationGuestContact

Anonymised guests cannot be updated. An error response will be returned when attempting to update an anonymised guest contact.

getContactList, getContact

These api actions will no longer return guests. There is no alternative to fetch guest details besides using the reservation APIs.

addOrUpdateContact

What should you do?

  1. Stop using the contact APIs for guests. Instead, use the above room reservation APIs to manage guest details.

  2. Stop subscribing to contact messages for guest details. Instead, subscribe to messages about room reservations for guest details.

  3. Stop using the contact property of the Guest object. Instead, use the guestContact property.

  4. Decide how an anonymised guest impacts your system(s). isAnonymised is a readonly property. Once the guest is anonymised in iVvy, the original personal identifiable information cannot be retrieved.

  5. Stop using guest ids to add guests to a reservation (including when adding a new reservation). Instead, always pass the contact details.

  6. Check the permissions assigned to your api key in case you intend to use the new updateBookingRoomReservationGuestContact api.

  7. Stop using contactId property from addOrUpdateBookingRoomReservation api response, instead use guestContactId.

The following changes are being made to the Guest object described here:

The following changes are being made to the Guest object described here:

can no longer be used for guests.

getBookingRoomReservationList#guest
getContactList
getContact
addOrUpdateContact
getBookingRoomReservationList
getBookingRoomReservationList#guest
addOrUpdateBookingRoomReservation
addOrUpdateBookingRoomReservation#guest
getContactList
getContact
addOrUpdateContact