Adlead - Documentation

# Leads

# Ajouter un lead sur un programme

Permet de transmettre un lead sur un programme.

ATTENTION

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

En cas de doublon, la fiche déjà présente dans le CRM sera complétée avec les nouvelles informations.

Un kit d'intégration 🔗 est fourni pour illustrer ce cas d'usage : Transmission des leads 🔗.

# Requête HTTP

POST https://api.adlead.immo/v1/{tenantKey}/programs/{programId}/leads

# Paramètres d'URL

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

# curl

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

# Paramètres de Body

IMPORTANT

Il est obligatoire de préciser à minima le nom du contact ainsi qu'un moyen de contact (e-mail ou téléphone).

REMARQUE

Les faux numéros de téléphone communément utilisés (tels que 0123456789, 0600000000, etc.) sont automatiquement filtrés et ignorés.

# Exemple

{
  "contact": {
    "name": "Dupont",
    "firstname": "Jean",
    "email1": "jean.dupont@gmail.com",
    "phone1": "0600000000",
    "phone2": "0100000000"
  },
  "lead": {
    "request_type": "information",
    "project": "home",
    "project_target": "to-buy-his-first-home",
    "property_types": [
      "apartment"
    ],
    "property_rooms": [
      "T3",
      "T4"
    ],
    "message": "Bonjour, je souhaite recevoir le plan du bien suivant : Appartement 3 pièces - 61,48m² - 303 000 €. Pouvez-vous me contacter concernant cette demande ?",
    "tracking_engagement_point_uuid": "e7caa6a7fe8e16544b3f",
    "tracking_origin": "landing",
    "tracking_source": "google",
    "tracking_medium": "cpc",
    "tracking_campaign": "relance-140920"
  }
}

# Body de réponse

DETAILS 
{
    "success": true,
    "message": "Lead traité avec succès",
    "body": {
        "lead_id": 403,
        "created_at": "2020-09-14T13:29:58.000000Z"
    },
    "data": {
        "initial_payload": {
            "contact": {
                "name": "Dupont",
                "firstname": "Jean",
                "email1": "jean.dupont@gmail.com",
                "phone1": "0600000000",
                "phone2": "0100000000"
            },
            "lead": {
                "project": "home",
                "project_target": "to-buy-his-first-home",
                "investment_scheme": "pinel",
                "property_types": [
                    "apartment"
                ],
                "property_rooms": [
                    "T3",
                    "T4"
                ],
                "message": "Bonjour, je souhaite recevoir le plan du bien suivant : Appartement 3 pièces - 61,48m² - 303 000 €. Pouvez-vous me contacter concernant cette demande ?",
                "request_type": "documentation",
                "request_comment": "Ce lead souhaite obtenir des documents relatifs au programme",
                "tracking_engagement_point_uuid": "e7caa6a7fe8e16544b3f",
                "tracking_origin": "landing",
                "tracking_source": "google",
                "tracking_medium": "cpc",
                "tracking_campaign": "relance-140920"
            }
        },
        "skipped_fields": null,
        "processed_fields": {
            "lead": {
                "project": "home",
                "project_target": "to-buy-his-first-home",
                "investment_scheme": "pinel",
                "property_types": [
                    "apartment"
                ],
                "property_rooms": [
                    "T3",
                    "T4"
                ],
                "message": "Bonjour, je souhaite recevoir le plan du bien suivant : Appartement 3 pièces - 61,48m² - 303 000 €. Pouvez-vous me contacter concernant cette demande ?",
                "tracking_engagement_point_uuid": "e7caa6a7fe8e16544b3f",
                "tracking_origin": "landing",
                "tracking_source": "google",
                "tracking_medium": "cpc",
                "tracking_campaign": "relance-140920"
            },
            "request": {
                "type": "documentation",
                "comment": "Ce lead souhaite obtenir des informations sur le programme"
            },
            "contact": {
                "name": "Dupont",
                "firstname": "Jean",
                "email1": "jean.dupont@gmail.com",
                "phone1": "0600000000",
                "phone2": "0100000000"
            }
        }
    }
}

