v1
latestOpenAPI 3.0.42026-08-04108409993.8 KBCreates or updates a residential listing
Request body
Lifestyle type
Sale or Rent
Indicates the listing preferred contact method. Default by both phone and email if not provided.
Set for Sale listings only
Optional. Ignored for sale listings
Optional. Sets the Date from which a Rental or Share property is available. Date format: yyyy-mm-dd
True if the property is a new development
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.
The Domain Agency Id number
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).
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
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
'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.
Sets an additional Email Address to which enquiries on the Listing will be sent
Send email enquiries to the default address for this listing type
True if the property is rural
Response
Ok
Status of listing been processed
The listing job Id. This job will eventually be processed.
Agency Id from Domain.
Provider Id for the agency.
Listing identifier provided by CRM.
Version Id