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