# Consulter la fiche d'un lead

Permet de récupérer la fiche détaillée d'un lead à partir de son id

# Requête HTTP

GET https://api.adlead.immo/v1/{tenantKey}/programs/{programId}/leads/{leadId}

# Paramètres d'URL

Nom de la clé Description
{tenantKey} Clé de l'espace client - Détails
{programId} ID du programme
{leadId} ID du lead

# curl

curl --location --request GET 'https://api.adlead.immo/v1/{tenantKey}/programs/{programId}/leads/{leadId}' \
    --header 'Accept: application/json' \
    --header 'X-API-Key: VOTRE_CLE_API'

# Body de réponse

DETAILS 
{
    "success": true,
    "message": null,
    "data": {
        "id": 5,
        "project": "home",
        "project_target": "to-buy-his-first-home",        
        "investment_scheme": "pinel",
        "property_types": [
            "apartment",
            "cellar",
            "garage"
        ],
        "property_rooms": [
            "T1",
            "T5"
        ],
        "property_living_area_from": 24,
        "property_living_area_to": 62,
        "property_specific_requests": [
            "garden",
            "upper-floor"
        ],
        "property_search_localities": [
            {
                "type": "city",
                "name": "Achères",
                "zipcode": "78260",
                "fullname": "Achères (78260), Yvelines"
            }
        ],
        "property_search_area": "Hauts-de-Seine (92)",
        "budget": 337863,
        "deposit": null,
        "temperature": "warm",
        "status": "negotiating",
        "follow_reason": null,
        "discard_reason": null,
        "contacts": [
            {
                "id": 6,
                "title": "ms",
                "title_display": "Madame",
                "name": "Aubert",
                "firstname": "Élodie",
                "fullname": "Élodie Aubert",
                "display_name": "Élodie Aubert",
                "email1": "gleleu@example.com",
                "email2": null,
                "phone1": "+33698740556",
                "phone2": null,
                "city": "DavidVille",
                "zipcode": "77350",
                "country": "FR",
                "address1": "chemin de Courtois",
                "address2": null,
                "legal_entity": false,
                "legal_status": null,
                "company_name": null,
                "company_siret": null,
                "resides_since": 2013,
                "optin_email": true,
                "optin_phone": true,
                "optin_sms": false,
                "birthname": null,
                "birthdate": "1994-04-07",
                "birthplace": "Schneider",
                "nationality": "FR",
                "marital_status": "divorced",
                "marital_status_display": "Divorcé(e)",
                "profession": null,
                "socio_professional_category": "retirees",
                "socio_professional_category_display": "Retraités",
                "is_employed": true,
                "employer_name": "Entreprise A",
                "work_address": null,
                "vehicles": 3,
                "children": 0,
                "children_age": [],
                "monthly_net_income": null,
                "annual_bonus": null,
                "other_annual_income": null,
                "annual_taxable_income_n1": null,
                "annual_taxable_income_n2": null,
                "annual_net_income": null,
                "primary_residence": "other",
                "primary_residence_display": "Autre",
                "own_secondary_residence": true,
                "first_time_homeowner": false,
                "has_already_invested": false,
                "has_already_invested_comment": null,
                "bank_name": "LCL",
                "insurance_name": "AXA",
                "has_broker": true,
                "updated_at": "2021-01-25T15:44:24.000000Z"
            }
        ],
        "tracking_origin": "sales-desk",
        "tracking_source": null,
        "tracking_medium": null,
        "tracking_campaign": null,
        "tracking_content": null,
        "referrer": "billboard",
        "created_at": "2020-08-29T02:35:58.000000Z",
        "updated_at": "2021-06-15T14:47:07.000000Z"
    }
}

# Modèle

# Noeud contact

Informations relatives au contact

