---
title: "PATCH /inventory/{inventoryId}"
method: PATCH
path: "/inventory/{inventoryId}"
tags: ["Inventory"]
---

# PATCH /inventory/{inventoryId}

`PATCH /inventory/{inventoryId}`

## Request

- Base URL: `https://api.alto.zoopladev.co.uk`
- URL: `https://api.alto.zoopladev.co.uk/inventory/{inventoryId}`
- Auth: `appAuth` (a scheme the document does not define)

## Path parameters

- `inventoryId` string, required

## Headers

- `AgencyRef` string, required

## Request body

- SystemTextJsonPatchOperationsOperation1AltoInventoryApiModelsResponsesInventoryPatch[]: Array of operations to perform
  - union
    - object: The displayable address.
      - `op` 'replace' | 'test'
      - `value` string
      - `path` string
    - object: The council tax band of the building or property.
      - `op` 'replace' | 'test'
      - `value` string
      - `path` string
    - object: The reason for a tax exemption on a building or property.
      - `op` 'replace' | 'test'
      - `value` string
      - `path` string
    - object: The unitary authority in governance of the building or property.
      - `op` 'replace' | 'test'
      - `value` string
      - `path` string
    - object: The service charge summary for a building or property.
      - `op` 'replace' | 'test'
      - `value` string
      - `path` string
    - object: Any additional notes pertaining to the service charge for a leasehold building or property.
      - `op` 'replace' | 'test'
      - `value` string
      - `path` string
    - object: The ground rent summary for a building or property.
      - `op` 'replace' | 'test'
      - `value` string
      - `path` string
    - object: The remaining term in months of the lease for a leasehold building or property.
      - `op` 'replace' | 'test'
      - `value` integer
      - `path` string
    - object: The term of the lease for a leasehold building or property.
      - `op` 'replace' | 'test'
      - `value` integer
      - `path` string
    - object: The end date of the lease for a leasehold building or property.
      - `op` 'replace' | 'test'
      - `value` object
      - `path` string
    - object: The review period of the ground rent for a leasehold building or property.
      - `op` 'replace' | 'test'
      - `value` number
      - `path` string
    - object: The percentage increase of the ground rent for a leasehold building or property.
      - `op` 'replace' | 'test'
      - `value` number
      - `path` string
    - object: The flag to indicate whether the ground rent is fixed for the duration of the lease.
      - `op` 'replace' | 'test'
      - `value` boolean
      - `path` string
    - object: Any additional notes pertaining to the ground rent for a leasehold building or property.
      - `op` 'replace' | 'test'
      - `value` string
      - `path` string
    - object: The flag to indicate whether there is shared ownership on a leasehold building or property.
      - `op` 'replace' | 'test'
      - `value` boolean
      - `path` string
    - object: The percentage share of ownership for a leasehold building or property.
      - `op` 'replace' | 'test'
      - `value` number
      - `path` string
    - object: The rent value of shared ownership for a leasehold building or property.
      - `op` 'replace' | 'test'
      - `value` number
      - `path` string
    - object: The frequency of rent income on a shared ownership leasehold building or property.
      - `op` 'replace' | 'test'
      - `value` 'Yearly' | 'Quarterly' | 'Monthly' | 'Weekly' | 'Daily'
      - `path` string
    - object: Any additional notes pertaining to the lease for a leasehold building or property.
      - `op` 'replace' | 'test'
      - `value` string
      - `path` string
    - object: Any private notes pertaining to the viewing
      - `op` 'replace' | 'test'
      - `value` string
      - `path` string
    - object: The status to set for a building or property from a restricted set of values.
      - `op` 'replace' | 'test'
      - `value` 'LetAgreed'
      - `path` string
    - object: The sub type of the building or property.
      - `op` 'replace' | 'test'
      - `value` 'NotSpecified' | 'HouseDetached' | 'HouseSemiDetached' | 'HouseTownhouse' | 'HouseMews' | 'HouseTerraced' | 'HouseEndTerrace' | 'Flat' | 'FlatPenthouse' | 'LandBuildingPlot' | 'Farm' | 'Apartment' | 'CottageDetached' | 'ApartmentAboveShop' | 'BungalowSemiDetached' | 'BungalowDetached' | 'BarnConversion' | 'HouseLowBuild' | 'ApartmentLoft' | 'ChaletSemiDetached' | 'Shop' | 'Maisonette' | 'HouseVilla' | 'BarnConversionBungalow' | 'Land' | 'ApartmentBasement' | 'ChaletDetached' | 'ApartmentConversion' | 'ApartmentDoubleUpper' | 'ApartmentDuplex' | 'ApartmentGarden' | 'MobileHome' | 'ParkHome' | 'Hotel' | 'ApartmentMansionBlock' | 'ApartmentPenthouse' | 'ApartmentPurposeBuilt' | 'ApartmentRetirement' | 'ApartmentStudio' | 'ApartmentSheltered' | 'ApartmentTriplex' | 'BarnConversionHouse' | 'BarnConversionUnconverted' | 'Bungalow' | 'BungalowDormerTerrace' | 'BungalowDormerDetached' | 'BungalowDormerSemiDetached' | 'BungalowLodge' | 'BungalowSheltered' | 'BungalowTerrace' | 'Cabana' | 'ChapelConverted' | 'ChapelUnconverted' | 'CottageSemiDetached' | 'CottageTerraced' | 'CountryHome' | 'CountryHomeEstate' | 'DevelopmentProperty' | 'FarmCommercial' | 'FarmResidential' | 'FlatAboveShop' | 'FlatBasement' | 'FlatConversion' | 'FlatDoubleUpper' | 'FlatDuplex' | 'FlatGarden' | 'FlatLoft' | 'FlatMansionBlock' | 'FlatPurposeBuilt' | 'FlatRetirement' | 'FlatStudio' | 'FlatSheltered' | 'FlatTriplex' | 'Garage' | 'GarageLockup' | 'House' | 'HouseBackToBack' | 'HouseEndMews' | 'HouseLinkDetached' | 'HouseLodge' | 'HouseMidQuasi' | 'HouseMidTerrace' | 'HouseQuasi' | 'HouseQuasiSemi' | 'HouseRetirement' | 'HouseSheltered' | 'HouseTerraceInnerThrough' | 'HouseEndTownhouse' | 'LandDevelopment' | 'LandGrazing' | 'LandPaddock' | 'LandArable' | 'LandPasture' | 'LandSmallholding' | 'LandWoodland' | 'MaisonetteDuplex' | 'MaisonetteGarden' | 'MaisonetteLower' | 'MaisonetteUpper' | 'Studio' | 'StudioConversion' | 'StudioPurposeBuilt' | 'BedandBreakfast' | 'Business' | 'BusinessAsGoingConcern' | 'Care' | 'Catering' | 'Commercial' | 'Equestrian' | 'Factory' | 'GaragePetrolStation' | 'GuestHouse' | 'IndustrialUnit' | 'Office' | 'PublicHouse' | 'Retail' | 'Warehouse' | 'Coachhouse' | 'ShopWithLivingAccommodation' | 'ParkingSpace' | 'CottageEndTerraced' | 'BlockOfFlats' | 'Room' | 'BungalowLinkDetached' | 'HouseAttached' | 'HolidayComplex' | 'Sporting' | 'OpenStorageYard' | 'InvestmentLet' | 'Leisure' | 'Estate' | 'Croft' | 'HouseLinkSemiDetached' | 'Educational' | 'Medical' | 'SelfBuild' | 'ServicedOffice' | 'A1Retail' | 'A2FinancialAndProfessional' | 'A3RestaurantsAndCafes' | 'D1NonResidentInstitutions' | 'D2AssemblyAndLeisure' | 'Nash' | 'Stucco' | 'MixedUse' | 'RoomToRent' | 'Renovation' | 'Villa' | 'Investment' | 'Workshop' | 'ManorHouse' | 'CountryResidence' | 'VictorianResidence' | 'CharacterProperty' | 'HouseWithLand' | 'Smallholding2To50Acres' | 'CountryHouse' | 'Paddock' | 'AmenityLand' | 'GrassField' | 'LandWithBuildings' | 'Allotments' | 'ArableLand' | 'Woodland' | 'HousesWithland' | 'Farm50PlusAcres' | 'DormerDetached' | 'DormerSemi' | 'HolidayChalet' | 'HouseWithAnnexe' | 'LodgingHouse' | 'Cottage' | 'ExLocalAuthority' | 'BeachHut' | 'StudentProperty' | 'CharacterPropertyDetached' | 'CharacterPropertySemiDetached' | 'CharacterPropertyTerrace' | 'FlatApartment' | 'Wing' | 'ChaletBungalowDetached' | 'ChaletBungalowSemiDetached' | 'Fishing' | 'FarmHouse' | 'DevelopmentOpportunity' | 'Other' | 'HouseBoat' | 'PropertyWithLand' | 'HouseCountryLessThan2' | 'HouseSmallholding2to25Acres' | 'HouseFarm25Acres' | 'HouseDerelictForConversion'
      - `path` string
    - object: The tenure of the building or property.
      - `op` 'replace' | 'test'
      - `value` 'LetAgreed'
      - `path` string
    - object: The year build of a building or property.
      - `op` 'replace' | 'test'
      - `value` integer
      - `path` string
    - object: The flag to indicate if building or property is new build.
      - `op` 'replace' | 'test'
      - `value` boolean
      - `path` string
    - object: The number of bedrooms in the building or property.
      - `op` 'replace' | 'test'
      - `value` integer
      - `path` string
    - object: The number of bathrooms in the building or property.
      - `op` 'replace' | 'test'
      - `value` integer
      - `path` string
    - object: The number of receptions in the building or property.
      - `op` 'replace' | 'test'
      - `value` integer
      - `path` string
    - object: The land area in acres in the building or property.
      - `op` 'replace' | 'test'
      - `value` number
      - `path` string
    - object: The floor area in square feet of the building or property..
      - `op` 'replace' | 'test'
      - `value` number
      - `path` string
    - object: The flag to indicate if asbestos is present in the building or property.
      - `op` 'replace' | 'test'
      - `value` boolean
      - `path` string
    - object: The date that a rental property becomes available.
      - `op` 'replace' | 'test'
      - `value` object
      - `path` string
    - object: Accessibility features of the property, such as step-free access
      - `op` 'replace' | 'test' | 'add' | 'remove'
      - `value` 'LateralLiving' | 'StepFreeAccess' | 'WetRoom' | 'WheelchairAccessible' | 'DisabledFeatures' | 'LevelAccess' | 'RampedAccess' | 'LiftAccess' | 'StairLift' | 'WideDoorways' | 'LevelAccessShower' | 'VariableHeightKitchenSurfaces'
      - `path` string
    - object: Details of the broadband provision for the property including speed
      - `op` 'replace' | 'test' | 'add' | 'remove'
      - `value` 'Adsl' | 'Cable' | 'FixedWireless' | 'Fttc' | 'Fttp' | 'Mobile' | 'None' | 'Other' | 'Satellite'
      - `path` string
    - object: Details of the broadband provision for the property including speed
      - `op` 'replace' | 'test' | 'add' | 'remove'
      - `value` string
      - `path` string
    - object: Issues with the property's safety
      - `op` 'replace' | 'test' | 'add' | 'remove'
      - `value` string
      - `path` string
    - object: Whether the property is subject to the risk of coastal erosion
      - `op` 'replace' | 'test'
      - `value` boolean
      - `path` string
    - object: Types of construction of the property, eg tile, brick.
      - `op` 'replace' | 'test' | 'add' | 'remove'
      - `value` string
      - `path` string
    - object: The types of electricity supply available to the property
      - `op` 'replace' | 'test' | 'add' | 'remove'
      - `value` 'MainsSupply' | 'PrivateSupply' | 'SolarPvPanels' | 'WindTurbine' | 'Generator' | 'Other'
      - `path` string
    - object: Details of any flooding risks to the property including their source
      - `op` 'replace' | 'test' | 'add' | 'remove'
      - `value` 'River' | 'Sea' | 'Groundwater' | 'Lake' | 'Reservoir' | 'Other'
      - `path` string
    - object: Details of any flooding risks to the property including their source
      - `op` 'replace' | 'test' | 'add' | 'remove'
      - `value` boolean
      - `path` string
    - object: Details of any flooding risks to the property including their source
      - `op` 'replace' | 'test' | 'add' | 'remove'
      - `value` boolean
      - `path` string
    - object: Any planning considerations that are known
      - `op` 'replace' | 'test'
      - `value` string
      - `path` string
    - object: How the property can be heated
      - `op` 'replace' | 'test' | 'add' | 'remove'
      - `value` 'BiomassBoiler' | 'Communal' | 'ElectricMains' | 'ElectricRoomHeaters' | 'GasMains' | 'HeatPumpAirSource' | 'HeatPumpGroundSource' | 'Lpg' | 'NightStorageHeaters' | 'Oil' | 'Other' | 'SolarPanels' | 'SolarPhotovoltaicThermal' | 'SolarThermal' | 'UnderFloorHeating' | 'WoodBurner' | 'OpenFire'
      - `path` string
    - object: What mining risks the property is exposed to
      - `op` 'replace' | 'test' | 'add' | 'remove'
      - `value` boolean
      - `path` string
    - object: What mining risks the property is exposed to
      - `op` 'replace' | 'test' | 'add' | 'remove'
      - `value` boolean
      - `path` string
    - object: The mobile coverage for the property
      - `op` 'replace' | 'test'
      - `value` string
      - `path` string
    - object: The parking facilities available to the property
      - `op` 'replace' | 'test' | 'add' | 'remove'
      - `value` 'DoubleGarage' | 'OffStreetParking' | 'ResidentsParking' | 'SingleGarage' | 'Underground' | 'CommunalCarParkAllocatedSpace' | 'CommunalCarParkNoAllocatedSpace' | 'DisabledParkingAvailable' | 'DisabledParkingNotAvailable' | 'DrivewayPrivate' | 'DrivewayShared' | 'EvChargingPrivate' | 'EvChargingShared' | 'Garage' | 'GarageBloc' | 'GarageCarport' | 'GarageDetached' | 'GarageIntegral' | 'GatedParking' | 'NoParkingAvailable' | 'RearOfProperty' | 'StreetParkingPermitNotRequired' | 'StreetParkingPermitRequired' | 'Undercroft' | 'UndergroundParkingAllocatedSpace' | 'UndergroundParkingNoAllocatedSpace' | 'Other'
      - `path` string
    - object: Any restrictions on the property's use
      - `op` 'replace' | 'test' | 'add' | 'remove'
      - `value` boolean
      - `path` string
    - object: Any restrictions on the property's use
      - `op` 'replace' | 'test' | 'add' | 'remove'
      - `value` boolean
      - `path` string
    - object: Any restrictions on the property's use
      - `op` 'replace' | 'test' | 'add' | 'remove'
      - `value` boolean
      - `path` string
    - object: Any restrictions on the property's use
      - `op` 'replace' | 'test' | 'add' | 'remove'
      - `value` boolean
      - `path` string
    - object: Any restrictions on the property's use
      - `op` 'replace' | 'test' | 'add' | 'remove'
      - `value` boolean
      - `path` string
    - object: Any restrictions on the property's use
      - `op` 'replace' | 'test' | 'add' | 'remove'
      - `value` boolean
      - `path` string
    - object: Any restrictions on the property's use
      - `op` 'replace' | 'test' | 'add' | 'remove'
      - `value` boolean
      - `path` string
    - object: Any restrictions on the property's use
      - `op` 'replace' | 'test' | 'add' | 'remove'
      - `value` boolean
      - `path` string
    - object: Any restrictions on the property's use
      - `op` 'replace' | 'test' | 'add' | 'remove'
      - `value` boolean
      - `path` string
    - object: Any restrictions on the property's use
      - `op` 'replace' | 'test' | 'add' | 'remove'
      - `value` boolean
      - `path` string
    - object: Any restrictions on the property's use
      - `op` 'replace' | 'test' | 'add' | 'remove'
      - `value` boolean
      - `path` string
    - object: Any rights or easements over the property
      - `op` 'replace' | 'test'
      - `value` boolean
      - `path` string
    - object: Any rights or easements over the property
      - `op` 'replace' | 'test'
      - `value` boolean
      - `path` string
    - object: Any rights or easements over the property
      - `op` 'replace' | 'test'
      - `value` boolean
      - `path` string
    - object: Any rights or easements over the property
      - `op` 'replace' | 'test'
      - `value` boolean
      - `path` string
    - object: Any rights or easements over the property
      - `op` 'replace' | 'test'
      - `value` boolean
      - `path` string
    - object: Any rights or easements over the property
      - `op` 'replace' | 'test'
      - `value` boolean
      - `path` string
    - object: Any rights or easements over the property
      - `op` 'replace' | 'test'
      - `value` boolean
      - `path` string
    - object: Any rights or easements over the property
      - `op` 'replace' | 'test'
      - `value` boolean
      - `path` string
    - object: Details of the property's sewerage
      - `op` 'replace' | 'test' | 'add' | 'remove'
      - `value` 'Mains' | 'SepticTank' | 'DomesticSmallSewageTreatmentPlants' | 'Cesspit' | 'Cesspool' | 'Other'
      - `path` string
    - object: The water supplies available to the property
      - `op` 'replace' | 'test' | 'add' | 'remove'
      - `value` 'Mains' | 'PrivateWell' | 'PrivateSpring' | 'PrivateBorehole' | 'PublicWell' | 'PublicSpring' | 'PublicBorehole' | 'Other'
      - `path` string
    - object: Current energy efficiency rating
      - `op` 'replace' | 'test'
      - `value` integer
      - `path` string
    - object: Potential energy efficiency rating
      - `op` 'replace' | 'test'
      - `value` integer
      - `path` string
    - object: Whether listing has an EPC Exemption
      - `op` 'replace' | 'test'
      - `value` boolean
      - `path` string
    - object: Reason for an EPC Exemption
      - `op` 'replace' | 'test'
      - `value` string
      - `path` string
    - object: The UPRN for the property
      - `op` 'replace' | 'test'
      - `value` string
      - `path` string
    - object: The inventory price, either sale or rental price depending on the property type
      - `op` 'replace' | 'test'
      - `value` number
      - `path` string
    - object: The Property Advert Summary
      - `op` 'replace' | 'test'
      - `value` string
      - `path` string

## Response `204`

No Content

## Other responses

- `400`: Bad Request
- `404`: Not Found

---

[API](https://skmtc.dev/alto/apis/alto-api.md) - [All operations](https://skmtc.dev/alto/apis/alto-api/llms.txt) - [OpenAPI document](https://skmtc.dev/alto/apis/alto-api/revisions/1b729d9b15a8?raw)