Cvent Event Cloud · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Cvent REST Audience Segments API

13 actions 13 updates phrasing extends openapi/cvent-event-cloud-audience-segments-api-openapi.yml

Generated by API Evangelist Written by API Evangelist tooling for Cvent Event Cloud's API. It is a proposal applied on top of the contract, not a document Cvent Event Cloud publishes.

View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 13

$.info

$.paths['/attendees/{attendeeId}/audience-segments'].get

$.paths['/attendees/{attendeeId}/audience-segments'].delete

$.paths['/attendees/{attendeeId}/audience-segments/filter'].post

$.paths['/audience-segments'].get

$.paths['/audience-segments'].post

$.paths['/audience-segments/filter'].post

$.paths['/audience-segments/{audienceSegmentId}'].get

$.paths['/audience-segments/{audienceSegmentId}'].put

$.paths['/audience-segments/{audienceSegmentId}'].delete

$.paths['/audience-segments/{audienceSegmentId}/attendees'].get

$.paths['/audience-segments/{audienceSegmentId}/attendees/{attendeeId}'].put

$.paths['/audience-segments/{audienceSegmentId}/attendees/{attendeeId}'].delete

OpenAPI Overlay

# 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-event-cloud-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 an attendee currently part of?
      - 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 if attendee {attendeeId} is in segment filter {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:
      - Can I pull an attendee out of every audience segment at once?
      - How do I clear all segment memberships for one attendee?
      instructions:
      - text: Remove attendee {attendeeId} from all audience segments.
        slots:
          attendeeId: path.attendeeId
      - text: Clear every audience 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 query an attendee's segment memberships with a filter in the request body?
      - Is there a POST lookup for the segments an attendee is associated with?
      instructions:
      - text: Search the segments of attendee {attendeeId} using body filter {filter}.
        slots:
          attendeeId: path.attendeeId
          filter: requestBody.filter
      - text: Post filter {filter} to find active segment associations 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 exist in my account?
      - Can I narrow the audience segments list to a single event?
      instructions:
      - text: List audience segments matching filter {filter}.
        slots:
          filter: query.filter
      - text: List audience segments for filter {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:
      - Can I create a new audience segment for an event, like VIPs or first-timers?
      - What is needed to set up an audience segment?
      instructions:
      - text: Create audience segment {name} in event {event}.
        slots:
          name: requestBody.name
          event: requestBody.event
      - text: Add a segment {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 body filter
      effect: read
      questions:
      - Can I search audience segments with a filter sent in the request body?
      - Which call lists account segments when my filter is too long for a URL?
      instructions:
      - text: Search audience segments using body filter {filter}.
        slots:
          filter: requestBody.filter
      - text: Search 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:
      - Can I view the name and description of one audience segment?
      - What event does a particular audience segment belong to?
      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:
      - Can I rename an audience segment?
      - How do I change the description of an existing segment?
      instructions:
      - text: Rename audience segment {audienceSegmentId} to {name} in event {event}.
        slots:
          audienceSegmentId: path.audienceSegmentId
          name: requestBody.name
          event: requestBody.event
      - text: Update segment {audienceSegmentId} 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:
      - Can I delete an audience segment I no longer need?
      - Is deleting a segment permanent?
      instructions:
      - text: Delete audience segment {audienceSegmentId}.
        slots:
          audienceSegmentId: path.audienceSegmentId
      - text: Remove the segment {audienceSegmentId}.
        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 given 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:
      - Can I put an attendee into a specific audience segment?
      - How do I tag an attendee as part of a segment?
      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:
      - Can I take an attendee out of just one audience segment?
      - How do I disassociate a single attendee from a particular segment?
      instructions:
      - text: Remove attendee {attendeeId} from audience segment {audienceSegmentId}.
        slots:
          attendeeId: path.attendeeId
          audienceSegmentId: path.audienceSegmentId
      - text: Disassociate attendee {attendeeId} from segment {audienceSegmentId} only.
        slots:
          attendeeId: path.attendeeId
          audienceSegmentId: path.audienceSegmentId
      method: generated
      generated: '2026-09-26'