Loops · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Loops OpenAPI Spec Transactional groups API

5 actions 5 updates phrasing extends openapi/loops-transactional-groups-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/transactional-groups'].get
$.paths['/v1/transactional-groups'].post
$.paths['/v1/transactional-groups/{transactionalGroupId}'].get
$.paths['/v1/transactional-groups/{transactionalGroupId}'].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 groups API
  version: 1.0.0
extends: openapi/loops-transactional-groups-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/transactional-groups'].get
  update:
    x-apievangelist-phrasing:
      intent: List transactional groups
      effect: read
      questions:
      - Which groups organize my transactional emails?
      - Can I page through transactional groups?
      instructions:
      - text: List my transactional groups.
      - text: Show transactional groups from cursor {cursor}.
        slots:
          cursor: query.cursor
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/transactional-groups'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a transactional group
      effect: write
      questions:
      - How do I create a folder for transactional emails?
      - Is there a reserved group name I can't use?
      instructions:
      - text: Create a transactional group called {name}.
        slots:
          name: requestBody.name
      - text: Add transactional group {name} described as {description}.
        slots:
          name: requestBody.name
          description: requestBody.description
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/transactional-groups/{transactionalGroupId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a transactional group
      effect: read
      questions:
      - How do I see one transactional group's details?
      - What description does a given transactional group have?
      instructions:
      - text: Show transactional group {transactionalGroupId}.
        slots:
          transactionalGroupId: path.transactionalGroupId
      - text: Fetch the name of transactional group {transactionalGroupId}.
        slots:
          transactionalGroupId: path.transactionalGroupId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/transactional-groups/{transactionalGroupId}'].post
  update:
    x-apievangelist-phrasing:
      intent: Rename or redescribe a transactional group
      effect: write
      questions:
      - How do I rename an existing transactional group?
      - Can the Unsorted transactional group be edited?
      instructions:
      - text: Rename transactional group {transactionalGroupId} to {name}.
        slots:
          transactionalGroupId: path.transactionalGroupId
          name: requestBody.name
      - text: Set the description of transactional group {transactionalGroupId} to {description}.
        slots:
          transactionalGroupId: path.transactionalGroupId
          description: requestBody.description
      method: generated
      generated: '2026-09-26'