Proposer un lead
Facultatif : demander si nous voulons un lead, avant de nous confier la moindre coordonnée.
Réservé aux partenaires avec référentiel
La proposition repose sur l'activité du lead : sans référentiel d'activités, envoyez directement le lead. Elle n'est jamais obligatoire.
Le code postal et votre identifiant d'activité suffisent. Ajoutez lead_id si vous l'avez : il relie la proposition à l'envoi qui suit dans nos journaux.
curl -X POST "https://api.kelkun.app/lead-providers/ping" \
-H "x-api-key: <votre clé>" \
-H "Content-Type: application/json" \
-d '{"postal_code": "75011", "activity_id": "114"}'Notre réponse
Toujours 200, refus compris : un refus est une réponse normale, pas une erreur. Inutile de réessayer.
{ "accepted": true }{ "accepted": false, "reason": "NO_COVERAGE" }Si nous acceptons, envoyez-nous le lead. Nous ne rejouons pas la proposition à l'envoi : si notre couverture a changé entre-temps, nous prenons quand même le lead.
Les motifs de refus
| Motif | Signification, et ce que vous pouvez en faire |
|---|---|
OUTSIDE_BUSINESS_HOURS | Hors des heures où notre service client peut rappeler rapidement : en semaine, en journée, à l'heure de Paris. Inutile de réessayer avant la réouverture. |
UNKNOWN_ACTIVITY | Cet identifiant n'est pas dans le référentiel que vous nous avez transmis. Signalez-le nous : c'est sans doute une activité à ajouter de notre côté. |
UNKNOWN_POSTAL_CODE | Le code postal ne correspond à aucune commune française. À vérifier chez vous. |
NO_COVERAGE | Pas assez d'artisans disponibles sur ce métier dans ce département. Cela évolue avec notre réseau : à réessayer plus tard. |
Ces codes sont stables, et nous pouvons en ajouter : traitez un motif que vous ne connaissez pas comme un refus.
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/ping" \ -H "Content-Type: application/json" \ -d '{ "postal_code": "75011", "activity_id": "114" }'{ "accepted": false, "reason": "NO_COVERAGE"}