Cvent · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Cvent REST Events API

53 actions 53 updates phrasing extends openapi/cvent-events-api-openapi.yml
Generated by API Evangelist Written by API Evangelist tooling for Cvent's API. It is a proposal applied on top of the contract, not a document Cvent publishes.
View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 53 · first 16 shown; the file carries all of them

$.info
$.paths['/admission-items'].get
$.paths['/admission-items/filter'].post
$.paths['/event-questions'].get
$.paths['/event-questions/{questionId}/choices'].get
$.paths['/events'].get
$.paths['/events/async'].post
$.paths['/events/async/{eventCreationId}/status'].get
$.paths['/events/copy/{eventCopyId}/status'].get
$.paths['/events/emails'].post
$.paths['/events/emails/{emailRequestId}/status'].get
$.paths['/events/filter'].post
$.paths['/events/{id}'].get
$.paths['/events/{id}'].put
$.paths['/events/{id}/check-in'].post
$.paths['/events/{id}/check-in/{attendeeId}'].delete

OpenAPI Overlay

Raw ↑
# 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 Events API
  version: 1.0.0
extends: openapi/cvent-events-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: 52
- target: $.paths['/admission-items'].get
  update:
    x-apievangelist-phrasing:
      intent: List admission items across events
      effect: read
      questions:
      - What admission items are set up in my Cvent account?
      - Can I page through admission items with a short query-string filter?
      instructions:
      - text: List admission items using the filter {filter}.
        slots:
          filter: query.filter
      - text: Show the first {limit} admission items.
        slots:
          limit: query.limit
      method: generated
      generated: '2026-09-26'
- target: $.paths['/admission-items/filter'].post
  update:
    x-apievangelist-phrasing:
      intent: Filter admission items with a long body filter
      effect: read
      questions:
      - How can I query admission items when my filter is too long for the URL?
      - Is there a POST version of the admission item listing that accepts filters in the body?
      instructions:
      - text: Send the long admission item filter {filter} in the request body and return the matches.
        slots:
          filter: requestBody.filter
      - text: Post a body filter for admission items and return {limit} per page.
        slots:
          limit: query.limit
      method: generated
      generated: '2026-09-26'
- target: $.paths['/event-questions'].get
  update:
    x-apievangelist-phrasing:
      intent: List registration questions defined for events
      effect: read
      questions:
      - Which registration questions have been configured on my events?
      - Where can I see the event questions attendees answer at sign-up?
      instructions:
      - text: List event questions matching {filter}.
        slots:
          filter: query.filter
      - text: Pull every event question created after {after}.
        slots:
          after: query.after
      method: generated
      generated: '2026-09-26'
- target: $.paths['/event-questions/{questionId}/choices'].get
  update:
    x-apievangelist-phrasing:
      intent: Get the answer choices for an event question
      effect: read
      questions:
      - What answer options does a particular event question offer?
      - Can I see the choices on a multiple-choice registration question?
      instructions:
      - text: Show the choices for event question {questionId}.
        slots:
          questionId: path.questionId
      - text: List up to {limit} choices for question {questionId}.
        slots:
          limit: query.limit
          questionId: path.questionId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/events'].get
  update:
    x-apievangelist-phrasing:
      intent: List events
      effect: read
      questions:
      - What events do we have in Cvent?
      - Can I sort my event list and filter it by date?
      instructions:
      - text: List events sorted by {sort}.
        slots:
          sort: query.sort
      - text: Show events modified before {before} that match {filter}.
        slots:
          before: query.before
          filter: query.filter
      method: generated
      generated: '2026-09-26'
