# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Admin API V1 Email Subscribers API
  version: 1.0.0
extends: openapi/optimizely-email-subscribers-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: 10
- target: $.paths['/api/v1/admin/EmailSubscribers'].get
  update:
    x-apievangelist-phrasing:
      intent: List email subscribers
      effect: read
      questions:
      - Who is subscribed to emails in Optimizely Commerce?
      - Can I search subscribers for a particular email domain?
      instructions:
      - text: List all email subscribers.
      - text: Show email subscribers matching {filter}.
        slots:
          filter: query.$filter
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/EmailSubscribers'].post
  update:
    x-apievangelist-phrasing:
      intent: Add an email subscriber
      effect: write
      questions:
      - How do I add a new email address to the subscriber list?
      - Is an email address all that's needed to create a subscriber?
      instructions:
      - text: Subscribe {email}.
        slots:
          email: requestBody.email
      - text: Create an email subscriber for {email}.
        slots:
          email: requestBody.email
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/EmailSubscribers({id})'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one email subscriber
      effect: read
      questions:
      - What is stored about a single email subscriber?
      - Can I look up a subscriber record by its id?
      instructions:
      - text: Fetch email subscriber {id}.
        slots:
          id: path.id
      - text: Show the address of subscriber {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/EmailSubscribers({id})'].put
  update:
    x-apievangelist-phrasing:
      intent: Replace an email subscriber record
      effect: write
      questions:
      - Can I overwrite an email subscriber record entirely?
      - Does a full replace of a subscriber need the email resent?
      instructions:
      - text: Replace subscriber {id} with email {email}.
        slots:
          id: path.id
          email: requestBody.email
      - text: Overwrite the full record of email subscriber {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/EmailSubscribers({id})'].delete
  update:
    x-apievangelist-phrasing:
      intent: Remove one email subscriber
      effect: destructive
      questions:
      - How do I delete a single email subscriber?
      - Can removing a subscriber be conditional on its ETag?
      instructions:
      - text: Delete email subscriber {id}.
        slots:
          id: path.id
      - text: Delete subscriber {id} only if its ETag is {etag}.
        slots:
          id: path.id
          etag: header.If-Match
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/EmailSubscribers({id})'].patch
  update:
    x-apievangelist-phrasing:
      intent: Change a subscriber's email address
      effect: write
      questions:
      - Can I correct a typo in a subscriber's email address?
      - Is there a partial update for an existing email subscriber?
      instructions:
      - text: Change the email of subscriber {id} to {email}.
        slots:
          id: path.id
          email: requestBody.email
      - text: Update subscriber {id} so the address reads {email}.
        slots:
          id: path.id
          email: requestBody.email
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/EmailSubscribers/Default.Default()'].get
  update:
    x-apievangelist-phrasing:
      intent: Get default values for a new subscriber
      effect: read
      questions:
      - What defaults does a new email subscriber record start with?
      - Is there a blank email subscriber template?
      instructions:
      - text: Get the default field values for a new email subscriber.
      - text: Show the empty subscriber template.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/emailsubscribers/delete'].delete
  update:
    x-apievangelist-phrasing:
      intent: Bulk delete email subscribers
      effect: destructive
      questions:
      - Can I remove many email subscribers at once?
      - Is there a batch delete for subscribers by a list of ids?
      instructions:
      - text: Bulk delete email subscribers {ids}.
        slots:
          ids: query.ids
      - text: Permanently delete every subscriber in {ids}.
        slots:
          ids: query.ids
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/emailsubscribers({key})/customproperties({custompropertyKey})'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a custom property on a subscriber
      effect: read
      questions:
      - How can I read a custom property stored on an email subscriber?
      - Can I fetch one custom field value from a subscriber record?
      instructions:
      - text: Get custom property {custompropertyKey} of subscriber {key}.
        slots:
          key: path.key
          custompropertyKey: path.custompropertyKey
      - text: Show the {custompropertyKey} custom property on email subscriber {key}.
        slots:
          key: path.key
          custompropertyKey: path.custompropertyKey
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/emailsubscribers({key})/emaillists({emaillistKey})'].get
  update:
    x-apievangelist-phrasing:
      intent: Get an email list a subscriber belongs to
      effect: read
      questions:
      - Which email lists is a subscriber on?
      - Can I check a subscriber's membership in one specific list?
      instructions:
      - text: Get email list {emaillistKey} for subscriber {key}.
        slots:
          key: path.key
          emaillistKey: path.emaillistKey
      - text: Show list {emaillistKey} that subscriber {key} belongs to.
        slots:
          key: path.key
          emaillistKey: path.emaillistKey
      method: generated
      generated: '2026-09-26'