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

# Alimenter le planning de permanence d'une semaine

> Remplace le planning de permanence d'**une** semaine ISO pour une agence et un type de transaction. Le corps décrit l'**état complet** de la semaine : tout créneau absent de `shifts` est supprimé. Rejouer le même corps donne le même résultat.

L'écriture ne touche que la semaine visée : les autres semaines et les créneaux de semaine type ne sont jamais modifiés. L'appel est tout ou rien — en cas d'erreur, rien n'est écrit.

Garde-fous : une semaine vide exige `allowEmpty: true` ; `dryRun: true` valide et compte sans écrire ; une agence paramétrée en semaine type est refusée, car ses créneaux datés seraient ignorés par l'attribution.

Requiert l'autorisation **en écriture** sur le scope `externalIntegration` — un token en lecture seule reçoit `401`.



## OpenAPI

````yaml /openapi.yaml post /external-integration/agency/{agencyId}/shift-planning/{transaction}
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/agency/{agencyId}/shift-planning/{transaction}:
    post:
      tags:
        - Shift planning
      summary: Alimenter le planning de permanence d'une semaine
      description: >-
        Remplace le planning de permanence d'**une** semaine ISO pour une agence
        et un type de transaction. Le corps décrit l'**état complet** de la
        semaine : tout créneau absent de `shifts` est supprimé. Rejouer le même
        corps donne le même résultat.


        L'écriture ne touche que la semaine visée : les autres semaines et les
        créneaux de semaine type ne sont jamais modifiés. L'appel est tout ou
        rien — en cas d'erreur, rien n'est écrit.


        Garde-fous : une semaine vide exige `allowEmpty: true` ; `dryRun: true`
        valide et compte sans écrire ; une agence paramétrée en semaine type est
        refusée, car ses créneaux datés seraient ignorés par l'attribution.


        Requiert l'autorisation **en écriture** sur le scope
        `externalIntegration` — un token en lecture seule reçoit `401`.
      operationId: setShiftPlanning
      parameters:
        - $ref: '#/components/parameters/ShiftPlanningAgencyId'
        - $ref: '#/components/parameters/ShiftPlanningTransaction'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/SetShiftPlanningBody'
            examples:
              semaine:
                summary: Une semaine de permanence
                value:
                  year: 2026
                  weekNumber: 37
                  shifts:
                    - userId: 618a35a36d932054e195ca0b
                      day: mon
                      time: am
                    - userId: 618a35a36d932054e195ca0c
                      day: mon
                      time: pm
                    - userId: 618a35a36d932054e195ca0b
                      day: tue
                      time: all
              simulation:
                summary: Simulation, sans écriture
                value:
                  year: 2026
                  weekNumber: 37
                  dryRun: true
                  shifts:
                    - userId: 618a35a36d932054e195ca0b
                      day: mon
                      time: am
              agenceFermee:
                summary: Semaine volontairement vide (agence fermée)
                value:
                  year: 2026
                  weekNumber: 33
                  shifts: []
                  allowEmpty: true
      responses:
        '200':
          description: Semaine remplacée (ou simulée si `dryRun`).
          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/SetShiftPlanningResponse'
              examples:
                succes:
                  summary: Semaine remplacée
                  value:
                    success: true
                    agencyId: 618a35a36d932054e195ca0a
                    transactionType: sale
                    year: 2026
                    weekNumber: 37
                    dryRun: false
                    deletedCount: 2
                    createdCount: 3
                    warnings: []
                avecWarning:
                  summary: Créneau qui ne recevra aucun lead
                  value:
                    success: true
                    agencyId: 618a35a36d932054e195ca0a
                    transactionType: sale
                    year: 2026
                    weekNumber: 37
                    dryRun: false
                    deletedCount: 0
                    createdCount: 1
                    warnings:
                      - code: USER_NOT_ELIGIBLE_FOR_ALLOCATION
                        userId: 618a35a36d932054e195ca0c
                        message: >-
                          User 618a35a36d932054e195ca0c is not eligible for sale
                          allocation in this agency : its shifts will never
                          receive a lead
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '429':
          $ref: '#/components/responses/TooManyRequests'
