Ortto · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Ortto Transactional API

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

What the actions change

x-apievangelist-phrasing

Targets 3

$.info
$.paths['/transactional/send'].post
$.paths['/transactional/send-sms'].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 Ortto Transactional API
  version: 1.0.0
extends: openapi/ortto-transactional-api-openapi.yml
actions:
- target: $.info
  update:
    x-apievangelist-phrasing:
      method: generated
      generated: '2026-10-01'
      generator: build-phrasing.py
      label: Generated by API Evangelist
      operations: 2
- target: $.paths['/transactional/send'].post
  update:
    x-apievangelist-phrasing:
      intent: Send a transactional email
      effect: write
      questions:
      - How do I send a password reset or receipt email through Ortto?
      - Can I attach files to a transactional email, and how many?
      - Is it possible to send this kind of email as a marketing message instead?
      instructions:
      - text: Send transactional email asset {email_id} to {people}.
        slots:
          email_id: requestBody.email_id
          people: requestBody.people
      - text: Email {people} with subject {subject} and body {html_body}.
        slots:
          people: requestBody.people
          subject: requestBody.subject
          html_body: requestBody.html_body
      - text: Send email {email_id} to {people} with attachments {attachments}.
        slots:
          email_id: requestBody.email_id
          people: requestBody.people
          attachments: requestBody.attachments
      method: generated
      generated: '2026-10-01'
- target: $.paths['/transactional/send-sms'].post
  update:
    x-apievangelist-phrasing:
      intent: Send a transactional SMS
      effect: write
      questions:
      - How do I text a one-time code or order update to a customer via Ortto?
      - Can a transactional text message be sent to several people in one request?
      instructions:
      - text: Send SMS message {sms_id} to {people}.
        slots:
          sms_id: requestBody.sms_id
          people: requestBody.people
      - text: Text {people} using SMS asset {sms_id}, matching contacts by {merge_by}.
        slots:
          people: requestBody.people
          sms_id: requestBody.sms_id
          merge_by: requestBody.merge_by
      method: generated
      generated: '2026-10-01'