Skip to main content
POST
/
create-property
Create a property
curl --request POST \
  --url https://v2.api.uk.housr.com/create-property \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "title": "<string>",
  "description": "<string>",
  "address": "<string>",
  "city": "<string>",
  "images": [
    "<string>"
  ],
  "price_pw": 123,
  "bedrooms": 1,
  "bathrooms": 1,
  "postcode": "<string>",
  "lat": 123,
  "lng": 123,
  "deposit": 0
}
'
{
  "propertyId": 12345,
  "message": "Property successfully uploaded"
}

Authorizations

​
Authorization
string
header
required

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

Body

​
title
string
required
​
description
string
required
​
address
string
required
​
city
string
required
​
images
string<uri>[]
required

Array of image URLs, each their own comma-separated string

​
price_pw
integer
required

Weekly price as a string to preserve precision

​
bedrooms
integer
required
Required range: x >= 0
​
bathrooms
integer
required
Required range: x >= 0
​
postcode
string
required
​
lat
number<double> | null
required
​
lng
number<double> | null
required
​
deposit
integer
default:0
required

Defaults to 0 if not supplied

Response

Created

​
propertyId
integer<int64>
​
message
string