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

# Ajouter un bénéficiaire aux favoris

> Permet d'ajouter un beneficiare aux favoris



## OpenAPI

````yaml /openapi.json post /api/v1/users/{referenceUsager}/beneficiaries
openapi: 3.0.1
info:
  title: Registre des APIs (GIM Gar Sud)
  version: 1.0.7
servers:
  - url: https://egimgarsud.gimpayapp.com
    description: Serveur de production
security: []
tags:
  - name: Favorite beneficiaries and mini marketplaces
    description: >-
      Une mini market place est une plateforme de vente de produits et de
      services locaux. On les utilise dans les APIs ...
paths:
  /api/v1/users/{referenceUsager}/beneficiaries:
    post:
      tags:
        - Favorite beneficiaries and mini marketplaces
      summary: Ajouter un bénéficiaire aux favoris
      description: Permet d'ajouter un beneficiare aux favoris
      operationId: addFavoriteBeneficiary
      parameters:
        - name: referenceUsager
          in: path
          description: Identifiant du usager
          required: true
          schema:
            type: string
          example: USER-0012345
        - name: Authorization
          in: header
          required: false
          schema:
            type: string
      requestBody:
        description: Informations du beneficiare à ajouter
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/BeneficiarieRequest'
        required: true
      responses:
        '201':
          description: Bénéficiaire ajouté aux favoris avec succès.
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/ResponseApi'
        '400':
          description: Données de requête invalides.
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/ResponseApi'
        '401':
          description: 'Non autorisé : le token d''authentification est manquant ou invalide.'
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/ResponseApi'
        '409':
          description: 'Conflit : le beneficiare est deja prefere.'
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/ResponseApi'
        '500':
          description: Erreur interne du serveur.
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/ResponseApi'
      security:
        - bearerAuth: []
components:
  schemas:
    BeneficiarieRequest:
      required:
        - refInstrumentBeneficiaire
        - refUsagerBeneficiaire
      type: object
      properties:
        refUsagerBeneficiaire:
          type: string
          description: La reference de l'usager initiateur
          example: USER-000123
        refInstrumentBeneficiaire:
          type: string
          description: La reference de l'instrumentde l'usager initiateur
          example: USER-000123
    ResponseApi:
      type: object
      properties:
        message:
          type: string
        status:
          type: integer
          format: int32
        body:
          type: object
        timestamp:
          type: string
          format: date-time
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT

````