Below is our standard data structure for a vacancy:
community_name
string
default:"none"
The name of the community for the vacancy you want to create.
external_ref
string
default:"none"
The external reference of the community for the vacancy you want create.
active_date
string
default:"none"
The active date for the vacancy you want to create.
building_name
string
default:"none"
The name of the building for the vacancy you want to create.
address_line_1
string
default:"none"
The first line of the address for the vacancy you want to create.
address_line_2
string
default:"none"
The second line of the address for the vacancy you want to create.
city
string
default:"none"
The city of the address for the vacancy you want to create.
state
string
default:"none"
The state of the address for the vacancy you want to create.
country
string
default:"none"
The country of the address for the vacancy you want to create.
postal_code
string
default:"none"
The postal code of the address for the vacancy you want to create.
longitude
string
default:"none"
The longitude of the address for the vacancy you want to create.
latitude
string
default:"none"
The latitude of the address for the vacancy you want to create.
amenities
string
default:"none"
The list of amenities available in the vacancy’s building.
bathrooms
string
default:"none"
The number of bathrooms for the property you want to create.
bedrooms
string
default:"none"
The number of bedrooms for the vacancy you want to create.
description
string
default:"none"
Free text description of the vacancy.
features
string
default:"none"
Text description of any features of the unit.
finish
string
default:"none"
Apartment finish name.
floorplan_url
string
default:"none"
The URL for the floorplan of the vacancy you want to create.
image_urls
string
default:"none"
URLs for any images associated with the vacancy you want to create.
is_flex
string
default:"none"
Whether the vacancy is for a flex apartment or not.
is_furnished
string
default:"none"
Whether the vacancy is for a furnished apartment or not.
is_furnished
string
default:"none"
Whether the vacancy is for a furnished apartment or not.
lease_terms
object
A list of the terms for the vacancy to be created.
move_in_date
date
The move in date for the vacancy to be created.
sqft
float
The square feet surface for the vacancy to be created.
tour_url
string
The url for online/video tours of the vacancy to be created.
unit_number
string
The unit number for the vacancy to be created.
unit_type
string
The type of the unit associated with the vacancy to be created.Will be either apartment or studio_apartment.
vacancy_url
string
The url of the vacancy to be created.