Loops

Loops Transactional emails API

Create, edit, publish, list and send transactional email templates with data variables. 8 operation(s) in the Loops REST API v1 (OpenAPI 1.21.6).

GitHub OpenAPI

Operations 8

Each operation below carries the questions people ask an LLM about it and the instructions they give an agent to run it. Generated by API Evangelist overlay

POST /v1/transactional Send a transactional email · Send a transactional email #
Ask an LLM
“How do I send a password reset or receipt email to one person?”
“Can I pass template data variables into a transactional send?”
Tell an agent
Send transactional email {transactionalId} to {email}.
Send transactional {transactionalId} to {email} with data {dataVariables}.
GET /v1/transactional List published transactional emails · List transactional emails #
Ask an LLM
“Which transactional emails are published and ready to send?”
“Can I page through only my published transactional templates?”
Tell an agent
List my published transactional emails.
Show published transactional emails from cursor {cursor}.
GET /v1/transactional-emails List all transactional emails incl. drafts · List transactional emails #
Ask an LLM
“What transactional emails exist, including ones not yet published?”
“Can I list every transactional email by creation date?”
Tell an agent
List all transactional emails, drafts included, newest first.
Show {perPage} transactional emails per page, including unpublished ones.
POST /v1/transactional-emails Create a transactional email · Create a transactional email #
Ask an LLM
“How do I set up a new transactional email template?”
“Can I put a new transactional email into a group?”
Tell an agent
Create a transactional email named {name}.
Create transactional email {name} in group {transactionalGroupId}.
GET /v1/transactional-emails/{transactionalId} Get a transactional email · Get a transactional email #
Ask an LLM
“How do I look up one transactional email's details?”
“Does a transactional email currently have a draft?”
Tell an agent
Show transactional email {transactionalId}.
Get the published and draft message IDs for transactional {transactionalId}.
POST /v1/transactional-emails/{transactionalId} Rename or regroup a transactional email · Update a transactional email #
Ask an LLM
“How do I rename an existing transactional email?”
“Can I move a transactional email into another group?”
Tell an agent
Rename transactional email {transactionalId} to {name}.
Move transactional {transactionalId} to group {transactionalGroupId}.
POST /v1/transactional-emails/{transactionalId}/draft Open a draft for a transactional email · Ensure a draft email message #
Ask an LLM
“How do I start editing a published transactional email without changing the live version?”
“Is a new draft seeded from the latest published version?”
Tell an agent
Make sure transactional {transactionalId} has a draft to edit.
Create or return the draft message for transactional email {transactionalId}.
POST /v1/transactional-emails/{transactionalId}/publish Publish a transactional email draft · Publish a transactional email draft #
Ask an LLM
“How do I make my edited transactional draft go live?”
“What happens to the draft after I publish it?”
Tell an agent
Publish the draft of transactional email {transactionalId}.
Make the current draft of {transactionalId} the live version.

Documentation

📖
Documentation
https://loops.so/docs/api-reference/send-transactional-email
📖
APIReference
https://loops.so/docs/api-reference/intro

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/loops/refs/heads/main/openapi/loops-transactional-emails-api-openapi.yml

Other Resources

🔗
Overlay
https://raw.githubusercontent.com/api-evangelist/loops/refs/heads/main/overlays/loops-transactional-emails-overlay.yaml

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API 
curl "https://apis.io/api/v1/apis/loops:loops-transactional-emails-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

loops-transactional-emails-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: Loops OpenAPI Spec Transactional emails API
  description: This is the OpenAPI Spec for the Loops API.
  version: 1.21.6
servers:
- url: https://app.loops.so/api
tags:
- name: Transactional Emails
  description: Create, manage, and send transactional emails
