# 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 Attendees API
  version: 1.0.0
extends: openapi/cvent-registration-attendees-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: 16
- target: $.paths['/ea/events/{eventId}/attendees'].get
  update:
    x-apievangelist-phrasing:
      intent: List the attendees of one event
      effect: read
      questions:
      - Who is registered for a specific event?
      - How do I page through one event's attendee list with a continuation token?
      instructions:
      - text: List the attendees of event {eventId}.
        slots:
          eventId: path.eventId
      - text: Show {limit} attendees of event {eventId}, continuing from token {token}.
        slots:
          limit: query.limit
          eventId: path.eventId
          token: query.token
      method: generated
      generated: '2026-10-01'
- target: $.paths['/ea/events/{eventId}/attendees'].post
  update:
    x-apievangelist-phrasing:
      intent: Register contacts as attendees of an event
      effect: write
      questions:
      - How do I register existing contacts into one specific event by its event ID?
      - Can I add attendees to an event through the event-scoped /ea path?
      instructions:
      - text: Register these contacts as attendees of event {eventId}.
        slots:
          eventId: path.eventId
      - text: Add attendees to event {eventId} via the /ea attendees path.
        slots:
          eventId: path.eventId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/ea/events/{eventId}/attendees/{attendeeId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one attendee of a specific event
      effect: read
      questions:
      - How do I look up an attendee within a particular event?
      - Has a given attendee of an event checked in yet?
      instructions:
      - text: Get attendee {attendeeId} of event {eventId}.
        slots:
          attendeeId: path.attendeeId
          eventId: path.eventId
      - text: Show the registration status and check-in of attendee {attendeeId} at event {eventId}.
        slots:
          attendeeId: path.attendeeId
          eventId: path.eventId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/ea/events/{eventId}/attendees/{attendeeId}'].put
  update:
    x-apievangelist-phrasing:
      intent: Cancel or modify an attendee within an event
      effect: write
      questions:
      - How do I cancel one attendee's registration within a specific event?
      - Can I mark an attendee of an event as checked in or change their attendance type?
      instructions:
      - text: Set the registration status of attendee {attendeeId} at event {eventId} to {registrationStatus}.
        slots:
          attendeeId: path.attendeeId
          eventId: path.eventId
          registrationStatus: requestBody.registrationStatus
      - text: 'Mark attendee {attendeeId} of event {eventId} as checked in: {checkedIn}.'
        slots:
          attendeeId: path.attendeeId
          eventId: path.eventId
          checkedIn: requestBody.checkedIn
      - text: Move attendee {attendeeId} at event {eventId} to admission item {admissionItemId}.
        slots:
          attendeeId: path.attendeeId
          eventId: path.eventId
          admissionItemId: requestBody.admissionItemId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/attendance-durations'].get
  update:
    x-apievangelist-phrasing:
      intent: List how long attendees engaged in sessions
      effect: read
      questions:
      - How long did attendees actually spend in sessions, appointments or videos?
      - Can I pull attendance durations recorded after a certain date?
      instructions:
      - text: List attendance durations recorded since {after}.
        slots:
          after: query.after
      - text: Show engagement durations for attendees 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 the attendee list include guests that were deleted?
      instructions:
      - text: List attendees modified after {after}.
        slots:
          after: query.after
      - text: Show attendees matching {filter}, sorted by {sort}.
        slots:
          filter: query.filter
          sort: query.sort
      method: generated
      generated: '2026-09-26'
- target: $.paths['/attendees'].post
  update:
    x-apievangelist-phrasing:
      intent: Invite or register contacts for an event
      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 invited attendees.
      - text: Register the given contacts straight into 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
      effect: read
      questions:
      - What if my attendee filter is too long to fit in a query string?
      - Can I search attendees by posting a filter in the request body?
      instructions:
      - text: Search attendees using the body filter {filter}.
        slots:
          filter: requestBody.filter
      - text: Run a long attendee filter {filter} in the request body and include 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's details
      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: 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 status or registration type?
      - Is it possible to add a note to an attendee record?
      instructions:
      - text: Set attendee {id}'s status to {status}.
        slots:
          id: path.id
          status: requestBody.status
      - text: Change attendee {id}'s registration type to {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 opt-out
      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: Opt attendee {id} out of emails for this event.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/attendees/{id}/internal-information-questions'].put
  update:
    x-apievangelist-phrasing:
      intent: Update internal information answers
      effect: write
      questions:
      - Can I record internal-only answers about an attendee that they never see?
      - Should I identify an internal information question by code or ID?
      instructions:
      - text: Set internal question {question} to {value} for attendee {id}.
        slots:
          question: requestBody.question
          value: requestBody.value
          id: path.id
      - text: Record staff-only answer {value} to internal question {question} on attendee {id}.
        slots:
          value: requestBody.value
          question: requestBody.question
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/events/{id}/badges'].get
  update:
    x-apievangelist-phrasing:
      intent: List third-party badge associations
      effect: read
      questions:
      - Which attendees have third-party badges linked for an event?
      - Can I filter badge associations with a short query filter?
      instructions:
      - text: List badge associations for event {id}.
        slots:
          id: path.id
      - text: Show event {id} attendee badges 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 link a third-party badge to an attendee?
      - What status and type are needed when creating an attendee badge?
      instructions:
      - text: Create badge {badgeId} of type {type} for attendee {attendee} in event {id}.
        slots:
          badgeId: requestBody.id
          type: requestBody.type
          attendee: requestBody.attendee
          id: path.id
      - text: Issue a new badge with status {status} 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 badges with a body filter
      effect: read
      questions:
      - Can I search an event's badges with a filter too long for the URL?
      - What's the way to query badges by posting a filter?
      instructions:
      - text: Search badges in event {id} using body filter {filter}.
        slots:
          id: path.id
          filter: requestBody.filter
      - text: Post a long badge filter {filter} for event {id} and return up to {limit}.
        slots:
          filter: requestBody.filter
          id: path.id
          limit: query.limit
      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 already exists?
      - 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} in event {id} to attendee {attendee}.
        slots:
          badgeId: path.badgeId
          id: path.id
          attendee: requestBody.attendee
      method: generated
      generated: '2026-09-26'