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

# Envoyer un e-mail transactionnel

> Envoie à partir d'un modèle transactionnel (`template`) ou d'un HTML fourni (`html`). L'e-mail est journalisé, suivi (ouvertures, clics si le modèle le demande) et compté dans le quota. Sans `to`, les destinataires par défaut du modèle sont utilisés.



## OpenAPI

````yaml /api-reference/openapi.fr.json post /api/v1/transactional-mails/send
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/transactional-mails/send:
    post:
      tags:
        - E-mails transactionnels
      summary: Envoyer un e-mail transactionnel
      description: >-
        Envoie à partir d'un modèle transactionnel (`template`) ou d'un HTML
        fourni (`html`). L'e-mail est journalisé, suivi (ouvertures, clics si le
        modèle le demande) et compté dans le quota. Sans `to`, les destinataires
        par défaut du modèle sont utilisés.
      operationId: api.transactional.send
      parameters:
        - $ref: '#/components/parameters/IdempotencyKey'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                template:
                  type:
                    - string
                    - 'null'
                  description: Nom d'un modèle transactionnel de l'équipe.
                html:
                  type:
                    - string
                    - 'null'
                  description: Corps HTML, si aucun modèle n'est donné.
                subject:
                  type:
                    - string
                    - 'null'
                  description: Remplace l'objet du modèle.
                to:
                  type: array
                  items:
                    type: string
                    format: email
                cc:
                  type: array
                  items:
                    type: string
                    format: email
                bcc:
                  type: array
                  items:
                    type: string
                    format: email
                variables:
                  type: object
                  additionalProperties: true
                  description: >-
                    Remplissent le modèle : {{ order.number }}, boucles {% for
                    %}…
                locale:
                  type:
                    - string
                    - 'null'
                  description: >-
                    Version linguistique du modèle à envoyer (fr, pt-BR…). Sans
                    valeur, la version de base.
                from_email:
                  type:
                    - string
                    - 'null'
                  format: email
                from_name:
                  type:
                    - string
                    - 'null'
                reply_to:
                  type:
                    - string
                    - 'null'
                  format: email
                mailer:
                  type:
                    - string
                    - 'null'
                  description: Nom d'un fournisseur configuré, pour forcer celui-ci.
                attachments:
                  type: array
                  maxItems: 10
                  items:
                    type: object
                    required:
                      - name
                      - content
                    properties:
                      name:
                        type: string
                      content:
                        type: string
                        format: byte
                        description: Contenu encodé en base64.
                      mime:
                        type: string
                        example: application/pdf
            example:
              template: confirmation-commande
              to:
                - ada@example.com
              locale: fr
              variables:
                customer:
                  name: Ada
                order:
                  number: A-1024
                  lines:
                    - Pain au levain
                    - Brioche
      responses:
        '201':
          description: E-mail envoyé.
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    $ref: '#/components/schemas/TransactionalMail'
        '401':
          $ref: '#/components/responses/Unauthenticated'
        '403':
          $ref: '#/components/responses/Forbidden'
        '422':
          description: >-
            Données invalides, modèle inconnu, ni modèle ni HTML, aucun
            destinataire, ou expéditeur non autorisé.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ValidationError'
        '429':
          $ref: '#/components/responses/TooManyRequests'
        '502':
          description: >-
            Le fournisseur a refusé l'envoi ; l'e-mail est journalisé avec la
            raison.
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    $ref: '#/components/schemas/TransactionalMail'
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:
    TransactionalMail:
      type: object
      properties:
        id:
          type: string
          format: uuid
        template:
          type:
            - string
            - 'null'
          description: Nom du modèle utilisé, s'il y en a un.
        subject:
          type: string
        from:
          type: string
          format: email
        to:
          type: array
          items:
            type: string
            format: email
        cc:
          type: array
          items:
            type: string
            format: email
        bcc:
          type: array
          items:
            type: string
            format: email
        status:
          type: string
          enum:
            - pending
            - sent
            - failed
        failure_reason:
          type:
            - string
            - 'null'
        opens:
          type: integer
        clicks:
          type: integer
        sent_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'
    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.

````