Adlead - Documentation

# Qualification

Permet de consulter et modifier la qualification d'un lead (projet, critères de recherche, budget).

IMPORTANT

Le lead doit disposer d'un intérêt sur le programme associé.

# Consulter la qualification

Permission requise : lead.view ou lead-extended.view

# Requête HTTP

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

# 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}/qualification' \
    --header 'Accept: application/json' \
    --header 'X-API-Key: VOTRE_CLE_API' \

# Body de réponse

DETAILS 
{
    "success": true,
    "message": null,
    "data": {
        "project": "home",
        "project_target": "to-buy-his-first-home",
        "investment_scheme": null,
        "property_types": ["apartment"],
        "property_rooms": ["T3", "T4"],
        "property_living_area_from": 55,
        "property_living_area_to": 80,
        "property_specific_requests": ["balcony", "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": 350000,
        "deposit": 25000,
        "reduced_vat_eligibility": true,
        "zero_interest_loan_eligibility": false
    }
}

# Modifier la qualification

Permission requise : lead.update ou lead-extended.update

# Requête HTTP

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

# 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 PUT 'https://api.adlead.immo/v1/{tenantKey}/programs/{programId}/leads/{leadId}/qualification' \
    --header 'Accept: application/json' \
    --header 'Content-Type: application/json' \
    --header 'X-API-Key: VOTRE_CLE_API' \

# Paramètres de Body

GUARDS

La modification est bloquée si le lead est anonymisé ou sous prescription (dénonciation active).

LOCALITÉS

L'envoi de property_search_localities ou property_search_insee_localities supprime toutes les localités existantes (les deux référentiels), puis réattache uniquement les valeurs fournies. Envoyer seulement l'un des deux champs détruit les localités de l'autre référentiel. Pour conserver les localités d'un référentiel, renvoyez-les dans la requête. Un tableau vide supprime toutes les localités.

# Schéma

Champ Type Description Requis Format des données
project string Type de projet Non Accéder au tableau — nullable
project_target string Finalité du projet Non Accéder au tableau — nullable
investment_scheme string Dispositif d'investissement Non Accéder au tableau — nullable
property_types array Types de biens recherchés Non Accéder au tableau — nullable
property_rooms array Typologies recherchées Non Accéder au tableau — nullable
property_living_area_from float Surface habitable minimum Non Nullable
property_living_area_to float Surface habitable maximum Non Nullable
property_specific_requests array Demandes spécifiques Non Tableau de chaînes libres — nullable. Voir valeurs suggérées (non validées côté serveur)
property_search_localities array Localités par code postal Non Tableau de valeurs numériques (département ou code postal) — nullable
property_search_insee_localities array Localités par code Insee Non Tableau de valeurs numériques (département ou code Insee) — nullable
property_search_area string Zone de recherche (texte libre) Non Nullable
budget integer Budget maximum Non Max 10 000 000 — nullable. Les décimales sont tronquées.
deposit integer Apport personnel Non Max 10 000 000 — nullable. Les décimales sont tronquées.
reduced_vat_eligibility boolean Éligibilité TVA réduite Non
zero_interest_loan_eligibility boolean Éligibilité PTZ Non

# Exemple

{
  "project": "home",
  "project_target": "to-buy-his-first-home",
  "property_types": ["apartment"],
  "property_rooms": ["T3", "T4"],
  "budget": 350000,
  "property_search_localities": [92200, 92110]
}

# Body de réponse

DETAILS 
{
    "success": true,
    "message": "Qualification mise à jour",
    "data": {
        "project": "home",
        "project_target": "to-buy-his-first-home",
        "investment_scheme": null,
        "property_types": ["apartment"],
        "property_rooms": ["T3", "T4"],
        "property_living_area_from": null,
        "property_living_area_to": null,
        "property_specific_requests": [],
        "property_search_localities": [
            {
                "type": "city",
                "name": "Neuilly-sur-Seine",
                "zipcode": "92200",
                "fullname": "Neuilly-sur-Seine (92200), Hauts-de-Seine"
            },
            {
                "type": "city",
                "name": "Clichy",
                "zipcode": "92110",
                "fullname": "Clichy (92110), Hauts-de-Seine"
            }
        ],
        "property_search_area": null,
        "budget": 350000,
        "deposit": null,
        "reduced_vat_eligibility": false,
        "zero_interest_loan_eligibility": false
    }
}

← Actions commerciales →