{
  "job_id": "string",
  "data": {}
}

​
Path Parameters

idrequired
string

The ID of the resource.

idrequired
string

The ID of the resource.

​
Body

idrequired
string
number
string

The unit number

bedrooms
string

The number of bedrooms

bathrooms
string

The number of bathrooms

square_feet
integer

The square footage of the unit

building_number
string

The building number

building_name
string

The building name

floor_plan_code
string

The floor plan code

floor_plan_name
string

The floor plan name

floor
string

Floor number/name

street_address_1
string

The street address line 1

street_address_2
string

The street address line 2

city
string

The city

state
string

The state

zip
string

The zip code

is_available
boolean

Whether the unit is available

is_furnished
boolean

Whether the unit is furnished

is_vacant
boolean

Whether the unit is vacant

custom_data
object

Custom data

​
Response

job_idrequired
string

The ID of the job created to handle this operation

datarequired
object

Returned data from the operation. This is dependent on the vendor specific endpoint's returned data.