Units

Create unit

Create a unit for a property.

post/v1/units/

Request

  • Base URL: https://api.propexo.com
  • URL: https://api.propexo.com/v1/units/
  • Auth: HTTP bearer

Request body

integration_idstring

The Propexo unique identifier for the integration

property_idstring required
lease_period_idstring

The Propexo unique identifier for the lease period

bathroomsstring nullable

The number of bathrooms in the unit.

bedroomsstring nullable

The number of bedrooms in the unit.

citystring

The city of the unit.

countrystring

The country of the unit.

date_availablestring date-time

The date that the unit becomes available

is_furnishedboolean

Whether the unit is furnished

numberstring

The unit number

square_feetnumber double

The size of the unit in square feet.

statestring

The state of the unit.

street_address_1string

The first address line associated with the unit

street_address_2string

The second address line associated with the unit

zipstring

The zip code of the unit.

floor_plan_codestring

The external ID of the floor plan

unit_type_idstring

The external ID of the unit type

category'Residential' | 'Commercial'

The category of the unit.

type'Apartment' | 'House'

The type of the unit.

namestring

The name of the unit. Example: "Unit 3".

abbreviationstring

The abbreviation of the unit. Example: "UNIT3"

address_1string

The first address line of the unit.

address_2string

The second address line of the unit.

notesstring

Notes about the unit.

rent_amount_market_in_centsnumber double

The market rent cost of the unit, in cents.

intgration_idstring required

Response

Successful response

job_idstring required

The ID of the job created to handle this operation

dataV1UnitsPostOutputData required

Changes

No recorded changes to this operation across all 1 revision of this API.