Adlead - Documentation

# Comptes-rendus d'événements

Permet de gérer les comptes-rendus d'événements (records) associé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é.

# Lister les comptes-rendus

Permission requise : record.view

# Requête HTTP

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

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

# Body de réponse

Les résultats sont triés par date de création décroissante.

DETAILS 
{
    "success": true,
    "message": null,
    "data": [
        {
            "id": 15200,
            "sales_action_id": null,
            "event": "outgoing-call",
            "comment": "Appel de relance, le client souhaite un rappel lundi",
            "occurred_at": "2024-03-08T14:30:00.000000Z",
            "created_at": "2024-03-08T14:35:00.000000Z",
            "updated_at": "2024-03-08T14:35:00.000000Z"
        },
        {
            "id": 15100,
            "sales_action_id": 38990,
            "event": "request-for-information",
            "comment": "Demande en provenance de : Landing",
            "occurred_at": null,
            "created_at": "2024-03-01T10:00:00.000000Z",
            "updated_at": "2024-03-01T10:00:00.000000Z"
        }
    ]
}

# Consulter un compte-rendu

Permission requise : record.view

# Requête HTTP

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

# 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
{recordId} ID du compte-rendu

# curl

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

# Body de réponse

DETAILS 
{
    "success": true,
    "message": null,
    "data": {
        "id": 15200,
        "sales_action_id": null,
        "event": "outgoing-call",
        "comment": "Appel de relance, le client souhaite un rappel lundi",
        "occurred_at": "2024-03-08T14:30:00.000000Z",
        "created_at": "2024-03-08T14:35:00.000000Z",
        "updated_at": "2024-03-08T14:35:00.000000Z"
    }
}

# Créer un compte-rendu

Permission requise : record.create

# Requête HTTP

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

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

# Paramètres de Body

# Schéma

Champ Type Description Requis Format des données
event string Type d'événement Oui Accéder au tableau
comment string Commentaire Non 1000 caractères maximum — nullable
occurred_at string Date de l'événement Non ISO 8601 — nullable
sales_action_id int ID de l'action commerciale liée Non nullable — Retourne une erreur 422 si introuvable ou n'appartient pas au lead

# Exemple

{
  "event": "outgoing-call",
  "comment": "Appel de relance, le client souhaite un rappel lundi",
  "occurred_at": "2024-03-08T14:30:00.000000Z",
  "sales_action_id": 38990
}

# Body de réponse

DETAILS 
{
    "success": true,
    "message": "Événement ajouté",
    "data": {
        "id": 15200,
        "sales_action_id": null,
        "event": "outgoing-call",
        "comment": "Appel de relance, le client souhaite un rappel lundi",
        "occurred_at": "2024-03-08T14:30:00.000000Z",
        "created_at": "2024-03-08T14:35:00.000000Z",
        "updated_at": "2024-03-08T14:35:00.000000Z"
    }
}

# Modifier un compte-rendu

Permission requise : record.update

# Requête HTTP

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

# 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
{recordId} ID du compte-rendu

# curl

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

# Paramètres de Body

# Schéma

Champ Type Description Requis Format des données
event string Type d'événement Non Accéder au tableau
comment string Commentaire Non 1000 caractères maximum — nullable
occurred_at string Date de l'événement Non ISO 8601 — nullable
sales_action_id int ID de l'action commerciale liée Non nullable — Retourne une erreur 422 si introuvable ou n'appartient pas au lead

# Exemple

{
  "comment": "Appel de relance, RDV confirmé pour lundi 14h",
  "sales_action_id": 38990
}

# Body de réponse

DETAILS 
{
    "success": true,
    "message": "Événement mis à jour",
    "data": {
        "id": 15200,
        "sales_action_id": null,
        "event": "outgoing-call",
        "comment": "Appel de relance, RDV confirmé pour lundi 14h",
        "occurred_at": "2024-03-08T14:30:00.000000Z",
        "created_at": "2024-03-08T14:35:00.000000Z",
        "updated_at": "2024-03-09T11:00:00.000000Z"
    }
}

# Supprimer un compte-rendu

Permission requise : record.delete

# Requête HTTP

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

# 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
{recordId} ID du compte-rendu

# curl

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

# Body de réponse

DETAILS 
{
    "success": true,
    "message": "Événement supprimé",
    "body": "Le compte-rendu d'événement a été supprimé."
}

# Modèle

Champ Type Description Exemple
id int ID du compte-rendu 15200
sales_action_id int ID de l'action commerciale liée (si applicable) 38990 — nullable
user_id int ID de l'utilisateur ayant réalisé l'action 126 — nullable
event string Type d'événement outgoing-call
comment string Commentaire Appel de relance
occurred_at string Date de l'événement 2024-03-08T14:30:00.000000Z
created_at string Date de création 2024-03-08T14:35:00.000000Z
updated_at string Dernière mise à jour 2024-03-08T14:35:00.000000Z

# Annexes

# Type d'événement

Liste des types d'événements

DETAILS 
[
  { "key": "incoming-call", "name": "Appel entrant" },
  { "key": "outgoing-call", "name": "Appel sortant réussi" },
  { "key": "outgoing-call-missed", "name": "Appel sortant non-abouti" },
  { "key": "voicemail", "name": "Message vocal laissé" },
  { "key": "booklet", "name": "Brochure envoyée" },
  { "key": "sms", "name": "SMS envoyé" },
  { "key": "email", "name": "E-mail envoyé" },
  { "key": "incoming-sms", "name": "SMS reçu" },
  { "key": "incoming-email", "name": "E-mail reçu" },
  { "key": "meeting-in-person", "name": "Rendez-vous physique" },
  { "key": "meeting-video", "name": "Rendez-vous visio-conférence" },
  { "key": "meeting-phone", "name": "Rendez-vous téléphonique" },
  { "key": "meeting-canceled", "name": "Rendez-vous annulé" },
  { "key": "meeting-missed", "name": "Rendez-vous non-honoré" },
  { "key": "sales-desk", "name": "Visite bureau de vente" },
  { "key": "comment", "name": "Commentaire" }
]

← Tags →