Create property

POST
/v1/properties/

Create a property for an integration.

Request

This endpoint expects an object.
integration_idstringRequired
x_portfolio_idstringOptional

The ID of the portfolio to create the property under in the PMS.

abbreviationstringOptional

The abbreviation of the property. Example: PROP1

namestringOptional

The name of the property. Example: Property 1

square_footagestringOptional

The size of the property in square feet

address_1stringOptional

The first address line associated with the property

address_2stringOptional

The second address line associated with the property

zipstringOptional

The zip code associated with the property

citystringOptional

The city associated with the property

countystringOptional

The county associated with the property

statestringOptional

The state associated with the property

countrystringOptional

The country associated with the property

websitestringOptional

The website URL associated with the property

is_activestringOptional

Whether or not the property is currently active

notesstringOptional

General notes about the property

year_builtintegerOptional

The year the property was built

categoryenumOptional
Allowed values: ResidentialCommercial

The category of the property. This is from a limited set of data that the PMS requires.

typeenumOptional

The type of the property. This is from a limited set of data that the PMS requires.

Response

Successful response

job_idstring

The ID of the job created to handle this operation

dataobject

Errors

Get a property by ID
Built with