# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Cvent REST Audience Segments API
  version: 1.0.0
extends: openapi/cvent-registration-audience-segments-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: 12
- target: $.paths['/attendees/{attendeeId}/audience-segments'].get
  update:
    x-apievangelist-phrasing:
      intent: List an attendee's audience segments
      effect: read
      questions:
      - Which audience segments is a particular attendee currently in?
      - Can I check whether an attendee belongs to one specific segment?
      instructions:
      - text: List the active audience segments for attendee {attendeeId}.
        slots:
          attendeeId: path.attendeeId
      - text: Check attendee {attendeeId}'s segment memberships matching {filter}.
        slots:
          attendeeId: path.attendeeId
          filter: query.filter
      method: generated
      generated: '2026-09-26'
- target: $.paths['/attendees/{attendeeId}/audience-segments'].delete
  update:
    x-apievangelist-phrasing:
      intent: Remove an attendee from all audience segments
      effect: destructive
      questions:
      - How do I pull an attendee out of every audience segment at once?
      - Can I clear all of an attendee's segment associations in one call?
      instructions:
      - text: Remove attendee {attendeeId} from all audience segments.
        slots:
          attendeeId: path.attendeeId
      - text: Clear every segment association for attendee {attendeeId}.
        slots:
          attendeeId: path.attendeeId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/attendees/{attendeeId}/audience-segments/filter'].post
  update:
    x-apievangelist-phrasing:
      intent: Search an attendee's segments with a body filter
      effect: read
      questions:
      - Can I send a long filter in the body to check an attendee's segment memberships?
      - Is there a POST version of listing one attendee's audience segments?
      instructions:
      - text: Search attendee {attendeeId}'s audience segments with body filter {filter}.
        slots:
          attendeeId: path.attendeeId
          filter: requestBody.filter
      - text: Use a body filter {filter} to list segments for attendee {attendeeId}.
        slots:
          filter: requestBody.filter
          attendeeId: path.attendeeId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/audience-segments'].get
  update:
    x-apievangelist-phrasing:
      intent: List audience segments
      effect: read
      questions:
      - What audience segments have been set up in my account?
      - Can I narrow the audience segment list to one event?
      instructions:
      - text: List audience segments matching {filter}.
        slots:
          filter: query.filter
      - text: List audience segments matching {filter}, sorted by {sort}.
        slots:
          filter: query.filter
          sort: query.sort
      method: generated
      generated: '2026-09-26'
- target: $.paths['/audience-segments'].post
  update:
    x-apievangelist-phrasing:
      intent: Create an audience segment
      effect: write
      questions:
      - How do I create a new audience segment for an event?
      - Can I give an audience segment a description?
      instructions:
      - text: Create audience segment {name} in event {event}.
        slots:
          name: requestBody.name
          event: requestBody.event
      - text: Add a segment called {name} to event {event} described as {description}.
        slots:
          name: requestBody.name
          event: requestBody.event
          description: requestBody.description
      method: generated
      generated: '2026-09-26'
- target: $.paths['/audience-segments/filter'].post
  update:
    x-apievangelist-phrasing:
      intent: Search audience segments with a long filter
      effect: read
      questions:
      - My audience segment filter is too long for the URL; can I POST it?
      - Is there a body-filter search for account audience segments?
      instructions:
      - text: Search audience segments using body filter {filter}.
        slots:
          filter: requestBody.filter
      - text: Search audience segments with body filter {filter}, sorted by {sort}.
        slots:
          filter: requestBody.filter
          sort: query.sort
      method: generated
      generated: '2026-09-26'
- target: $.paths['/audience-segments/{audienceSegmentId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get an audience segment
      effect: read
      questions:
      - What are the details of one audience segment?
      - Which event does a given audience segment belong to?
      instructions:
      - text: Get audience segment {audienceSegmentId}.
        slots:
          audienceSegmentId: path.audienceSegmentId
      - text: Show the name and event of segment {audienceSegmentId}.
        slots:
          audienceSegmentId: path.audienceSegmentId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/audience-segments/{audienceSegmentId}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update an audience segment
      effect: write
      questions:
      - How do I rename an existing audience segment?
      - Can I change a segment's description after creating it?
      instructions:
      - text: Rename audience segment {audienceSegmentId} to {name}.
        slots:
          audienceSegmentId: path.audienceSegmentId
          name: requestBody.name
      - text: Update segment {audienceSegmentId}'s description to {description}.
        slots:
          audienceSegmentId: path.audienceSegmentId
          description: requestBody.description
      method: generated
      generated: '2026-09-26'
- target: $.paths['/audience-segments/{audienceSegmentId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete an audience segment
      effect: destructive
      questions:
      - How do I delete an audience segment I no longer use?
      - Can I remove a segment by its ID?
      instructions:
      - text: Delete audience segment {audienceSegmentId}.
        slots:
          audienceSegmentId: path.audienceSegmentId
      - text: Remove the segment {audienceSegmentId} permanently.
        slots:
          audienceSegmentId: path.audienceSegmentId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/audience-segments/{audienceSegmentId}/attendees'].get
  update:
    x-apievangelist-phrasing:
      intent: List attendees in an audience segment
      effect: read
      questions:
      - Which attendees are in a given audience segment?
      - Can I also see attendees who were removed from a segment?
      instructions:
      - text: List the attendees in segment {audienceSegmentId}.
        slots:
          audienceSegmentId: path.audienceSegmentId
      - text: List segment {audienceSegmentId} attendees with includeDisassociated set to {includeDisassociated}.
        slots:
          audienceSegmentId: path.audienceSegmentId
          includeDisassociated: query.includeDisassociated
      method: generated
      generated: '2026-09-26'
- target: $.paths['/audience-segments/{audienceSegmentId}/attendees/{attendeeId}'].put
  update:
    x-apievangelist-phrasing:
      intent: Add an attendee to an audience segment
      effect: write
      questions:
      - How do I add an attendee to an audience segment?
      - Can I put one attendee into a specific segment?
      instructions:
      - text: Add attendee {attendeeId} to segment {audienceSegmentId}.
        slots:
          attendeeId: path.attendeeId
          audienceSegmentId: path.audienceSegmentId
      - text: Associate attendee {attendeeId} with audience segment {audienceSegmentId}.
        slots:
          attendeeId: path.attendeeId
          audienceSegmentId: path.audienceSegmentId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/audience-segments/{audienceSegmentId}/attendees/{attendeeId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Remove an attendee from one audience segment
      effect: destructive
      questions:
      - How do I take an attendee out of just one segment?
      - Can I disassociate an attendee from a single segment and keep their others?
      instructions:
      - text: Remove attendee {attendeeId} from segment {audienceSegmentId}.
        slots:
          attendeeId: path.attendeeId
          audienceSegmentId: path.audienceSegmentId
      - text: Disassociate attendee {attendeeId} from audience segment {audienceSegmentId} only.
        slots:
          attendeeId: path.attendeeId
          audienceSegmentId: path.audienceSegmentId
      method: generated
      generated: '2026-09-26'