Envoyer un lead
Nous transmettre un particulier et son besoin : notre service client prend le relais.
Seul phone est obligatoire. Envoyez tout ce que vous avez : coordonnées, adresse du chantier, statut et type de logement, délai souhaité, et surtout le besoin.
Décrivez le besoin dans details, avec les mots du particulier : notre service client le qualifie.
curl -X POST "https://api.kelkun.app/lead-providers/leads" \
-H "x-api-key: <votre clé>" \
-H "Content-Type: application/json" \
-d '{
"phone": "06 12 34 98 76",
"lead_id": "P-2026-0412",
"first_name": "Camille",
"last_name": "Durand",
"postal_code": "47000",
"city": "Agen",
"details": "Après la recherche de fuite, il faut refaire le carrelage de la douche et changer le mitigeur."
}'Envoyez toujours lead_id
La validation ne l'exige pas, mais c'est par lui que nous vous désignons ce lead par la suite, sans ambiguïté.
Les champs de qualification (housing_status, housing_type, desired_delay) ne sont pas traduits dans notre vocabulaire : notre service client les lit tels quels, et n'a pas à les redemander. Un champ absent ne fait jamais échouer l'envoi, et un lead n'est jamais refusé pour son activité : inconnue, il est pris quand même, et classé à la main.
Notre réponse
Un 201, avec notre référence :
{ "status": "accepted", "reference": "V0YDH" }status | Signification |
|---|---|
accepted | Lead reçu et enregistré : notre service client prend le relais. |
duplicate | Ce numéro de téléphone nous est déjà parvenu dans les 30 dernières minutes. Nous ne créons pas de second lead ; reference est celle du lead d'origine. |
reference est notre identifiant court, à citer pour toute question sur ce lead. C'est aussi par elle que vous joignez des fichiers au lead.
Référence
Authentification
x-api-key La clé d'API que Kelkun vous a transmise.
Dans: header
Corps de la requête
application/json
Types TypeScript
Le type à reprendre dans votre code TypeScript.
Corps de la réponse
application/json
application/json
application/json
application/json
curl -X POST "https://example.com/lead-providers/leads" \ -H "Content-Type: application/json" \ -d '{ "phone": "06 12 34 98 76" }'{ "status": "accepted", "reference": "V0YDH"}