Adlead - Documentation

# Intérêt programme

Permet de consulter et modifier les champs liés à l'intérêt d'un lead sur un programme.

IMPORTANT

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

# Consulter l'intérêt

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

# Requête HTTP

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

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

# Body de réponse

DETAILS 
{
    "success": true,
    "message": null,
    "data": {
        "id": 72933,
        "is_protected": false,
        "is_under_prescription": false,
        "status": "ongoing",
        "follow_reason": null,
        "discard_reason": null,
        "temperature": "warm",
        "optin": true,
        "memo_content": "Client intéressé par les T3",
        "memo_updated_at": "2024-03-08T16:54:03.000000Z",
        "created_at": "2024-01-15T10:00:00.000000Z",
        "updated_at": "2024-03-08T16:54:03.000000Z"
    }
}

# Modifier l'intérêt

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

# Requête HTTP

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

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

# Paramètres de Body

CHAMPS PROTÉGÉS

Si le lead est protégé (is_protected = true), les champs status, temperature, follow_reason et discard_reason ne peuvent pas être modifiés. La requête sera rejetée avec un code 403.

GUARDS

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

# Schéma

Champ Type Description Requis Format des données
status string Statut de l'intérêt Non Accéder au tableau
temperature string Chaleur du lead Non cold warm hot — nullable
follow_reason string Motif de suivi — requis si status = to-follow, interdit sinon Conditionnel Accéder au tableau — nullable
discard_reason string Motif de disqualification — requis si status = discarded, interdit sinon Conditionnel Accéder au tableau — nullable
memo_content string Mémo interne Non Nullable
optin boolean Consentement programme Non true = consentement donné

# Exemple

{
  "status": "ongoing",
  "temperature": "hot",
  "memo_content": "Relancé par téléphone"
}

# Body de réponse

DETAILS 
{
    "success": true,
    "message": "Lead mis à jour",
    "data": {
        "id": 72933,
        "is_protected": false,
        "is_under_prescription": false,
        "status": "ongoing",
        "follow_reason": null,
        "discard_reason": null,
        "temperature": "hot",
        "optin": true,
        "memo_content": "Relancé par téléphone",
        "memo_updated_at": "2024-03-09T11:00:00.000000Z",
        "created_at": "2024-01-15T10:00:00.000000Z",
        "updated_at": "2024-03-09T11:00:00.000000Z"
    }
}

# Modèle

Champ Type Description Exemple
id int ID du lead 72933
is_protected boolean Lead protégé false
is_under_prescription boolean Dénonciation active sur le programme false
status string Statut de l'intérêt ongoing
follow_reason string Motif de suivi project-to-update
discard_reason string Motif de disqualification do-not-reply
temperature string Chaleur du lead warm
optin boolean Consentement programme true
memo_content string Mémo interne Client intéressé par les T3
memo_updated_at string Dernière mise à jour du mémo 2024-03-08T16:54:03.000000Z
created_at string Date de création de l'intérêt 2024-01-15T10:00:00.000000Z
updated_at string Dernière mise à jour 2024-03-08T16:54:03.000000Z

# Annexes

# Motif de suivi

Valeurs acceptées pour follow_reason (requis lorsque status = to-follow)

DETAILS 
[
  { "key": "family-situation", "name": "Changement de situation familiale" },
  { "key": "occupational-status", "name": "Changement de situation professionnelle" },
  { "key": "administrative-formality", "name": "Démarche administrative" },
  { "key": "expected-income", "name": "Entrée d'argent à venir" },
  { "key": "project-to-update", "name": "Projet à réactualiser" },
  { "key": "follow-up", "name": "À relancer" },
  { "key": "other", "name": "Autre" }
]

# Motif de disqualification

Valeurs acceptées pour discard_reason (requis lorsque status = discarded)

DETAILS 
[
  { "key": "do-not-reply", "name": "Ne répond pas" },
  { "key": "curious", "name": "Curieux" },
  { "key": "incorrect-contact-information", "name": "Information de contact incorrecte" },
  { "key": "do-not-have-any-plans", "name": "Pas de projet immobilier" },
  { "key": "looking-for-rental", "name": "Recherche une location" },
  { "key": "looking-for-former", "name": "Recherche dans l'ancien" },
  { "key": "bought-from-competitor", "name": "Achat chez un autre promoteur" },
  { "key": "bought-former-property", "name": "Achat dans l'ancien" },
  { "key": "interest-in-another-program", "name": "Intérêt pour un autre programme" },
  { "key": "price", "name": "Prix trop élevé" },
  { "key": "budget", "name": "Budget insuffisant" },
  { "key": "location", "name": "Localisation" },
  { "key": "product", "name": "Produit/prestations" },
  { "key": "delivery-date", "name": "Date de livraison tardive" },
  { "key": "out-of-stock", "name": "Plus de stock" },
  { "key": "withdrawal", "name": "Désistement" },
  { "key": "other", "name": "Autre" }
]

← Qualification →