Home → API Documentation → Booking Process → api/BookingUpdate

6.3. api/BookingUpdate

This API call is used to update information about the booking.

The API call allows you to submit different update types depending on what information you are updating about the booking. The different update types are SpecialRequests, Attendee, NamedGuest and Remove.

The API call requires you to pass the uid of the user logged in, the bid of the booking to be updated, the updatetype and the updatevalue.

Update Types

•    SpecialRequests – The value supplied can be a simple string.

•    Attendee – Used in conjunction with api/BookingAttendeesToBook where you would supply the “conid” (uid) of the user you intend to assign as the attendee for the booking.

•    NamedGuest – If the user does not appear as an option in api/BookingAttendeesToBook and the client does not want to allow TBC bookings, you can set a named guest. You would supply a stringified array of GuestOrg, GuestName and GuestEmail.

•    Remove – If you wish to delete the booking.

Data Types for Update Values

Update Type	Update Value Data Type
SpecialRequests	String – Max 250 chars
Attendee	Boolean
NamedGuest	String
Remove	Boolean

 

Parameters To Submit

All parameters are required and cannot be empty.

Parameter	Parameter Help	Parameter Data Type
uid	Logged in user’s uid.	String – Max 50 chars
bid	The booking bid to be updated.	String – Max 50 chars
UpdateType	Update type with available options above.	String – Max 20 chars
UpdateValues	Value to be submitted as part of the call.	String

 

Return Response

The API call ResponseMessage will return a Boolean indicating whether the update was successful.