Noeud Champ Type Description Exemple Format des données
contact title string Civilité mr ms mr = Monsieur / ms = Madame
contact name string Nom Dupont 80 caractères maximum
contact firstname string Prénom Jean 80 caractères maximum
contact fullname string Prénom Nom Jean Dupont
contact display_name string Prénom Nom ou Raison sociale Jean Dupont Nom société SCI
contact email1 string Adresse e-mail jean.dupont@gmail.com
contact email2 string Adresse e-mail secondaire jean.dupont@gmail.com
contact phone1 string Téléphone 33600000000 0600000000 Format international ou français
contact phone2 string Téléphone secondaire 33600000000 0600000000 Format international ou français
contact legal_entity boolean Personne morale true false true = personne morale
contact legal_status string Statut juridique sci sarl sas Accéder au tableau
contact company_name string Nom de la société Nom société
contact company_siret string SIRET de la société 36252187900034
contact city string Ville paris
contact zipcode string Code postal 75001
contact country string Code pays FR Accéder au tableau
contact address1 string Adresse 12 rue du Louvre
contact address2 string Adresse 2
contact resides_since int Réside à l'adresse depuis 2015
contact optin_email boolean Optin e-mail true false true = consentement donné
contact optin_phone boolean Optin téléphone true false true = consentement donné
contact optin_sms boolean Optin SMS true false true = consentement donné
contact birthname string Nom de naissance Dupont
contact birthdate string Date de naissance 1981-08-13 Y-m-d
contact birthplace string Lieu de naissance Paris
contact nationality string Nationalité FR Accéder au tableau
contact marital_status string Situation maritale single Accéder au tableau
contact profession string Profession Cadre
contact socio_professional_category string Catégorie socioprofessionnelle retirees Accéder au tableau
contact is_employed boolean En activité true false
contact employer_name string Nom de l'employeur Entreprise A
contact work_address string Lieu de travail
contact vehicles int Nombre de véhicules 2
contact children int Nombre d'enfants 2
contact monthly_net_income int Revenus mensuels net
contact annual_bonus int Primes annuelles
contact other_annual_income int Autres revenus annuels
contact annual_taxable_income_n1 int Revenu fiscal N-1
contact annual_taxable_income_n2 int Revenu fiscal N-2
contact annual_net_income int Revenus annuels net
contact primary_residence string Résidence principale owner tenant other Accéder au tableau
contact own_secondary_residence boolean Possède une résidence secondaire true false
contact first_time_homeowner boolean Est un primo-accèdant true false
contact has_already_invested boolean A déjà investi dans l'immobilier true false
contact has_already_invested_comment string Commentaire sur l'investissement Pinel en 2018
contact bank_name string Nom de la banque Société Générale
contact insurance_name string Nom de l'assureur AXA
contact has_broker boolean A déjà un courtier true false

# Noeud lead

Informations relatives au lead et à son projet

