--- title: "Creates or updates a residential listing" method: PUT path: "/v1/listings/residential" tags: ["Listings"] --- # Creates or updates a residential listing `PUT /v1/listings/residential` ## Request body - DomainListingAdminServiceV1ModelResidentialListing — Residential Listing - `lifeStyleType` 'firstHome' | 'investment' | 'retirement' | 'seaChange' | 'treeChange' | 'youngFamilies' — Lifestyle type - `listingAction` 'sale' | 'rent' | 'saleAndLease' — Sale or Rent - `contactPreference` 'byPhone' — Indicates the listing preferred contact method. Default by both phone and email if not provided. - `underOfferOrContract` boolean — Set for Sale listings only - `auction` DomainListingAdminServiceV1ModelAuction — Auction Details - `dateTime` string, date-time — Date of the auction. format: yyyy-MM-ddTHH:mm:ss - `location` string — Optional. Venue for the Auction. String max 100 characters. If the Location is omitted, or included but empty, the Venue will default to \"On Site\". - `url` string — Optional on-line auction URL. Must be a valid URL and maximum 255 characters. If an empty string is received, the property will be re-set. - `bond` integer — Optional. Ignored for sale listings - `availableFrom` string, date-time — Optional. Sets the Date from which a Rental or Share property is available. Date format: yyyy-mm-dd - `propertyDetails` DomainListingAdminServiceV1ModelResidentialProperty — Residential Property - `propertyType` string[] — 'Retirement' requires at least one more property type to be specified with it (for example: \"Retirement\", \"ApartmentUnitFlat\") ['acreageSemiRural', 'apartmentUnitFlat', 'aquaculture', 'blockOfUnits', 'carSpace', 'dairyFarming', 'developmentSite', 'duplex', 'farm', 'fishingForestry', 'newHomeDesigns', 'house', 'newHouseLand', 'irrigationServices', 'newLand', 'livestock', 'newApartments', 'penthouse', 'retirement', 'rural', 'semiDetached', 'specialistFarm', 'studio', 'terrace', 'townhouse', 'vacantLand', 'villa', 'cropping', 'viticulture', 'mixedFarming', 'grazing', 'horticulture', 'equine', 'farmlet', 'orchard', 'ruralLifestyle']. - `bedRooms` integer — Number of bedrooms - `bathRooms` integer — Number of bathrooms - `parkingInfo` DomainListingAdminServiceV1ModelParkingInfo — Parking Details - `details` DomainListingAdminServiceV1ModelParkingDetails[] — Details for available parking spaces - `parkingType` 'onSite' | 'onStreet' | 'noParking' | 'garage' | 'carport' | 'outdoor' — Can have the value \"OnSite\", \"OnStreet\", \"NoParking\". Default: \"NoParking\" - `numberOfSpaces` integer — Number of parking spaces on site - `information` string — Additional information regarding the parking condition - `energyEfficiencyRating` number, double — Optional, although must be set for ACT dwellings for sale. Valid values range from 0 to 10 inclusive, in increments of 0.5 - `pdfs` DomainListingAdminServiceV1ModelPropertyPdf[] — List of PDF files related to the listing - `type` 'commercialPdf' | 'newDevBrochurePdf' | 'floorplanPdf' | 'devProjectPdf' — Type of the PDF - `url` string — Url of the PDF - `description` string — Description of the PDF - `isMarkedForLiveability` boolean — Is the property liveability compliant - `propertyName` string — Name of the property up to 70 characters - `location` string — Short location information up to 30 character, e.g.: Greenhills Beach - `images` DomainListingAdminServiceV1ModelPropertyMedia[] — List of image files, photos or floor plans related to the listing. - `resourceType` 'photograph' | 'floorPlan' | 'video' | 'virtualTour' | 'webLink' — Type of the resource - `url` string — shows the place from where file can be downloaded - `address` DomainListingAdminServiceV1ModelAddress — Address structure for property - `displayOption` 'unspecified' | 'fullAddress' | 'streetAndSuburb' | 'suburbOnly' | 'regionOnly' | 'areaOnly' | 'stateOnly' — What granularity to display the properties location at. For residential listings, the accepted displayOption values are `FullAddress`, `StreetAndSuburb` or `SuburbOnly`. - `state` 'nsw' | 'vic' | 'act' | 'sa' | 'wa' | 'tas' | 'qld' | 'nt' — State - `unitNumber` string — Unit number for apartments, maximum 30 characters - `street` string — Street name, maximum 100 characters - `suggestedGeoLocation` DomainListingAdminServiceV1ModelGeoLocation — Contains geocoding of an address - `latitude` number, double — Latitude - `longitude` number, double — Longitude - `streetNumber` string — Street number, maximum 20 characters - `suburb` string — Suburb name , maximum 50 characters - `postcode` string — Postcode - `area` DomainListingAdminServiceV1ModelArea — Area information, Either single value or from and To must be provided - `unit` 'squareMetres' | 'acres' | 'hectares' | 'squareFeet' | 'squareYards' | 'squares' — Unit of measure, defaults to SquareMetres if not provided. - `value` number, double — Area. Will be rounded to 2 decimals. - `from` number, double — Minimum area - `to` number, double — Maximum area - `landArea` DomainListingAdminServiceV1ModelLandArea — Area information, Either single value or from and To must be provided - `unit` 'squareMetres' | 'acres' | 'hectares' | 'squareFeet' | 'squareYards' | 'squares' — Unit of measure - `value` number, double — Area. Will be rounded to 2 decimals. - `from` number, double — Minimum area - `to` number, double — Maximum area - `isNewDevelopment` boolean — True if the property is a new development - `statementOfInformation` DomainListingAdminServiceV1ModelStatementOfInformation — Statement of Information Regarding sale listing - `estimatedPrice` DomainListingAdminServiceV1ModelBasicPrice — Basic price information - `from` integer — Lowest price the property is expected to sell/rent for to set search price. For a fixed price, set this value the same as To - `to` integer — Highest price the property is expected to sell/rent for to set search price. For a fixed price, set this value the same as From - `comparableData` DomainListingAdminServiceV1ModelComparableData — Information regarding past comparable property sales that influenced the setting of teh estimationPrice - `comparableProperty` DomainListingAdminServiceV1ModelPastSaleData[] — To be comparable, property must be Of a similar standard or condition to the property for sale And Sold in the last six months and be within two kilometres of the property for sale (if the property for sale is in the Melbourne metropolitan area) Or Sold in the last 18 months and be within five kilometres of the property for sale (if the property for sale is outside the Melbourne metropolitan area). - `address` DomainListingAdminServiceV1ModelPastSaleAddress — Address for past sold listing - `state` 'nsw' | 'vic' | 'act' | 'sa' | 'wa' | 'tas' | 'qld' | 'nt' — State - `unitNumber` string — Unit number for apartments, maximum 30 characters - `streetNumber` string — Street number, maximum 20 characters - `street` string — Street name, maximum 100 characters - `suburb` string — Suburb name , maximum 50 characters - `postcode` string — Postcode - `dateOfSale` string, date-time — Registered date of the sale - `soldPrice` integer — Price property has been sold - `declarationText` string — Text description should be provided If you reasonably believe that there are less than three comparable sales within the prescribed period outlined above for ComparableProperty {Domain.Listing.Admin.Model.Entities.ComparableData.ComparableProperty} Required when no past sale property data was provided - `suburbMedianPrice` DomainListingAdminServiceV1ModelMedianPriceData — Information regarding median house/unit price for the suburb - `priceType` 'house' | 'apartmentUnitFlat' | 'vacantLand' — Type of property this median price is based on . - `suburb` string — Name of the suburb median price is based on. - `postcode` string — Postcode of the suburb - `medianPrice` integer — Median price for the suburb . - `source` string — Where the Median Price come from - `sourceDateFrom` string, date-time — Median Price Source Data From Date - `sourceDateTo` string, date-time — Median Price Source Data To Date - `declarationText` string — Declaration text should be provided when no median price data available - `documentationUrl` string — Link to the statement of information documentation file. Must be a PDF file. File should be less than 10 MB in size The Statement of Information must be updated if there is a change in the indicative selling price. - `price` DomainListingAdminServiceV1ModelPrice — Pricing Information - `displayText` string — When provided this will be shown instead of the price range, e.g.: \"Offers over $450K considered\" - `from` integer — Lowest price the property is expected to sell/rent for to set search price. For a fixed price, set this value the same as To - `to` integer — Highest price the property is expected to sell/rent for to set search price. For a fixed price, set this value the same as From - `project` DomainListingAdminServiceV1ModelListingProject — Listing development project details. - `id` integer — Domain's development project identifier. If the value is not provided, the listing will be unlinked. - `order` integer — Listing's order. If the value is not provided, the listing will be last. - `domainAdId` integer — Domain Advertisement Id, not applicable for creating new ads. Mandatory when updating a listing that belongs to an agency that is in the process of being migrated between listing providers. - `domainAgencyID` integer — The Domain Agency Id number - `providerAdId` string — External Advertisement Id of up to 50 characters will be stored.<br /> This value is used to identify an Advertisement for updates and should be unique for listing provider.<br /> This value is case-insensitive (meaning AAAA will update aaaa). - `features` string — Comma-separated list of features. 1000 characters in length. Select as appropriate or write your own. INSIDE: Air conditioning, Ensuite, Floorboards, Indoor Spa, Gym, Alarm System, Intercom, Built in wardrobes, Furnished, Internal Laundry, Pets allowed, Cable or Satellite, Gas, Broadband internet access, Bath, Fireplace(s), Separate Dining Room, Heating, Dishwasher, Study. OUTSIDE: Tennis Court, Secure Parking, Shed, Fully fenced, Balcony / Deck, Garden / Courtyard, Swimming Pool, Outdoor Spa. LOCATION: Ground floor, Water Views, North Facing, City Views. ECO FRIENDLY: Double glazed windows, Energy efficient appliances, Water efficient appliances, Wall / ceiling insulation, Rainwater storage tank, Greywater system, Water efficient fixtures, Solar hot water, Solar panels - `description` string — Description of the property. 6000 characters in length. The following HTML elements are permitted: &lt;br /&gt;, &lt;p&gt;&lt;/p&gt;, &amp;nbsp;. HTML must be well-formed. Carriage Returns are interpreted as line breaks. Foreign characters must be HTML encoded, e.g., façade for façade. Unicode characters which are unsupported by Latin-1 (ISO-8859-1 range from U+0080 to U+00FF), will be removed https://en.wikipedia.org/wiki/ISO/IEC_8859-1 - `summary` string — 'Headline' Any HTML stripped out. If the Summary is less than 80 characters long then the description is concatenated to it and the total trimmed to 250 characters. - `inspectionDetails` DomainListingAdminServiceV1ModelInspectionDetails — Inspection details - `inspectionDescription` string — Free text field for inspections - `inspections` DomainListingAdminServiceV1ModelInspection[] — Inspection times of the listing - `from` string, date-time — Format: yyyy-mm-dd HH:mm:ss eg: 2015-10-20 13:30:00 - `to` string, date-time — Format: yyyy-mm-dd HH:mm:ss, eg: 2015-10-20 14:30:00 - `repeat` boolean — Specifies if the inspection is recurring weekly - `media` DomainListingAdminServiceV1ModelPropertyMedia[] — Links to VideoURL, virtual tour or weblink. Maximum length of media URLs is 255 characters. - `resourceType` 'photograph' | 'floorPlan' | 'video' | 'virtualTour' | 'webLink' — Type of the resource - `url` string — shows the place from where file can be downloaded - `contacts` DomainListingAdminServiceV1ModelContact[] — Minimum required attributes: First name, last name and E-mail. If the DomainAgentId is provided, contact information will be based on the existing agent found for that id. Otherwise first name, last name and email will be used to find the matching contact. A new contact will be created if no contact can be found. - `domainAgentId` integer — Domain ID of the contact person at the agency - `firstName` string — First name. Maximum 50 characters. - `lastName` string — Last name. Maximum 50 characters. - `phone` string — Phone. Maximum 20 characters. - `fax` string — Fax. Maximum 20 characters. - `mobile` string — Mobile. Maximum 20 characters. - `email` string — Email. Maximum 100 characters. - `receiveEmails` boolean — Indicates whether the contact person should receive emails for the listing - `otherEnquiryEmail` string — Sets an additional Email Address to which enquiries on the Listing will be sent - `receiveEmailsToDefaultAddress` boolean — Send email enquiries to the default address for this listing type - `isRural` boolean — True if the property is rural - `supplementary` DomainListingAdminServiceV1ModelListingSupplementary[] — Rural attributes *Improvements* (optional) Available `types` (fixed list, optional): * Machinery Shed * Shearing Shed * Workshop * Shearers Quarters * Silos * Other Housing * Managers Accommodation *Fencing* (optional) `description` (string, optional): free text fencing description, maximum 250 characters. *Yards* (optional) Available `types` (fixed list, optional): * Sheep * Cattle *Homestead* (optional) `description` (string, optional): description of the homestead and construction, maximum 250 characters. `metadata` (optional) * `area` (decimal, optional): homestead area in square metres. Available `types` (fixed list, optional): * Office * Ensuite * Tennis Court * Mains Gas * Floorboards * Internal Laundry *Water* (optional) `description` (string, optional): water comments, maximum 250 characters. Available `types` (fixed list, optional): * Tank * Well * Reticulated * Bores * Springs * Creeks * Dams * River *Crops* (optional) `description` (string, optional): description of the crops, maximum 250 characters. `metadata` (optional) * `croppedAnnually` (decimal, optional): average annual area cropped in hectares. * `fallowAnnually` (decimal, optional): average annual fallow area in hectares. * `pastures` (string, optional): description of pastures available, maximum 250 characters. *Livestock* (optional) `description` (string, optional): additional comments, maximum 250 characters. `metadata` (optional) * `capacity` (decimal, optional): property carrying capacity in DSE (unit of carry capacity). Available `types` (fixed list, optional): * Sheep * Pigs * Cattle * Poultry * Horses * Exotic * Goats * Stud *Inclusions* (optional) `description` (string, optional): description of plant and machinery included in sale, maximum 250 characters. `metadata` (optional) * `livestock` (string, optional): description of livestock included in sale, maximum 250 characters. * `crop` (string, optional): description of crops included in sale, maximum 250 characters. *Irrigation* (optional) `description` (string, optional): irrigation comments, maximum 250 characters `metadata` (optional) * `rainfall` (decimal, optional): annual rainfall in millimetres. - `name` string — Name - `description` string — Description - `types` string[] — Types - `metadata` DomainListingAdminServiceV1ModelSupplementaryMetadata[] — Metadata - `measurementUnit` 'squareMetres' | 'hectares' | 'millimetres' | 'dse' — Measurement unit - `name` string — Name - `description` string — Description - `measurement` number, double — Measurement ## Response `200` Ok - DomainListingAdminServiceV1ModelListingResponse — Represent the listing job. - `processStatus` 'queued' | 'processing' | 'processed' | 'searchable' | 'failed' | 'error' — Status of listing been processed - `id` string — The listing job Id. This job will eventually be processed. - `agencyId` integer — Agency Id from Domain. - `providerId` string — Provider Id for the agency. - `providerAdId` string — Listing identifier provided by CRM. - `versionId` string — Version Id ## Other responses - `202` — Accepted --- [API](https://skmtc.net/domain/apis/domain-public-api.md) · [All operations](https://skmtc.net/domain/apis/domain-public-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/domain/domain-public-api/revisions/839de6c29cc3/schema)