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

# Send Transactional Email

> Send an email from a template to one recipient now, or schedule it with sendAt

Guide: [Schedule one email yourself](https://docs.minimo.it/embedded/schedule-email.md). Errors: [Errors and limits](https://docs.minimo.it/embedded/errors.md).


## OpenAPI

````yaml post /public/v1/transactionals
openapi: 3.1.0
info:
  title: API Documentation
  description: Documentation for transactional and subscribe APIs
  version: 1.0.0
servers:
  - url: https://app.minimo.it
security:
  - bearerAuth: []
paths:
  /public/v1/transactionals:
    servers:
      - url: https://api.minimo.it
    post:
      summary: Send transactional email
      description: >-
        Sends one email from a template of your workspace to one recipient. With
        `tenant`, a restaurant's own copy of the template is used when it has
        one.


        Add `sendAt` to schedule the email instead of sending it now. The answer
        is HTTP `201` both times: read `status` inside (`200` sent now, `202`
        scheduled).
      operationId: sendTransactional
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                transactional:
                  type: string
                  description: Template uid (7 characters). `uid` works too.
                  example: TRF4MS9
                recipient:
                  type: string
                  description: Email address of the recipient.
                  example: guest@example.com
                customFields:
                  type: object
                  description: >-
                    Values for the template's merge fields, such as
                    `{GUEST_NAME}`. Keys are turned to capitals. Other top-level
                    keys you send are used as merge fields too.
                  example:
                    GUEST_NAME: Anna
                tenant:
                  type: string
                  maxLength: 64
                  description: >-
                    The restaurant this email is for. Stored on the message for
                    statistics and billing.
                  example: restaurant_4812
                senderId:
                  type: integer
                  description: A sender id from List Senders. Its domain must be verified.
                  example: 34
                from:
                  type: string
                  description: >-
                    `"Name <address>"` or an address under a verified domain of
                    your workspace.
                  example: Trattoria da Mario <bookings@yoursaas.example>
                fromAddress:
                  type: string
                  description: >-
                    Same as `from`, address only. At most one of `senderId`,
                    `from`, `fromAddress`.
                fromName:
                  type: string
                  description: Display name of the sender.
                replyTo:
                  type: string
                  maxLength: 320
                  description: >-
                    Where replies go. Any mailbox. A malformed value answers
                    `422 INVALID_REPLY_TO`.
                  example: owner@trattoriadamario.example
                sendAt:
                  type: string
                  description: >-
                    Schedule the email: ISO 8601 **with the UTC offset**, in the
                    future, at most 90 days ahead. Not for sign-in, verification
                    or one-time-code emails.
                  example: '2026-11-19T20:30:00+01:00'
                idempotencyKey:
                  type: string
                  description: >-
                    With `sendAt`: the same key again returns the email already
                    scheduled (`duplicate: true`).
                  example: booking-4812-reminder
                cancellationKey:
                  type: string
                  description: >-
                    With `sendAt`: groups emails you may cancel together with
                    Cancel Scheduled Emails.
                  example: booking-4812
              required:
                - transactional
                - recipient
            examples:
              now:
                summary: Send now
                value:
                  transactional: TRF4MS9
                  recipient: guest@example.com
                  tenant: restaurant_4812
                  customFields:
                    GUEST_NAME: Anna
                    BOOKING_TIME: '20:30'
              scheduled:
                summary: Schedule with sendAt
                value:
                  transactional: TRF4MS9
                  recipient: guest@example.com
                  tenant: restaurant_4812
                  customFields:
                    GUEST_NAME: Anna
                    BOOKING_TIME: '20:30'
                  sendAt: '2026-11-19T20:30:00+01:00'
                  idempotencyKey: booking-4812-reminder
                  cancellationKey: booking-4812
      responses:
        '201':
          description: >-
            Sent (`status: 200`) or scheduled (`status: 202`). `sent: 0` with a
            `reason` means nothing was sent (for example no subject, or no
            marketing consent).
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: object
                    properties:
                      status:
                        type: integer
                        enum:
                          - 200
                          - 202
                        description: '`200` sent now, `202` scheduled.'
                      sent:
                        type: integer
                        description: Emails sent now.
                      scheduled:
                        $ref: '#/components/schemas/ScheduledEmail'
                        description: With `sendAt` only. Also has `duplicate`.
                      reason:
                        type: string
                        description: Why nothing was sent.
                      skippedNoConsent:
                        type: integer
                        description: Recipients skipped for missing marketing consent.
              examples:
                now:
                  summary: Sent now
                  value:
                    data:
                      status: 200
                      sent: 1
                scheduled:
                  summary: Scheduled
                  value:
                    data:
                      status: 202
                      sent: 0
                      scheduled:
                        id: 1042
                        status: pending
                        sendAt: '2026-11-19T19:30:00.000Z'
                        recipient: guest@example.com
                        transactional: TRF4MS9
                        tenant: restaurant_4812
                        cancellationKey: booking-4812
                        idempotencyKey: booking-4812-reminder
                        duplicate: false
        '400':
          description: >-
            Missing `transactional` or `recipient`, or a template id that is not
            valid.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
        '401':
          description: >-
            `INVALID_TOKEN`: missing or wrong key, or a key without the
            **Transactional** permission.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
        '404':
          description: '`TEMPLATE_NOT_FOUND`: no template with that uid in your workspace.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
        '422':
          description: >-
            `MARKETING_CONSENT_REQUIRED`, `INVALID_SEND_AT`,
            `SEND_AT_NOT_ALLOWED`, `INVALID_TENANT`, `INVALID_REPLY_TO` or a
            sender error. See [Errors and limits](/embedded/errors#sending).
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
      security:
        - bearerAuth: []
      x-codeSamples:
        - label: cURL
          lang: bash
          source: |-
            curl --request POST \
              --url 'https://api.minimo.it/public/v1/transactionals' \
              --header 'Authorization: Bearer YOUR_MINIMO_KEY' \
              --header 'Content-Type: application/json' \
              --data '{"transactional": "TRF4MS9", "recipient": "guest@example.com", "tenant": "restaurant_4812", "customFields": {"GUEST_NAME": "Anna", "BOOKING_TIME": "20:30"}}'
        - lang: JavaScript
          source: >-
            const res = await
            fetch('https://api.minimo.it/public/v1/transactionals', {
              method: 'POST',
              headers: {
                Authorization: 'Bearer YOUR_MINIMO_KEY',
                'Content-Type': 'application/json',
              },
              body: JSON.stringify({"transactional": "TRF4MS9", "recipient": "guest@example.com", "tenant": "restaurant_4812", "customFields": {"GUEST_NAME": "Anna", "BOOKING_TIME": "20:30"}}),
            });

            const { data } = await res.json();

            console.log(data);
        - lang: Python
          source: |-
            import requests

            res = requests.post(
                'https://api.minimo.it/public/v1/transactionals',
                headers={'Authorization': 'Bearer YOUR_MINIMO_KEY'},
                json={"transactional": "TRF4MS9", "recipient": "guest@example.com", "tenant": "restaurant_4812", "customFields": {"GUEST_NAME": "Anna", "BOOKING_TIME": "20:30"}},
            )
            print(res.status_code, res.text)
components:
  schemas:
    ScheduledEmail:
      type: object
      properties:
        id:
          type: integer
          example: 1042
        status:
          type: string
          enum:
            - pending
            - sending
            - sent
            - cancelled
            - skipped
            - failed
          example: pending
        reason:
          type: string
          nullable: true
          description: >-
            Why it was skipped, cancelled or failed, for example
            `cancelled_by_api`, `past_due`, `no_marketing_consent`,
            `empty_subject`.
        sendAt:
          type: string
          format: date-time
          example: '2026-11-19T19:30:00.000Z'
        sentAt:
          type: string
          format: date-time
          nullable: true
        messageId:
          type: string
          nullable: true
          description: Id of the sent email.
        recipient:
          type: string
          example: guest@example.com
        transactional:
          type: string
          description: Master template uid.
          example: TRF4MS9
        sentTransactional:
          type: string
          nullable: true
          description: Template actually sent (the restaurant's copy, if any).
        tenant:
          type: string
          nullable: true
          example: restaurant_4812
        event:
          type: string
          example: api.scheduled
        cancellationKey:
          type: string
          nullable: true
          example: booking-4812
        idempotencyKey:
          type: string
          nullable: true
          example: booking-4812-reminder
        createdAt:
          type: string
          format: date-time
          example: '2026-11-12T10:00:00.000Z'
      required:
        - id
        - status
        - reason
        - sendAt
        - sentAt
        - messageId
        - recipient
        - transactional
        - sentTransactional
        - tenant
        - event
        - cancellationKey
        - idempotencyKey
        - createdAt
    ApiError:
      type: object
      properties:
        status:
          type: string
          example: FAIL
        message:
          type: string
          description: The error code to test in your code.
          example: INVALID_PARAMETERS
        userMessage:
          type: string
          description: >-
            When present, a sentence that says what to fix. You can show or log
            it.
          example: Set the origins allowed to embed the widgets first.
      description: >-
        Every error has this shape. See [Errors and limits](/embedded/errors)
        for every code.
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: mn-API_CLIENT_ID-API_KEY

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.