AddressLocators1

Agencies7

Agents5

AgentSearch1

AuctionCollection2

Authorities8

AvmHistory1

CampaignReporting3

Dataset1

Demographics1

Disclaimers2

Enquiries3

Leadscope1

Listings16

ListingSearch2

Locations1

Me3

PreMarket3

Products8

Projects6

Properties10

PropertyAvm2

PropertyFeatures1

PropertyLike1

PropertyRadar9

PropertySearch1

PropertyZoningPerils1

SalesResults5

Schools2

Statistics5

Webhooks4

PreMarket

Creates or updates a pre-portal listing.

Changed on Apr 24, 2024

post/v2/premarket/listings

Request

Base URL
https://api.domain.com.au
Auth
- API key in header x-api-key
- or OAuth 2
  Authorization codehttps://auth.domain.com.au/v1/connect/authorize
  Client credentials
  Token URLhttps://auth.domain.com.au/v1/connect/token
  Scopesapi_listings_write
TypeScript
https://skmtc.dev/domain/apis/domain-public-api/docs/v2/premarket/listings/post.ts
A function with typed inputs. Its response is checked against the schema.

Request body

listingStatus'preMarket' | 'sold' | 'listed' | 'withdrawn' | 'draft' required

domainAgencyIdinteger required

The Domain agency ID. Must match an existing Domain agency ID.

listingProviderstring required

A string identifying the source of the listing.

providerAdIdstring required

External Advertisement Id of up to 50 characters will be stored. This value is correlated with actual Domain listing when it is created, and it should be unique for the listing provider. This value is case-insensitive (meaning AAAA will update aaaa).

bedroomsnumber float required

Number of bedrooms divisible by 0.5.

bathroomsnumber float required

Number of bathrooms divisible by 0.5.

carspacesnumber float required

Number of car spaces divisible by 0.5.

summarystring nullable

Headline of the advertisement. Any HTML will be stripped out.

descriptionstring nullable

Description of the property. Allow up to 6000 characters in length. The following HTML elements are permitted: <br />, <p></p>,   . 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

authorityExecutedDatestring date-time nullable

The date on which the authority contract was executed. The date must comply with the ISO 8601 and be in the UTC format, e.g. 2009-06-15T13:45:30.0000000Z.

reservePricenumber double nullable

Vendor reserve price.

propertyTypesPreMarketV1PropertyType[] required

The property types (e.g. house, apartment/unit/flat, etc.).

authorityType'privateSale' | 'auction' | 'expressionOfInterest'

exclusivePeriodDaysinteger nullable

The time (in days) that the agent has exclusive authority to sell the property.

exclusiveContinuingPeriodDaysinteger nullable

The time (in days) that exclusive authority has been extended.

exclusivePeriodStartDatestring date-time nullable

Start date of the exclusivity period. The date must comply with the ISO 8601 and be in the UTC format, e.g. 2009-06-15T13:45:30.0000000Z.

metadataobject nullable

Optional listing metadata.

commentstring nullable

Optional listing comment.

Response

Accepted

idstring required

Pre-portal listing ID.

Changes

Apr 24, 2024eee76e147314 Revision changes
- info
  api tag PreMarket added
- info
  api tag Premarket removed
Feb 28, 2023c4fc9a6df53a Revision changes
- breaking
  the / request property's minLength was increased from 0 to 1 (media type: application/json-patch+json)
- breaking
  the / request property's minLength was increased from 0 to 1 (media type: application/json)
- breaking
  the / request property's minLength was increased from 0 to 1 (media type: text/json)
- breaking
  the / request property's minLength was increased from 0 to 1 (media type: application/*+json)
- breaking
  the / request property's minLength was increased from 0 to 1 (media type: application/json-patch+json)
- breaking
  the / request property's minLength was increased from 0 to 1 (media type: application/json)
- breaking
  the / request property's minLength was increased from 0 to 1 (media type: text/json)
- breaking
  the / request property's minLength was increased from 0 to 1 (media type: application/*+json)
- breaking
  the / request property's minLength was increased from 0 to 1 (media type: application/json-patch+json)
- breaking
  the / request property's minLength was increased from 0 to 1 (media type: application/json)
- breaking
  the / request property's minLength was increased from 0 to 1 (media type: text/json)
- breaking
  the / request property's minLength was increased from 0 to 1 (media type: application/*+json)
- breaking
  the / request property's minLength was increased from 0 to 1 (media type: application/json-patch+json)
- breaking
  the / request property's minLength was increased from 0 to 1 (media type: application/json)
- breaking
  the / request property's minLength was increased from 0 to 1 (media type: text/json)
- breaking
  the / request property's minLength was increased from 0 to 1 (media type: application/*+json)
- breaking
  the // request property's minLength was increased from 0 to 1 (media type: application/json-patch+json)
- breaking
  the // request property's minLength was increased from 0 to 1 (media type: application/json)
- breaking
  the // request property's minLength was increased from 0 to 1 (media type: text/json)
- breaking
  the // request property's minLength was increased from 0 to 1 (media type: application/*+json)
- breaking
  the // request property's minLength was increased from 0 to 1 (media type: application/json-patch+json)
- breaking
  the // request property's minLength was increased from 0 to 1 (media type: application/json)
- breaking
  the // request property's minLength was increased from 0 to 1 (media type: text/json)
- breaking
  the // request property's minLength was increased from 0 to 1 (media type: application/*+json)
- breaking
  the // request property's minLength was increased from 0 to 1 (media type: application/json-patch+json)
- breaking
  the // request property's minLength was increased from 0 to 1 (media type: application/json)
- breaking
  the // request property's minLength was increased from 0 to 1 (media type: text/json)
- breaking
  the // request property's minLength was increased from 0 to 1 (media type: application/*+json)
- breaking
  the // request property's minLength was increased from 0 to 1 (media type: application/json-patch+json)
- breaking
  the // request property's minLength was increased from 0 to 1 (media type: application/json)
- breaking
  the // request property's minLength was increased from 0 to 1 (media type: text/json)
- breaking
  the // request property's minLength was increased from 0 to 1 (media type: application/*+json)
- breaking
  the request property's minLength was increased from 0 to 1 (media type: application/json-patch+json)
- breaking
  the request property's minLength was increased from 0 to 1 (media type: application/json)
- breaking
  the request property's minLength was increased from 0 to 1 (media type: text/json)
- breaking
  the request property's minLength was increased from 0 to 1 (media type: application/*+json)
- breaking
  the request property's minLength was increased from 0 to 1 (media type: application/json-patch+json)
- breaking
  the request property's minLength was increased from 0 to 1 (media type: application/json)
- breaking
  the request property's minLength was increased from 0 to 1 (media type: text/json)
- breaking
  the request property's minLength was increased from 0 to 1 (media type: application/*+json)
- breaking
  the / request property's minLength was increased from 0 to 1 (media type: application/json-patch+json)
- breaking
  the / request property's minLength was increased from 0 to 1 (media type: application/json)
- breaking
  the / request property's minLength was increased from 0 to 1 (media type: text/json)
- breaking
  the / request property's minLength was increased from 0 to 1 (media type: application/*+json)

Operation history

Creates or updates a pre-portal listing.

Request

Request body

Response 202Accepted

Changes

Response