Create Property: Propertyware

POSThttps://api.propexo.com/v1/properties/propertyware/

Method
createBuilding

Notice

Due to PMS limitations, the ID of the created record cannot be retrieved. This will be found on the next data sync.

Authentication

• AuthorizationBearer
  Bearer authentication of the form Bearer <token>, where token is your auth token.

Request

This endpoint expects an object.

integration_idstringrequired

The Propexo unique identifier for the integration

x_portfolio_idstringrequired

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

abbreviationstringrequired

The abbreviation of the property. Example: PROP1

namestringrequired

The name of the property. Example: Property 1

square_footagestringrequired

The size of the property in square feet

address_1stringrequired

The first address line associated with the property

address_2string

The second address line associated with the property

zipstring

The zip code associated with the property

citystring

The city associated with the property

countystring

The county associated with the property

statestring

The state associated with the property

countrystring

The country associated with the property

websitestring

The website URL associated with the property

is_activestring

Whether or not the property is currently active

notesstring

General notes about the property

year_builtinteger

The year the property was built

categorystringrequired
The category of the property. This is from a limited set of data that the PMS requires.
Show 2 enum values
ResidentialCommercial
typestringrequired
The type of the property. This is from a limited set of data that the PMS requires.
Show 11 enum values
ApartmentCondoCommercialDu/FourplexHouseSection 8/AffordableSeniorShort-term/vacationStudentTownhouseOther

Response

Successful response

meta objectrequired
job_idstringrequired
result objectrequired
integration_idstringrequired
The Propexo unique identifier for the integration
x_portfolio_idstringrequired
The ID of the portfolio to create the property under in the PMS.
abbreviationstringrequired
The abbreviation of the property. Example: PROP1
namestringrequired
The name of the property. Example: Property 1
square_footagestringrequired
The size of the property in square feet
address_1stringrequired
The first address line associated with the property
address_2string | nullnullablerequired
The second address line associated with the property
zipstring | nullnullablerequired
The zip code associated with the property
citystring | nullnullablerequired
The city associated with the property
countystring | nullnullablerequired
The county associated with the property
statestring | nullnullablerequired
The state associated with the property
countrystring | nullnullablerequired
The country associated with the property
websitestring | nullnullablerequired
The website URL associated with the property
is_activestring | nullnullablerequired
Whether or not the property is currently active
notesstring | nullnullablerequired
General notes about the property
year_builtinteger | nullnullablerequired
The year the property was built
categorystringrequired
The category of the property. This is from a limited set of data that the PMS requires.
Show 2 enum values
ResidentialCommercial
typestringrequired
The type of the property. This is from a limited set of data that the PMS requires.
Show 11 enum values
ApartmentCondoCommercialDu/FourplexHouseSection 8/AffordableSeniorShort-term/vacationStudentTownhouseOther

Errors

• 400Bad Request

  error objectrequired
  codestringrequired
  Example: invalid_request
  messagestringrequired
  Example: invalid request
  details object
  property name*any
  Example: {"details":{"issues":[{"code":"unrecognized_keys","keys":["foo"],"path":[],"message":"Unrecognized key(s) in object: 'foo'"}],"name":"ZodError"}}

POST /v1/properties/propertyware/

curl -X POST https://api.propexo.com/v1/properties/propertyware/ \
     -H "Authorization: Bearer <token>" \
     -H "Content-Type: application/json" \
     -d '{
  "integration_id": "string",
  "x_portfolio_id": "string",
  "abbreviation": "string",
  "name": "string",
  "square_footage": "string",
  "address_1": "string",
  "category": "Residential",
  "type": "Apartment"
}'

200 Successful response

{
  "meta": {
    "job_id": "string"
  },
  "result": {
    "integration_id": "string",
    "x_portfolio_id": "string",
    "abbreviation": "string",
    "name": "string",
    "square_footage": "string",
    "address_1": "string",
    "address_2": "string",
    "zip": "string",
    "city": "string",
    "county": "string",
    "state": "string",
    "country": "string",
    "website": "string",
    "is_active": "string",
    "notes": "string",
    "year_built": 0,
    "category": "Residential",
    "type": "Apartment"
  }
}