API Evangelist conversational phrasing for Zoom REST Webinar API

# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Zoom REST Webinar API
  version: 1.0.0
extends: openapi/zoom-webinar-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: 17
- target: $.paths['/webinar/attendees/list'].post
  update:
    x-apievangelist-phrasing:
      intent: List attendees of an ended webinar
      effect: read
      questions:
      - Who actually showed up to a webinar after it ended?
      - Can I get the attendee list for one specific past occurrence of a webinar?
      instructions:
      - text: List who attended ended webinar {id} hosted by {host_id}.
        slots:
          id: requestBody.id
          host_id: requestBody.host_id
      - text: Get attendees of webinar {id} for the session with UUID {uuid}, host {host_id}.
        slots:
          id: requestBody.id
          uuid: requestBody.uuid
          host_id: requestBody.host_id
      method: generated
      generated: '2026-09-24'
- target: $.paths['/webinar/create'].post
  update:
    x-apievangelist-phrasing:
      intent: Schedule a webinar
      effect: write
      questions:
      - How do I schedule a new webinar and get its start and join links?
      - Can I require registration with approval when setting up a webinar?
      instructions:
      - text: Create a webinar called {topic} of type {type} for host {host_id}.
        slots:
          topic: requestBody.topic
          type: requestBody.type
          host_id: requestBody.host_id
      - text: Schedule webinar {topic} (type {type}) for host {host_id} starting {start_time} for {duration} minutes.
        slots:
          topic: requestBody.topic
          type: requestBody.type
          host_id: requestBody.host_id
          start_time: requestBody.start_time
          duration: requestBody.duration
      method: generated
      generated: '2026-09-24'
- target: $.paths['/webinar/delete'].post
  update:
    x-apievangelist-phrasing:
      intent: Delete a webinar
      effect: destructive
      questions:
      - Can I delete just one occurrence of a recurring webinar?
      - What happens to a webinar once I delete it?
      instructions:
      - text: Delete webinar {id} hosted by {host_id}.
        slots:
          id: requestBody.id
          host_id: requestBody.host_id
      - text: Delete only occurrence {occurrence_id} of webinar {id} for host {host_id}.
        slots:
          occurrence_id: requestBody.occurrence_id
          id: requestBody.id
          host_id: requestBody.host_id
      method: generated
      generated: '2026-09-24'
- target: $.paths['/webinar/end'].post
  update:
    x-apievangelist-phrasing:
      intent: End a running webinar
      effect: destructive
      questions:
      - Is there a way to force a live webinar to end for everyone?
      - Can I stop a webinar that's in progress from the API?
      instructions:
      - text: End the live webinar {id} for host {host_id} now.
        slots:
          id: requestBody.id
          host_id: requestBody.host_id
      - text: Stop webinar {id} that host {host_id} is running.
        slots:
          id: requestBody.id
          host_id: requestBody.host_id
      method: generated
      generated: '2026-09-24'
- target: $.paths['/webinar/get'].post
  update:
    x-apievangelist-phrasing:
      intent: Get a webinar's details
      effect: read
      questions:
      - What settings and schedule does a particular webinar have?
      - Can I look up one webinar by its ID?
      instructions:
      - text: Get the details of webinar {id} for host {host_id}.
        slots:
          id: requestBody.id
          host_id: requestBody.host_id
      - text: Show me the configuration of webinar {id}, host {host_id}.
        slots:
          id: requestBody.id
          host_id: requestBody.host_id
      method: generated
      generated: '2026-09-24'
- target: $.paths['/webinar/list'].post
  update:
    x-apievangelist-phrasing:
      intent: List a host's registrationless webinars
      effect: read
      questions:
      - Which webinars that don't need registration does a host have?
      - Can I list webinars where attendees join without registering?
      instructions:
      - text: List the registrationless webinars for host {host_id}.
        slots:
          host_id: requestBody.host_id
      - text: Show page {page_number} of no-registration webinars for host {host_id}.
        slots:
          page_number: requestBody.page_number
          host_id: requestBody.host_id
      method: generated
      generated: '2026-09-24'
