Property

Post Property

POST
Insert a new property in the database. For example a new development.

Request

This endpoint expects an object.
property
objectRequired
RentSourcePropertyInsert object is a very simplified version of the RentSourcePropertyAttributes object used when creating a new Property object. It is used to validate the request body of a POST

Response

This endpoint returns an object
id
string
POST
1curl -X POST https://api.hellodata.ai/property \
2 -H "x-api-key: <apiKey>" \
3 -H "Content-Type: application/json" \
4 -d '{
5 "property": {
6 "street_address": "123 Main St",
7 "city": "New York",
8 "state": "NY",
9 "zip_code": "01234",
10 "lat": 40.7128,
11 "lon": 74.006,
12 "is_single_family": false,
13 "is_condo": false,
14 "is_apartment": true,
15 "number_units": 100,
16 "year_built": 2020,
17 "number_stories": 10,
18 "building_amenities": [
19 "24_hour_maintenance"
20 ],
21 "unit_amenities": [
22 "air_conditioning"
23 ],
24 "avg_quality": 0.8,
25 "units": [
26 {
27 "bed": 2,
28 "bath": 1,
29 "name": "1A",
30 "sqft": 1000
31 }
32 ]
33 }
34}'
200Successful
1{
2 "id": "id"
3}