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

Path Parameters

property_idrequired
string

The ID of the resource.

property_idrequired
string

The ID of the resource.

Body

integration_id
string

The Propify unique identifier for the integration

property_idrequired
string
number
string

The number of the unit. For example Unit 20.

unit_prefix
string

The prefix of the unit. For example Unit 20c.

unit_suffix
string

The suffix of of the unit. For example c20.

space_number
string

The space number for the unit.

max_occupants
string

The maximum number of occupants per specific unit.

max_pets
string

The maximum number of pets per specific unit.

bedrooms
string | null

The number of bedrooms in the unit.

bathrooms
string | null

The number of bathrooms in the unit.

square_feet
number

The size of the unit in square feet.

note
string

Notes about the unit.

unit_gender_id
string

The gender id for the unit.

marking_number
string

The marking number for the unit.

certificate_of_occupancy_date
string

The certificate of occupancy for the unit.

is_shown_on_website
boolean

The unit is listed online.

property_building_id
string

The id of the property building.

floor_plan_code
string

The code for the floor plan.

unit_type_id
string

The id for the unit type.

property_floor_id
string

The id for the property floor.

unit_exclusion_reason_type_id
string

The unit exclusion reason id.

unit_space_status_type_id
string

The unit space status type id.

lease_term_in_months
integer

The lease term in months for the unit.

Available options:
3,
6,
9,
12,
15,
18
available_on
string

The date when the unit is available.

make_ready_date
string

The make ready date.

is_furnished
boolean

The unit is furnished.

tax_credit_unit_number
string

The tax credit number for the unit.

amenity_ids
string

A comma separated list of unit-level amenity ids for the unit.

country
string

The country of the unit.

street_address_1
string

The first address line associated with the unit

street_address_2
string

The second address line associated with the unit

city
string

The city of the unit.

state
string

The state of the unit.

zip
string

The zip code of the unit.

category
string

The category of the unit.

Available options:
Residential,
Commercial
type
string

The type of the unit.

Available options:
Apartment,
House
name
string

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

abbreviation
string

The abbreviation of the unit. Example: "UNIT3"

address_1
string

The first address line of the unit.

address_2
string

The second address line of the unit.

notes
string

Notes about the unit.

rent_amount_market_in_cents
number

The market rent cost of the unit, in cents.

intgration_idrequired
string

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.