API Documentation - Prospects

Table of Contents


Prospect data must be nested under the client key in the json body.

PUT /api/v2/clients/<client_id>

Edit a limited number of fields on a specified company prospect.

Accepted PUT Parameters

Example request body for status change:

    "status": "toured"

Example request body for status change to applicant:

    "status": "applicant"
    "application": {
    	"unit_id": 123,
	"lease_start_date": "2020-06-01",
	"lease_end_date": "2020-05-31",
	"application_submitted_date": "2020-05-20",
	"application_price": "1200.00"

POST /api/v2/clients

Create a prospect record in Nestio. Note that in order for Nestio to properly ingest prospects and associate them with teams and properties, the following fields are required: first_name, last_name, email, group.

Accepted POST Parameters

NOTE: You should only pass one of three community/building/unit, otherwise you will get a validation error.

Example request body:

	"client": {
                "people": [{
                		"first_name": "John",
                		"last_name": "Doe",
                		"email": "johndoe@example.com",
                		"phone_1": "5101234567",
                		"phone_2": "",
                		"is_primary": true
                		"first_name": "Jane",
                		"last_name": "Doe",
                		"email": "janedoe@example.com",
                		"phone_1": "",
                		"phone_2": "",
                		"is_primary": false
                "move_in_date": "1970-01-01",
                "layout": ["studio", "1br"],
                "price_floor": 1500,
                "price_ceiling": 2500,
                "notes": "looking for affordable neighborhood with bars and restaurants",
                "group": 12,
                "broker_company": "Jerry Company",
                "broker_email": "jerry@seinfeld.com",
                "broker_first_name": "Jerry",
                "broker_last_name": "Seinfeld",
                "broker_phone": "4101230987",
                "client_referral": "Company Website",
                "campaign_info": "3384123",
                "unit": 5309,
                "device": "phone",
                "source_type": "organic"