{"note":"OpenAPI conversion -- returning structured metadata","name":"zoom","description":"Zoom API","version":"2.0.0","base_url":"https://api.zoom.us/v2","endpoints":155,"raw":"@lap v0.3\n# Machine-readable API spec. Each @endpoint block is one API call.\n@api Zoom API\n@base https://api.zoom.us/v2\n@version 2.0.0\n@auth ApiKey access_token in query\n@endpoints 155\n@hint download_for_search\n@toc accounts(15), groups(8), h323(4), tracking_fields(5), im(10), users(35), meetings(22), past_meetings(3), metrics(16), report(12), tsp(2), webinars(16), past_webinars(1), webhooks(6)\n\n@group accounts\n@endpoint GET /accounts\n@desc List sub accounts\n@optional {page_size: any # The number of records returned within a single API call, page_number: any # Current page number of returned records}\n@returns(200) Account list returned\n\n@endpoint POST /accounts\n@desc Create a sub account\n@required {body: map # Account}\n@returns(201) Account Created\n@errors {409: Account with that email already exists}\n\n@endpoint GET /accounts/{accountId}\n@desc Retrieve a sub account\n@required {accountId: any # The account ID}\n@returns(200) Account object returned\n@errors {404: User not found}\n\n@endpoint DELETE /accounts/{accountId}\n@desc Disassociate an account\n@required {accountId: any # The account ID}\n@returns(204) Account deleted\n@errors {404: Account not found}\n\n@endpoint PATCH /accounts/{accountId}/options\n@desc Update a sub account's options\n@required {accountId: any # The account ID, body: map}\n@returns(204) Account options updated\n@errors {404: Account not found}\n\n@endpoint GET /accounts/{accountId}/settings\n@desc Retrieve a sub account's settings\n@required {accountId: any # The account ID}\n@returns(200) Account settings returned\n@errors {404: Account not found}\n\n@endpoint PATCH /accounts/{accountId}/settings\n@desc Update a sub account's settings\n@required {accountId: any # The account ID, body: map}\n@returns(204) Account settings updated\n@errors {404: Account not found}\n\n@endpoint GET /accounts/{accountId}/managed_domains\n@desc Retrieve a sub account's managed domains\n@required {accountId: any # The account ID}\n@returns(200) Account managed domains returned\n@errors {404: Account not found}\n\n@endpoint GET /accounts/{accountId}/billing\n@desc Retrieve billing information for a sub account\n@required {accountId: any # The account ID}\n@returns(200) Account billing contact information returned\n@errors {404: Account not found}\n\n@endpoint PATCH /accounts/{accountId}/billing\n@desc Update billing information for a sub account\n@required {accountId: any # The account ID, body: map}\n@returns(204) Account billing contact information updated\n@errors {404: Account not found}\n\n@endpoint GET /accounts/{accountId}/plans\n@desc Retrieve plan information for a sub account\n@required {accountId: any # The account ID}\n@returns(200) Account plans returned\n@errors {404: Account not fond}\n\n@endpoint POST /accounts/{accountId}/plans\n@desc Subscribe plans for a sub account\n@required {accountId: any # The account ID, body: any}\n@returns(201) Account plans updated\n\n@endpoint PUT /accounts/{accountId}/plans/base\n@desc Update a base plan for a sub account\n@required {accountId: any # The account ID, body: map}\n@returns(204) Account plans updated\n\n@endpoint POST /accounts/{accountId}/plans/addons\n@desc Add an additional plan for sub account\n@required {accountId: any # The account ID, body: map}\n@returns(201) Account plans updated\n\n@endpoint PUT /accounts/{accountId}/plans/addons\n@desc Update an additional plan for sub account\n@required {accountId: any # The account ID, body: map}\n@returns(204) Account plans updated\n\n@endgroup\n\n@group groups\n@endpoint GET /groups\n@desc List groups\n@returns(200) List of groups returned\n\n@endpoint POST /groups\n@desc Create a group\n@required {body: any}\n@returns(201) Group created\n\n@endpoint GET /groups/{groupId}\n@desc Retrieve a group\n@required {groupId: any # The group ID}\n@returns(200) Group object returned\n@errors {404: Group not found}\n\n@endpoint PATCH /groups/{groupId}\n@desc Update a group\n@required {groupId: any # The group ID, body: any}\n@returns(204) Group updated\n@errors {404: Group not found}\n\n@endpoint DELETE /groups/{groupId}\n@desc Delete a group\n@required {groupId: any # The group ID}\n@returns(204) Group deleted\n@errors {404: Group not found}\n\n@endpoint GET /groups/{groupId}/members\n@desc List a group's members\n@required {groupId: any # The group ID}\n@optional {page_size: any # The number of records returned within a single API call, page_number: any # Current page number of returned records}\n@returns(200) Group member list returned\n@errors {404: Group not found}\n\n@endpoint POST /groups/{groupId}/members\n@desc Add group members\n@required {groupId: any # The group ID, body: any}\n@returns(201) Member added\n@errors {404: Group not found}\n\n@endpoint DELETE /groups/{groupId}/members/{memberId}\n@desc Delete a group member\n@required {groupId: any # The group ID, memberId: any # The member ID}\n@returns(204) Group member deleted\n@errors {404: Group or Group member not found}\n\n@endgroup\n\n@group h323\n@endpoint GET /h323/devices\n@desc List H.323/SIP Devices.\n@returns(200) List of H.323/SIP Devices returned.\n\n@endpoint POST /h323/devices\n@desc Create a H.323/SIP Device\n@required {body: map # H.323/SIP Device}\n@returns(201) H.323/SIP Device created\n\n@endpoint PATCH /h323/devices/{deviceId}\n@desc Update a H.323/SIP Device\n@required {deviceId: any # The device ID, body: map}\n@returns(204) H.323/SIP Device updated\n@errors {404: H.323/SIP Device not found}\n\n@endpoint DELETE /h323/devices/{deviceId}\n@desc Delete a H.323/SIP Device\n@required {deviceId: any # The device ID}\n@returns(204) H.323/SIP Device deleted\n@errors {404: H.323/SIP Device not found}\n\n@endgroup\n\n@group tracking_fields\n@endpoint GET /v2/tracking_fields\n@desc List Tracking Fields.\n@returns(200) List of Tracking Fields returned.\n\n@endpoint POST /v2/tracking_fields\n@desc Create a Tracking Field\n@required {body: map # Tracking Field}\n@returns(201) Tracking Field created\n\n@endpoint GET /v2/tracking_fields/{fieldId}\n@desc Retrieve a tracking field\n@required {fieldId: any # The Tracking Field ID}\n@returns(200) Tracking Field object returned\n@errors {404: Tracking Field not found}\n\n@endpoint PATCH /v2/tracking_fields/{fieldId}\n@desc Update a Tracking Field\n@required {fieldId: any # The Tracking Field ID, body: map}\n@returns(204) Tracking Field updated\n@errors {404: Tracking Field not found}\n\n@endpoint DELETE /v2/tracking_fields/{fieldId}\n@desc Delete a Tracking Field\n@required {fieldId: any # The Tracking Field ID}\n@returns(204) Tracking Field deleted\n@errors {404: Tracking Field not found}\n\n@endgroup\n\n@group im\n@endpoint GET /im/groups\n@desc List IM Groups\n@returns(200) List of IM Groups returned\n\n@endpoint POST /im/groups\n@desc Create an IM Group\n@required {body: any}\n@returns(201) IM Group created\n\n@endpoint GET /im/groups/{groupId}\n@desc Retrieve an IM Group\n@required {groupId: any # The group ID}\n@returns(200) IM Group object returned\n@errors {404: IM Group not found}\n\n@endpoint PATCH /im/groups/{groupId}\n@desc Update an IM Group\n@required {groupId: any # The group ID, body: any}\n@returns(204) IM Group updated\n@errors {404: IM Group not found}\n\n@endpoint DELETE /im/groups/{groupId}\n@desc Delete an IM Group\n@required {groupId: any # The group ID}\n@returns(204) IM Group deleted\n@errors {404: IM Group not found}\n\n@endpoint GET /im/groups/{groupId}/members\n@desc List an IM Group's members\n@required {groupId: any # The group ID}\n@optional {page_size: any # The number of records returned within a single API call, page_number: any # Current page number of returned records}\n@returns(200) IM Group member list returned\n@errors {404: IM Group not found}\n\n@endpoint POST /im/groups/{groupId}/members\n@desc Add IM Group members\n@required {groupId: any # The group ID, body: any}\n@returns(201) Member added\n@errors {404: IM Group not found}\n\n@endpoint DELETE /im/groups/{groupId}/members/{memberId}\n@desc Delete an IM Group member\n@required {groupId: any # The group ID, memberId: any # The member ID}\n@returns(204) IM Group member deleted\n@errors {404: IM Group or IM Group member not found}\n\n@endpoint GET /im/chat/sessions\n@desc Retrieve IM Chat sessions\n@required {from: any # Start Date, to: any # End Date}\n@optional {page_size: any # The number of records returned within a single API call, next_page_token: any # Next page token is used to paginate through large result sets. A next page token will be returned whenever the set of available results exceed the current page size. The expiration period for this token is 15 minutes.}\n@returns(200) Archived IM Chat sessions Returned\n\n@endpoint GET /im/chat/sessions/{sessionId}\n@desc Retrieve IM Chat messages\n@required {sessionId: any # IM Chat Session ID, from: any # Start Date, to: any # End Date}\n@optional {page_size: any # The number of records returned within a single API call, next_page_token: any # Next page token is used to paginate through large result sets. A next page token will be returned whenever the set of available results exceed the current page size. The expiration period for this token is 15 minutes.}\n@returns(200) Archived IM Chat messages Returned\n\n@endgroup\n\n@group users\n@endpoint GET /users/{userId}/meetings\n@desc List meetings\n@required {userId: any # The user ID or email address}\n@optional {type: any # The meeting type, page_size: any # The number of records returned within a single API call, page_number: any # Current page number of returned records}\n@returns(200) List of Meeting objects returned\n@errors {404: User not found}\n\n@endpoint POST /users/{userId}/meetings\n@desc Create a meeting\n@required {userId: any # The user ID or email address, body: any # Meeting object}\n@returns(201) Meeting Created\n@errors {404: User not found}\n\n@endgroup\n\n@group meetings\n@endpoint GET /meetings/{meetingId}\n@desc Retrieve a meeting\n@required {meetingId: any # The meeting ID}\n@returns(200) Meeting object returned\n@errors {404: Meeting not found}\n\n@endpoint PATCH /meetings/{meetingId}\n@desc Update a meeting\n@required {meetingId: any # The meeting ID, body: any # Meeting}\n@returns(204) Meeting Updated\n@errors {404: Meeting not found}\n\n@endpoint DELETE /meetings/{meetingId}\n@desc Delete a meeting\n@required {meetingId: any # The meeting ID}\n@optional {occurrence_id: any # The meeting occurrence ID}\n@returns(204) Meeting deleted\n@errors {404: Meeting not found}\n\n@endpoint PUT /meetings/{meetingId}/status\n@desc Update a meeting's status\n@required {meetingId: any # The meeting ID, body: any}\n@returns(204) Meeting updated\n@errors {404: Meeting not found}\n\n@endpoint GET /meetings/{meetingId}/invitation\n@desc Retrieve meeting invitation\n@required {meetingId: any # The meeting ID}\n@returns(200) Meeting invitation Returned\n\n@endpoint GET /meetings/{meetingId}/registrants\n@desc List a meeting's registrants\n@required {meetingId: any # The meeting ID}\n@optional {occurrence_id: any # The meeting occurrence ID, status: any # The registrant status, page_size: any # The number of records returned within a single API call, page_number: any # Current page number of returned records}\n@returns(200) Success\n@errors {404: Meeting not found}\n\n@endpoint POST /meetings/{meetingId}/registrants\n@desc Add a meeting registrant\n@required {meetingId: any # The meeting ID, body: map}\n@optional {occurrence_ids: any # Occurrence IDs. You can find these with the meeting get API. Multiple values separated by comma.}\n@returns(201) Registration created\n@errors {404: Meeting not found}\n\n@endpoint PUT /meetings/{meetingId}/registrants/status\n@desc Update a meeting registrant's status\n@required {meetingId: any # The meeting ID, body: map}\n@optional {occurrence_id: any # The meeting occurrence ID}\n@returns(204) Registrant status updated\n@errors {404: Meeting or Registrant not found}\n\n@endpoint PATCH /meetings/{meetingId}/livestream\n@desc Update a meeting live stream\n@required {meetingId: any # The meeting ID, body: map # Meeting}\n@returns(204) Meeting live stream Updated\n@errors {404: Meeting not found}\n\n@endpoint PATCH /meetings/{meetingId}/livestream/status\n@desc Update a meeting live stream status\n@required {meetingId: any # The meeting ID, body: map # Meeting}\n@returns(204) Meeting live stream Updated\n@errors {404: Meeting not found}\n\n@endgroup\n\n@group past_meetings\n@endpoint GET /past_meetings/{meetingUUID}\n@desc Retrieve past meeting details\n@required {meetingUUID: any # The meeting UUID.}\n@returns(200) Meeting detail Returned\n@errors {404: Meeting not found}\n\n@endpoint GET /past_meetings/{meetingUUID}/participants\n@desc Retrieve past meeting participants\n@required {meetingUUID: any # The meeting UUID.}\n@optional {page_size: any # The number of records returned within a single API call, next_page_token: any # Next page token is used to paginate through large result sets. A next page token will be returned whenever the set of available results exceed the current page size. The expiration period for this token is 15 minutes.}\n@returns(200) Meeting Participants Report Returned\n@errors {404: Meeting not found}\n\n@endpoint GET /past_meetings/{meetingId}/instances\n@desc List of ended meeting instances\n@required {meetingId: any # The meeting ID}\n@returns(200) List of ended meeting instances\n@errors {404: Meeting not found}\n\n@endgroup\n\n@group meetings\n@endpoint GET /meetings/{meetingId}/polls\n@desc List a meeting's polls\n@required {meetingId: any # The meeting ID}\n@returns(200) List polls of a Meeting  returned\n@errors {404: Meeting not found}\n\n@endpoint POST /meetings/{meetingId}/polls\n@desc Create a meeting's poll\n@required {meetingId: any # The meeting ID, body: any # Meeting poll object}\n@returns(201) Meeting Poll Created\n@errors {404: Meeting not found}\n\n@endpoint GET /meetings/{meetingId}/polls/{pollId}\n@desc Retrieve a meeting's poll\n@required {meetingId: any # The meeting ID, pollId: any # The poll ID}\n@returns(200) Meeting Poll object returned\n@errors {404: Meeting Poll not found}\n\n@endpoint PUT /meetings/{meetingId}/polls/{pollId}\n@desc Update a meeting's poll\n@required {meetingId: any # The meeting ID, pollId: any # The poll ID, body: any # Meeting Poll}\n@returns(204) Meeting Poll Updated\n@errors {404: Meeting Poll not found}\n\n@endpoint DELETE /meetings/{meetingId}/polls/{pollId}\n@desc Delete a meeting's Poll\n@required {meetingId: any # The meeting ID, pollId: any # The poll ID}\n@returns(204) Meeting Poll deleted\n@errors {404: Meeting Poll not found}\n\n@endgroup\n\n@group users\n@endpoint GET /users/{userId}/recordings\n@desc List all the recordings\n@required {userId: any # The user ID or email address, from: any # Start Date, to: any # End Date}\n@optional {page_size: any # The number of records returned within a single API call, next_page_token: any # Next page token is used to paginate through large result sets. A next page token will be returned whenever the set of available results exceed the current page size. The expiration period for this token is 15 minutes., mc: any # Query mc, trash: any # Query trash}\n@returns(200) List of Recording objects returned\n@errors {404: User not found}\n\n@endgroup\n\n@group meetings\n@endpoint GET /meetings/{meetingId}/recordings\n@desc Retrieve a meeting’s all recordings\n@required {meetingId: any # The meeting ID or meeting UUID. If given meeting ID, will take the last meeting instance.}\n@returns(200) Recording object returned\n@errors {404: Meeting recording not found}\n\n@endpoint DELETE /meetings/{meetingId}/recordings\n@desc Delete a meeting's recordings\n@required {meetingId: any # The meeting ID or meeting UUID. If given meeting ID, will take the last meeting instance.}\n@optional {action: any # The recording delete action}\n@returns(204) Meeting recording deleted\n@errors {404: Meeting recording not found}\n\n@endpoint DELETE /meetings/{meetingId}/recordings/{recordingId}\n@desc Delete one meeting recording file\n@required {meetingId: any # The meeting ID or meeting UUID. If given meeting ID, will take the last meeting instance., recordingId: any # The recording ID}\n@optional {action: any # The recording delete action}\n@returns(204) Meeting recording file deleted\n@errors {404: Meeting recording file not found}\n\n@endpoint PUT /meetings/{meetingId}/recordings/status\n@desc Recover a meeting's recordings\n@required {meetingId: any # The meeting ID or meeting UUID. If given meeting ID, will take the last meeting instance., body: any}\n@returns(204) Meeting recording recover\n@errors {404: Meeting recording not found}\n\n@endpoint PUT /meetings/{meetingId}/recordings/{recordingId}/status\n@desc Recover a single recording\n@required {meetingId: any # The meeting ID or meeting UUID. If given meeting ID, will take the last meeting instance., recordingId: any # The recording ID, body: any}\n@returns(204) Meeting recording recover\n@errors {404: Meeting recording not found}\n\n@endpoint GET /meetings/{meetingId}/recordings/settings\n@desc Retrieve a meeting recording's settings\n@required {meetingId: any # The meeting ID or meeting UUID. If given meeting ID, will take the last meeting instance.}\n@returns(200) Meeting recording settings returned\n@errors {404: Meeting recording not found}\n\n@endpoint PATCH /meetings/{meetingId}/recordings/settings\n@desc Update a meeting recording's settings\n@required {meetingId: any # The meeting ID or meeting UUID. If given meeting ID, will take the last meeting instance., body: map # Meeting recording Settings}\n@returns(204) Meeting recording setting's updated\n@errors {404: Meeting recording not found}\n\n@endgroup\n\n@group metrics\n@endpoint GET /metrics/meetings\n@desc List meetings\n@required {from: any # Start Date, to: any # End Date}\n@optional {type: any # The meeting type, page_size: any # The number of records returned within a single API call, next_page_token: any # Next page token is used to paginate through large result sets. A next page token will be returned whenever the set of available results exceed the current page size. The expiration period for this token is 15 minutes.}\n@returns(200) Meetings Returned\n\n@endpoint GET /metrics/meetings/{meetingId}\n@desc Retrieve meeting detail\n@required {meetingId: any # The meeting ID or meeting UUID. If given meeting ID, will take the last meeting instance.}\n@optional {type: any # The meeting type}\n@returns(200) Meeting Returned\n\n@endpoint GET /metrics/meetings/{meetingId}/participants\n@desc Retrieve meeting participants\n@required {meetingId: any # The meeting ID or meeting UUID. If given meeting ID, will take the last meeting instance.}\n@optional {type: any # The meeting type, page_size: any # The number of records returned within a single API call, next_page_token: any # Next page token is used to paginate through large result sets. A next page token will be returned whenever the set of available results exceed the current page size. The expiration period for this token is 15 minutes.}\n@returns(200) Meeting Participants Returned\n\n@endpoint GET /metrics/meetings/{meetingId}/participants/{participantId}/qos\n@desc Retrieve meeting participant QOS\n@required {meetingId: any # The meeting ID or meeting UUID. If given meeting ID, will take the last meeting instance., participantId: any # Participant ID}\n@optional {type: any # The meeting type}\n@returns(200) Meeting Participant QOS Returned\n\n@endpoint GET /metrics/meetings/{meetingId}/participants/qos\n@desc List meeting participants QOS\n@required {meetingId: any # The meeting ID or meeting UUID. If given meeting ID, will take the last meeting instance.}\n@optional {type: any # The meeting type, page_size: any # Number of items returned per page, next_page_token: any # Next page token is used to paginate through large result sets. A next page token will be returned whenever the set of available results exceed the current page size. The expiration period for this token is 15 minutes.}\n@returns(200) Meeting Participants Returned\n\n@endpoint GET /metrics/meetings/{meetingId}/participants/sharing\n@desc Retrieve sharing/recording details of meeting participant\n@required {meetingId: any # The meeting ID or meeting UUID. If given meeting ID, will take the last meeting instance.}\n@optional {type: any # The meeting type, page_size: any # The number of records returned within a single API call, next_page_token: any # Next page token is used to paginate through large result sets. A next page token will be returned whenever the set of available results exceed the current page size. The expiration period for this token is 15 minutes.}\n@returns(200) Meeting Participants Returned\n\n@endpoint GET /metrics/webinars\n@desc List webinars\n@required {from: any # Start Date, to: any # End Date}\n@optional {type: any # The webinar type, page_size: any # The number of records returned within a single API call, next_page_token: any # Next page token is used to paginate through large result sets. A next page token will be returned whenever the set of available results exceed the current page size. The expiration period for this token is 15 minutes.}\n@returns(200) Meetings Returned\n\n@endpoint GET /metrics/webinars/{webinarId}\n@desc Retrieve webinar detail\n@required {webinarId: any # The webinar ID or webinar UUID. If given webinar ID, will take the last webinar instance.}\n@optional {type: any # The webinar type}\n@returns(200) Webinar Returned\n\n@endpoint GET /metrics/webinars/{webinarId}/participants\n@desc Retrieve webinar participants\n@required {webinarId: any # The webinar ID or webinar UUID. If given webinar ID, will take the last webinar instance.}\n@optional {type: any # The webinar type, page_size: any # The number of records returned within a single API call, next_page_token: any # Next page token is used to paginate through large result sets. A next page token will be returned whenever the set of available results exceed the current page size. The expiration period for this token is 15 minutes.}\n@returns(200) Webinar Participants Returned\n\n@endpoint GET /metrics/webinars/{webinarId}/participants/{participantId}/qos\n@desc Retrieve webinar participant QOS\n@required {webinarId: any # The webinar ID or webinar UUID. If given webinar ID, will take the last webinar instance., participantId: any # Participant ID}\n@optional {type: any # The webinar type}\n@returns(200) Webinar Participant QOS Returned\n\n@endpoint GET /metrics/webinars/{webinarId}/participants/qos\n@desc List webinar participant QOS\n@required {webinarId: any # The webinar ID or webinar UUID. If given webinar ID, will take the last webinar instance.}\n@optional {type: any # The webinar type, page_size: any # Number of items returned per page, next_page_token: any # Next page token is used to paginate through large result sets. A next page token will be returned whenever the set of available results exceed the current page size. The expiration period for this token is 15 minutes.}\n@returns(200) Webinar Participants Returned\n\n@endpoint GET /metrics/webinars/{webinarId}/participants/sharing\n@desc Retrieve sharing/recording details of webinar participant\n@required {webinarId: any # The webinar ID or webinar UUID. If given webinar ID, will take the last webinar instance.}\n@optional {type: any # The webinar type, page_size: any # The number of records returned within a single API call, next_page_token: any # Next page token is used to paginate through large result sets. A next page token will be returned whenever the set of available results exceed the current page size. The expiration period for this token is 15 minutes.}\n@returns(200) Webinar Participants Returned\n\n@endpoint GET /metrics/zoomrooms\n@desc List Zoom Rooms\n@optional {page_size: any # The number of records returned within a single API call, page_number: any # Current page number of returned records}\n@returns(200) List of Zoom Rooms returned\n\n@endpoint GET /metrics/zoomrooms/{zoomroomId}\n@desc Retrieve Zoom Room\n@required {zoomroomId: any # The Zoom Room ID, from: any # Start Date, to: any # End Date}\n@optional {page_size: any # The number of records returned within a single API call, page_number: any # Current page number of returned records}\n@returns(200) Zoom Room returned\n\n@endpoint GET /metrics/crc\n@desc Retrieve CRC Port Usage\n@required {from: any # Start Date, to: any # End Date}\n@returns(200) CRC Usage returned\n\n@endpoint GET /metrics/im\n@desc Retrieve IM\n@required {from: any # Start Date, to: any # End Date}\n@optional {page_size: any # The number of records returned within a single API call, next_page_token: any # Next page token is used to paginate through large result sets. A next page token will be returned whenever the set of available results exceed the current page size. The expiration period for this token is 15 minutes.}\n@returns(200) IM setails returned\n\n@endgroup\n\n@group report\n@endpoint GET /report/daily\n@desc Retrieve daily report\n@optional {year: any # Year for this report, month: any # Month for this report}\n@returns(200) Daily Report Returned\n\n@endpoint GET /report/users\n@desc Retrieve hosts report\n@required {from: any # Start Date, to: any # End Date}\n@optional {type: any # Active hosts or inactive hosts, page_size: any # The number of records returned within a single API call, page_number: any # Current page number of returned records}\n@returns(200) Active/Inactive Hosts Report Returned\n\n@endpoint GET /report/users/{userId}/meetings\n@desc Retrieve meetings report\n@required {userId: any # The user ID or email address, from: any # Start Date, to: any # End Date}\n@optional {page_size: any # The number of records returned within a single API call, next_page_token: any # Next page token is used to paginate through large result sets. A next page token will be returned whenever the set of available results exceed the current page size. The expiration period for this token is 15 minutes.}\n@returns(200) Active/Inactive Hosts Report Returned\n@errors {404: User not found}\n\n@endpoint GET /report/meetings/{meetingId}\n@desc Retrieve meeting details report\n@required {meetingId: any # The meeting ID or meeting UUID. If given meeting ID, will take the last meeting instance.}\n@returns(200) Meeting detail Returned\n@errors {404: Meeting not found}\n\n@endpoint GET /report/meetings/{meetingId}/participants\n@desc Retrieve meeting participants report\n@required {meetingId: any # The meeting ID or meeting UUID. If given meeting ID, will take the last meeting instance.}\n@optional {page_size: any # The number of records returned within a single API call, next_page_token: any # Next page token is used to paginate through large result sets. A next page token will be returned whenever the set of available results exceed the current page size. The expiration period for this token is 15 minutes.}\n@returns(200) Meeting Participants Report Returned\n@errors {404: Meeting not found}\n\n@endpoint GET /report/meetings/{meetingId}/polls\n@desc Retrieve meeting polls report\n@required {meetingId: any # The meeting ID or meeting UUID. If given meeting ID, will take the last meeting instance.}\n@returns(200) Meeting Polls Report Returned\n@errors {404: Meeting not found}\n\n@endpoint GET /report/webinars/{webinarId}\n@desc Retrieve webinar details report\n@required {webinarId: any # The webinar ID or webinar UUID. If given webinar ID, will take the last webinar instance.}\n@returns(200) Webinar detail Returned\n@errors {404: Webinar not found}\n\n@endpoint GET /report/webinars/{webinarId}/participants\n@desc Retrieve webinar participants report\n@required {webinarId: any # The webinar ID or webinar UUID. If given webinar ID, will take the last webinar instance.}\n@optional {page_size: any # The number of records returned within a single API call, next_page_token: any # Next page token is used to paginate through large result sets. A next page token will be returned whenever the set of available results exceed the current page size. The expiration period for this token is 15 minutes.}\n@returns(200) Meeting Participants Report Returned\n@errors {404: Webinar not found}\n\n@endpoint GET /report/webinars/{webinarId}/polls\n@desc Retrieve webinar polls report\n@required {webinarId: any # The webinar ID or webinar UUID. If given webinar ID, will take the last webinar instance.}\n@returns(200) Webinar Polls Report Returned\n@errors {404: Webinar not found}\n\n@endpoint GET /report/webinars/{webinarId}/qa\n@desc Retrieve webinar Q&A report\n@required {webinarId: any # The webinar ID or webinar UUID. If given webinar ID, will take the last webinar instance.}\n@returns(200) Webinar Q&A Report Returned\n@errors {404: Webinar not found}\n\n@endpoint GET /report/telephone\n@desc Retrieve telephone report\n@required {from: any # Start Date, to: any # End Date}\n@optional {type: any # Audio type, page_size: any # The number of records returned within a single API call, page_number: any # Current page number of returned records}\n@returns(200) Telephone Report Returned\n\n@endpoint GET /report/cloud_recording\n@desc Retrieve cloud recording usage report\n@required {from: any # Start Date, to: any # End Date}\n@returns(200) Cloud Recording Report Returned\n@errors {300: Only provide report in recent 6 months}\n\n@endgroup\n\n@group tsp\n@endpoint GET /tsp\n@desc Retrieve account's TSP information\n@returns(200) TSP account detail returned\n\n@endpoint PATCH /tsp\n@desc Update account's TSP information\n@required {body: any # TSP Account}\n@returns(204) TSP Account updated\n\n@endgroup\n\n@group users\n@endpoint GET /users\n@desc List Users\n@optional {status: any # User status, page_size: any # The number of records returned within a single API call, page_number: any # Current page number of returned records}\n@returns(200) User list returned\n\n@endpoint POST /users\n@desc Create a user\n@required {body: map # User}\n@returns(201) User Created\n@errors {409: User with that email already exists}\n\n@endpoint GET /users/{userId}\n@desc Retrieve a user\n@required {userId: any # The user ID or email address}\n@optional {login_type: any}\n@returns(200) User object returned\n@errors {404: User not found}\n\n@endpoint PATCH /users/{userId}\n@desc Update a user\n@required {userId: any # The user ID or email address, body: map # User}\n@returns(204) User updated\n@errors {404: User not found}\n\n@endpoint DELETE /users/{userId}\n@desc Delete a user\n@required {userId: any # The user ID or email address}\n@optional {action: any # Delete action type, transfer_email: any # Transfer email, transfer_meeting: any # Transfer meeting, transfer_webinar: any # Transfer webinar, transfer_recording: any # Transfer recording}\n@returns(204) User deleted\n@errors {404: User not found}\n\n@endpoint GET /users/{userId}/assistants\n@desc List a user's assistants\n@required {userId: any # The user ID or email address}\n@returns(200) Success\n@errors {404: User not found}\n\n@endpoint POST /users/{userId}/assistants\n@desc Add assistants\n@required {userId: any # The user ID or email address, body: map # User assistant}\n@returns(201) Assitant Added\n@errors {404: User not found}\n\n@endpoint DELETE /users/{userId}/assistants\n@desc Delete a user's assistants\n@required {userId: any # The user ID or email address}\n@returns(204) Assitants deleted\n@errors {404: User not found}\n\n@endpoint DELETE /users/{userId}/assistants/{assistantId}\n@desc Delete a user's assistant\n@required {userId: any # The user ID or email address, assistantId: any # Assistant's ID}\n@returns(204) Assitant deleted\n@errors {404: User or Assistant not found}\n\n@endpoint GET /users/{userId}/schedulers\n@desc List a user's schedulers\n@required {userId: any # The user ID or email address}\n@returns(200) Success\n@errors {404: User not found}\n\n@endpoint DELETE /users/{userId}/schedulers\n@desc Delete a user's schedulers\n@required {userId: any # The user ID or email address}\n@returns(204) Schedulers deleted.\n@errors {404: User not found}\n\n@endpoint DELETE /users/{userId}/schedulers/{schedulerId}\n@desc Delete a user's scheduler\n@required {userId: any # The user ID or email address, schedulerId: any # Scheduler's ID}\n@returns(204) Scheduler deleted.\n@errors {404: User or Scheduler not found}\n\n@endpoint POST /users/{userId}/picture\n@desc Upload a user's picture\n@required {userId: any # The user ID or email address, pic_file: any # User picture file, must be a jpg/jpeg file}\n@returns(201) Picture Uploaded\n@errors {404: User not found}\n\n@endpoint GET /users/{userId}/settings\n@desc Retrieve a user's settings\n@required {userId: any # The user ID or email address}\n@optional {login_type: any}\n@returns(200) User settings returned\n@errors {404: User not found}\n\n@endpoint PATCH /users/{userId}/settings\n@desc Update a user's settings\n@required {userId: any # The user ID or email address, body: map # User Settings}\n@returns(204) User setting's updated\n@errors {404: User not found}\n\n@endpoint PUT /users/{userId}/status\n@desc Update a user's status\n@required {userId: any # The user ID or email address, body: map # User status}\n@returns(204) Status updated\n@errors {404: User not found}\n\n@endpoint PUT /users/{userId}/password\n@desc Update a user's password\n@required {userId: any # The user ID or email address, body: map # User password}\n@returns(204) Password updated\n@errors {404: User not found}\n\n@endpoint GET /users/{userId}/permissions\n@desc Retrieve a user's permissions\n@required {userId: any # The user ID or email address}\n@returns(200) User permissions returned\n@errors {404: User not found}\n\n@endpoint GET /users/{userId}/pac\n@desc List user's PAC accounts\n@required {userId: any # The user ID or email address}\n@returns(200) PAC Account list returned\n@errors {404: User not found}\n\n@endpoint GET /users/{userId}/tsp\n@desc List user's TSP accounts\n@required {userId: any # The user ID or email address}\n@returns(200) TSP Account list returned\n@errors {404: User not found}\n\n@endpoint POST /users/{userId}/tsp\n@desc Add a user's TSP account\n@required {userId: any # The user ID or email address, body: map # TSP Account}\n@returns(201) TSP Account added\n\n@endpoint GET /users/{userId}/tsp/{tspId}\n@desc Retrieve a user's TSP account\n@required {userId: any # The user ID or email address, tspId: any # TSP account index}\n@returns(200) TSP Account returned\n\n@endpoint PATCH /users/{userId}/tsp/{tspId}\n@desc Update a TSP account\n@required {userId: any # The user ID or email address, tspId: any # TSP account index, body: map # TSP Account}\n@returns(204) TSP Account updated\n\n@endpoint DELETE /users/{userId}/tsp/{tspId}\n@desc Delete a user's TSP account\n@required {userId: any # The user ID or email address, tspId: any # TSP account index}\n@returns(204) TSP Account deleted\n\n@endpoint GET /users/{userId}/token\n@desc Retrieve a user's token\n@required {userId: any # The user ID or email address}\n@optional {type: any # User token type}\n@returns(200) Token returned\n@errors {404: User not found}\n\n@endpoint DELETE /users/{userId}/token\n@desc Revoke a user's SSO token\n@required {userId: any # The user ID or email address}\n@returns(204) Token deleted\n@errors {404: User not found}\n\n@endpoint PUT /users/{userId}/email\n@desc Update a user's email\n@required {userId: any # The user ID or email address, body: map # User email}\n@returns(204) email updated\n@errors {404: User not found}\n\n@endpoint GET /users/zpk\n@desc Verify a user's zpk (Deprecated\n@required {zpk: any # User zpk}\n@returns(200) Success\n\n@endpoint GET /users/email\n@desc Check a user's email\n@required {email: any # Zoom work email}\n@returns(200) Success\n\n@endpoint GET /users/vanity_name\n@desc Check a user's personal meeting room name\n@required {vanity_name: any # Personal meeting room name}\n@returns(200) Success\n\n@endpoint GET /users/{userId}/webinars\n@desc List webinars\n@required {userId: any # The user ID or email address}\n@optional {page_size: any # The number of records returned within a single API call, page_number: any # Current page number of returned records}\n@returns(200) List of Webinar objects returned\n@errors {404: User not found}\n\n@endpoint POST /users/{userId}/webinars\n@desc Create a webinar\n@required {userId: any # The user ID or email address, body: map # User}\n@returns(201) Webinar Created\n@errors {404: User not found}\n\n@endgroup\n\n@group webinars\n@endpoint GET /webinars/{webinarId}\n@desc Retrieve a webinar\n@required {webinarId: any # The webinar ID}\n@returns(200) Webinar object returned\n@errors {404: Webinar not found}\n\n@endpoint PATCH /webinars/{webinarId}\n@desc Update a webinar\n@required {webinarId: any # The webinar ID, body: map # Webinar}\n@returns(204) Webinar Updated\n@errors {404: Webinar not found}\n\n@endpoint DELETE /webinars/{webinarId}\n@desc Delete a webinar\n@required {webinarId: any # The webinar ID}\n@optional {occurrence_id: any # The meeting occurrence ID}\n@returns(204) Webinar deleted\n@errors {404: Webinar not found}\n\n@endpoint PUT /webinars/{webinarId}/status\n@desc Update a webinar's status\n@required {webinarId: any # The webinar ID, body: any}\n@returns(204) Webinar updated\n@errors {404: Webinar not found}\n\n@endpoint GET /webinars/{webinarId}/panelists\n@desc List a webinar's panelists\n@required {webinarId: any # The webinar ID}\n@returns(200) Success\n@errors {404: Webinar not found}\n\n@endpoint POST /webinars/{webinarId}/panelists\n@desc Add a webinar panelist\n@required {webinarId: any # The webinar ID, body: map}\n@returns(201) Panelist created\n@errors {404: Webinar not found}\n\n@endpoint DELETE /webinars/{webinarId}/panelists\n@desc Remove a webinar's panelists\n@required {webinarId: any # The webinar ID}\n@returns(204) Panelists removed\n@errors {404: Webinar not found}\n\n@endpoint DELETE /webinars/{webinarId}/panelists/{panelistId}\n@desc Remove a webinar panelist\n@required {webinarId: any # The webinar ID, panelistId: any # The panelist ID}\n@returns(204) Panelists removed\n@errors {404: Webinar or Panelist not found}\n\n@endpoint GET /webinars/{webinarId}/registrants\n@desc List a webinar's registrants\n@required {webinarId: any # The webinar ID}\n@optional {occurrence_id: any # The meeting occurrence ID, status: any # The registrant status, page_size: any # The number of records returned within a single API call, page_number: any # Current page number of returned records}\n@returns(200) Success\n@errors {404: Webinar not found}\n\n@endpoint POST /webinars/{webinarId}/registrants\n@desc Add a webinar registrant\n@required {webinarId: any # The webinar ID, body: map}\n@optional {occurrence_ids: any # Occurrence IDs, could get this value from Webinar Get API. Multiple value separated by comma.}\n@returns(201) Registration created\n@errors {404: Webinar not found}\n\n@endpoint PUT /webinars/{webinarId}/registrants/status\n@desc Update a webinar registrant's status\n@required {webinarId: any # The webinar ID, body: any}\n@optional {occurrence_id: any # The meeting occurrence ID}\n@returns(204) Registrant status updated\n@errors {404: Webinar or Registrant not found}\n\n@endgroup\n\n@group past_webinars\n@endpoint GET /past_webinars/{webinarId}/instances\n@desc List of ended webinar instances\n@required {webinarId: any # The webinar ID}\n@returns(200) List of ended webinar instances\n@errors {404: Webinar not found}\n\n@endgroup\n\n@group webinars\n@endpoint GET /webinars/{webinarId}/polls\n@desc List a webinar's polls\n@required {webinarId: any # The webinar ID}\n@returns(200) List polls of a Webinar  returned\n@errors {404: Webinar not found}\n\n@endpoint POST /webinars/{webinarId}/polls\n@desc Create a webinar's poll\n@required {webinarId: any # The webinar ID, body: any # Webinar poll object}\n@returns(201) Webinar Poll Created\n@errors {404: Webinar not found}\n\n@endpoint GET /webinars/{webinarId}/polls/{pollId}\n@desc Retrieve a webinar's poll\n@required {webinarId: any # The webinar ID, pollId: any # The poll ID}\n@returns(200) Webinar Poll object returned\n@errors {404: Webinar Poll not found}\n\n@endpoint PUT /webinars/{webinarId}/polls/{pollId}\n@desc Update a webinar's poll\n@required {webinarId: any # The webinar ID, pollId: any # The poll ID, body: any # Webinar Poll}\n@returns(204) Webinar Poll Updated\n@errors {404: Webinar Poll not found}\n\n@endpoint DELETE /webinars/{webinarId}/polls/{pollId}\n@desc Delete a webinar's Poll\n@required {webinarId: any # The webinar ID, pollId: any # The poll ID}\n@returns(204) Webinar Poll deleted\n@errors {404: Webinar Poll not found}\n\n@endgroup\n\n@group webhooks\n@endpoint PATCH /webhooks/options\n@desc Switch webhook version\n@required {body: any}\n@returns(204) Webhook Subscribe version update\n@errors {404: Webhook Subscribe not found}\n\n@endpoint GET /webhooks\n@desc List webhooks\n@returns(200) List of Webhook objects returned\n@errors {404: Webhook not found}\n\n@endpoint POST /webhooks\n@desc Create a webhook\n@required {body: map # Webhook}\n@returns(201) Webhook Created\n@errors {404: Account not found}\n\n@endpoint GET /webhooks/{webhookId}\n@desc Retrieve a webhook\n@required {webhookId: any # The webhook ID}\n@returns(200) Webhook object returned\n@errors {404: Webinar not found}\n\n@endpoint PATCH /webhooks/{webhookId}\n@desc Update a webhook\n@required {webhookId: any # The webhook ID, body: map # Webhook}\n@returns(204) Webhook Updated\n@errors {404: Webhook not found}\n\n@endpoint DELETE /webhooks/{webhookId}\n@desc Delete a webhook\n@required {webhookId: any # The webhook ID}\n@returns(204) Webhook deleted\n@errors {404: Webhook not found}\n\n@endgroup\n\n@end\n"}