Properties

Create property

POST
Create a property for an integration.

Request

This endpoint expects an object.
integration_id
stringRequired
x_portfolio_id
stringOptional
The ID of the portfolio to create the property under in the PMS.
abbreviation
stringOptional
The abbreviation of the property. Example: PROP1
name
stringOptional
The name of the property. Example: Property 1
square_footage
stringOptional
The size of the property in square feet
address_1
stringOptional
The first address line associated with the property
address_2
stringOptional
The second address line associated with the property
zip
stringOptional
The zip code associated with the property
city
stringOptional
The city associated with the property
county
stringOptional
The county associated with the property
state
stringOptional
The state associated with the property
country
stringOptional
The country associated with the property
website
stringOptional
The website URL associated with the property
is_active
stringOptional
Whether or not the property is currently active
notes
stringOptional
General notes about the property
year_built
integerOptional
The year the property was built
category
enumOptional
The category of the property. This is from a limited set of data that the PMS requires.
Allowed values: ResidentialCommercial
type
enumOptional
The type of the property. This is from a limited set of data that the PMS requires.

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/properties \
2 -H "Authorization: Bearer <token>" \
3 -H "Content-Type: application/json" \
4 -d '{
5 "integration_id": "integration_id"
6}'
200Successful
1{
2 "job_id": "clwh5uics000608me9v74du0a",
3 "data": {}
4}