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

# Inscrire une adresse

> Inscrit l'adresse, ou met à jour l'abonné s'il est déjà dans la liste. Sur une liste en double opt-in, l'abonné reste « unconfirmed » et reçoit l'e-mail de confirmation, sauf si `skip_confirmation` est vrai. Une adresse de la liste de suppression est refusée.



## OpenAPI

````yaml /api-reference/openapi.fr.json post /api/v1/lists/{list}/subscribers
openapi: 3.1.0
info:
  title: API Lekalao
  version: 1.0.0
  description: >-
    Tout ce que fait l'interface, votre application peut le faire aussi. Chaque
    appel porte un jeton d'API (Paramètres → Jetons d'API).
servers:
  - url: https://{host}
    description: Votre installation
    variables:
      host:
        default: lekalao.example.com
        description: Le domaine de votre Lekalao
security:
  - bearer: []
tags:
  - name: Listes
  - name: Abonnés
  - name: Tags
  - name: Segments
  - name: Imports
  - name: Modèles
  - name: Campagnes
  - name: Automatisations
  - name: E-mails transactionnels
  - name: Revenu
  - name: Plateforme
paths:
  /api/v1/lists/{list}/subscribers:
    post:
      tags:
        - Abonnés
      summary: Inscrire une adresse
      description: >-
        Inscrit l'adresse, ou met à jour l'abonné s'il est déjà dans la liste.
        Sur une liste en double opt-in, l'abonné reste « unconfirmed » et reçoit
        l'e-mail de confirmation, sauf si `skip_confirmation` est vrai. Une
        adresse de la liste de suppression est refusée.
      operationId: api.subscribers.store
      parameters:
        - name: list
          in: path
          required: true
          schema:
            type: string
            format: uuid
          description: L'identifiant (uuid) de la liste.
        - $ref: '#/components/parameters/IdempotencyKey'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              allOf:
                - $ref: '#/components/schemas/SubscriberInput'
                - type: object
                  properties:
                    skip_confirmation:
                      type: boolean
                      default: false
                      description: >-
                        Inscrit directement, même en double opt-in. À réserver
                        aux consentements déjà recueillis.
            example:
              email: ada@example.com
              first_name: Ada
              locale: fr
              attributes:
                ville: Douala
              tags:
                - client
      responses:
        '201':
          description: L'abonné, créé ou mis à jour.
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    $ref: '#/components/schemas/Subscriber'
              example:
                data:
                  id: 9d5c2a1e-8f3b-4c7a-9e21-3b8f0c6d4a12
                  email: ada@example.com
                  first_name: Ada
                  last_name: Lovelace
                  timezone: Africa/Douala
                  locale: fr
                  status: subscribed
                  tags:
                    - client
                    - vip
                  attributes:
                    ville: Douala
                  subscribed_at: '2026-09-17T09:30:00+00:00'
                  unsubscribed_at: null
                  created_at: '2026-09-17T09:30:00+00:00'
        '401':
          $ref: '#/components/responses/Unauthenticated'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          $ref: '#/components/responses/NotFound'
        '422':
          description: >-
            Données invalides, ou adresse bloquée (« This address is blocked.
            »).
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ValidationError'
        '429':
          $ref: '#/components/responses/TooManyRequests'
components:
  parameters:
    IdempotencyKey:
      name: Idempotency-Key
      in: header
      required: false
      schema:
        type: string
        maxLength: 255
      description: >-
        Rejouez une écriture sans risque : la même clé rend la première réponse
        pendant 24 heures (en-tête Idempotent-Replay: true).
  schemas:
    SubscriberInput:
      type: object
      required:
        - email
      properties:
        email:
          type: string
          format: email
          maxLength: 255
        first_name:
          type:
            - string
            - 'null'
          maxLength: 255
        last_name:
          type:
            - string
            - 'null'
          maxLength: 255
        timezone:
          type:
            - string
            - 'null'
          description: Fuseau IANA valide.
        locale:
          type:
            - string
            - 'null'
          description: Code ISO 639-1, avec région facultative (fr, en, pt-BR).
        attributes:
          type: object
          additionalProperties: true
          description: Fusionnés avec les attributs existants.
        tags:
          type: array
          items:
            type: string
            maxLength: 255
          description: Ajoutés à ceux de l'abonné ; un tag inconnu est créé.
    Subscriber:
      type: object
      properties:
        id:
          type: string
          format: uuid
        email:
          type: string
          format: email
        first_name:
          type:
            - string
            - 'null'
        last_name:
          type:
            - string
            - 'null'
        timezone:
          type:
            - string
            - 'null'
          description: 'Fuseau IANA, par exemple Africa/Douala. Vide : celui de la liste.'
        locale:
          type:
            - string
            - 'null'
          description: 'Langue de lecture. Vide : celle de la liste.'
        status:
          type: string
          enum:
            - unconfirmed
            - subscribed
            - unsubscribed
        tags:
          type: array
          items:
            type: string
          description: >-
            Présent quand les tags sont chargés (lecture, création, mise à
            jour).
        attributes:
          type: object
          additionalProperties: true
          description: Vos propres champs.
        list:
          type: string
          format: uuid
          description: Présent sur la lecture d'un abonné.
        subscribed_at:
          type:
            - string
            - 'null'
          format: date-time
        unsubscribed_at:
          type:
            - string
            - 'null'
          format: date-time
        created_at:
          type: string
          format: date-time
    ValidationError:
      type: object
      properties:
        message:
          type: string
          example: Le champ email doit être une adresse e-mail valide.
        errors:
          type: object
          additionalProperties:
            type: array
            items:
              type: string
    Message:
      type: object
      properties:
        message:
          type: string
  responses:
    Unauthenticated:
      description: Aucun jeton, ou un jeton invalide ou révoqué.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Message'
          example:
            message: Unauthenticated.
    Forbidden:
      description: Le jeton n'a pas l'aptitude requise, ou l'équipe est suspendue.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Message'
    NotFound:
      description: Aucune ressource de ce uuid dans l'équipe du jeton.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Message'
    TooManyRequests:
      description: >-
        Limite du jeton atteinte. Attendez le nombre de secondes indiqué par
        Retry-After.
      headers:
        X-RateLimit-Limit:
          schema:
            type: integer
          description: Appels permis par minute pour ce jeton.
        X-RateLimit-Remaining:
          schema:
            type: integer
        Retry-After:
          schema:
            type: integer
  securitySchemes:
    bearer:
      type: http
      scheme: bearer
      description: >-
        Jeton d'API. Aptitude « read » : routes GET seulement. « read + write »
        : toutes les routes.

````