# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Talon One Audiences API
  version: 1.0.0
extends: openapi/talon-one-audiences-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: 11
- target: $.paths['/v2/audiences'].post
  update:
    x-apievangelist-phrasing:
      intent: Create an audience
      effect: write
      questions:
      - How do I create a customer audience I can target in promotion rules?
      - Can I link a new audience to an audience that already exists in a third-party platform?
      instructions:
      - text: Create an audience named {name}.
        slots:
          name: requestBody.name
      - text: Create audience {name} from integration {integration} with external ID {integrationId}.
        slots:
          name: requestBody.name
          integration: requestBody.integration
          integrationId: requestBody.integrationId
      - text: Create audience {name} available to applications {subscribedApplicationsIds}.
        slots:
          name: requestBody.name
          subscribedApplicationsIds: requestBody.subscribedApplicationsIds
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v2/audiences/{audienceId}'].put
  update:
    x-apievangelist-phrasing:
      intent: Rename an audience
      effect: write
      questions:
      - Can I rename an audience that a third-party integration created?
      - Does renaming an audience trigger the Rule Engine?
      instructions:
      - text: Rename audience {audienceId} to {name}.
        slots:
          audienceId: path.audienceId
          name: requestBody.name
      - text: Change the name of audience {audienceId} to {name} and subscribe applications {subscribedApplicationsIds}.
        slots:
          audienceId: path.audienceId
          name: requestBody.name
          subscribedApplicationsIds: requestBody.subscribedApplicationsIds
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v2/audiences/{audienceId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete an audience
      effect: destructive
      questions:
      - What happens to customer associations when I delete an audience?
      - How do I get rid of an audience entirely?
      instructions:
      - text: Delete audience {audienceId}.
        slots:
          audienceId: path.audienceId
      - text: Permanently remove audience {audienceId} and its profile associations.
        slots:
          audienceId: path.audienceId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v2/audiences/{audienceId}/memberships'].delete
  update:
    x-apievangelist-phrasing:
      intent: Remove every member from an audience
      effect: destructive
      questions:
      - Can I empty an audience without deleting the audience itself?
      - Is there a way to clear all members out of an audience at once?
      instructions:
      - text: Remove all members from audience {audienceId}.
        slots:
          audienceId: path.audienceId
      - text: Empty audience {audienceId} but keep the audience.
        slots:
          audienceId: path.audienceId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v2/customer_audiences'].post
  update:
    x-apievangelist-phrasing:
      intent: Add or remove customers from audiences in bulk
      effect: write
      questions:
      - How many add or remove audience actions can I send in one request?
      - Can I add several customer profiles to an audience in a single call?
      instructions:
      - text: 'Apply these audience add and remove actions: {data}.'
        slots:
          data: requestBody.data
      - text: Add or remove customer profiles in audiences according to {data}.
        slots:
          data: requestBody.data
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v2/audience_customers/{audienceId}/attributes'].put
  update:
    x-apievangelist-phrasing:
      intent: Set profile attributes for everyone in an audience
      effect: write
      questions:
      - Can I set the same profile attribute value for every customer in an audience?
      - Is there a bulk way to update attributes of all audience members?
      instructions:
      - text: Update profile attributes for all customers in audience {audienceId}.
        slots:
          audienceId: path.audienceId
      - text: Set the given attribute values on every member of audience {audienceId}.
        slots:
          audienceId: path.audienceId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/audiences'].get
  update:
    x-apievangelist-phrasing:
      intent: List the account's audiences
      effect: read
      questions:
      - Which audiences have been created in my account?
      - Can I get the total number of audiences along with the list?
      instructions:
      - text: List all audiences in my account.
      - text: 'Show audiences sorted by {sort}, including the total count: {withTotalResultSize}.'
        slots:
          sort: query.sort
          withTotalResultSize: query.withTotalResultSize
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/audiences/analytics'].get
  update:
    x-apievangelist-phrasing:
      intent: Get member counts for audiences
      effect: read
      questions:
      - How many members does each of my audiences have?
      - Can I compare member counts for a chosen set of audiences?
      instructions:
      - text: Show member counts for audiences {audienceIds}.
        slots:
          audienceIds: query.audienceIds
      - text: Get audience size analytics for {audienceIds}.
        slots:
          audienceIds: query.audienceIds
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/audiences/{audienceId}/memberships'].get
  update:
    x-apievangelist-phrasing:
      intent: List the customers in an audience
      effect: read
      questions:
      - Who is in a particular audience?
      - What's the maximum page size when listing an audience's members?
      instructions:
      - text: List the members of audience {audienceId}.
        slots:
          audienceId: path.audienceId
      - text: Find members of audience {audienceId} matching {profileQuery}.
        slots:
          audienceId: path.audienceId
          profileQuery: query.profileQuery
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/audiences/{audienceId}/memberships/import'].post
  update:
    x-apievangelist-phrasing:
      intent: Replace an audience's members from a CSV
      effect: write
      questions:
      - How do I upload a CSV of customer IDs into an audience?
      - Does importing audience members replace the existing members?
      instructions:
      - text: Import audience members from file {upFile} into audience {audienceId}.
        slots:
          upFile: requestBody.upFile
          audienceId: path.audienceId
      - text: Replace the members of audience {audienceId} with the profile IDs in CSV {upFile}.
        slots:
          audienceId: path.audienceId
          upFile: requestBody.upFile
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/audiences/{audienceId}/memberships/export'].get
  update:
    x-apievangelist-phrasing:
      intent: Export an audience's members to CSV
      effect: read
      questions:
      - Can I download an audience's member IDs as a CSV file?
      - What column does the audience member export contain?
      instructions:
      - text: Export the members of audience {audienceId} to CSV.
        slots:
          audienceId: path.audienceId
      - text: Download the profile integration IDs in audience {audienceId}.
        slots:
          audienceId: path.audienceId
      method: generated
      generated: '2026-09-26'