Sign in

v1

latestOpenAPI 3.0.42026-08-04108409993.8 KB
PreMarket

Patches a pre-portal listing.

patch/v2/premarket/listings/{id}

Path parameters

idstring required

Pre-portal listing ID.

Request body

contractResolverPreMarketV1IContractResolver

Response

Accepted

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>, &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

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.