Appointments

Updates an existing viewing

Updates a viewing with any of the following fields supported for update:

  • /startDate ie. The start date and time in ISO 8601 format to update against the requested viewing
  • /endDate ie. The end date and time in ISO 8601 format to update against the requested viewing
  • /negotiatorId ie. The unique identifier of the negotiator to be associated with the requested viewing
  • /status ie. When cancelling, the status the requested viewing should be set to
  • /notes ie. The notes to be associated with the requested viewing
  • /internalNotes ie. The internal notes to be associated with the requested viewing
  • /applicantFeedback ie. The applicant feedback to be associated with the requested viewing

Required scope: alto/write:appointments_viewings

patch/appointments/viewings/{appointmentId}

Request

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

Path parameters

appointmentIdinteger required

The appointment's unique identifier

Headers

AgencyRefstring required

Request body

op'replace'
valuestring
path'/status' | '/startDate' | '/endDate' | '/negotiatorId' | '/notes' | '/applicantFeedback' | '/internalNotes'

Response

Returns an object with a flag indicating a successful update

Changes

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