Noeud Champ Type Description Exemple Format des données
lead request_type string Type de demande information documentation lot-detail callback meeting other Accéder au tableau
lead request_lot_id int ID du lot, à utiliser en combinaison avec request_type = lot-detail 250
lead request_comment string Commentaire à destination du commercial Ce lead souhaite obtenir des informations sur le programme
lead project string Type de projet home investment Accéder au tableau
lead project_target string Finalité du projet to-buy-his-first-home to-settle-down-as-a-couple Accéder au tableau
lead investment_scheme string Dispositif d'investissement pinel lnmp Accéder au tableau
lead property_types array Type de biens recherchés ["apartment", "parking"] Accéder au tableau
lead property_rooms array Nombre de pièces recherchées ["T3", "T4"] Accéder au tableau
lead property_living_area_from float Surface habitable minimum 45
lead property_living_area_to float Surface habitable maximum 70
lead property_search_localities array Localités recherchées (code postal) [92, 92200, 92110] Département ou code postal
lead property_search_insee_localities array Localités recherchées (code Insee) [92, 92051, 92024] Département ou code Insee
lead property_search_area string Commentaire sur la zone de recherche Dans le quartier de la Roseraie
lead property_specific_requests array Demandes spécifiques ["balcony", "terrace"] Accéder au tableau
lead reduced_vat_eligibility boolean Éligibilité à la TVA réduite true true false
lead zero_interest_loan_eligibility boolean Éligibilité au PTZ false true false
lead budget float Budget maximum 350000.00
lead message string Commentaire du lead Bonjour, je souhaite recevoir le plan...
lead temperature string Chaleur du lead cold warm hot Accéder au tableau
lead tracking_engagement_point_uuid string UUID du canal personnalisé e7caa6a7fe8e16544b3f À récupérer auprès du responsable maketing
lead tracking_origin string Canal d'origine landing call Accéder au tableau
lead tracking_source string Tracking - Source (utm) google Paramètres UTM
lead tracking_medium string Tracking - Support (utm) cpc Paramètres UTM
lead tracking_campaign string Tracking - Campagne (utm) relance-140920 Paramètres UTM
lead tracking_term string Tracking - Termes de recherche (utm) immobilier+neuf Paramètres UTM
lead tracking_content string Tracking - Contenu (utm) logo-link Paramètres UTM
lead tracking_marketing_tactic string Tracking - Critères de ciblage Paramètres UTM
lead referrer string Comment nous avez-vous connu ? leaflet word-of-mouth Accéder au tableau
lead referrers deprecated string ⚠️ déprécié leaflet word-of-mouth Accéder au tableau

# Annexes

# Statut juridique

Liste des statuts juridique

DETAILS 
[
  {
    "key": "sa",
    "name": "Société Anonyme",
    "short": "SA"
  },
  {
    "key": "sarl",
    "name": "Société à Responsabilité Limitée",
    "short": "SARL"
  },
  {
    "key": "eurl",
    "name": "Entreprise Unipersonnelle à Responsabilité Limitée",
    "short": "EURL"
  },
  {
    "key": "sas",
    "name": "Société par Actions Simplifiée",
    "short": "SAS"
  },
  {
    "key": "sasu",
    "name": "Société par Actions Simplifiée Unipersonnelle",
    "short": "SASU"
  },
  {
    "key": "sci",
    "name": "Société Civile Immobilière",
    "short": "SCI"
  },
  {
    "key": "snc",
    "name": "Société en Nom Collectif",
    "short": "SNC"
  },
  {
    "key": "scs",
    "name": "Société en Commandite Simple",
    "short": "SCS"
  },
  {
    "key": "other",
    "name": "Autre type d'entité",
    "short": "Autre"
  }
]

# Situation maritale

Liste des situations maritales

DETAILS 
[
  {
    "key": "single",
    "name": "Célibataire"
  },
  {
    "key": "domestic-partnership",
    "name": "Union libre"
  },
  {
    "key": "civil",
    "name": "Pacsé(e)"
  },
  {
    "key": "married",
    "name": "Marié(e)"
  },
  {
    "key": "divorced",
    "name": "Divorcé(e)"
  },
  {
    "key": "widower",
    "name": "Veuf(ve)"
  }
]

# Catégorie socioprofessionnelle

Liste des catégories socioprofessionnelles

