> ## 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.

# Faire avancer l'étape d'une mise en relation

> Fait progresser un match dans l'entonnoir commercial. Seule l'étape est modifiable.

Entonnoir **à sens unique** : une étape de poids supérieur est acceptée (sauts permis) ; une clôture « sans suite » n'est possible qu'à l'étape courante (`MVST` → `MVST_NF`) et exige `stepUpdateReason` ; une régression est refusée, et une étape `_NF` est **terminale** (pas de réouverture via l'API).

Passer en `MVST` exige une **visite active** (ni annulée ni supprimée) sur le match ; sinon `400` avec `errorCode: VISIT_DATE_REQUIRED`. Créez plutôt la visite (`POST .../visit`) : elle fait passer le match en `MVST`.

`MOFA` et `MOFA_NF` ne sont pas accessibles : accepter une offre écrit sur la vente et classe sans suite toutes les autres mises en relation du bien. Action réservée à l'application Avest.



## OpenAPI

````yaml /openapi.yaml patch /external-integration/match/{matchId}
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/match/{matchId}:
    patch:
      tags:
        - Matches
      summary: Faire avancer l'étape d'une mise en relation
      description: >-
        Fait progresser un match dans l'entonnoir commercial. Seule l'étape est
        modifiable.


        Entonnoir **à sens unique** : une étape de poids supérieur est acceptée
        (sauts permis) ; une clôture « sans suite » n'est possible qu'à l'étape
        courante (`MVST` → `MVST_NF`) et exige `stepUpdateReason` ; une
        régression est refusée, et une étape `_NF` est **terminale** (pas de
        réouverture via l'API).


        Passer en `MVST` exige une **visite active** (ni annulée ni supprimée)
        sur le match ; sinon `400` avec `errorCode: VISIT_DATE_REQUIRED`. Créez
        plutôt la visite (`POST .../visit`) : elle fait passer le match en
        `MVST`.


        `MOFA` et `MOFA_NF` ne sont pas accessibles : accepter une offre écrit
        sur la vente et classe sans suite toutes les autres mises en relation du
        bien. Action réservée à l'application Avest.
      operationId: updateMatchStep
      parameters:
        - name: matchId
          in: path
          required: true
          schema:
            $ref: '#/components/schemas/ObjectId'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateMatchStepBody'
      responses:
        '200':
          description: Étape 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:
                $ref: '#/components/schemas/GetMatchResponse'
        '400':
          description: >-
            Requête invalide : étape inconnue ou interdite, régression, clôture
            sans raison, ou passage en `MVST` sans visite active.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                visiteRequise:
                  summary: Passage en MVST sans visite active
                  value:
                    success: false
                    errorCode: VISIT_DATE_REQUIRED
                    message: Visit date required to plan a visit
                regression:
                  value:
                    success: false
                    message: >-
                      ExternalIntegrationUpdateMatchStep : Step regression from
                      MVST to MRQT is not allowed
        '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
    UpdateMatchStepBody:
      type: object
      required:
        - step
      properties:
        step:
          type: string
          description: >-
            Étape cible. `MOFA` et `MOFA_NF` sont exclus (action réservée à
            l'application Avest).
          enum:
            - MSND
            - MSND_NF
            - MRQT
            - MRQT_NF
            - MCNV
            - MCNV_NF
            - MVST
            - MVST_NF
            - MNGT
            - MNGT_NF
            - MOFF
            - MOFF_NF
        stepUpdateReason:
          type: string
          description: Raison du changement. Obligatoire pour une clôture `_NF`.
    GetMatchResponse:
      type: object
      properties:
        success:
          type: boolean
          const: true
        match:
          oneOf:
            - $ref: '#/components/schemas/Match'
            - type: 'null'
    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
    Match:
      type: object
      description: Rapprochement (match) entre une vente et une acquisition.
      properties:
        id:
          $ref: '#/components/schemas/ObjectId'
        customId:
          type: string
        step:
          type: string
          description: >-
            Étape courante du match. 7 étapes ordonnées (`MSND` < `MRQT` <
            `MCNV` < `MVST` < `MNGT` < `MOFF` < `MOFA`), chacune avec une
            variante `_NF` (« sans suite ») indiquant que la mise en relation
            est close à ce stade.
          enum:
            - MSND
            - MSND_NF
            - MRQT
            - MRQT_NF
            - MCNV
            - MCNV_NF
            - MVST
            - MVST_NF
            - MNGT
            - MNGT_NF
            - MOFF
            - MOFF_NF
            - MOFA
            - MOFA_NF
        origin:
          type: string
          nullable: true
          description: Origine du rapprochement.
          enum:
            - auto_matching
            - manual
            - parsing
            - proposition
            - visit_receipt
        sale:
          oneOf:
            - $ref: '#/components/schemas/ObjectId'
            - type: 'null'
          description: ObjectId de la vente liée. `null` si absente.
        acquisition:
          oneOf:
            - $ref: '#/components/schemas/ObjectId'
            - type: 'null'
          description: ObjectId de l'acquisition liée. `null` si absente.
        tags:
          type: array
          items:
            type: string
        createdAt:
          type: string
          format: date-time
    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.
  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:
    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.