Zoom · OpenAPI Overlay 1.0.0
API Evangelist conversational phrasing for Zoom REST Account API
11 actions
11 updates
phrasing
extends
openapi/zoom-account-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.
What the actions change
x-apievangelist-phrasing
Targets 11
$.info
$.paths['/ma/account/billing/update'].post
$.paths['/ma/account/create'].post
$.paths['/ma/account/delete'].post
$.paths['/ma/account/get'].post
$.paths['/ma/account/list'].post
$.paths['/ma/account/plan/add'].post
$.paths['/ma/account/plan/get'].post
$.paths['/ma/account/plan/subscribe'].post
$.paths['/ma/account/plan/update'].post
$.paths['/ma/account/update'].post
OpenAPI Overlay
# 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 Account API
version: 1.0.0
extends: openapi/zoom-account-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: 10
- target: $.paths['/ma/account/billing/update'].post
update:
x-apievangelist-phrasing:
intent: Update a sub account's billing information
effect: write
questions:
- Can a master account change the billing address on one of its sub accounts?
- Which billing contact fields can I update for a sub account?
instructions:
- text: Update the billing phone for sub account {account_id} to {phone_number}.
slots:
account_id: requestBody.account_id
phone_number: requestBody.phone_number
- text: Set sub account {account_id}'s billing address to {address}, {city}, {state} {zip}.
slots:
account_id: requestBody.account_id
address: requestBody.address
city: requestBody.city
state: requestBody.state
zip: requestBody.zip
method: generated
generated: '2026-09-24'
- target: $.paths['/ma/account/create'].post
update:
x-apievangelist-phrasing:
intent: Create a sub account under the master account
effect: write
questions:
- How do I create a new sub account under my master account?
- What privilege does a master account need before it can create sub accounts?
instructions:
- text: Create a sub account owned by {first_name} {last_name} at {email} with password {password}.
slots:
first_name: requestBody.first_name
last_name: requestBody.last_name
email: requestBody.email
password: requestBody.password
- text: Open a new sub account for {email} ({first_name} {last_name}), password {password}, capacity {meeting_capacity}.
slots:
email: requestBody.email
first_name: requestBody.first_name
last_name: requestBody.last_name
password: requestBody.password
meeting_capacity: requestBody.meeting_capacity
method: generated
generated: '2026-09-24'
- target: $.paths['/ma/account/delete'].post
update:
x-apievangelist-phrasing:
intent: Delete a sub account
effect: destructive
questions:
- Can I remove a sub account from under my master account?
- What identifies the sub account I want to delete?
instructions:
- text: Delete sub account {account_id}.
slots:
account_id: requestBody.account_id
- text: Remove the sub account {account_id} from the master account.
slots:
account_id: requestBody.account_id
method: generated
generated: '2026-09-24'
- target: $.paths['/ma/account/get'].post
update:
x-apievangelist-phrasing:
intent: Get a sub account's details
effect: read
questions:
- Who owns a particular sub account under my master account?
- Can I look up one sub account by its account ID?
instructions:
- text: Get the details of sub account {account_id}.
slots:
account_id: requestBody.account_id
- text: Show me the owner of sub account {account_id}.
slots:
account_id: requestBody.account_id
method: generated
generated: '2026-09-24'
- target: $.paths['/ma/account/list'].post
update:
x-apievangelist-phrasing:
intent: List all sub accounts
effect: read
questions:
- Which sub accounts sit under my master account?
- Can I see every sub account the master account manages?
instructions:
- text: List all sub accounts under the master account.
- text: List sub accounts using API key {api_key} and secret {api_secret}.
slots:
api_key: requestBody.api_key
api_secret: requestBody.api_secret
method: generated
generated: '2026-09-24'
- target: $.paths['/ma/account/plan/add'].post
update:
x-apievangelist-phrasing:
intent: Add an additional plan to a sub account
effect: write
questions:
- Can I add an extra plan to a sub account that the master account pays for?
- Is adding a base plan allowed, or only additional plans?
instructions:
- text: Add the additional plan {plan} to sub account {account_id}.
slots:
plan: requestBody.plan
account_id: requestBody.account_id
- text: Attach add-on plan {plan} to paid sub account {account_id}.
slots:
plan: requestBody.plan
account_id: requestBody.account_id
method: generated
generated: '2026-09-24'
- target: $.paths['/ma/account/plan/get'].post
update:
x-apievangelist-phrasing:
intent: Get a sub account's plans
effect: read
questions:
- What plans is a sub account currently on?
- Can I check a sub account's subscription details?
instructions:
- text: Get the plan information for sub account {account_id}.
slots:
account_id: requestBody.account_id
- text: Show which plans sub account {account_id} is subscribed to.
slots:
account_id: requestBody.account_id
method: generated
generated: '2026-09-24'
- target: $.paths['/ma/account/plan/subscribe'].post
update:
x-apievangelist-phrasing:
intent: Subscribe a sub account to plans
effect: write
questions:
- How do I start a paid subscription for a sub account?
- Can I bundle webinar, recording and audio plans into a sub account's subscription?
instructions:
- text: Subscribe sub account {account_id} to base plan {plan_base}, billing {first_name} {last_name} at {phone_number}.
slots:
account_id: requestBody.account_id
plan_base: requestBody.plan_base
first_name: requestBody.first_name
last_name: requestBody.last_name
phone_number: requestBody.phone_number
- text: Subscribe {account_id} to {plan_base} with webinar plan {plan_webinar}, billed to {address}, {city}, {state} {zip}, {country}.
slots:
account_id: requestBody.account_id
plan_base: requestBody.plan_base
plan_webinar: requestBody.plan_webinar
address: requestBody.address
city: requestBody.city
state: requestBody.state
zip: requestBody.zip
country: requestBody.country
method: generated
generated: '2026-09-24'
- target: $.paths['/ma/account/plan/update'].post
update:
x-apievangelist-phrasing:
intent: Change a sub account's base or additional plan
effect: write
questions:
- Can I upgrade the base plan on a sub account the master account pays for?
- What is the difference between updating a base plan and an additional plan here?
instructions:
- text: Change sub account {account_id}'s {type} plan to {plan}.
slots:
account_id: requestBody.account_id
type: requestBody.type
plan: requestBody.plan
- text: Switch the existing plan of type {type} on {account_id} to {plan}.
slots:
type: requestBody.type
account_id: requestBody.account_id
plan: requestBody.plan
method: generated
generated: '2026-09-24'
- target: $.paths['/ma/account/update'].post
update:
x-apievangelist-phrasing:
intent: Update a sub account's settings
effect: write
questions:
- Can I change meeting capacity or login enforcement for an existing sub account?
- Which options can I toggle on a sub account after it's created?
instructions:
- text: Set meeting capacity on sub account {account_id} to {meeting_capacity}.
slots:
account_id: requestBody.account_id
meeting_capacity: requestBody.meeting_capacity
- text: Restrict sub account {account_id} logins to domains {enforce_login_domains}.
slots:
account_id: requestBody.account_id
enforce_login_domains: requestBody.enforce_login_domains
method: generated
generated: '2026-09-24'