paths:
  /v1/transactional:
    post:
      operationId: sendTransactionalEmail
      tags:
      - Transactional Emails
      summary: Send a transactional email
      description: 'Send a transactional email to a contact.

        Please email us to enable attachments on your account before using them with the API.


        To set dynamic Subject, From, Reply to, CC, BCC email header fields, add data variables to those fields in the editor, then include data for each variable in the API request. Read our transactional email guide for more details.'
      x-mint:
        metadata:
          description: Send a transactional email.
          sidebarTitle: Send transactional
        href: /api-reference/send-transactional-email
        content: 'Send a transactional email, including optional data variables, to a single recipient.


          To set dynamic Subject, From, Reply to, CC, BCC email header fields, add data variables to those fields in the editor, then include data for each variable in the API request. Read our [transactional email guide](/transactional) for more details.


          To send a test preview of a transactional email, use the [Preview email message](/api-reference/preview-email-message) endpoint.


          <Note>Please [email us](mailto:help@loops.so) to enable attachments on your account before using them with the API.</Note>'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/TransactionalRequest'
        required: true
      parameters:
      - in: header
        name: Idempotency-Key
        description: 'Include a unique ID for this request (maximum 100 characters) to avoid duplicate emails.


          The value should be a string of up to 100 characters and should be unique for each request. We recommend using V4 UUIDs or some other method with enough guaranteed entropy to avoid collisions during a 24 hour window.


          This endpoint will return a `409 Conflict` response if the idempotency key has been used in the previous 24 hours.'
        schema:
          type: string
          maxLength: 100
      responses:
        '200':
          description: Successful send.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TransactionalSuccessResponse'
        '400':
          description: Bad request (e.g. transactional email is not published).
          content:
            application/json:
              schema:
                oneOf:
                - $ref: '#/components/schemas/TransactionalSendFailureResponse'
                - $ref: '#/components/schemas/TransactionalFailure2Response'
                - $ref: '#/components/schemas/TransactionalFailure3Response'
                - $ref: '#/components/schemas/TransactionalFailure4Response'
                - $ref: '#/components/schemas/TransactionalFailure5Response'
        '404':
          description: Transactional email not found.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TransactionalFailure3Response'
        '405':
          description: Wrong HTTP request method.
        '409':
          description: Idempotency key has been used.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/IdempotencyKeyFailureResponse'
      security:
      - apiKey: []
    get:
      operationId: listPublishedTransactionalEmails
      deprecated: true
      tags:
      - Transactional Emails
      summary: List transactional emails
      description: Get a list of published transactional emails.
      x-mint:
        href: /api-reference/list-transactional-emails-v1
        content: <Warning>This endpoint is deprecated. Use [List transactional emails](/api-reference/list-transactional-emails) instead.</Warning>
      parameters:
      - name: perPage
        in: query
        required: false
        description: How many results to return in each request. Must be between 10 and 50. Default is 20.
        schema:
          type: string
      - name: cursor
        in: query
        required: false
        description: A cursor, to return a specific page of results. Cursors can be found from the `pagination.nextCursor` value in each response.
        schema:
          type: string
      responses:
        '200':
          description: Successful.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListTransactionalsResponse'
        '405':
          description: Wrong HTTP request method.
      security:
      - apiKey: []
  /v1/transactional-emails:
    get:
      operationId: listTransactionalEmails
      tags:
      - Transactional Emails
      summary: List transactional emails
      description: Retrieve a paginated list of transactional emails, most recently created first.
      x-mint:
        href: /api-reference/list-transactional-emails
        metadata:
          sidebarTitle: List transactionals
      parameters:
      - name: perPage
        in: query
        required: false
        description: How many results to return in each request. Must be between 10 and 50. Default is 20.
        schema:
          type: string
      - name: cursor
        in: query
        required: false
        description: A cursor to return a specific page of results. Cursors can be found from the `pagination.nextCursor` value in each response.
        schema:
          type: string
      responses:
        '200':
          description: Successful.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListTransactionalsResourceResponse'
        '400':
          description: Invalid `perPage` value.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TransactionalFailureResponse'
        '401':
          description: Invalid API key or content API not enabled for this team.
        '405':
          description: Wrong HTTP request method.
      security:
      - apiKey: []
    post:
      operationId: createTransactionalEmail
      tags:
      - Transactional Emails
      summary: Create a transactional email
      description: Create a new transactional email. An empty draft email message is created automatically and its `draftEmailMessageId` is returned. Use the `POST /v1/email-messages/{emailMessageId}` endpoint along with the returned `draftEmailMessageContentRevisionId` to set subject, sender, preview text, and LMX content, then call `POST /v1/transactional-emails/{transactionalId}/publish` to publish the draft.
      x-mint:
        href: /api-reference/create-transactional-email
        content: 'This endpoint creates a transactional email and an empty draft email message in one step.


          Use the returned `draftEmailMessageId` and `draftEmailMessageContentRevisionId` when calling the [Update email message](/api-reference/update-email-message) endpoint to set subject, sender, preview text, and LMX content.


          Call [Publish transactional email draft](/api-reference/publish-transactional-email) to publish.'
        metadata:
          sidebarTitle: Create transactional
          description: Create a new transactional email and its draft email message, ready for editing, previewing, and publishing through the Loops API.
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateTransactionalRequest'
      responses:
        '201':
          description: Transactional email created.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TransactionalDraftResponse'
        '400':
          description: Invalid request body or no sending domain configured.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TransactionalFailureResponse'
        '401':
          description: Invalid API key or content API not enabled for this team.
        '405':
          description: Wrong HTTP request method.
      security:
      - apiKey: []
  /v1/transactional-emails/{transactionalId}:
    parameters:
    - name: transactionalId
      in: path
      required: true
      description: The ID of the transactional email.
      schema:
        type: string
        examples:
        - cll42l54f20i1la0lfooe3z12
    get:
      operationId: getTransactionalEmail
      tags:
      - Transactional Emails
      summary: Get a transactional email
      description: Retrieve a single transactional email by ID.
      x-mint:
        href: /api-reference/get-transactional-email
        metadata:
          sidebarTitle: Get transactional
      responses:
        '200':
          description: Successful.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TransactionalResource'
        '400':
          description: Invalid `transactionalId`.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TransactionalFailureResponse'
        '401':
          description: Invalid API key or content API not enabled for this team.
        '404':
          description: Transactional email not found.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TransactionalFailureResponse'
        '405':
          description: Wrong HTTP request method.
      security:
      - apiKey: []
    post:
      operationId: updateTransactionalEmail
      tags:
      - Transactional Emails
      summary: Update a transactional email
      description: Update a transactional email by ID.
      x-mint:
        href: /api-reference/update-transactional-email
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateTransactionalRequest'
      responses:
        '200':
          description: Transactional email updated.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TransactionalResource'
        '400':
          description: Invalid request body or `transactionalId`.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TransactionalFailureResponse'
        '401':
          description: Invalid API key or content API not enabled for this team.
        '404':
          description: Transactional email not found.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TransactionalFailureResponse'
        '405':
          description: Wrong HTTP request method.
      security:
      - apiKey: []
  /v1/transactional-emails/{transactionalId}/draft:
    parameters:
    - name: transactionalId
      in: path
      required: true
      description: The ID of the transactional email.
      schema:
        type: string
        examples:
        - cll42l54f20i1la0lfooe3z12
    post:
      operationId: ensureTransactionalDraft
      tags:
      - Transactional Emails
      summary: Ensure a draft email message
      description: Ensure the transactional email has a draft email message. If a draft already exists it is returned unchanged; otherwise a new empty draft is created (seeded from the most recent published version when present). Use `POST /v1/email-messages/{emailMessageId}` to edit the draft's content.
      x-mint:
        href: /api-reference/ensure-transactional-draft
        content: 'If a draft email message already exists, it is returned unchanged. Otherwise a new empty draft is created (seeded from the most recent published version when present).


          Use the returned `draftEmailMessageId` and `draftEmailMessageContentRevisionId` when calling [Update an email message](/api-reference/update-email-message) to edit the draft''s content.'
        metadata:
          title: Ensure a transactional email has a draft
          sidebarTitle: Ensure draft
          description: Ensure a transactional email has a draft email message ready for editing, creating one from the published version if no draft currently exists.
      responses:
        '200':
          description: Draft ready.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TransactionalDraftResponse'
        '400':
          description: Invalid `transactionalId` or no sending domain configured.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TransactionalFailureResponse'
        '401':
          description: Invalid API key or content API not enabled for this team.
        '404':
          description: Transactional email not found.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TransactionalFailureResponse'
        '405':
          description: Wrong HTTP request method.
      security:
      - apiKey: []
  /v1/transactional-emails/{transactionalId}/publish:
    parameters:
    - name: transactionalId
      in: path
      required: true
      description: The ID of the transactional email.
      schema:
        type: string
        examples:
        - cll42l54f20i1la0lfooe3z12
    post:
      operationId: publishTransactionalEmail
      tags:
      - Transactional Emails
      summary: Publish a transactional email draft
      description: Publish the transactional email's current draft email message. The draft becomes the published version and the draft is cleared.
      x-mint:
        href: /api-reference/publish-transactional-email
        content: 'The transactional email''s current draft email message is published. The draft becomes the published version and the draft is cleared.


          After publishing, use the returned `id` as `transactionalId` with [Send a transactional email](/api-reference/send-transactional-email) to send the email.'
        metadata:
          title: Publish a transactional email
          sidebarTitle: Publish transactional
      responses:
        '200':
          description: Transactional email published.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TransactionalResource'
        '400':
          description: Invalid `transactionalId`.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TransactionalFailureResponse'
        '401':
          description: Invalid API key or content API not enabled for this team.
        '404':
          description: Transactional email not found.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TransactionalFailureResponse'
        '405':
          description: Wrong HTTP request method.
        '409':
          description: No draft to publish.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TransactionalFailureResponse'
        '422':
          description: Draft failed validation, sending domain is not verified, or content was flagged as unsafe.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TransactionalFailureResponse'
      security:
      - apiKey: []
