AI Applyd · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Aiapplyd Email Preferences API

6 actions 6 updates phrasing extends openapi/aiapplyd-email-preferences-api-openapi.yml
Generated by API Evangelist Written by API Evangelist tooling for AI Applyd's API. It is a proposal applied on top of the contract, not a document AI Applyd publishes.
View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 6

$.info
$.paths['/email-preferences'].get
$.paths['/email-preferences'].put
$.paths['/email-preferences/by-token'].get
$.paths['/email-preferences/by-token'].put
$.paths['/email-preferences/one-click'].post

OpenAPI Overlay

Raw ↑
# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Aiapplyd Email Preferences API
  version: 1.0.0
extends: openapi/aiapplyd-email-preferences-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: 5
- target: $.paths['/email-preferences'].get
  update:
    x-apievangelist-phrasing:
      intent: Get my email subscription settings
      effect: read
      questions:
      - Which emails am I currently subscribed to?
      - Am I opted in to the weekly recap email?
      instructions:
      - text: Show my email preferences.
      - text: List which email types I receive.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/email-preferences'].put
  update:
    x-apievangelist-phrasing:
      intent: Change my email subscription settings
      effect: write
      questions:
      - How do I stop getting product update emails while signed in?
      - Can I turn off re-engagement emails but keep the weekly recap?
      instructions:
      - text: Turn my weekly recap emails {weeklyRecap}.
        slots:
          weeklyRecap: requestBody.weeklyRecap
      - text: Set product updates to {productUpdates} and unsubscribe all to {unsubscribeAll}.
        slots:
          productUpdates: requestBody.productUpdates
          unsubscribeAll: requestBody.unsubscribeAll
      method: generated
      generated: '2026-09-26'
- target: $.paths['/email-preferences/by-token'].get
  update:
    x-apievangelist-phrasing:
      intent: View email settings from an email link
      effect: read
      questions:
      - Can I see my email settings from a link in an email without logging in?
      - What preferences does a signed email-preferences link show?
      instructions:
      - text: Show the email preferences for link token {token}.
        slots:
          token: query.token
      - text: Open my email settings using token {token}.
        slots:
          token: query.token
      method: generated
      generated: '2026-09-26'
- target: $.paths['/email-preferences/by-token'].put
  update:
    x-apievangelist-phrasing:
      intent: Change email settings from an email link
      effect: write
      questions:
      - Can I change which emails I get from the email link without signing in?
      - How do I opt out of onboarding emails using the link in a message?
      instructions:
      - text: Using token {token}, set weekly recap to {weeklyRecap}.
        slots:
          token: query.token
          weeklyRecap: requestBody.weeklyRecap
      - text: 'Unsubscribe from everything via email link token {token}: {unsubscribeAll}.'
        slots:
          token: query.token
          unsubscribeAll: requestBody.unsubscribeAll
      method: generated
      generated: '2026-09-26'
- target: $.paths['/email-preferences/one-click'].post
  update:
    x-apievangelist-phrasing:
      intent: One-click unsubscribe from emails
      effect: write
      questions:
      - Does the unsubscribe button in my mail client stop all emails in one click?
      - What handles the List-Unsubscribe one-click request?
      instructions:
      - text: One-click unsubscribe with token {token}.
        slots:
          token: query.token
      - text: Process a one-click list-unsubscribe for {token}.
        slots:
          token: query.token
      method: generated
      generated: '2026-09-26'