Optimizely · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Optimizely Campaign REST Mail ID API

4 actions 4 updates phrasing extends openapi/optimizely-mail-id-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 4

$.info
$.paths['/{clientId}/mailid/{mailId}'].get
$.paths['/{clientId}/mailid/{mailId}/plain'].get
$.paths['/{clientId}/mailid'].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 Optimizely Campaign REST Mail ID API
  version: 1.0.0
extends: openapi/optimizely-mail-id-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: 3
- target: $.paths['/{clientId}/mailid/{mailId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Decode a full mail ID
      effect: read
      questions:
      - Which mailing, recipient list and recipient does a mail ID stand for?
      - Can I decode a full encoded mail ID into its parts?
      instructions:
      - text: Decode mail ID {mailId} for client {clientId} into mailing, list and recipient.
        slots:
          mailId: path.mailId
          clientId: path.clientId
      - text: Get the details behind full mail ID {mailId} in client {clientId}.
        slots:
          mailId: path.mailId
          clientId: path.clientId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/{clientId}/mailid/{mailId}/plain'].get
  update:
    x-apievangelist-phrasing:
      intent: Decode a plain mail ID to its mailing
      effect: read
      questions:
      - What mailing does a plain mail ID, one without recipient data, refer to?
      - Can I look up just the mailing behind a plain mail ID?
      instructions:
      - text: Decode plain mail ID {mailId} for client {clientId} to its mailing.
        slots:
          mailId: path.mailId
          clientId: path.clientId
      - text: Show the mailing referenced by plain mail ID {mailId} in client {clientId}.
        slots:
          mailId: path.mailId
          clientId: path.clientId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/{clientId}/mailid'].get
  update:
    x-apievangelist-phrasing:
      intent: Generate a mail ID for a mailing recipient
      effect: read
      questions:
      - How do I get the mail ID for a particular mailing-to-user record?
      - Can I retrieve a mail ID to reuse later in links or tracking?
      instructions:
      - text: Retrieve the mail ID for mailing-to-user {MailingToUserID} in client {clientId}.
        slots:
          MailingToUserID: query.MailingToUserID
          clientId: path.clientId
      - text: Get a mail ID for recipient mailing record {MailingToUserID}, client {clientId}.
        slots:
          MailingToUserID: query.MailingToUserID
          clientId: path.clientId
      method: generated
      generated: '2026-09-26'