# 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 Delivery Attempts API
  version: 1.0.0
extends: openapi/optimizely-email-message-delivery-attempts-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/EmailMessageDeliveryAttempts'].get
  update:
    x-apievangelist-phrasing:
      intent: List email delivery attempts
      effect: read
      questions:
      - How can I see every attempt the site made to deliver its emails?
      - Can I filter email delivery attempts down to the ones that logged an error?
      instructions:
      - text: List all email delivery attempts.
      - text: List email delivery attempts matching {filter}.
        slots:
          filter: query.$filter
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/EmailMessageDeliveryAttempts'].post
  update:
    x-apievangelist-phrasing:
      intent: Record an email delivery attempt
      effect: write
      questions:
      - How do I log a new delivery attempt for an email message?
      - Can I record the error message when an email fails to send?
      instructions:
      - text: Record a delivery attempt for email {emailMessageId} with error {errorMessage}.
        slots:
          emailMessageId: requestBody.emailMessageId
          errorMessage: requestBody.errorMessage
      - text: Log a delivery attempt at {attemptedDateTime} with error text {errorMessage}.
        slots:
          attemptedDateTime: requestBody.attemptedDateTime
          errorMessage: requestBody.errorMessage
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/EmailMessageDeliveryAttempts({id})'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one email delivery attempt
      effect: read
      questions:
      - How can I look up a single email delivery attempt?
      - Where do I see when one delivery attempt was made and whether it was delivered?
      instructions:
      - text: Show email delivery attempt {id}.
        slots:
          id: path.id
      - text: Fetch {select} for delivery attempt {id}.
        slots:
          id: path.id
          select: query.$select
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/EmailMessageDeliveryAttempts({id})'].put
  update:
    x-apievangelist-phrasing:
      intent: Replace an email delivery attempt
      effect: write
      questions:
      - How do I overwrite an entire email delivery attempt record?
      - Will a full replace of a delivery attempt clear its delivered date?
      instructions:
      - text: Replace delivery attempt {id} with error message {errorMessage}.
        slots:
          id: path.id
          errorMessage: requestBody.errorMessage
      - text: Overwrite the full email delivery attempt {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/EmailMessageDeliveryAttempts({id})'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete one email delivery attempt
      effect: destructive
      questions:
      - How do I remove a single email delivery attempt from the log?
      - Can I delete a delivery attempt conditionally with an ETag?
      instructions:
      - text: Delete email delivery attempt {id}.
        slots:
          id: path.id
      - text: Remove delivery attempt {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/EmailMessageDeliveryAttempts({id})'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update an email delivery attempt
      effect: write
      questions:
      - How can I mark a delivery attempt as delivered after the fact?
      - Can I change only the error text on a delivery attempt?
      instructions:
      - text: Set delivery attempt {id} delivered on {deliveredDate}.
        slots:
          id: path.id
          deliveredDate: requestBody.deliveredDate
      - text: Update the error on delivery attempt {id} to {errorMessage}.
        slots:
          id: path.id
          errorMessage: requestBody.errorMessage
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/EmailMessageDeliveryAttempts/Default.Default()'].get
  update:
    x-apievangelist-phrasing:
      intent: Get defaults for a new delivery attempt
      effect: read
      questions:
      - What default values does a new email delivery attempt have?
      - Where do I get a blank delivery attempt template?
      instructions:
      - text: Fetch the default email delivery attempt template.
      - text: Show starting values for a new delivery attempt.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/emailmessagedeliveryattempts/delete'].delete
  update:
    x-apievangelist-phrasing:
      intent: Bulk delete email delivery attempts
      effect: destructive
      questions:
      - How do I purge many email delivery attempts at once?
      - Can I pass a list of ids to clear delivery attempt records?
      instructions:
      - text: Bulk delete email delivery attempts {ids}.
        slots:
          ids: query.ids
      - text: Permanently delete every delivery attempt in {ids}.
        slots:
          ids: query.ids
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/emailmessagedeliveryattempts({key})/customproperties({custompropertyKey})'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a custom property of a delivery attempt
      effect: read
      questions:
      - Where can I read a custom property on an email delivery attempt?
      - How do I fetch one custom attribute from a delivery attempt?
      instructions:
      - text: Get custom property {custompropertyKey} of delivery attempt {key}.
        slots:
          key: path.key
          custompropertyKey: path.custompropertyKey
      - text: Read custom field {custompropertyKey} on email delivery attempt {key}.
        slots:
          key: path.key
          custompropertyKey: path.custompropertyKey
      method: generated
      generated: '2026-09-26'