HomeAPI DocumentationBooking Processapi/BookingGuest

6.4. api/BookingGuest

This API call is the secondary call for creating bookings in the CRM. It is designed for creating quick bookings in the CRM without the need for a user to log in.

The CRM takes the Email Address and First Name provided to try to find a match to an existing contact in the CRM. If no match is found, a new Primary Record is created, marked as a Guest with the contact created within it.

You must provide the GuestFirstName, GuestLastName, GuestEmail and the GuestCompany of the user making the booking, the eid of the event being booked, and the number of bookings being made (GuestNumberBookings). The GuestNumberBookings must be greater than 0.

Before calling this method, api/CalendarDetail should be checked for if BookOnline is true and if GuestBookingPriceSet is true for the event, and the number of remaining places is greater than or equal to the number of intended bookings being made.

 


 

Parameters To Submit

The parameters below highlighted with “*” must be submitted and not be blank values.

Parameter Parameter Help Parameter Data Type
GuestFirstName* Contact’s first name. String – Max 100 chars
GuestLastName* Contact’s last name. String – Max 100 chars
GuestEmail* Contact’s email address. String – Max 200 chars
GuestJobTitle Contact’s job title. String – Max 200 chars
GuestCompany* Company name. String – Max 250 chars
GuestTel Contact’s telephone number. Integer – Max 20 chars
GuestNumberBookings* The number of places to be booked. Integer – Must be greater than 0
eid*  The event eid being booked onto. String – Max 50 chars
API Key    

 


 

Return Response

The API call ResponseMessage will return a JSON stringified array containing arrays of the bookings created, provided the number of places submitted. The following fields of data will be returned in the arrays.

Field Field Help
EmailTo Who should receive notification of the booking attempt. (CRM auto sends a copy)
GuestEmailSubject The email subject of the create an account for next time. (CRM auto sends a copy)
GuestEmailBody The email body of the create an account for next time. (CRM auto sends a copy)
uid The contact’s uid that has the provided email address associated with their contact record.
sid The session guid.
EmailAddress The contact’s email address.
FirstName The contact’s first name that has the provided email address associated with their contact record.
LastName The contact’s last name that has the provided email address associated with their contact record.
KnownAs What the contact is known by provided the email address associated with their contact record.
WebAdmin Whether the contact is a website administrator.
LoginVerified True/False value indicating if the email address has been verified.
AllowLogin Can be custom-configured as required.

 

This should be used in conjunction with api/BookingUpdate, using the Update Type: NamedGuest, for any guest booking made for more than one person.

For guest bookings with multiple places reserved, only the primary attendee should have a contact record created. Additional attendees must not have separate contact records and should instead be processed as “guest” bookings via the api/BookingUpdate NamedGuest method.

You still need to process api/UserBasket and api/UserPayment to process the bookings fully.

This page was: Helpful | Not Helpful