Search
K
[dev] 🇫🇷 Seeker Leads

agencyLead

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
Example

propertysearchLead

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
propertyobject
Show Child Parameters
projectobject
Show Child Parameters
distributionTypearray[string]required

Allowed values:BUYERSELLERLANDLORDTENANT

Example

phoneNumber

object
typestring

Type of phone number. Could be ignored as it should be MOBILE most of the time.

Allowed values:MOBILELANDLINE

Example:MOBILE

numberstring

Phone number, no format checks.

Example:+33511223344

verifiedboolean

Marks the given phone number as validated.

Example:true

Example

phoneNumberInput

object
typestring

Type of phone number. Could be ignored as it should be MOBILE most of the time.

Allowed values:MOBILELANDLINE

Example:MOBILE

numberstringrequired

Phone number

Match pattern:^[+]?[0-9() \/.\-]{6,21}[0-9]$

Example:+33511223344

Example

portal

string

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