DETAILS 
[
  {
    "key": "public-sector-executives",
    "name": "Cadres de la fonction publique"
  },
  {
    "key": "private-sector-executives",
    "name": "Cadres du secteur privé"
  },
  {
    "key": "company-directors",
    "name": "Dirigeants d'entreprises"
  },
  {
    "key": "liberal-professions-and-higher-intellectuals",
    "name": "Professions libérales et intellectuelles supérieures"
  },
  {
    "key": "artisans",
    "name": "Artisans"
  },
  {
    "key": "traders-and-self-employed",
    "name": "Commerçants et auto-entrepreneurs"
  },
  {
    "key": "private-sector-employees",
    "name": "Employés du secteur privé"
  },
  {
    "key": "public-sector-employees",
    "name": "Employés de la fonction publique"
  },
  {
    "key": "skilled-workers",
    "name": "Ouvriers qualifiés"
  },
  {
    "key": "unskilled-workers",
    "name": "Ouvriers non qualifiés"
  },
  {
    "key": "farmers",
    "name": "Exploitants agricoles"
  },
  {
    "key": "agricultural-workers",
    "name": "Salariés de l'agriculture"
  },
  {
    "key": "retirees",
    "name": "Retraités"
  },
  {
    "key": "students",
    "name": "Étudiants"
  },
  {
    "key": "job-seekers",
    "name": "Chercheurs d'emploi"
  },
  {
    "key": "non-job-seekers",
    "name": "Non chercheurs d'emploi"
  },
  {
    "key": "other",
    "name": "Autres"
  }
]

# Statut de la résidence principale

Liste des statuts de résidence principale

DETAILS 
[
  {
    "key": "owner",
    "name": "Propriétaire"
  },
  {
    "key": "tenant",
    "name": "Locataire"
  },
  {
    "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"
  },
  {
    "key": "commercial-space",
    "name": "Local commercial"
  },
  {
    "key": "rental",
    "name": "Demande de location"
  }
]

# Finalité du projet

Liste des types de finalité de projet

DETAILS 
[
  {
    "key": "to-buy-his-first-home",
    "name": "Acheter son premier logement"
  },
  {
    "key": "to-settle-down-as-a-couple",
    "name": "S'installer à deux"
  },
  {
    "key": "to-expand-the-family",
    "name": "Agrandir la famille"
  },
  {
    "key": "to-house-his-children",
    "name": "Loger ses enfants"
  },
  {
    "key": "to-reduce-taxes",
    "name": "Réduire ses impôts"
  },
  {
    "key": "to-have-an-additional-income",
    "name": "Avoir un complément de revenu"
  },
  {
    "key": "to-build-up-an-estate",
    "name": "Constituer un patrimoine"
  },
  {
    "key": "to-prepare-for-retirement",
    "name": "Préparer sa retraite"
  },
  {
    "key": "to-spend-his-retirement",
    "name": "Y passer sa retraite"
  }
]

# 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"
  }
]

# Type de bien

Liste des types de biens

DETAILS 
[
  {
    "key": "apartment",
    "name": "Appartement"
  },
  {
    "key": "house",
    "name": "Maison"
  },
  {
    "key": "parking",
    "name": "Parking"
  },
  {
    "key": "garage",
    "name": "Garage"
  },
  {
    "key": "basement",
    "name": "Cave"
  },
  {
    "key": "cellar",
    "name": "Cellier"
  },
  {
    "key": "commercial-space",
    "name": "Local commercial"
  },
  {
    "key": "office-space",
    "name": "Bureau"
  },
  {
    "key": "land",
    "name": "Terrain"
  }
]

# 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 +"
  }
]

# Demande spécifique

Liste des demandes spécifiques

DETAILS 
[
  {
    "key": "balcony",
    "name": "Balcon"
  },
  {
    "key": "terrace",
    "name": "Terrasse"
  },
  {
    "key": "garden",
    "name": "Jardin"
  },
  {
    "key": "not-overlooked",
    "name": "Sans vis-à-vis"
  },
  {
    "key": "upper-floor",
    "name": "Étage élevé"
  },
  {
    "key": "ground-floor",
    "name": "Rez-de-chaussée"
  },
  {
    "key": "south-exposure",
    "name": "Orientation Sud"
  },
  {
    "key": "sea-view",
    "name": "Vue mer"
  },
  {
    "key": "adapted-pmr",
    "name": "Adpaté aux personnes à mobilité réduite"
  }
]

# Statut d'un lead

Liste des statuts possibles pour un lead

