API Reference

Property Access

Details required to access your property.

Overview

Many PlanOmatic services require our PlanOtechs to access your property. These access details should be passed in our property access object.

Property Access Example

property_access: {
	vacant: true,						// required
	method_of_access: "lockbox_code",			// required
	access_code: "XXXX",					// potentially required
	lockbox_location: "Behind A/C Unit",			// potentially required
	onsite_contact_name: "Jane Doe",			// required
	onsite_contact_phone: "+1 555-555-5555",		// required
	onsite_contact_email: "[email protected]",
 	preferred_date: "YYYY-MM-DD"
}

Methods of Access

Access Method

Description

Additional Requirements

lockbox_code

Property accessed via a lockbox.

  • accesscode,
    lockbox_location

keypad

Property accessed via keypad on the door.

access_code

rently

Property accessed via a Rently smart-lockbox.

no_access_needed

Services requested don't require access.
Service access requirements >

On-site Contact

Your on-site contact is the person that our PlanOtech will contact in the case the property access information is incorrect or not descriptive enough. It's important to make sure the person on the other end of this data is available to keep your appointment success rate high!

Occupied Properties

We are currently experimenting with servicing occupied homes. If you have an occupied home you will be expected to send the access method no_access_needed.

property_access: {
	vacant: false,								// required
	method_of_access: "no_access_needed",		// required
	onsite_contact_name: "Jane Doe",			// required
	onsite_contact_phone: "+1 555-555-5555"		// required
}