Optimizely · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Consent API

3 actions 3 updates phrasing extends openapi/optimizely-consent-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['/consent'].post
$.paths['/consent/{identifier_field_name}'].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 Consent API
  version: 1.0.0
extends: openapi/optimizely-consent-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['/consent'].post
  update:
    x-apievangelist-phrasing:
      intent: Update marketing consent for customers
      effect: write
      questions:
      - How do I record marketing opt-ins for many customers at once?
      - Can I update email consent in bulk after importing a signup list?
      instructions:
      - text: Update marketing consent for this batch of customers.
      - text: Record the latest marketing consent choices for my customers.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/consent/{identifier_field_name}'].get
  update:
    x-apievangelist-phrasing:
      intent: Check a customer's marketing consent
      effect: read
      questions:
      - Has this customer consented to receive marketing emails?
      - Can I look up consent by email address or another messaging identifier?
      instructions:
      - text: Get marketing consent for {id} by {identifier_field_name}.
        slots:
          id: query.id
          identifier_field_name: path.identifier_field_name
      - text: Check whether {id} has opted in to marketing, looked up by {identifier_field_name}.
        slots:
          id: query.id
          identifier_field_name: path.identifier_field_name
      method: generated
      generated: '2026-09-26'