# 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 User Profile Email Lists API
  version: 1.0.0
extends: openapi/optimizely-user-profile-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/UserProfileEmailLists'].get
  update:
    x-apievangelist-phrasing:
      intent: List user email list subscriptions
      effect: read
      questions:
      - Which user profiles are subscribed to which email lists?
      - Can I filter email list memberships to a single user profile?
      - How many users are on a particular email list?
      instructions:
      - text: List all user profile email list memberships.
      - text: Find email list memberships matching {filter}.
        slots:
          filter: query.$filter
      - text: Count the email list memberships matching {filter}.
        slots:
          filter: query.$filter
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/UserProfileEmailLists'].post
  update:
    x-apievangelist-phrasing:
      intent: Subscribe a user profile to an email list
      effect: write
      questions:
      - How do I add a user to an email list?
      - Can I link one user profile to several email lists?
      instructions:
      - text: Subscribe user profile {userProfileId} to email list {emailListId}.
        slots:
          userProfileId: requestBody.userProfileId
          emailListId: requestBody.emailListId
      - text: Add email list {emailListId} to user {userProfileId}.
        slots:
          emailListId: requestBody.emailListId
          userProfileId: requestBody.userProfileId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/UserProfileEmailLists({id})'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a user email list membership
      effect: read
      questions:
      - How do I look up one user-to-email-list membership by ID?
      - Which user and list does a membership record connect?
      instructions:
      - text: Get email list membership {id}.
        slots:
          id: path.id
      - text: Show the user and email list for membership {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/UserProfileEmailLists({id})'].put
  update:
    x-apievangelist-phrasing:
      intent: Replace a user email list membership
      effect: write
      questions:
      - How do I overwrite an email list membership record in full?
      - Does replacing a membership reset fields I omit?
      instructions:
      - text: Replace membership {id} to link user {userProfileId} with list {emailListId}.
        slots:
          id: path.id
          userProfileId: requestBody.userProfileId
          emailListId: requestBody.emailListId
      - text: Overwrite every field of email list membership {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/UserProfileEmailLists({id})'].delete
  update:
    x-apievangelist-phrasing:
      intent: Unsubscribe a user from an email list
      effect: destructive
      questions:
      - How do I remove a user from an email list?
      - Can I delete a membership only if its ETag still matches?
      instructions:
      - text: Delete email list membership {id}.
        slots:
          id: path.id
      - text: Delete email list membership {id} if its ETag is {etag}.
        slots:
          id: path.id
          etag: header.If-Match
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/UserProfileEmailLists({id})'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update a user email list membership
      effect: write
      questions:
      - How do I switch a user's membership to a different email list?
      - Can I partially update an email list membership?
      instructions:
      - text: Move membership {id} to email list {emailListId}.
        slots:
          id: path.id
          emailListId: requestBody.emailListId
      - text: Change the user on membership {id} to {userProfileId}.
        slots:
          id: path.id
          userProfileId: requestBody.userProfileId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/UserProfileEmailLists/Default.Default()'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a default email list membership template
      effect: read
      questions:
      - What default values does a new email list membership start with?
      - Can I fetch a blank user email list membership template?
      instructions:
      - text: Fetch the default email list membership template.
      - text: Show me the defaults for a new user email list membership.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/userprofileemaillists/delete'].delete
  update:
    x-apievangelist-phrasing:
      intent: Bulk remove user email list memberships
      effect: destructive
      questions:
      - How do I remove many users from email lists in one go?
      - Can I delete email list memberships by a list of IDs?
      instructions:
      - text: Bulk delete email list memberships {ids}.
        slots:
          ids: query.ids
      - text: 'Remove these email list memberships in one call: {ids}.'
        slots:
          ids: query.ids
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/userprofileemaillists({key})/customproperties({custompropertyKey})'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a custom property on an email list membership
      effect: read
      questions:
      - How do I read a custom property stored on an email list membership?
      - Can I fetch one extra property from a user email list membership?
      instructions:
      - text: Get custom property {custompropertyKey} on email list membership {key}.
        slots:
          custompropertyKey: path.custompropertyKey
          key: path.key
      - text: Show email list membership {key}'s custom property {custompropertyKey}.
        slots:
          key: path.key
          custompropertyKey: path.custompropertyKey
      method: generated
      generated: '2026-09-26'