API Evangelist conversational phrasing for Paubox Marketing Subscriptions API

# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Paubox Marketing Subscriptions API
  version: 1.0.0
extends: openapi/paubox-subscriptions-api-openapi.yml
actions:
- target: $.info
  update:
    x-apievangelist-phrasing:
      method: generated
      generated: '2026-10-01'
      generator: build-phrasing.py
      label: Generated by API Evangelist
      operations: 10
- target: $.paths['/subscriptions'].get
  update:
    x-apievangelist-phrasing:
      intent: List all subscriber-to-list subscriptions
      effect: read
      questions:
      - How do I see every subscriber-to-list membership in my account?
      - Which list-level opt-outs exist across my subscriptions?
      instructions:
      - text: List all subscriptions on my account.
      - text: Show every subscription record with its unsubscribed_at timestamp.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/subscriptions'].post
  update:
    x-apievangelist-phrasing:
      intent: Subscribe an existing subscriber to a list
      effect: write
      questions:
      - How do I put an existing subscriber onto a list using their internal numeric ID?
      - Will creating a subscription trigger a drip campaign on that list?
      instructions:
      - text: Create subscription {subscription}.
        slots:
          subscription: requestBody.subscription
      - text: 'Create a subscription record linking a numeric subscriber ID to a list: {subscription}.'
        slots:
          subscription: requestBody.subscription
      method: generated
      generated: '2026-10-01'
- target: $.paths['/subscriptions/{subscription_id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one subscription
      effect: read
      questions:
      - How do I look up a single subscription by its UUID?
      - Can I check whether one specific list membership has been unsubscribed?
      instructions:
      - text: Get subscription {subscription_id}.
        slots:
          subscription_id: path.subscription_id
      - text: Show the details of list membership {subscription_id}.
        slots:
          subscription_id: path.subscription_id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/subscriptions/{subscription_id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Unsubscribe one list membership
      effect: destructive
      questions:
      - How do I unsubscribe someone from just one list using the subscription's UUID?
      - Does removing a single subscription opt the person out globally?
      instructions:
      - text: Unsubscribe subscription {subscription_id}.
        slots:
          subscription_id: path.subscription_id
      - text: End list membership {subscription_id} without touching their other lists.
        slots:
          subscription_id: path.subscription_id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/subscriptions/subscribe'].post
  update:
    x-apievangelist-phrasing:
      intent: Re-subscribe specific subscribers
      effect: write
      questions:
      - How do I re-subscribe a few contacts who previously opted out?
      - Can I clear opt-outs on specific lists only for certain subscribers?
      instructions:
      - text: Re-subscribe subscribers {subscriber_ids}.
        slots:
          subscriber_ids: requestBody.subscriber_ids
      - text: Re-subscribe {subscriber_ids} to lists {subscription_list_ids}.
        slots:
          subscriber_ids: requestBody.subscriber_ids
          subscription_list_ids: requestBody.subscription_list_ids
      method: generated
      generated: '2026-10-01'
- target: $.paths['/subscriptions/unsubscribe'].post
  update:
    x-apievangelist-phrasing:
      intent: Unsubscribe or opt out specific subscribers
      effect: destructive
      questions:
      - How do I unsubscribe a handful of contacts by their UUIDs?
      - What happens if I unsubscribe subscribers without naming any lists?
      instructions:
      - text: Globally opt out subscribers {subscriber_ids}.
        slots:
          subscriber_ids: requestBody.subscriber_ids
      - text: Unsubscribe {subscriber_ids} from lists {subscription_list_ids} only.
        slots:
          subscriber_ids: requestBody.subscriber_ids
          subscription_list_ids: requestBody.subscription_list_ids
      method: generated
      generated: '2026-10-01'
- target: $.paths['/subscriptions/bulk_global_subscribe'].post
  update:
    x-apievangelist-phrasing:
      intent: Clear global opt-out for a whole list
      effect: write
      questions:
      - Can I clear the global opt-out for everyone on a subscription list without listing each one?
      - Can I re-subscribe a whole list except a few people?
      instructions:
      - text: Clear the global opt-out for everyone on subscription list {from_subscription_list_id}.
        slots:
          from_subscription_list_id: requestBody.from_subscription_list_id
      - text: Globally re-subscribe all of list {from_subscription_list_id} except {except_ids}.
        slots:
          from_subscription_list_id: requestBody.from_subscription_list_id
          except_ids: requestBody.except_ids
      method: generated
      generated: '2026-10-01'
- target: $.paths['/subscriptions/bulk_global_unsubscribe'].post
  update:
    x-apievangelist-phrasing:
      intent: Globally opt out a whole subscription list
      effect: destructive
      questions:
      - How do I globally opt out every member of a subscription list in one call?
      - Can I suppress marketing email for a list's members matching a search term?
      instructions:
      - text: Globally opt out every subscriber on list {from_subscription_list_id}.
        slots:
          from_subscription_list_id: requestBody.from_subscription_list_id
      - text: Opt out members of list {from_subscription_list_id} matching {search}, except {except_ids}.
        slots:
          from_subscription_list_id: requestBody.from_subscription_list_id
          search: requestBody.search
          except_ids: requestBody.except_ids
      method: generated
      generated: '2026-10-01'
- target: $.paths['/subscriptions/dynamic_bulk_subscribe'].post
  update:
    x-apievangelist-phrasing:
      intent: Clear global opt-out for a dynamic list
      effect: write
      questions:
      - Can I re-subscribe everyone who currently matches a dynamic list's filters?
      - How do I clear opt-outs for a saved dynamic segment in the background?
      instructions:
      - text: Clear the global opt-out for all current members of dynamic list {from_subscription_list_id}.
        slots:
          from_subscription_list_id: requestBody.from_subscription_list_id
      - text: Re-subscribe dynamic list {from_subscription_list_id} except {except_ids}.
        slots:
          from_subscription_list_id: requestBody.from_subscription_list_id
          except_ids: requestBody.except_ids
      method: generated
      generated: '2026-10-01'
- target: $.paths['/subscriptions/dynamic_bulk_unsubscribe'].post
  update:
    x-apievangelist-phrasing:
      intent: Globally opt out a dynamic list's members
      effect: destructive
      questions:
      - How do I opt out everyone currently in a dynamic list segment?
      - Can I unsubscribe a dynamic list's members but spare a few of them?
      instructions:
      - text: Globally opt out all current members of dynamic list {from_subscription_list_id}.
        slots:
          from_subscription_list_id: requestBody.from_subscription_list_id
      - text: Unsubscribe dynamic segment {from_subscription_list_id}, sparing {except_ids}.
        slots:
          from_subscription_list_id: requestBody.from_subscription_list_id
          except_ids: requestBody.except_ids
      method: generated
      generated: '2026-10-01'