DETAILS 
[
  {
    "key": "to-process",
    "name": "À traiter",
    "description": "Aucune action n'a été faite par le commercial"
  },
  {
    "key": "pending",
    "name": "En attente de contact",
    "description": "A été contacté mais sans réponse"
  },
  {
    "key": "to-follow",
    "name": "À suivre",
    "description": "À recontacter plus tard"
  },
  {
    "key": "ongoing",
    "name": "En discussion",
    "description": "Une discussion est en cours"
  },
  {
    "key": "interested",
    "name": "Intéressé",
    "description": "A montré un intérêt pour le programme ou pour un lot"
  },
  {
    "key": "negotiating",
    "name": "En négociation",
    "description": "Échanges actifs jusqu'à la signature du contrat de réservation"
  },
  {
    "key": "discarded",
    "name": "Sans suite",
    "description": "Désintéressé, abandon du projet, client non finançable, etc."
  },
  {
    "key": "pending-purchaser",
    "name": "Réservataire",
    "description": "A signé le contrat de réservation"
  },
  {
    "key": "purchaser",
    "name": "Signataire",
    "description": "A signé l'acte de vente"
  }
]

# Chaleur du lead

Liste des chaleurs de lead

DETAILS 
[
  {
    "key": "hot",
    "name": "Lead chaud"
  },
  {
    "key": "warm",
    "name": "Lead tiède"
  },
  {
    "key": "cold",
    "name": "Lead froid"
  }
]

# Type de demande

Liste des types de demande

DETAILS 
[
  {
    "key": "information",
    "name": "Demande d'information"
  },
  {
    "key": "documentation",
    "name": "Demande de documentation"
  },
  {
    "key": "lot-detail",
    "name": "Demande d'information sur un lot"
  },
  {
    "key": "callback",
    "name": "Demande de rappel"
  },
  {
    "key": "meeting",
    "name": "Demande de rendez-vous"
  },
  {
    "key": "other",
    "name": "Autre demande"
  }
]

# 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": "live-chat",
    "name": "Chat"
  },
  {
    "key": "sales-desk",
    "name": "Bureau de vente"
  },
  {
    "key": "call",
    "name": "Appel"
  },
  {
    "key": "network",
    "name": "Réseau"
  },
  {
    "key": "prescriber",
    "name": "Prescripteur"
  },
  {
    "key": "referral",
    "name": "Parrainage"
  },
  {
    "key": "other",
    "name": "Autre"
  }
]

# Comment nous avez-vous connu ?

Liste des référents

DETAILS 
[
  {
    "key": "website",
    "name": "Site internet"
  },
  {
    "key": "real-estate-portal",
    "name": "Portail immobilier"
  },
  {
    "key": "emailing",
    "name": "E-mailing"
  },
  {
    "key": "google",
    "name": "Google"
  },
  {
    "key": "facebook",
    "name": "Facebook"
  },
  {
    "key": "sales-desk",
    "name": "Bureau de vente"
  },
  {
    "key": "press-advertising",
    "name": "Annonce presse"
  },
  {
    "key": "leaflet",
    "name": "Tract"
  },
  {
    "key": "billboard",
    "name": "Panneau"
  },
  {
    "key": "city-hall",
    "name": "Mairie"
  },
  {
    "key": "word-of-mouth",
    "name": "Bouche à oreille"
  },
  {
    "key": "web",
    "name": "Internet (non-défini)"
  },
  {
    "key": "social-media",
    "name": "Réseaux sociaux"
  },
  {
    "key": "sms",
    "name": "SMS"
  },
  {
    "key": "print-media",
    "name": "Presse papier"
  },
  {
    "key": "radio",
    "name": "Radio"
  },
  {
    "key": "cinema",
    "name": "Cinéma"
  },
  {
    "key": "television",
    "name": "Télévision"
  },
  {
    "key": "prescribing",
    "name": "Prescription"
  },
  {
    "key": "secondary-developer",
    "name": "Co-promoteur"
  },
  {
    "key": "referral",
    "name": "Parrainage"
  },
  {
    "key": "other",
    "name": "Autre"
  }
]

← Actions commerciales →