- target: $.paths['/events/async'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a new event asynchronously
      effect: write
      questions:
      - How do I create a brand-new event through the API?
      - What is required to set up a new event — title, format, timezone, planners?
      instructions:
      - text: Create an event titled {title} in timezone {timezone} with format {format}.
        slots:
          title: requestBody.title
          timezone: requestBody.timezone
          format: requestBody.format
      - text: Start creating event {title} of type {type} planned by {planners}.
        slots:
          title: requestBody.title
          type: requestBody.type
          planners: requestBody.planners
      method: generated
      generated: '2026-09-26'
- target: $.paths['/events/async/{eventCreationId}/status'].get
  update:
    x-apievangelist-phrasing:
      intent: Check whether an async event creation finished
      effect: read
      questions:
      - Is the event I asked Cvent to create ready yet?
      - How do I track the progress of an asynchronous event creation?
      instructions:
      - text: Check the creation status for event creation job {eventCreationId}.
        slots:
          eventCreationId: path.eventCreationId
      - text: Tell me if event creation {eventCreationId} has completed.
        slots:
          eventCreationId: path.eventCreationId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/events/copy/{eventCopyId}/status'].get
  update:
    x-apievangelist-phrasing:
      intent: Check the status of an event copy
      effect: read
      questions:
      - Has my event copy finished running?
      - Where do I see progress on copying an event?
      instructions:
      - text: Get the status of event copy {eventCopyId}.
        slots:
          eventCopyId: path.eventCopyId
      - text: Tell me whether copy job {eventCopyId} is done.
        slots:
          eventCopyId: path.eventCopyId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/events/emails'].post
  update:
    x-apievangelist-phrasing:
      intent: Send an event email to invited attendees
      effect: write
      questions:
      - How do I send an event email to specific attendees on the invitation list?
      - Can I resend an event email to people who already received it?
      instructions:
      - text: Send email {email} for event {event} to attendees {attendees}.
        slots:
          email: requestBody.email
          event: requestBody.event
          attendees: requestBody.attendees
      - text: 'Email attendees {attendees} of event {event} with {email}, resending to previous recipients: {resendToPreviousRecipients}.'
        slots:
          attendees: requestBody.attendees
          event: requestBody.event
          email: requestBody.email
          resendToPreviousRecipients: requestBody.resendToPreviousRecipients
      method: generated
      generated: '2026-09-26'
- target: $.paths['/events/emails/{emailRequestId}/status'].get
  update:
    x-apievangelist-phrasing:
      intent: Check delivery status of an event email send
      effect: read
      questions:
      - Did the email I sent to attendees go out?
      - How do I check the status of an event email request?
      instructions:
      - text: Get the status of email request {emailRequestId}.
        slots:
          emailRequestId: path.emailRequestId
      - text: Show delivery progress for attendee email send {emailRequestId}.
        slots:
          emailRequestId: path.emailRequestId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/events/filter'].post
  update:
    x-apievangelist-phrasing:
      intent: Filter events with a long body filter
      effect: read
      questions:
      - How do I search events with a filter too long for a query string?
      - Is there a POST endpoint to list events using a body filter?
      instructions:
      - text: Post the event filter {filter} in the body and list matching events.
        slots:
          filter: requestBody.filter
      - text: Find events with a body filter, sorted by {sort}.
        slots:
          sort: query.sort
      method: generated
      generated: '2026-09-26'
- target: $.paths['/events/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get an event's details
      effect: read
      questions:
      - What are the details of a specific event, like its dates and venue?
      - How do I look up a single event by its ID?
      instructions:
      - text: Get event {id}.
        slots:
          id: path.id
      - text: Show me the start, end and status of event {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/events/{id}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update an existing event's details
      effect: write
      questions:
      - How do I change the title or dates of an existing event?
      - Can I update an event's capacity or close date after it is created?
      instructions:
      - text: Rename event {id} to {title}.
        slots:
          id: path.id
          title: requestBody.title
      - text: Set the capacity of event {id} to {capacity}.
        slots:
          id: path.id
          capacity: requestBody.capacity
      method: generated
      generated: '2026-09-26'
- target: $.paths['/events/{id}/check-in'].post
  update:
    x-apievangelist-phrasing:
      intent: Check attendees in to an event
      effect: write
      questions:
      - How do I mark attendees as checked in at an event?
      - Can I check in several attendees to an event at once?
      instructions:
      - text: Check in the listed attendees to event {id}.
        slots:
          id: path.id
      - text: Record event check-in for attendees arriving at event {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/events/{id}/check-in/{attendeeId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Remove an attendee's event check-in
      effect: destructive
      questions:
      - How do I undo an attendee's check-in to an event?
      - Can I remove a check-in that was recorded by mistake at the event level?
      instructions:
      - text: Remove the check-in for attendee {attendeeId} at event {id}.
        slots:
          attendeeId: path.attendeeId
          id: path.id
      - text: Undo event {id} check-in of {attendeeId}.
        slots:
          id: path.id
          attendeeId: path.attendeeId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/events/{id}/copy'].post
  update:
    x-apievangelist-phrasing:
      intent: Copy an event's setup to a new or existing event
      effect: write
      questions:
      - How do I duplicate an event to reuse its setup?
      - Can I copy just the agenda and speakers from one event into another?
      instructions:
      - text: Copy event {id} into a new event.
        slots:
          id: path.id
      - text: Copy the agenda {agenda} and speakers {speakers} from event {id}.
        slots:
          agenda: requestBody.agenda
          speakers: requestBody.speakers
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/events/{id}/custom-fields/{customFieldId}/answers'].put
  update:
    x-apievangelist-phrasing:
      intent: Set an event's custom field answer
      effect: write
      questions:
      - How do I fill in a custom field like event region on an event?
      - Can I store extra information on an event through its custom fields?
      instructions:
      - text: Set custom field {customFieldId} on event {id} to {value}.
        slots:
          customFieldId: path.customFieldId
          id: path.id
          value: requestBody.value
      - text: Answer event {id} custom field {customFieldId} with value {value}.
        slots:
          id: path.id
          customFieldId: path.customFieldId
          value: requestBody.value
      method: generated
      generated: '2026-09-26'
- target: $.paths['/events/{id}/donation-items'].get
  update:
    x-apievangelist-phrasing:
      intent: List an event's donation items
      effect: read
      questions:
      - What donation items does this event offer?
      - Can I filter an event's donation options?
      instructions:
      - text: List donation items for event {id}.
        slots:
          id: path.id
      - text: Show donation items on event {id} matching {filter}.
        slots:
          id: path.id
          filter: query.filter
      method: generated
      generated: '2026-09-26'
- target: $.paths['/events/{id}/donation-items/filter'].post
  update:
    x-apievangelist-phrasing:
      intent: Filter an event's donation items in the body
      effect: read
      questions:
      - How do I query donation items with a long filter sent in the request body?
      - Is there a POST filter version of the event donation items list?
      instructions:
      - text: Post filter {filter} to find donation items for event {id}.
        slots:
          filter: requestBody.filter
          id: path.id
      - text: Body-filter event {id} donation items, {limit} per page.
        slots:
          id: path.id
          limit: query.limit
      method: generated
      generated: '2026-09-26'
- target: $.paths['/events/{id}/emails'].get
  update:
    x-apievangelist-phrasing:
      intent: List emails configured for an event
      effect: read
      questions:
      - Which emails are set up for my event, like invitations and reminders?
      - Can I see the list of event emails?
      instructions:
      - text: List the emails for event {id}.
        slots:
          id: path.id
      - text: Show event {id} emails matching {filter}.
        slots:
          id: path.id
          filter: query.filter
      method: generated
      generated: '2026-09-26'
- target: $.paths['/events/{id}/fee-items'].get
  update:
    x-apievangelist-phrasing:
      intent: List an event's fee items
      effect: read
      questions:
      - What fees are attached to this event?
      - Which fee items does an event charge?
      instructions:
      - text: List the fee items for event {id}.
        slots:
          id: path.id
      - text: Show fee items on event {id} filtered by {filter}.
        slots:
          id: path.id
          filter: query.filter
      method: generated
      generated: '2026-09-26'
- target: $.paths['/events/{id}/invitation-lists'].get
  update:
    x-apievangelist-phrasing:
      intent: List an event's invitation lists
      effect: read
      questions:
      - Which invitation lists are attached to an event?
      - Who has this event been sent to by invitation list?
      instructions:
      - text: List the invitation lists for event {id}.
        slots:
          id: path.id
      - text: Find event {id} invitation lists matching {filter}.
        slots:
          id: path.id
          filter: query.filter
      method: generated
      generated: '2026-09-26'
- target: $.paths['/events/{id}/membership-items'].get
  update:
    x-apievangelist-phrasing:
      intent: List an event's membership items
      effect: read
      questions:
      - What memberships can attendees buy during event registration?
      - Can I list the membership items on an event?
      instructions:
      - text: List membership items for event {id}.
        slots:
          id: path.id
      - text: Show event {id} membership items matching {filter}.
        slots:
          id: path.id
          filter: query.filter
      method: generated
      generated: '2026-09-26'
- target: $.paths['/events/{id}/membership-items/filter'].post
  update:
    x-apievangelist-phrasing:
      intent: Filter an event's membership items in the body
      effect: read
      questions:
      - How do I query membership items with a filter in the request body?
      - Is there a POST filter endpoint for event membership items?
      instructions:
      - text: Post filter {filter} to find membership items on event {id}.
        slots:
          filter: requestBody.filter
          id: path.id
      - text: Body-filter membership items for event {id}, {limit} at a time.
        slots:
          id: path.id
          limit: query.limit
      method: generated
      generated: '2026-09-26'
- target: $.paths['/events/{id}/orders'].get
  update:
    x-apievangelist-phrasing:
      intent: List orders placed for an event
      effect: read
      questions:
      - What registration orders have been placed for my event?
      - Can I include deleted orders when listing an event's orders?
      instructions:
      - text: List orders for event {id}.
        slots:
          id: path.id
      - text: 'Show event {id} orders including deleted ones: {deleted}.'
        slots:
          id: path.id
          deleted: query.deleted
      method: generated
      generated: '2026-09-26'
- target: $.paths['/events/{id}/orders/items'].get
  update:
    x-apievangelist-phrasing:
      intent: List order line items for an event
      effect: read
      questions:
      - Which individual items were purchased across an event's orders?
      - Can I see order line items for an event rather than whole orders?
      instructions:
      - text: List order items for event {id}.
        slots:
          id: path.id
      - text: Show event {id} order items matching {filter}.
        slots:
          id: path.id
          filter: query.filter
      method: generated
      generated: '2026-09-26'
- target: $.paths['/events/{id}/orders/{orderId}/items/{orderItemId}/discounts/{discountCode}'].put
  update:
    x-apievangelist-phrasing:
      intent: Apply a discount code to an order item
      effect: write
      questions:
      - How do I apply a discount code to one item on an attendee's order?
      - Can I assign a discount after an order has been placed?
      instructions:
      - text: Apply discount {discountCode} to item {orderItemId} on order {orderId} in event {id}.
        slots:
          discountCode: path.discountCode
          orderItemId: path.orderItemId
          orderId: path.orderId
          id: path.id
      - text: Assign code {discountCode} to order item {orderItemId} of order {orderId}, event {id}, quantity {amountOrdered}.
        slots:
          discountCode: path.discountCode
          orderItemId: path.orderItemId
          orderId: path.orderId
          id: path.id
          amountOrdered: requestBody.amountOrdered
      method: generated
      generated: '2026-09-26'
- target: $.paths['/events/{id}/planning-documents'].get
  update:
    x-apievangelist-phrasing:
      intent: List an event's planning documents
      effect: read
      questions:
      - What planning documents are stored for this event?
      - Where can I find contracts and files uploaded for event planning?
      instructions:
      - text: List planning documents for event {id}.
        slots:
          id: path.id
      - text: Show event {id} planning documents added after {after}.
        slots:
          id: path.id
          after: query.after
      method: generated
      generated: '2026-09-26'
- target: $.paths['/events/{id}/quantity-items'].get
  update:
    x-apievangelist-phrasing:
      intent: List an event's quantity items
      effect: read
      questions:
      - What quantity-based items, like extra tickets, does this event sell?
      - Can I list the quantity items on an event?
      instructions:
      - text: List quantity items for event {id}.
        slots:
          id: path.id
      - text: Show event {id} quantity items matching {filter}.
        slots:
          id: path.id
          filter: query.filter
      method: generated
      generated: '2026-09-26'
- target: $.paths['/events/{id}/quantity-items/filter'].post
  update:
    x-apievangelist-phrasing:
      intent: Filter an event's quantity items in the body
      effect: read
      questions:
      - How do I search quantity items with a filter sent in the body?
      - Is there a POST filter version of the quantity items list?
      instructions:
      - text: Post filter {filter} to find quantity items on event {id}.
        slots:
          filter: requestBody.filter
          id: path.id
      - text: Body-filter quantity items for event {id}, {limit} per page.
        slots:
          id: path.id
          limit: query.limit
      method: generated
      generated: '2026-09-26'
- target: $.paths['/events/{id}/registration-paths'].get
  update:
    x-apievangelist-phrasing:
      intent: List an event's registration paths
      effect: read
      questions:
      - What registration paths does my event have?
      - Can I get registration path names in a specific locale?
      instructions:
      - text: List registration paths for event {id}.
        slots:
          id: path.id
      - text: Show event {id} registration paths in locale {locale}.
        slots:
          id: path.id
          locale: query.locale
      method: generated
      generated: '2026-09-26'
- target: $.paths['/events/{id}/registration-types'].get
  update:
    x-apievangelist-phrasing:
      intent: List an event's registration types
      effect: read
      questions:
      - What registration types, like VIP or general, exist on an event?
      - Which attendee types can people register as for this event?
      instructions:
      - text: List registration types for event {id}.
        slots:
          id: path.id
      - text: Show up to {limit} registration types on event {id}.
        slots:
          limit: query.limit
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/events/{id}/registration-types/{registrationTypeId}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update an event registration type
      effect: write
      questions:
      - How do I close a registration type so no one else can sign up with it?
      - Can I change the capacity or name of a registration type?
      instructions:
      - text: 'Set registration type {registrationTypeId} on event {id} open for registration: {openForRegistration}.'
        slots:
          registrationTypeId: path.registrationTypeId
          id: path.id
          openForRegistration: requestBody.openForRegistration
      - text: Change the capacity of registration type {registrationTypeId} in event {id} to {capacity}.
        slots:
          registrationTypeId: path.registrationTypeId
          id: path.id
          capacity: requestBody.capacity
      method: generated
      generated: '2026-09-26'
- target: $.paths['/events/{id}/taxes'].get
  update:
    x-apievangelist-phrasing:
      intent: List taxes configured for an event
      effect: read
      questions:
      - What taxes are applied to items sold at my event?
      - Which tax settings does an event use for admission items and sessions?
      instructions:
      - text: List taxes for event {id}.
        slots:
          id: path.id
      - text: Show event {id} taxes matching {filter}.
        slots:
          id: path.id
          filter: query.filter
      method: generated
      generated: '2026-09-26'
- target: $.paths['/events/{id}/transactions'].get
  update:
    x-apievangelist-phrasing:
      intent: List payment transactions for an event
      effect: read
      questions:
      - What payments and refunds have been recorded for an event?
      - Can I see an event's transactions within a date range?
      instructions:
      - text: List transactions for event {id}.
        slots:
          id: path.id
      - text: Show event {id} transactions between {after} and {before}.
        slots:
          id: path.id
          after: query.after
          before: query.before
      method: generated
      generated: '2026-09-26'
- target: $.paths['/events/{id}/transactions'].post
  update:
    x-apievangelist-phrasing:
      intent: Record an offline charge or refund
      effect: write
      questions:
      - How do I record a check or cash payment made outside Cvent?
      - Can I log an offline refund against an event order, including partial payments?
      instructions:
      - text: Record an offline {paymentType} of {amount} by {paymentMethod} on {date} for event {id}.
        slots:
          paymentType: requestBody.paymentType
          amount: requestBody.amount
          paymentMethod: requestBody.paymentMethod
          date: requestBody.date
          id: path.id
      - text: Log offline refund {paymentType} paid by {paymentMethod} on {date} for orders {orders} in event {id}.
        slots:
          paymentType: requestBody.paymentType
          paymentMethod: requestBody.paymentMethod
          date: requestBody.date
          orders: requestBody.orders
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/events/{id}/transactions/items'].get
  update:
    x-apievangelist-phrasing:
      intent: List transaction line items for an event
      effect: read
      questions:
      - Which items did each transaction at an event cover?
      - Can I break an event's transactions down by line item?
      instructions:
      - text: List transaction items for event {id}.
        slots:
          id: path.id
      - text: Show event {id} transaction items matching {filter}.
        slots:
          id: path.id
          filter: query.filter
      method: generated
      generated: '2026-09-26'
- target: $.paths['/events/{id}/user-groups'].get
  update:
    x-apievangelist-phrasing:
      intent: List user groups with access to an event
      effect: read
      questions:
      - Which user groups can access this event?
      - What planner groups are associated with an event?
      instructions:
      - text: List user groups on event {id}.
        slots:
          id: path.id
      - text: Show the first {limit} user groups associated with event {id}.
        slots:
          limit: query.limit
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/events/{id}/user-groups/{userGroupId}'].put
  update:
    x-apievangelist-phrasing:
      intent: Add a user group to an event
      effect: write
      questions:
      - How do I give a user group access to an event?
      - Can I associate a planner team with a specific event?
      instructions:
      - text: Add user group {userGroupId} to event {id}.
        slots:
          userGroupId: path.userGroupId
          id: path.id
      - text: Associate group {userGroupId} with event {id}.
        slots:
          userGroupId: path.userGroupId
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/events/{id}/user-groups/{userGroupId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Remove a user group from an event
      effect: destructive
      questions:
      - How do I revoke a user group's access to an event?
      - Can I detach a planner group from an event?
      instructions:
      - text: Remove user group {userGroupId} from event {id}.
        slots:
          userGroupId: path.userGroupId
          id: path.id
      - text: Disassociate group {userGroupId} from event {id}.
        slots:
          userGroupId: path.userGroupId
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/events/{id}/vouchers'].get
  update:
    x-apievangelist-phrasing:
      intent: List vouchers set up for an event
      effect: read
      questions:
      - What vouchers exist for my event?
      - Can I sort an event's vouchers?
      instructions:
      - text: List vouchers for event {id}.
        slots:
          id: path.id
      - text: Show event {id} vouchers sorted by {sort}.
        slots:
          id: path.id
          sort: query.sort
      method: generated
      generated: '2026-09-26'
- target: $.paths['/events/{id}/vouchers/filter'].post
  update:
    x-apievangelist-phrasing:
      intent: Filter an event's vouchers in the body
      effect: read
      questions:
      - How do I search event vouchers with a filter sent in the request body?
      - Is there a POST filter version of the event voucher list?
      instructions:
      - text: Post filter {filter} to find vouchers on event {id}.
        slots:
          filter: requestBody.filter
          id: path.id
      - text: Body-filter event {id} vouchers, sorted by {sort}.
        slots:
          id: path.id
          sort: query.sort
      method: generated
      generated: '2026-09-26'
- target: $.paths['/events/{id}/vouchers/{voucherId}/attendees'].get
  update:
    x-apievangelist-phrasing:
      intent: List attendees who redeemed a voucher
      effect: read
      questions:
      - Who has redeemed a particular voucher at my event?
      - How many attendees used a given voucher?
      instructions:
      - text: List attendees who redeemed voucher {voucherId} for event {id}.
        slots:
          voucherId: path.voucherId
          id: path.id
      - text: Show redemptions of voucher {voucherId} in event {id}.
        slots:
          voucherId: path.voucherId
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/quantity-items/{quantityItemId}'].put
  update:
    x-apievangelist-phrasing:
      intent: Change an attendee's quantity item count
      effect: write
      questions:
      - How do I change how many of a quantity item an attendee registered for?
      - Can I update an attendee's quantity item and send them an email about it?
      instructions:
      - text: Set quantity item {quantityItemId} for attendee {attendee} to {updatedQuantity}.
        slots:
          quantityItemId: path.quantityItemId
          attendee: requestBody.attendee
          updatedQuantity: requestBody.updatedQuantity
      - text: 'Update attendee {attendee} to {updatedQuantity} of quantity item {quantityItemId} and email them: {sendEmail}.'
        slots:
          attendee: requestBody.attendee
          updatedQuantity: requestBody.updatedQuantity
          quantityItemId: path.quantityItemId
          sendEmail: requestBody.sendEmail
      method: generated
      generated: '2026-09-26'
- target: $.paths['/sessions/attendance'].get
  update:
    x-apievangelist-phrasing:
      intent: List session attendance records
      effect: read
      questions:
      - Who actually attended each session?
      - Can I pull session attendance for a date range?
      instructions:
      - text: List session attendance matching {filter}.
        slots:
          filter: query.filter
      - text: Show session attendance recorded after {after}.
        slots:
          after: query.after
      method: generated
      generated: '2026-09-26'
- target: $.paths['/sessions/enrollment'].get
  update:
    x-apievangelist-phrasing:
      intent: List attendees registered for sessions
      effect: read
      questions:
      - Which attendees are registered for each session?
      - Can I see session registrants filtered by session?
      instructions:
      - text: List session registrants matching {filter}.
        slots:
          filter: query.filter
      - text: Show session enrollments changed after {after}.
        slots:
          after: query.after
      method: generated
      generated: '2026-09-26'
- target: $.paths['/sessions/enrollment/filter'].post
  update:
    x-apievangelist-phrasing:
      intent: Filter session registrants with a body filter
      effect: read
      questions:
      - How do I query session registrants with a long filter in the request body?
      - Is there a POST filter version of the session enrollment list?
      instructions:
      - text: Post filter {filter} to find session registrants.
        slots:
          filter: requestBody.filter
      - text: Body-filter session enrollment, returning {limit} per page.
        slots:
          limit: query.limit
      method: generated
      generated: '2026-09-26'
- target: $.paths['/sessions/{id}/attendance/{attendeeId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete an attendee's session check-in
      effect: destructive
      questions:
      - How do I remove an attendee's attendance from a session?
      - Can I undo a session check-in recorded in error?
      instructions:
      - text: Delete session {id} attendance for attendee {attendeeId}.
        slots:
          id: path.id
          attendeeId: path.attendeeId
      - text: Remove {attendeeId}'s check-in from session {id}.
        slots:
          attendeeId: path.attendeeId
          id: path.id
      method: generated
      generated: '2026-09-26'


# --- truncated at 32 KB (34 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/cvent/refs/heads/main/overlays/cvent-events-api-phrasing-overlay.yaml