Units

Create unit

POST
Create a unit for a property.

Request

This endpoint expects an object.
property_id
stringRequired
intgration_id
stringRequired
integration_id
stringOptional
The Propexo unique identifier for the integration
lease_period_id
stringOptional
The Propexo unique identifier for the lease period
bathrooms
stringOptional
The number of bathrooms in the unit.
bedrooms
stringOptional
The number of bedrooms in the unit.
city
stringOptional
The city of the unit.
country
stringOptional
The country of the unit.
date_available
datetimeOptional
The date that the unit becomes available
is_furnished
booleanOptional
Whether the unit is furnished
number
stringOptional
The unit number
square_feet
doubleOptional
The size of the unit in square feet.
state
stringOptional
The state of the unit.
street_address_1
stringOptional
The first address line associated with the unit
street_address_2
stringOptional
The second address line associated with the unit
zip
stringOptional
The zip code of the unit.
floor_plan_code
stringOptional
The external ID of the floor plan
unit_type_id
stringOptional
The external ID of the unit type
category
enumOptional
The category of the unit.
Allowed values: ResidentialCommercial
type
enumOptional
The type of the unit.
Allowed values: ApartmentHouse
name
stringOptional
The name of the unit. Example: "Unit 3".
abbreviation
stringOptional
The abbreviation of the unit. Example: "UNIT3"
address_1
stringOptional
The first address line of the unit.
address_2
stringOptional
The second address line of the unit.
notes
stringOptional
Notes about the unit.
rent_amount_market_in_cents
doubleOptional
The market rent cost of the unit, in cents.

Response

This endpoint returns an object
job_id
string
The ID of the job created to handle this operation
data
object
Returned data from the operation. This is dependent on the vendor specific endpoint's returned data.
POST
1curl -X POST https://api.propexo.com/v1/units \
2 -H "Authorization: Bearer <token>" \
3 -H "Content-Type: application/json" \
4 -d '{
5 "property_id": "property_id",
6 "intgration_id": "intgration_id"
7}'
200Successful
1{
2 "job_id": "clwh5uics000608me9v74du0a",
3 "data": {}
4}