Creates a new property.

Body·

required

Property details

Request model for creating a new property.

name
Type: string
min length:
1
max length:
200
required

Property name. Required, 1-200 characters.
avgContractLengthYears
Type: string Pattern: ^-?(?:0|[1-9]\d*)(?:\.\d+)?$Format: double

Average contract length in years.
categories
Type: array object[] ·

Asset categories with yield, rental income, rented/vacant area data.

Category data for property creation.
description
Type: null | string

Property description.
externalRefs
Type: array object[] · …10

External references for CRM integration (e.g., Yardi, Salesforce). Each namespace can only appear once. Maximum 10 refs.

Represents an external system reference (e.g., Salesforce, HubSpot, Pipedrive). Supports multiple CRM systems simultaneously.
location
Type: object · nullable

Location data: latitude, longitude, country (ISO 3166-1 alpha-2), locality.
operatingCosts
Type: object · nullable

Annual operating costs.
parcelArea
Type: object · nullable

Parcel area. Write requests must include unit "sqm".
price
Type: object · nullable

Investment price.
tags
Type: array string[]

Property tags using the documented snake_case values.
tenure
Type: null | string

Tenure: freehold or leasehold.
yearBuilt
Type: string Pattern: ^-?(?:0|[1-9]\d*)$Format: int32

Year the property was built.

Request model for creating a new property.

Responses

application/json
application/problem+json
application/problem+json
application/problem+json

post/api/v1/properties

curl https://app.propstreet.com/api/v1/properties \
  --request POST \
  --header 'Content-Type: application/json' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN' \
  --data '{
  "name": "",
  "description": null,
  "location": {
    "latitude": "",
    "longitude": "",
    "country": null,
    "locality": null
  },
  "categories": [
    {
      "type": "",
      "locationClass": null,
      "yieldPercent": "",
      "rentalIncome": {
        "value": 0,
        "currency": "",
        "scale": ""
      },
      "rentedArea": {
        "value": "",
        "unit": ""
      },
      "vacantArea": {
        "value": "",
        "unit": ""
      },
      "conversions": [
        ""
      ]
    }
  ],
  "price": {
    "value": 0,
    "currency": "",
    "scale": ""
  },
  "operatingCosts": {
    "value": 0,
    "currency": "",
    "scale": ""
  },
  "avgContractLengthYears": "",
  "yearBuilt": "",
  "parcelArea": {
    "value": "",
    "unit": ""
  },
  "zoning": {
    "gfa": {
      "value": "",
      "unit": ""
    },
    "categories": [
      ""
    ]
  },
  "tenure": null,
  "tags": [
    ""
  ],
  "externalRefs": [
    {
      "namespace": "",
      "id": ""
    }
  ]
}'

Show Schema

{
  "id": "string",
  "uri": null,
  "name": "string",
  "description": null,
  "location": {
    "latitude": "string",
    "longitude": "string",
    "country": null,
    "locality": null
  },
  "categories": [
    {
      "type": "string",
      "locationClass": null,
      "yieldPercent": "string",
      "rentalIncome": {
        "value": 0,
        "currency": "string",
        "scale": "string"
      },
      "rentedArea": {
        "value": "string",
        "unit": "string"
      },
      "vacantArea": {
        "value": "string",
        "unit": "string"
      },
      "conversions": [
        "string"
      ]
    }
  ],
  "price": {
    "value": 0,
    "currency": "string",
    "scale": "string"
  },
  "operatingCosts": {
    "value": 0,
    "currency": "string",
    "scale": "string"
  },
  "avgContractLengthYears": "string",
  "yearBuilt": "string",
  "parcelArea": {
    "value": "string",
    "unit": "string"
  },
  "zoning": {
    "gfa": {
      "value": "string",
      "unit": "string"
    },
    "categories": [
      "string"
    ]
  },
  "tenure": null,
  "tags": [
    "string"
  ],
  "projects": [
    {
      "id": "string",
      "uri": null,
      "name": "string"
    }
  ],
  "externalRefs": [
    {
      "namespace": "string",
      "id": "string"
    }
  ],
  "createdUtc": "2026-05-18T20:22:36.959Z",
  "updatedUtc": "2026-05-18T20:22:36.959Z",
  "deletedUtc": null,
  "etag": "string",
  "distance_meters": "string",
  "changeType": null,
  "changeOrigin": null
}

Created