Optimizely · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Optimizely Unsubscribes API

5 actions 5 updates phrasing extends openapi/optimizely-unsubscribes-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['/{clientId}/unsubscribes'].get
$.paths['/{clientId}/unsubscribes'].post
$.paths['/{clientId}/unsubscribes'].delete
$.paths['/{clientId}/unsubscribes/count'].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 Unsubscribes API
  version: 1.0.0
extends: openapi/optimizely-unsubscribes-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['/{clientId}/unsubscribes'].get
  update:
    x-apievangelist-phrasing:
      intent: List unsubscribed recipients
      effect: read
      questions:
      - Who has unsubscribed from our email communications?
      - Can I pull the full unsubscribe list for a client?
      instructions:
      - text: List unsubscribed recipients for client {clientId}.
        slots:
          clientId: path.clientId
      - text: Show everyone on client {clientId}'s unsubscribe list.
        slots:
          clientId: path.clientId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/{clientId}/unsubscribes'].post
  update:
    x-apievangelist-phrasing:
      intent: Unsubscribe a recipient
      effect: write
      questions:
      - How do I add someone to the unsubscribe list by email?
      - Can I manually opt a recipient out of all mailings?
      instructions:
      - text: Unsubscribe {email} for client {clientId}.
        slots:
          email: requestBody.email
          clientId: path.clientId
      - text: Add {email} to client {clientId}'s unsubscribe list.
        slots:
          email: requestBody.email
          clientId: path.clientId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/{clientId}/unsubscribes'].delete
  update:
    x-apievangelist-phrasing:
      intent: Resubscribe recipients
      effect: destructive
      questions:
      - Can I take several recipients off the internal unsubscribe list?
      - Is it possible to remove unsubscribes for just one media type or recipient list?
      instructions:
      - text: Remove recipients {recipientIds} from client {clientId}'s unsubscribe list.
        slots:
          recipientIds: query.recipientIds
          clientId: path.clientId
      - text: Remove unsubscribes {recipientIds} for media type {mediaType} in client {clientId}.
        slots:
          recipientIds: query.recipientIds
          mediaType: query.mediaType
          clientId: path.clientId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/{clientId}/unsubscribes/count'].get
  update:
    x-apievangelist-phrasing:
      intent: Count unsubscribed recipients
      effect: read
      questions:
      - How many recipients are currently unsubscribed?
      - Can I count unsubscribes for a single media type like SMS?
      instructions:
      - text: Count unsubscribed recipients for client {clientId}.
        slots:
          clientId: path.clientId
      - text: Get the number of {mediaType} unsubscribes in client {clientId}.
        slots:
          mediaType: query.mediaType
          clientId: path.clientId
      method: generated
      generated: '2026-09-26'