components:
  parameters:
    ShiftPlanningAgencyId:
      name: agencyId
      in: path
      required: true
      description: >-
        Identifiant de l'agence. Doit appartenir au périmètre autorisé de la
        clé, sinon `400`.
      schema:
        $ref: '#/components/schemas/ObjectId'
    ShiftPlanningTransaction:
      name: transaction
      in: path
      required: true
      description: >-
        Type de transaction — un planning de permanence par type. Toute autre
        valeur répond `404 This route does not exist`.
      schema:
        type: string
        enum:
          - sale
          - acquisition
          - rental
  schemas:
    SetShiftPlanningBody:
      type: object
      required:
        - year
        - weekNumber
        - shifts
      properties:
        year:
          type: integer
          description: Année ISO de la semaine.
          example: 2026
        weekNumber:
          type: integer
          minimum: 1
          maximum: 53
          description: >-
            Numéro de semaine ISO, de 1 au nombre de semaines de l'année (52, ou
            53 les années longues : 2026 en compte 53). Une semaine passée est
            refusée.
          example: 37
        shifts:
          type: array
          maxItems: 500
          description: >-
            État **complet** de la semaine. Tout créneau absent est supprimé.
            Deux créneaux du même collaborateur ne peuvent pas se chevaucher.
          items:
            $ref: '#/components/schemas/ShiftPlanningEntry'
        allowEmpty:
          type: boolean
          default: false
          description: >-
            Obligatoire à `true` pour envoyer une semaine vide. Sans lui, un
            `shifts` vide est refusé : une semaine sans permanence envoie tous
            ses leads en pioche.
        dryRun:
          type: boolean
          default: false
          description: >-
            `true` = joue toutes les validations et renvoie les compteurs, sans
            rien écrire.
      additionalProperties: false
    SetShiftPlanningResponse:
      type: object
      properties:
        success:
          type: boolean
          const: true
        agencyId:
          $ref: '#/components/schemas/ObjectId'
        transactionType:
          type: string
          enum:
            - sale
            - acquisition
            - rental
        year:
          type: integer
        weekNumber:
          type: integer
        dryRun:
          type: boolean
        deletedCount:
          type: integer
          description: Créneaux de cette semaine remplacés.
        createdCount:
          type: integer
          description: Créneaux écrits (ou qui l'auraient été si `dryRun`).
        warnings:
          type: array
          items:
            $ref: '#/components/schemas/ShiftPlanningWarning'
    ObjectId:
      type: string
      description: Identifiant Mongo (24 caractères hexadécimaux).
      pattern: ^[a-fA-F0-9]{24}$
      example: 618a35a36d932054e195ca0a
    ShiftPlanningEntry:
      type: object
      required:
        - userId
        - day
        - time
      properties:
        userId:
          allOf:
            - $ref: '#/components/schemas/ObjectId'
          description: >-
            Identifiant Avest du collaborateur, obtenu via `GET
            /external-integration/users`. Le rapprochement sur prénom + nom
            n'est pas supporté.
        day:
          $ref: '#/components/schemas/ShiftDay'
        time:
          $ref: '#/components/schemas/ShiftTime'
    ShiftPlanningWarning:
      type: object
      description: >-
        Anomalie non bloquante : l'écriture a eu lieu, mais le créneau signalé
        ne servira à rien.
      properties:
        code:
          type: string
          enum:
            - USER_NOT_ELIGIBLE_FOR_ALLOCATION
        userId:
          $ref: '#/components/schemas/ObjectId'
        message:
          type: string
    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.
    ShiftDay:
      type: string
      description: Jour de la semaine.
      enum:
        - mon
        - tue
        - wed
        - thu
        - fri
        - sat
        - sun
    ShiftTime:
      type: string
      description: >-
        Créneau : `am` (matin), `pm` (après-midi) ou `all` (journée entière,
        couvre `am` **et** `pm`).
      enum:
        - am
        - pm
        - all
  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.