Optimizely · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Optimizely Campaign REST Responses API

6 actions 6 updates phrasing extends openapi/optimizely-responses-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 6

$.info

$.paths['/{clientId}/responses/bounces/{recipientId}'].get

$.paths['/{clientId}/responses/bounces/{recipientId}'].delete

$.paths['/{clientId}/responses/bounces/{recipientId}/thresholdExceeded'].get

$.paths['/{clientId}/responses/bounces'].get

$.paths['/{clientId}/responses'].get

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 Responses API
  version: 1.0.0
extends: openapi/optimizely-responses-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: 5
- target: $.paths['/{clientId}/responses/bounces/{recipientId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a recipient's bounce count
      effect: read
      questions:
      - How many hard or soft bounces has a recipient produced so far?
      - Can I check a recipient's bounce count for a specific media type like SMS?
      instructions:
      - text: Get the {category} bounce count for recipient {recipientId} in client {clientId}.
        slots:
          category: query.category
          recipientId: path.recipientId
          clientId: path.clientId
      - text: Count {category} bounces of recipient {recipientId} on {mediaType} for client {clientId}.
        slots:
          category: query.category
          recipientId: path.recipientId
          mediaType: query.mediaType
          clientId: path.clientId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/{clientId}/responses/bounces/{recipientId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Reset a recipient's bounces
      effect: destructive
      questions:
      - How do I clear the hard and soft bounces of a recipient so they get mailings again?
      - Can I reset bounces for a recipient on just one media type?
      instructions:
      - text: Reset all bounces for recipient {recipientId} in client {clientId}.
        slots:
          recipientId: path.recipientId
          clientId: path.clientId
      - text: Clear {mediaType} bounces of recipient {recipientId} for client {clientId}.
        slots:
          mediaType: query.mediaType
          recipientId: path.recipientId
          clientId: path.clientId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/{clientId}/responses/bounces/{recipientId}/thresholdExceeded'].get
  update:
    x-apievangelist-phrasing:
      intent: Check if a recipient exceeded the bounce limit
      effect: read
      questions:
      - Has a recipient gone over the hard or soft bounce threshold?
      - Will a recipient stop receiving mailings because of too many bounces?
      instructions:
      - text: Check whether recipient {recipientId} in client {clientId} exceeded the bounce threshold.
        slots:
          recipientId: path.recipientId
          clientId: path.clientId
      - text: Tell me if recipient {recipientId} is over the {mediaType} bounce limit in client {clientId}.
        slots:
          recipientId: path.recipientId
          mediaType: query.mediaType
          clientId: path.clientId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/{clientId}/responses/bounces'].get
  update:
    x-apievangelist-phrasing:
      intent: Get the allowed bounce threshold
      effect: read
      questions:
      - What is the maximum number of soft bounces allowed before mailings stop?
      - Which hard bounce limit is configured for my client account?
      instructions:
      - text: Get the {category} bounce threshold for client {clientId}.
        slots:
          category: query.category
          clientId: path.clientId
      - text: Show how many {category} bounces client {clientId} allows per recipient.
        slots:
          category: query.category
          clientId: path.clientId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/{clientId}/responses'].get
  update:
    x-apievangelist-phrasing:
      intent: List a recipient's responses
      effect: read
      questions:
      - What responses, like auto-replies or bounces, did a recipient send back?
      - Can I list responses to one mailing for a set of recipients?
      instructions:
      - text: List {category} responses in client {clientId} for recipients {recipientIds}.
        slots:
          category: query.category
          clientId: path.clientId
          recipientIds: query.recipientIds
      - text: Show up to {limit} {category} responses to mailing {mailingId} in client {clientId}.
        slots:
          limit: query.limit
          category: query.category
          mailingId: query.mailingId
          clientId: path.clientId
      method: generated
      generated: '2026-09-26'