Zoom · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Zoom / Account Meeting Registrants API

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

What the actions change

x-apievangelist-phrasing

Targets 5

$.info
$.paths['/meetings/{meetingId}/registrants'].get
$.paths['/meetings/{meetingId}/registrants'].post
$.paths['/meetings/{meetingId}/registrants/status'].put
$.paths['/meetings/{meetingId}/batch_registrants'].post

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 Zoom / Account Meeting Registrants API
  version: 1.0.0
extends: openapi/zoom-meeting-registrants-api-openapi.yml
actions:
- target: $.info
  update:
    x-apievangelist-phrasing:
      method: generated
      generated: '2026-09-24'
      generator: build-phrasing.py
      label: Generated by API Evangelist
      operations: 4
- target: $.paths['/meetings/{meetingId}/registrants'].get
  update:
    x-apievangelist-phrasing:
      intent: List a meeting's registrants
      effect: read
      questions:
      - Who has registered for my meeting so far?
      - Can I see only the registrants still pending approval?
      - Can I list registrants for one occurrence of a recurring meeting?
      instructions:
      - text: List the registrants for meeting {meetingId}.
        slots:
          meetingId: path.meetingId
      - text: List {status} registrants on meeting {meetingId}.
        slots:
          status: query.status
          meetingId: path.meetingId
      - text: Show who registered for occurrence {occurrence_id} of meeting {meetingId}.
        slots:
          occurrence_id: query.occurrence_id
          meetingId: path.meetingId
      method: generated
      generated: '2026-09-24'
- target: $.paths['/meetings/{meetingId}/registrants'].post
  update:
    x-apievangelist-phrasing:
      intent: Register one participant for a meeting
      effect: write
      questions:
      - How can a host register someone else for a meeting?
      - Can I auto-approve a registrant I'm adding myself?
      instructions:
      - text: Register {first_name} {last_name} ({email}) for meeting {meetingId}.
        slots:
          first_name: requestBody.first_name
          last_name: requestBody.last_name
          email: requestBody.email
          meetingId: path.meetingId
      - text: Add {email} ({first_name}) as a registrant to occurrences {occurrence_ids} of meeting {meetingId}.
        slots:
          email: requestBody.email
          first_name: requestBody.first_name
          occurrence_ids: query.occurrence_ids
          meetingId: path.meetingId
      method: generated
      generated: '2026-09-24'
- target: $.paths['/meetings/{meetingId}/registrants/status'].put
  update:
    x-apievangelist-phrasing:
      intent: Approve, deny or cancel meeting registrants
      effect: write
      questions:
      - How do I approve or deny people who registered for my meeting?
      - Can I cancel a registrant I already approved?
      instructions:
      - text: Apply {action} to registrants {registrants} on meeting {meetingId}.
        slots:
          action: requestBody.action
          registrants: requestBody.registrants
          meetingId: path.meetingId
      - text: Set registration status to {action} for occurrence {occurrence_id} of meeting {meetingId}.
        slots:
          action: requestBody.action
          occurrence_id: query.occurrence_id
          meetingId: path.meetingId
      method: generated
      generated: '2026-09-24'
- target: $.paths['/meetings/{meetingId}/batch_registrants'].post
  update:
    x-apievangelist-phrasing:
      intent: Register up to 30 people for a meeting at once
      effect: write
      questions:
      - Can I bulk-register a list of attendees for a meeting?
      - What's the maximum number of registrants I can add in one batch?
      instructions:
      - text: Batch register {registrants} for meeting {meetingId}.
        slots:
          registrants: requestBody.registrants
          meetingId: path.meetingId
      - text: Bulk-add up to 30 registrants {registrants} to meeting {meetingId} with auto-approve {auto_approve}.
        slots:
          registrants: requestBody.registrants
          meetingId: path.meetingId
          auto_approve: requestBody.auto_approve
      method: generated
      generated: '2026-09-24'