Adscore

# Qualifier un lead

Cette documentation fournit des exemples indicatifs pour la qualification d'un lead. Adscore s'adapte aux besoins spécifiques de chaque client en se connectant aux systèmes via des passerelles sur mesure, permettant une intégration fluide et sécurisée des données. Vous trouverez ici des exemples de requêtes et de réponses standard pour transmettre et recevoir les informations de qualification des leads.

# Demander la qualification un lead

Permet de transmettre une demande de qualification pour un lead.

WARNING

Les leads sont dédoublonnés automatiquement à partir de leur numéro de téléphone et de leur adresse e-mail.

Le dédoublonnage peut être effectif au niveau de l'espace client ou d'un programme, selon la configuration en place.

# Requête HTTP

POST https://api.adscore.immo/v1/{tenantKey}/leads

# Paramètres d'URL

Nom de la clé Description
{tenantKey} Clé de l'espace client - Détails

# curl

curl --location --request POST 'https://api.adscore.immo/v1/{tenantKey}/leads' \
    --header 'Accept: application/json' \
    --header 'Content-Type: application/json' \
    --header 'Content-Length: ###' \
    --header 'X-API-Key: VOTRE_CLE_API' \

# Paramètres de Body

DANGER

Certains champs sont obligatoires, veillez à ce que ces derniers soient tous correctement remplis :

  • A minima un moyen de contact (téléphone ou e-mail) pour le lead
  • L'ID externe du programme ainsi que son nom et sa ville

# Exemple

{
  "lead": {
    "external_id": "00000000",
    "name": "Dupont",
    "firstname": "Jean",
    "email1": "jean.dupont@gmail.com",
    "phone1": "0600000000",
    "phone2": "0100000000",
    "tracking_origin": "landing",
    "tracking_source": "google",
    "tracking_medium": "cpc",
    "tracking_campaign": "relance-140921"
  },
  "program": {
    "external_id": "2365",
    "name": "Nom du programme",
    "city": "Neuilly-sur-Seine",
    "zipcode": "92200"
  },
  "sellers": [
    {
      "email": "commercial@client-a.com"
    }
  ]
}

# Body de réponse

DETAILS 
{
    "success": true,
    "message": "Demande prise en compte",
    "body": {
        "initial_payload": {
            "lead": {
                "external_id": "00000000",
                "name": "Dupont",
                "firstname": "Jean",
                "email1": "jean.dupont@gmail.com",
                "phone1": "0600000000",
                "phone2": "0100000000",
                "tracking_origin": "landing",
                "tracking_source": "google",
                "tracking_medium": "cpc",
                "tracking_campaign": "relance-140921"
            },
            "program": {
                "external_id": "2365",
                "name": "Nom du programme",
                "city": "Neuilly-sur-Seine",
                "zipcode": "92200"
            },
            "sellers": [
                {
                    "email": "commercial@client-a.com"
                }
            ]
        },
        "skipped_fields": [],
        "processed_fields": {
            "lead": {
                "external_id": "00000000",
                "name": "Dupont",
                "firstname": "Jean",
                "email1": "jean.dupont@gmail.com",
                "phone1": "0600000000",
                "phone2": "0100000000",
                "tracking_origin": "landing",
                "tracking_source": "google",
                "tracking_medium": "cpc",
                "tracking_campaign": "relance-140921"
            },
            "program": {
                "external_id": "2365",
                "name": "Nom du programme",
                "city": "Neuilly-sur-Seine",
                "zipcode": "92200"
            },
            "sellers": [
                {
                    "name": "Jourdain",
                    "firstname": "Antoine",
                    "email": "commercial@client-a.com",
                }
            ]
        }
    },
    "data": null
}

# Modèle

# Noeud lead

Noeud Champ Type Description Exemple Format des données
lead external_id string Identifiant externe du lead
lead title string Civilité mr ms mr = Monsieur / ms = Madame
lead name string Nom Dupont
lead firstname string Prénom Jean
lead email1 string Adresse e-mail jean.dupont@gmail.com
lead email2 string Adresse e-mail secondaire jean.dupont@gmail.com
lead phone1 string Téléphone 33600000000 0600000000 Format international ou français
lead phone2 string Téléphone secondaire 33600000000 0600000000 Format international ou français
lead optin boolean Optin true false true = consentement donné
lead project string Type de projet home investment Accéder au tableau
lead investment_scheme string Dispositif d'investissement pinel lnmp Accéder au tableau
lead typology array Nombre de pièces recherchées ["T3", "T4"] Accéder au tableau
lead budget float Budget maximum 350000.00
lead meta_data object Meta-données Intégration sur-mesure
lead tracking_origin string Canal d'origine landing call Accéder au tableau
lead tracking_source string Tracking - Source (utm) google Paramètres UTM (opens new window)
lead tracking_medium string Tracking - Support (utm) cpc Paramètres UTM (opens new window)
lead tracking_campaign string Tracking - Campagne (utm) relance-140920 Paramètres UTM (opens new window)
lead tracking_content string Tracking - Contenu (utm) logo-link Paramètres UTM (opens new window)

# Noeud programme

Noeud Champ Type Description Exemple Format des données
program external_id string Identifiant externe du programme
program name string Nom Les Jardins de Neuilly
program city string Ville Neuilly-sur-Seine
program zipcode string Code postal 92200

# Noeud sellers (commerciaux)

Noeud Champ Type Description Exemple Format des données
sellers.* name string Nom du commercial Jourdain
sellers.* firstname string Prénom du commercial Antoine
sellers.* email string Adresse e-mail du commercial jourdain.antoine@client-a.com

# Annexes

# Canal d'origine

Liste des canaux d'origine

DETAILS 
[
  {
    "key": "landing",
    "name": "Landing"
  },
  {
    "key": "corporate-website",
    "name": "Site institutionnel"
  },
  {
    "key": "portal",
    "name": "Portail immobilier"
  },
  {
    "key": "lead-ads",
    "name": "Lead Ads"
  },
  {
    "key": "lead-acquisition",
    "name": "Achat de lead"
  },
  {
    "key": "sales-desk",
    "name": "Bureau de vente"
  },
  {
    "key": "call",
    "name": "Appel"
  },
  {
    "key": "network",
    "name": "Réseau"
  },
  {
    "key": "other",
    "name": "Autre"
  }
]

# Type de projet

Liste des types de projet

DETAILS 
[
  {
    "key": "home",
    "name": "Résidence principale"
  },
  {
    "key": "investment",
    "name": "Investissement"
  },
  {
    "key": "second-home",
    "name": "Résidence secondaire"
  }
]

# Dispositif d'investissement

Liste des dispositifs d'investissement

DETAILS 
[
  {
    "key": "pinel",
    "name": "Pinel"
  },
  {
    "key": "lmnp",
    "name": "LMNP"
  },
  {
    "key": "bare-ownership",
    "name": "Nue-propriété"
  },
  {
    "key": "patrimonial-investment",
    "name": "Investissement patrimonial"
  }
]

# Typologie

Liste des typologies

DETAILS 
[
  {
    "key": "T1",
    "name": "Studio"
  },
  {
    "key": "T2",
    "name": "2 pièces"
  },
  {
    "key": "T3",
    "name": "3 pièces"
  },
  {
    "key": "T4",
    "name": "4 pièces"
  },
  {
    "key": "T5",
    "name": "5 pièces"
  },
  {
    "key": "T6",
    "name": "6 pièces et +"
  }
]

← Exemple de résultat de qualification →