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

# Clôturer, rouvrir une activité ou corriger une note

> Met à jour une activité existante — principalement pour **clôturer un rappel** honoré depuis un outil tiers, afin qu'il cesse de remonter dans les relances du négociateur.

`completionDate` accepte une date ISO 8601 pour clôturer, ou `null` pour rouvrir. `reason` consigne le résultat de l'action (le champ que l'interface Avest renseigne pour un appel). `owner` réattribue l'activité au collaborateur qui l'a réellement traitée. `content` remplace le texte d'une **note** (et uniquement d'une note), avec la même mise en forme qu'à la création.

Clôturer déclenche les mêmes effets que depuis l'interface, dont les séquences branchées sur la clôture d'activité. Renvoyer une `completionDate` sur une activité **déjà close** met simplement la date à jour, sans rejouer ces effets : un rejeu est donc sans conséquence.

Périmètre : les mêmes types que `POST /external-integration/activity` (`note`, `task`, `call`, `message`, `email`, `meeting`, `appointment`). Les activités système (changement d'étape, séquence, commandes) sont de l'historique et ne sont pas modifiables ; les visites et offres de match gardent leurs routes dédiées, car les clôturer pilote l'étape du match.



## OpenAPI

````yaml /openapi.yaml patch /external-integration/activity/{activityId}
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/activity/{activityId}:
    patch:
      tags:
        - Activities
      summary: Clôturer, rouvrir une activité ou corriger une note
      description: >-
        Met à jour une activité existante — principalement pour **clôturer un
        rappel** honoré depuis un outil tiers, afin qu'il cesse de remonter dans
        les relances du négociateur.


        `completionDate` accepte une date ISO 8601 pour clôturer, ou `null` pour
        rouvrir. `reason` consigne le résultat de l'action (le champ que
        l'interface Avest renseigne pour un appel). `owner` réattribue
        l'activité au collaborateur qui l'a réellement traitée. `content`
        remplace le texte d'une **note** (et uniquement d'une note), avec la
        même mise en forme qu'à la création.


        Clôturer déclenche les mêmes effets que depuis l'interface, dont les
        séquences branchées sur la clôture d'activité. Renvoyer une
        `completionDate` sur une activité **déjà close** met simplement la date
        à jour, sans rejouer ces effets : un rejeu est donc sans conséquence.


        Périmètre : les mêmes types que `POST /external-integration/activity`
        (`note`, `task`, `call`, `message`, `email`, `meeting`, `appointment`).
        Les activités système (changement d'étape, séquence, commandes) sont de
        l'historique et ne sont pas modifiables ; les visites et offres de match
        gardent leurs routes dédiées, car les clôturer pilote l'étape du match.
      operationId: updateActivity
      parameters:
        - name: activityId
          in: path
          required: true
          description: ObjectId de l'activité.
          schema:
            $ref: '#/components/schemas/ObjectId'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateActivityBody'
            examples:
              complete:
                summary: Clôturer un rappel honoré
                value:
                  completionDate: '2026-08-12T10:32:00.000Z'
                  reason: Répondu
              reassign:
                summary: Clôturer au nom du collaborateur qui a appelé
                value:
                  completionDate: '2026-08-12T10:32:00.000Z'
                  owner: 6939530d9200187f19a2707d
              reopen:
                summary: Rouvrir une activité clôturée par erreur
                value:
                  completionDate: null
              editNote:
                summary: Corriger le texte d'une note
                value:
                  content: |-
                    Visite du bien avec M. Martin.

                    Rappeler le 14/04 pour une offre.
      responses:
        '200':
          description: Activité 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/CreateActivityResponse'
              example:
                success: true
                activity:
                  id: 6a04a0aed4948142783f8ce0
                  type: call
                  startAt: null
                  endAt: null
                  deadline: '2026-08-12T09:00:00.000Z'
                  completionDate: '2026-08-12T10:32:00.000Z'
                  pinned: false
                  owner: 6939530d9200187f19a2707d
                  linkedDocument: 6a04a0aed4948142783f8cdf
                  linkedModel: sale
                  data:
                    title: Rappeler M. Dupont
                    content: Relance après estimation.
                    reason: Répondu
                  file: null
                  driveLinks: []
                  createdAt: '2026-08-04T10:00:00.000Z'
                  updatedAt: '2026-08-12T10:32:00.000Z'
        '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
    UpdateActivityBody:
      type: object
      description: >-
        Au moins un champ parmi `completionDate`, `reason`, `content` et
        `owner`.
      properties:
        completionDate:
          type: string
          nullable: true
          description: >-
            Date ISO 8601 de réalisation pour clôturer l'activité, ou `null`
            pour la rouvrir. Sur une activité déjà close, la date est mise à
            jour sans rejouer les effets de la clôture.
        reason:
          type: string
          description: >-
            Résultat de l'action, tel que l'interface Avest le consigne pour un
            appel (faux numéro, non répondu, répondu, …). Stocké dans
            `data.reason`.
        owner:
          allOf:
            - $ref: '#/components/schemas/ObjectId'
          description: >-
            Collaborateur ayant réellement traité l'activité. Doit appartenir
            aux agences de votre clé et, sur une vente, à l'agence de la vente.
            Sinon la requête est refusée (`400`) et rien n'est écrit : `owner is
            not in the authorized scope of this LinkedAPI` ou `Activity's sale
            owner not found`. `GET /users` ne renvoie pas les agences d'un
            collaborateur : en cas de doute, omettez `owner`.
        content:
          type: string
          description: >-
            Nouveau texte d'une activité `note` — refusé sur tout autre type.
            Remplace `data.content` en entier. Texte brut ou HTML, avec la même
            mise en forme qu'à la création (un texte brut avec des `\n` est
            converti en paragraphes HTML).
    CreateActivityResponse:
      type: object
      properties:
        success:
          type: boolean
          const: true
        activity:
          $ref: '#/components/schemas/Activity'
    Activity:
      type: object
      description: >-
        Activité liée à un document Avest (note, tâche, appel, email, changement
        d'étape, etc.).
      properties:
        id:
          $ref: '#/components/schemas/ObjectId'
        type:
          type: string
          description: >-
            Type d'activité (`note`, `task`, `call`, `email`, `meeting`,
            `changeStep`, ...).
        startAt:
          type: string
          format: date-time
          nullable: true
        endAt:
          type: string
          format: date-time
          nullable: true
        deadline:
          type: string
          format: date-time
          nullable: true
        completionDate:
          type: string
          format: date-time
          nullable: true
        pinned:
          type: boolean
        owner:
          oneOf:
            - $ref: '#/components/schemas/ObjectId'
            - type: 'null'
          description: ObjectId de l'utilisateur auteur. `null` si non renseigné.
        linkedDocument:
          oneOf:
            - $ref: '#/components/schemas/ObjectId'
            - type: 'null'
          description: ObjectId du document lié. `null` si non renseigné.
        linkedModel:
          type: string
          description: Type du document lié.
        data:
          type: object
          nullable: true
          additionalProperties: true
          description: >-
            Données propres à l'activité. La forme dépend du `type` de
            l'activité. `null` si absent. Les chemins sensibles peuvent être
            masqués. Pour `changeStep` : `from` et `to` ; sur une vente,
            `isAutomatic: true` quand Avest a changé l'étape seul (séquence de
            relance, par exemple).
        file:
          oneOf:
            - $ref: '#/components/schemas/ActivityFile'
            - type: 'null'
        driveLinks:
          type: array
          items:
            type: string
        createdAt:
          type: string
          format: date-time
        updatedAt:
          type: string
          format: date-time
    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.
    ActivityFile:
      type: object
      description: Fichier attaché à une activité.
      properties:
        name:
          type: string
        mimetype:
          type: string
        size:
          type: integer
        url:
          oneOf:
            - type: string
            - type: 'null'
          description: >-
            URL S3 signée temporaire (privée), `null` si le lien n'a pas pu être
            généré.
  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.