Search
K
Listing Creation

Error

object

Uniform error format across all Real Estate Agency APIs.

codestringrequired

Example:mandatory_disclosure_missing

messagestringrequired

Example:Mandatory disclosures from the energy certificate are missing for publication.

detailsarray[object]
Show Child Parameters
Example

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