Listing Creation

Overview

This API turns a property record into a finished, publication-ready listing - as a PDF and as a web view.

This API turns a property record into a finished, publication-ready listing - as a PDF and as a web view.

What it's for

  • Automatically generating listings as soon as a property is fully entered
  • Delivering multilingual versions of the same property
  • Checking, before publication, whether all mandatory disclosures are present
  • Withdrawing existing listings from individual channels on demand

What it's not for

The API doesn't maintain property data. Title, price, floor area and the energy certificate belong in Property Management; the listing reads them from there. That keeps a single source of truth, so a price change doesn't need to be repeated in multiple places.

States of a listing

StatusMeaning
in_progressGeneration is running, typically 2-10 seconds
completedPDF is ready, not yet published
publishedLive on at least one channel
withdrawnTaken off every channel, document remains available
failedGeneration aborted, reason is in disclosures.missing

Once generated, a listing is never modified afterwards. If the property changes, generate a new listing - that way it stays traceable which document a prospect was shown, and when.

Required scopes

CallScope
Read listings and templates, download PDFlistings:read
Create, publish or withdraw a listinglistings:write