Sign in

v1

latestOpenAPI 3.0.42026-08-04108409993.8 KB
Listings

Creates an externally sold business listing; or takes an existing business listing off the market.

post/v2/listings/business/offmarket

Request body

listingProviderstring

A string identifying the data provider

domainAgencyIDinteger required

The Domain Agency ID

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

descriptionstring

Description of the property. 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. 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.

listingAction'sale' | 'rent' required

Sale or Rent

Response

Listing data hasn't been changed

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

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

Status of listing been processed