UpdateProjectRequest

Request model for updating a project.

  • asset
    Type: object · Asset nullable

    Asset information for a project. Describes whether this is a single property or portfolio deal.

    • type
      Type: string
      required

      Asset type: "single" for single property, "portfolio" for multiple properties.

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

      Number of properties in the portfolio. Only present when type is "portfolio".

  • exclusivity
    Type: null | string

    Sales exclusivity type: "exclusive", "non_exclusive", "other", or null to clear. Preferred field; mutually exclusive with the deprecated mandate field.

  • externalRefs
    Type: array object[] | null · ExternalRef[]

    External references for CRM integration. Replaces all existing external refs. Set to empty array to remove all external refs.

    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.

  • mandate
    Type: null | string
    deprecated

    Deprecated alias for 'exclusivity'. Sending both 'mandate' and 'exclusivity' with non-null values is rejected with 422. Will be removed in a future minor version.

  • name
    Type: null | string

    Project name. Cannot be empty if provided.

  • price
    Type: object · Price nullable

    Price as a single value, with currency and scale.

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

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

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

      Price value. Multiply by scale factor to get actual amount. Example: value=1500 with scale="millions" = 1.5 billion.

    • scale
      Type: string

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

  • priceRange
    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.