v1
latestSwagger 2.02026-07-14453366.1 KBViewingController
Book an appointment for a viewing slot returned from the GET verb
post/v2/tier2/{shortName}/viewing/bookings
Path parameters
shortNamestring required
The unique client short-name
Query parameters
forenamestring required
The forename of the prospect
surnamestring required
The surname of the prospect
mobilePhonestring required
The mobile phone number of the prospect
emailAddressstring required
The email address of the prospect
propertyIDsToViewstring[] required
An array of unique IDs of properties to view
wantRoomInSharedPropertyboolean
Whether the prospect wants a shared property
alertMinRentnumber double
The minimum rent amount the prospect is looking for
alertMaxRentnumber double
The maximum rent amount the prospect is looking for
alertNumberOfBedsinteger
The minimum number of beds the prospect is looking for
alertAreaIDstring
The unique ID of the area the prospect is looking for
alertTenantType'Employed' | 'SelfEmployed' | 'Unemployed' | 'Student' | 'OwnMeans' | 'Retired' | 'Company' | 'Council'
The tenanct type the prospect is looking for
subscribeToEmailAlertsboolean
Whether to subscribe the prospect to email alerts
subscribeToSMSAlertsboolean
Whether to subscribe the prospect to SMS alerts
Request body
Response
OK
boolean required