# 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 Attendees API
  version: 1.0.0
extends: openapi/cvent-event-cloud-attendees-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['/attendance-durations'].get
  update:
    x-apievangelist-phrasing:
      intent: List attendee engagement durations
      effect: read
      questions:
      - How long did attendees spend in each session, appointment or video?
      - Can I see virtual and in-person engagement time for attendees?
      instructions:
      - text: List attendance durations recorded after {after}.
        slots:
          after: query.after
      - text: Show how long attendees engaged in sessions and videos, matching {filter}.
        slots:
          filter: query.filter
      method: generated
      generated: '2026-09-26'
- target: $.paths['/attendees'].get
  update:
    x-apievangelist-phrasing:
      intent: List attendees in the account
      effect: read
      questions:
      - Who are the attendees across my Cvent account?
      - Can I include deleted guests when listing attendees?
      - Which attendees changed since yesterday?
      instructions:
      - text: List attendees updated after {after}.
        slots:
          after: query.after
      - text: Get attendees matching a short query-string filter {filter}.
        slots:
          filter: query.filter
      method: generated
      generated: '2026-09-26'
- target: $.paths['/attendees'].post
  update:
    x-apievangelist-phrasing:
      intent: Add contacts to an event as attendees
      effect: write
      questions:
      - How do I add existing contacts to an event as attendees?
      - Can I register contacts directly instead of just inviting them?
      instructions:
      - text: Add these contacts to the event as attendees.
      - text: Register my contact list directly into the event rather than sending invitations.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/attendees/filter'].post
  update:
    x-apievangelist-phrasing:
      intent: Search attendees with a long filter in the body
      effect: read
      questions:
      - My attendee filter is too long for the URL — how else can I query attendees?
      - Is there a way to send an attendee filter in the request body?
      instructions:
      - text: Search attendees by posting the long filter {filter} in the request body.
        slots:
          filter: requestBody.filter
      - text: Run body filter {filter} against attendees, including deleted guests {includeDeletedGuests}.
        slots:
          filter: requestBody.filter
          includeDeletedGuests: query.includeDeletedGuests
      method: generated
      generated: '2026-09-26'
- target: $.paths['/attendees/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one attendee
      effect: read
      questions:
      - What's the registration status of a specific attendee?
      - Can I expand related data when fetching a single attendee?
      instructions:
      - text: Get attendee {id}.
        slots:
          id: path.id
      - text: Fetch attendee {id} with {expand} expanded.
        slots:
          id: path.id
          expand: query.expand
      method: generated
      generated: '2026-09-26'
- target: $.paths['/attendees/{id}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update an attendee's registration
      effect: write
      questions:
      - How do I change an attendee's status or registration type?
      - Can I add a note to an attendee record and optionally send them an email?
      instructions:
      - text: Set attendee {id}'s status to {status}.
        slots:
          id: path.id
          status: requestBody.status
      - text: Change attendee {id} to registration type {registrationType}.
        slots:
          id: path.id
          registrationType: requestBody.registrationType
      method: generated
      generated: '2026-09-26'
- target: $.paths['/attendees/{id}/email-subscriptions'].put
  update:
    x-apievangelist-phrasing:
      intent: Change an attendee's email subscription
      effect: write
      questions:
      - How do I unsubscribe an attendee from an event's emails?
      - Can I resubscribe an attendee who opted out of event emails?
      instructions:
      - text: Set attendee {id}'s event email unsubscribed flag to {unsubscribed}.
        slots:
          id: path.id
          unsubscribed: requestBody.unsubscribed
      - text: Unsubscribe attendee {id} from this event's emails.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/attendees/{id}/internal-information-questions'].put
  update:
    x-apievangelist-phrasing:
      intent: Update an attendee's internal information answers
      effect: write
      questions:
      - How do I record planner-only internal information for an attendee?
      - Can I identify an internal question by its code instead of its ID?
      instructions:
      - text: Set internal information question {question} to {value} for attendee {id}.
        slots:
          question: requestBody.question
          value: requestBody.value
          id: path.id
      - text: Record internal answer {value} on attendee {id} for question {question}.
        slots:
          value: requestBody.value
          id: path.id
          question: requestBody.question
      method: generated
      generated: '2026-09-26'
- target: $.paths['/events/{id}/badges'].get
  update:
    x-apievangelist-phrasing:
      intent: List an event's third-party badge associations
      effect: read
      questions:
      - Which attendees have third-party badges associated for my event?
      - Can I filter an event's badges with a short query filter?
      instructions:
      - text: List the attendee badges for event {id}.
        slots:
          id: path.id
      - text: Show badges on event {id} matching query filter {filter}.
        slots:
          id: path.id
          filter: query.filter
      method: generated
      generated: '2026-09-26'
- target: $.paths['/events/{id}/badges'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a badge for an attendee
      effect: write
      questions:
      - How do I associate a third-party badge with an attendee?
      - Can I set a badge's type and status when creating it?
      instructions:
      - text: Create badge {badgeId} of type {type} for attendee {attendee} on event {id}.
        slots:
          badgeId: requestBody.id
          type: requestBody.type
          attendee: requestBody.attendee
          id: path.id
      - text: Issue a new {status} badge to attendee {attendee} at event {id}.
        slots:
          status: requestBody.status
          attendee: requestBody.attendee
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/events/{id}/badges/filter'].post
  update:
    x-apievangelist-phrasing:
      intent: Search an event's badges with a body filter
      effect: read
      questions:
      - My badge filter is too long for a query string — how can I send it?
      - Is there a POST search for event badges?
      instructions:
      - text: Search badges on event {id} using body filter {filter}.
        slots:
          id: path.id
          filter: requestBody.filter
      - text: Post the long badge filter {filter} for event {id}.
        slots:
          filter: requestBody.filter
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/events/{id}/badges/{badgeId}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update an attendee's badge
      effect: write
      questions:
      - Can I change the status of a badge that's already been issued?
      - How do I update an existing attendee badge's type?
      instructions:
      - text: Set badge {badgeId} on event {id} to status {status}.
        slots:
          badgeId: path.badgeId
          id: path.id
          status: requestBody.status
      - text: Change existing badge {badgeId} for attendee {attendee} at event {id} to type {type}.
        slots:
          badgeId: path.badgeId
          attendee: requestBody.attendee
          id: path.id
          type: requestBody.type
      method: generated
      generated: '2026-09-26'