# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Cvent Registration Events API
  version: 1.0.0
extends: openapi/cvent-registration-events-api-openapi.yml
actions:
- target: $.info
  update:
    x-apievangelist-phrasing:
      method: generated
      generated: '2026-10-01'
      generator: build-phrasing.py
      label: Generated by API Evangelist
      operations: 58
- target: $.paths['/ea/events'].get
  update:
    x-apievangelist-phrasing:
      intent: List events through the /ea events endpoint
      effect: read
      questions:
      - How do I page through events on the /ea/events endpoint with a continuation token?
      - Can I narrow the /ea event list with an RSQL-style filter expression?
      instructions:
      - text: List events from /ea/events, {limit} per page.
        slots:
          limit: query.limit
      - text: Get the next page of /ea events using continuation token {token}.
        slots:
          token: query.token
      - text: List /ea events matching the RSQL filter {filter}.
        slots:
          filter: query.filter
      method: generated
      generated: '2026-10-01'
- target: $.paths['/ea/events'].post
  update:
    x-apievangelist-phrasing:
      intent: Create an event through the /ea endpoint
      effect: write
      questions:
      - What does it take to create an event synchronously on the /ea/events endpoint?
      - Can I set an event code, currency and locale when creating an event through /ea?
      instructions:
      - text: Create an /ea event with code {code} titled {title}.
        slots:
          code: requestBody.code
          title: requestBody.title
      - text: Create an /ea event running {start} to {end} in timezone {timezone}, priced in {currency}.
        slots:
          start: requestBody.start
          end: requestBody.end
          timezone: requestBody.timezone
          currency: requestBody.currency
      method: generated
      generated: '2026-10-01'
