Loops · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Loops OpenAPI Spec Email messages API

5 actions 5 updates phrasing extends openapi/loops-email-messages-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 5

$.info
$.paths['/v1/email-messages/{emailMessageId}'].get
$.paths['/v1/email-messages/{emailMessageId}'].post
$.paths['/v1/email-messages/{emailMessageId}/preview'].post
$.paths['/v1/email-messages/{emailMessageId}/guardian'].get

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 Email messages API
  version: 1.0.0
extends: openapi/loops-email-messages-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: 4
- target: $.paths['/v1/email-messages/{emailMessageId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get an email message
      effect: read
      questions:
      - How do I read the subject, sender and content of an email message?
      - What is the current content revision ID of a message?
      instructions:
      - text: Show email message {emailMessageId}.
        slots:
          emailMessageId: path.emailMessageId
      - text: Get the compiled LMX of message {emailMessageId}.
        slots:
          emailMessageId: path.emailMessageId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/email-messages/{emailMessageId}'].post
  update:
    x-apievangelist-phrasing:
      intent: Edit an email's subject, sender or content
      effect: write
      questions:
      - How do I set the subject line and sender on a draft email?
      - Why does editing an email message return a 409 conflict?
      - Can I set fallback values for contact properties in an email?
      instructions:
      - text: Set the subject of email message {emailMessageId} to {subject}.
        slots:
          emailMessageId: path.emailMessageId
          subject: requestBody.subject
      - text: Update message {emailMessageId} at revision {expectedRevisionId} with body {lmx}.
        slots:
          emailMessageId: path.emailMessageId
          expectedRevisionId: requestBody.expectedRevisionId
          lmx: requestBody.lmx
      - text: Send email {emailMessageId} from {fromName} at {fromEmail}.
        slots:
          emailMessageId: path.emailMessageId
          fromName: requestBody.fromName
          fromEmail: requestBody.fromEmail
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/email-messages/{emailMessageId}/preview'].post
  update:
    x-apievangelist-phrasing:
      intent: Send a test preview of an email
      effect: write
      questions:
      - How do I send myself a test copy of an email before it goes out?
      - Can I fill in sample contact properties in a preview?
      instructions:
      - text: Send a preview of email {emailMessageId} to {emails}.
        slots:
          emailMessageId: path.emailMessageId
          emails: requestBody.emails
      - text: Send a test of transactional message {emailMessageId} to {emails} with data {dataVariables}.
        slots:
          emailMessageId: path.emailMessageId
          emails: requestBody.emails
          dataVariables: requestBody.dataVariables
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/email-messages/{emailMessageId}/guardian'].get
  update:
    x-apievangelist-phrasing:
      intent: Check an email for publishing errors
      effect: read
      questions:
      - What errors are blocking this email from being published?
      - Can I validate an email's content for warnings before sending?
      instructions:
      - text: Run Guardian checks on email {emailMessageId}.
        slots:
          emailMessageId: path.emailMessageId
      - text: List the errors and warnings for message {emailMessageId}.
        slots:
          emailMessageId: path.emailMessageId
      method: generated
      generated: '2026-09-26'