• Articles
  • Api Documentation
Show / Hide Table of Contents
  • Setting up the API Client
  • Using the API Client
    • Getting started
  • Customers
    • Adding a customer
  • Branch Users
    • Managing branch users
  • List data
    • Getting list data
  • Properties
    • Referring a property
    • Searching for properties
    • Getting property details
  • Property Images
    • Listing property images
    • Adding property images
    • Removing property images
  • Property Notes
    • Listing property notes
  • Viewings
    • Listing property viewings
    • Creating a viewing
    • Rescheduling a viewing
    • Cancelling a viewing
    • Adding viewing feedback

Cancelling a viewing

In order to cancel a viewing, you need to call the Viewings.CancelViewingAsync method on the API client:

var response = await apiClient.Viewings.CancelViewingAsync(new CancelViewingRequest
{
    Id = 123456,
    Reason = "A reason for cancelling the viewing"
});

The response variable will contain a CancelViewingResponse object, which will indicate whether the viewing was cancelled successfully or not. If it was, there will be a ViewingDetails object in the Viewing property, which will contain the information about the viewing that was cancelled.

Validation

Name Type Required Max Length Other Rules
Id int Yes - Must be greater than 0 and must a valid viewing id for the agent
Reason string Yes -
In This Article
Back to top Generated by DocFX