> ## 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 les critères d'une acquisition

> Corrige les critères de recherche d'une fiche acquéreur existante sans repasser par le pipeline leadgen.

`step` n'est pas modifiable ici (voir `/qualify`), pas plus que `customId`, `parsingCustomId`, `mandate`, `owner` et `agency`. Les zones de recherche (`areas`) ne sont pas modifiables non plus.

En cas de modification concurrente : `409` avec le code `TRANSACTION_EDIT_CONFLICT`, rejouer la requête.



## OpenAPI

````yaml /openapi.yaml patch /external-integration/acquisition/{acquisitionId}
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/acquisition/{acquisitionId}:
    patch:
      tags:
        - Transactions
      summary: Mettre à jour les critères d'une acquisition
      description: >-
        Corrige les critères de recherche d'une fiche acquéreur existante sans
        repasser par le pipeline leadgen.


        `step` n'est pas modifiable ici (voir `/qualify`), pas plus que
        `customId`, `parsingCustomId`, `mandate`, `owner` et `agency`. Les zones
        de recherche (`areas`) ne sont pas modifiables non plus.


        En cas de modification concurrente : `409` avec le code
        `TRANSACTION_EDIT_CONFLICT`, rejouer la requête.
      operationId: updateAcquisition
      parameters:
        - name: acquisitionId
          in: path
          required: true
          schema:
            $ref: '#/components/schemas/ObjectId'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateAcquisitionBody'
      responses:
        '200':
          description: Acquisition mise à 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:
                type: object
                properties:
                  success:
                    type: boolean
                  acquisition:
                    $ref: '#/components/schemas/AcquisitionRead'
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '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
    UpdateAcquisitionBody:
      type: object
      description: >-
        Au moins un champ. Critères de recherche uniquement — `step`,
        `customId`, `parsingCustomId`, `mandate`, `owner`, `agency` et `areas`
        ne sont pas modifiables.
      properties:
        project:
          type: string
        activityLevel:
          type: string
        propertiesTypes:
          type: array
          items:
            type: string
        priceRange:
          $ref: '#/components/schemas/Range'
        sizeRange:
          $ref: '#/components/schemas/Range'
        fieldRange:
          $ref: '#/components/schemas/Range'
        roomRange:
          $ref: '#/components/schemas/Range'
        bedroomRange:
          $ref: '#/components/schemas/Range'
        floorRange:
          $ref: '#/components/schemas/Range'
        elevator:
          $ref: '#/components/schemas/NecessityCriteria'
        outdoor:
          $ref: '#/components/schemas/NecessityCriteria'
        parking:
          $ref: '#/components/schemas/NecessityCriteria'
        pool:
          $ref: '#/components/schemas/NecessityCriteria'
        lastFloor:
          $ref: '#/components/schemas/NecessityCriteria'
        groundFloor:
          $ref: '#/components/schemas/NecessityCriteria'
        singleStorey:
          $ref: '#/components/schemas/NecessityCriteria'
        bikeShed:
          type: boolean
          description: Local vélo souhaité.
        mortgage:
          type: boolean
          description: L'acquéreur finance par un crédit.
        purpose:
          type: string
    AcquisitionRead:
      type: object
      description: >-
        Acquisition en lecture. `id`, `customId`, `agency`, `agencyGroup`,
        `step`, `createdAt`, `updatedAt`, `stepUpdatedAt`, `owner` et
        `mainContact` sont toujours présents (si l'acquisition existe). Les
        autres champs sont absents s'ils ne sont pas renseignés.
      properties:
        id:
          $ref: '#/components/schemas/ObjectId'
        customId:
          type: string
        agency:
          $ref: '#/components/schemas/ObjectId'
        agencyGroup:
          $ref: '#/components/schemas/ObjectId'
        step:
          type: string
          description: Étape courante de l'acquisition.
          enum:
            - AQUL
            - ASRC
            - ANGT
            - AOFR
            - ACLS
            - AARC
        createdAt:
          type: string
        updatedAt:
          type: string
          description: Date de dernière modification (ISO 8601).
        stepUpdatedAt:
          type: string
          description: Date du dernier changement d'étape (ISO 8601).
        owner:
          $ref: '#/components/schemas/Owner'
        mainContact:
          oneOf:
            - $ref: '#/components/schemas/ObjectId'
            - type: 'null'
        project:
          type: string
          description: Projet (`buyer`, `buyerSeller`, `buyerOwner`, ...).
        activityLevel:
          type: string
          enum:
            - hot
            - warm
            - cold
            - mandate
        propertiesTypes:
          type: array
          items:
            type: string
        areas:
          type: array
          items:
            $ref: '#/components/schemas/Area'
        priceRange:
          $ref: '#/components/schemas/Range'
        sizeRange:
          $ref: '#/components/schemas/Range'
        roomRange:
          $ref: '#/components/schemas/Range'
        bedroomRange:
          $ref: '#/components/schemas/Range'
        floorRange:
          $ref: '#/components/schemas/Range'
        fieldRange:
          $ref: '#/components/schemas/Range'
        elevator:
          type: string
        outdoor:
          type: string
        parking:
          type: string
        pool:
          type: string
        lastFloor:
          type: string
        groundFloor:
          type: string
        bikeShed:
          type: boolean
        mortgageType:
          type: string
          enum:
            - relay
            - standard
            - none
        mortgage:
          type: boolean
        purpose:
          type: string
          enum:
            - primaryResidence
            - secondaryResidence
            - businessPremise
            - investment
            - propertyTrade
        mandate:
          type: object
          additionalProperties: true
        parsingCustomId:
          type: string
        contacts:
          type: array
          description: Présent dans la réponse de recherche (`/search`).
          items:
            $ref: '#/components/schemas/Contact'
    Range:
      type: object
      description: Fourchette de valeurs.
      properties:
        low:
          type: number
        high:
          type: number
    NecessityCriteria:
      type: string
      description: '`excluded` : critère éliminatoire, le bien ne doit pas en avoir.'
      enum:
        - unnecessary
        - preferable
        - essential
        - excluded
    Owner:
      type: object
      nullable: true
      description: Utilisateur Avest responsable du dossier. `null` si non attribué.
      properties:
        id:
          $ref: '#/components/schemas/ObjectId'
        firstName:
          type: string
        lastName:
          type: string
        picture:
          type: string
          description: URL de la photo (optionnelle).
    Area:
      type: object
      properties:
        type:
          type: string
          enum:
            - postalCode
            - inseeCode
            - departmentCode
            - geometry
        postalCode:
          type: string
        inseeCode:
          type: string
        countryCode:
          type: string
          description: Code pays ISO 3166-1 alpha-2.
        addresses:
          type: array
          items:
            type: object
            additionalProperties: true
        geometry:
          type: object
          additionalProperties: true
          description: Polygone GeoJSON, si `type = geometry`.
        center:
          type: object
          additionalProperties: true
          description: >-
            Centre d'une zone tracée en cercle dans Avest (GeoJSON `Point`), si
            `type = geometry`.
        radius:
          type: number
          description: Rayon de ce cercle, en km.
    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'
    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
    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.