Passer au contenu principal
Crée un contact seul dans une agence de votre périmètre.
À éviter dans le cas général. Pour démarrer une affaire (vente, acquisition, location), créez le contact en même temps que la transaction via POST /external-integration/sale, …/acquisition ou …/rental (bloc contact). Ces routes appliquent la déduplication ET l’allocation automatique d’agence / collaborateur.Ne créez JAMAIS un contact via cette route puis une transaction séparément : vous contournez la déduplication et l’allocation, et vous créez des doublons. Cette route n’existe que pour les cas où vous devez créer un contact sans transaction associée.

Endpoint

URL : /external-integration/contact Méthode : POST Authentification : Requiert un token LinkedAPI avec scope externalIntegration et une clé rattachée à un groupe d’agences. Clé requise : lecture-écriture. Une clé en lecture seule reçoit 403. Voir Types de clé.
Un GET /external-integration/contact existe aussi (récupérer un contact). La création utilise la même URL en POST.

Headers

Body Parameters

Consentement

Sans objet consent, le contact est créé sans aucun consentement de prospection — c’est le comportement par défaut. Vous pouvez soit déclarer le parcours dont la personne a vu la mention (consent.journey = sale, rental ou acquisition), soit énoncer chaque canal (email, phone, sms). Dès qu’un canal est consenti, consent.date est obligatoire ; dès que le téléphone l’est — c’est le cas des trois parcours, sauf "phone": false —, la mention affichée l’est aussi (wordingText, wordingVersion, locale). Détail des durées, de la date de recueil et de la traçabilité : Consentement à la prospection.
Sur un contact déjà existant (dédup), un consent transmis est quand même appliqué : Avest l’enregistre comme le recueil que vous déclarez, et non comme une valeur par défaut. Seuls les canaux que vous citez sont écrits : un canal absent de l’objet (sans journey) garde son état, et seul un false explicite retire un consentement. Un canal que la fiche porte déjà consenti n’est renouvelé que si votre date est strictement postérieure à l’accord enregistré. Sinon il est ignoré, sans erreur, et la réponse (201) ne le signale pas. Sur un canal retiré depuis, le même accord le rétablit.

Déduplication

Si un contact existe déjà dans l’agence avec le même téléphone/email, il est réutilisé (pas de doublon) et retourné avec isNew: false. Sinon il est créé (isNew: true).

Exemple de requête

Réponse de succès

Code : 201

Réponses d’erreur

  • agencyId manquant : 400 Bad Request
  • agencyId hors périmètre : 400 Bad Request
  • Ni email ni téléphone : 400 Bad Request
  • Consentement invalide : 400 Bad Request — le contact n’est pas créé. Messages détaillés dans le guide Consentement.
  • Header Authorization absent, clé en lecture seule, ou IP non whitelistée sur une clé sécurisée : 403 Not authorized to access this resource
  • Token invalide : 401 Invalid bearer token

Rate limits

Cette route est limitée à 100 req / minute par groupe d’agences (un compteur par groupe d’agences × route : les autres routes d’écriture ont chacune le leur).
  • Headers : RateLimit-Limit, RateLimit-Remaining, RateLimit-Reset.
  • Dépassement → 429 Too Many Requests avec header Retry-After.