Appointments

Create a viewing appointment.

Creates a viewing appointment with the requested applicant and property in a negotiator's calender. Required scope: alto/write:appointments_viewings

post/appointments/viewings

Request

Base URL: https://api.alto.zoopladev.co.uk
URL: https://api.alto.zoopladev.co.uk/appointments/viewings
Auth: appAuth (a scheme the document does not define)

Headers

AgencyRefstring required

Request body

negotiatorIdinteger required

Required: The unique identifer of the negotiator

branchIdinteger nullable

Optional: The branch in which to record the viewing diary event. When omitted, defaults to the negotiator's default branch.

applicantIdsinteger[] required

Required: The unique identifer of the applicant(s)

propertyIdinteger required

Required: The unique identifer of the property

startDatestring date-time required

Required: The start date and time in ISO 8601 format of the viewing appointment to be created. Interpreted as UK local diary time: a value with a UTC marker (a trailing Z) or an explicit offset is converted to UK local time (Europe/London); a plain local value with no offset is taken as-is.

endDatestring date-time required

Required: The end date and time in ISO 8601 format of the viewing appointment to be created. Interpreted as UK local diary time: a value with a UTC marker (a trailing Z) or an explicit offset is converted to UK local time (Europe/London); a plain local value with no offset is taken as-is.

notesstring nullable

Optional: Additional notes to accompany the viewing appointment being created.

isConfirmedboolean

Optional: Marks viewing as confirmed; this will NOT send out confirmation emails and texts Default if not set: false

meetingPlaceType'Unspecified' | 'AtTheOffice' | 'AtTheProperty'

Optional: Sets where the negotiator will meet for the viewing; Default if not set: AtTheProperty

Example request

{
  "negotiatorId": 123456,
  "branchId": 12345,
  "applicantIds": [
    7891011,
    7891025
  ],
  "propertyId": 121314,
  "startDate": "2023-01-01T10:15:00.0000000+00:00",
  "endDate": "2023-01-01T10:30:00.0000000+00:00",
  "notes": "Here are some optional notes",
  "isConfirmed": true,
  "meetingPlaceType": "Unspecified"
}

Response

Returns an object containing the newly created viewing appointment's unique identifier

appointmentIdinteger

The unique identifier of the viewing appointment that has been created

Example response

{
  "appointmentId": 123456
}

Changes

No recorded changes to this operation across all 1 revision of this API.