# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Antavo Customer lists API
  version: 1.0.0
extends: openapi/antavo-customer-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: 9
- target: $.paths['/v1/bulk-operation/customer-list/{batch_id}/status/errors'].get
  update:
    x-apievangelist-phrasing:
      intent: List errors from a customer list operation
      effect: read
      questions:
      - Which customers failed to be added to or removed from a list?
      - Can I page through the errors of a list update batch?
      instructions:
      - text: List the errors from customer list batch {batch_id}.
        slots:
          batch_id: path.batch_id
      - text: Show {limit} failed list operations in batch {batch_id} from offset {offset}.
        slots:
          limit: query.limit
          batch_id: path.batch_id
          offset: query.offset
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/bulk-operation/customer-list/{batch_id}/status'].get
  update:
    x-apievangelist-phrasing:
      intent: Check a customer list operation's status
      effect: read
      questions:
      - Has my customer list update finished processing?
      - Can I track a bulk add or remove on a customer list?
      instructions:
      - text: Check the status of customer list batch {batch_id}.
        slots:
          batch_id: path.batch_id
      - text: Tell me if list operation batch {batch_id} is done.
        slots:
          batch_id: path.batch_id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/bulk-operation/customer-list/add/{customer_list_id}'].post
  update:
    x-apievangelist-phrasing:
      intent: Add customers to a list in bulk
      effect: write
      questions:
      - Can I add many customers to a customer list at once?
      - Is adding customers to a list processed asynchronously?
      instructions:
      - text: Add customers {customers} to customer list {customer_list_id}.
        slots:
          customers: requestBody.customers
          customer_list_id: path.customer_list_id
      - text: Bulk-add these customer IDs {customers} to list {customer_list_id}.
        slots:
          customers: requestBody.customers
          customer_list_id: path.customer_list_id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/bulk-operation/customer-list/remove/{customer_list_id}'].post
  update:
    x-apievangelist-phrasing:
      intent: Remove customers from a list in bulk
      effect: write
      questions:
      - Can I remove a batch of customers from a list?
      - Can I take many members off a segment in a single call?
      instructions:
      - text: Remove customers {customers} from customer list {customer_list_id}.
        slots:
          customers: requestBody.customers
          customer_list_id: path.customer_list_id
      - text: Take {customers} off list {customer_list_id} in bulk.
        slots:
          customers: requestBody.customers
          customer_list_id: path.customer_list_id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/entities/core/customer-list/{entity_id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a customer list
      effect: read
      questions:
      - What are the details of a specific customer list?
      - Can I look up one customer list by its ID?
      instructions:
      - text: Get customer list {entity_id}.
        slots:
          entity_id: path.entity_id
      - text: Show the name and status of customer list {entity_id}.
        slots:
          entity_id: path.entity_id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/entities/core/customer-list/{entity_id}'].post
  update:
    x-apievangelist-phrasing:
      intent: Update a customer list
      effect: write
      questions:
      - Can I rename a customer list or change its status?
      - Can I deactivate a list before archiving it?
      instructions:
      - text: Rename customer list {entity_id} to {name}.
        slots:
          entity_id: path.entity_id
          name: requestBody.name
      - text: Set customer list {entity_id}'s status to {status}.
        slots:
          entity_id: path.entity_id
          status: requestBody.status
      method: generated
      generated: '2026-10-01'
- target: $.paths['/entities/core/customer-list/{entity_id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Archive a customer list
      effect: destructive
      questions:
      - Can I archive a customer list I no longer use?
      - Can an archived customer list be restored?
      instructions:
      - text: Archive inactive customer list {entity_id}.
        slots:
          entity_id: path.entity_id
      - text: Permanently archive list {entity_id} and drop its members.
        slots:
          entity_id: path.entity_id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/entities/core/customer-list'].get
  update:
    x-apievangelist-phrasing:
      intent: List all customer lists
      effect: read
      questions:
      - Which customer lists exist in my program?
      - Where can I see every segment list that's been set up?
      instructions:
      - text: List all customer lists.
      - text: Show every available customer list.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/entities/core/customer-list'].put
  update:
    x-apievangelist-phrasing:
      intent: Create a customer list
      effect: write
      questions:
      - Can I create a new customer list for segmentation?
      - What do I need to start a fresh customer list?
      instructions:
      - text: Create a customer list named {name}.
        slots:
          name: requestBody.name
      - text: Set up a new list called {name}.
        slots:
          name: requestBody.name
      method: generated
      generated: '2026-10-01'