Units

Create unit

POST
https://api.propexo.com/v1/units
Create a unit for a property.

Request

This endpoint expects an object.
property_id
string
intgration_id
string
integration_id
optional string
The Propexo unique identifier for the integration
number
optional string
The number of the unit. For example Unit 20.
unit_prefix
optional string
The prefix of the unit. For example Unit 20c.
unit_suffix
optional string
The suffix of of the unit. For example c20.
space_number
optional string
The space number for the unit.
max_occupants
optional string
The maximum number of occupants per specific unit.
max_pets
optional string
The maximum number of pets per specific unit.
bedrooms
optional string
The number of bedrooms in the unit.
bathrooms
optional string
The number of bathrooms in the unit.
square_feet
optional double
The size of the unit in square feet.
note
optional string
Notes about the unit.
unit_gender_id
optional string
The gender id for the unit.
marking_number
optional string
The marking number for the unit.
certificate_of_occupancy_date
optional datetime
The certificate of occupancy for the unit.
is_shown_on_website
optional boolean
The unit is listed online.
property_building_id
optional string
The id of the property building.
floor_plan_code
optional string
The code for the floor plan.
unit_type_id
optional string
The id for the unit type.
property_floor_id
optional string
The id for the property floor.
unit_exclusion_reason_type_id
optional string
The unit exclusion reason id.
unit_space_status_type_id
optional string
The unit space status type id.
lease_term_in_months
optional integer
The lease term in months for the unit.
available_on
optional datetime
The date when the unit is available.
make_ready_date
optional datetime
The make ready date.
is_furnished
optional boolean
The unit is furnished.
tax_credit_unit_number
optional string
The tax credit number for the unit.
amenity_ids
optional string
A comma separated list of unit-level amenity ids for the unit.
country
optional string
The country of the unit.
address_1
optional string
The first address line of the unit.
address_2
optional string
The second address line of the unit.
city
optional string
The city of the unit.
state
optional string
The state of the unit.
zip
optional string
The zip code of the unit.
category
optional enum
The category of the unit.
Allowed values: ResidentialCommercial
type
optional enum
The type of the unit.
Allowed values: ApartmentHouse
name
optional string
The name of the unit. Example: "Unit 3".
abbreviation
optional string
The abbreviation of the unit. Example: "UNIT3"
notes
optional string
Notes about the unit.
rent_amount_market_in_cents
optional double
The market rent cost of the unit, in cents.

Response

This endpoint return 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
/v1/units
curl -X POST https://api.propexo.com/v1/units \
-H "Authorization: Bearer <token>" \
-H "Content-Type: application/json" \
-d '{
"property_id": "property_id",
"intgration_id": "intgration_id"
}'
Response
{
"job_id": "job_id",
"data": {}
}