Passer au contenu principal
Crée ou met à jour une location (fiche bailleur / gestion locative) avec déduplication automatique du contact et de la transaction.

Endpoint

URL : /external-integration/rental Méthode : POST Authentification : Requiert un token LinkedAPI. Clé requise : lecture-écriture. Une clé en lecture seule reçoit 403. Voir Types de clé.

Headers

Logique de fonctionnement

1. Déduplication Contact

  • Recherche d’un contact existant par téléphone ou email dans le groupe d’agences
  • Si trouvé : mise à jour des informations
  • Si non trouvé : création d’un nouveau contact

2. Déduplication Transaction

  • Si contact existant, recherche de la location la plus récente de ce contact à la même adresse, quelle que soit son étape (voir Déduplication)
  • Si trouvée : mise à jour de la location existante
  • Si non trouvée : création d’une nouvelle location

3. Allocation

  • Attribution automatique d’un utilisateur et d’une agence selon les règles configurées
  • Possibilité de forcer l’allocation via settings.allocation

4. Routing Step

  • Calcul automatique de l’étape selon le projet et la configuration de l’agence
  • Possibilité de forcer l’étape d’une nouvelle location via settings.step. Sur une location retrouvée, l’étape ne change pas, sauf une location archivée (RARC), rouverte à l’étape calculée ou à settings.step

5. Activités optionnelles

  • Appointment : Crée une activité de type “meeting” avec date, heures et note
  • Note : Crée une activité de type “note” avec titre et contenu

Body Parameters

Structure complète

Détail des paramètres

settings.allocation

Sans agencyId, l’attribution est automatique, parmi les agences du groupe.

settings.disableAlerts

settings.step

Étapes prospects bailleurs

Étapes mandats de gestion (après signature mandat)

appointment

Crée une activité de type “meeting” (rendez-vous) liée à la transaction.
Le titre de l’activité sera automatiquement défini comme “Rendez-vous estimation”.

note

Crée une activité de type “note” liée à la transaction.

contact

address

transaction (TransactionRental)

Projet et identifiant

Valeurs de project

Propriété (transaction.property)

La règle du DPE d’un bien professionnel est celle de POST Sale : les étiquettes transmises sont gardées telles quelles.

Estimations et valeurs

Mandat (transaction.mandate)

Timeline (transaction.timeline)

Exemple complet

Les agencyGroupId et agencyId de l’exemple sont ceux de l’exemple de GET Agencies : remplacez-les par ceux que GET Agencies renvoie pour votre clé, et userId par un collaborateur de cette agence (GET Users liste ceux du groupe).

Réponse de succès

Code : 200
transaction.property.addressData est l’adresse reconnue et enregistrée sur le bien, au format de GET Rental ; transaction.property.addresses la contient aussi. Comparez-la à l’address envoyée pour repérer une adresse mal reconnue. Elle n’est pas renvoyée si la fiche est attribuée à une agence que votre clé ne couvre pas, comme sur GET.

Réponses d’erreur

  • Settings manquants : 400 Bad Request
  • Allocation manquante : 400 Bad Request
  • AgencyGroupId manquant : 400 Bad Request
  • Groupe d’agences hors du périmètre de votre clé : 400 Bad Request, aucun lead créé
  • Agence de votre groupe que votre clé ne couvre pas, ou désactivée : 400 Bad Request, aucun lead créé (une agence d’un autre groupe reçoit, avec le même préfixe, Agency group ID is not the same as the agency group ID)
  • Adresse manquante : 400 Bad Request
  • Property manquant : 400 Bad Request
  • Project manquant : 400 Bad Request

Notes importantes

  1. Déduplication : Par défaut, si un contact existe avec le même téléphone/email, la location existante à la même adresse sera mise à jour plutôt que d’en créer une nouvelle.
  2. Allocation automatique : Sans agencyId/userId, le système alloue automatiquement selon les règles configurées (zones, shifts, priorité contact, etc.)
  3. Activités : appointment et note créent des activités séparées liées à la transaction. En cas d’erreur sur ces créations, la transaction est quand même créée (notification Slack envoyée).
  4. Steps : Si settings.step n’est pas fourni, l’étape est calculée automatiquement selon le project et la configuration de l’agence.
  5. Identifiant externe : parsingCustomId est enregistré sur la fiche et renvoyé en lecture, mais il ne sert pas au dédoublonnage. Deux envois avec le même parsingCustomId peuvent créer deux locations. Conservez l’id renvoyé à la création pour retrouver la fiche.

Rate limits

Cette route est limitée à 100 req / minute par groupe d’agences (bucket dédié, indépendant des autres routes).
  • Headers présents sur toutes les réponses : RateLimit-Limit, RateLimit-Remaining, RateLimit-Reset (secondes avant reset).
  • Dépassement → 429 Too Many Requests avec header Retry-After (secondes) :
  • Si vous atteignez régulièrement la limite, contactez le support pour évaluer un relèvement sur votre token.