Loops · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Loops OpenAPI Spec Transactional emails API

9 actions 9 updates phrasing extends openapi/loops-transactional-emails-api-openapi.yml
Generated by API Evangelist Written by API Evangelist tooling for Loops's API. It is a proposal applied on top of the contract, not a document Loops publishes.
View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 9

$.info
$.paths['/v1/transactional'].get
$.paths['/v1/transactional'].post
$.paths['/v1/transactional-emails'].get
$.paths['/v1/transactional-emails'].post
$.paths['/v1/transactional-emails/{transactionalId}'].get
$.paths['/v1/transactional-emails/{transactionalId}'].post
$.paths['/v1/transactional-emails/{transactionalId}/draft'].post
$.paths['/v1/transactional-emails/{transactionalId}/publish'].post

OpenAPI Overlay

Raw ↑
# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Loops OpenAPI Spec Transactional emails API
  version: 1.0.0
extends: openapi/loops-transactional-emails-api-openapi.yml
actions:
- target: $.info
  update:
    x-apievangelist-phrasing:
      method: generated
      generated: '2026-09-26'
      generator: build-phrasing.py
      label: Generated by API Evangelist
      operations: 8
- target: $.paths['/v1/transactional'].get
  update:
    x-apievangelist-phrasing:
      intent: List published transactional emails
      effect: read
      questions:
      - Which transactional emails are published and ready to send?
      - Can I page through only my published transactional templates?
      instructions:
      - text: List my published transactional emails.
      - text: Show published transactional emails from cursor {cursor}.
        slots:
          cursor: query.cursor
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/transactional'].post
  update:
    x-apievangelist-phrasing:
      intent: Send a transactional email
      effect: write
      questions:
      - How do I send a password reset or receipt email to one person?
      - Can I pass template data variables into a transactional send?
      - Can I include attachments in a transactional email?
      instructions:
      - text: Send transactional email {transactionalId} to {email}.
        slots:
          transactionalId: requestBody.transactionalId
          email: requestBody.email
      - text: Send transactional {transactionalId} to {email} with data {dataVariables}.
        slots:
          transactionalId: requestBody.transactionalId
          email: requestBody.email
          dataVariables: requestBody.dataVariables
      - text: Send transactional {transactionalId} to {email} and add them to my audience ({addToAudience}).
        slots:
          transactionalId: requestBody.transactionalId
          email: requestBody.email
          addToAudience: requestBody.addToAudience
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/transactional-emails'].get
  update:
    x-apievangelist-phrasing:
      intent: List all transactional emails incl. drafts
      effect: read
      questions:
      - What transactional emails exist, including ones not yet published?
      - Can I list every transactional email by creation date?
      instructions:
      - text: List all transactional emails, drafts included, newest first.
      - text: Show {perPage} transactional emails per page, including unpublished ones.
        slots:
          perPage: query.perPage
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/transactional-emails'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a transactional email
      effect: write
      questions:
      - How do I set up a new transactional email template?
      - Can I put a new transactional email into a group?
      instructions:
      - text: Create a transactional email named {name}.
        slots:
          name: requestBody.name
      - text: Create transactional email {name} in group {transactionalGroupId}.
        slots:
          name: requestBody.name
          transactionalGroupId: requestBody.transactionalGroupId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/transactional-emails/{transactionalId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a transactional email
      effect: read
      questions:
      - How do I look up one transactional email's details?
      - Does a transactional email currently have a draft?
      instructions:
      - text: Show transactional email {transactionalId}.
        slots:
          transactionalId: path.transactionalId
      - text: Get the published and draft message IDs for transactional {transactionalId}.
        slots:
          transactionalId: path.transactionalId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/transactional-emails/{transactionalId}'].post
  update:
    x-apievangelist-phrasing:
      intent: Rename or regroup a transactional email
      effect: write
      questions:
      - How do I rename an existing transactional email?
      - Can I move a transactional email into another group?
      instructions:
      - text: Rename transactional email {transactionalId} to {name}.
        slots:
          transactionalId: path.transactionalId
          name: requestBody.name
      - text: Move transactional {transactionalId} to group {transactionalGroupId}.
        slots:
          transactionalId: path.transactionalId
          transactionalGroupId: requestBody.transactionalGroupId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/transactional-emails/{transactionalId}/draft'].post
  update:
    x-apievangelist-phrasing:
      intent: Open a draft for a transactional email
      effect: write
      questions:
      - How do I start editing a published transactional email without changing the live version?
      - Is a new draft seeded from the latest published version?
      instructions:
      - text: Make sure transactional {transactionalId} has a draft to edit.
        slots:
          transactionalId: path.transactionalId
      - text: Create or return the draft message for transactional email {transactionalId}.
        slots:
          transactionalId: path.transactionalId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/transactional-emails/{transactionalId}/publish'].post
  update:
    x-apievangelist-phrasing:
      intent: Publish a transactional email draft
      effect: write
      questions:
      - How do I make my edited transactional draft go live?
      - What happens to the draft after I publish it?
      instructions:
      - text: Publish the draft of transactional email {transactionalId}.
        slots:
          transactionalId: path.transactionalId
      - text: Make the current draft of {transactionalId} the live version.
        slots:
          transactionalId: path.transactionalId
      method: generated
      generated: '2026-09-26'