v1

latestOpenAPI 3.0.42026-08-04108409993.8 KB
Listings

Creates or updates a business listing

put/v1/listings/business

Request body

listingAction'sale' | 'rent' | 'saleAndLease'

Sale or Rent

contactPreference'byPhone'

Indicates the listing preferred contact method. Default by both phone and email if not provided.

underOfferOrContractboolean

Set for Sale listings only

nabersnumber double

The NABERS Rating is the energy efficiency rating that the property has been measured to have. This rating is measured in increments of .5 and can range from 0 to 6. The NABERS rating is required for spaces within office buildings of 1000 square metres or more. For more information on the NABERS rating system please visit http://www.nabers.gov.au

freeholdCommercialAdIdinteger

The ad id of the commercial property with a freehold that the business belongs to. Leasehold and freehold are mutually exclusive properties, only specify one

domainAdIdinteger

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.

domainAgencyIDinteger

The Domain Agency Id number

providerAdIdstring

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).

featuresstring

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

descriptionstring

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

summarystring

'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.

otherEnquiryEmailstring

Sets an additional Email Address to which enquiries on the Listing will be sent

receiveEmailsToDefaultAddressboolean

Send email enquiries to the default address for this listing type

isRuralboolean

True if the property is rural

Response

Ok

processStatus'queued' | 'processing' | 'processed' | 'searchable' | 'failed' | 'error'

Status of listing been processed

idstring

The listing job Id. This job will eventually be processed.

agencyIdinteger

Agency Id from Domain.

providerIdstring

Provider Id for the agency.

providerAdIdstring

Listing identifier provided by CRM.

versionIdstring

Version Id