Zoom · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Zoom / Account Meetings API

9 actions 9 updates phrasing extends openapi/zoom-meetings-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 9

$.info
$.paths['/users/{userId}/meetings'].get
$.paths['/users/{userId}/meetings'].post
$.paths['/meetings/{meetingId}'].get
$.paths['/meetings/{meetingId}'].delete
$.paths['/meetings/{meetingId}'].patch
$.paths['/meetings/{meetingId}/status'].put
$.paths['/past_meetings/{meetingId}'].get
$.paths['/meetings/{meetingId}/invitation'].get

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 Meetings API
  version: 1.0.0
extends: openapi/zoom-meetings-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: 8
- target: $.paths['/users/{userId}/meetings'].get
  update:
    x-apievangelist-phrasing:
      intent: List a user's meetings
      effect: read
      questions:
      - What meetings are scheduled for a given user?
      - Can I filter a user's meetings to only upcoming or live ones?
      - Which value do I pass instead of a user ID for a user-level app?
      instructions:
      - text: List the meetings scheduled for user {userId}.
        slots:
          userId: path.userId
      - text: List {type} meetings for user {userId}, {page_size} per page.
        slots:
          type: query.type
          userId: path.userId
          page_size: query.page_size
      - text: List my own meetings.
      method: generated
      generated: '2026-09-24'
- target: $.paths['/users/{userId}/meetings'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a meeting for a user
      effect: write
      questions:
      - How do I schedule a meeting for a user?
      - Can I create a recurring meeting instead of a one-time one?
      - Can I schedule a meeting on behalf of another user?
      instructions:
      - text: Create a meeting for user {userId} called {topic} starting at {start_time}.
        slots:
          userId: path.userId
          topic: requestBody.topic
          start_time: requestBody.start_time
      - text: Schedule a {duration}-minute meeting {topic} for {userId} in timezone {timezone}.
        slots:
          duration: requestBody.duration
          topic: requestBody.topic
          userId: path.userId
          timezone: requestBody.timezone
      - text: Create a meeting for {userId} from template {template_id}.
        slots:
          userId: path.userId
          template_id: requestBody.template_id
      method: generated
      generated: '2026-09-24'
- target: $.paths['/meetings/{meetingId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a meeting's details
      effect: read
      questions:
      - What are the settings, recurrence and tracking fields on a meeting?
      - Can I fetch details for one occurrence of a recurring meeting?
      instructions:
      - text: Get the details of meeting {meetingId}.
        slots:
          meetingId: path.meetingId
      - text: Get 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}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a meeting
      effect: destructive
      questions:
      - Can I cancel a meeting and notify the registrants?
      - Is deleting a meeting permanent?
      instructions:
      - text: Delete meeting {meetingId} permanently.
        slots:
          meetingId: path.meetingId
      - text: Delete 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}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update a meeting's details
      effect: write
      questions:
      - Can I change the topic or start time of a meeting already scheduled?
      - What meeting settings can be edited after it's created?
      instructions:
      - text: Move meeting {meetingId} to start at {start_time}.
        slots:
          meetingId: path.meetingId
          start_time: requestBody.start_time
      - text: Change the topic of meeting {meetingId} to {topic}.
        slots:
          meetingId: path.meetingId
          topic: requestBody.topic
      - text: Set the agenda for occurrence {occurrence_id} of meeting {meetingId} to {agenda}.
        slots:
          occurrence_id: query.occurrence_id
          meetingId: path.meetingId
          agenda: requestBody.agenda
      method: generated
      generated: '2026-09-24'
- target: $.paths['/meetings/{meetingId}/status'].put
  update:
    x-apievangelist-phrasing:
      intent: End a meeting or recover a deleted one
      effect: write
      questions:
      - Can I end a meeting by changing its status?
      - Is it possible to recover a meeting I deleted by mistake?
      instructions:
      - text: End meeting {meetingId} by setting its status.
        slots:
          meetingId: path.meetingId
      - text: Apply status action {action} to meeting {meetingId}.
        slots:
          action: requestBody.action
          meetingId: path.meetingId
      method: generated
      generated: '2026-09-24'
- target: $.paths['/past_meetings/{meetingId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get details of a past meeting
      effect: read
      questions:
      - What information is available about a meeting that already happened?
      - Why do I have to double-encode a meeting UUID containing slashes?
      instructions:
      - text: Get the details of past meeting {meetingId}.
        slots:
          meetingId: path.meetingId
      - text: Show what happened in the ended meeting {meetingId}.
        slots:
          meetingId: path.meetingId
      method: generated
      generated: '2026-09-24'
- target: $.paths['/meetings/{meetingId}/invitation'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a meeting's invitation text
      effect: read
      questions:
      - Where do I get the invitation note to send to attendees?
      - Can I copy a meeting's invite text to paste into an email?
      instructions:
      - text: Get the invitation for meeting {meetingId}.
        slots:
          meetingId: path.meetingId
      - text: Fetch the invite note I can share for meeting {meetingId}.
        slots:
          meetingId: path.meetingId
      method: generated
      generated: '2026-09-24'