Recevoir les prospects

GF

Équipe HUSSTEER · mis à jour 2026-09-16 · 5 min

Le formulaire « Je suis intéressé » de votre site crée un contact directement dans Hussteer, rattaché au bien concerné.

Envoyer un prospect

POST/api/v1/leads

Crée un contact dans Hussteer depuis le formulaire du site. Si `propertyId` est fourni, le prospect est **rattaché au bien** et l'agent le voit sur la fiche. Un contact portant le même e-mail dans l'agence est **réutilisé** plutôt que dupliqué. Envoyez un en-tête `Idempotency-Key` : une requête rejouée par le réseau rendra `200` et le même contact, au lieu de créer un doublon.

Paramètres

  • Idempotency-Key (header) — Identifiant unique de la soumission, choisi par votre site.

Corps de la requête

{
  "firstName": "Camille",
  "lastName": "Mercier",
  "email": "camille.mercier@example.fr",
  "phone": "06 60 90 50 20",
  "message": "Je souhaite visiter ce bien.",
  "propertyId": "11111111-1111-1111-1111-111111111111",
  "consent": true
}

Réponses

  • 200 — Requête déjà traitée sous la même `Idempotency-Key` : rien n'a été écrit une seconde fois.
  • 201 — Prospect créé.
  • 401
  • 403
  • 413
  • 422 — Données refusées. `error.fields` dit quel champ et pourquoi.
  • 429
curl -X POST 'https://hussteer.com/api/v1/leads' \
  -H 'Authorization: Bearer hus_at_example' \
  -H 'Content-Type: application/json' \
  -H 'Idempotency-Key: form-2026-09-16-a1b2c3' \
  -d '{
    "firstName": "Camille",
    "lastName": "Mercier",
    "email": "camille.mercier@example.fr",
    "phone": "06 60 90 50 20",
    "message": "Je souhaite visiter ce bien.",
    "propertyId": "11111111-1111-1111-1111-111111111111",
    "consent": true
  }'

Ce qui est exigé

  • un nom (prénom et/ou nom) ;
  • au moins un moyen de rappeler : e-mail OU téléphone. Les deux valent mieux.
  • tout le reste est facultatif ; les champs inconnus sont ignorés, pas refusés.

Rattacher au bien

Avec `propertyId`, le prospect apparaît directement sur la fiche du bien, dans les contacts associés. L'agent voit donc « cette personne vient du site et s'intéresse à ce bien » sans avoir à le déduire.

Le bien doit appartenir à votre agence et être publiable. Sinon la réponse est 422 sur le champ `propertyId` — jamais 404, qui vous apprendrait si l'identifiant existe ailleurs.

Doublons

Un contact portant la même adresse e-mail dans l'agence est RÉUTILISÉ : la réponse porte alors `contact_reused: true`. Deux personnes qui partagent un numéro de téléphone, en revanche, ne sont jamais fusionnées automatiquement — c'est la règle du module Contacts, et l'API ne s'en écarte pas.

Idempotence

Envoyez un en-tête `Idempotency-Key` propre à chaque soumission de formulaire. Si le réseau vous fait rejouer la requête, Hussteer rend 200 et le même contact, au lieu de créer un doublon. Une vraie création rend 201 : vos journaux distinguent donc les deux sans lire le corps.

Consentement

Le champ `consent` est un booléen. Ne l'envoyez que si votre formulaire pose réellement la question : omettre le champ signifie « non renseigné », ce qui n'est pas la même chose qu'un refus.

Formulaires attaqués

  • corps limité à 16 Ko, message à 4 000 caractères ;
  • les chevrons et les caractères de contrôle sont neutralisés ;
  • 30 écritures par minute et par intégration ;
  • prévoyez tout de même un anti-robot sur votre formulaire : l'API protège Hussteer, pas votre page.

Cet article vous a-t-il été utile ?