Adlead - Documentation

# Actions commerciales

# Planifier une action commerciale

Permet de planifier une action commerciale sur un lead d'un programme.

IMPORTANT

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

# Requête HTTP

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

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

# Paramètres de Body

# Schéma

Champ Type Description Requis Exemple Format des données
type string Type d'action commerciale Oui call meeting-in-person Accéder au tableau
scheduled_at string Date à laquelle l'action doit-être réalisée (doit être dans le futur) Oui 2020-09-04T10:20:04.000000Z ISO 8601
priority string Priorité Non low medium high Accéder au tableau
comment string Commentaire à destination du commercial Non

# Exemple

{
  "type": "call",
  "scheduled_at": "2024-03-09T11:00:00.000000Z",
  "priority": "high",
  "comment": "A appeler pour préciser le projet"
}

# Body de réponse

DETAILS 
{
    "success": true,
    "message": "Action commerciale planifiée",
    "body": "L'action commerciale a été planifiée.",
    "data": {
        "id": 38990,
        "lead_id": 72933,
        "program_id": 1,
        "type": "call",
        "priority": "high",
        "scheduled_at": "2024-03-09T11:00:00.000000Z",
        "comment": "A appeler pour préciser le projet",
        "status": "scheduled",
        "created_at": "2024-03-08T16:54:03.000000Z",
        "updated_at": "2024-03-08T16:54:03.000000Z"
    }
}

# Type d'action commerciale

Liste des types d'actions commerciales

DETAILS 
[
  {
    "key": "request-to-process",
    "name": "Demande à traiter"
  },
  {
    "key": "call",
    "name": "Appel"
  },
  {
    "key": "send-email",
    "name": "Envoi d'e-mail"
  },
  {
    "key": "send-sms",
    "name": "Envoi de SMS"
  },
  {
    "key": "meeting-phone",
    "name": "Rendez-vous téléphonique"
  },
  {
    "key": "meeting-video",
    "name": "Rendez-vous visio-conférence"
  },
  {
    "key": "meeting-in-person",
    "name": "Rendez-vous physique"
  },
  {
    "key": "other",
    "name": "Autre tâche"
  }
]

# Priorités

Liste des priorités

DETAILS 
[
  {
    "key": "high",
    "name": "Priorité haute"
  },
  {
    "key": "medium",
    "name": "Priorité moyenne"
  },
  {
    "key": "low",
    "name": "Priorité basse"
  }
]

← Tags →