# 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 Message Addresses API
  version: 1.0.0
extends: openapi/optimizely-email-message-addresses-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/EmailMessageAddresses'].get
  update:
    x-apievangelist-phrasing:
      intent: List email message addresses
      effect: read
      questions:
      - Which recipient addresses are recorded on outgoing commerce emails?
      - Can I filter email message addresses to only CC recipients?
      - How many email message address records exist?
      instructions:
      - text: List all email message addresses.
      - text: List email message addresses matching {filter}.
        slots:
          filter: query.$filter
      - text: Show the first {top} email message addresses ordered by {orderby}.
        slots:
          top: query.$top
          orderby: query.$orderby
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/EmailMessageAddresses'].post
  update:
    x-apievangelist-phrasing:
      intent: Add an address to an email message
      effect: write
      questions:
      - How do I add a recipient address to an email message?
      - Can I mark a new email address as To, CC or BCC?
      instructions:
      - text: Add {emailAddress} as a {type} address on email message {emailMessageId}.
        slots:
          emailAddress: requestBody.emailAddress
          type: requestBody.type
          emailMessageId: requestBody.emailMessageId
      - text: Create an email message address {emailAddress} of type {type}.
        slots:
          emailAddress: requestBody.emailAddress
          type: requestBody.type
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/EmailMessageAddresses({id})'].get
  update:
    x-apievangelist-phrasing:
      intent: Get an email message address
      effect: read
      questions:
      - What address and recipient type does one email message address record hold?
      - Can I look up a single email message address by ID?
      instructions:
      - text: Get email message address {id}.
        slots:
          id: path.id
      - text: Show the recipient details of email address record {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/EmailMessageAddresses({id})'].put
  update:
    x-apievangelist-phrasing:
      intent: Replace an email message address
      effect: write
      questions:
      - How do I overwrite an email message address record completely?
      - Does replacing an email message address reset fields I omit?
      instructions:
      - text: Replace email message address {id} with {emailAddress} of type {type}.
        slots:
          id: path.id
          emailAddress: requestBody.emailAddress
          type: requestBody.type
      - text: Overwrite all fields of email address record {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/EmailMessageAddresses({id})'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete an email message address
      effect: destructive
      questions:
      - Can I remove one recipient address from an email message?
      - Is it possible to delete an email message address only if its ETag matches?
      instructions:
      - text: Delete email message address {id}.
        slots:
          id: path.id
      - text: Delete email address record {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/EmailMessageAddresses({id})'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update an email message address
      effect: write
      questions:
      - How do I fix a typo in a recipient address on an email message?
      - Can I change a recipient from CC to BCC without replacing the record?
      instructions:
      - text: Change email message address {id} to {emailAddress}.
        slots:
          id: path.id
          emailAddress: requestBody.emailAddress
      - text: Set the recipient type of email address record {id} to {type}.
        slots:
          id: path.id
          type: requestBody.type
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/EmailMessageAddresses/Default.Default()'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a blank email message address template
      effect: read
      questions:
      - What default values does a new email message address have?
      - Can I fetch an empty email message address template?
      instructions:
      - text: Fetch the default email message address template.
      - text: Show the starting values for a new email message address.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/emailmessageaddresses/delete'].delete
  update:
    x-apievangelist-phrasing:
      intent: Bulk delete email message addresses
      effect: destructive
      questions:
      - Can I delete several email message addresses at once?
      - How do I remove a batch of recipient address records by ID?
      instructions:
      - text: Bulk delete email message addresses {ids}.
        slots:
          ids: query.ids
      - text: 'Remove these email address records together: {ids}.'
        slots:
          ids: query.ids
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/emailmessageaddresses({key})/customproperties({custompropertyKey})'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a custom property on an email address record
      effect: read
      questions:
      - Can I read a custom property stored on an email message address?
      - What extra custom values does an email address record carry?
      instructions:
      - text: Get custom property {custompropertyKey} on email message address {key}.
        slots:
          custompropertyKey: path.custompropertyKey
          key: path.key
      - text: Show email address record {key}'s custom property {custompropertyKey}.
        slots:
          key: path.key
          custompropertyKey: path.custompropertyKey
      method: generated
      generated: '2026-09-26'