- target: $.paths['/ea/events/{eventId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get an event from the /ea endpoint
      effect: read
      questions:
      - How do I read a single event's record from /ea/events by its event ID?
      - Which event code, currency and locale does an /ea event record carry?
      instructions:
      - text: Get /ea event {eventId}.
        slots:
          eventId: path.eventId
      - text: Show the code, currency and locale of /ea event {eventId}.
        slots:
          eventId: path.eventId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/ea/events/{eventId}'].put
  update:
    x-apievangelist-phrasing:
      intent: Replace an event through the /ea endpoint
      effect: write
      questions:
      - How do I overwrite a whole event record on the /ea/events endpoint?
      - Can I change an event's locale or event URL when replacing it through /ea?
      instructions:
      - text: Replace /ea event {eventId} with title {title} and status {status}.
        slots:
          eventId: path.eventId
          title: requestBody.title
          status: requestBody.status
      - text: Replace /ea event {eventId}, setting its locale to {locale} and its URL to {eventUrl}.
        slots:
          eventId: path.eventId
          locale: requestBody.locale
          eventUrl: requestBody.eventUrl
      method: generated
      generated: '2026-10-01'
- target: $.paths['/ea/events/{eventId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete an event through the /ea endpoint
      effect: destructive
      questions:
      - How do I remove an event entirely using the /ea/events endpoint?
      - Is deleting an event on /ea something I can undo afterwards?
      instructions:
      - text: Delete /ea event {eventId}.
        slots:
          eventId: path.eventId
      - text: Permanently remove event {eventId} via the /ea events endpoint.
        slots:
          eventId: path.eventId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/ea/events/{eventId}/copy'].post
  update:
    x-apievangelist-phrasing:
      intent: Copy an event through the /ea endpoint
      effect: write
      questions:
      - How do I duplicate an event using the /ea copy endpoint?
      - Does the /ea event copy call need anything besides the source event ID?
      instructions:
      - text: Copy /ea event {eventId}.
        slots:
          eventId: path.eventId
      - text: Make a duplicate of event {eventId} through the /ea copy endpoint.
        slots:
          eventId: path.eventId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/admission-items'].get
  update:
    x-apievangelist-phrasing:
      intent: List admission items
      effect: read
      questions:
      - How do I see the admission items (ticket types) set up across my Cvent events?
      - Can I filter admission items with a short query-string filter and page through them?
      instructions:
      - text: List my admission items.
      - text: List admission items matching the query filter {filter}.
        slots:
          filter: query.filter
      method: generated
      generated: '2026-09-26'
- target: $.paths['/admission-items/filter'].post
  update:
    x-apievangelist-phrasing:
      intent: Filter admission items with a body filter
      effect: read
      questions:
      - My admission item filter is too long for the URL; can I send it in the request body instead?
      - Which endpoint lets me search admission items using a lengthy filter expression in a POST body?
      instructions:
      - text: Search admission items by posting the long filter {filter} in the request body.
        slots:
          filter: requestBody.filter
      - text: Return the first {limit} admission items matching body filter {filter}.
        slots:
          limit: query.limit
          filter: requestBody.filter
      method: generated
      generated: '2026-09-26'
- target: $.paths['/event-questions'].get
  update:
    x-apievangelist-phrasing:
      intent: List event registration questions
      effect: read
      questions:
      - What registration questions are configured on my events?
      - Is there a way to page through all event questions across the account?
      instructions:
      - text: List all event questions.
      - text: List event questions matching {filter}.
        slots:
          filter: query.filter
      method: generated
      generated: '2026-09-26'
- target: $.paths['/event-questions/{questionId}/choices'].get
  update:
    x-apievangelist-phrasing:
      intent: List the answer choices for an event question
      effect: read
      questions:
      - What answer options does a multiple-choice event question offer?
      - Can I retrieve every choice defined for one registration question?
      instructions:
      - text: Show the answer 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:
      - How do I pull a list of all the events in my Cvent account?
      - Can I sort my event list and filter it by a short query filter?
      - Which events were modified after a certain date?
      instructions:
      - text: List my events.
      - text: List events changed after {after}, sorted by {sort}.
        slots:
          after: query.after
          sort: query.sort
      method: generated
      generated: '2026-09-26'
- target: $.paths['/events/async'].post
  update:
    x-apievangelist-phrasing:
      intent: Create an event asynchronously
      effect: write
      questions:
      - How do I create a brand-new event through the API?
      - What details are required when creating an event, like format, timezone, languages and planners?
      - Why does event creation return an ID I have to poll before the event is ready?
      instructions:
      - text: Create a new event titled {title} in timezone {timezone}.
        slots:
          title: requestBody.title
          timezone: requestBody.timezone
      - text: Create a {format} event called {title} starting {start} and ending {end}.
        slots:
          format: requestBody.format
          title: requestBody.title
          start: requestBody.start
          end: requestBody.end
      method: generated
      generated: '2026-09-26'
- target: $.paths['/events/async/{eventCreationId}/status'].get
  update:
    x-apievangelist-phrasing:
      intent: Check whether an event creation finished
      effect: read
      questions:
      - Is the event I just created asynchronously ready to use yet?
      - Where do I check the progress of an async event creation request?
      instructions:
      - text: Check the creation status of event request {eventCreationId}.
        slots:
          eventCreationId: path.eventCreationId
      - text: Tell me if async 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 processing?
      - How can I track progress after copying an event?
      instructions:
      - text: Check 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: 'Send email {email} for event {event} to {attendees}, resend to prior recipients: {resendToPreviousRecipients}.'
        slots:
          email: requestBody.email
          event: requestBody.event
          attendees: requestBody.attendees
          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 attendee email I sent go out successfully?
      - How do I look up the status of an email send using its request ID?
      instructions:
      - text: Get the status of email request {emailRequestId}.
        slots:
          emailRequestId: path.emailRequestId
      - text: Check whether email send {emailRequestId} was delivered.
        slots:
          emailRequestId: path.emailRequestId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/events/filter'].post
  update:
    x-apievangelist-phrasing:
      intent: Filter events with a body filter
      effect: read
      questions:
      - My event filter is too long for a query string; can I POST it in the body?
      - Is there a POST version of the event list that accepts lengthy filter expressions?
      instructions:
      - text: Search events by posting the long filter {filter} in the request body.
        slots:
          filter: requestBody.filter
      - text: Find events matching body filter {filter}, sorted by {sort}.
        slots:
          filter: requestBody.filter
          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:
      - How do I fetch the full details of one event by its ID?
      - What timezone, dates and status does a specific event have?
      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 event's details
      effect: write
      questions:
      - How do I change the title, dates or capacity of an existing event?
      - Can I update an event's description or venue after it's been 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
      - text: Move event {id} to start {start} and end {end}.
        slots:
          id: path.id
          start: requestBody.start
          end: requestBody.end
      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 the event?
      - Can I check in several attendees to an event in one call?
      instructions:
      - text: Check in attendees to event {id}.
        slots:
          id: path.id
      - text: Record event check-in for the attendees I list 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?
      - Someone was checked in to the event by mistake; can I remove it?
      instructions:
      - text: Remove the event check-in for attendee {attendeeId} at event {id}.
        slots:
          attendeeId: path.attendeeId
          id: path.id
      - text: Undo check-in of {attendeeId} for event {id}.
        slots:
          attendeeId: path.attendeeId
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/events/{id}/copy'].post
  update:
    x-apievangelist-phrasing:
      intent: Copy an event
      effect: write
      questions:
      - How do I duplicate an existing event including its registration and agenda?
      - Can I copy speakers, surveys and exhibitors from one event into another existing event?
      instructions:
      - text: Copy event {id} into a new event.
        slots:
          id: path.id
      - text: Copy event {id} including registration settings {registration} and agenda {agenda}.
        slots:
          id: path.id
          registration: requestBody.registration
          agenda: requestBody.agenda
      method: generated
      generated: '2026-09-26'
- target: $.paths['/events/{id}/custom-fields/{customFieldId}/answers'].put
  update:
    x-apievangelist-phrasing:
      intent: Answer a custom field on an event
      effect: write
      questions:
      - How do I set an event-level custom field like event region or event type?
      - Can I store extra metadata 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}'s custom field {customFieldId} with {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 options can registrants choose at my event?
      - Can I filter an event's donation items with a query filter?
      instructions:
      - text: List donation items for event {id}.
        slots:
          id: path.id
      - text: List donation items for 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 with a body filter
      effect: read
      questions:
      - Can I send a long donation-item filter in the request body instead of the URL?
      - Which endpoint searches an event's donation items with a POSTed filter?
      instructions:
      - text: Search donation items for event {id} using body filter {filter}.
        slots:
          id: path.id
          filter: requestBody.filter
      - text: POST the long filter {filter} to find donation items in event {id}.
        slots:
          filter: requestBody.filter
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/events/{id}/emails'].get
  update:
    x-apievangelist-phrasing:
      intent: List an event's emails
      effect: read
      questions:
      - Which emails are configured for my event, like invitations and confirmations?
      - How do I get the email IDs I need before sending an event email?
      instructions:
      - text: List the emails set up for event {id}.
        slots:
          id: path.id
      - text: List emails in event {id} 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 my event?
      - Can I see all fee items associated with a single event?
      instructions:
      - text: List fee items for event {id}.
        slots:
          id: path.id
      - text: Show fee items in event {id} that match {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 my event?
      - How do I find the invitation lists used to invite people to an event?
      instructions:
      - text: List invitation lists for event {id}.
        slots:
          id: path.id
      - text: Show invitation lists on event {id} 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 registration for my event?
      - Can I filter an event's membership items using a query-string filter?
      instructions:
      - text: List membership items for event {id}.
        slots:
          id: path.id
      - text: List membership items in event {id} 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 membership items with a body filter
      effect: read
      questions:
      - Can I POST a lengthy filter to search an event's membership items?
      - Is there a body-filter variant for listing membership items?
      instructions:
      - text: Search membership items in event {id} using body filter {filter}.
        slots:
          id: path.id
          filter: requestBody.filter
      - text: POST filter {filter} to find membership items for event {id}.
        slots:
          filter: requestBody.filter
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/events/{id}/orders'].get
  update:
    x-apievangelist-phrasing:
      intent: List orders placed in an event
      effect: read
      questions:
      - How do I see all registration orders for one event?
      - Can I include deleted orders when listing an event's orders?
      instructions:
      - text: List orders for event {id}.
        slots:
          id: path.id
      - text: 'List orders in event {id}, 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 in an event
      effect: read
      questions:
      - What individual items were ordered across an event's registrations?
      - Can I list an event's order line items modified since a given date?
      instructions:
      - text: List order items for event {id}.
        slots:
          id: path.id
      - text: List order items in event {id} changed after {after}.
        slots:
          id: path.id
          after: query.after
      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 something an attendee already ordered?
      - Can I assign a discount to a specific order line item after registration?
      instructions:
      - text: Apply discount code {discountCode} to item {orderItemId} of order {orderId} in event {id}.
        slots:
          discountCode: path.discountCode
          orderItemId: path.orderItemId
          orderId: path.orderId
          id: path.id
      - text: Assign discount {discountCode} to order item {orderItemId} (order {orderId}, event {id}) for 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:
      - Where can I find the planning documents attached to an event?
      - Can I list event planning documents uploaded after a certain date?
      instructions:
      - text: List planning documents for event {id}.
        slots:
          id: path.id
      - text: List planning documents in event {id} 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:
      - Which optional items in my event let attendees choose a quantity?
      - Can I filter an event's quantity items using a URL filter?
      instructions:
      - text: List quantity items for event {id}.
        slots:
          id: path.id
      - text: List quantity items in event {id} 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 quantity items with a body filter
      effect: read
      questions:
      - Is there a POST variant for searching quantity items with a long filter?
      - Can I send my quantity-item filter in the request body?
      instructions:
      - text: Search quantity items in event {id} using body filter {filter}.
        slots:
          id: path.id
          filter: requestBody.filter
      - text: POST filter {filter} to find event {id}'s quantity items.
        slots:
          filter: requestBody.filter
          id: path.id
      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 offer?
      - Can I get registration path names in a particular locale?
      instructions:
      - text: List registration paths for event {id}.
        slots:
          id: path.id
      - text: List registration paths for event {id} 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 attendee or VIP, are defined for my event?
      - How do I get the registration type IDs for an event?
      instructions:
      - text: List registration types for event {id}.
        slots:
          id: path.id
      - text: Show the first {limit} registration types in 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 or reopen a registration type for new registrations?
      - Can I change the capacity or automatic open and end dates of a registration type?
      instructions:
      - text: 'Set registration type {registrationTypeId} in 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 an event's taxes
      effect: read
      questions:
      - What taxes are applied to admission items and sessions in my event?
      - How do I see an event's tax configuration?
      instructions:
      - text: List taxes for event {id}.
        slots:
          id: path.id
      - text: Show taxes in event {id} 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 in an event
      effect: read
      questions:
      - How do I pull all payment transactions recorded for an event?
      - Can I list an event's transactions made before a certain date?
      instructions:
      - text: List transactions for event {id}.
        slots:
          id: path.id
      - text: List transactions in event {id} before {before}.
        slots:
          id: path.id
          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 payment an attendee made by check outside Cvent?
      - Can I log an offline refund against an event order?
      - Is partial payment allowed when recording an offline transaction?
      instructions:
      - text: Record an offline {paymentType} of {amount} paid by {paymentMethod} on {date} in event {id}.
        slots:
          paymentType: requestBody.paymentType
          amount: requestBody.amount
          paymentMethod: requestBody.paymentMethod
          date: requestBody.date
          id: path.id
      - text: Log an offline refund of {amount} for event {id} with reference {referenceNumber}.
        slots:
          amount: requestBody.amount
          id: path.id
          referenceNumber: requestBody.referenceNumber
      method: generated
      generated: '2026-09-26'
- target: $.paths['/events/{id}/transactions/items'].get
  update:
    x-apievangelist-phrasing:
      intent: List transaction line items in an event
      effect: read
      questions:
      - Which items does each payment transaction in my event cover?
      - Can I see transaction-level line items for an event?
      instructions:
      - text: List transaction items for event {id}.
        slots:
          id: path.id
      - text: List transaction items in event {id} 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 are associated with my event?
      - How do I check which teams have access to an event?
      instructions:
      - text: List user groups on event {id}.
        slots:
          id: path.id
      - text: Show which user groups are associated with event {id}.
        slots:
          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 a specific event?
      - Can I associate an account user group with an 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 take a user group off an event?
      - Can I revoke a team's association with a particular 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 an event's vouchers
      effect: read
      questions:
      - What vouchers are set up for my event?
      - Can I sort and filter event vouchers with query parameters?
      instructions:
      - text: List vouchers for event {id}.
        slots:
          id: path.id
      - text: List vouchers in event {id} 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 with a body filter
      effect: read
      questions:
      - Can I search event vouchers by sending a long filter in the POST body?
      - Is there a body-filter version of the event voucher list?
      instructions:
      - text: Search vouchers in event {id} using body filter {filter}.
        slots:
          id: path.id
          filter: requestBody.filter
      - text: POST filter {filter} to find vouchers for event {id}.
        slots:
          filter: requestBody.filter
          id: path.id
      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} in event {id}.
        slots:
          voucherId: path.voucherId
          id: path.id
      - text: Show redemptions of voucher {voucherId} for 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 amount
      effect: write
      questions:
      - How do I change how many of a quantity item an attendee has registered for?
      - Can I update an attendee's quantity item and optionally send them an email?
      instructions:
      - text: Set attendee {attendee}'s quantity of item {quantityItemId} to {updatedQuantity}.
        slots:
          attendee: requestBody.attendee
          quantityItemId: path.quantityItemId
          updatedQuantity: requestBody.updatedQuantity
      - text: 'Update quantity item {quantityItemId} to {updatedQuantity} for {attendee} and email them: {sendEmail}.'
        slots:
          quantityItemId: path.quantityItemId
          updatedQuantity: requestBody.updatedQuantity
          attendee: requestBody.attendee
          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 my sessions?
      - Can I pull session attendance records updated since a certain time?
      instructions:
      - text: List session attendance records.
      - text: List session attendance matching {filter}.
        slots:
          filter: query.filter
      method: generated
      generated: '2026-09-26'
- target: $.paths['/sessions/enrollment'].get
  update:
    x-apievangelist-phrasing:
      intent: List session registrants
      effect: read
      questions:
      - Which attendees are registered for my optional sessions?
      - Can I see no-shows for included sessions?
      instructions:
      - text: List session registrants.
      - text: List session registrants matching query filter {filter}.
        slots:
          filter: query.filter
      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:
      - Can I search session registrants with a long filter in the request body?
      - Is there a POST variant for listing session enrollment?
      instructions:
      - text: Search session registrants using body filter {filter}.
        slots:
          filter: requestBody.filter
      - text: POST filter {filter} to list up to {limit} session registrants.
        slots:
          filter: requestBody.filter
          limit: query.limit
      method: generated
      generated: '2026-09-26'
- target: $.paths['/sessions/{id}/attendance/{attendeeId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Remove an attendee's session check-in
      effect: destructive
      questions:
      - How do I undo a session check-in for one attendee?
      - Someone was marked present at a session by mistake; can I delete that attendance?
      instructions:
      - text: Delete session {id} attendance for attendee {attendeeId}.
        slots:
          id: path.id
          attendeeId: path.attendeeId
      - text: Undo {attendeeId}'s check-in to session {id}.
        slots:
          attendeeId: path.attendeeId
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/sessions/{id}/check-in'].put
  update:
    x-apievangelist-phrasing:
      intent: Update session check-in details
      effect: write
      questions:
      - How do I correct check-in details for attendees already checked in to a session?
      - Can I edit existing session check-in records in bulk?
      instructions:
      - text: Update the check-in details for attendees in session {id}.
        slots:
          id: path.id
      - text: Correct existing session {id} check-ins for the attendees I list.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/sessions/{id}/check-in'].post
  update:
    x-apievangelist-phrasing:
      intent: Check attendees in to a session
      effect: write
      questions:
      - How do I check attendees in to a specific session?
      - Can I record session check-ins for several attendees at once?
      instructions:
      - text: Check in attendees to session {id}.
        slots:
          id: path.id
      - text: Record new check-ins at session {id} for the attendees I provide.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/sessions/{id}/enrollment/{attendeeId}'].post
  update:
    x-apievangelist-phrasing:
      intent: Register an attendee for a session
      effect: write
      questions:
      - How do I sign an attendee up for a session?
      - What does registering someone for a session require on the registration path?
      instructions:
      - text: Register attendee {attendeeId} for session {id}.
        slots:
          attendeeId: path.attendeeId
          id: path.id
      - text: Enroll {attendeeId} in session {id}.
        slots:
          attendeeId: path.attendeeId
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/sessions/{id}/enrollment/{attendeeId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Unregister an attendee from a session
      effect: destructive
      questions:
      - How do I remove an attendee's registration for a session?
      - Can I drop someone from a session they signed up for?
      instructions:
      - text: Unregister attendee {attendeeId} from session {id}.
        slots:
          attendeeId: path.attendeeId
          id: path.id
      - text: Drop {attendeeId}'s enrollment in session {id}.
        slots:
          attendeeId: path.attendeeId
          id: path.id
      method: generated
      generated: '2026-09-26'