Skip to content

Update Collateral

Updates properties of a specific collateral using Blooma's update engine. Allows atomic modification of collateral-level fields like name, valuation overrides, or custom attributes.

Key Details

  • Request body contains propertiesToUpdates[] — each item specifies a property (field name) and value (new value).
  • Example: To update the collateral name, provide {"property": "Name", "value": "Sunset Apartments"}.
  • The update engine validates each change against field constraints. If any update fails, the response includes error details with errorType (MissingMandatoryField, IllegalValue) and field context.
  • All updates are processed atomically — either all succeed or none are applied.
  • Returns a success/error wrapper with minimal data. Use Get Deal Collateral Summary or Get Collateral Cash Flow to verify changes.

Parameters

collateralId string

Unique identifier for the collateral property

Request

Type: application/json

Schema: UpdateCollateralRequestDto

propertiesToUpdates array [ CollateralPropertyUpdateDto ]
property string(enum)

Available enum values: Name, Description, YearRenovated, YearBuilt, FloorAreaRatio, ParkingRatio, AssetClass

value string

Response

Status: 200

Type: application/json

Schema: UpdateResponseDto

success boolean

Indicates whether the API request completed successfully

error ErrorDto
target string

Field or parameter that caused the error

code string(enum)

Error code (e.g., Duplicated, MissingMandatoryField, InvalidCreateValues, MissingEntity)

Available enum values: Duplicated, MissingMandatoryField, InvalidCreateValues, Existing, ValidationError, MissingEntity

message string

details array [ ErrorDto ]
PATCH 
/api/apiGateway/updateCollateral/{collateralId}
Request Body
{
  "propertiesToUpdates": [
    {
      "property": "Name",
      "value": "string"
    }
  ]
}
Response
{
  "success": true,
  "error": {
    "target": "string",
    "code": "Duplicated",
    "message": "string",
    "details": [
      {}
    ]
  }
}