API ReferenceUnits

Create unit

Create a unit for a property.

Headers

AuthorizationstringRequired

Bearer authentication of the form Bearer <token>, where token is your auth token.

Request

This endpoint expects an object.
property_idstringRequired
intgration_idstringRequired
integration_idstringOptional
The Propexo unique identifier for the integration
lease_period_idstringOptional
The Propexo unique identifier for the lease period
bathroomsstringOptional
The number of bathrooms in the unit.
bedroomsstringOptional
The number of bedrooms in the unit.
citystringOptional
The city of the unit.
countrystringOptional
The country of the unit.
date_availabledatetimeOptionalDefaults to 1970-01-01T00:00:00.000Z
The date that the unit becomes available
is_furnishedbooleanOptionalDefaults to false
Whether the unit is furnished
numberstringOptional
The unit number
square_feetdoubleOptional
The size of the unit in square feet.
statestringOptional
The state of the unit.
street_address_1stringOptional
The first address line associated with the unit
street_address_2stringOptional
The second address line associated with the unit
zipstringOptional
The zip code of the unit.
floor_plan_codestringOptional
The external ID of the floor plan
unit_type_idstringOptional
The external ID of the unit type
categoryenumOptional
The category of the unit.
Allowed values:
typeenumOptional
The type of the unit.
Allowed values:
namestringOptional

The name of the unit. Example: “Unit 3”.

abbreviationstringOptional

The abbreviation of the unit. Example: “UNIT3”

address_1stringOptional
The first address line of the unit.
address_2stringOptional
The second address line of the unit.
notesstringOptional
Notes about the unit.
rent_amount_market_in_centsdoubleOptional
The market rent cost of the unit, in cents.

Response

Successful response
job_idstring
The ID of the job created to handle this operation
dataobject

Errors