# 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-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 how long attendees engaged in sessions
      effect: read
      questions:
      - How long did attendees spend in sessions or watching videos?
      - Can I pull attendance durations for virtual and in-person sessions?
      instructions:
      - text: List attendance durations recorded after {after}.
        slots:
          after: query.after
      - text: Show time-in-session durations 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 is registered across my events?
      - Can I include deleted guests when listing attendees?
      - How do I list attendees updated since yesterday?
      instructions:
      - text: List attendees modified after {after}.
        slots:
          after: query.after
      - text: Show attendees matching {filter} using a query-string 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 register existing contacts for an event?
      - Can I invite contacts instead of registering them directly?
      instructions:
      - text: Add these contacts to the event as registered attendees.
      - text: Invite this list of contacts to the event as attendees.
      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; what can I use instead?
      - Can I send a complex attendee filter in a request body?
      instructions:
      - text: Search attendees with body filter {filter}.
        slots:
          filter: requestBody.filter
      - text: Run a long attendee filter {filter} and sort by {sort}.
        slots:
          filter: requestBody.filter
          sort: query.sort
      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 look up a single attendee by ID with expanded details?
      instructions:
      - text: Get attendee {id}.
        slots:
          id: path.id
      - text: Show 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:
      - Can I change an attendee's registration type after they've signed up?
      - Is it possible to update an attendee's status and 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 event emails?
      - Can I resubscribe an attendee who opted out of emails?
      instructions:
      - text: Unsubscribe attendee {id} from event emails.
        slots:
          id: path.id
      - text: Set attendee {id}'s email unsubscribed flag to {unsubscribed}.
        slots:
          id: path.id
          unsubscribed: requestBody.unsubscribed
      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 internal-only notes on an attendee?
      - Can I identify an internal information question by its code?
      instructions:
      - text: Set internal question {question} to {value} for attendee {id}.
        slots:
          question: requestBody.question
          value: requestBody.value
          id: path.id
      - text: Update attendee {id}'s internal information answer for {question}.
        slots:
          id: path.id
          question: requestBody.question
      method: generated
      generated: '2026-09-26'
- target: $.paths['/events/{id}/badges'].get
  update:
    x-apievangelist-phrasing:
      intent: List third-party badge associations for an event
      effect: read
      questions:
      - Which attendees have third-party badges linked at my event?
      - Can I filter badge associations with a short query-string filter?
      instructions:
      - text: List badge associations for event {id}.
        slots:
          id: path.id
      - text: Show event {id} badges matching {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 link a badge to an attendee at an event?
      - Can I set a badge type and status when creating it?
      instructions:
      - text: Create a {type} badge for attendee {attendee} at event {id}.
        slots:
          type: requestBody.type
          attendee: requestBody.attendee
          id: path.id
      - text: Issue badge {badgeId} with status {status} to attendee {attendee} in event {id}.
        slots:
          badgeId: requestBody.id
          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 event badges with a long filter
      effect: read
      questions:
      - What if my badge filter is too long for a query string?
      - Can I search badges by sending the filter in the request body?
      instructions:
      - text: Search badges in event {id} with body filter {filter}.
        slots:
          id: path.id
          filter: requestBody.filter
      - text: Run the long badge filter {filter} against 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 issued?
      - Is it possible to reassign an existing badge to another attendee?
      instructions:
      - text: Set badge {badgeId} in event {id} to status {status}.
        slots:
          badgeId: path.badgeId
          id: path.id
          status: requestBody.status
      - text: Reassign existing badge {badgeId} at event {id} to attendee {attendee}.
        slots:
          badgeId: path.badgeId
          id: path.id
          attendee: requestBody.attendee
      method: generated
      generated: '2026-09-26'