Optimizely · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Advanced Reachability API

3 actions 3 updates phrasing extends openapi/optimizely-reachability-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 3

$.info

$.paths['/reachability'].post

$.paths['/reachability/{identifier_field_name}'].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 Advanced Reachability API
  version: 1.0.0
extends: openapi/optimizely-reachability-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: 2
- target: $.paths['/reachability'].post
  update:
    x-apievangelist-phrasing:
      intent: Update whether an identifier is reachable
      effect: write
      questions:
      - How do I mark an email address as unreachable after a hard bounce?
      - Can I record a reason and timestamp when an identifier's reachability changes?
      instructions:
      - text: Mark {identifier_field_name} {identifier_value} as reachable {reachable} with update type {reachable_update_type}.
        slots:
          identifier_field_name: requestBody.identifier_field_name
          identifier_value: requestBody.identifier_value
          reachable: requestBody.reachable
          reachable_update_type: requestBody.reachable_update_type
      - text: Flag {identifier_field_name} {identifier_value} unreachable ({reachable}) as type {reachable_update_type} because {reachable_update_reason}.
        slots:
          identifier_field_name: requestBody.identifier_field_name
          identifier_value: requestBody.identifier_value
          reachable: requestBody.reachable
          reachable_update_type: requestBody.reachable_update_type
          reachable_update_reason: requestBody.reachable_update_reason
      method: generated
      generated: '2026-09-26'
- target: $.paths['/reachability/{identifier_field_name}'].get
  update:
    x-apievangelist-phrasing:
      intent: Check if an identifier is reachable
      effect: read
      questions:
      - Can I still send messages to a given email address, or is it unreachable?
      - What reachability information is stored for a customer's identifier?
      instructions:
      - text: Check reachability of {identifier_field_name} {id}.
        slots:
          identifier_field_name: path.identifier_field_name
          id: query.id
      - text: Look up whether email {id} is reachable.
        slots:
          id: query.id
      method: generated
      generated: '2026-09-26'