---
title: "Creates an externally sold or leased residential listing; or takes an existing residential listing off the market."
method: POST
path: "/v2/listings/residential/offmarket"
tags: ["Listings"]
---

# Creates an externally sold or leased residential listing; or takes an existing residential listing off the market.

`POST /v2/listings/residential/offmarket`

## Request body

- ListingAdminV2ResidentialOffMarketListing — Residential off market listing
  - `listingProvider` string — A string identifying the data provider
  - `domainAgencyID` integer, required — The Domain Agency ID
  - `providerAdId` string, required — 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).
  - `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.
  - `contacts` ListingAdminV2Contact[] — 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
  - `listingAction` 'sale' | 'rent', required — Sale or Rent
  - `offMarketDetails` ListingAdminV2OffMarketDetailsBase, required — Off market details base
    - `offMarketAction` 'withDrawn' | 'sold' | 'leased', required — Off Market Action
    - `actionDate` string, date-time, required — The date property was sold, leased or withdrawn
    - `soldDetails` ListingAdminV2SoldDetails — Sold Details
      - `soldType` 'auction' | 'privateTreaty' | 'priorToAuction', required — Sold Type
      - `soldPrice` integer, required — Price property was sold for
      - `displaySoldPrice` boolean — Indicates how the price will be displayed for free to the general public, default to true if value not provided
    - `leasedDetails` ListingAdminV2LeasedDetails — Leased Details
      - `leasedPrice` integer — Optional. The weekly rental price.
      - `leasedDuration` integer — The duration of the lease in weeks.
    - `comment` string — Extra details for off market action
  - `propertyDetails` ListingAdminV2ResidentialOffMarketProperty, required — Residential off market property
    - `propertyType` string[], required — Residential property types<br /> '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` ListingAdminV2ParkingInfo — Parking Details
      - `details` ListingAdminV2ParkingDetails[] — Details for available parking spaces
        - `parkingType` 'onSite' | 'onStreet' | 'noParking' | 'garage' | 'carport' | 'outdoor', required — Can have the value "OnSite", "OnStreet", "NoParking". Default: "NoParking"
        - `numberOfSpaces` integer, required — Number of parking spaces on site
      - `information` string — Additional information regarding the parking condition
    - `images` ListingAdminV2PropertyMedia[] — List of image files, photos or floor plans related to the listing. Supported image file formats: AVIF, BMP, GIF, HEIF/HEIC, JPEG, JPEG 2000, PNG, TIFF, WebP. The file size is restricted to maximum 100MB. We recommend against using transparent backgrounds. Some image formats, such as PNG, support transparency, but when images with transparent areas are resized, they may be converted to a format that doesn’t support transparency, such as JPEG. By default, transparent areas are converted to black, but the application displaying the image may convert the transparent area to the most appropriate colour for the area where the image is being placed.
      - `resourceType` 'photograph' | 'floorPlan' | 'video' | 'virtualTour' | 'webLink' — Type of the resource
      - `url` string, required — shows the place from where file can be downloaded
    - `address` ListingAdminV2Address, required — Address structure for property
      - `unitNumber` string — Unit number for apartments, maximum 30 characters
      - `street` string, required — Street name, maximum 100 characters
      - `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".
      - `suggestedGeoLocation` ListingAdminV2GeoLocation — Contains geocoding of an address
        - `latitude` number, double — Latitude
        - `longitude` number, double — Longitude
      - `streetNumber` string — Street number, maximum 20 characters
      - `suburb` string, required — Suburb name , maximum 50 characters
      - `postcode` string, required — Postcode
      - `state` 'nsw' | 'vic' | 'act' | 'sa' | 'wa' | 'tas' | 'qld' | 'nt', required — State
    - `area` ListingAdminV2Area — Area information, Either single value or from and To must be provided
      - `value` number, double — Area. Will be rounded to 2 decimals.
      - `from` number, double — Minimum area
      - `to` number, double — Maximum area
      - `unit` 'squareMetres' | 'acres' | 'hectares' | 'squareFeet' | 'squareYards' | 'squares' — Unit of measure, defaults to SquareMetres if not provided.
    - `landArea` ListingAdminV2LandArea — Area information, Either single value or from and To must be provided
      - `unit` 'squareMetres' | 'acres' | 'hectares' | 'squareFeet' | 'squareYards' | 'squares', required — Unit of measure
      - `value` number, double — Area. Will be rounded to 2 decimals.
      - `from` number, double — Minimum area
      - `to` number, double — Maximum area

## Response `200`

Listing data hasn't been changed

- ListingAdminV2ListingResponse — Represent the listing job.
  - `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
  - `processStatus` 'queued' | 'processing' | 'processed' | 'searchable' | 'failed' | 'error' — Status of listing been processed

## Other responses

- `202` — Listing data has been accepted
- `400` — Listing data is not valid

---

[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/versions/24ab78aba827/schema)