# 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 Subscriber Email Lists API
  version: 1.0.0
extends: openapi/optimizely-email-subscriber-email-lists-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: 9
- target: $.paths['/api/v1/admin/EmailSubscriberEmailLists'].get
  update:
    x-apievangelist-phrasing:
      intent: List email subscriber list memberships
      effect: read
      questions:
      - Which email subscribers belong to which email lists in my commerce admin?
      - Can I filter memberships to one email list to see its subscribers?
      - How many subscriber-to-list memberships are there?
      instructions:
      - text: List all email subscriber list memberships.
      - text: Find subscriber list memberships matching {filter}.
        slots:
          filter: query.$filter
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/EmailSubscriberEmailLists'].post
  update:
    x-apievangelist-phrasing:
      intent: Add an email subscriber to an email list
      effect: write
      questions:
      - How do I put an existing email subscriber onto an email list?
      - Can I link a subscriber record to a mailing list?
      instructions:
      - text: Add email subscriber {emailSubscriberId} to email list {emailListId}.
        slots:
          emailSubscriberId: requestBody.emailSubscriberId
          emailListId: requestBody.emailListId
      - text: Create a membership linking subscriber {emailSubscriberId} with list {emailListId}.
        slots:
          emailSubscriberId: requestBody.emailSubscriberId
          emailListId: requestBody.emailListId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/EmailSubscriberEmailLists({id})'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one subscriber list membership
      effect: read
      questions:
      - What subscriber and list does a given membership record connect?
      - How do I look up a single subscriber list membership by ID?
      instructions:
      - text: Get subscriber list membership {id}.
        slots:
          id: path.id
      - text: Show membership {id} with {expand} expanded.
        slots:
          id: path.id
          expand: query.$expand
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/EmailSubscriberEmailLists({id})'].put
  update:
    x-apievangelist-phrasing:
      intent: Replace a subscriber list membership
      effect: write
      questions:
      - How do I overwrite a subscriber list membership record entirely?
      - Can I fully replace which subscriber and list a membership points at?
      instructions:
      - text: Replace membership {id} so it links subscriber {emailSubscriberId} with list {emailListId}.
        slots:
          id: path.id
          emailSubscriberId: requestBody.emailSubscriberId
          emailListId: requestBody.emailListId
      - text: Overwrite the full subscriber list membership record {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/EmailSubscriberEmailLists({id})'].delete
  update:
    x-apievangelist-phrasing:
      intent: Remove a subscriber from an email list
      effect: destructive
      questions:
      - How do I take a subscriber off an email list by deleting the membership?
      - Can I delete a membership only if its ETag still matches?
      instructions:
      - text: Delete subscriber list membership {id}.
        slots:
          id: path.id
      - text: Delete membership {id} if the ETag is {ifMatch}.
        slots:
          id: path.id
          ifMatch: header.If-Match
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/EmailSubscriberEmailLists({id})'].patch
  update:
    x-apievangelist-phrasing:
      intent: Move a subscriber membership to another list
      effect: write
      questions:
      - Can I change just the email list on an existing membership?
      - How do I patch one field of a subscriber list membership?
      instructions:
      - text: Move membership {id} to email list {emailListId}.
        slots:
          id: path.id
          emailListId: requestBody.emailListId
      - text: Patch membership {id} to point at subscriber {emailSubscriberId}.
        slots:
          id: path.id
          emailSubscriberId: requestBody.emailSubscriberId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/EmailSubscriberEmailLists/Default.Default()'].get
  update:
    x-apievangelist-phrasing:
      intent: Get the default membership template
      effect: read
      questions:
      - What default values does a new subscriber list membership start with?
      - Is there a blank email list membership template?
      instructions:
      - text: Fetch the default subscriber list membership template.
      - text: Get default values for a new email list membership.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/emailsubscriberemaillists/delete'].delete
  update:
    x-apievangelist-phrasing:
      intent: Bulk remove subscriber list memberships
      effect: destructive
      questions:
      - How do I remove many subscribers from lists in one request?
      - Can I delete several membership records by their IDs?
      instructions:
      - text: Bulk delete subscriber list memberships {ids}.
        slots:
          ids: query.ids
      - text: 'Remove all these list memberships at once: {ids}.'
        slots:
          ids: query.ids
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/emailsubscriberemaillists({key})/customproperties({custompropertyKey})'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a custom property of a list membership
      effect: read
      questions:
      - How do I read a custom property on a subscriber list membership?
      - Can I fetch one custom field from a membership record?
      instructions:
      - text: Get custom property {custompropertyKey} of membership {key}.
        slots:
          custompropertyKey: path.custompropertyKey
          key: path.key
      - text: Show custom field {custompropertyKey} on subscriber list membership {key}.
        slots:
          custompropertyKey: path.custompropertyKey
          key: path.key
      method: generated
      generated: '2026-09-26'