> ## Documentation Index
> Fetch the complete documentation index at: https://developers.avest.fr/llms.txt
> Use this file to discover all available pages before exploring further.

# Mettre à jour un contact

> Met à jour les champs d'identité et le consentement d'un contact existant du périmètre du token. Chaque champ modifié génère une activité d'audit (`ATTRIBUTE_UPDATE`) sur la fiche. Au moins un champ doit être fourni : un objet `consent` seul suffit. Voir le guide [Consentement à la prospection](/guides/consentement).

Les coordonnées (email / téléphone) **ne sont pas modifiables** via cette route. Requiert le droit `PATCH` sur le scope `externalIntegration` de la clé (sinon `403 Not authorized to access this resource`, soit la même réponse qu'une requête sans header `Authorization`).



## OpenAPI

````yaml /openapi.yaml patch /external-integration/contact/{contactId}
openapi: 3.1.0
info:
  title: Avest External Integration API
  version: 1.0.0
  description: >-
    API d'intégration externe Avest. Permet de rechercher des contacts et des
    collaborateurs, de récupérer des transactions (ventes, acquisitions,
    locations) et de créer/mettre à jour des transactions avec déduplication
    automatique.


    Tous les endpoints requièrent un token LinkedAPI (scope
    `externalIntegration`) dont la clé doit avoir un `agencyGroup` configuré.
    Les données sont strictement limitées au périmètre autorisé du token :
    aucune fiche hors `agencyGroup` n'est jamais retournée.
servers:
  - url: https://api.avest.fr/v1
    description: API de production Avest
security:
  - linkedApiToken: []
tags:
  - name: Contacts
    description: Recherche et récupération de contacts.
  - name: Users
    description: Récupération des collaborateurs (annuaire).
  - name: Transactions
    description: Récupération et recherche de ventes, acquisitions et locations.
  - name: Lead generation
    description: Création / mise à jour de transactions (ventes, acquisitions, locations).
  - name: Matches
    description: Récupération et recherche de rapprochements (matches vente / acquisition).
  - name: Activities
    description: Récupération et création des activités liées à un document.
  - name: Ads
    description: Récupération et recherche d'annonces (listings publiques).
  - name: Key
    description: Type de la clé API et méthodes qu'elle autorise.
  - name: Agencies
    description: Découverte des agences accessibles par la clé.
  - name: Shift planning
    description: >-
      Planning de permanence d'une agence, semaine par semaine. Écriture
      réservée aux clés autorisées en écriture.
paths:
  /external-integration/contact/{contactId}:
    patch:
      tags:
        - Contacts
      summary: Mettre à jour un contact
      description: >-
        Met à jour les champs d'identité et le consentement d'un contact
        existant du périmètre du token. Chaque champ modifié génère une activité
        d'audit (`ATTRIBUTE_UPDATE`) sur la fiche. Au moins un champ doit être
        fourni : un objet `consent` seul suffit. Voir le guide [Consentement à
        la prospection](/guides/consentement).


        Les coordonnées (email / téléphone) **ne sont pas modifiables** via
        cette route. Requiert le droit `PATCH` sur le scope
        `externalIntegration` de la clé (sinon `403 Not authorized to access
        this resource`, soit la même réponse qu'une requête sans header
        `Authorization`).
      operationId: updateContact
      parameters:
        - name: contactId
          in: path
          required: true
          description: ObjectId du contact à mettre à jour.
          schema:
            $ref: '#/components/schemas/ObjectId'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateContactBody'
            example:
              firstName: Jean-Pierre
              lastName: Dupont
      responses:
        '200':
          description: Contact mis à jour.
          headers:
            RateLimit-Limit:
              $ref: '#/components/headers/RateLimit-Limit'
            RateLimit-Remaining:
              $ref: '#/components/headers/RateLimit-Remaining'
            RateLimit-Reset:
              $ref: '#/components/headers/RateLimit-Reset'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UpdateContactResponse'
              example:
                success: true
                contact:
                  id: 618a35a36d932054e195ca0a
                  firstName: Jean-Pierre
                  lastName: Dupont
                  contactDetails:
                    - type: email
                      data: jean.dupont@email.com
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '409':
          description: >-
            Contact supprimé définitivement, sur une requête dont le `consent`
            modifierait la fiche (`errorCode` `CONTACT_DELETED`).
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              example:
                success: false
                errorCode: CONTACT_DELETED
                message: 'Contact is locked: deleted'
        '429':
          $ref: '#/components/responses/TooManyRequests'
components:
  schemas:
    ObjectId:
      type: string
      description: Identifiant Mongo (24 caractères hexadécimaux).
      pattern: ^[a-fA-F0-9]{24}$
      example: 618a35a36d932054e195ca0a
    UpdateContactBody:
      type: object
      minProperties: 1
      description: >-
        Au moins un champ doit être fourni : un objet `consent` seul suffit. Les
        coordonnées (email / téléphone) ne sont pas modifiables via cette route.
      properties:
        firstName:
          type: string
        lastName:
          type: string
        title:
          type: string
          enum:
            - mr
            - mme
        commercialName:
          type: string
        corporateName:
          type: string
        siren:
          type: string
        website:
          type: string
        address:
          type: string
        consent:
          $ref: '#/components/schemas/ContactConsent'
    UpdateContactResponse:
      type: object
      properties:
        success:
          type: boolean
          const: true
        contact:
          $ref: '#/components/schemas/Contact'
        consentChanged:
          type: boolean
          description: >-
            Présent quand la requête porte un objet `consent`. `false` quand
            rien n'a été écrit : retirer un canal déjà retiré, ou renvoyer, sur
            un canal encore consenti, un consentement sans date de recueil plus
            récente.
    ErrorResponse:
      type: object
      required:
        - success
        - message
      properties:
        success:
          type: boolean
          const: false
        errorCode:
          type: string
          description: >-
            Code stable, présent sur certaines erreurs seulement (par exemple
            `VISIT_DATE_REQUIRED`, `CONTACT_DELETED`). À préférer à `message`
            pour reconnaître une erreur.
        message:
          type: string
    ContactConsent:
      type: object
      description: >-
        Consentement à la prospection que vous avez recueilli, par canal. Un
        canal consenti exige `date` ; `phone` consenti exige aussi
        `wordingText`, `wordingVersion` et `locale` (sinon `400`). Ne
        transmettez `true` que pour un nouvel accord : sur un canal encore
        consenti, il n'est enregistré que si `date` est postérieure au recueil
        déjà enregistré ; sur un canal retiré depuis, il rétablit le
        consentement. Un canal absent n'est pas modifié. Voir le guide
        [Consentement à la prospection](/guides/consentement).
      properties:
        email:
          type: boolean
          description: Consentement à la prospection par courriel.
        phone:
          type: boolean
          description: Consentement à la prospection téléphonique.
        sms:
          type: boolean
          description: Consentement à la prospection par SMS.
        date:
          type: string
          format: date-time
          description: >-
            Date de recueil, ISO 8601. Obligatoire dès qu'un canal est consenti
            (`true`, ou annoncé par `journey`). Ne peut pas être dans le futur.
        wordingText:
          type: string
          minLength: 1
          maxLength: 5000
          description: >-
            Texte exact de la mention affichée à la personne. Obligatoire si
            `phone` est consenti.
        wordingVersion:
          type: string
          minLength: 1
          maxLength: 64
          description: >-
            Version de la mention, selon votre propre référence. Obligatoire si
            `phone` est consenti.
        locale:
          type: string
          minLength: 2
          maxLength: 10
          description: >-
            Langue de la mention (ex. `fr`). Obligatoire si `phone` est
            consenti.
        details:
          type: string
          minLength: 1
          maxLength: 1000
          description: Contexte du recueil, conservé dans le journal d'audit.
        durationYears:
          type: integer
          minimum: 1
          maximum: 3
          description: >-
            Durée du consentement courriel et SMS, en années, à la création
            comme à la mise à jour ; trois ans si elle est absente. Le réglage
            de durée de l'agence ne s'applique pas. Ne s'applique pas au
            téléphone (un an).
        retentionDurationYears:
          type: integer
          minimum: 1
          maximum: 20
          description: >-
            Durée de conservation, en années. Ne peut que raccourcir la durée
            réglée par l'agence (3 ans par défaut, 10 au plus) : au-delà, elle
            est ramenée à celle-ci, sans erreur.
    Contact:
      type: object
      description: >-
        Contact. `firstName` / `lastName` si `isIndividual: true` ;
        `commercialName` / `corporateName` si entreprise (`isIndividual:
        false`).
      properties:
        id:
          $ref: '#/components/schemas/ObjectId'
        title:
          type: string
          enum:
            - mr
            - mme
        firstName:
          type: string
        lastName:
          type: string
        commercialName:
          type: string
        corporateName:
          type: string
        isIndividual:
          type: boolean
        contactDetails:
          type: array
          items:
            $ref: '#/components/schemas/ContactDetail'
    RateLimitErrorResponse:
      type: object
      required:
        - success
        - message
      properties:
        success:
          type: boolean
          const: false
        message:
          type: string
          example: Rate limit exceeded
        retryAfter:
          type: integer
          description: Secondes avant de pouvoir réessayer.
    ContactDetail:
      type: object
      properties:
        type:
          type: string
          enum:
            - email
            - phone
        data:
          type: string
      required:
        - type
        - data
  headers:
    RateLimit-Limit:
      description: Nombre de requêtes autorisées dans la fenêtre courante.
      schema:
        type: integer
    RateLimit-Remaining:
      description: Requêtes restantes dans la fenêtre courante.
      schema:
        type: integer
    RateLimit-Reset:
      description: Secondes avant la réinitialisation de la fenêtre.
      schema:
        type: integer
    Retry-After:
      description: Secondes à attendre avant de réessayer (présent sur les réponses `429`).
      schema:
        type: integer
  responses:
    BadRequest:
      description: >-
        Requête invalide. Le champ `message` précise la cause (paramètre
        manquant, invalide, mutuellement exclusif, clé de query inconnue,
        `LinkedAPI agencyGroup is required`, etc.).


        Les exemples ci-dessous sont **illustratifs et non exhaustifs** : les
        messages réellement renvoyés dépendent de la route. En particulier, le
        rejet des clés de query inconnues n'est appliqué que par `/contact`,
        `/contacts`, `/user`, `/users` et `/{transaction}/search`.


        La plupart des messages de validation sont préfixés par le contexte qui
        les émet, sous la forme `"<Contexte> : <message>"`. **Ne faites jamais
        de correspondance exacte sur `message`** : basez-vous sur le code HTTP
        et traitez `message` comme du texte destiné au diagnostic.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
          examples:
            unParametreRequis:
              value:
                success: false
                message: One of phone, email, or search is required
            exclusif:
              value:
                success: false
                message: Provide exactly one of phone, email, or search
            queryInconnue:
              value:
                success: false
                message: 'Unsupported query parameter: foo'
            telephoneInvalide:
              value:
                success: false
                message: Invalid phone number
            emailInvalide:
              value:
                success: false
                message: Invalid email
            searchTropCourt:
              value:
                success: false
                message: search must be at least 3 characters
            pageHorsLimites:
              value:
                success: false
                message: page must be <= 100
            agencyGroupManquant:
              value:
                success: false
                message: LinkedAPI agencyGroup is required
    Unauthorized:
      description: >-
        Token invalide. Renvoyé quand le header `Authorization: Bearer` est
        présent mais que sa valeur n'est pas un token exploitable (malformé,
        signature invalide, valeur vide) — `message` vaut alors `Invalid bearer
        token`.


        Un token bien formé mais qui ne correspond plus à aucune clé (révoquée
        ou régénérée) donne aussi un `401`, avec le message `Not authorized to
        access this resource`.


        L'absence du header, une clé en lecture seule et une IP non autorisée
        renvoient un `403`, pas un `401`.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
          examples:
            tokenInvalide:
              value:
                success: false
                message: Invalid bearer token
            cleInconnue:
              value:
                success: false
                message: Not authorized to access this resource
    Forbidden:
      description: >-
        Accès refusé. Trois causes donnent **exactement la même réponse** (même
        code, même `message`) :


        1. le header `Authorization` est absent ;

        2. la clé est en **lecture seule** et la requête est un `POST` ou un
        `PATCH` (voir le guide Authentification) ;

        3. la clé est en mode **sécurisé** et l'IP d'appel, lue dans
        `X-Real-IP`, n'est pas celle autorisée.


        Sur les routes d'écriture, un document lié hors du périmètre de la clé
        renvoie également ce `403`.


        Un `403` sur vos seules écritures alors que vos lectures passent = clé
        en lecture seule.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
          example:
            success: false
            message: Not authorized to access this resource
    TooManyRequests:
      description: >-
        Limite de débit dépassée : limite de la route (par groupe d'agences et
        par chemin) ou limite globale (200 requêtes / 10 s par clé, `message`
        `Too many requests, please try again later`).
      headers:
        Retry-After:
          $ref: '#/components/headers/Retry-After'
        RateLimit-Limit:
          $ref: '#/components/headers/RateLimit-Limit'
        RateLimit-Remaining:
          $ref: '#/components/headers/RateLimit-Remaining'
        RateLimit-Reset:
          $ref: '#/components/headers/RateLimit-Reset'
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/RateLimitErrorResponse'
          example:
            success: false
            message: Rate limit exceeded
            retryAfter: 27
  securitySchemes:
    linkedApiToken:
      type: http
      scheme: bearer
      description: >-
        Token LinkedAPI avec scope `externalIntegration`. La clé doit avoir un
        `agencyGroup` configuré (sinon `400 LinkedAPI agencyGroup is required`).
        Fourni via l'en-tête `Authorization: Bearer {linkedAPI_token}`. Si la
        clé a `secure === true`, l'IP appelante doit être whitelistée (en-tête
        `X-Real-IP`), sinon `403 Not authorized to access this resource`.


        La clé porte aussi un **niveau d'accès** : en lecture seule, elle
        n'autorise que les `GET` ; un `POST` ou un `PATCH` renvoie alors `403
        Not authorized to access this resource`, soit la même réponse qu'une
        requête sans en-tête `Authorization`. Voir le guide Authentification.

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.