Create a property

POSThttp://localhost:4000/api/properties/create

Adds a new property. Send photos and floorPlansPhotos as empty lists when you have none yet.

Your API key needs the properties.MANAGE permission.

Body Params

titlestringrequired

Listing title.

descriptionstring

Listing description.

propertyTypeenumrequired

Kind of property.

dealTypeenumrequired

Whether it is for sale, for rent, or both.

statusenum

Availability.

brandIdinteger

ID of the brand that lists the property.

developerIdinteger

ID of the developer.

externalAgentIdinteger

ID of the external agent selling the property.

sellerClientIdinteger

ID of the client selling the property.

isPublishedToWebsiteboolean

True when the property appears on your website.

photosarray of stringrequired

Photo URLs. Upload them first, see the Upload property files guide.

floorPlansPhotosarray of stringrequired

Floor plan image URLs.

propertyFilesobject

Documents grouped by folder.

countrystring

Country.

citystring

City.

statestring

State or district.

areastring

Area or neighborhood.

addressstring

Street address.

zipcodestring

Postal code.

latitudenumber

Latitude.

longitudenumber

Longitude.

bedroomsinteger

Number of bedrooms.

bathroomsinteger

Number of bathrooms.

showersinteger

Number of showers.

toiletsinteger

Number of toilets.

livingRoomsinteger

Number of living rooms.

kitchensinteger

Number of kitchens.

parkingSpacesinteger

Number of parking spaces.

buildingFloorinteger

Floor of the unit.

houseFloorsinteger

Floors in the house.

unitNumberstring

Unit number.

featuresarray of string

Features. See List property features.

furnishedenum

How furnished it is.

orientationstring

Which way it faces. See List orientations.

constructionStageenum

Construction stage.

estimatedCompletionDatestring

Estimated completion date.

yearOfConstructioninteger

Year built.

yearOfRenovationinteger

Year renovated.

energyEfficiencyRatingstring

Energy rating.

plotSizenumber

Plot size in square meters.

interiorSizenumber

Interior size in square meters.

coveredSizenumber

Covered size in square meters.

gardenSizenumber

Garden size in square meters.

roofGardenSizenumber

Roof garden size in square meters.

basementSizenumber

Basement size in square meters.

coveredVerandaSizenumber

Covered veranda size in square meters.

uncoveredVerandaSizenumber

Uncovered veranda size in square meters.

coveredParkingSizenumber

Covered parking size in square meters.

sectionstring

Land registry section.

plotNumberinteger

Land registry plot number.

sheetPlanstring

Land registry sheet and plan.

titleDeedIdstring

Title deed number.

priceinteger

Price.

reducedPriceinteger

Reduced price.

vatRatenumber

VAT rate.

commissionPercentageinteger

Commission percentage.

Responses

200Successful response.
400The request is not valid.
401The API key is missing, invalid, expired or disabled.
403The API key does not have the permission this endpoint needs.