- target: $.paths['/webinar/list/registration'].post
  update:
    x-apievangelist-phrasing:
      intent: List a host's upcoming registration webinars
      effect: read
      questions:
      - What upcoming webinars require attendees to register first?
      - Can I see only the registration-based webinars that haven't happened yet?
      instructions:
      - text: List upcoming registration-based webinars for host {host_id}.
        slots:
          host_id: requestBody.host_id
      - text: Show {page_size} upcoming webinars requiring registration for host {host_id}.
        slots:
          page_size: requestBody.page_size
          host_id: requestBody.host_id
      method: generated
      generated: '2026-09-24'
- target: $.paths['/webinar/panelists'].post
  update:
    x-apievangelist-phrasing:
      intent: List a webinar's panelists
      effect: read
      questions:
      - Who are the panelists on a given webinar?
      - Can I pull the speaker lineup for a webinar?
      instructions:
      - text: List the panelists for webinar {id} hosted by {host_id}.
        slots:
          id: requestBody.id
          host_id: requestBody.host_id
      - text: Get the speaker lineup for webinar {id}, host {host_id}.
        slots:
          id: requestBody.id
          host_id: requestBody.host_id
      method: generated
      generated: '2026-09-24'
- target: $.paths['/webinar/polls'].post
  update:
    x-apievangelist-phrasing:
      intent: Get poll results from an ended webinar
      effect: read
      questions:
      - How did attendees answer the polls in a webinar that already ended?
      - Can I pull poll responses for a single session of a recurring webinar?
      instructions:
      - text: Get the poll results from ended webinar {id}, host {host_id}.
        slots:
          id: requestBody.id
          host_id: requestBody.host_id
      - text: Pull poll answers for webinar session {uuid} of webinar {id}, host {host_id}.
        slots:
          uuid: requestBody.uuid
          id: requestBody.id
          host_id: requestBody.host_id
      method: generated
      generated: '2026-09-24'
- target: $.paths['/webinar/questions'].post
  update:
    x-apievangelist-phrasing:
      intent: Get Q&A from an ended webinar
      effect: read
      questions:
      - What questions did the audience ask during a webinar that's over?
      - Can I export the Q&A log after a webinar ends?
      instructions:
      - text: Get the Q&A from ended webinar {id} hosted by {host_id}.
        slots:
          id: requestBody.id
          host_id: requestBody.host_id
      - text: Export audience questions for webinar {id} session {uuid}, host {host_id}.
        slots:
          id: requestBody.id
          uuid: requestBody.uuid
          host_id: requestBody.host_id
      method: generated
      generated: '2026-09-24'
- target: $.paths['/webinar/register'].post
  update:
    x-apievangelist-phrasing:
      intent: Register someone for a webinar
      effect: write
      questions:
      - How can I sign a person up for a webinar on their behalf?
      - Can I register an attendee for specific occurrences of a recurring webinar?
      instructions:
      - text: Register {first_name} {last_name} ({email}) for webinar {id}.
        slots:
          first_name: requestBody.first_name
          last_name: requestBody.last_name
          email: requestBody.email
          id: requestBody.id
      - text: Sign up {email}, {first_name} {last_name} from {org}, for webinar {id}.
        slots:
          email: requestBody.email
          first_name: requestBody.first_name
          last_name: requestBody.last_name
          org: requestBody.org
          id: requestBody.id
      method: generated
      generated: '2026-09-24'
- target: $.paths['/webinar/registrants/approve'].post
  update:
    x-apievangelist-phrasing:
      intent: Approve pending webinar registrants
      effect: write
      questions:
      - How do I approve people waiting for approval to join my webinar?
      - Can I approve several pending registrants at once?
      instructions:
      - text: Approve registrants {registrant_ids} for webinar {id}, host {host_id}.
        slots:
          registrant_ids: requestBody.registrant_ids
          id: requestBody.id
          host_id: requestBody.host_id
      - text: Let pending registrants {registrant_ids} into webinar {id} hosted by {host_id}.
        slots:
          registrant_ids: requestBody.registrant_ids
          id: requestBody.id
          host_id: requestBody.host_id
      method: generated
      generated: '2026-09-24'
