Search
K
Listing Creation

ListingStatus

string

Lifecycle of a listing.

Allowed values:in_progresscompletedpublishedwithdrawnfailed

Example

Channel

string

Publication channel.

Allowed values:portalwebsitenewslettershop_window

Section

string

Content block of the listing.

Allowed values:locationfeaturesenergyfloor_plancommissionneighborhoodhistory

CreateListingRequest

object
property_idstringrequired

Property the listing is generated from.

Example:prop_8f2c1a

template_idstringrequired

Design template of the agency.

Example:tpl_classic

languagestring

Language of the generated document. Useful when marketing to international buyers.

Allowed values:enesfrde

Default:en

sectionsarray[string]

Content block of the listing.

Allowed values:locationfeaturesenergyfloor_plancommissionneighborhoodhistory

internal_notestring

Internal remark; does not appear in the document.

<= 500 characters

Example:Owner prefers viewings starting September 1st.

Example

Listing

object
idstring

Example:lst_4d9b2e

property_idstring

Example:prop_8f2c1a

template_idstring

Example:tpl_classic

languagestring

Example:en

statusstring

Lifecycle of a listing.

Allowed values:in_progresscompletedpublishedwithdrawnfailed

Example:completed

pdf_urlstring(uri)

Only set once status: completed. The link is valid for 24 hours.

Example:https://api.realestateagency.example/v1/listings/lst_4d9b2e/pdf

pagesinteger

Page count of the generated document.

Example:6

disclosuresobject

Result of the mandatory-disclosure check.

Show Child Parameters
created_atstring(date-time)

Example:2026-08-20T09:41:12Z

completed_atstring(date-time)

Example:2026-08-20T09:41:20Z

Example