# 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-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 active audience segments
      effect: read
      questions:
      - Which audience segments does a given attendee currently belong to?
      - Can I check if an attendee is in one specific segment?
      instructions:
      - text: List active audience segments for attendee {attendeeId}.
        slots:
          attendeeId: path.attendeeId
      - text: Check attendee {attendeeId}'s segments 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 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 memberships in one call?
      instructions:
      - text: Remove attendee {attendeeId} from all audience segments.
        slots:
          attendeeId: path.attendeeId
      - text: Clear every segment membership 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 find an attendee's active segments?
      - How do I query an attendee's segment associations with a complex filter?
      instructions:
      - text: Search attendee {attendeeId}'s segments using body filter {filter}.
        slots:
          attendeeId: path.attendeeId
          filter: requestBody.filter
      - text: Filter the active segments of attendee {attendeeId} by posting {filter}.
        slots:
          attendeeId: path.attendeeId
          filter: requestBody.filter
      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 exist for an event?
      - Is a filter required when listing audience segments?
      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 targeting attendees at an event?
      - Can I add a description to an audience segment?
      instructions:
      - text: Create audience segment {name} in event {event}.
        slots:
          name: requestBody.name
          event: requestBody.event
      - text: Create segment {name} for 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 body filter
      effect: read
      questions:
      - My audience segment filter is too long — can I send it in the request body?
      - Can I search segments across the account with a posted filter and sort order?
      instructions:
      - text: Search audience segments using body filter {filter}.
        slots:
          filter: requestBody.filter
      - text: Find segments matching posted 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:
      - How do I look up one audience segment's details?
      - What event and name does a given segment have?
      instructions:
      - text: Get audience segment {audienceSegmentId}.
        slots:
          audienceSegmentId: path.audienceSegmentId
      - text: Show details 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 audience segment?
      - Can I change the description on an existing segment?
      instructions:
      - text: Rename audience segment {audienceSegmentId} in event {event} to {name}.
        slots:
          audienceSegmentId: path.audienceSegmentId
          event: requestBody.event
          name: requestBody.name
      - text: Update the description of segment {audienceSegmentId} 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 need?
      - Can I permanently remove a segment from an event?
      instructions:
      - text: Delete audience segment {audienceSegmentId}.
        slots:
          audienceSegmentId: path.audienceSegmentId
      - text: Remove 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:
      - Who are the attendees in a particular audience segment?
      - Can I also see attendees who were removed from a segment?
      instructions:
      - text: List attendees in audience segment {audienceSegmentId}.
        slots:
          audienceSegmentId: path.audienceSegmentId
      - text: 'List attendees of segment {audienceSegmentId}, including disassociated ones: {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 a segment?
      - Can I put one attendee into a targeted audience group?
      instructions:
      - text: Add attendee {attendeeId} to audience segment {audienceSegmentId}.
        slots:
          attendeeId: path.attendeeId
          audienceSegmentId: path.audienceSegmentId
      - text: Associate attendee {attendeeId} with 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 segment
      effect: destructive
      questions:
      - How do I take an attendee out of just one audience segment?
      - Can I remove a single attendee from a segment and leave their other segments?
      instructions:
      - text: Remove attendee {attendeeId} from audience segment {audienceSegmentId}.
        slots:
          attendeeId: path.attendeeId
          audienceSegmentId: path.audienceSegmentId
      - text: Disassociate attendee {attendeeId} from only segment {audienceSegmentId}.
        slots:
          attendeeId: path.attendeeId
          audienceSegmentId: path.audienceSegmentId
      method: generated
      generated: '2026-09-26'