- target: $.paths['/webinar/registrants/list'].post
  update:
    x-apievangelist-phrasing:
      intent: List a webinar's pending and approved registrants
      effect: read
      questions:
      - Which registrants are still waiting for approval on my webinar?
      - Can I filter a webinar's registrant list to only approved people?
      instructions:
      - text: List registrants for webinar {id}, host {host_id}.
        slots:
          id: requestBody.id
          host_id: requestBody.host_id
      - text: List webinar {id} registrants of type {type} for host {host_id}.
        slots:
          id: requestBody.id
          type: requestBody.type
          host_id: requestBody.host_id
      method: generated
      generated: '2026-09-24'
- target: $.paths['/webinar/registration'].post
  update:
    x-apievangelist-phrasing:
      intent: Gather registrant info for a webinar occurrence
      effect: read
      questions:
      - Can I collect the registration details people submitted for a webinar?
      - What registration info was gathered for one occurrence of a recurring webinar?
      instructions:
      - text: Gather the registration info submitted for webinar {id}, host {host_id}.
        slots:
          id: requestBody.id
          host_id: requestBody.host_id
      - text: Collect registration form data for occurrence {occurrence_id} of webinar {id}, host {host_id}.
        slots:
          occurrence_id: requestBody.occurrence_id
          id: requestBody.id
          host_id: requestBody.host_id
      method: generated
      generated: '2026-09-24'
- target: $.paths['/webinar/registration/cancel'].post
  update:
    x-apievangelist-phrasing:
      intent: Cancel webinar registrations
      effect: destructive
      questions:
      - Can I cancel someone's registration for a webinar?
      - Is it possible to cancel registrants for only one occurrence?
      instructions:
      - text: Cancel registrations {registrant_ids} for webinar {id}, host {host_id}.
        slots:
          registrant_ids: requestBody.registrant_ids
          id: requestBody.id
          host_id: requestBody.host_id
      - text: Cancel {registrant_ids} from occurrence {occurrence_id} of webinar {id}, host {host_id}.
        slots:
          registrant_ids: requestBody.registrant_ids
          occurrence_id: requestBody.occurrence_id
          id: requestBody.id
          host_id: requestBody.host_id
      method: generated
      generated: '2026-09-24'
- target: $.paths['/webinar/update'].post
  update:
    x-apievangelist-phrasing:
      intent: Update an existing webinar
      effect: write
      questions:
      - Can I reschedule a webinar that's already been created?
      - What can I change on an existing webinar, like its agenda or panelists?
      instructions:
      - text: Move existing webinar {id} (host {host_id}) to start at {start_time}.
        slots:
          id: requestBody.id
          host_id: requestBody.host_id
          start_time: requestBody.start_time
      - text: Rename existing webinar {id} for host {host_id} to {topic}.
        slots:
          id: requestBody.id
          host_id: requestBody.host_id
          topic: requestBody.topic
      method: generated
      generated: '2026-09-24'
- target: $.paths['/webinar/uuid/list'].post
  update:
    x-apievangelist-phrasing:
      intent: List session UUIDs of an ended webinar
      effect: read
      questions:
      - Where do I find the UUIDs for past sessions of a webinar?
      - Which session identifiers exist for a recurring webinar that has run before?
      instructions:
      - text: List the ended session UUIDs for webinar {id}, host {host_id}.
        slots:
          id: requestBody.id
          host_id: requestBody.host_id
      - text: Get past-instance UUIDs of webinar {id} hosted by {host_id}.
        slots:
          id: requestBody.id
          host_id: requestBody.host_id
      method: generated
      generated: '2026-09-24'