components:
  schemas:
    TransactionalRequest:
      type: object
      required:
      - email
      - transactionalId
      properties:
        email:
          type: string
          examples:
          - alex@company.com
          description: The recipient's email address.
        transactionalId:
          type: string
          description: The ID of the transactional email to send.
          examples:
          - cll42l54f20i1la0lfooe3z12
        addToAudience:
          type: boolean
          description: If `true`, a contact will be created in your audience using the `email` value (if a matching contact doesn't already exist).
          examples:
          - true
        dataVariables:
          type: object
          description: 'An object containing data as defined by the data variables added to the transactional email template. Values can be of type string or number.


            If you have added optional data variables to your email, you can exclude them from the dataVariables object or set the value to "".


            If you have added an array data variable to your email, make sure to include an array matching the data variables you added to your array block.'
          examples:
          - name: Chris
            passwordResetLink: https://example.com/reset-password
        attachments:
          type: array
          description: A list containing file objects to be sent along with an email message. Attachments must be enabled by Loops support before they can be used with the API.
          items:
            type: object
            required:
            - filename
            - contentType
            - data
            properties:
              filename:
                type: string
                description: The name of the file, shown in email clients.
              contentType:
                type: string
                description: The MIME type of the file.
              data:
                type: string
                description: The base64-encoded content of the file.
      examples:
      - email: alex@company.com
        transactionalId: cll42l54f20i1la0lfooe3z12
        addToAudience: true
        dataVariables:
          name: Alex
          passwordResetLink: https://app.company.com/reset/abc123
    TransactionalFailure4Response:
      type: object
      properties:
        success:
          type: boolean
          examples:
          - false
        message:
          type: string
        error:
          type: object
          properties:
            path:
              type: string
            reason:
              type: string
      required:
      - success
      - message
      - error
    TransactionalFailureResponse:
      type: object
      properties:
        message:
          type: string
          examples:
          - Transactional email not found.
      required:
      - message
      examples:
      - message: Transactional email not found.
    TransactionalDraftResponse:
      type: object
      properties:
        id:
          type: string
          description: The ID of the transactional email.
        name:
          type: string
          description: The name of the transactional email.
        draftEmailMessageId:
          type:
          - string
          - 'null'
          description: The ID of the draft email message.
        draftEmailMessageContentRevisionId:
          type:
          - string
          - 'null'
          description: The `contentRevisionId` of the draft email message. Pass this as `expectedRevisionId` on your first update via `POST /v1/email-messages/{emailMessageId}`.
          examples:
          - clrev1s10n2i3d4e5f6g7h8
        publishedEmailMessageId:
          type:
          - string
          - 'null'
          description: The ID of the published email message. `null` if there is no published version.
        transactionalGroupId:
          type:
          - string
          - 'null'
          description: The ID of the group this transactional email belongs to. Returned when creating a transactional email.
        createdAt:
          type: string
          format: date-time
          description: ISO 8601 timestamp for when the transactional email was created.
        updatedAt:
          type: string
          format: date-time
          description: ISO 8601 timestamp for when the transactional email was last updated.
        dataVariables:
          type: array
          description: Data variable names used by the published email. Empty for unpublished transactional emails.
          items:
            type: string
      required:
      - id
      - name
      - draftEmailMessageId
      - draftEmailMessageContentRevisionId
      - publishedEmailMessageId
      - createdAt
      - updatedAt
      - dataVariables
      examples:
      - id: cll42l54f20i1la0lfooe3z12
        name: Sign up confirmation
        draftEmailMessageId: cle5f7g9h1i3j5k7l9m1n3p5
        publishedEmailMessageId: cle5f7g9h1i3j5k7l9m1n3p5
        transactionalGroupId: clg7n5p3q1r9s7t5u3v1w9y7
        createdAt: 2025-06-29 07:47:39.370000+00:00
        updatedAt: 2025-06-29 07:47:39.370000+00:00
        dataVariables:
        - confirmationUrl
        draftEmailMessageContentRevisionId: clrev1s10n2i3d4e5f6g7h8
    TransactionalSendFailureResponse:
      type: object
      properties:
        success:
          type: boolean
          examples:
          - false
        message:
          type: string
          examples:
          - 'Missing required data variable(s): confirmationUrl'
      required:
      - success
      - message
      examples:
      - success: false
        message: 'Missing required data variable(s): confirmationUrl'
    ListTransactionalsResponse:
      type: object
      properties:
        pagination:
          $ref: '#/components/schemas/Pagination'
        data:
          type: array
          items:
            $ref: '#/components/schemas/TransactionalEmail'
      examples:
      - pagination:
          totalResults: 2
          returnedResults: 2
          perPage: 20
          totalPages: 1
          nextCursor: null
          nextPage: null
        data:
        - id: cll42l54f20i1la0lfooe3z12
          name: Sign up confirmation
          lastUpdated: 2025-06-29 07:47:39.370000+00:00
          dataVariables:
          - confirmationUrl
    Pagination:
      type: object
      properties:
        totalResults:
          type: number
          examples:
          - 2
        returnedResults:
          type: number
          examples:
          - 2
        perPage:
          type: number
          examples:
          - 20
        totalPages:
          type: number
          examples:
          - 1
        nextCursor:
          type:
          - string
          - 'null'
          examples:
          - null
        nextPage:
          type:
          - string
          - 'null'
          examples:
          - null
      required:
      - totalResults
      - returnedResults
      - perPage
      - totalPages
      - nextCursor
      - nextPage
      examples:
      - totalResults: 2
        returnedResults: 2
        perPage: 20
        totalPages: 1
        nextCursor: null
        nextPage: null
    TransactionalResource:
      type: object
      properties:
        id:
          type: string
          description: The ID of the transactional email.
          examples:
          - cll42l54f20i1la0lfooe3z12
        name:
          type: string
          description: The name of the transactional email.
          examples:
          - Sign up confirmation
        draftEmailMessageId:
          type:
          - string
          - 'null'
          description: The ID of the draft email message. `null` if there is no draft version.
          examples:
          - cle5f7g9h1i3j5k7l9m1n3p5
        publishedEmailMessageId:
          type:
          - string
          - 'null'
          description: The ID of the published email message. `null` if there is no published version.
          examples:
          - cle5f7g9h1i3j5k7l9m1n3p5
        transactionalGroupId:
          type:
          - string
          - 'null'
          description: The ID of the group this transactional email belongs to.
          examples:
          - clg7n5p3q1r9s7t5u3v1w9y7
        createdAt:
          type: string
          format: date-time
          description: ISO 8601 timestamp for when the transactional email was created.
          examples:
          - 2025-06-29 07:47:39.370000+00:00
        updatedAt:
          type: string
          format: date-time
          description: ISO 8601 timestamp for when the transactional email was last updated.
          examples:
          - 2025-06-29 07:47:39.370000+00:00
        dataVariables:
          type: array
          description: Data variable names used by the published email. Empty for unpublished transactional emails.
          items:
            type: string
      required:
      - id
      - name
      - draftEmailMessageId
      - publishedEmailMessageId
      - transactionalGroupId
      - createdAt
      - updatedAt
      - dataVariables
      examples:
      - id: cll42l54f20i1la0lfooe3z12
        name: Sign up confirmation
        draftEmailMessageId: cle5f7g9h1i3j5k7l9m1n3p5
        publishedEmailMessageId: cle5f7g9h1i3j5k7l9m1n3p5
        transactionalGroupId: clg7n5p3q1r9s7t5u3v1w9y7
        createdAt: 2025-06-29 07:47:39.370000+00:00
        updatedAt: 2025-06-29 07:47:39.370000+00:00
        dataVariables:
        - confirmationUrl
    TransactionalSuccessResponse:
      type: object
      properties:
        success:
          type: boolean
          examples:
          - true
      required:
      - success
    TransactionalFailure5Response:
      type: object
      properties:
        success:
          type: boolean
          examples:
          - false
        message:
          type: string
        error:
          type: object
          properties:
            path:
              type: string
            message:
              type: string
        transactionalId:
          type: string
          examples:
          - cll42l54f20i1la0lfooe3z12
      required:
      - success
      - message
      - error
      - transactionalId
      examples:
      - success: false
        message: 'Missing required data variable(s): confirmationUrl'
        error:
          path: dataVariables
          message: 'Missing required data variable(s): confirmationUrl'
        transactionalId: cll42l54f20i1la0lfooe3z12
    IdempotencyKeyFailureResponse:
      type: object
      properties:
        success:
          type: boolean
          examples:
          - false
        message:
          type: string
      required:
      - success
      - message
      examples:
      - success: false
        message: Idempotency key already used with a different request body.
    TransactionalFailure3Response:
      type: object
      properties:
        success:
          type: boolean
          examples:
          - false
        message:
          type: string
        error:
          type: object
          properties:
            path:
              type: string
            message:
              type: string
      required:
      - success
      - message
      - error
    ListTransactionalsResourceResponse:
      type: object
      properties:
        pagination:
          $ref: '#/components/schemas/Pagination'
        data:
          type: array
          items:
            $ref: '#/components/schemas/TransactionalResource'
      required:
      - pagination
      - data
      examples:
      - pagination:
          totalResults: 2
          returnedResults: 2
          perPage: 20
          totalPages: 1
          nextCursor: null
          nextPage: null
        data:
        - id: cll42l54f20i1la0lfooe3z12
          name: Sign up confirmation
          draftEmailMessageId: cle5f7g9h1i3j5k7l9m1n3p5
          publishedEmailMessageId: cle5f7g9h1i3j5k7l9m1n3p5
          transactionalGroupId: clg7n5p3q1r9s7t5u3v1w9y7
          createdAt: 2025-06-29 07:47:39.370000+00:00
          updatedAt: 2025-06-29 07:47:39.370000+00:00
          dataVariables:
          - confirmationUrl
    TransactionalFailure2Response:
      type: object
      properties:
        success:
          type: boolean
          examples:
          - false
        message:
          type: string
        path:
          type: string
      required:
      - success
      - message
      - path
    CreateTransactionalRequest:
      type: object
      properties:
        name:
          type: string
          description: The name of the transactional email.
          examples:
          - Welcome email
        transactionalGroupId:
          type: string
          description: The ID of the group to add this transactional email to. Defaults to the team's default group when omitted.
          examples:
          - clg7n5p3q1r9s7t5u3v1w9y7
      required:
      - name
      additionalProperties: false
    TransactionalEmail:
      type: object
      properties:
        id:
          type: string
          description: The ID of the transactional email.
        name:
          type: string
          description: The name of the transactional email.
        lastUpdated:
          type: string
          description: The date and time the transactional email was last updated in ISO 8601 format.
        dataVariables:
          type: array
          description: The data variables used by the transactional email.
      examples:
      - id: cll42l54f20i1la0lfooe3z12
        name: Sign up confirmation
        lastUpdated: 2025-02-02 02:56:28.845000+00:00
        dataVariables:
        - confirmationUrl
      required:
      - id
      - name
      - lastUpdated
      - dataVariables
    UpdateTransactionalRequest:
      type: object
      minProperties: 1
      description: At least one field must be provided.
      properties:
        name:
          type: string
          examples:
          - Password reset email
        transactionalGroupId:
          type: string
          description: The ID of the group to move this transactional email to.
          examples:
          - clg7n5p3q1r9s7t5u3v1w9y7
      additionalProperties: false
  securitySchemes:
    apiKey:
      type: http
      scheme: bearer