API Evangelist conversational phrasing for Paubox Marketing Subscribers 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 Subscribers API
  version: 1.0.0
extends: openapi/paubox-subscribers-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: 7
- target: $.paths['/subscribers'].get
  update:
    x-apievangelist-phrasing:
      intent: List marketing subscribers
      effect: read
      questions:
      - Who are the contacts in my marketing audience?
      - Can I list only the subscribers on a particular contact list?
      - Is there a way to search subscribers by a term and page through them?
      instructions:
      - text: List subscribers on list {subscription_list_id}.
        slots:
          subscription_list_id: query.subscription_list_id
      - text: Search my subscribers for {search}.
        slots:
          search: query.search
      method: generated
      generated: '2026-10-01'
- target: $.paths['/subscribers'].post
  update:
    x-apievangelist-phrasing:
      intent: Add a single subscriber
      effect: write
      questions:
      - How do I add one new contact to my marketing audience?
      - Can I add a new subscriber directly to a specific list when I create them?
      instructions:
      - text: Create subscriber {subscriber}.
        slots:
          subscriber: requestBody.subscriber
      - text: Add new subscriber {subscriber} to list {subscription_list_id}.
        slots:
          subscriber: requestBody.subscriber
          subscription_list_id: requestBody.subscription_list_id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/subscribers/{subscriber_id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one subscriber's details
      effect: read
      questions:
      - How do I look up a single subscriber's record?
      - Can I see a subscriber's engagement stats along with their profile?
      instructions:
      - text: Get subscriber {subscriber_id}.
        slots:
          subscriber_id: path.subscriber_id
      - text: Show subscriber {subscriber_id} with aggregate analytics ({with_stats}).
        slots:
          subscriber_id: path.subscriber_id
          with_stats: query.with_stats
      method: generated
      generated: '2026-10-01'
- target: $.paths['/subscribers/{subscriber_id}'].put
  update:
    x-apievangelist-phrasing:
      intent: Replace a subscriber's record (PUT)
      effect: write
      questions:
      - How do I overwrite a subscriber's record using a PUT request?
      - Is there a PUT variant for updating a subscriber?
      instructions:
      - text: PUT updated details {subscriber} onto subscriber {subscriber_id}.
        slots:
          subscriber: requestBody.subscriber
          subscriber_id: path.subscriber_id
      - text: Use the PUT endpoint to update subscriber {subscriber_id}.
        slots:
          subscriber_id: path.subscriber_id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/subscribers/{subscriber_id}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Partially update a subscriber (PATCH)
      effect: write
      questions:
      - Can I change just a subscriber's name with a PATCH request?
      - Which method lets me patch a few fields on a contact?
      instructions:
      - text: PATCH subscriber {subscriber_id} with {subscriber}.
        slots:
          subscriber_id: path.subscriber_id
          subscriber: requestBody.subscriber
      - text: Patch only the changed fields on subscriber {subscriber_id}.
        slots:
          subscriber_id: path.subscriber_id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/subscribers_bulk_create'].post
  update:
    x-apievangelist-phrasing:
      intent: Add many subscribers at once
      effect: write
      questions:
      - Can I import a batch of contacts in a single request?
      - How do I bulk add subscribers straight onto one list?
      instructions:
      - text: 'Bulk create these subscribers: {subscribers}.'
        slots:
          subscribers: requestBody.subscribers
      - text: Import {subscribers} into list {subscription_list_id} in one go.
        slots:
          subscribers: requestBody.subscribers
          subscription_list_id: requestBody.subscription_list_id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/subscribers_bulk_delete'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete subscribers in bulk
      effect: destructive
      questions:
      - How do I delete several subscribers at once?
      - Can I remove subscribers from one list only rather than from all contacts?
      instructions:
      - text: Delete subscribers {subscriber_ids}.
        slots:
          subscriber_ids: query.subscriber_ids
      - text: Remove subscribers {subscriber_ids} from list {subscription_list_id}.
        slots:
          subscriber_ids: query.subscriber_ids
          subscription_list_id: query.subscription_list_id
      method: generated
      generated: '2026-10-01'