Adlead - Documentation

# Tags

Permet de gérer les tags associés à un lead via son intérêt sur un programme.

IMPORTANT

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

# Lister les tags

Permission requise : lead.view ou lead-extended.view (via le scoping de l'intérêt)

Retourne les tags de l'intérêt programme et les tags globaux du lead.

# Requête HTTP

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

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

# Body de réponse

DETAILS 
{
    "success": true,
    "message": null,
    "data": [
        {
            "id": 1520,
            "uuid": "a7caa6a5de8e16544b3d",
            "name": "VIP",
            "is_global": false
        },
        {
            "id": 1305,
            "uuid": "b8dbb7b6ef9f27655c4e",
            "name": "Investisseur",
            "is_global": true
        }
    ]
}

# Ajouter un tag à un lead

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

# Requête HTTP

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

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

# Paramètres de Body

IDEMPOTENT

Si le tag est déjà associé au lead (ou à l'intérêt), la requête réussit et retourne le tag existant.

# Schéma

Champ Type Description Requis Exemple Format des données
tag_uuid string UUID du tag Oui a7caa6a5de8e16544b3d À récupérer auprès du responsable marketing
is_global boolean Tag spécifique à l'intérêt actif, ou global au lead Non true false true = Tag global au lead (défaut : false)

# Exemple

{
  "tag_uuid": "a7caa6a5de8e16544b3d",
  "is_global": false
}

# Body de réponse

DETAILS 
{
    "success": true,
    "message": "Tag ajouté",
    "data": {
        "id": 1520,
        "uuid": "a7caa6a5de8e16544b3d",
        "name": "VIP",
        "is_global": false
    }
}

# Retirer un tag

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

ID DU LEAD TAG

Le paramètre {leadTagId} est l'ID retourné dans le modèle (id), pas l'UUID du tag.

# Requête HTTP

DELETE https://api.adlead.immo/v1/{tenantKey}/programs/{programId}/leads/{leadId}/tags/{leadTagId}

# 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
{leadTagId} ID du LeadTag (retourné par GET et POST)

# curl

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

# Body de réponse

DETAILS 
{
    "success": true,
    "message": "Tag retiré"
}

# Modèle

Champ Type Description Exemple
id int ID du LeadTag (à utiliser pour DELETE) 1520
uuid string UUID du tag a7caa6a5de8e16544b3d
name string Nom du tag VIP
is_global boolean true = tag global au lead, false = tag d'intérêt false

← Leads sans programme →