UpdateMandateRequest

Partial update body for PATCH /api/v1/mandates/{id}. Send only the fields you want to change; omitted fields are left untouched. Where a nullable field accepts null, sending null explicitly clears the stored value.

  • categories
    Type: array object[] | null · CreateMandateCategoryRequest[]

    Replace-all asset categories. Null/empty list clears.

    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.

    • type
      Type: string
      required

      Asset type token. Either a recognised top-level category (e.g. office) or slash-notation category/subtype where both halves are recognised and the subtype belongs to the declared base (e.g. retail/shopping_mall). Empty halves, unknown tokens, and mixed-base pairs return 400 with the accepted base-type list in the error message.

    • leasableUnits
      Type: object · AreaRange nullable

      Leasable units (area) range.

    • locationClasses
      Type: array string[] | null

      Allowed location classes for this category (A | B | C).

    • rentPerUnit
      Type: object · PriceRange nullable

      Target rent per unit (currency-bearing).

    • vacancyRate
      Type: object · PercentRange nullable

      Acceptable vacancy rate range.

    • yieldPercent
      Type: object · PercentRange nullable

      Target yield percentage range.

  • country
    Type: null | string

    ISO 3166-1 alpha-2 country code (e.g. SE, DE). Null clears.

  • description
    Type: null | string

    Free-text investment strategy / thesis. Null clears the description.

  • externalRefs
    Type: array object[] · ExternalRef[] …10

    Replace-all external references. Each (namespace, externalId) pair must be unique within your organization and is trimmed/normalized server-side.

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

    • id
      Type: string
      max length:  
      255
      required

      External identifier within the namespace (e.g., "003XXXXXXXXXXXX" for Salesforce). Case-sensitive. Format depends on the external system.

    • namespace
      Type: string
      max length:  
      50
      required

      External system namespace (e.g., "salesforce", "hubspot", "pipedrive", "csv-import"). Case-insensitive.

  • geography
    nullable
  • investmentSize
    Type: object · PriceRange nullable

    Price as a min/max range, with currency and scale.

    • currency
      Type: string
      min length:  
      3
      max length:  
      3
      required

      ISO 4217 currency code (e.g., "EUR", "SEK", "USD").

    • max
      Type: null | number | string Pattern: ^-?(?:0|[1-9]\d*)(?:\.\d+)?$Format: double
      min:  
      0

      Maximum price. Multiply by scale factor to get actual amount. Example: max=200 with scale="millions" = 200 million. Omit for an open-ended lower-bounded range.

    • min
      Type: null | number | string Pattern: ^-?(?:0|[1-9]\d*)(?:\.\d+)?$Format: double
      min:  
      0

      Minimum price. Multiply by scale factor to get actual amount. Example: min=100 with scale="millions" = 100 million. Omit for an open-ended upper-bounded range.

    • scale
      Type: string

      Scale factor for the values: "none" (1), "thousands" (1,000), "millions" (1,000,000), "billions" (1,000,000,000). Default is "none" if not specified on input.

  • location
    Type: null | string

    Named location to geocode and search within (city, region, country). Mutually exclusive with geography and near+radius. Null/empty clears the geography.

  • name
    Type: null | string

    New mandate name (1-200 chars). Whitespace is trimmed server-side.

  • near
    Type: object · MandateNearRequest 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.

    • latitude
      Type: null | number | string Pattern: ^-?(?:0|[1-9]\d*)(?:\.\d+)?(?:[eE][+-]?\d+)?$Format: double

      Latitude (WGS84). Required when near is specified.

    • longitude
      Type: null | number | string Pattern: ^-?(?:0|[1-9]\d*)(?:\.\d+)?(?:[eE][+-]?\d+)?$Format: double

      Longitude (WGS84). Required when near is specified.

  • negativeTags
    Type: array string[] | null

    Replace-all negative tags. Null/empty list clears.

  • parcelArea
    Type: object · AreaRange nullable

    Area as a min/max range. Values are in square meters.

    • max
      Type: null | number | string Pattern: ^-?(?:0|[1-9]\d*)(?:\.\d+)?$Format: double
      min:  
      0

      Maximum area (sqm). Omit for an open-ended lower-bounded range.

    • min
      Type: null | number | string Pattern: ^-?(?:0|[1-9]\d*)(?:\.\d+)?$Format: double
      min:  
      0

      Minimum area (sqm). Omit for an open-ended upper-bounded range.

  • positiveTags
    Type: array string[] | null

    Replace-all positive tags. Null/empty list clears.

  • radius
    Type: null | integerFormat: int32

    Search radius in meters (1-100 000). Paired with near.

  • yearBuilt
    Type: object · YearRange nullable

    Calendar year as a min/max range (e.g. 1990–2005). Years are expressed as full integer years (CE / Common Era).

    • max
      Type: null | integer | string Pattern: ^-?(?:0|[1-9]\d*)$Format: int32

      Latest year in the range (e.g. 2005). Omit for an open-ended lower-bounded range.

    • min
      Type: null | integer | string Pattern: ^-?(?:0|[1-9]\d*)$Format: int32

      Earliest year in the range (e.g. 1990). Omit for an open-ended upper-bounded range.

Propstreet API Documentation