@itentialopensource/adapter-zoom
Version:
This adapter integrates with system described as: zoom.
1,744 lines (1,743 loc) • 440 kB
YAML
openapi: 3.0.0
info:
title: Zoom API
description: API Description
contact:
name: Zoom Developers
url: https://developer.zoom.us/
email: developer@zoom.us
version: '2.0.0'
servers:
- url: https://api.zoom.us/v2
variables: {}
paths:
/accounts:
get:
tags:
- Accounts
summary: accounts
description: List all the sub accounts under the master account
operationId: accounts
parameters:
- name: page_size
in: query
description: The number of records returned within a single API call
style: form
explode: true
schema:
maximum: 300
type: integer
format: int32
default: 30
- name: page_number
in: query
description: Current page number of returned records
style: form
explode: true
schema:
type: integer
format: int32
default: 1
responses:
'200':
description: Account list returned
headers: {}
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/AccountList'
- description: List of Accounts
application/xml:
schema:
allOf:
- $ref: '#/components/schemas/AccountsResponse'
- xml:
name: AccountsResponse
attribute: false
wrapped: false
deprecated: false
post:
tags:
- Accounts
summary: accountCreate
description: Create a sub account under the master account. <aside>Your account must be a master account and have this privilege to create sub account. Zoom only assigns this privilege to trusted partners. The created user will not receive a confirmation email.</aside>.
operationId: accountCreate
parameters: []
requestBody:
description: Account
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/AccountsRequest'
- description: Account
required: true
responses:
'201':
description: Account Created
headers:
Content-Location:
description: Location of created Account
content:
text/plain:
schema:
type: string
description: Location of created Account
content:
application/json:
schema:
$ref: '#/components/schemas/accountCreateResponse'
application/xml:
schema:
allOf:
- $ref: '#/components/schemas/accountCreateResponse'
- xml:
name: accountCreateResponse
attribute: false
wrapped: false
'409':
description: Account with that email already exists
headers: {}
content: {}
deprecated: false
/accounts/{accountId}:
get:
tags:
- Accounts
summary: account
description: Retrieve a sub account under the master account. <aside>Your account must be a master account and have this privilege to read sub accounts. Zoom only assigns this privilege to trusted partners</aside>.
operationId: account
parameters:
- name: accountId
in: path
description: The account ID
required: true
style: simple
schema:
type: string
responses:
'200':
description: Account object returned
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/accountResponse'
application/xml:
schema:
allOf:
- $ref: '#/components/schemas/accountResponse'
- xml:
name: accountResponse
attribute: false
wrapped: false
'404':
description: User not found
headers: {}
content: {}
deprecated: false
delete:
tags:
- Accounts
summary: accountDisassociate
description: Disassociate a sub account from the master account. This will leave the account intact but the sub account will not longer be associated with the master account.
operationId: accountDisassociate
parameters:
- name: accountId
in: path
description: The account ID
required: true
style: simple
schema:
type: string
responses:
'204':
description: Account deleted
headers: {}
content: {}
'404':
description: Account not found
headers: {}
content: {}
deprecated: false
/accounts/{accountId}/options:
patch:
tags:
- Accounts
summary: accountOptionsUpdate
description: Update a sub account's options under the master account
operationId: accountOptionsUpdate
parameters:
- name: accountId
in: path
description: The account ID
required: true
style: simple
schema:
type: string
requestBody:
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/AccountOptions'
required: true
responses:
'204':
description: Account options updated
headers: {}
content: {}
'404':
description: Account not found
headers: {}
content: {}
deprecated: false
/accounts/{accountId}/settings:
get:
tags:
- Accounts
summary: accountSettings
description: Retrieve a sub account's settings under the master account
operationId: accountSettings
parameters:
- name: accountId
in: path
description: The account ID
required: true
style: simple
schema:
type: string
responses:
'200':
description: Account settings returned
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/Accountsettings'
application/xml:
schema:
allOf:
- $ref: '#/components/schemas/Accountsettings'
- xml:
name: Accountsettings
attribute: false
wrapped: false
'404':
description: Account not found
headers: {}
content: {}
deprecated: false
patch:
tags:
- Accounts
summary: accountSettingsUpdate
description: Update a sub account's settings under the master account
operationId: accountSettingsUpdate
parameters:
- name: accountId
in: path
description: The account ID
required: true
style: simple
schema:
type: string
requestBody:
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/Accountsettings'
required: true
responses:
'204':
description: Account settings updated
headers: {}
content: {}
'404':
description: Account not found
headers: {}
content: {}
deprecated: false
/accounts/{accountId}/managed_domains:
get:
tags:
- Accounts
summary: accountManagedDomain
description: Retrieve a sub account's managed domains under the master account
operationId: accountManagedDomain
parameters:
- name: accountId
in: path
description: The account ID
required: true
style: simple
schema:
type: string
responses:
'200':
description: Account managed domains returned
headers: {}
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/DomainsList'
- description: List of Managed Domains
application/xml:
schema:
allOf:
- $ref: '#/components/schemas/AccountsManagedDomainsResponse'
- xml:
name: AccountsManagedDomainsResponse
attribute: false
wrapped: false
'404':
description: Account not found
headers: {}
content: {}
deprecated: false
/accounts/{accountId}/billing:
get:
tags:
- Billing
summary: accountBilling
description: Retrieve billing information for a sub account under the master account
operationId: accountBilling
parameters:
- name: accountId
in: path
description: The account ID
required: true
style: simple
schema:
type: string
responses:
'200':
description: Account billing contact information returned
headers: {}
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/BillingContactRequired'
- description: Billing Contact object
application/xml:
schema:
allOf:
- $ref: '#/components/schemas/AccountsBillingResponse'
- xml:
name: AccountsBillingResponse
attribute: false
wrapped: false
'404':
description: Account not found
headers: {}
content: {}
deprecated: false
patch:
tags:
- Billing
summary: accountBillingUpdate
description: Update billing information for a sub account under the master account <aside>Only for the sub account which is a paid account and paid by master account</aside>
operationId: accountBillingUpdate
parameters:
- name: accountId
in: path
description: The account ID
required: true
style: simple
schema:
type: string
requestBody:
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/BillingContact'
required: true
responses:
'204':
description: Account billing contact information updated
headers: {}
content: {}
'404':
description: Account not found
headers: {}
content: {}
deprecated: false
/accounts/{accountId}/plans:
get:
tags:
- Billing
summary: accountPlans
description: Retrieve plan information for a sub account under the master account <aside>Only for the sub account which is paid by master account</aside>
operationId: accountPlans
parameters:
- name: accountId
in: path
description: The account ID
required: true
style: simple
schema:
type: string
responses:
'200':
description: Account plans returned
headers: {}
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/AccountPlans'
- description: Account Plans object
application/xml:
schema:
allOf:
- $ref: '#/components/schemas/AccountsPlansResponse'
- xml:
name: AccountsPlansResponse
attribute: false
wrapped: false
'404':
description: Account not fond
headers: {}
content: {}
deprecated: false
post:
tags:
- Billing
summary: accountPlanCreate
description: Subscribe plans for a sub account of the master account <aside>Can only subscribe plans for the sub account which is a free account and paid by master account</aside>
operationId: accountPlanCreate
parameters:
- name: accountId
in: path
description: The account ID
required: true
style: simple
schema:
type: string
requestBody:
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/body'
required: true
responses:
'201':
description: Account plans updated
headers: {}
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/AccountPlans'
- description: Account Plans object
application/xml:
schema:
allOf:
- $ref: '#/components/schemas/AccountsPlansResponse'
- xml:
name: AccountsPlansResponse
attribute: false
wrapped: false
deprecated: false
/accounts/{accountId}/plans/base:
put:
tags:
- Billing
summary: accountPlanBaseUpdate
description: Update a base plan for a sub account <aside>Can only update a base plan for the sub account which is a paid account and paid by master account</aside>
operationId: accountPlanBaseUpdate
parameters:
- name: accountId
in: path
description: The account ID
required: true
style: simple
schema:
type: string
requestBody:
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/AccountPlanBaseRequired'
required: true
responses:
'204':
description: Account plans updated
headers: {}
content: {}
deprecated: false
/accounts/{accountId}/plans/addons:
post:
tags:
- Billing
summary: accountPlanAddonCreate
description: Add an additional plan for sub account <aside>Can only add an Additional plan for the sub account which is a paid account and paid by master account</aside>
operationId: accountPlanAddonCreate
parameters:
- name: accountId
in: path
description: The account ID
required: true
style: simple
schema:
type: string
requestBody:
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/AccountPlanRequired'
required: true
responses:
'201':
description: Account plans updated
headers: {}
content: {}
deprecated: false
put:
tags:
- Billing
summary: accountPlanAddonUpdate
description: Update an additional plan for sub account<aside>Can only update an Additional plan for the sub account which is a paid account and paid by master account</aside>
operationId: accountPlanAddonUpdate
parameters:
- name: accountId
in: path
description: The account ID
required: true
style: simple
schema:
type: string
requestBody:
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/AccountPlanRequired'
required: true
responses:
'204':
description: Account plans updated
headers: {}
content: {}
deprecated: false
/users:
get:
tags:
- Users
summary: users
description: List users on your account
operationId: users
parameters:
- name: status
in: query
description: User status
style: form
explode: true
schema:
allOf:
- $ref: '#/components/schemas/status41'
- description: User status
- name: page_size
in: query
description: The number of records returned within a single API call
style: form
explode: true
schema:
maximum: 300
type: integer
format: int32
default: 30
- name: page_number
in: query
description: Current page number of returned records
style: form
explode: true
schema:
type: integer
format: int32
default: 1
responses:
'200':
description: User list returned
headers: {}
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/UserList'
- description: List of Users
application/xml:
schema:
allOf:
- $ref: '#/components/schemas/UsersResponse'
- xml:
name: UsersResponse
attribute: false
wrapped: false
deprecated: false
post:
tags:
- Users
summary: userCreate
description: Create a user on your account
operationId: userCreate
parameters: []
requestBody:
description: User
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/body13'
- description: User
required: true
responses:
'201':
description: User Created
headers:
Content-Location:
description: Location of created User
content:
text/plain:
schema:
type: string
description: Location of created User
content:
application/json:
schema:
$ref: '#/components/schemas/userCreateResponse'
application/xml:
schema:
allOf:
- $ref: '#/components/schemas/userCreateResponse'
- xml:
name: userCreateResponse
attribute: false
wrapped: false
'409':
description: User with that email already exists
headers: {}
content: {}
deprecated: false
/users/{userId}:
get:
tags:
- Users
summary: user
description: Retrieve a user on your account
operationId: user
parameters:
- name: userId
in: path
description: The user ID or email address
required: true
style: simple
schema:
type: string
- name: login_type
in: query
description: ''
style: form
explode: true
schema:
$ref: '#/components/schemas/login_type'
responses:
'200':
description: User object returned
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/userResponse'
application/xml:
schema:
allOf:
- $ref: '#/components/schemas/userResponse'
- xml:
name: userResponse
attribute: false
wrapped: false
'404':
description: User not found
headers: {}
content: {}
deprecated: false
patch:
tags:
- Users
summary: userUpdate
description: Update a user on your account
operationId: userUpdate
parameters:
- name: userId
in: path
description: The user ID or email address
required: true
style: simple
schema:
type: string
requestBody:
description: User
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/UsersRequest1'
- description: User
required: true
responses:
'204':
description: User updated
headers: {}
content: {}
'404':
description: User not found
headers: {}
content: {}
deprecated: false
delete:
tags:
- Users
summary: userDelete
description: Delete a user on your account
operationId: userDelete
parameters:
- name: userId
in: path
description: The user ID or email address
required: true
style: simple
schema:
type: string
- name: action
in: query
description: Delete action type
style: form
explode: true
schema:
allOf:
- $ref: '#/components/schemas/action91'
- description: Delete action type
- name: transfer_email
in: query
description: Transfer email
style: form
explode: true
schema:
type: string
- name: transfer_meeting
in: query
description: Transfer meeting
style: form
explode: true
schema:
type: boolean
- name: transfer_webinar
in: query
description: Transfer webinar
style: form
explode: true
schema:
type: boolean
- name: transfer_recording
in: query
description: Transfer recording
style: form
explode: true
schema:
type: boolean
responses:
'204':
description: User deleted
headers: {}
content: {}
'404':
description: User not found
headers: {}
content: {}
deprecated: false
/users/{userId}/assistants:
get:
tags:
- Users
summary: userAssistants
description: List a user's assistants
operationId: userAssistants
parameters:
- name: userId
in: path
description: The user ID or email address
required: true
style: simple
schema:
type: string
responses:
'200':
description: Success
headers: {}
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/UserassistantsList'
- description: List of User's assistants
application/xml:
schema:
allOf:
- $ref: '#/components/schemas/UsersAssistantsResponse'
- xml:
name: UsersAssistantsResponse
attribute: false
wrapped: false
'404':
description: User not found
headers: {}
content: {}
deprecated: false
post:
tags:
- Users
summary: userAssistantCreate
description: Add assistants to a user
operationId: userAssistantCreate
parameters:
- name: userId
in: path
description: The user ID or email address
required: true
style: simple
schema:
type: string
requestBody:
description: User assistant
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/UsersAssistantsRequest'
- description: User assistant
required: true
responses:
'201':
description: Assitant Added
headers:
Content-Location:
description: Location of created assistant
content:
text/plain:
schema:
type: string
description: Location of created assistant
content:
application/json:
schema:
$ref: '#/components/schemas/userAssistantCreateResponse'
application/xml:
schema:
allOf:
- $ref: '#/components/schemas/userAssistantCreateResponse'
- xml:
name: userAssistantCreateResponse
attribute: false
wrapped: false
'404':
description: User not found
headers: {}
content: {}
deprecated: false
delete:
tags:
- Users
summary: userAssistantsDelete
description: Delete all of a user'sassitants
operationId: userAssistantsDelete
parameters:
- name: userId
in: path
description: The user ID or email address
required: true
style: simple
schema:
type: string
responses:
'204':
description: Assitants deleted
headers: {}
content: {}
'404':
description: User not found
headers: {}
content: {}
deprecated: false
/users/{userId}/assistants/{assistantId}:
delete:
tags:
- Users
summary: userAssistantDelete
description: Delete one of a user's assistants
operationId: userAssistantDelete
parameters:
- name: userId
in: path
description: The user ID or email address
required: true
style: simple
schema:
type: string
- name: assistantId
in: path
description: Assistant's ID
required: true
style: simple
schema:
type: string
responses:
'204':
description: Assitant deleted
headers: {}
content: {}
'404':
description: User or Assistant not found
headers: {}
content: {}
deprecated: false
/users/{userId}/schedulers:
get:
tags:
- Users
summary: userSchedulers
description: List a user's schedulers
operationId: userSchedulers
parameters:
- name: userId
in: path
description: The user ID or email address
required: true
style: simple
schema:
type: string
responses:
'200':
description: Success
headers: {}
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/UserschedulersList'
- description: List of User's schedulers
application/xml:
schema:
allOf:
- $ref: '#/components/schemas/UsersSchedulersResponse'
- xml:
name: UsersSchedulersResponse
attribute: false
wrapped: false
'404':
description: User not found
headers: {}
content: {}
deprecated: false
delete:
tags:
- Users
summary: userSchedulersDelete
description: Delete all of a user'schedulers
operationId: userSchedulersDelete
parameters:
- name: userId
in: path
description: The user ID or email address
required: true
style: simple
schema:
type: string
responses:
'204':
description: Schedulers deleted.
headers: {}
content: {}
'404':
description: User not found
headers: {}
content: {}
deprecated: false
/users/{userId}/schedulers/{schedulerId}:
delete:
tags:
- Users
summary: userSchedulerDelete
description: Delete one of a user's schedulers
operationId: userSchedulerDelete
parameters:
- name: userId
in: path
description: The user ID or email address
required: true
style: simple
schema:
type: string
- name: schedulerId
in: path
description: Scheduler's ID
required: true
style: simple
schema:
type: string
responses:
'204':
description: Scheduler deleted.
headers: {}
content: {}
'404':
description: User or Scheduler not found
headers: {}
content: {}
deprecated: false
/users/{userId}/picture:
post:
tags:
- Users
summary: userPicture
description: Upload a user's profile picture
operationId: userPicture
parameters:
- name: userId
in: path
description: The user ID or email address
required: true
style: simple
schema:
type: string
requestBody:
content:
multipart/form-data:
encoding: {}
schema:
required:
- pic_file
type: object
properties:
pic_file:
type: string
description: User picture file, must be a jpg/jpeg file
format: binary
required: false
responses:
'201':
description: Picture Uploaded
headers:
Content-Location:
description: Location of user's picture
content:
text/plain:
schema:
type: string
description: Location of user's picture
content: {}
'404':
description: User not found
headers: {}
content: {}
deprecated: false
/users/{userId}/settings:
get:
tags:
- Users
summary: userSettings
description: Retrieve a user's settings
operationId: userSettings
parameters:
- name: userId
in: path
description: The user ID or email address
required: true
style: simple
schema:
type: string
- name: login_type
in: query
description: ''
style: form
explode: true
schema:
$ref: '#/components/schemas/login_type'
responses:
'200':
description: User settings returned
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/Usersettings'
application/xml:
schema:
allOf:
- $ref: '#/components/schemas/Usersettings'
- xml:
name: Usersettings
attribute: false
wrapped: false
'404':
description: User not found
headers: {}
content: {}
deprecated: false
patch:
tags:
- Users
summary: userSettingsUpdate
description: Update a user's settings
operationId: userSettingsUpdate
parameters:
- name: userId
in: path
description: The user ID or email address
required: true
style: simple
schema:
type: string
requestBody:
description: User Settings
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/Usersettings1'
- description: User Settings
required: true
responses:
'204':
description: User setting's updated
headers: {}
content: {}
'404':
description: User not found
headers: {}
content: {}
deprecated: false
/users/{userId}/status:
put:
tags:
- Users
summary: userStatus
description: Update a user's status
operationId: userStatus
parameters:
- name: userId
in: path
description: The user ID or email address
required: true
style: simple
schema:
type: string
requestBody:
description: User status
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/UsersStatusRequest'
- description: User status
required: true
responses:
'204':
description: Status updated
headers: {}
content: {}
'404':
description: User not found
headers: {}
content: {}
deprecated: false
/users/{userId}/password:
put:
tags:
- Users
summary: userPassword
description: Update a user's password
operationId: userPassword
parameters:
- name: userId
in: path
description: The user ID or email address
required: true
style: simple
schema:
type: string
requestBody:
description: User password
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/body15'
- description: User password
required: true
responses:
'204':
description: Password updated
headers: {}
content: {}
'404':
description: User not found
headers: {}
content: {}
deprecated: false
/users/{userId}/permissions:
get:
tags:
- Users
summary: userPermission
description: Retrieve a user's permissions
operationId: userPermission
parameters:
- name: userId
in: path
description: The user ID or email address
required: true
style: simple
schema:
type: string
responses:
'200':
description: User permissions returned
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/UserPermissions'
application/xml:
schema:
allOf:
- $ref: '#/components/schemas/UserPermissions'
- xml:
name: UserPermissions
attribute: false
wrapped: false
'404':
description: User not found
headers: {}
content: {}
deprecated: false
/users/{userId}/token:
get:
tags:
- Users
summary: userToken
description: Retrieve a user's token
operationId: userToken
parameters:
- name: userId
in: path
description: The user ID or email address
required: true
style: simple
schema:
type: string
- name: type
in: query
description: User token type
style: form
explode: true
schema:
allOf:
- $ref: '#/components/schemas/type331'
- description: User token type
responses:
'200':
description: Token returned
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/userTokenResponse'
application/xml:
schema:
allOf:
- $ref: '#/components/schemas/userTokenResponse'
- xml:
name: userTokenResponse
attribute: false
wrapped: false
'404':
description: User not found
headers: {}
content: {}
deprecated: false
delete:
tags:
- Users
summary: userSSOTokenDelete
description: Revoke a user's SSO token
operationId: userSSOTokenDelete
parameters:
- name: userId
in: path
description: The user ID or email address
required: true
style: simple
schema:
type: string
responses:
'204':
description: Token deleted
headers: {}
content: {}
'404':
description: User not found
headers: {}
content: {}
deprecated: false
/users/{userId}/email:
put:
tags:
- Users
summary: userEmailUpdate
description: Update a user's email
operationId: userEmailUpdate
parameters:
- name: userId
in: path
description: The user ID or email address
required: true
style: simple
schema:
type: string
requestBody:
description: User email
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/body16'
- description: User email
required: true
responses:
'204':
description: email updated
headers: {}
content: {}
'404':
description: User not found
headers: {}
content: {}
deprecated: false
/users/zpk:
get:
tags:
- Users
summary: userZPK
description: Check if the zpk is expired. The zpk is used to authenticate a user.
operationId: userZPK
parameters:
- name: zpk
in: query
description: User zpk
required: true
style: form
explode: true
schema:
type: string
responses:
'200':
description: Success
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/userZPKResponse'
application/xml:
schema:
allOf:
- $ref: '#/components/schemas/userZPKResponse'
- xml:
name: userZPKResponse
attribute: false
wrapped: false
deprecated: false
/users/email:
get:
tags:
- Users
summary: userEmail
description: Check if the user email exists
operationId: userEmail
parameters:
- name: email
in: query
description: Zoom work email
required: true
style: form
explode: true
schema:
type: string
responses:
'200':
description: Success
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/userEmailResponse'
application/xml:
schema:
allOf:
- $ref: '#/components/schemas/userEmailResponse'
- xml:
name: userEmailResponse
attribute: false
wrapped: false
deprecated: false
/users/vanity_name:
get:
tags:
- Users
summary: userVanityName
description: Check if the user's personal meeting room name exists
operationId: userVanityName
parameters:
- name: vanity_name
in: query
description: Personal meeting room name
required: true
style: form
explode: true
schema:
type: string
responses:
'200':
description: Success
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/userVanityNameResponse'
application/xml:
schema:
allOf:
- $ref: '#/components/schemas/userVanityNameResponse'
- xml:
name: userVanityNameResponse
attribute: false
wrapped: false
deprecated: false
/users/{userId}/meetings:
get:
tags:
- Meetings
summary: meetings
description: List meetings for a user
operationId: meetings
parameters:
- name: userId
in: path
description: The user ID or email address
required: true
style: simple
schema:
type: string
- name: type
in: query
description: The meeting type
style: form
explode: true
schema:
allOf:
- $ref: '#/components/schemas/type161'
- description: The meeting type
- name: page_size
in: query
description: The number of records returned within a single API call
style: form
explode: true
schema:
maximum: 300
type: integer
format: int32
default: 30
- name: page_number
in: query
description: Current page number of returned records
style: form
explode: true
schema:
type: integer
format: int32
default: 1
responses:
'200':
description: List of Meeting objects returned
headers: {}
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/GroupList1'
- description: List of Meetings
application/xml:
schema:
allOf:
- $ref: '#/components/schemas/UsersMeetingsResponse'
- xml:
name: UsersMeetingsResponse
attribute: false
wrapped: false
'404':
description: User not found
headers: {}
content: {}
deprecated: false
post:
tags:
- Meetings
summary: meetingCreate
description: Create a meeting for a user <aside>The expiration time of start_url is two hours. But for API users, the expiration time is 90 days.</aside>
operationId: meetingCreate
parameters:
- name: userId
in: path
description: The user ID or email address
required: true
style: simple
schema:
type: string
requestBody:
description: Meeting object
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/body7'
- description: Meeting object
required: true
responses:
'201':
description: Meeting Created
headers:
Content-Location:
description: Location of created Meeting
content:
text/plain:
schema:
type: string
description: Location of created Meeting
content:
application/json:
schema:
$ref: '#/components/schemas/meetingCreateResponse'
application/xml:
schema:
allOf:
- $ref: '#/components/schemas/meetingCreateResponse'
- xml:
name: meetingCreateResponse
attribute: false
wrapped: false
'404':
description: User not found
headers: {}
content: {}
deprecated: false
/meetings/{meetingId}:
get:
tags:
- Meetings
summary: meeting
description: Retrieve a meeting's details
operationId: meeting
parameters:
- name: meetingId
in: path
description: The meeting ID
required: true
style: simple
schema:
type: integer
format: int32
responses:
'200':
description: Meeting object returned
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/meetingResponse'
application/xml:
schema:
allOf:
- $ref: '#/components/schemas/meetingResponse'
- xml:
name: meetingResponse
attribute: false
wrapped: false
'404':
description: Meeting not found
headers: {}
content: {}
deprecated: false
patch:
tags:
- Meetings
summary: meetingUpdate
description: Update a meeting's details
operationId: meetingUpdate
parameters:
- name: meetingId
in: path
description: The meeting ID
required: true
style: simple
schema:
type: integer
format: int32
requestBody:
description: Meeting
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/body8'
- description: Meeting
required: true
responses:
'204':
description: Meeting Updated
headers: {}
content: {}
'404':
description: Meeting not found
headers: {}
content: {}
deprecated: false
delete:
tags:
- Meetings
summary: meetingDelete
description: Delete a meeting
operationId: meetingDelete
parameters:
- name: meetingId
in: path
description: The meeting ID
required: true
style: simple
schema:
type: integer
format: int32
- name: occurrence_id
in: query
description: The meeting occurrence ID
style: form
explode: true
schema:
type: string
responses:
'204':
description: Meeting deleted
headers: {}
content: {}
'404':
description: Meeting not found
headers: {}
content: {}
deprecated: false
/meetings/{meetingId}/status:
put:
tags:
- Meetings
summary: meetingStatus
description: Update a meeting's status
operationId: meetingStatus
parameters:
- name: meetingId
in: path
description: The meeting ID
required: true
style: simple
schema:
type: integer
format: int32
requestBody:
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/body9'
required: true
responses:
'204':
description: Meeting updated
headers: {}
content: {}
'404':
description: Meeting not found
headers: {}
content: {}
deprecated: false
/meetings/{meetingId}/invitation:
get:
tags:
- Meetings
summary: meetingInvitation
description: Retrieve a meeting invitation
operationId: meetingInvitation
parameters:
- name: meetingId
in: path
description: The meeting ID
required: true
style: simple
schema:
type: integer
format: int32
responses:
'200':
description: Meeting invitation Returned
headers: {}
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/MeetingInvitation'
- description: Meeting invitation details
application/xml:
schema:
allOf:
- $ref: '#/components/schemas/MeetingsInvitationResponse'
- xml:
name: MeetingsInvitationResponse
attribute: false
wrapped: false
deprecated: false
/meetings/{meetingId}/registrants:
get:
tags:
- Meetings
summary: meetingRegistrants
description: List registrants of a meeting
operationId: meetingRegistrants
parameters:
- name: meetingId
in: path
description: The meeting ID
required: true
style: simple
schema:
type: integer
format: int32
- name: occurrence_id
in: query
description: The meeting occurrence ID
style: form
explode: true
schema: