Optimizely · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Optimizely Campaign REST Transactional Mail API

2 actions 2 updates phrasing extends openapi/optimizely-transactional-mail-api-openapi.yml

Generated by API Evangelist Written by API Evangelist tooling for Optimizely's API. It is a proposal applied on top of the contract, not a document Optimizely publishes.

View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 2

$.info

$.paths['/{clientId}/transactionalmail'].post

OpenAPI Overlay

# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Optimizely Campaign REST Transactional Mail API
  version: 1.0.0
extends: openapi/optimizely-transactional-mail-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: 1
- target: $.paths['/{clientId}/transactionalmail'].post
  update:
    x-apievangelist-phrasing:
      intent: Send a transactional email
      effect: write
      questions:
      - How do I send an order confirmation or password reset email to one recipient?
      - Can I personalize a transactional email with my own key-value data?
      instructions:
      - text: Send transactional mailing {mailing_id} to {recipient_email} from client {clientId}.
        slots:
          mailing_id: requestBody.mailing_id
          recipient_email: requestBody.recipient_email
          clientId: path.clientId
      - text: Email {recipient_email} using template {mailing_id} personalized with {personalization}.
        slots:
          recipient_email: requestBody.recipient_email
          mailing_id: requestBody.mailing_id
          personalization: requestBody.personalization
      method: generated
      generated: '2026-09-26'