Search
K
[dev] 🇫🇷 Seeker Leads

propertysearchLeadMetadata

leadIdstringrequired
ingestionDatenumberrequired

Unix timestamp in seconds, indicates when the lead was processed

portalstringrequired

The portal(brand) where the lead was created.

  • BDS-FRA: Belles Demeures France
  • IMN-DEU: Immonet Germany
  • IWB-BEL: Immoweb Belgium
  • IWT-DEU: Immowelt Germany
  • YSQ-DEU: Yoursquares Germany
  • IWT-AUT: Immowelt Austria
  • LCI-FRA: La Cote Immo France
  • LIM-FRA: Logic-Immo France
  • LIC-FRA: Logic-Immo Construire France
  • LIN-FRA: Logic-Immo Neuf France
  • LUX-FRA: Luxe Residence France
  • MAG-FRA: Meilleurs Agents France
  • SLG-FRA: Se Loger France
  • BCM-FRA: Se Loger Bureaux et Commerces France
  • SLC-FRA: Se Loger Construire France
  • SLN-FRA: Se Loger Neuf France
  • SIG-DEU: Signify Germany
  • SIG-FRA: Signify France

Allowed values:BDS-FRAIMN-DEUIWB-BELIWT-DEUIWT-AUTLCI-FRALIM-FRALIC-FRALIN-FRALUX-FRAMAG-FRASLG-FRABCM-FRASLC-FRASLN-FRAYSQ-DEUSIG-DEUSIG-FRA

TTLnumberrequired

Time To Live. Unix timestamp in seconds, after which the lead should be deleted from all systems. Legally 3 years after creation.

leadCategorystringrequired

Allowed values:PROPERTY_SEARCH

Example

propertyMetadata

object
classifiedIdstring
offererEstateIdstring

unique identifier of the classified assigned by the sender (publisher) software system.

<= 512 characters

offererMarketingKeystring

the human readable key of a real estate classified given by the offerer (e.g. real estate agent) within the sender software.

<= 512 characters

projectIdstring

Project ID ( available for new build project units)

<= 512 characters

projectOffererEstateIdstring

unique identifier of the classified assigned by the sender (publisher) software system.
The “projectOffererEstateId” is the id of the Program (building) which contains the Plot (apartment) for which the seeker
sent a contact request.

<= 512 characters

projectOffererMarketingKeystring

the human readable key of a real estate classified given by the offerer (e.g. real estate agent) within the sender software for the parent classified.

<= 512 characters

Example

psearchMetadata

object
estateTypearray[string]

Allowed values:HOUSEAPARTMENTPLOTBUILDINGOFFICETRADINGGASTRONOMY_HOTELSTORAGE_PRODUCTIONAGRICULTURE_FORESTRYPARKINGSENIORPROJECTMISCELLANEOUS

roomsobject

The number of rooms as specified by the seeker (numberOfRoomsMin filled first if only one value is specified).

Show Child Parameters
spacesobject

The surface area as specified by the seeker (spaceMin filled first if only one value is specified).

Show Child Parameters
budgetobject

The budget range as specified by the seeker (amountMax filled first if only one value is specified).

Show Child Parameters
geoobject

The geographical criteria as specified by the seeker.

Show Child Parameters
Example

projectMetadata

object
commercialobject
Show Child Parameters
buildobject
Show Child Parameters
Example

classifiedLead

object
metadataobjectrequired
Show Child Parameters
contactRequestobjectrequired

The data of the User who created the contact.
In rare cases, the User may have requested to delete their account / data on our Portals for GDPR Reasons.
In those cases:

  • the contact data fields (firstName, lastName, message, name, gender, language) will be set with null fields
  • the phoneNumbers will be replaced with an empty array: []
Show Child Parameters
propertyobjectrequired
Show Child Parameters
Example