Creates a new mandate.

Body·

required

Mandate details

Request model for creating a new mandate.

name
Type: string
min length:
1
max length:
200
required
categories
Type: array object[] ·

Mandate category entry (POST create + PATCH update). Categories are replace-all on PATCH — partial-by-id semantics are not supported because the category list is small and the contained ranges are independently optional.
country
Type: null | string
description
Type: null | string
externalRefs
Type: array object[] · …10

Represents an external system reference (e.g., Salesforce, HubSpot, Pipedrive). Supports multiple CRM systems simultaneously.
geography
nullable

GeoJSON Polygon/MultiPolygon (WGS84, [lng, lat]). Mutually exclusive with near+radius and location.
investmentSize
Type: object · nullable

Price as a min/max range, with currency and scale.
location
Type: null | string
near
Type: object · nullable

Point coordinates for near-field search on the mandates V1 routes. Shared by the PATCH update body, the POST create request, and the POST search request.
negativeTags
Type: array string[]
parcelArea
Type: object · nullable

Area as a min/max range. Values are in square meters.
positiveTags
Type: array string[]

Request model for creating a new mandate.

Responses

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

post/api/v1/mandates

curl https://app.propstreet.com/api/v1/mandates \
  --request POST \
  --header 'Content-Type: application/json' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN' \
  --data '{
  "name": "",
  "description": null,
  "geography": null,
  "near": {
    "longitude": "",
    "latitude": ""
  },
  "radius": "",
  "location": null,
  "country": null,
  "investmentSize": {
    "min": 0,
    "max": 0,
    "currency": "",
    "scale": ""
  },
  "yearBuilt": {
    "min": "",
    "max": ""
  },
  "parcelArea": {
    "min": 0,
    "max": 0
  },
  "categories": [
    {
      "type": "",
      "locationClasses": [
        ""
      ],
      "yieldPercent": {
        "min": "",
        "max": ""
      },
      "leasableUnits": {
        "min": 0,
        "max": 0
      },
      "vacancyRate": {
        "min": "",
        "max": ""
      },
      "rentPerUnit": {
        "min": 0,
        "max": 0,
        "currency": "",
        "scale": ""
      }
    }
  ],
  "positiveTags": [
    ""
  ],
  "negativeTags": [
    ""
  ],
  "externalRefs": [
    {
      "namespace": "",
      "id": ""
    }
  ]
}'

Show Schema

{
  "id": "string",
  "uri": null,
  "name": "string",
  "description": null,
  "geography": null,
  "resolvedLocation": {
    "name": "string",
    "country": null,
    "longitude": "string",
    "latitude": "string"
  },
  "country": null,
  "investmentSize": {
    "min": 0,
    "max": 0,
    "currency": "string",
    "scale": "string"
  },
  "yearBuilt": {
    "min": "string",
    "max": "string"
  },
  "parcelArea": {
    "min": 0,
    "max": 0
  },
  "categories": [
    {
      "type": "string",
      "locationClasses": [
        "string"
      ],
      "yieldPercent": {
        "min": "string",
        "max": "string"
      },
      "leasableUnits": {
        "min": 0,
        "max": 0
      },
      "vacancyRate": {
        "min": "string",
        "max": "string"
      },
      "rentPerUnit": {
        "min": 0,
        "max": 0,
        "currency": "string",
        "scale": "string"
      }
    }
  ],
  "positiveTags": [
    "string"
  ],
  "negativeTags": [
    "string"
  ],
  "externalRefs": [
    {
      "namespace": "string",
      "id": "string"
    }
  ],
  "createdUtc": "2026-05-18T20:22:36.959Z",
  "updatedUtc": "2026-05-18T20:22:36.959Z",
  "deletedUtc": null,
  "etag": "string",
  "changeType": null,
  "changeOrigin": null
}

Created