# 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 Subscription Lists API
  version: 1.0.0
extends: openapi/paubox-subscription-lists-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: 5
- target: $.paths['/subscription_lists'].get
  update:
    x-apievangelist-phrasing:
      intent: List contact lists
      effect: read
      questions:
      - What subscription lists do I have in my marketing account?
      - How can I get the IDs of all my contact lists?
      instructions:
      - text: List all my subscription lists.
      - text: Show every contact list with its ID.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/subscription_lists'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a contact list
      effect: write
      questions:
      - How do I create a new contact list for segmenting subscribers?
      - Are there names I'm not allowed to use for a new subscription list?
      instructions:
      - text: Create a subscription list called {name}.
        slots:
          name: requestBody.name
      - text: Make a new contact list named {name}.
        slots:
          name: requestBody.name
      method: generated
      generated: '2026-10-01'
- target: $.paths['/subscription_lists/{subscription_list_id}'].put
  update:
    x-apievangelist-phrasing:
      intent: Rename a contact list (PUT)
      effect: write
      questions:
      - How do I rename a subscription list with a PUT request?
      - Is there a PUT method for changing a contact list's name?
      instructions:
      - text: PUT the name {name} on subscription list {subscription_list_id}.
        slots:
          name: requestBody.name
          subscription_list_id: path.subscription_list_id
      - text: Use the PUT endpoint to rename list {subscription_list_id} to {name}.
        slots:
          subscription_list_id: path.subscription_list_id
          name: requestBody.name
      method: generated
      generated: '2026-10-01'
- target: $.paths['/subscription_lists/{subscription_list_id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a contact list
      effect: destructive
      questions:
      - How do I delete a subscription list I no longer need?
      - Can the default all-contacts list be deleted?
      instructions:
      - text: Delete subscription list {subscription_list_id}.
        slots:
          subscription_list_id: path.subscription_list_id
      - text: Remove contact list {subscription_list_id} from the account.
        slots:
          subscription_list_id: path.subscription_list_id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/subscription_lists/{subscription_list_id}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Rename a contact list (PATCH)
      effect: write
      questions:
      - Can I patch a subscription list's name instead of using PUT?
      - Which PATCH call changes what a contact list is called?
      instructions:
      - text: PATCH subscription list {subscription_list_id} with the name {name}.
        slots:
          subscription_list_id: path.subscription_list_id
          name: requestBody.name
      - text: Patch contact list {subscription_list_id} so it's called {name}.
        slots:
          subscription_list_id: path.subscription_list_id
          name: requestBody.name
      method: generated
      generated: '2026-10-01'