Optimizely · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Lists API

5 actions 5 updates phrasing extends openapi/optimizely-lists-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 5

$.info

$.paths['/lists/subscriptions'].get

$.paths['/lists/subscriptions'].post

$.paths['/lists'].get

$.paths['/lists'].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 Lists API
  version: 1.0.0
extends: openapi/optimizely-lists-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['/lists/subscriptions'].get
  update:
    x-apievangelist-phrasing:
      intent: Check list subscription status for a customer
      effect: read
      questions:
      - Is a customer subscribed to my Optimizely Data Platform lists?
      - Can I look up list subscriptions by an identifier like email?
      instructions:
      - text: Check list subscription status for identifier {identifiers}.
        slots:
          identifiers: query.identifiers
      - text: Show which ODP lists the customer with {identifiers} is subscribed to.
        slots:
          identifiers: query.identifiers
      method: generated
      generated: '2026-09-26'
- target: $.paths['/lists/subscriptions'].post
  update:
    x-apievangelist-phrasing:
      intent: Subscribe or unsubscribe a customer from a list
      effect: write
      questions:
      - How do I add a customer to an ODP list or take them off it?
      - Can I unsubscribe a messaging identifier from a specific list?
      instructions:
      - text: Subscribe the customer to list {list_id}.
        slots:
          list_id: requestBody.list_id
      - text: Set subscribed to {subscribed} for list {list_id}.
        slots:
          subscribed: requestBody.subscribed
          list_id: requestBody.list_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/lists'].get
  update:
    x-apievangelist-phrasing:
      intent: List all ODP lists
      effect: read
      questions:
      - What lists exist in my Optimizely Data Platform account?
      - Where can I see every marketing list in ODP?
      instructions:
      - text: List all lists in my ODP account.
      - text: Show me every Data Platform list.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/lists'].post
  update:
    x-apievangelist-phrasing:
      intent: Create an ODP list
      effect: write
      questions:
      - How do I create a new marketing list in ODP?
      - Can I add a named list for customers to subscribe to?
      instructions:
      - text: Create an ODP list named {name}.
        slots:
          name: requestBody.name
      - text: Add a new subscription list called {name}.
        slots:
          name: requestBody.name
      method: generated
      generated: '2026-09-26'