ZoomMeetingAPISpec.json

{"openapi":"3.0.0","info":{"contact":{"name":"Zoom Developers","url":"https://developer.zoom.us/"},"description":"The Zoom Meeting API lets developers access information from Zoom. You can use this API to build private services or public applications on the [Zoom App Marketplace](http://marketplace.zoom.us). To learn how to get your credentials and create private/public applications, see our [OAuth](https://developers.zoom.us/docs/integrations/oauth/) documentation. \n\nAll endpoints are available via `https` and are located at `api.zoom.us/v2/`. For example, to list all of an account's users, use the `https://api.zoom.us/v2/users/` endpoint.","termsOfService":"https://zoom.us/docs/en-us/zoom_api_license_and_tou.html","title":"Zoom Meeting API","version":"2.0.0"},"servers":[{"url":"https://api.zoom.us/v2"}],"paths":{"/accounts/{accountId}/managed_domains":{"get":{"parameters":[{"description":"The account's ID. For the Master account, pass the `me` value for this parameter.","in":"path","name":"accountId","required":true,"schema":{"type":"string","example":"q6gBJVO5TzexKYTb_I2rpg"}}],"responses":{"200":{"content":{"application/json":{"schema":{"description":"Information about the account's managed domains.","properties":{"domains":{"description":"Information about the managed domains.","items":{"properties":{"domain":{"description":"The domain's name.","type":"string","example":"example.com"},"status":{"description":"The domain's status.","type":"string","example":"verified"}},"type":"object"},"type":"array"},"total_records":{"description":"The total number of records returned.","type":"integer","example":1}},"type":"object"}}},"description":"**HTTP Status Code:** `200` <br>\nAccount's managed domains returned. \n\n**Error Code:** `200` <br>\nOnly available for paid accounts."},"404":{"description":"**HTTP Status Code:** `404` <br>\nNot Found \n\n**Error Code:** `2001` <br>\nAccount does not exist: $accountId"}},"security":[{"OAuth":[]}],"tags":["Accounts"],"description":"Use this API to get an account's [managed domains](https://support.zoom.us/hc/en-us/articles/203395207). To get the master account's managed domains, pass the `me` value for the `accountId` path parameter. \n\n **Scopes:** `account:read:admin` <br> **[Rate Limit Label](https://developers.zoom.us/docs/api/rest/rate-limits/):** `Light` \n\n **Prerequisites:** \n* A Pro or a higher paid account with the Master account option enabled.","operationId":"accountManagedDomain","summary":"Get account's managed domains"}},"/accounts/{accountId}/settings":{"get":{"parameters":[{"description":"The account's ID. For the Master account, pass the `me` value for this parameter.","in":"path","name":"accountId","required":true,"schema":{"type":"string","example":"me"}},{"allowEmptyValue":true,"description":"Optional query parameters: \n* `meeting_authentication` — Use this query parameter to view the [meeting authentication settings](https://support.zoom.us/hc/en-us/articles/360037117472-Authentication-Profiles-for-Meetings-and-Webinars) applied to the user's account. \n* `recording_authentication` — Use this query parameter to view the [recording authentication settings](https://support.zoom.us/hc/en-us/articles/360037756671-Authentication-Profiles-for-Cloud-Recordings) applied to the user's account. \n* `security` — Use this query parameter to view the account's security settings. For example, password requirements for user login or two-factor authentication. \n* `meeting_security` — Use this query parameter to view the meeting security settings applied to the user's account.","in":"query","name":"option","schema":{"enum":["meeting_authentication","recording_authentication","meeting_security","security"],"type":"string","example":"security"}},{"description":"The name of the field by which to filter the response. For example, if you provide the `host_video` value for this field, you will get a response similar to the following: \n\n `{ \"schedule_meeting\": { \"host_video\": false } }` \n\n To use multiple values, comma-separate each value. For example: `host_video,participant_video`","in":"query","name":"custom_query_fields","schema":{"type":"string","example":"in_meeting"}}],"responses":{"200":{"content":{"application/json":{"schema":{"oneOf":[{"properties":{"security":{"description":"[Security settings](https://support.zoom.us/hc/en-us/articles/360034675592-Advanced-security-settings#h_bf8a25f6-9a66-447a-befd-f02ed3404f89) of an Account.","properties":{"admin_change_name_pic":{"type":"boolean","deprecated":true,"description":"Whether to only allow account administrators to change a user's picture.","example":true},"admin_change_user_info":{"type":"boolean","description":"Whether to only allow account administrators to change a user's information.","example":true},"user_modifiable_info_by_admin":{"type":"array","description":"If the `admin_change_user_info` value is `true`, the list of the types of user information that only the account administrators can modify: \n* `name` \n* `profile_picture` \n* `sign_in_email` \n* `host_key`","items":{"type":"string","enum":["name","profile_picture","sign_in_email","host_key"],"example":["name","host_key","sign_in_email"]}},"signin_with_sso":{"type":"object","properties":{"enable":{"description":"Whether to allow users to sign in with single sign-on (SSO). If enabling this, configure your account's SSO settings. This lets users sign in with SSO through your company's vanity URL.","type":"boolean","example":true},"require_sso_for_domains":{"description":"Whether to require users to sign in with single sign-on (SSO) if their e-mail address belongs to one of the `domains`.","type":"boolean","example":true},"domains":{"type":"array","description":"Users on these domains must sign in with single sign-on (SSO). ","example":["test.com","example.us"],"items":{"type":"string","example":"test.com"}},"sso_bypass_users":{"type":"array","description":"The users can bypass SSO sign-in.","items":{"type":"object","properties":{"id":{"description":"The user ID.","type":"string","example":"21212_aefwef32233"},"email":{"description":"The user email.","type":"string","example":"123@test.com"}}}}},"description":"Allow users to sign in with single sign-on (SSO). "},"hide_billing_info":{"description":"Hide billing information.","type":"boolean","example":true},"import_photos_from_devices":{"description":"Allow users to import photos from a photo library on a  device.","type":"boolean","example":true},"password_requirement":{"description":"This object refers to the [enhanced password rules](https://support.zoom.us/hc/en-us/articles/360034675592-Advanced-security-settings#h_bf8a25f6-9a66-447a-befd-f02ed3404f89) that allows Zoom account admins and owners to apply extra requirements to the users' Zoom login password.","properties":{"consecutive_characters_length":{"description":"\nSpecify the max length of consecutive characters(abcde...) that can be used in a password.\nIf you set the value of this field to `0`, no restriction will be applied on consecutive characters. \n\nIf you would like to set this restriction, you can specify a number between 4 and 8 that define the maximum allowed length for consecutive characters in a password.\n\nThe max allowed length will be `n-1` where `n` refers to the value you provide for this field.  For instance, if you provide `4` as the value, there can only be a maximum of `3` consecutive characters in a password(example: abc1x@8fdh).","type":"integer","example":8},"have_special_character":{"description":"If the value of this field is set to `true`, the password must have at least one special character(!, @, #...).","type":"boolean","example":true},"minimum_password_length":{"description":"Specify a minimum length for the password. The password length can be from a minimum of 9 characters, up to 14 characters. If you provide `0` as the value of this field, this field will be disabled and not be used and the basic password length requirement (minimum of 8 characters) will be applied for the requirement.","maximum":14,"minimum":8,"type":"integer","example":8},"weak_enhance_detection":{"description":"If the value of this field is set to `true`, user passwords will have to pass detection through a weak password dictionary in case hackers use simple passwords to sign in to your users' accounts.","type":"boolean","example":true}},"type":"object"},"sign_again_period_for_inactivity_on_client":{"description":"Settings for User Sign In interval requirements after a period of inactivity. If enabled, this setting forces automatic logout of users in Zoom Client app after a set amount of time. <br>\n\nIf this setting is disabled, the value of this field will be `0`. If the setting is enabled, the value of this field will indicate the **period of inactivity** in minutes after which, an inactive user will be automatically logged out of the Zoom Client. The value for the period of inactivity can be one of the following:<br>\n\n`5`: 5 minutes<br>\n`10`: 10 minutes<br>\n`15`: 15 minutes<br>\n`30`: 30 minutes<br>\n`45`: 45 minutes<br>\n`60`: 60 minutes<br>\n`90`: 90 minutes<br>\n`120`: 120 minutes\n","type":"integer","example":45},"sign_again_period_for_inactivity_on_web":{"description":"Settings for User Sign In interval requirements after a period of inactivity. If enabled, this setting forces automatic logout of users in Zoom Web Portal after a set amount of time. <br>\n\nIf this setting is disabled, the value of this field will be `0`. If the setting is enabled, the value of this field will indicate the **period of inactivity** in minutes after which, an inactive user will be automatically logged out of the Zoom Web Portal. The value for the period of inactivity can be one of the following:<br>\n\n`5`: 5 minutes<br>\n`10`: 10 minutes<br>\n`15`: 15 minutes<br>\n`30`: 30 minutes<br>\n`60`: 60 minutes<br>\n`120`: 120 minutes\n\n    \n\n","type":"integer","example":60},"sign_in_with_two_factor_auth":{"description":"Settings for 2FA( [two factor authentication](https://support.zoom.us/hc/en-us/articles/360038247071) ). The value can be one of the following:\n`all`: Two factor authentication will be enabled for all users in the account.<br>\n`none`: Two factor authentication is disabled.<br>\n`group`: Two factor authentication will be enabled for users belonging to specific groups. If 2FA is enabled for certain groups, the group IDs of the group(s) will be provided in the `sign_in_with_two_factor_auth_groups` field.<br>\n`role`: Two factor authentication will be enabled only for users assigned with specific roles in the account. If 2FA is enabled for specific roles, the role IDs will be provided in the\n`sign_in_with_two_factor_auth_roles` field.\n","enum":["all","group","role","none"],"type":"string","example":"group"},"sign_in_with_two_factor_auth_groups":{"description":"This field contains group IDs of groups that have 2FA enabled. This field is only returned if the value of `sign_in_with_two_factor_auth` is `group`","items":{"type":"string","example":"group"},"type":"array"},"sign_in_with_two_factor_auth_roles":{"description":"This field contains role IDs of roles that have 2FA enabled. This field is only returned if the value of `sign_in_with_two_factor_auth` is `role`.","items":{"type":"string","example":"role"},"type":"array"}},"type":"object"},"audio_conferencing":{"description":"The account's audio conference settings.","properties":{"toll_free_and_fee_based_toll_call":{"description":"The account's [**Toll-free and Fee-based Toll Call**](https://support.zoom.us/hc/en-us/articles/360060950711-Enabling-Toll-free-and-Fee-based-Toll-Call#h_01F51680NJ7YHZDXGJNSKDGM2P) settings.","properties":{"allow_webinar_attendees_dial":{"description":"Whether webinar attendees can dial in through the account's **Toll-free and Fee-based Toll Call** phone numbers. This feature is only available in version 5.2.2 and higher.","type":"boolean","example":true},"enable":{"description":"Whether the account has the [**Toll-free and Fee-based Toll Call**](https://support.zoom.us/hc/en-us/articles/360060950711-Enabling-Toll-free-and-Fee-based-Toll-Call#h_01F51680NJ7YHZDXGJNSKDGM2P) setting enabled.","type":"boolean","example":true},"numbers":{"description":"The account's **Toll-free and Fee-based Toll Call** phone number information.","items":{"properties":{"code":{"description":"The phone number's [E.164 country calling code](https://en.wikipedia.org/wiki/List_of_country_calling_codes).","type":"string","example":"86"},"country_code":{"description":"The phone number's [country code](https://marketplace.zoom.us/docs/api-reference/other-references/abbreviation-lists#countries).","type":"string","example":"CN"},"country_name":{"description":"The country name.","type":"string","example":"China"},"display_number":{"description":"The phone number's display number.","maxLength":30,"type":"string","example":"+86 777 777 77"},"number":{"description":"The phone number.","maxLength":30,"type":"string","example":"777 777 77"}},"type":"object"},"maxItems":100,"type":"array"}},"type":"object"}},"type":"object"},"chat":{"description":"The account's chat settings.","properties":{"allow_bots_chat":{"description":"Whether chatbots added to chats and channels can read and write messages.","type":"boolean","example":true},"share_files":{"type":"object","description":"Users can share files in chats and channels.","properties":{"enable":{"type":"boolean","description":"Allow users of this account to send and receive files in chats and channels. When disabled, users can still take and share screenshots.","example":true},"share_option":{"type":"string","description":"Allow users of this account to send and receive files in chats and channels. When disabled, users can still take and share screenshots.","enum":["anyone","account","organization"],"x-enum-descriptions":["Anyone (internal and external contacts)","In the same account","In the same organization"],"example":true},"restrictions":{"type":"object","description":"User restrictions for sharing files in chats and channels.","properties":{"only_allow_specific_file_types":{"type":"boolean","description":"Only allow specified file types.","example":true},"file_type_restrictions":{"type":"array","items":{"type":"string","description":"Specified file type.","example":".gz","enum":[".gz",".rar",".zip",".xls",".xlsx",".json",".png",".pptx",".ppt",".7z",".xmind",".pdf",".pps",".txt",".docx",".doc"]}},"file_type_restrictions_for_external":{"type":"array","items":{"type":"string","description":"Specified file type.","example":".gz","enum":[".gz",".rar",".zip",".xls",".xlsx",".json",".png",".pptx",".ppt",".7z",".xmind",".pdf",".pps",".txt",".docx",".doc"]}},"maximum_file_size":{"type":"boolean","description":"Whether to restrict the file size","example":true},"file_size_restrictions":{"type":"integer","description":"Maximum file size","example":100,"enum":[50,100,200,300,400,500]},"file_size_restrictions_for_external":{"type":"integer","description":"Maximum file size for external users","example":100,"enum":[50,100,200,300,400,500]}}}}},"chat_emojis":{"type":"object","description":"Chat emojis.","properties":{"enable":{"type":"boolean","description":"Allow users to use the emoji library in direct messages or group conversations. Choose between allowing users to use any emoji in the library, or choose to allow only pre-selected emojis. If the setting is disabled, users can still use keyboard shortcuts to add emojis. Users can change their emoji skin tone in Settings.","example":true},"emojis_option":{"type":"string","example":"all","enum":["all","selected"],"x-enum-descriptions":["All emojis","Selected emojis"]}}},"record_voice_messages":{"description":"Allow users to record voice messages that can be sent in direct messages or group conversations.","type":"boolean","example":true},"record_video_messages":{"description":"Allow users to record video messages that can be sent in direct messages or group conversations. If the file share setting is disabled, they will not be able to record and send video messages.","type":"boolean","example":true},"screen_capture":{"description":"Allow users to take and send screenshots in direct messages or group conversations.","type":"boolean","example":true},"create_public_channels":{"type":"boolean","description":"Allow users to create public channels.","example":true},"create_private_channels":{"type":"boolean","description":"Allow users to create private channels.","example":true},"share_links_in_chat":{"type":"boolean","description":"Share links to messages and channels in Team Chat.","example":true},"schedule_meetings_in_chat":{"type":"boolean","description":"Schedule a meeting from chat or channel.","example":true},"set_retention_period_in_cloud":{"type":"object","description":"Set retention period for messages and files in Zoom's cloud.","properties":{"enable":{"type":"boolean","description":"By default, messages and files are stored in Zoom's cloud. Enable this setting to specify when they are deleted. When retention is disabled, messages sent by offline users can be received within 7 days before they are deleted.","example":true},"retention_period_of_direct_messages_and_group_conversation":{"type":"string","description":"Delete direct messages and group conversations after retention period. 'y' - year, 'm' - month, 'd' - day","example":"2m"},"retention_period_of_channels":{"type":"string","description":"Delete data in channels after retention period. 'y' - year, 'm' - month, 'd' - day","example":"2m"}}},"set_retention_period_in_local":{"type":"object","description":"Store messages on local devices (excluding personal channel messages).","properties":{"enable":{"type":"boolean","description":"Specify how long your messages are saved on local devices. If this setting is disabled, messages are never deleted locally.","example":true},"retention_period_of_direct_messages_and_group_conversation":{"type":"string","description":"Delete direct messages and group conversations after retention period. 'y' - year, 'm' - month, 'd' - day","example":"2m"},"retention_period_of_channels":{"type":"string","description":"Delete data in channels after retention period. 'y' - year, 'm' - month, 'd' - day","example":"2m"}}},"allow_users_to_add_contacts":{"description":"Allow users to add contacts.","type":"object","properties":{"enable":{"description":"By disabling this setting, users will not be able to add contacts.","type":"boolean","example":true},"selected_option":{"description":"The type of allowing users to add contacts. \n* 1 — Anyone (internal and external contacts). \n* 2 — In the same organization. \n* 3 — In the same organization and specified domains. \n* 4 — In the same organization and specified users.","enum":[1,2,3,4],"type":"integer","example":4},"user_email_addresses":{"description":"The domains or emails (internal or external). \n* When the `selected_option` field value is `3`, the value is internal or external domains. Use a comma to separate multiple domains. Example: company.com. \n* When the `selected_option` field value is `4`, the value is internal or external email addresses. Use a comma to separate multiple emails.","type":"string","example":"123@test.com"}}},"allow_users_to_chat_with_others":{"description":"Allow users to chat with others.","type":"object","properties":{"enable":{"description":"If you select 'In the same organization', users may still be able to chat with external users if they are added to channels or group chats with external users.","type":"boolean","example":true},"selected_option":{"description":"The type of allowing users to add contacts. \n* 1 — Anyone (internal and external contacts). \n* 2 — In the same organization. \n* 3 — In the same organization and specified domains. \n* 4 — In the same organization and specified users.","enum":[1,2,3,4],"type":"integer","example":4},"user_email_addresses":{"description":"The domains or emails (internal or external). \n* When the `selected_option` field value is `3`, the value is internal or external domains. Use a comma to separate multiple domains. Example: company.com. \n* When the `selected_option` field value is `4`, the value is internal or external email addresses. Use a comma to separate multiple emails.","type":"string","example":"123@test.com"}}},"chat_etiquette_tool":{"description":"Information about the **Chat Etiquette Tool**.","properties":{"enable":{"description":"Whether to enable the **Chat Etiquette Tool**.","type":"boolean","example":true},"policies":{"description":"Information about the defined **Chat Etiquette Tool** policies.","items":{"properties":{"description":{"description":"The policy's description.","type":"string","example":"The policy's description"},"id":{"description":"The policy ID.","type":"string","example":"afwef342tr2qfwrg"},"is_locked":{"description":"Whether the policy is locked by an account-level user. When it is locked, users cannot update the policy.","type":"boolean","example":true},"keywords":{"description":"A list of defined rule keywords.","items":{"type":"string","example":"test"},"type":"array"},"name":{"description":"The policy name.","type":"string","example":"The policy name"},"regular_expression":{"description":"The regular expression to match to the content of chat messages.","type":"string","example":"^test"},"status":{"description":"The policy's current status. \n* `activated` — Activated. \n* `deactivated` — Deactivated.","enum":["activated","deactivated"],"type":"string","x-enum-descriptions":["Activated.","Deactivated."],"example":"activated"},"trigger_action":{"description":"The policy's trigger action. \n* `1` — Ask the user to confirm before they send the message. \n* `2` — Block the user's message.","enum":[1,2],"type":"integer","x-enum-descriptions":["Ask the user to confirm before they send the message.","Block the user's message."],"example":1}},"type":"object"},"type":"array"},"policy_max_count":{"description":"The read-only maximum number of **Chat Etiquette Tool** policies.","type":"integer","example":50}},"type":"object"},"send_data_to_third_party_archiving_service":{"type":"object","description":"Send data to third-party archiving service.","properties":{"enable":{"type":"boolean","description":"Allow users to send data to third-party archiving service.","example":true},"type":{"type":"string","description":"The type of global relay. \n* `global_relay` — The participant cannot use chat.\n* `smarsh` — Host and co-hosts only.","enum":["global_relay","smarsh"],"x-enum-descriptions":["Global Relay","Smarsh"],"example":"global_relay"},"smtp_delivery_address":{"type":"string","description":"SMTP delivery address. It is used when the field `type` value is `global_relay`.","example":"test@zoom.us"},"user_name":{"type":"string","description":"User name. It is used when the field `type` value is `global_relay`.","example":"test"},"passcode":{"type":"string","description":"passcode. It is used when the field `type` value is `global_relay`.","example":"111111111"},"authorized_channel_token":{"type":"string","description":"Authorized channel token. It is used when the field `type` value is `smarsh`.","example":"as1131zxwrwcssd32r4fkmaksjiajco999999999999a9qef23jr43twn4%^&IBNByeq"}}},"apply_local_storage_to_personal_channel":{"type":"object","description":"Store personal channel messages on local devices.","properties":{"enable":{"type":"boolean","description":"Specify how long your messages sent in your personal channel are saved on local devices. If this setting is disabled, messages are never deleted locally.","example":true},"retention_period":{"type":"string","description":"Delete data after retention period. 'y' - year, 'm' - month, 'd' - day. ","example":"2m"}}}},"type":"object"},"email_notification":{"description":"Account Settings: Notification.","properties":{"alternative_host_reminder":{"description":"Notify when an alternative host is set or removed from a meeting.","type":"boolean","example":true},"cancel_meeting_reminder":{"description":"Notify the host and participants when a meeting is cancelled.","type":"boolean","example":true},"cloud_recording_available_reminder":{"description":"Whether to notify the host when a cloud recording is available.","type":"boolean","example":true},"jbh_reminder":{"description":"Notify the host when participants join the meeting before them.","type":"boolean","example":true},"low_host_count_reminder":{"description":"Notify user when host licenses are running low.","type":"boolean","example":true},"recording_available_reminder_alternative_hosts":{"description":"Whether to notify any alternative hosts when a cloud recording is available.","type":"boolean","example":true},"recording_available_reminder_schedulers":{"description":"Whether to notify the person who scheduled the meeting or webinar for the host when a cloud recording is available.","type":"boolean","example":true},"schedule_for_reminder":{"description":"Notify the host there is a meeting is scheduled, rescheduled, or cancelled.","type":"boolean","example":true}},"type":"object"},"feature":{"description":"Account Settings: Feature.","properties":{"meeting_capacity":{"description":"Set the maximum number of participants a host can have in a single meeting.","type":"integer","example":50}},"type":"object"},"in_meeting":{"description":"Account Settings: In Meeting.","properties":{"auto_generated_translation":{"description":"Information about the [Translate captions](https://support.zoom.us/hc/en-us/articles/8158738379917-Managing-automated-captions-) settings in meetings.","properties":{"language_item_pairList":{"description":"Information about all  speak languages and  translation languages in meetings.","type":"object","properties":{"trans_lang_config":{"type":"array","description":"A list of speak languages and  translation languages.","items":{"type":"object","description":"A item of speak language and  translation languages in meetings.","properties":{"speak_language":{"type":"object","description":"language used in meetings","properties":{"name":{"type":"string","enum":["Chinese (Simplified)","Dutch","English","French","German","Italian","Japanese","Korean","Portuguese","Russian","Spanish","Ukrainian"],"example":"Chinese (Simplified)","description":"the name of language"},"code":{"type":"string","enum":["zh","nl","en","fr","de","it","ja","ko","pt","ru","es","uk"],"example":"zh","description":"th code for the language"}}},"translate_to":{"type":"object","description":"Information about all the translation languages.","properties":{"all":{"type":"boolean","example":true,"description":"Whether to select all the translation languages"},"language_config":{"type":"array","description":"A list of the translation languages.","items":{"type":"object","description":"A item of translation languages.","properties":{"name":{"type":"string","example":"English","enum":["English"],"description":"the name of translation language"},"code":{"type":"string","enum":["en"],"example":"en","description":"the code of translation language"}}}}}}}}},"all":{"description":"Whether to select all speak languages and translation languages","type":"boolean","example":true}}},"enable":{"description":"Whether to allow users to enable automated translated captions in these language pairs in meetings.","type":"boolean","example":true}},"type":"object"},"alert_guest_join":{"description":"Identify guest participants in a meeting or webinar.","type":"boolean","example":true},"allow_host_to_enable_focus_mode":{"description":"Whether the host can enable [**Focus Mode**](https://support.zoom.us/hc/en-us/articles/360061113751-Using-focus-mode) when scheduling a meeting. This value defaults to `null`.","type":"boolean","example":true},"allow_live_streaming":{"description":"Whether to allow livestreaming.","type":"boolean","example":true},"allow_participants_chat_with":{"description":"Whether to allow participants to only chat with certain groups:\n* `1` — The participant cannot use chat.\n* `2` — Host and co-hosts only.\n * `3` — The participant can chat with other participants publicly.\n* `4` - The participant can chat with other participants publicly and privately.\n\n**Note:** This setting is only available with client versions 5.7.3 and above.","enum":[1,2,3,4],"type":"integer","x-enum-descriptions":["No one","Host and co-hosts","Everyone","Everyone and anyone directly"],"example":1},"allow_participants_to_rename":{"description":"If the value of this field is set to `true`, meeting participants and webinar panelists can be allowed to rename themselves during a meeting or a webinar.\n","type":"boolean","example":true},"allow_show_zoom_windows":{"description":"Show the Zoom desktop application when sharing screens. ","type":"boolean","example":true},"allow_users_save_chats":{"description":"Whether to allow participants to save meeting chats:\n* `1` — Participants cannot save meeting chats.\n* `2` — Participants can only save host and co-host meeting chats.\n* `3` — Participants can save all meeting chats.","enum":[1,2,3],"type":"integer","x-enum-descriptions":["Not allow","Host and co-hosts","Everyone"],"example":1},"allow_users_to_delete_messages_in_meeting_chat":{"description":"If the value of this field is set to `true`,  allow users to delete messages in the in-meeting chat.\n","type":"boolean","example":true},"annotation":{"description":"Allow participants to use annotation tools to add information to shared screens.","type":"boolean","example":true},"anonymous_question_answer":{"description":"Allow an anonymous Q&A in a webinar.","type":"boolean","example":true},"attendee_on_hold":{"deprecated":true,"default":false,"description":"Allow host to put attendee on hold.\n\n**This field has been deprecated and is no longer supported.**","type":"boolean","example":true},"attention_mode_focus_mode":{"default":false,"description":"Whether to enable [**Focus Mode**](https://support.zoom.us/hc/en-us/articles/360061113751-Using-focus-mode). When enabled, this feature only displays the host and co-hosts' video and profile pictures during a meeting. \n\n This value defaults to `false`.","type":"boolean","example":true},"auto_answer":{"description":"Whether to enable the [**Auto-answer group in chat**](https://support.zoom.us/hc/en-us/articles/203736135-Auto-answering-invitations-to-meetings) setting. Calls from these group members will be answered automatically.","type":"boolean","example":true},"auto_saving_chat":{"description":"Automatically save all in-meeting chats so that the host does not need to manually save the chat transcript after the meeting starts.","type":"boolean","example":true},"breakout_room":{"description":"Allow host to split meeting participants into separate, smaller rooms.","type":"boolean","example":true},"breakout_room_schedule":{"description":"Whether the host can assign participants to breakout rooms when scheduling. This feature is only available in version 4.5.0 or higher.","type":"boolean","example":true},"chat":{"description":"Allow meeting participants to send a message that is visible to all participants.","type":"boolean","example":true},"meeting_question_answer":{"description":"Allow participants to ask questions for the host and participants to answer.","type":"boolean","example":true},"closed_caption":{"description":"Allow a host to type closed captions. Enable a host to assign a participant or third party device to add closed captions. ","type":"boolean","example":true},"closed_captioning":{"description":"Information about the account's closed captioning settings.","properties":{"auto_transcribing":{"description":"Whether to allow a live transcription service to transcribe meetings.","type":"boolean","example":true},"enable":{"description":"Whether to allow the host to type closed captions or assign a participant or 3rd-party service to provide closed captioning.","type":"boolean","example":true},"save_caption":{"description":"Whether to allow participants to save closed captions or transcripts.","type":"boolean","example":true},"third_party_captioning_service":{"description":"Whether to allow the use of an API token to integrate with 3rd-party closed captioning services.","type":"boolean","example":true},"view_full_transcript":{"description":"Whether to allow the viewing of full transcripts in the in-meeting side panel.","type":"boolean","example":true}},"type":"object"},"co_host":{"description":"Allow the host to add co-hosts.","type":"boolean","example":true},"custom_data_center_regions":{"description":"If set to `true`, account owners and admins on paid accounts can [select data center regions](https://support.zoom.us/hc/en-us/articles/360042411451-Selecting-data-center-regions-for-hosted-meetings-and-webinars) to use for hosting their real-time meeting and webinar traffic. These regions can be provided in the `data_center_regions` field. If set to `false`, the regions cannot be customized and the default regions will be used.","type":"boolean","example":true},"custom_live_streaming_service":{"description":"Whether to allow custom livestreaming.","type":"boolean","example":true},"custom_service_instructions":{"description":"The specific instructions to configure a custom livestream.","type":"string","example":"The specific instructions"},"data_center_regions":{"type":"array","description":"If the value of `custom_data_center_regions` is `true`, a comma-separated list of the following [data center regions](https://support.zoom.us/hc/en-us/articles/360059254691-Datacenter-abbreviation-list) to opt in to: \n* `AU` — Australia.\n* `LA` — Latin America. \n* `CA` — Canada. \n* `CN` — China. \n* `DE` — Germany. \n* `HK` — Hong Kong SAR. \n* `IN` — India. \n* `IE` — Ireland. \n* `TY` — Japan. \n* `MX` — Mexico. \n* `NL` — Netherlands. \n* `SG` — Singapore. \n* `US` — United States.","items":{"type":"string","enum":["AU","LA","CA","CN","DE","HK","IN","IE","TY","MX","NL","SG","US"],"example":"AU"}},"disable_screen_sharing_for_host_meetings":{"description":"Whether to enable the **Disable desktop screen sharing for meetings you host** setting.","type":"boolean","example":true},"disable_screen_sharing_for_in_meeting_guests":{"description":"Whether to enable the **Disable screen sharing when guests are in the meeting** setting.","type":"boolean","example":true},"dscp_audio":{"description":"DSCP audio.","maximum":63,"minimum":1,"type":"integer","example":56},"dscp_marking":{"description":"DSCP marking.","type":"boolean","example":true},"dscp_video":{"description":"DSCP video.","maximum":63,"minimum":1,"type":"integer","example":40},"dscp_dual":{"type":"boolean","description":"Whether to use the differentiated services code point classifiers ('dscp_video', 'dscp_audio') in the dual way (incoming and outgoing).","example":false},"e2e_encryption":{"description":"Zoom requires encryption for all data between the Zoom cloud, Zoom client, and Zoom Room. Require encryption for 3rd party endpoints (H323/SIP).","type":"boolean","example":true},"entry_exit_chime":{"description":"Play sound when participants join or leave.<br>`host` - Heard by host only.<br>`all` - Heard by host and all attendees.<br>`none` - Disable.","enum":["host","all","none"],"type":"string","x-enum-descriptions":["Heard by host only","Heard by host and all attendees","Disable"],"example":"all"},"far_end_camera_control":{"description":"Allow another user to take control of your camera during a meeting.","type":"boolean","example":true},"feedback":{"description":"Add a \"Feedback\" tab to the Windows Settings or Mac Preferences dialog. Enable users to provide feedback to Zoom at the end of the meeting.","type":"boolean","example":true},"file_transfer":{"description":"Indicates whether [in-meeting file transfer](https://support.zoom.us/hc/en-us/articles/209605493-In-meeting-file-transfer) setting has been enabled on the account or not.","type":"boolean","example":true},"group_hd":{"description":"Activate higher quality video for host and participants.\nPlease note: This will use more bandwidth.","type":"boolean","example":true},"join_from_desktop":{"description":"Whether to allow participants to join a meeting directly from their desktop browser. Note that the meeting experience from the desktop browser is limited.","type":"boolean","example":true},"join_from_mobile":{"description":"Whether to allow participants to join a meeting directly from their mobile browser. Note that the meeting experience from the mobile browser is limited.","type":"boolean","example":true},"language_interpretation":{"description":"Information about the [language interpretation](https://support.zoom.us/hc/en-us/articles/360034919791-Using-Language-Interpretation-in-your-meeting-or-webinar) settings.","properties":{"custom_languages":{"description":"A list of user-defined supported languages.","items":{"type":"string","example":"English"},"type":"array"},"enable":{"description":"Whether to allow hosts to assign participants as interpreters who can interpret one language into another in real-time.","type":"boolean","example":true},"enable_language_interpretation_by_default":{"description":"Whether enable language interpretation by default.","type":"boolean","example":true},"allow_participants_to_speak_in_listening_channel":{"description":"Whether to allow participants to speak in listening channel.","type":"boolean","example":true},"allow_up_to_25_custom_languages_when_scheduling_meetings":{"description":"Whether to allow up to 25 custom languages when scheduling meetings.","type":"boolean","example":true},"languages":{"description":"A list of system-supported languages.","items":{"enum":["English","Chinese","Japanese","German","French","Russian","Portuguese","Spanish","Korean"],"type":"string","example":"English"},"type":"array"}},"type":"object"},"live_streaming_facebook":{"description":"Whether to allow Facebook livestreaming.","type":"boolean","example":true},"live_streaming_youtube":{"description":"Whether to allow YouTube livestreaming.","type":"boolean","example":true},"manual_captioning":{"description":"Information about manual captioning settings.","properties":{"allow_to_type":{"description":"Whether to allow the host to manually caption or let the host assign a participant to provide manual captioning.","type":"boolean","example":true},"auto_generated_captions":{"description":"Whether to enable Zoom's [live transcription feature](https://support.zoom.us/hc/en-us/articles/207279736-Managing-closed-captioning-and-live-transcription#h_01FHGGHYJ4457H4GSZY0KM3NSB).","type":"boolean","example":true},"full_transcript":{"description":"Whether to enable the viewing of full transcripts in the in-meeting side panel.","type":"boolean","example":true},"manual_captions":{"description":"Whether to [enable manual closed captioning](https://support.zoom.us/hc/en-us/articles/207279736-Managing-closed-captioning-and-live-transcription).","type":"boolean","example":true},"save_captions":{"description":"Whether to allow participants to [save closed captions or transcripts](https://support.zoom.us/hc/en-us/articles/360060958752). \n\n **Note:** If the `full_transcript` field is set to `false`, participants **cannot** save captions.","type":"boolean","example":true},"third_party_captioning_service":{"description":"Whether to allow the use of an API token to integrate with a [3rd-party device](https://support.zoom.us/hc/en-us/articles/115002212983) to provide closed captioning.","type":"boolean","example":true}},"type":"object"},"meeting_reactions":{"description":"Whether meeting participants can [communicate using the emoji reactions](https://support.zoom.us/hc/en-us/articles/115001286183-Nonverbal-feedback-and-meeting-reactions) located in the **Reactions** menu in the meeting toolbar.","type":"boolean","example":true},"meeting_reactions_emojis":{"description":"Choose from the following meeting reaction options:\n* `all` — All emojis: Allow meeting participants to use any emoji available in Zoom chat as a reaction in a meeting.\n* `selected` — Selected emojis: Allow meeting participants to use the 6 standard meeting reaction emojis: Clapping Hands, Thumbs Up, Heart, Tears of Joy, Open Mouth, Party Popper (Tada, Celebration) ","type":"string","enum":["all","selected"],"x-enum-descriptions":["Allow meeting participants to use any emoji available in Zoom chat as a reaction in a meeting.","Allow meeting participants to use the 6 standard meeting reaction emojis: Clapping Hands, Thumbs Up, Heart, Tears of Joy, Open Mouth, Party Popper (Tada, Celebration) ."],"example":"all"},"allow_host_panelists_to_use_audible_clap":{"description":"Whether to allow host and panelist to use audible clap.","type":"boolean","example":true},"webinar_reactions":{"description":"Set this field to true to use [webinar reactions](https://support.zoom.us/hc/en-us/articles/4803536268429).","type":"boolean","example":true},"meeting_survey":{"description":"Whether to allow the host to present a survey to participants once a meeting has ended. This feature is only available in version 5.7.3 or higher.","type":"boolean","example":true},"original_audio":{"description":"Allow users to select original sound in their client settings.","type":"boolean","example":true},"p2p_connetion":{"description":"Peer to peer connection while only two people are in a meeting.","type":"boolean","example":true},"p2p_ports":{"description":"Peer to peer listening ports range.","type":"boolean","example":true},"polling":{"description":"Add \"Polls\" to the meeting controls.","type":"boolean","example":true},"meeting_polling":{"type":"object","description":"Information about the account's meeting polling settings.","properties":{"enable":{"type":"boolean","description":"Whether to allow the host to add polls before or during a meeting.","example":true},"require_answers_to_be_anonymous":{"description":"Whether to require answers to be anonymous.","type":"boolean","example":true},"advanced_polls":{"type":"boolean","description":"Whether to allow host to create advanced polls and quizzes. Advanced polls and quizzes include single choice, multiple choice, drop down, matching, short answer, long answer, rank order, and fill-in-the-blank questions. Hosts can also set the correct answers for quizzes they create.","example":true},"manage_saved_polls_and_quizzes":{"description":"Whether to allow users to manage saved polls and quizzes from Meetings","type":"boolean","example":true},"allow_alternative_host_to_add_edit":{"type":"boolean","description":"Whether to allow the alternative host to add or edit polls and quizzes.","example":true},"allow_host_to_upload_image":{"description":"Whether to allow host to upload an image for each question.","type":"boolean","example":true}}},"ports_range":{"default":"","description":"The listening ports range, separated by a comma (ex 55,56). The ports range must be between 1 to 65535.","type":"string","example":"1;65535"},"post_meeting_feedback":{"description":"Display a thumbs up or down survey at the end of each meeting.","type":"boolean","example":true},"private_chat":{"description":"Allow a meeting participant to send a private message to another participant.","type":"boolean","example":true},"record_play_own_voice":{"description":"Record and play their own voice.","type":"boolean","example":true},"remote_control":{"description":"Allow users to request remote control.","type":"boolean","example":true},"non_verbal_feedback":{"default":false,"description":"Whether to enable the [**Non-verbal feedback**](https://support.zoom.us/hc/en-us/articles/115001286183-Nonverbal-feedback-and-meeting-reactions-) setting.  This value defaults to `false`.","type":"boolean","example":true},"remote_support":{"default":false,"description":"Whether to enable the [**Remote support**](https://support.zoom.us/hc/en-us/articles/360060951012-Enabling-remote-support) setting. This value defaults to `false`.","type":"boolean","example":true},"request_permission_to_unmute_participants":{"type":"boolean","description":"Whether to enable the [**Request permission to unmute participants**](https://support.zoom.us/hc/en-us/articles/203435537-Muting-and-unmuting-participants-in-a-meeting) setting.","example":true},"screen_sharing":{"description":"Allow screen sharing.","type":"boolean","example":true},"sending_default_email_invites":{"description":"Only show the default email when sending email invites.","type":"boolean","example":true},"show_a_join_from_your_browser_link":{"description":"Whether to allow participants to join a meeting directly from their browser and bypass the Zoom application download process. This is useful for participants who cannot download, install, or run applications. Note that the meeting experience from the browser is limited.","type":"boolean","example":true},"show_meeting_control_toolbar":{"description":"Always show the meeting control toolbar.","type":"boolean","example":true},"slide_control":{"description":"Whether the person sharing during a presentation can allow others to control the slide presentation. This feature is only available in version 5.8.3 or higher.","type":"boolean","example":true},"stereo_audio":{"description":"Allow users to select stereo audio in their client settings.","type":"boolean","example":true},"unchecked_data_center_regions":{"description":"If the value of `custom_data_center_regions` is `true`, a comma-separated list of the following [data center regions](https://support.zoom.us/hc/en-us/articles/360059254691-Datacenter-abbreviation-list) to **not** opt in to: \n* `EU` — Europe. \n* `HK` — Hong Kong. \n* `AU` — Australia. \n* `IN` — India. \n* `LA` — Latin America. \n* `TY` — Tokyo. \n* `CN` — China. \n* `US` — United States. \n* `CA` — Canada.","items":{"enum":["EU","HK","AU","IN","TY","CN","US","CA","DE","NL","LA"],"type":"string","example":"AU"},"type":"array"},"use_html_format_email":{"description":"Use HTML formatted email for the Outlook plugin.","type":"boolean","example":true},"virtual_background":{"description":"Allow users to replace their background with any selected image. Choose or upload an image in the Zoom desktop application settings.","type":"boolean","example":true},"virtual_background_settings":{"description":"Settings to manage virtual background.","properties":{"allow_upload_custom":{"description":"Allow users to upload custom backgrounds.","type":"boolean","example":true},"allow_videos":{"description":"Allow use of videos for virtual backgrounds.","type":"boolean","example":true},"enable":{"description":"Enable virtual background.","type":"boolean","example":true},"files":{"items":{"properties":{"id":{"description":"Unique identifier of the file.","type":"string","example":"sdvfwr2dsf43t34612frg1v"},"is_default":{"description":"Indicates whether or not this file is the default virtual background file.","type":"boolean","example":true},"name":{"description":"File name.","type":"string","example":"test.png"},"size":{"description":"File size.","type":"integer","example":1213},"type":{"description":"File type.","type":"string","example":"image"}},"type":"object"},"type":"array"}},"type":"object"},"watermark":{"description":"Add a watermark when viewing a shared screen.","type":"boolean","example":true},"webinar_chat":{"properties":{"allow_attendees_chat_with":{"description":"Allow webinar attendees to chat with:\n* `1` — No one.\n* `2` — Host and all panelists.\n* `3` — Everyone.","enum":[1,2,3],"type":"integer","example":1},"allow_auto_save_local_chat_file":{"description":"Whether to automatically save chat messages to a local file on the host's computer when the webinar ends.","type":"boolean","example":true},"allow_panelists_chat_with":{"description":"Allow webinar panelists to chat with:\n* `1` — Host and all panelists.\n* `2` — Everyone.","enum":[1,2],"type":"integer","example":1},"allow_panelists_send_direct_message":{"description":"Whether to allow webinar panelists to send direct messages to other panelists.","type":"boolean","example":true},"allow_users_save_chats":{"description":"Whether to allow webinar attendees to save chats:\n* `0` — Attendees cannot save chats.\n* `1` — Attendees can only save host and panelist chats.\n* `2` — Attendees can save all chats.","enum":[0,1,2],"type":"integer","example":1},"default_attendees_chat_with":{"description":"By default, allow webinar attendees to chat with:\n* `1` — Host and all panelists.\n* `2` — Everyone.","enum":[1,2],"type":"integer","example":1},"enable":{"description":"Whether to allow webinar participants to send chat messages.","type":"boolean","example":true}},"type":"object"},"webinar_live_streaming":{"properties":{"custom_service_instructions":{"description":"The specific instructions to allow your account's meeting hosts to configure a custom livestream.","type":"string","example":"The specific instructions"},"enable":{"description":"Whether to enable webinar livestreaming.","type":"boolean","example":true},"live_streaming_reminder":{"description":"Whether to notify users to watch the livestream. This does not apply to custom RTMP (real-time messaging protocol).","type":"boolean","example":true},"live_streaming_service":{"description":"The available livestreaming services:\n* `facebook`\n* `workplace_by_facebook`\n* `youtube`\n* `custom_live_streaming_service`","items":{"enum":["facebook","workplace_by_facebook","youtube","custom_live_streaming_service"],"type":"string","x-enum-descriptions":["Facebook","Workplace by Facebook","YouTube","Custom Live Streaming Service"],"example":"Facebook"},"type":"array"}},"type":"object"},"webinar_polling":{"description":"Information about the account's webinar polling settings.","properties":{"enable":{"description":"Whether to allow the host to add polls before or during a webinar.","type":"boolean","example":true},"advanced_polls":{"description":"Whether to allow host to create advanced polls and quizzes. Advanced polls and quizzes include single choice, multiple choice, drop down, matching, short answer, long answer, rank order, and fill-in-the-blank questions. Hosts can also set the correct answers for quizzes they create.","type":"boolean","example":true},"require_answers_to_be_anonymous":{"description":"Whether to require answers to be anonymous.","type":"boolean","example":true},"manage_saved_polls_and_quizzes":{"description":"Whether to allow users to manage saved polls and quizzes from Meetings","type":"boolean","example":true},"allow_alternative_host_to_add_edit":{"type":"boolean","description":"Whether to allow the alternative host to add or edit polls and quizzes.","example":true},"allow_host_to_upload_image":{"description":"Whether to allow host to upload an image for each question.","type":"boolean","example":true}},"type":"object"},"webinar_question_answer":{"description":"Whether attendees can ask the host and panelists questions in the webinar.","type":"boolean","example":true},"webinar_survey":{"description":"Whether to allow the host to present surveys to attendees once a webinar has ended.","type":"boolean","example":true},"whiteboard":{"description":"Allow participants to share a whiteboard that includes annotation tools.","type":"boolean","example":true},"who_can_share_screen":{"description":"Indicates who can share their screen or content during meetings. The value can be one of the following: <br>\n`host`: Only host can share the screen.<br>\n`all`: Both hosts and attendees can share their screen during meetings. For Webinar, the hosts and panelists can start screen sharing, but not the attendees.\n","enum":["host","all"],"type":"string","example":"host"},"who_can_share_screen_when_someone_is_sharing":{"description":"Indicates who is allowed to start sharing screen when someone else in the meeting is sharing their screen. The value can be one of the following:<br>\n`host`: Only a host can share the screen when someone else is sharing.<br>\n`all`: Anyone in the meeting is allowed to start sharing their screen when someone else is sharing. For Webinar, the hosts and panelists can start screen sharing, but not the attendees.\n","enum":["host","all"],"type":"string","example":"host"},"participants_share_simultaneously":{"description":"Indicates how many participants can share at the same time. The value can be one of the following:<br>\n`one`: Only one participant can share at a time\n.<br>\n`multiple`: Multiple participants can share simultaneously (dual monitors recommended)\n. For Webinar, the hosts and panelists can start screen sharing, but not the attendees.\n","enum":["multiple","one"],"type":"string","example":"multiple"},"workplace_by_facebook":{"description":"Whether to allow Workplace by Facebook livestreaming.","type":"boolean","example":true},"transfer_meetings_between_devices":{"description":"Users can move to a new device without leaving the meeting they're in.","type":"boolean","example":true}},"type":"object"},"integration":{"description":"Account Settings: Integration.","properties":{"box":{"description":"Enable users who join a meeting from their mobile device to share content from their Box account.","type":"boolean","example":true},"dropbox":{"description":"Enable users who join a meeting from their mobile device to share content from their Dropbox account.","type":"boolean","example":true},"google_calendar":{"description":"Enable meetings to be scheduled using Google Calendar.","type":"boolean","example":true},"google_drive":{"description":"Enable users who join a meeting from their mobile device to share content from their Google Drive.","type":"boolean","example":true},"kubi":{"description":"Enable users to control a connected Kubi device from within a Zoom meeting.","type":"boolean","example":true},"microsoft_one_drive":{"description":"Enable users who join a meeting from their mobile device to share content from their Microsoft OneDrive account.","type":"boolean","example":true}},"type":"object"},"other_options":{"properties":{"allow_auto_active_users":{"description":"Whether administrators can activate users with a single default password when they add users. This immediately activates the users without waiting for them to set their own password.","type":"boolean","example":true},"allow_users_contact_support_via_chat":{"description":"Whether to display the Zoom Help badge on the bottom-right of the page.","type":"boolean","example":true},"allow_users_enter_and_share_pronouns":{"description":"Whether users can add pronouns to their profile cards and share them during meetings and webinars.","type":"boolean","example":true},"blur_snapshot":{"description":"Whether iOS blurs the screenshot in the task switcher when multiple apps are open. Android hides the screenshot in the system-level list of recent apps.","type":"boolean","example":true},"display_meetings_scheduled_for_others":{"description":"Whether a user with the [scheduling privilege](https://support.zoom.us/hc/en-us/articles/201362803-Scheduling-privilege) can view other users' meetings.","type":"boolean","example":true},"meeting_qos_and_mos":{"description":"The Dashboard meeting [quality scores and network alerts](https://support.zoom.us/hc/en-us/articles/360061244651) setting: \n* `0` — Do not enable meeting quality scores and network alerts on the Dashboard. \n* `1` — Display the meeting quality score and network alerts on the Dashboard. \n* `2` — Use custom thresholds for quality scores and network alerts. \n* `3` —Both Use custom thresholds for quality scores and network alerts and Display the meeting quality score and network alerts on the Dashboard.","enum":[0,1,2,3],"type":"integer","x-enum-descriptions":["Do not display meeting quality scores and network alerts on the Dashboard","Display the meeting quality score and network alerts on the Dashboard","Use custom thresholds for quality scores and network alerts"],"example":0},"show_one_user_meeting_on_dashboard":{"description":"Whether meetings with only one person will display on the Dashboard and in reports.","type":"boolean","example":true},"use_cdn":{"description":"Allow connections to different CDNs (content delivery networks) for a better web browsing experience. All users in your organization will use the selected CDN to access static resources: \n* `none` — Do not use a CDN. \n* `default` — Use the Amazon CloudFront CDN for users **except** Chinese Mainland users. Chinese Mainland users will use the Wangsu CDN (China). \n* `wangsu` — Use the Wangsu CDN for all users.","enum":["none","default","wangsu"],"type":"string","x-enum-descriptions":["Do not use use a CDN","All users will use the Amazon CloudFront CDN except Chinese Mainland users. Chinese Mainland users will use the Wangsu CDN (China)","All users use the Wangsu CDN (China)"],"example":"none"},"webinar_registration_options":{"type":"object","description":"Webinar registration options.","properties":{"allow_host_to_enable_join_info":{"type":"boolean","description":"Allow host to enable \"Show join info on registration confirmation page\".","example":true},"allow_host_to_enable_social_share_buttons":{"type":"boolean","description":"Allow host to enable \"Show social share buttons on registration page\".","example":true},"enable_custom_questions":{"type":"boolean","description":"Enable custom questions.","example":true}}}},"type":"object"},"profile":{"properties":{"recording_storage_location":{"properties":{"allowed_values":{"description":"Users can choose the country to store their recorded content. Content can include meeting, webinar, and phone recordings, as well as voicemail, transcripts, and custom greeting prompts. See [Managing the Communications Content storage location](https://support.zoom.us/hc/en-us/articles/360050781131) for details.\n\nProvide abbreviated country codes as the value for this field. See the [Countries abbreviation list](https://marketplace.zoom.us/docs/api-reference/other-references/abbreviation-lists#countries) for details.","items":{"type":"string","example":"US"},"type":"array"},"value":{"description":"Abbreviated country code.","type":"string","example":"US"}},"type":"object"}},"title":"Profile","type":"object"},"recording":{"description":"Account Settings: Recording.","properties":{"account_user_access_recording":{"description":"Cloud recordings are only accessible to account members. People outside of your organization cannot open links that provide access to cloud recordings.","type":"boolean","example":true},"allow_recovery_deleted_cloud_recordings":{"description":"Allow recovery of deleted cloud recordings from trash. \nIf the value of this field is set to `true`, deleted cloud recordings will be kept in trash for 30 days after deletion and can be recovered within that period. ","type":"boolean","example":true},"archive":{"description":"[Archiving solution](https://support.zoom.us/hc/en-us/articles/360050431572-Archiving-Meeting-and-Webinar-data) settings. This setting can only be used if you have been granted with archiving solution access by the Zoom support team.","properties":{"enable":{"description":"Enable the archiving feature.","type":"boolean","example":true},"settings":{"properties":{"audio_file":{"description":"Include in-meeting and/or in-webinar audio in the archive.","type":"boolean","example":true},"cc_transcript_file":{"description":"Include closed caption or transcript in the archive.","type":"boolean","example":true},"chat_file":{"description":"Include in-meeting chat in the archive.","type":"boolean","example":true},"chat_with_sender_email":{"description":"Include user email in in-meeting chat file.","type":"boolean","example":true},"video_file":{"description":"Include in-meeting and/or in-webinar video in the archive.","type":"boolean","example":true},"chat_with_direct_message":{"description":"Include direct message in in-meeting chat file.","type":"boolean","example":true},"archive_retention":{"description":"The retention period for archiving content, in days.","type":"integer","example":1,"enum":[1,2,3,4,5,6,7,8,9,10,11,12,13,14,15,16,17,18,19,20,21,22,23,24,25,26,27,28,29,30]},"action_when_archive_failed":{"description":"Perform the action when meetings or webinars cannot be archived.<br>`1` - Participants can stay in the meeting and will receive a notification.<br>`2` - Nobody can join or stay in the meeting.","type":"integer","example":1,"enum":[1,2]},"notification_when_archiving_starts":{"description":"Show notification when video or audio archiving starts.<br>`1` - Participants can stay in the meeting and will receive a notification.<br>`2` - Nobody can join or stay in the meeting.","type":"string","example":"participants","enum":["participants","guest"]},"play_voice_prompt_when_archiving_starts":{"description":"Play voice prompt when video or audio archiving starts.<br>`1` - Participants can stay in the meeting and will receive a notification.<br>`2` - Nobody can join or stay in the meeting.","type":"string","example":"guest","enum":["participants","guest","none"]}},"type":"object"},"type":{"description":"Archive types:\n\n* `1`: Only meetings are archived.<br>\n* `2`: Only webinars are archived.<br>\n* `3`: Both meetings and webinars are archived.","enum":[1,2,3],"type":"integer","example":1}},"type":"object"},"auto_delete_cmr":{"description":"Allow Zoom to permanently delete recordings automatically after a specified number of days.","type":"boolean","example":true},"auto_delete_cmr_days":{"description":"When the `auto_delete_cmr` value is `true`, this value is the number of days before the auto-deletion of cloud recordings: \n* `30` — 30 days. \n* `60` — 60 days. \n* `90` — 90 days. \n* `120` — 120 days.","enum":[30,60,90,120],"type":"integer","x-enum-descriptions":["30 days.","60 days.","90 days.","120 days."],"example":90},"record_files_separately":{"type":"object","description":"The account's [**Record active speaker, gallery view and shared screen separately**](https://support.zoom.us/hc/en-us/articles/360060316092-Changing-basic-and-advanced-cloud-recording-settings#h_01F4CYJTCTXNS2MXH00W9EFG6R) settings.","properties":{"active_speaker":{"type":"boolean","description":"Whether to record the active speaker only.","example":true},"gallery_view":{"type":"boolean","description":"Whether to record the gallery view only.","example":true},"shared_screen":{"type":"boolean","description":"Whether to record the shared screen only.","example":true}}},"display_participant_name":{"type":"boolean","description":"Whether to display participants' names in the recording.","example":true},"recording_thumbnails":{"type":"boolean","description":"Whether to record thumbnails of the presenter when they are sharing their screen.","example":true},"optimize_recording_for_3rd_party_video_editor":{"type":"boolean","description":"Whether to optimize recordings for a 3rd party video editor. This may increase the file size and the time it takes to generate recording files.","example":true},"recording_highlight":{"type":"boolean","description":"Whether to enable the [recording highlights](https://support.zoom.us/hc/en-us/articles/360060802432) feature.","example":true,"deprecated":true},"save_panelist_chat":{"type":"boolean","description":"Whether to save panelist chat to the recording. This setting saves messages sent by panelists during a webinar to either all panelists or all panelists and attendees to the recording.","example":true},"save_poll_results":{"type":"boolean","description":"Whether to save poll results shared during the meeting or webinar. This also includes poll results shared during the meeting or webinar.","example":true},"save_close_caption":{"type":"boolean","description":"Whether to save [closed captions](https://support.zoom.us/hc/en-us/articles/207279736) as a VTT (Video Track Text) file.","example":true},"auto_recording":{"description":"Automatic recording:<br>`local` - Record on local.<br>`cloud` -  Record on cloud.<br>`none` - Disabled.","enum":["local","cloud","none"],"type":"string","x-enum-descriptions":["Record on local","Record on cloud","Disabled"],"example":"local"},"cloud_recording":{"description":"Allow hosts to record and save the meeting in the cloud.","type":"boolean","example":true},"cloud_recording_download":{"description":"Cloud recording downloads.","type":"boolean","example":true},"cloud_recording_download_host":{"description":"Only the host can download cloud recordings.","type":"boolean","example":true},"host_delete_cloud_recording":{"description":"If the value of this field is set to `true`, hosts will be able to delete the recordings. If this option is set to `false`, the recordings cannot be deleted by the host and only admin can delete them.\n","type":"boolean","example":true},"ip_address_access_control":{"description":"Setting to allow cloud recording access only from specific IP address ranges.\n","properties":{"enable":{"description":"If set to `true`, the cloud recordings of this account can only be accessed by the IP addresses defined in the `ip_addresses_or_ranges` property.\n\n","type":"boolean","example":true},"ip_addresses_or_ranges":{"description":"IP addresses or ranges that have access to the cloud recordings. Separate multiple IP ranges with comma. Use n.n.n.n, n.n.n.n/n or n.n.n.n - n.n.n.n syntax where n is a number.\n\nExample: `46.33.24.184, 48.99.100.2/25` or `200.181.108.17 - 220.181.108.157`\n\n","type":"string","example":"46.33.24.184"}},"type":"object"},"local_recording":{"description":"Allow hosts and participants to record the meeting using a local file.","type":"boolean","example":true},"prevent_host_access_recording":{"description":"If set to `true`, meeting hosts cannot view their meeting cloud recordings. Only the admins who have recording management privilege can access them.\n","type":"boolean","example":true},"record_audio_file":{"description":"Whether to record one audio file for all participants.","type":"boolean","example":true},"record_gallery_view":{"description":"Record the gallery view with a shared screen.","type":"boolean","example":true},"record_speaker_view":{"description":"Record the active speaker with a shared screen.","type":"boolean","example":true},"recording_audio_transcript":{"description":"Automatically transcribe the audio of the meeting or webinar to the cloud.","type":"boolean","example":true},"recording_disclaimer":{"description":"Show a disclaimer to participants before a recording starts\n","type":"boolean","example":true},"smart_recording":{"description":"By selecting this option, your recording will have meeting smart chapters, and next steps. You are directing Zoom to access, process, and use your account's recording data for the purpose of analysis and insights.","properties":{"create_recording_highlights":{"description":"By selecting this option, meeting details in the audio transcript will be highlighted. Hosts can modify highlighted sections and generate a video summary (highlighted sections may have a 3-second offset) based on these sections. The summary is for informational purposes only and may not be complete.","type":"boolean","example":true},"create_smart_chapters":{"description":"By selecting this option, your recording will have chapters with overview. Hosts can edit the chapters.","type":"boolean","example":true},"create_next_steps":{"description":"By selecting this option, there will be a summary of actions to take after the recorded meeting.","type":"boolean","example":true}},"type":"object"},"recording_password_requirement":{"description":"This object represents the minimum password requirements set for recordings via Account Recording Settings.","properties":{"have_letter":{"description":"Indicates whether or not password must contain at least one alphabetical letter (a, b, c..).","type":"boolean","example":true},"have_number":{"description":"Indicates whether or not password must contain at least one number(1, 2, 3..).","type":"boolean","example":true},"have_special_character":{"description":"Indicates whether or not password must contain at least one special character(!, @, #..).","type":"boolean","example":true},"length":{"description":"Minimum required length for the password.","maximum":10,"type":"integer","example":10},"only_allow_numeric":{"description":"Indicates whether or not password must contain only numeric characters.","type":"boolean","example":true}},"type":"object"},"required_password_for_existing_cloud_recordings":{"description":"Require a passcode to access existing cloud recordings.","type":"boolean","example":true},"required_password_for_shared_cloud_recordings":{"type":"boolean","description":"Whether to require a passcode to share cloud recordings.","example":true},"save_chat_text":{"description":"Save the chat text from the meeting.","type":"boolean","example":true},"show_timestamp":{"description":"Add a timestamp to the recording.","type":"boolean","example":true}},"type":"object"},"schedule_meeting":{"description":"Account Settings: Schedule Meeting.","properties":{"audio_type":{"default":"both","description":"Determine how participants can join the audio portion of the meeting.<br>`both` - Telephony and VoIP.<br>`telephony` - Audio PSTN telephony only.<br>`voip` - VoIP only.<br>`thirdParty` - 3rd party audio conference.","enum":["both","telephony","voip","thirdParty"],"type":"string","x-enum-descriptions":["Telephony and VoIP","Audio PSTN telephony only","VoIP only","3rd party audio conference"],"example":"both"},"enforce_login":{"description":"Only Zoom users who are signed in can join meetings.","type":"boolean","example":true},"enforce_login_domains":{"description":"Only signed in users with a specified domain can join the meeting. ","type":"string","example":"example.com"},"enforce_login_with_domains":{"description":"Only signed in users with a specific domain can join meetings.","type":"boolean","example":true},"force_pmi_jbh_password":{"description":"Require a password for Personal Meetings if attendees can join before host.","type":"boolean","example":true},"host_video":{"description":"Start meetings with the host video on.","type":"boolean","example":true},"jbh_time":{"description":"If the value of \"join_before_host\" field is set to `true`, this field can be used to indicate time limits within which a participant may join a meeting before a host. The value of this field can be one of the following:\n\n*  `0`: Allow participant to join anytime.\n*  `5`: Allow participant to join 5 minutes before meeting start time.\n * `10`: Allow participant to join 10 minutes before meeting start time.","enum":[0,5,10,15],"type":"integer","example":5},"join_before_host":{"description":"Allow participants to join the meeting before the host arrives.","type":"boolean","example":true},"meeting_password_requirement":{"description":"Account wide meeting/webinar [password requirements](https://support.zoom.us/hc/en-us/articles/360033559832-Meeting-and-webinar-passwords#h_a427384b-e383-4f80-864d-794bf0a37604).","properties":{"consecutive_characters_length":{"description":"\nSpecify the max length of consecutive characters(abcde...) that can be used in a password.\nIf you set the value of this field to `0`, no restriction will be applied on consecutive characters. \n\nIf you would like to set this restriction, you can specify a number between `4` and `8` that will define the maximum allowed length for consecutive characters in a password.\n\nThe maximum allowed length will be `n-1` where `n` refers to the value you provide for this field.  For instance, if you provide `4` as the value, there can only be a maximum of `3` consecutive characters in a password(example: abc1x@8fdh).","enum":[0,4,5,6,7,8],"type":"integer","example":8},"have_letter":{"description":"If set to `true`, the password must contain at least 1 letter (such as a,b,c...).\n","type":"boolean","example":true},"have_number":{"description":"If set to `true`, the password must contain at least 1 number (such as 1,2,3...).","type":"boolean","example":true},"have_special_character":{"description":"If set to `true`, the password must have at least 1 special character (!,@,#...).","type":"boolean","example":true},"have_upper_and_lower_characters":{"description":"If set to `true`, the password must include both uppercase and lowercase characters.","type":"boolean","example":true},"length":{"description":"The minimum length that the meeting/webinar password needs to have.","type":"integer","example":8},"only_allow_numeric":{"description":"If set to `true`, the password must only contain numbers and no other characters.","type":"boolean","example":true},"weak_enhance_detection":{"description":"If set to `true`, users will be informed if the provided password is weak.","type":"boolean","example":true}},"type":"object"},"not_store_meeting_topic":{"description":"Always display \"Zoom Meeting\" as the meeting topic.","type":"boolean","example":true},"participant_video":{"description":"Start meetings with the participant video on. Participants can change this setting during the meeting.","type":"boolean","example":true},"personal_meeting":{"description":"Personal Meeting Setting.<br><br>\n`true`: Indicates that the **\"Enable Personal Meeting ID\"** setting is turned on. Users can choose to use personal meeting ID for their meetings. <br><br>\n`false`: Indicates that the **\"Enable Personal Meeting ID\"** setting is [turned off](https://support.zoom.us/hc/en-us/articles/201362843-Personal-meeting-ID-PMI-and-personal-link#h_aa0335c8-3b06-41bc-bc1f-a8b84ef17f2a). If this setting is disabled, meetings that were scheduled with PMI will be invalid. Scheduled meetings will need to be manually updated.\nFor Zoom Phone only:If a user has been assigned a desk phone, **\"Elevate to Zoom Meeting\"** on desk phone will be disabled.\n\n\n","type":"boolean","example":true},"require_password_for_instant_meetings":{"description":"Require a password for instant meetings. If you use PMI for your instant meetings, this option will be disabled. This setting is always enabled for free accounts and Pro accounts with a single host and cannot be modified for these accounts.\n","type":"boolean","example":true},"require_password_for_pmi_meetings":{"description":"Require a password for a meeting held using Personal Meeting ID (PMI) This setting is always enabled for free accounts and Pro accounts with a single host and cannot be modified for these accounts.\n","enum":["jbh_only","all","none"],"type":"string","x-enum-descriptions":["Only meetings with Join Before Host enabled","All meetings using PMI","Disabled"],"example":"jbh_only"},"require_password_for_scheduled_meetings":{"description":"Require a password for meetings which have already been scheduled\n","type":"boolean","example":true},"require_password_for_scheduling_new_meetings":{"description":"Require a password when scheduling new meetings. This setting applies for regular meetings that do not use PMI. If enabled, a password will be generated while a host schedules a new meeting and participants will be required to enter the password before they can join the meeting. This setting is always enabled for free accounts and Pro accounts with a single host and cannot be modified for these accounts.","type":"boolean","example":true},"use_pmi_for_instant_meetings":{"description":"Use Personal Meeting ID (PMI) when starting an instant meeting\n","type":"boolean","example":true},"use_pmi_for_scheduled_meetings":{"description":"Use Personal Meeting ID (PMI) when scheduling a meeting\n","type":"boolean","example":true},"always_display_zoom_meeting_as_topic":{"description":"Information about the [**Always display \"Zoom Meeting\" as the meeting topic**](https://support.zoom.us/hc/en-us/articles/201363253-Changing-account-settings#h_01EG9BJ646V2WJK1S3H2MP6YV6) setting.","type":"object","properties":{"enable":{"type":"boolean","description":"Whether to enable the **Always display \"Zoom Meeting\" as the meeting topic** setting.","example":true},"display_topic_for_scheduled_meetings":{"type":"boolean","description":"Whether to display \"Zoom Meeting\" as the topic for already-scheduled meetings.","example":true}}},"hide_meeting_description":{"type":"object","description":"Information about the **Hide meeting description** feature.","properties":{"enable":{"type":"boolean","description":"Whether to enable the **Hide meeting description** setting.","example":true},"hide_description_for_scheduled_meetings":{"type":"boolean","description":"Whether to hide the description for already-scheduled meetings.","example":true}}},"always_display_zoom_webinar_as_topic":{"type":"object","description":"Information about the [**Always show \"Zoom Webinar\" as the webinar topic**](https://support.zoom.us/hc/en-us/articles/201363253-Changing-account-settings#h_01EG9BJ646V2WJK1S3H2MP6YV6) setting.","properties":{"enable":{"type":"boolean","description":"Whether to enable the **Always show \"Zoom Webinar\" as the webinar topic** setting.","example":true},"display_topic_for_scheduled_webinars":{"type":"boolean","description":"Whether to display \"Zoom Webinar\" as the topic for already-scheduled meetings.","example":true}}},"hide_webinar_description":{"type":"object","description":"Information about the **Hide webinar description** feature.","properties":{"enable":{"type":"boolean","description":"Whether to enable the **Hide webinar description** setting.","example":true},"hide_description_for_scheduled_webinars":{"type":"boolean","description":"Whether to hide webinar description for the webinars which have already been scheduled.","example":true}}}},"type":"object"},"telephony":{"description":"Account Settings: Telephony.","properties":{"audio_conference_info":{"description":"Third party audio conference info.","type":"string","example":"test"},"telephony_regions":{"description":"Indicates where most of the participants call into or call from during a meeting.","properties":{"allowed_values":{"description":"Telephony region options provided by Zoom to select from.","items":{"type":"string","example":"CNTB"},"type":"array"},"selection_values":{"description":"The account's selected telephony regions that indicate where most participants call in to or call from during a meeting.","type":"string","example":"USTB"}},"type":"object"},"third_party_audio":{"description":"Users can join the meeting using the existing third party audio configuration.","type":"boolean","example":true}},"type":"object"},"tsp":{"description":"Account Settings: TSP.","properties":{"call_out":{"description":"Call Out","type":"boolean","example":true},"call_out_countries":{"description":"Call Out Countries/Regions","items":{"type":"string","example":"us"},"type":"array"},"display_toll_free_numbers":{"description":"Display toll-free numbers","type":"boolean","example":true},"show_international_numbers_link":{"description":"Show international numbers link on the invitation email","type":"boolean","example":true}},"type":"object"},"zoom_rooms":{"description":"Account Settings: Zoom Rooms.","properties":{"auto_start_stop_scheduled_meetings":{"description":"Automatic start and stop for scheduled meetings.","type":"boolean","example":true},"cmr_for_instant_meeting":{"description":"Cloud recording for instant meetings.","type":"boolean","example":true},"force_private_meeting":{"description":"Shift all meetings to private.","type":"boolean","example":true},"hide_host_information":{"description":"Hide host and meeting ID from private meetings.","type":"boolean","example":true},"list_meetings_with_calendar":{"description":"Display meeting list with calendar integration.","type":"boolean","example":true},"start_airplay_manually":{"description":"Start AirPlay service manually.","type":"boolean","example":true},"ultrasonic":{"description":"Automatic direct sharing using an ultrasonic proximity signal.","type":"boolean","example":true},"upcoming_meeting_alert":{"description":"Upcoming meeting alert.","type":"boolean","example":true},"weekly_system_restart":{"description":"Weekly system restart.","type":"boolean","example":true},"zr_post_meeting_feedback":{"description":"Zoom Room post meeting feedback.","type":"boolean","example":true}},"type":"object"}},"title":"Account settings","type":"object"},{"oneOf":[{"properties":{"allow_authentication_exception":{"description":"Whether to enable the [**Allow authentication exception**](https://support.zoom.us/hc/en-us/articles/360037117472#h_01F13A9N1FQFNVESC9C21NRHXY) setting. This lets hosts invite users who can bypass authentication.","type":"boolean","example":true},"authentication_options":{"description":"Meeting Authentication Options","items":{"properties":{"default_option":{"description":"Authentication default option","type":"boolean","example":true},"domains":{"description":"Authentication domains.","type":"string","example":"test.com"},"id":{"description":"Authentication id","type":"string","example":"qef22g34gr3g43g33rv43"},"name":{"description":"Authentication name","type":"string","example":"test"},"type":{"description":" Authentication type. Specify one of the following authentication types for the authentication profile:<br>\n * `enforce_login`: This option allows any users to join the meeting or webinar, as long as they are signed into their Zoom account.\n * `enforce_login_with_domains`: This option, allows you to specify a rule so that only those Zoom users whose email addresses contain a certain domain, can join the meeting or webinar. You can either add multiple domains using a comma in between and/or use a wildcard for listing domains.<br>\n * `enforce_login_with_same_account`: This option allows users to join the meeting or webinar with the same Zoom account.","enum":["enforce_login","enforce_login_with_same_account","enforce_login_with_domains"],"type":"string","example":"enforce_login_with_domains"},"visible":{"description":"Authentication visible","type":"boolean","example":true}},"type":"object"},"type":"array"},"meeting_authentication":{"description":"Only authenticated users can join meetings","type":"boolean","example":true}},"type":"object"},{"properties":{"authentication_options":{"items":{"properties":{"default_option":{"description":"Authentication default option","type":"boolean","example":true},"domains":{"description":"Authentication domains.","type":"string","example":"test.com"},"id":{"description":"Authentication id","type":"string","example":"qwefwqefqwf43231231"},"name":{"description":"Authentication name","type":"string","example":"test"},"type":{"description":"Authentication type","enum":["internally","enforce_login","enforce_login_with_domains"],"type":"string","example":"enforce_login"},"visible":{"description":"Authentication visible","type":"boolean","example":true}},"type":"object"},"type":"array"},"recording_authentication":{"description":"Only authenticated users can view cloud recordings","type":"boolean","example":true}},"type":"object"}],"title":"AccountSettingsAuthentication","type":"object"},{"description":"[Security settings](https://support.zoom.us/hc/en-us/articles/360034675592-Advanced-security-settings#h_bf8a25f6-9a66-447a-befd-f02ed3404f89) of an Account.","properties":{"admin_change_name_pic":{"type":"boolean","deprecated":true,"description":"Whether to only allow account administrators to change a user's picture.","example":true},"admin_change_user_info":{"type":"boolean","description":"Whether to only allow account administrators to change a user's information.","example":true},"user_modifiable_info_by_admin":{"type":"array","description":"If the `admin_change_user_info` value is `true`, the list of the types of user information that only the account administrators can modify: \n* `name` \n* `profile_picture` \n* `sign_in_email` \n* `host_key`","items":{"type":"string","enum":["name","profile_picture","sign_in_email","host_key"],"example":["name","host_key","sign_in_email"]}},"signin_with_sso":{"type":"object","properties":{"enable":{"description":"Whether to allow users to sign in with single sign-on (SSO). If enabling this, configure your account's SSO settings. This lets users sign in with SSO through your company's vanity URL.","type":"boolean","example":true},"require_sso_for_domains":{"description":"Whether to require users to sign in with single sign-on (SSO) if their e-mail address belongs to one of the `domains`.","type":"boolean","example":true},"domains":{"type":"array","description":"Users on these domains must sign in with single sign-on (SSO). ","example":["test.com","example.us"],"items":{"type":"string","example":"test.com"}},"sso_bypass_users":{"type":"array","description":"The users can bypass SSO sign-in.","items":{"type":"object","properties":{"id":{"description":"The user ID.","type":"string","example":"21212_aefwef32233"},"email":{"description":"The user email.","type":"string","example":"123@test.com"}}}}},"description":"Allow users to sign in with single sign-on (SSO). "},"hide_billing_info":{"description":"Hide billing information.","type":"boolean","example":true},"import_photos_from_devices":{"description":"Allow users to import photos from a photo library on a  device.","type":"boolean","example":true},"password_requirement":{"description":"This object refers to the [enhanced password rules](https://support.zoom.us/hc/en-us/articles/360034675592-Advanced-security-settings#h_bf8a25f6-9a66-447a-befd-f02ed3404f89) that allows Zoom account admins and owners to apply extra requirements to the users' Zoom login password.","properties":{"consecutive_characters_length":{"description":"\nSpecify the max length of consecutive characters(abcde...) that can be used in a password.\nIf you set the value of this field to `0`, no restriction will be applied on consecutive characters. \n\nIf you would like to set this restriction, you can specify a number between 4 and 8 that define the maximum allowed length for consecutive characters in a password.\n\nThe max allowed length will be `n-1` where `n` refers to the value you provide for this field.  For instance, if you provide `4` as the value, there can only be a maximum of `3` consecutive characters in a password(example: abc1x@8fdh).","type":"integer","example":8},"have_special_character":{"description":"If the value of this field is set to `true`, the password must have at least one special character(!, @, #...).","type":"boolean","example":true},"minimum_password_length":{"description":"Specify a minimum length for the password. The password length can be from a minimum of 9 characters, up to 14 characters. If you provide `0` as the value of this field, this field will be disabled and not be used and the basic password length requirement (minimum of 8 characters) will be applied for the requirement.","maximum":14,"minimum":8,"type":"integer","example":8},"weak_enhance_detection":{"description":"If the value of this field is set to `true`, user passwords will have to pass detection through a weak password dictionary in case hackers use simple passwords to sign in to your users' accounts.","type":"boolean","example":true}},"type":"object"},"sign_again_period_for_inactivity_on_client":{"description":"Settings for User Sign In interval requirements after a period of inactivity. If enabled, this setting forces automatic logout of users in Zoom Client app after a set amount of time. <br>\n\nIf this setting is disabled, the value of this field will be `0`. If the setting is enabled, the value of this field will indicate the **period of inactivity** in minutes after which, an inactive user will be automatically logged out of the Zoom Client. The value for the period of inactivity can be one of the following:<br>\n\n`5`: 5 minutes<br>\n`10`: 10 minutes<br>\n`15`: 15 minutes<br>\n`30`: 30 minutes<br>\n`45`: 45 minutes<br>\n`60`: 60 minutes<br>\n`90`: 90 minutes<br>\n`120`: 120 minutes\n","type":"integer","example":45},"sign_again_period_for_inactivity_on_web":{"description":"Settings for User Sign In interval requirements after a period of inactivity. If enabled, this setting forces automatic logout of users in Zoom Web Portal after a set amount of time. <br>\n\nIf this setting is disabled, the value of this field will be `0`. If the setting is enabled, the value of this field will indicate the **period of inactivity** in minutes after which, an inactive user will be automatically logged out of the Zoom Web Portal. The value for the period of inactivity can be one of the following:<br>\n\n`5`: 5 minutes<br>\n`10`: 10 minutes<br>\n`15`: 15 minutes<br>\n`30`: 30 minutes<br>\n`60`: 60 minutes<br>\n`120`: 120 minutes\n\n    \n\n","type":"integer","example":60},"sign_in_with_two_factor_auth":{"description":"Settings for 2FA( [two factor authentication](https://support.zoom.us/hc/en-us/articles/360038247071) ). The value can be one of the following:\n`all`: Two factor authentication will be enabled for all users in the account.<br>\n`none`: Two factor authentication is disabled.<br>\n`group`: Two factor authentication will be enabled for users belonging to specific groups. If 2FA is enabled for certain groups, the group IDs of the group(s) will be provided in the `sign_in_with_two_factor_auth_groups` field.<br>\n`role`: Two factor authentication will be enabled only for users assigned with specific roles in the account. If 2FA is enabled for specific roles, the role IDs will be provided in the\n`sign_in_with_two_factor_auth_roles` field.\n","enum":["all","group","role","none"],"type":"string","example":"group"},"sign_in_with_two_factor_auth_groups":{"description":"This field contains group IDs of groups that have 2FA enabled. This field is only returned if the value of `sign_in_with_two_factor_auth` is `group`","items":{"type":"string","example":"group"},"type":"array"},"sign_in_with_two_factor_auth_roles":{"description":"This field contains role IDs of roles that have 2FA enabled. This field is only returned if the value of `sign_in_with_two_factor_auth` is `role`.","items":{"type":"string","example":"role"},"type":"array"}},"type":"object"},{"description":"The account's meeting and webinar security settings.","properties":{"meeting_security":{"properties":{"auto_security":{"description":"Whether all meetings must be secured with at least one security option. \n\n This setting can only be disabled by Enterprise, ISV, Business (with more than 100 licenses), and Education accounts.","type":"boolean","example":true},"block_user_domain":{"description":"Whether users in specific domains are blocked from joining meetings and webinars.","type":"boolean","example":true},"block_user_domain_list":{"description":"The blocked domains.","items":{"maxLength":30,"minLength":5,"type":"string","example":"example.com"},"maxItems":20,"type":"array"},"chat_etiquette_tool":{"description":"Information about the **Chat Etiquette Tool**.","properties":{"enable":{"description":"Whether to enable the **Chat Etiquette Tool**.","type":"boolean","example":true},"policies":{"description":"Information about the defined **Chat Etiquette Tool** policies.","items":{"properties":{"description":{"description":"The policy's description.","type":"string","example":"The policy's description"},"id":{"description":"The policy ID.","type":"string","example":"afwef342tr2qfwrg"},"is_locked":{"description":"Whether the policy is locked by an account-level user. When it is locked, users cannot update the policy.","type":"boolean","example":true},"keywords":{"description":"A list of defined rule keywords.","items":{"type":"string","example":"test"},"type":"array"},"name":{"description":"The policy name.","type":"string","example":"The policy name"},"regular_expression":{"description":"The regular expression to match to the content of chat messages.","type":"string","example":"^test"},"status":{"description":"The policy's current status: \n* `activated` — Activated. \n* `deactivated` — Deactivated.","enum":["activated","deactivated"],"type":"string","x-enum-descriptions":["Activated.","Deactivated."],"example":"activated"},"trigger_action":{"description":"The policy's trigger action: \n* `1` — Ask the user to confirm before they send the message. \n* `2` — Block the user's message.","enum":[1,2],"type":"integer","x-enum-descriptions":["Ask the user to confirm before they send the message.","Block the user's message."],"example":1}},"type":"object"},"type":"array"},"policy_max_count":{"description":"The read-only maximum number of **Chat Etiquette Tool** policies.","type":"integer","example":14}},"type":"object"},"embed_password_in_join_link":{"description":"Whether the meeting password is encrypted and included in the invitation link. The provided link will allow participants to join the meeting without having to enter the password.","type":"boolean","example":true},"encryption_type":{"description":"The type of encryption used when starting a meeting: \n* `enhanced_encryption` — Enhanced encryption. Encryption data is stored in the cloud. \n* `e2ee` — End-to-end encryption. The encryption key is stored on the local device and cannot be obtained by anyone else. Enabling E2EE also [**disables** certain features](https://support.zoom.us/hc/en-us/articles/360048660871), such as cloud recording, live streaming, and allowing participants to join before the host.","enum":["enhanced_encryption","e2ee"],"type":"string","example":"e2ee"},"end_to_end_encrypted_meetings":{"description":"Whether to enable end-to-end encryption for meetings.","type":"boolean","example":true},"meeting_password":{"description":"Whether all instant and scheduled meetings that users can join via client or Zoom Rooms systems are password-protected. [Personal Meeting ID (PMI)](https://support.zoom.us/hc/en-us/articles/203276937) meetings are **not** included in this setting.","type":"boolean","example":true},"meeting_password_requirement":{"description":"Information about the meeting and webinar [password requirements](https://support.zoom.us/hc/en-us/articles/360033559832-Meeting-and-webinar-passwords#h_a427384b-e383-4f80-864d-794bf0a37604).","properties":{"consecutive_characters_length":{"description":"The maximum length of consecutive characters (for example, `abcdef`) allowed in a password: \n* `4` through `8` — The maximum consecutive characters length. The length is `n` minus `1`, where `n` is the value. For example, if the value is `4`, there can only be a maximum of `3` consecutive characters in a password (for example, `abc1x@8fdh`). \n* `0` — No consecutive character restriction.","enum":[0,4,5,6,7,8],"type":"integer","example":0},"have_letter":{"description":"Whether passwords must contain at least one letter character.","type":"boolean","example":true},"have_number":{"description":"Whether passwords must contain at least one numeric character.","type":"boolean","example":true},"have_special_character":{"description":"Whether passwords must contain at least one special character. For example, `!`, `@`, and/or `#` characters.","type":"boolean","example":true},"have_upper_and_lower_characters":{"description":"Whether passwords must include uppercase and lowercase characters.","type":"boolean","example":true},"length":{"description":"The minimum password length.","type":"integer","example":10},"only_allow_numeric":{"description":"Whether passwords must contain **only** numeric characters.","type":"boolean","example":true},"weak_enhance_detection":{"description":"Whether users are informed when the provided password is weak.","type":"boolean","example":true}},"type":"object"},"only_authenticated_can_join_from_webclient":{"description":"Whether to specify that only authenticated users can join the meeting from the web client.","type":"boolean","example":true},"phone_password":{"description":"Whether passwords are required for participants joining by phone. \n\n If enabled and the meeting is password-protected, a numeric password is required for participants to join by phone. For meetings with alphanumeric passwords, a numeric password will be generated.","type":"boolean","example":true},"pmi_password":{"description":"Whether all Personal Meeting ID (PMI) meetings that users can join via client or Zoom Rooms systems are password-protected.","type":"boolean","example":true},"require_password_for_scheduled_meeting":{"description":"Whether passwords are required for meetings that have already been scheduled.","type":"boolean","example":true},"require_password_for_scheduled_webinar":{"description":"Whether passwords are required for webinars that have already been scheduled.","type":"boolean","example":true},"waiting_room":{"description":"Whether participants are placed in the [**Waiting Room**](https://support.zoom.us/hc/en-us/articles/115000332726-Waiting-Room) when they join a meeting. \n\n When the **Waiting Room** feature is enabled, the [**Allow participants to join before host**](https://support.zoom.us/hc/en-us/articles/202828525-Allow-participants-to-join-before-host) setting is disabled.","type":"boolean","example":true},"waiting_room_settings":{"description":"Information about the Waiting Room settings.","properties":{"participants_to_place_in_waiting_room":{"description":"The type of participants to be admitted to the Waiting Room: \n* `0` — All attendees. \n* `1` — Users who are not in your account. \n* `2` — Users who are not in your account and are not part of your [allowed domains list](https://support.zoom.us/hc/en-us/articles/360037117472-Configuring-authentication-profiles#h_e3cf0d5f-eec7-4c2a-ad29-ef2a5079a7da).","enum":[0,1,2],"type":"integer","example":1},"users_who_can_admit_participants_from_waiting_room":{"description":"The users who can admit participants from the Waiting Room: \n* `0` — Host and co-hosts only. \n* `1` — Host, co-hosts, and anyone who bypassed the Waiting Room if the host and co-hosts are not present.","enum":[0,1],"type":"integer","example":1},"whitelisted_domains_for_waiting_room":{"description":"If the `participants_to_place_in_waiting_room` field is `2`, a comma-separated list of the domains that can bypass the Waiting Room (`\"example.com,example2.com\"`).","type":"string","example":"example.com"}},"type":"object"},"webinar_password":{"description":"Whether to generate a password when scheduling webinars. Participants must use the generated password to join the scheduled webinar.","type":"boolean","example":true}},"type":"object"}},"title":"Meeting or Webinar Security Account Settings","type":"object"},{"title":"Video SDK Account Settings","type":"object","properties":{"in_meeting":{"deprecated":true,"type":"object","properties":{"custom_data_center_regions":{"description":"Whether custom [data center regions](https://support.zoom.us/hc/en-us/articles/360042411451-Selecting-data-center-regions-for-meetings-webinars) are in use: \n* `true` — Users can [select data center regions](https://support.zoom.us/hc/en-us/articles/360042411451-Selecting-data-center-regions-for-hosted-meetings-and-webinars) to use for hosting real-time meeting traffic. The data center regions can be provided in the `data_center_regions` field. \n* `false` — Only the default data center regions.","type":"boolean","example":false},"data_center_regions":{"type":"array","description":"If the value of `custom_data_center_regions` is `true`, a comma-separated list of the selected custom [data center regions](https://support.zoom.us/hc/en-us/articles/360059254691-Datacenter-abbreviation-list): \n* `AU` — Australia.\n* `LA` — Latin America. \n* `CA` — Canada. \n* `CN` — China. \n* `DE` — Germany. \n* `HK` — Hong Kong SAR. \n* `IN` — India. \n* `IE` — Ireland. \n* `TY` — Japan. \n* `MX` — Mexico. \n* `NL` — Netherlands. \n* `SG` — Singapore. \n* `US` — United States.","items":{"type":"string","enum":["AU","LA","CA","CN","DE","HK","IN","IE","TY","MX","NL","SG","US"],"example":"AU"}},"unchecked_data_center_regions":{"type":"array","description":"If the value of `custom_data_center_regions` is `true`, a comma-separated list the [data center regions](https://support.zoom.us/hc/en-us/articles/360059254691-Datacenter-abbreviation-list) that are **not** selected: \n* `EU` — Europe. \n* `HK` — Hong Kong. \n* `AU` — Australia. \n* `IN` — India. \n* `LA` — Latin America. \n* `TY` — Tokyo. \n* `CN` — China. \n* `US` — United States. \n* `CA` — Canada.","items":{"enum":["EU","HK","AU","IN","TY","CN","US","CA","DE","NL","LA"],"type":"string","example":"EU"}}}},"in_session":{"type":"object","properties":{"custom_data_center_regions":{"description":"Whether custom [data center regions](https://support.zoom.us/hc/en-us/articles/360042411451-Selecting-data-center-regions-for-meetings-webinars) are in use: \n* `true` — Users can [select data center regions](https://support.zoom.us/hc/en-us/articles/360042411451-Selecting-data-center-regions-for-hosted-meetings-and-webinars) to use for hosting real-time meeting traffic. The data center regions can be provided in the `data_center_regions` field. \n* `false` — Only the default data center regions.","type":"boolean","example":false},"data_center_regions":{"type":"array","description":"If the value of `custom_data_center_regions` is `true`, a comma-separated list of the selected custom [data center regions](https://support.zoom.us/hc/en-us/articles/360059254691-Datacenter-abbreviation-list): \n* `AU` — Australia.\n* `LA` — Latin America. \n* `CA` — Canada. \n* `CN` — China. \n* `DE` — Germany. \n* `HK` — Hong Kong SAR. \n* `IN` — India. \n* `IE` — Ireland. \n* `TY` — Japan. \n* `MX` — Mexico. \n* `NL` — Netherlands. \n* `SG` — Singapore. \n* `US` — United States.","items":{"type":"string","enum":["AU","LA","CA","CN","DE","HK","IN","IE","TY","MX","NL","SG","US"],"example":"AU"}},"unchecked_data_center_regions":{"type":"array","description":"If the value of `custom_data_center_regions` is `true`, a comma-separated list the [data center regions](https://support.zoom.us/hc/en-us/articles/360059254691-Datacenter-abbreviation-list) that are **not** selected: \n* `EU` — Europe. \n* `HK` — Hong Kong. \n* `AU` — Australia. \n* `IN` — India. \n* `LA` — Latin America. \n* `TY` — Tokyo. \n* `CN` — China. \n* `US` — United States. \n* `CA` — Canada.","items":{"enum":["EU","HK","AU","IN","TY","CN","US","CA","DE","NL","LA"],"type":"string","example":"EU"}},"p2p_connetion":{"description":"Whether to enable the [**Peer to Peer connection while only 2 people are in a meeting**](https://support.zoom.us/hc/en-us/articles/360061410851-Enabling-Peer-to-Peer-connection-for-2-people-in-a-meeting) setting.","type":"boolean","example":true},"p2p_ports":{"description":"Whether to enable the **Listening ports range** setting.","type":"boolean","example":true},"ports_range":{"default":"","description":"When the `p2p_ports` value is `true`, the value is a semi-colon list of the peer to peer listening ports range, between `1` to `65535`. This value defaults to an empty string.","type":"string","example":"1;65535"},"dscp_audio":{"default":56,"description":"The DSCP audio marking value. This value defaults to `56`.","maximum":63,"minimum":1,"type":"integer","example":56},"dscp_marking":{"description":"Whether to enable [differentiated services code point (DSCP)](https://en.wikipedia.org/wiki/Differentiated_services) marking.","type":"boolean","example":true},"dscp_video":{"default":40,"description":"The DSCP video marking value. This value defaults to `40`.","maximum":63,"minimum":1,"type":"integer","example":40},"dscp_dual":{"type":"boolean","description":"Whether to use the differentiated services code point classifiers ('dscp_video', 'dscp_audio') in the dual way (incoming and outgoing).","example":false},"subsession":{"description":"Allow host to split meeting participants into separate, smaller rooms.","type":"boolean","example":true}}},"session_security":{"type":"object","properties":{"approved_or_denied_countries_or_regions":{"description":"Approve or block users from specific regions or countries from joining this meeting. \n","properties":{"approved_list":{"description":"List of countries/regions from where participants can join this meeting. ","items":{"type":"string","example":"CX"},"type":"array"},"denied_list":{"description":"List of countries/regions from where participants can not join this meeting. ","items":{"type":"string","example":"CA"},"type":"array"},"enable":{"description":"`true`: Setting enabled to either allow or block users from specific regions from joining your meetings. <br>\n\n`false`: Setting disabled.","type":"boolean","example":true},"method":{"description":"Specify whether to allow users from specific regions to join this meeting; or block users from specific regions from joining this meeting. <br><br>\n`approve`: Allow users from specific regions or countries to join this meeting. If this setting is selected, the approved regions or countries must be included in the `approved_list`.<br><br>\n`deny`: Block users from specific regions or countries from joining this meeting. If this setting is selected, the approved regions or countries must be included in the `denied_list`","enum":["approve","deny"],"type":"string","example":"approve"}},"type":"object"}}},"recording":{"type":"object","properties":{"cloud_recording":{"type":"boolean","description":"Whether hosts can record and save meetings or webinars to the cloud.","example":true},"record_speaker_view":{"type":"boolean","description":"Whether to enable recording the [**Active Speaker** view](https://support.zoom.us/hc/en-us/articles/360025561091-Recording-layouts#h_5c001397-33d6-47fb-bb40-1a3f68401581) during screen sharing.","example":true},"record_gallery_view":{"type":"boolean","description":"Whether to enable recording the [**Gallery** view](https://support.zoom.us/hc/en-us/articles/360025561091-Recording-layouts#h_889dc825-9d79-4139-b65d-e719669c546b) during screen sharing.","example":true},"record_audio_file":{"type":"boolean","description":"Whether to record one audio file for all participants.","example":true},"save_chat_text":{"type":"boolean","description":"Whether meeting and webinar chat texts are saved.","example":false},"show_timestamp":{"type":"boolean","description":"Whether timestamps are added to all meeting and webinar recordings.","example":true},"recording_audio_transcript":{"type":"boolean","description":"Whether to enable the [**Audio transcription**](https://support.zoom.us/hc/en-us/articles/115004794983-Audio-transcription-for-cloud-recordings) feature.","example":false},"cloud_recording_download":{"type":"boolean","description":"Whether to enable the [**Cloud recording downloads**](https://support.zoom.us/hc/en-us/articles/360060240972-Managing-cloud-recording-settings) setting.","example":true},"auto_delete_cmr":{"type":"boolean","description":"Whether cloud recordings are automatically deleted after a specific number of days.","example":true},"auto_delete_cmr_days":{"type":"integer","description":"When the `auto_delete_cmr` value is `true`, the number of days before Zoom automatically deletes cloud recordings: \n* `30` — 30 days. \n* `60` — 60 days. \n* `90` — 90 days. \n* `120` — 120 days.","enum":[30,60,90,120],"example":30}}}}}]}}},"description":"**HTTP Status Code:** `200` <br>\nAccount settings returned. \n\n**Error Code:** `200` <br>\nOnly available for paid accounts."},"404":{"description":"**HTTP Status Code:** `404` <br>\nNot Found \n\n**Error Code:** `2001` <br>\nAccount does not exist: $accountId"}},"tags":["Accounts"],"description":"Use this API to get an account's settings. To get the Master account's settings, use the `me` value for the `accountId` path parameter. \n\n**Scopes:** `account:read:admin` <br> **[Rate Limit Label](https://developers.zoom.us/docs/api/rest/rate-limits/):** `Medium` \n\n**Prerequisites:** \n* The account must be a paid account.","operationId":"accountSettings","summary":"Get account settings"},"patch":{"parameters":[{"description":"The account's ID. For the Master account, pass the `me` value for this parameter.","in":"path","name":"accountId","required":true,"schema":{"type":"string","example":"me"}},{"allowEmptyValue":true,"description":"Optional query parameters: \n* `meeting_authentication` — Use this query parameter to view the [meeting authentication settings](https://support.zoom.us/hc/en-us/articles/360037117472-Authentication-Profiles-for-Meetings-and-Webinars) applied to the user's account. \n* `recording_authentication` — Use this query parameter to view the [recording authentication settings](https://support.zoom.us/hc/en-us/articles/360037756671-Authentication-Profiles-for-Cloud-Recordings) applied to the user's account. \n* `security` — Use this query parameter to view the account's security settings. For example, password requirements for user login or two-factor authentication. \n* `meeting_security` — Use this query parameter to view the meeting security settings applied to the user's account.","in":"query","name":"option","schema":{"enum":["meeting_authentication","recording_authentication","security","meeting_security"],"type":"string","example":"meeting_security"}}],"responses":{"200":{"description":"**Error Code:** `200` <br>\nOnly available for paid accounts."},"204":{"description":"**HTTP Status Code:** `204` <br>\nAccount settings updated."},"300":{"description":"**Error Code:** `300` <br>\nThe domains provided are invalid. If you are providing multiple domains, separate each domain with a comma."},"404":{"description":"**HTTP Status Code:** `404`<br>\n Not Found \n\n**Error Code:** `2001` <br>\nAccount does not exist: $accountId"}},"tags":["Accounts"],"description":"Use this API to update an account's settings. To update the Master account's settings, pass the `me` value for the `accountId` path parameter. \n\n **Scopes:** `account:write:admin` <br> **[Rate Limit Label](https://developers.zoom.us/docs/api/rest/rate-limits/):** `Medium` \n\n **Prerequisites:** \n* The account must be a paid account.","operationId":"accountSettingsUpdate","requestBody":{"content":{"application/json":{"schema":{"oneOf":[{"properties":{"security":{"description":"[Security settings](https://support.zoom.us/hc/en-us/articles/360034675592-Advanced-security-settings#h_bf8a25f6-9a66-447a-befd-f02ed3404f89) of an Account.","properties":{"admin_change_name_pic":{"type":"boolean","deprecated":true,"description":"Whether to only allow account administrators to change a user's picture.","example":true},"admin_change_user_info":{"type":"boolean","description":"Whether to only allow account administrators to change a user's information.","example":true},"user_modifiable_info_by_admin":{"type":"array","description":"If the `admin_change_user_info` value is `true`, the list of the types of user information that only the account administrators can modify: \n* `name` \n* `profile_picture` \n* `sign_in_email` \n* `host_key`","items":{"type":"string","enum":["name","profile_picture","sign_in_email","host_key"],"example":["name","host_key","sign_in_email"]}},"signin_with_sso":{"type":"object","properties":{"enable":{"description":"Whether to allow users to sign in with ssingle sign-on (SSO). If enabling this, configure your account's SSO settings. This lets users to sign in with SSO through your company's vanity URL.","type":"boolean","example":true},"require_sso_for_domains":{"description":"Whether to require users to sign in with single sign-on (SSO) if their e-mail address belongs to one of the `domains`.","type":"boolean","example":true},"domains":{"type":"array","description":"Users on these domains are required to sign in with single sign-on (SSO). ","example":["test.com","example.us"],"items":{"type":"string","example":"test.com"}},"sso_bypass_user_ids":{"type":"array","description":"The users' ID can bypass SSO sign-in.","items":{"type":"string","example":"1211414124112zw_r"}}},"description":"Allow users to sign in with single sign-on (SSO). "},"hide_billing_info":{"description":"Hide billing information.","type":"boolean","example":true},"import_photos_from_devices":{"description":"Allow users to import photos from a photo library on a  device.","type":"boolean","example":true},"password_requirement":{"description":"This object refers to the [enhanced password rules](https://support.zoom.us/hc/en-us/articles/360034675592-Advanced-security-settings#h_bf8a25f6-9a66-447a-befd-f02ed3404f89) that allows Zoom account admins and owners to apply extra requirements to the users' Zoom login password.","properties":{"consecutive_characters_length":{"description":"\nSpecify the max length of consecutive characters(abcde...) that can be used in a password.\nIf you set the value of this field to `0`, no restriction will be applied on consecutive characters. \n\nIf you would like to set this restriction, you can specify a number between 4 and 8 that define the maximum allowed length for consecutive characters in a password.\n\nThe max allowed length will be `n-1` where `n` refers to the value you provide for this field.  For instance, if you provide `4` as the value, there can only be a maximum of `3` consecutive characters in a password(example: abc1x@8fdh).","type":"integer","example":8},"have_special_character":{"description":"If the value of this field is set to `true`, the password must have at least one special character(!, @, #...).","type":"boolean","example":true},"minimum_password_length":{"description":"Specify a minimum length for the password. The password length can be from a minimum of 9 characters, up to 14 characters. If you provide `0` as the value of this field, this field will be disabled and not be used and the basic password length requirement (minimum of 8 characters) will be applied for the requirement.","maximum":14,"minimum":8,"type":"integer","example":8},"weak_enhance_detection":{"description":"If the value of this field is set to `true`, user passwords will have to pass detection through a weak password dictionary in case hackers use simple passwords to sign in to your users' accounts.","type":"boolean","example":true}},"type":"object"},"sign_again_period_for_inactivity_on_client":{"description":"Settings for User Sign In interval requirements after a period of inactivity. If enabled, this setting forces automatic logout of users in Zoom Client app after a set amount of time. <br>\n\nIf this setting is disabled, the value of this field will be `0`. If the setting is enabled, the value of this field will indicate the **period of inactivity** in minutes after which, an inactive user will be automatically logged out of the Zoom Client. The value for the period of inactivity can be one of the following:<br>\n\n`5`: 5 minutes<br>\n`10`: 10 minutes<br>\n`15`: 15 minutes<br>\n`30`: 30 minutes<br>\n`45`: 45 minutes<br>\n`60`: 60 minutes<br>\n`90`: 90 minutes<br>\n`120`: 120 minutes\n","type":"integer","example":45},"sign_again_period_for_inactivity_on_web":{"description":"Settings for User Sign In interval requirements after a period of inactivity. If enabled, this setting forces automatic logout of users in Zoom Web Portal after a set amount of time. <br>\n\nIf this setting is disabled, the value of this field will be `0`. If the setting is enabled, the value of this field will indicate the **period of inactivity** in minutes after which, an inactive user will be automatically logged out of the Zoom Web Portal. The value for the period of inactivity can be one of the following:<br>\n\n`5`: 5 minutes<br>\n`10`: 10 minutes<br>\n`15`: 15 minutes<br>\n`30`: 30 minutes<br>\n`60`: 60 minutes<br>\n`120`: 120 minutes\n\n    \n\n","type":"integer","example":60},"sign_in_with_two_factor_auth":{"description":"Settings for 2FA( [two factor authentication](https://support.zoom.us/hc/en-us/articles/360038247071) ). The value can be one of the following:\n`all`: Two factor authentication will be enabled for all users in the account.<br>\n`none`: Two factor authentication is disabled.<br>\n`group`: Two factor authentication will be enabled for users belonging to specific groups. If 2FA is enabled for certain groups, the group IDs of the group(s) will be provided in the `sign_in_with_two_factor_auth_groups` field.<br>\n`role`: Two factor authentication will be enabled only for users assigned with specific roles in the account. If 2FA is enabled for specific roles, the role IDs will be provided in the\n`sign_in_with_two_factor_auth_roles` field.\n","enum":["all","group","role","none"],"type":"string","example":"group"},"sign_in_with_two_factor_auth_groups":{"description":"This field contains group IDs of groups that have 2FA enabled. This field is only returned if the value of `sign_in_with_two_factor_auth` is `group`","items":{"type":"string","example":"group"},"type":"array"},"sign_in_with_two_factor_auth_roles":{"description":"This field contains role IDs of roles that have 2FA enabled. This field is only returned if the value of `sign_in_with_two_factor_auth` is `role`.","items":{"type":"string","example":"role"},"type":"array"}},"type":"object"},"audio_conferencing":{"description":"The account's audio conference settings.","properties":{"toll_free_and_fee_based_toll_call":{"description":"The account's [**Toll-free and Fee-based Toll Call**](https://support.zoom.us/hc/en-us/articles/360060950711-Enabling-Toll-free-and-Fee-based-Toll-Call#h_01F51680NJ7YHZDXGJNSKDGM2P) settings.","properties":{"allow_webinar_attendees_dial":{"description":"Whether webinar attendees can dial in through the account's **Toll-free and Fee-based Toll Call** phone numbers. This feature is only available in version 5.2.2 and higher.","type":"boolean","example":true},"enable":{"description":"Whether the account has the [**Toll-free and Fee-based Toll Call**](https://support.zoom.us/hc/en-us/articles/360060950711-Enabling-Toll-free-and-Fee-based-Toll-Call#h_01F51680NJ7YHZDXGJNSKDGM2P) setting enabled.","type":"boolean","example":true},"numbers":{"description":"The account's **Toll-free and Fee-based Toll Call** phone number information.","items":{"properties":{"code":{"description":"The phone number's [E.164 country calling code](https://en.wikipedia.org/wiki/List_of_country_calling_codes).","type":"string","example":"86"},"country_code":{"description":"The phone number's [country code](https://marketplace.zoom.us/docs/api-reference/other-references/abbreviation-lists#countries).","type":"string","example":"CN"},"country_name":{"description":"The country name.","type":"string","example":"China"},"display_number":{"description":"The phone number's display number.","maxLength":30,"type":"string","example":"+86 777 777 77"},"number":{"description":"The phone number.","maxLength":30,"type":"string","example":"777 777 77"}},"type":"object"},"maxItems":100,"type":"array"}},"type":"object"}},"type":"object"},"chat":{"description":"The account's chat settings.","properties":{"allow_bots_chat":{"description":"Whether chatbots added to chats and channels can read and write messages.","type":"boolean","example":true},"share_files":{"type":"object","description":"Users can share files in chats and channels.","properties":{"enable":{"type":"boolean","description":"Allow users of this account to send and receive files in chats and channels. When disabled, users can still take and share screenshots.","example":true},"share_option":{"type":"string","description":"Allow users of this account to send and receive files in chats and channels. When disabled, users can still take and share screenshots.","enum":["anyone","account","organization"],"x-enum-descriptions":["Anyone (internal and external contacts)","In the same account","In the same organization"],"example":true},"restrictions":{"type":"object","description":"The restrictions of users can share files in chats and channels","properties":{"only_allow_specific_file_types":{"type":"boolean","description":"Only allow specified file types","example":true},"file_type_restrictions":{"type":"array","items":{"type":"string","description":"Specified file type","example":".gz","enum":[".gz",".rar",".zip",".xls",".xlsx",".json",".png",".pptx",".ppt",".7z",".xmind",".pdf",".pps",".txt",".docx",".doc"]}},"file_type_restrictions_for_external":{"type":"array","items":{"type":"string","description":"Specified file type","example":".gz","enum":[".gz",".rar",".zip",".xls",".xlsx",".json",".png",".pptx",".ppt",".7z",".xmind",".pdf",".pps",".txt",".docx",".doc"]}},"maximum_file_size":{"type":"boolean","description":"Whether to restrict file size","example":true},"file_size_restrictions":{"type":"integer","description":"Maximum file size","example":100,"enum":[50,100,200,300,400,500]},"file_size_restrictions_for_external":{"type":"integer","description":"Maximum file size for external users","example":100,"enum":[50,100,200,300,400,500]}}}}},"chat_emojis":{"type":"object","description":"Chat emojis.","properties":{"enable":{"type":"boolean","description":"Allow users to use the emoji library in direct messages or group conversations. Choose between allowing users to use any emoji in the library, or choose to allow only pre-selected emojis. If the setting is disabled, users can still use keyboard shortcuts to add emojis. Users can change their emoji skin tone in Settings.","example":true},"emojis_option":{"type":"string","example":"all","enum":["all","selected"],"x-enum-descriptions":["All emojis","Selected emojis"]}}},"record_voice_messages":{"description":"Allow users to record voice messages that can be sent in direct messages or group conversations.","type":"boolean","example":true},"record_video_messages":{"description":"Allow users to record video messages that can be sent in direct messages or group conversations. If the file share setting is disabled, they will not be able to record and send video messages.","type":"boolean","example":true},"screen_capture":{"description":"Allow users to take and send screenshots in direct messages or group conversations.","type":"boolean","example":true},"create_public_channels":{"type":"boolean","description":"Allow users to create public channels.","example":true},"create_private_channels":{"type":"boolean","description":"Allow users to create private channels.","example":true},"share_links_in_chat":{"type":"boolean","description":"Share links to messages and channels in Team Chat.","example":true},"schedule_meetings_in_chat":{"type":"boolean","description":"Schedule a meeting from chat or channel.","example":true},"set_retention_period_in_cloud":{"type":"object","description":"Set retention period for messages and files in Zoom's cloud.","properties":{"enable":{"type":"boolean","description":"By default, messages and files are stored in Zoom's cloud. Enable this setting to specify when they are deleted. When retention is disabled, messages sent by offline users can be received within 7 days before they are deleted.","example":true},"retention_period_of_direct_messages_and_group_conversation":{"type":"string","description":"Delete direct messages and group conversations after retention period. 'y' - year, 'm' - month, 'd' - day","example":"2m"},"retention_period_of_channels":{"type":"string","description":"Delete data in channels after retention period. 'y' - year, 'm' - month, 'd' - day","example":"2m"}}},"set_retention_period_in_local":{"type":"object","description":"Store messages on local devices, excluding personal channel messages.","properties":{"enable":{"type":"boolean","description":"Specify how long your messages are saved on local devices. If this setting is disabled, messages are never deleted locally.","example":true},"retention_period_of_direct_messages_and_group_conversation":{"type":"string","description":"Delete direct messages and group conversations after retention period. 'y' - year, 'm' - month, 'd' - day","example":"2m"},"retention_period_of_channels":{"type":"string","description":"Delete data in channels after retention period. 'y' - year, 'm' - month, 'd' - day","example":"2m"}}},"allow_users_to_add_contacts":{"description":"Allow users to add contacts.","type":"object","properties":{"enable":{"description":"By disabling this setting, users will not be able to add contacts.","type":"boolean","example":true},"selected_option":{"description":"The type of allowing users to add contacts. \n* 1 — Anyone (internal and external contacts). \n* 2 — In the same organization. \n* 3 — In the same organization and specified domains. \n* 4 — In the same organization and specified users.","enum":[1,2,3,4],"type":"integer","example":4},"user_email_addresses":{"description":"The internal or external domains or emails. \n* When the `selected_option` field value is `3`, the value is internal or external domains. Use a comma to separate multiple domains. Example: company.com. \n* When the `selected_option` field value is `4`, the value is internal or external email addresses. Use a comma to separate multiple emails.","type":"string","example":"123@test.com"}}},"allow_users_to_chat_with_others":{"description":"Allow users to chat with others.","type":"object","properties":{"enable":{"description":"If you select 'In the same organization', users may still be able to chat with external users if they are added to channels or group chats with external users.","type":"boolean","example":true},"selected_option":{"description":"The type of allowing users to add contacts. \n* 1 — Anyone (internal and external contacts). \n* 2 — In the same organization. \n* 3 — In the same organization and specified domains. \n* 4 — In the same organization and specified users.","enum":[1,2,3,4],"type":"integer","example":4},"user_email_addresses":{"description":"The internal or external domains or emails. \n* When the `selected_option` field value is `3`, the value is internal or external domains. Use a comma to separate multiple domains. Example: company.com. \n* When the `selected_option` field value is `4`, the value is internal or external email addresses. Use a comma to separate multiple emails.","type":"string","example":"123@test.com"}}},"chat_etiquette_tool":{"description":"Information about the **Chat Etiquette** tool.","properties":{"enable":{"default":false,"description":"Whether to enable the **Chat Etiquette Tool**. This value defaults to `false`. \n\n The **Chat Etiquette Tool** allows you to define specific keywords and text patterns in chat to prevent users from inadvertently sharing unwanted messages.","type":"boolean","example":true},"operate":{"description":"The policy operation to perform for the update. \n* `create` — Create policies. \n* `update` — Update policies. \n* `delete` — Delete policies.","enum":["create","update","delete"],"type":"string","x-enum-descriptions":["Add new policies.","Update policies.","Delete policies."],"example":"update"},"policies":{"description":"Information about the defined **Chat Etiquette Tool** policies.","items":{"properties":{"description":{"description":"The policy's description.","type":"string","example":"The policy's description"},"id":{"description":"The policy ID.","type":"string","example":"afwefwef243fwef132f2g43g43g44br"},"is_locked":{"default":false,"description":"Whether to lock the policy. When it is locked, users cannot update the policy. This value defaults to `false`.","type":"boolean","example":true},"keywords":{"description":"A list of defined rule keywords.","items":{"type":"string","example":"test"},"type":"array"},"name":{"description":"The policy name.","type":"string","example":"the policy name"},"regular_expression":{"description":"The regular expression to match to the content of chat messages.","type":"string","example":"^test"},"status":{"description":"The policy's current status. \n* `activated` — Activated. \n* `deactivated` — Deactivated.","enum":["activated","deactivated"],"type":"string","x-enum-descriptions":["Activated.","Deactivated."],"example":"activated"},"trigger_action":{"description":"The policy's trigger action. \n* `1` — Ask the user to confirm before they send the message. \n* `2` — Block the user's message.","enum":[1,2],"type":"integer","x-enum-descriptions":["Ask the user to confirm before they send the message.","Block the user's message."],"example":1}},"type":"object"},"type":"array"}},"type":"object"},"send_data_to_third_party_archiving_service":{"type":"object","description":"Send data to third-party archiving service.","properties":{"enable":{"type":"boolean","description":"Allow users to send data to third-party archiving service.","example":true},"type":{"type":"string","description":"The type of global relay. \n* `global_relay` — The participant cannot use chat.\n* `smarsh` — Host and co-hosts only.","enum":["global_relay","smarsh"],"x-enum-descriptions":["Global Relay","Smarsh"],"example":"global_relay"},"smtp_delivery_address":{"type":"string","description":"SMTP delivery address. It is used when the field `type` value is `global_relay`, and it is required.","example":"test@zoom.us"},"user_name":{"type":"string","description":"User name. It is used when the field `type` value is `global_relay`, and it is required.","example":"test"},"passcode":{"type":"string","description":"passcode. It is used when the field `type` value is `global_relay`, and it is required.","example":"111111111"},"authorized_channel_token":{"type":"string","description":"Authorized channel token. It is used when the field `type` value is `smarsh`, and it is required.","example":"as1131zxwrwcssd32r4fkmaksjiajco999999999999a9qef23jr43twn4%^&IBNByeq"}}},"apply_local_storage_to_personal_channel":{"type":"object","description":"Store personal channel messages on local devices.","properties":{"enable":{"type":"boolean","description":"Specify how long your messages sent in your personal channel are saved on local devices. If this setting is disabled, messages are never deleted locally.","example":true},"retention_period":{"type":"string","description":"Delete data after retention period. 'y' - year, 'm' - month, 'd' - day. ","example":"2m"}}}},"type":"object"},"email_notification":{"description":"Account Settings: Notification.","properties":{"alternative_host_reminder":{"description":"Notify when an alternative host is set or removed from a meeting.","type":"boolean","example":true},"cancel_meeting_reminder":{"description":"Notify the host and participants when a meeting is cancelled.","type":"boolean","example":true},"cloud_recording_available_reminder":{"description":"Whether to notify the host when a cloud recording is available.","type":"boolean","example":true},"jbh_reminder":{"description":"Notify the host when participants join the meeting before them.","type":"boolean","example":true},"low_host_count_reminder":{"description":"Notify user when host licenses are running low.","type":"boolean","example":true},"recording_available_reminder_alternative_hosts":{"description":"Whether to notify any alternative hosts when a cloud recording is available.","type":"boolean","example":true},"recording_available_reminder_schedulers":{"description":"Whether to notify the person who scheduled the meeting or webinar for the host when a cloud recording is available.","type":"boolean","example":true},"schedule_for_reminder":{"description":"Notify the host there is a meeting is scheduled, rescheduled, or cancelled.","type":"boolean","example":true}},"type":"object"},"feature":{"description":"Account Settings: Feature.","properties":{"meeting_capacity":{"description":"Set the maximum number of participants a host can have in a single meeting.","type":"integer","example":50}},"type":"object"},"in_meeting":{"description":"In Meeting Account Settings","properties":{"alert_guest_join":{"description":"Whether to enable [guest participant](https://support.zoom.us/hc/en-us/articles/115004791123-Identifying-guests-in-the-meeting-webinar) alerts.","type":"boolean","example":true},"allow_users_to_delete_messages_in_meeting_chat":{"description":"If the value of this field is set to `true`,  allow users to delete messages in the in-meeting chat.\n","type":"boolean","example":true},"allow_host_to_enable_focus_mode":{"description":"Whether the host can enable [**Focus Mode**](https://support.zoom.us/hc/en-us/articles/360061113751-Using-focus-mode) when scheduling a meeting. This value defaults to `null`.","type":"boolean","example":true},"allow_live_streaming":{"description":"Whether to allow livestreaming.","type":"boolean","example":true},"allow_participants_chat_with":{"description":"Whether to allow participants to only chat with certain groups: \n* `1` — The participant cannot use chat. \n* `2` — Host and co-hosts only. \n * `3` — The participant can chat with other participants publicly. \n* `4` - The participant can chat with other participants publicly and privately. \n\n **Note:** This setting is only available with client versions 5.7.3 and above.","enum":[1,2,3,4],"type":"integer","example":1},"allow_participants_to_rename":{"description":"Whether to allow meeting participants to rename themselves during a meeting.","type":"boolean","example":true},"allow_show_zoom_windows":{"description":"Whether to enable the [**Show Zoom windows during screen share**](https://support.zoom.us/hc/en-us/articles/360061383571-Showing-Zoom-windows-during-screen-share) feature.","type":"boolean","example":true},"allow_users_save_chats":{"description":"Whether to allow participants to save meeting chats: \n* `1` — Participants cannot save meeting chats. \n* `2` — Participants can only save host and co-host meeting chats. \n* `3` — Participants can save all meeting chats.","enum":[1,2,3],"type":"integer","example":1},"annotation":{"description":"Whether to allow meeting participants to use the [annotation tools](https://support.zoom.us/hc/en-us/articles/115005706806).","type":"boolean","example":true},"anonymous_question_answer":{"description":"Whether to enable anonymous Q&A.","type":"boolean","example":true},"attendee_on_hold":{"deprecated":true,"default":false,"description":"Whether to allow the host to put an attendee on hold. This value defaults to `false`. **This field has been deprecated and is no longer supported.**","type":"boolean","example":true},"attention_mode_focus_mode":{"default":false,"description":"Whether to enable [**Focus Mode**](https://support.zoom.us/hc/en-us/articles/360061113751-Using-focus-mode). When enabled, this feature only displays the host and co-hosts' video and profile pictures during a meeting. \n\n This value defaults to `false`.","type":"boolean","example":true},"auto_answer":{"description":"Whether to enable the [**Auto-answer group in chat**](https://support.zoom.us/hc/en-us/articles/203736135-Auto-answering-invitations-to-meetings) setting. Calls from these group members will be answered automatically.","type":"boolean","example":true},"auto_saving_chat":{"description":"Whether to automatically save all in-meeting chats.","type":"boolean","example":true},"breakout_room":{"description":"Whether to allow the meeting host to split meeting participants into separate breakout rooms.","type":"boolean","example":true},"breakout_room_schedule":{"description":"Whether the host can assign participants to breakout rooms when scheduling. This feature is **only** available in version 4.5.0 or higher.","type":"boolean","example":true},"chat":{"description":"Whether to enable chat during meeting for all participants.","type":"boolean","example":true},"meeting_question_answer":{"description":"Allow participants to ask questions for the host and participants to answer.","type":"boolean","example":true},"closed_caption":{"description":"Whether to enable closed captions.","type":"boolean","example":true},"closed_captioning":{"description":"Information about the account's closed captioning settings.","properties":{"auto_transcribing":{"description":"Whether to enable Zoom's [live transcription feature](https://support.zoom.us/hc/en-us/articles/207279736-Managing-closed-captioning-and-live-transcription#h_01FHGGHYJ4457H4GSZY0KM3NSB).","type":"boolean","example":true},"enable":{"description":"Whether to enable [closed captioning and transcription services](https://support.zoom.us/hc/en-us/articles/4409683389709-Enabling-or-disabling-closed-captioning-and-live-transcription-services).","type":"boolean","example":true},"save_caption":{"description":"Whether to allow participants to [save closed captions or transcripts](https://support.zoom.us/hc/en-us/articles/360060958752). \n\n **Note:** If the `view_full_transcript` field is set to `false`, participants **cannot** save captions.","type":"boolean","example":true},"third_party_captioning_service":{"description":"Whether to allow the use of an API token to integrate with a [3rd-party device](https://support.zoom.us/hc/en-us/articles/115002212983) to provide closed captioning.","type":"boolean","example":true},"view_full_transcript":{"description":"Whether to enable the viewing of full transcripts in the in-meeting side panel.","type":"boolean","example":true}},"type":"object"},"co_host":{"description":"Whether to allow the host to add co-hosts.","type":"boolean","example":true},"custom_data_center_regions":{"description":"Whether to use custom [data center regions](https://support.zoom.us/hc/en-us/articles/360042411451-Selecting-data-center-regions-for-meetings-webinars): \n* `true` — Users can [select data center regions](https://support.zoom.us/hc/en-us/articles/360042411451-Selecting-data-center-regions-for-hosted-meetings-and-webinars) to use for hosting real-time meeting traffic. The data center regions can be provided in the `data_center_regions` field. \n* `false` — Only use the default data center regions.","type":"boolean","example":true},"custom_live_streaming_service":{"description":"Whether to allow custom livestreaming.","type":"boolean","example":true},"custom_service_instructions":{"description":"The specific instructions to configure a custom livestream.","type":"string","example":"The specific instructions"},"data_center_regions":{"type":"array","description":"If the value of `custom_data_center_regions` is `true`, a comma-separated list of the following [data center regions](https://support.zoom.us/hc/en-us/articles/360059254691-Datacenter-abbreviation-list) to opt in to: \n* `AU` — Australia.\n* `LA` — Latin America. \n* `CA` — Canada. \n* `CN` — China. \n* `DE` — Germany. \n* `HK` — Hong Kong SAR. \n* `IN` — India. \n* `IE` — Ireland. \n* `TY` — Japan. \n* `MX` — Mexico. \n* `NL` — Netherlands. \n* `SG` — Singapore. \n* `US` — United States.","items":{"type":"string","enum":["AU","LA","CA","CN","DE","HK","IN","IE","TY","MX","NL","SG","US"],"example":"AU"}},"disable_screen_sharing_for_host_meetings":{"description":"Whether to enable the **Disable desktop screen sharing for meetings you host** setting.","type":"boolean","example":true},"disable_screen_sharing_for_in_meeting_guests":{"description":"Whether to enable the **Disable screen sharing when guests are in the meeting** setting.","type":"boolean","example":true},"dscp_audio":{"default":56,"description":"The DSCP audio marking value. This value defaults to `56`.","maximum":63,"minimum":1,"type":"integer","example":56},"dscp_marking":{"description":"Whether to enable [differentiated services code point (DSCP)](https://en.wikipedia.org/wiki/Differentiated_services) marking.","type":"boolean","example":true},"dscp_video":{"default":40,"description":"The DSCP video marking value. This value defaults to `40`.","maximum":63,"minimum":1,"type":"integer","example":40},"dscp_dual":{"type":"boolean","description":"Whether to use the differentiated services code point classifiers ('dscp_video', 'dscp_audio') in the dual way (incoming and outgoing).","example":false},"e2e_encryption":{"description":"Whether to require [AES encryption](https://en.wikipedia.org/wiki/Advanced_Encryption_Standard) for meetings.","type":"boolean","example":true},"entry_exit_chime":{"description":"When to play the meeting entry/exit sound notification: \n* `host` — Only when the host joins or leaves. \n* `all` — When any participant joins or leaves. \n* `none` - Disable the entry/exit sound notification.","enum":["host","all","none"],"type":"string","example":"host"},"far_end_camera_control":{"description":"Whether to allow another user to take control of the user's camera.","type":"boolean","example":true},"feedback":{"description":"Whether to enable the [**Feedback to Zoom**](https://support.zoom.us/hc/en-us/articles/115005838023-Feedback-to-Zoom) setting.","type":"boolean","example":true},"file_transfer":{"description":"Whether to enable the [**Send files via meeting chat**](https://support.zoom.us/hc/en-us/articles/209605493-In-meeting-file-transfer) setting.","type":"boolean","example":true},"group_hd":{"description":"Whether to enable group HD video.","type":"boolean","example":true},"join_from_desktop":{"description":"Whether to allow participants to join a meeting directly from their desktop browser. Note that the meeting experience from the desktop browser is limited.","type":"boolean","example":true},"join_from_mobile":{"description":"Whether to allow participants to join a meeting directly from their mobile browser. Note that the meeting experience from the mobile browser is limited.","type":"boolean","example":true},"auto_generated_translation":{"description":"Information about the [Translate captions](https://support.zoom.us/hc/en-us/articles/8158738379917-Managing-automated-captions-) settings in meetings.","properties":{"language_item_pairList":{"description":"Information about all  speak languages and  translation languages in meetings.","type":"object","properties":{"trans_lang_config":{"type":"array","description":"A list of speak languages and  translation languages.","items":{"type":"object","description":"A item of speak language and  translation languages in meetings.","properties":{"speak_language":{"type":"object","description":"language used in meetings","properties":{"name":{"type":"string","enum":["Chinese (Simplified)","Dutch","English","French","German","Italian","Japanese","Korean","Portuguese","Russian","Spanish","Ukrainian"],"example":"Chinese (Simplified)","description":"the name of language"},"code":{"type":"string","enum":["zh","nl","en","fr","de","it","ja","ko","pt","ru","es","uk"],"example":"zh","description":"th code for the language"}}},"translate_to":{"type":"object","description":"Information about all the translation languages.","properties":{"all":{"type":"boolean","example":true,"description":"Whether to select all the translation languages"},"language_config":{"type":"array","description":"A list of the translation languages.","items":{"type":"object","description":"A item of translation languages.","properties":{"name":{"type":"string","example":"English","enum":["English"],"description":"the name of translation language"},"code":{"type":"string","enum":["en"],"example":"en","description":"the code of translation language"}}}}}}}}},"all":{"description":"Whether to select all speak languages and translation languages","type":"boolean","example":true}}},"enable":{"description":"Whether to allow users to enable automated translated captions in these language pairs in meetings.","type":"boolean","example":true}},"type":"object"},"language_interpretation":{"description":"Information about the [language interpretation](https://support.zoom.us/hc/en-us/articles/360034919791-Using-Language-Interpretation-in-your-meeting-or-webinar) settings.","properties":{"custom_languages":{"description":"A list of user-defined supported languages.","items":{"type":"string","example":"English"},"type":"array"},"enable_language_interpretation_by_default":{"description":"Whether enable language interpretation by default.","type":"boolean","example":true},"allow_participants_to_speak_in_listening_channel":{"description":"Whether to allow participants to speak in listening channel.","type":"boolean","example":true},"allow_up_to_25_custom_languages_when_scheduling_meetings":{"description":"Whether to allow up to 25 custom languages when scheduling meetings.","type":"boolean","example":true},"enable":{"description":"Whether to allow hosts to assign participants as interpreters who can interpret one language into another in real-time.","type":"boolean","example":true}},"type":"object"},"live_streaming_facebook":{"description":"Whether to allow Facebook livestreaming.","type":"boolean","example":true},"live_streaming_youtube":{"description":"Whether to allow YouTube livestreaming.","type":"boolean","example":true},"manual_captioning":{"description":"Information about manual captioning settings.","properties":{"allow_to_type":{"description":"Whether to allow the host to manually caption or let the host assign a participant to provide manual captioning.","type":"boolean","example":true},"auto_generated_captions":{"description":"Whether to enable Zoom's [live transcription feature](https://support.zoom.us/hc/en-us/articles/207279736-Managing-closed-captioning-and-live-transcription#h_01FHGGHYJ4457H4GSZY0KM3NSB).","type":"boolean","example":true},"full_transcript":{"description":"Whether to enable the viewing of full transcripts in the in-meeting side panel.","type":"boolean","example":true},"manual_captions":{"description":"Whether to [enable manual closed captioning](https://support.zoom.us/hc/en-us/articles/207279736-Managing-closed-captioning-and-live-transcription).","type":"boolean","example":true},"save_captions":{"description":"Whether to allow participants to [save closed captions or transcripts](https://support.zoom.us/hc/en-us/articles/360060958752). \n\n **Note:** If the `full_transcript` field is set to `false`, participants **cannot** save captions.","type":"boolean","example":true},"third_party_captioning_service":{"description":"Whether to allow the use of an API token to integrate with a [3rd-party device](https://support.zoom.us/hc/en-us/articles/115002212983) to provide closed captioning.","type":"boolean","example":true}},"type":"object"},"meeting_reactions":{"description":"Whether meeting participants can [communicate using the emoji reactions](https://support.zoom.us/hc/en-us/articles/115001286183-Nonverbal-feedback-and-meeting-reactions) located in the **Reactions** menu in the meeting toolbar.","type":"boolean","example":true},"meeting_reactions_emojis":{"description":"Choose from the following meeting reaction options:\n* `all` — All emojis: Allow meeting participants to use any emoji available in Zoom chat as a reaction in a meeting.\n* `selected` — Selected emojis: Allow meeting participants to use the 6 standard meeting reaction emojis: Clapping Hands, Thumbs Up, Heart, Tears of Joy, Open Mouth, Party Popper (Tada, Celebration) ","type":"string","enum":["all","selected"],"x-enum-descriptions":["Allow meeting participants to use any emoji available in Zoom chat as a reaction in a meeting.","Allow meeting participants to use the 6 standard meeting reaction emojis: Clapping Hands, Thumbs Up, Heart, Tears of Joy, Open Mouth, Party Popper (Tada, Celebration) ."],"example":"all"},"allow_host_panelists_to_use_audible_clap":{"description":"Whether to allow host and panelist to use audible clap.","type":"boolean","example":true},"webinar_reactions":{"description":"Set this field to true to use [webinar reactions](https://support.zoom.us/hc/en-us/articles/4803536268429).","type":"boolean","example":true},"meeting_survey":{"description":"Whether to allow the host to present a survey to participants once a meeting has ended. This feature is only available in version 5.7.3 or higher.","type":"boolean","example":true},"original_audio":{"description":"Whether to allow users to select original sound in their client settings.","type":"boolean","example":true},"p2p_connetion":{"description":"Whether to enable the [**Peer to Peer connection while only 2 people are in a meeting**](https://support.zoom.us/hc/en-us/articles/360061410851-Enabling-Peer-to-Peer-connection-for-2-people-in-a-meeting) setting.","type":"boolean","example":true},"p2p_ports":{"description":"Whether to enable the **Listening ports range** setting.","type":"boolean","example":true},"polling":{"description":"Whether to add polls to the meeting controls.","type":"boolean","example":true},"meeting_polling":{"type":"object","description":"Information about the account's meeting polling settings.","properties":{"enable":{"type":"boolean","description":"Whether to allow the host to add polls before or during a meeting.","example":true},"advanced_polls":{"type":"boolean","description":"Whether to allow the host to create advanced polls and quizzes. Advanced polls and quizzes include single choice, multiple choice, drop down, matching, short answer, long answer, rank order, and fill-in-the-blank questions. Hosts can also set the correct answers for quizzes they create.","example":true},"require_answers_to_be_anonymous":{"description":"Whether to require answers to be anonymous.","type":"boolean","example":true},"manage_saved_polls_and_quizzes":{"description":"Whether to allow users to manage saved polls and quizzes from Meetings","type":"boolean","example":true},"allow_alternative_host_to_add_edit":{"type":"boolean","description":"Whether to allow the alternative host to add or edit polls and quizzes.","example":true},"allow_host_to_upload_image":{"description":"Whether to allow host to upload an image for each question.","type":"boolean","example":true}}},"ports_range":{"default":"","description":"When the `p2p_ports` value is `true`, the value is a semi-colon list of the peer to peer listening ports range, between `1` to `65535`. This value defaults to an empty string.","type":"string","example":"1;65535"},"post_meeting_feedback":{"description":"Whether to display a thumbs up or thumbs down feedback survey at the end of each meeting.","type":"boolean","example":true},"private_chat":{"description":"Whether to [enable private chat](https://support.zoom.us/hc/en-us/articles/360060835932-Enabling-and-disabling-private-chat) between participants during meetings.","type":"boolean","example":true},"record_play_own_voice":{"description":"Whether to let the user record and play their own voice.","type":"boolean","example":true},"remote_control":{"description":"Whether to enable the [**Remote control**](https://support.zoom.us/hc/en-us/articles/201362673-Requesting-or-giving-remote-control) setting.","type":"boolean","example":true},"non_verbal_feedback":{"default":false,"description":"Whether to enable the [**Non-verbal feedback**](https://support.zoom.us/hc/en-us/articles/115001286183-Nonverbal-feedback-and-meeting-reactions-) setting.  This value defaults to `false`.","type":"boolean","example":true},"remote_support":{"default":false,"description":"Whether to enable the [**Remote support**](https://support.zoom.us/hc/en-us/articles/360060951012-Enabling-remote-support) setting. This value defaults to `false`.","type":"boolean","example":true},"request_permission_to_unmute_participants":{"type":"boolean","description":"Whether to enable the [**Request permission to unmute participants**](https://support.zoom.us/hc/en-us/articles/203435537-Muting-and-unmuting-participants-in-a-meeting) setting.","example":true},"screen_sharing":{"description":"Whether to allow hosts and participants to share their screen or content during meetings.","type":"boolean","example":true},"sending_default_email_invites":{"description":"Whether to enable the [**Only show default email when sending email invites**](https://support.zoom.us/hc/en-us/articles/360061433531-Showing-default-email-when-sending-email-invites) setting.","type":"boolean","example":true},"show_a_join_from_your_browser_link":{"description":"Whether to allow participants to join a meeting directly from their browser and bypass the Zoom application download process. This is useful for participants who cannot download, install, or run applications. Note that the meeting experience from the browser is limited.","type":"boolean","example":true},"show_meeting_control_toolbar":{"description":"Whether to display the in-meeting control toolbar.","type":"boolean","example":true},"slide_control":{"description":"Whether the person sharing during a presentation can allow others to control the slide presentation. This feature is only available in version 5.8.3 or higher.","type":"boolean","example":true},"stereo_audio":{"description":"Whether to allow users to select stereo audio in their client settings.","type":"boolean","example":true},"use_html_format_email":{"description":"Whether to enable the use of HTML-formatted emails for the Outlook plugin.","type":"boolean","example":true},"virtual_background":{"description":"Whether to enable Virtual Backgrounds.","type":"boolean","example":true},"virtual_background_settings":{"description":"The account's Virtual Background settings.","properties":{"allow_upload_custom":{"description":"Whether to allow user to upload custom Virtual Backgrounds.","type":"boolean","example":true},"allow_videos":{"description":"Whether to allow the use of videos for Virtual Backgrounds.","type":"boolean","example":true},"enable":{"description":"Whether to enable Virtual Backgrounds.","type":"boolean","example":true},"files":{"description":"Information about the Virtual Background files.","items":{"properties":{"id":{"description":"The Virtual Background file's ID.","type":"string","example":"13refwef43svSFrwfrgfsrwrfew"},"is_default":{"description":"Whether the file is the default Virtual Background file.","type":"boolean","example":true},"name":{"description":"The Virtual Background file's name.","type":"string","example":"test.png"},"size":{"description":"The Virtual Background file's size, in bytes.","type":"integer","example":1235},"type":{"description":"The Virtual Background file's type.","type":"string","example":"image"}},"type":"object"},"type":"array"}},"type":"object"},"watermark":{"description":"Whether to include a [watermark](https://support.zoom.us/hc/en-us/articles/209605273-Adding-an-image-watermark) when viewing a shared screen.","type":"boolean","example":true},"webinar_chat":{"description":"Information about the account's webinar chat settings.","properties":{"allow_attendees_chat_with":{"description":"Allow webinar attendees to chat with: \n* `1` — No one. \n* `2` — Host and all panelists. \n* `3` — Everyone.","enum":[1,2,3],"type":"integer","example":1},"allow_auto_save_local_chat_file":{"description":"Whether to automatically save chat messages to a local file on the host's computer when the webinar ends.","type":"boolean","example":true},"allow_panelists_chat_with":{"description":"Allow webinar panelists to chat with: \n* `1` — Host and all panelists. \n* `2` — Everyone.","enum":[1,2],"type":"integer","example":1},"allow_panelists_send_direct_message":{"description":"Whether to allow webinar panelists to send direct messages to other panelists.","type":"boolean","example":true},"allow_users_save_chats":{"description":"Whether to allow webinar attendees to save chats: \n* `0` — Attendees cannot save chats. \n* `1` — Attendees can only save host and panelist chats. \n* `2` — Attendees can save all chats.","enum":[0,1,2],"type":"integer","example":1},"default_attendees_chat_with":{"description":"By default, allow webinar attendees to chat with: \n* `1` — Host and all panelists. \n* `2` — Everyone.","enum":[1,2],"type":"integer","example":1},"enable":{"description":"Whether to allow webinar participants to send chat messages.","type":"boolean","example":true}},"type":"object"},"webinar_live_streaming":{"properties":{"custom_service_instructions":{"description":"The specific instructions to allow the account's meeting hosts to configure a custom livestream.","type":"string","example":"The specific instructions"},"enable":{"description":"Whether to enable webinar livestreaming.","type":"boolean","example":true},"live_streaming_reminder":{"description":"Whether to notify users to watch the livestream. This does not apply to custom RTMP (real-time messaging protocol).","type":"boolean","example":true},"live_streaming_service":{"description":"The available livestreaming services: \n* `facebook` — Facebook. \n* `workplace_by_facebook` — Workplace by Facebook. \n* `youtube` — YouTube. \n* `custom_live_streaming_service` — Custom Live Streaming Service.","items":{"enum":["facebook","workplace_by_facebook","youtube","custom_live_streaming_service"],"type":"string","example":"facebook"},"type":"array"}},"type":"object"},"webinar_polling":{"description":"Information about the account's webinar polling settings.","properties":{"enable":{"description":"Whether to allow the host to add polls before or during a webinar.","type":"boolean","example":true},"advanced_polls":{"description":"Whether to allow the host to create advanced polls and quizzes. Advanced polls and quizzes include single choice, multiple choice, drop down, matching, short answer, long answer, rank order, and fill-in-the-blank questions. Hosts can also set the correct answers for quizzes they create.","type":"boolean","example":true},"require_answers_to_be_anonymous":{"description":"Whether to require answers to be anonymous.","type":"boolean","example":true},"manage_saved_polls_and_quizzes":{"description":"Whether to allow users to manage saved polls and quizzes from Meetings","type":"boolean","example":true},"allow_alternative_host_to_add_edit":{"type":"boolean","description":"Whether to allow the alternative host to add or edit polls and quizzes.","example":true},"allow_host_to_upload_image":{"description":"Whether to allow host to upload an image for each question.","type":"boolean","example":true}},"type":"object"},"webinar_question_answer":{"description":"Whether attendees can ask the host and panelists questions in the webinar.","type":"boolean","example":true},"webinar_survey":{"description":"Whether to allow the host to present surveys to attendees once a webinar has ended.","type":"boolean","example":true},"whiteboard":{"description":"Whether to enable the [**Zoom Whiteboard**](https://support.zoom.us/hc/en-us/articles/4410916881421) feature.","type":"boolean","example":true},"who_can_share_screen":{"description":"The type of user who can share their screen or content during meetings: \n* `host` — Only hosts can screen share. \n* `all` — Both hosts and participants can screen share.","enum":["host","all"],"type":"string","example":"host"},"who_can_share_screen_when_someone_is_sharing":{"description":"The type of user that can begin sharing their screen when someone else in the meeting is sharing their screen: \n* `host` — Only hosts can screen share when someone else is sharing. \n* `all` — Both hosts and participants can screen share when someone else is sharing.","enum":["host","all"],"type":"string","example":"all"},"participants_share_simultaneously":{"description":"Indicates how many participants can share at the same time. The value can be one of the following:<br>\n`one`: Only one participant can share at a time\n.<br>\n`multiple`: Multiple participants can share simultaneously (dual monitors recommended).","enum":["multiple","one"],"type":"string","example":"multiple"},"workplace_by_facebook":{"description":"Whether to allow Workplace by Facebook livestreaming.","type":"boolean","example":true},"transfer_meetings_between_devices":{"description":"Users can move to a new device without leaving the meeting they're in.","type":"boolean","example":true}},"type":"object"},"integration":{"description":"Account Settings: Integration.","properties":{"box":{"description":"Enable users who join a meeting from their mobile device to share content from their Box account.","type":"boolean","example":true},"dropbox":{"description":"Enable users who join a meeting from their mobile device to share content from their Dropbox account.","type":"boolean","example":true},"google_calendar":{"description":"Enable meetings to be scheduled using Google Calendar.","type":"boolean","example":true},"google_drive":{"description":"Enable users who join a meeting from their mobile device to share content from their Google Drive.","type":"boolean","example":true},"kubi":{"description":"Enable users to control a connected Kubi device from within a Zoom meeting.","type":"boolean","example":true},"microsoft_one_drive":{"description":"Enable users who join a meeting from their mobile device to share content from their Microsoft OneDrive account.","type":"boolean","example":true}},"type":"object"},"other_options":{"properties":{"allow_auto_active_users":{"description":"Whether administrators can activate users with a single default password when they add users. This immediately activates the users without waiting for them to set their own password.","type":"boolean","example":true},"allow_users_contact_support_via_chat":{"description":"Whether to display the Zoom Help badge on the bottom-right of the page.","type":"boolean","example":true},"allow_users_enter_and_share_pronouns":{"description":"Whether users can add pronouns to their profile cards and share them during meetings and webinars.","type":"boolean","example":true},"blur_snapshot":{"description":"Whether iOS blurs the screenshot in the task switcher when multiple apps are open. Android hides the screenshot in the system-level list of recent apps.","type":"boolean","example":true},"display_meetings_scheduled_for_others":{"description":"Whether a user with the [scheduling privilege](https://support.zoom.us/hc/en-us/articles/201362803-Scheduling-privilege) can view other users' meetings.","type":"boolean","example":true},"meeting_qos_and_mos":{"description":"The Dashboard meeting [quality scores and network alerts](https://support.zoom.us/hc/en-us/articles/360061244651) setting: \n* `0` — Do not enable meeting quality scores and network alerts on the Dashboard. \n* `1` — Display the meeting quality score and network alerts on the Dashboard. \n* `2` — Use custom thresholds for quality scores and network alerts. \n* `3` —Both Use custom thresholds for quality scores and network alerts and Display the meeting quality score and network alerts on the Dashboard.","enum":[0,1,2,3],"type":"integer","x-enum-descriptions":["Do not display meeting quality scores and network alerts on the Dashboard","Display the meeting quality score and network alerts on the Dashboard","Use custom thresholds for quality scores and network alerts"],"example":0},"show_one_user_meeting_on_dashboard":{"description":"Whether meetings with only one person will display on the Dashboard and in reports.","type":"boolean","example":true},"use_cdn":{"description":"Allow connections to different CDNs (content delivery networks) for a better web browsing experience. All users in your organization will use the selected CDN to access static resources: \n* `none` — Do not use a CDN. \n* `default` — Use the Amazon CloudFront CDN for users **except** Chinese Mainland users. Chinese Mainland users will use the Wangsu CDN (China). \n* `wangsu` — Use the Wangsu CDN for all users.","enum":["none","default","wangsu"],"type":"string","x-enum-descriptions":["Do not use use a CDN","All users will use the Amazon CloudFront CDN except Chinese Mainland users. Chinese Mainland users will use the Wangsu CDN (China)","All users use the Wangsu CDN (China)"],"example":"none"},"webinar_registration_options":{"type":"object","description":"Webinar registration options.","properties":{"allow_host_to_enable_join_info":{"type":"boolean","description":"Allow host to enable \"Show join info on registration confirmation page\".","example":true},"allow_host_to_enable_social_share_buttons":{"type":"boolean","description":"Allow host to enable \"Show social share buttons on registration page\".","example":true},"enable_custom_questions":{"type":"boolean","description":"Enable custom questions.","example":true}}}},"type":"object"},"profile":{"properties":{"recording_storage_location":{"properties":{"allowed_values":{"description":"Users can choose the country to store their recorded content. Content can include meeting, webinar, and phone recordings, as well as voicemail, transcripts, and custom greeting prompts. See [Managing the Communications Content storage location](https://support.zoom.us/hc/en-us/articles/360050781131) for details.\n\nProvide abbreviated country codes as the value for this field. See the [Countries abbreviation list](https://marketplace.zoom.us/docs/api-reference/other-references/abbreviation-lists#countries) for details.","items":{"type":"string","example":"US"},"type":"array"},"value":{"description":"Abbreviated country code.","type":"string","example":"US"}},"type":"object"}},"title":"Profile","type":"object"},"recording":{"description":"Account Settings: Recording.","properties":{"account_user_access_recording":{"description":"Cloud recordings are only accessible to account members. People outside of your organization cannot open links that provide access to cloud recordings.","type":"boolean","example":true},"allow_recovery_deleted_cloud_recordings":{"description":"Allow recovery of deleted cloud recordings from trash. \nIf the value of this field is set to `true`, deleted cloud recordings will be kept in trash for 30 days after deletion and can be recovered within that period. ","type":"boolean","example":true},"archive":{"description":"[Archiving solution](https://support.zoom.us/hc/en-us/articles/360050431572-Archiving-Meeting-and-Webinar-data) settings. This setting can only be used if you have been granted with archiving solution access by the Zoom support team.","properties":{"enable":{"description":"Enable the archiving feature.","type":"boolean","example":true},"settings":{"properties":{"audio_file":{"description":"Include in-meeting and/or in-webinar audio in the archive.","type":"boolean","example":true},"cc_transcript_file":{"description":"Include closed caption or transcript in the archive.","type":"boolean","example":true},"chat_file":{"description":"Include in-meeting chat in the archive.","type":"boolean","example":true},"chat_with_sender_email":{"description":"Include user email in in-meeting chat file.","type":"boolean","example":true},"video_file":{"description":"Include in-meeting and/or in-webinar video in the archive.","type":"boolean","example":true},"chat_with_direct_message":{"description":"Include direct message in in-meeting chat file.","type":"boolean","example":true},"archive_retention":{"description":"The retention period for archiving content, in days.","type":"integer","example":1,"enum":[1,2,3,4,5,6,7,8,9,10,11,12,13,14,15,16,17,18,19,20,21,22,23,24,25,26,27,28,29,30]},"action_when_archive_failed":{"description":"Perform the action when meetings or webinars cannot be archived.<br>`1` - Participants can stay in the meeting and will receive a notification.<br>`2` - Nobody can join or stay in the meeting.","type":"integer","example":1,"enum":[1,2]},"notification_when_archiving_starts":{"description":"Show notification when video or audio archiving starts.<br>`1` - Participants can stay in the meeting and will receive a notification.<br>`2` - Nobody can join or stay in the meeting.","type":"string","example":"participants","enum":["participants","guest"]},"play_voice_prompt_when_archiving_starts":{"description":"Play voice prompt when video or audio archiving starts.<br>`1` - Participants can stay in the meeting and will receive a notification.<br>`2` - Nobody can join or stay in the meeting.","type":"string","example":"guest","enum":["participants","guest","none"]}},"type":"object"},"type":{"description":"Archive types:\n\n* `1`: Only meetings are archived.<br>\n* `2`: Only webinars are archived.<br>\n* `3`: Both meetings and webinars are archived.","enum":[1,2,3],"type":"integer","example":1}},"type":"object"},"auto_delete_cmr":{"description":"Allow Zoom to permanently delete recordings automatically after a specified number of days.","type":"boolean","example":true},"auto_delete_cmr_days":{"description":"When the `auto_delete_cmr` value is `true`, this value is the number of days before the auto-deletion of cloud recordings: \n* `30` — 30 days. \n* `60` — 60 days. \n* `90` — 90 days. \n* `120` — 120 days.","enum":[30,60,90,120],"type":"integer","x-enum-descriptions":["30 days.","60 days.","90 days.","120 days."],"example":90},"record_files_separately":{"type":"object","description":"The account's [**Record active speaker, gallery view and shared screen separately**](https://support.zoom.us/hc/en-us/articles/360060316092-Changing-basic-and-advanced-cloud-recording-settings#h_01F4CYJTCTXNS2MXH00W9EFG6R) settings.","properties":{"active_speaker":{"type":"boolean","description":"Whether to record the active speaker only.","example":true},"gallery_view":{"type":"boolean","description":"Whether to record the gallery view only.","example":true},"shared_screen":{"type":"boolean","description":"Whether to record the shared screen only.","example":true}}},"display_participant_name":{"type":"boolean","description":"Whether to display participants' names in the recording.","example":true},"recording_thumbnails":{"type":"boolean","description":"Whether to record thumbnails of the presenter when they are sharing their screen.","example":true},"optimize_recording_for_3rd_party_video_editor":{"type":"boolean","description":"Whether to optimize recordings for a 3rd party video editor. This may increase the file size and the time it takes to generate recording files.","example":true},"recording_highlight":{"type":"boolean","description":"Whether to enable the [recording highlights](https://support.zoom.us/hc/en-us/articles/360060802432) feature.","example":true,"deprecated":true},"save_panelist_chat":{"type":"boolean","description":"Whether to save panelist chat to the recording. This setting saves messages sent by panelists during a webinar to either all panelists or all panelists and attendees to the recording.","example":true},"save_poll_results":{"type":"boolean","description":"Whether to save poll results shared during the meeting or webinar. This also includes poll results shared during the meeting or webinar.","example":true},"save_close_caption":{"type":"boolean","description":"Whether to save [closed captions](https://support.zoom.us/hc/en-us/articles/207279736) as a VTT (Video Track Text) file.","example":true},"auto_recording":{"description":"Automatic recording:<br>`local` - Record on local.<br>`cloud` -  Record on cloud.<br>`none` - Disabled.","enum":["local","cloud","none"],"type":"string","x-enum-descriptions":["Record on local","Record on cloud","Disabled"],"example":"local"},"cloud_recording":{"description":"Allow hosts to record and save the meeting in the cloud.","type":"boolean","example":true},"cloud_recording_download":{"description":"Cloud recording downloads.","type":"boolean","example":true},"cloud_recording_download_host":{"description":"Only the host can download cloud recordings.","type":"boolean","example":true},"host_delete_cloud_recording":{"description":"If the value of this field is set to `true`, hosts will be able to delete the recordings. If this option is set to `false`, the recordings cannot be deleted by the host and only admin can delete them.\n","type":"boolean","example":true},"ip_address_access_control":{"description":"Setting to allow cloud recording access only from specific IP address ranges.\n","properties":{"enable":{"description":"If set to `true`, the cloud recordings of this account can only be accessed by the IP addresses defined in the `ip_addresses_or_ranges` property.\n\n","type":"boolean","example":true},"ip_addresses_or_ranges":{"description":"IP addresses or ranges that have access to the cloud recordings. Separate multiple IP ranges with comma. Use n.n.n.n, n.n.n.n/n or n.n.n.n - n.n.n.n syntax where n is a number.\n\nExample: `46.33.24.184, 48.99.100.2/25` or `200.181.108.17 - 220.181.108.157`\n\n","type":"string","example":"46.33.24.184"}},"type":"object"},"local_recording":{"description":"Allow hosts and participants to record the meeting using a local file.","type":"boolean","example":true},"prevent_host_access_recording":{"description":"If set to `true`, meeting hosts cannot view their meeting cloud recordings. Only the admins who have recording management privilege can access them.\n","type":"boolean","example":true},"record_audio_file":{"description":"Whether to record one audio file for all participants.","type":"boolean","example":true},"record_gallery_view":{"description":"Record the gallery view with a shared screen.","type":"boolean","example":true},"record_speaker_view":{"description":"Record the active speaker with a shared screen.","type":"boolean","example":true},"recording_audio_transcript":{"description":"Automatically transcribe the audio of the meeting or webinar to the cloud.","type":"boolean","example":true},"recording_disclaimer":{"description":"Show a disclaimer to participants before a recording starts\n","type":"boolean","example":true},"smart_recording":{"description":"By selecting this option, your recording will have meeting smart chapters, and next steps. You are directing Zoom to access, process, and use your account's recording data for the purpose of analysis and insights.","properties":{"create_recording_highlights":{"description":"By selecting this option, meeting details in the audio transcript will be highlighted. Hosts can modify highlighted sections and generate a video summary (highlighted sections may have a 3-second offset) based on these sections. The summary is for informational purposes only and may not be complete.","type":"boolean","example":true},"create_smart_chapters":{"description":"By selecting this option, your recording will have chapters with overview. Hosts can edit the chapters.","type":"boolean","example":true},"create_next_steps":{"description":"By selecting this option, there will be a summary of actions to take after the recorded meeting.","type":"boolean","example":true}},"type":"object"},"recording_password_requirement":{"description":"This object represents the minimum password requirements set for recordings via Account Recording Settings.","properties":{"have_letter":{"description":"Indicates whether or not password must contain at least one alphabetical letter (a, b, c..).","type":"boolean","example":true},"have_number":{"description":"Indicates whether or not password must contain at least one number(1, 2, 3..).","type":"boolean","example":true},"have_special_character":{"description":"Indicates whether or not password must contain at least one special character(!, @, #..).","type":"boolean","example":true},"length":{"description":"Minimum required length for the password.","maximum":10,"type":"integer","example":10},"only_allow_numeric":{"description":"Indicates whether or not password must contain only numeric characters.","type":"boolean","example":true}},"type":"object"},"required_password_for_existing_cloud_recordings":{"description":"Require a passcode to access existing cloud recordings.","type":"boolean","example":true},"required_password_for_shared_cloud_recordings":{"type":"boolean","description":"Whether to require a passcode to share cloud recordings.","example":true},"save_chat_text":{"description":"Save the chat text from the meeting.","type":"boolean","example":true},"show_timestamp":{"description":"Add a timestamp to the recording.","type":"boolean","example":true}},"type":"object"},"schedule_meeting":{"description":"Account Settings: Schedule Meeting.","properties":{"audio_type":{"default":"both","description":"Determine how participants can join the audio portion of the meeting.<br>`both` - Telephony and VoIP.<br>`telephony` - Audio PSTN telephony only.<br>`voip` - VoIP only.<br>`thirdParty` - 3rd party audio conference.","enum":["both","telephony","voip","thirdParty"],"type":"string","x-enum-descriptions":["Telephony and VoIP","Audio PSTN telephony only","VoIP only","3rd party audio conference"],"example":"both"},"enforce_login":{"description":"Only Zoom users who are signed in can join meetings.","type":"boolean","example":true},"enforce_login_domains":{"description":"Only signed in users with a specified domain can join the meeting. ","type":"string","example":"example.com"},"enforce_login_with_domains":{"description":"Only signed in users with a specific domain can join meetings.","type":"boolean","example":true},"force_pmi_jbh_password":{"description":"Require a password for Personal Meetings if attendees can join before host.","type":"boolean","example":true},"host_video":{"description":"Start meetings with the host video on.","type":"boolean","example":true},"jbh_time":{"description":"If the value of \"join_before_host\" field is set to `true`, this field can be used to indicate time limits within which a participant may join a meeting before a host. The value of this field can be one of the following:\n\n*  `0`: Allow participant to join anytime.\n*  `5`: Allow participant to join 5 minutes before meeting start time.\n * `10`: Allow participant to join 10 minutes before meeting start time.","enum":[0,5,10,15],"type":"integer","example":10},"join_before_host":{"description":"Allow participants to join the meeting before the host arrives.","type":"boolean","example":true},"meeting_password_requirement":{"description":"Account wide meeting or webinar [password requirements](https://support.zoom.us/hc/en-us/articles/360033559832-Meeting-and-webinar-passwords#h_a427384b-e383-4f80-864d-794bf0a37604).","properties":{"consecutive_characters_length":{"description":"\nSpecify the max length of consecutive characters(abcde...) that can be used in a password.\nIf you set the value of this field to `0`, no restriction will be applied on consecutive characters. \n\nIf you would like to set this restriction, you can specify a number between 4 and 8 that define the maximum allowed length for consecutive characters in a password.\n\nThe max allowed length will be `n-1` where `n` refers to the value you provide for this field.  For instance, if you provide `4` as the value, there can only be a maximum of `3` consecutive characters in a password(example: abc1x@8fdh).","enum":[0,4,5,6,7,8],"type":"integer","example":5},"have_letter":{"description":"If set to `true`, the password must contain at least 1 letter (such as a,b,c...).\n","type":"boolean","example":true},"have_number":{"description":"If set to `true`, the password must contain at least 1 number (such as 1,2,3...).","type":"boolean","example":true},"have_special_character":{"description":"If set to `true`, the password must have at least 1 special character (!,@,#...).","type":"boolean","example":true},"have_upper_and_lower_characters":{"description":"If set to `true`, the password must include both uppercase and lowercase characters.","type":"boolean","example":true},"length":{"description":"The minimum length that the meeting or webinar password must have.","type":"integer","example":10},"only_allow_numeric":{"description":"If set to `true`, the password must only contain numbers and no other characters.","type":"boolean","example":true},"weak_enhance_detection":{"description":"If set to `true`, users will be informed if the provided password is weak.","type":"boolean","example":true}},"type":"object"},"not_store_meeting_topic":{"description":"Always display \"Zoom Meeting\" as the meeting topic.","type":"boolean","example":true},"participant_video":{"description":"Start meetings with the participant video on. Participants can change this setting during the meeting.","type":"boolean","example":true},"personal_meeting":{"description":"Personal Meeting Setting.<br><br>\n`true`: Indicates that the **\"Enable Personal Meeting ID\"** setting is turned on. Users can choose to use personal meeting ID for their meetings. <br><br>\n`false`: Indicates that the **\"Enable Personal Meeting ID\"** setting is [turned off](https://support.zoom.us/hc/en-us/articles/201362843-Personal-meeting-ID-PMI-and-personal-link#h_aa0335c8-3b06-41bc-bc1f-a8b84ef17f2a). If this setting is disabled, meetings that were scheduled with a PMI will be invalid. Scheduled meetings will need to be manually updated.\nFor Zoom Phone only: If a user has been assigned a desk phone, **\"Elevate to Zoom Meeting\"** on desk phone will be disabled.\n\n\n","type":"boolean","example":true},"require_password_for_instant_meetings":{"description":"Require a password for instant meetings. If you use a PMI for your instant meetings, this option will be disabled. This setting is always enabled for free accounts and Pro accounts with a single host and cannot be modified for these accounts.\n","type":"boolean","example":true},"require_password_for_pmi_meetings":{"description":"Require a password for a meeting held using a Personal Meeting ID (PMI). This setting is always enabled for free accounts and Pro accounts with a single host and cannot be modified for these accounts.\n","enum":["jbh_only","all","none"],"type":"string","x-enum-descriptions":["Only meetings with Join Before Host enabled","All meetings using PMI","All meetings using a PMI","Disabled"],"example":"none"},"require_password_for_scheduled_meetings":{"description":"Require a password for meetings which have already been scheduled.\n","type":"boolean","example":true},"require_password_for_scheduling_new_meetings":{"description":"Require a password when scheduling new meetings. This setting applies for regular meetings that do not use a PMI. If enabled, a password will be generated while a host schedules a new meeting and participants will be required to enter the password before they can join the meeting. This setting is always enabled for free accounts and Pro accounts with a single host and cannot be modified for these accounts.","type":"boolean","example":true},"use_pmi_for_instant_meetings":{"description":"Use a Personal Meeting ID (PMI) when starting an instant meeting.","type":"boolean","example":true},"use_pmi_for_scheduled_meetings":{"description":"Use a Personal Meeting ID (PMI) when scheduling a meeting.","type":"boolean","example":true},"always_display_zoom_meeting_as_topic":{"description":"Information about the [**Always display \"Zoom Meeting\" as the meeting topic**](https://support.zoom.us/hc/en-us/articles/201363253-Changing-account-settings#h_01EG9BJ646V2WJK1S3H2MP6YV6) setting.","type":"object","properties":{"enable":{"type":"boolean","description":"Whether to enable the **Always display \"Zoom Meeting\" as the meeting topic** setting.","example":true},"display_topic_for_scheduled_meetings":{"type":"boolean","description":"Whether to display \"Zoom Meeting\" as the topic for already-scheduled meetings.","example":true}}},"hide_meeting_description":{"type":"object","description":"Information about the **Hide meeting description** feature.","properties":{"enable":{"type":"boolean","description":"Whether to enable the **Hide meeting description** setting.","example":true},"hide_description_for_scheduled_meetings":{"type":"boolean","description":"Whether to hide the description for already-scheduled meetings.","example":true}}},"always_display_zoom_webinar_as_topic":{"type":"object","description":"Information about the [**Always show \"Zoom Webinar\" as the webinar topic**](https://support.zoom.us/hc/en-us/articles/201363253-Changing-account-settings#h_01EG9BJ646V2WJK1S3H2MP6YV6) setting.","properties":{"enable":{"type":"boolean","description":"Whether to enable the **Always show \"Zoom Webinar\" as the webinar topic** setting.","example":true},"display_topic_for_scheduled_webinars":{"type":"boolean","description":"Whether to display \"Zoom Webinar\" as the topic for already-scheduled meetings.","example":true}}},"hide_webinar_description":{"type":"object","description":"Information about the **Hide webinar description** feature.","properties":{"enable":{"type":"boolean","description":"Whether to enable the **Hide webinar description** setting.","example":true},"hide_description_for_scheduled_webinars":{"type":"boolean","description":"Whether to hide webinar description for the webinars which have already been scheduled.","example":true}}}},"type":"object"},"telephony":{"description":"Account Settings Update: Telephony.","properties":{"audio_conference_info":{"description":"Third party audio conference info.","type":"string","example":"test"},"telephony_regions":{"description":"Indicates where most of the participants call into or call from during a meeting.","properties":{"selection_values":{"description":"The account's selected telephony regions that indicate where most participants call into or call from during a meeting.","type":"string","example":"USTB"}},"type":"object"},"third_party_audio":{"description":"Users can join the meeting using the existing third party audio configuration.","type":"boolean","example":true}},"type":"object"},"tsp":{"description":"Account Settings: TSP.","properties":{"call_out":{"description":"Call Out","type":"boolean","example":true},"call_out_countries":{"description":"Call Out Countries/Regions","items":{"type":"string","example":"us"},"type":"array"},"display_toll_free_numbers":{"description":"Display toll-free numbers","type":"boolean","example":true},"show_international_numbers_link":{"description":"Show international numbers link on the invitation email","type":"boolean","example":true}},"type":"object"},"zoom_rooms":{"description":"Account Settings: Zoom Rooms.","properties":{"auto_start_stop_scheduled_meetings":{"description":"Automatic start and stop for scheduled meetings.","type":"boolean","example":true},"cmr_for_instant_meeting":{"description":"Cloud recording for instant meetings.","type":"boolean","example":true},"force_private_meeting":{"description":"Shift all meetings to private.","type":"boolean","example":true},"hide_host_information":{"description":"Hide host and meeting ID from private meetings.","type":"boolean","example":true},"list_meetings_with_calendar":{"description":"Display meeting list with calendar integration.","type":"boolean","example":true},"start_airplay_manually":{"description":"Start AirPlay service manually.","type":"boolean","example":true},"ultrasonic":{"description":"Automatic direct sharing using an ultrasonic proximity signal.","type":"boolean","example":true},"upcoming_meeting_alert":{"description":"Upcoming meeting alert.","type":"boolean","example":true},"weekly_system_restart":{"description":"Weekly system restart.","type":"boolean","example":true},"zr_post_meeting_feedback":{"description":"Zoom Room post meeting feedback.","type":"boolean","example":true}},"type":"object"}},"title":"Information about the account's updated settings.","type":"object"},{"oneOf":[{"description":"Set/ update [authentication profile](https://support.zoom.us/hc/en-us/articles/360037117472-Authentication-Profiles-for-Meetings-and-Webinars).<br><br> The authentication profile **must first be set at the account level via the account settings**, and later can be disabled after enabling on the preferred level - i.e. user level using user settings or at group level via group settings  (if you do not want the settings to be enabled on the entire account).","properties":{"allow_authentication_exception":{"description":"Whether to enable the [**Allow authentication exception**](https://support.zoom.us/hc/en-us/articles/360037117472#h_01F13A9N1FQFNVESC9C21NRHXY) setting. This lets hosts invite users who can bypass authentication.","type":"boolean","example":true},"authentication_option":{"description":"Meeting Authentication Options","properties":{"action":{"description":"Specify the action that you would like to take via this API request:<br>\n* `add` : Choose this value if you are adding an authentication option.\n* `update`: Choose this value if you are updating an existing authentication option.\n* `delete`: Choose this value if you are deleting an existing authentication option.","enum":["update","delete","add"],"type":"string","example":"update"},"default_option":{"description":"Specify whether you would like to set this authentication option as the default option or not.","type":"boolean","example":true},"domains":{"description":"If you chose `enforce_login_with_domains` as the authentication type, specify the domain(s) that you want to allow to join your meetings or webinars. ","type":"string","example":"example.com"},"id":{"description":" Authentication ID. If you are creating an authentication profile, you do not need to provide this field. The id field will be generated in the response once this API request is completed successfully. You can also use the Get Account Settings API with query parameter set to `meeting_authentication` to list the authentication id.<br><br>\n Use this field or the `name` field to identify the associated authentication option that you would like to update or delete.","type":"string","example":"13rfefrg43erberbre"},"name":{"description":"Unique name for the authentication option.","type":"string","example":"test name"},"type":{"description":" Authentication type. Specify one of the following authentication types for the authentication profile:<br>\n * `enforce_login`: This option allows any users to join the meeting or webinar, as long as they are signed into their Zoom account.\n * `enforce_login_with_domains`: This option, allows you to specify a rule so that only those Zoom users whose email addresses contain a certain domain, can join the meeting or webinar. You can either add multiple domains using a comma in between and/or use a wildcard for listing domains.<br>\n * `enforce_login_with_same_account`: This option allows users to join the meeting or webinar with the same Zoom account.","enum":["enforce_login","enforce_login_with_same_account","enforce_login_with_domains"],"type":"string","example":"enforce_login_with_domains"}},"type":"object"},"meeting_authentication":{"description":"If set to \"true\", only authenticated users can join meetings. The method for authentication can be defined in the \"authentication_option\". ","type":"boolean","example":true}},"type":"object"},{"description":"Set/Update [authentication profile for Cloud Recordings](https://support.zoom.us/hc/en-us/articles/360037756671-Authentication-Profiles-for-Cloud-Recordings).","properties":{"authentication_option":{"description":"Specify the authentication options for this account.","properties":{"action":{"description":"Specify the action that you would like to take via this API request:<br>\n* `add` : Choose this value if you are adding an authentication option.\n* `update`: Choose this value if you are updating an existing authentication option.\n* `delete`: Choose this value if you are deleting an existing authentication option.","enum":["update","delete","add"],"type":"string","example":"update"},"default_option":{"description":"Specify whether you would like to set this authentication option as the default option or not.","type":"boolean","example":true},"domains":{"description":"If you chose `enforce_login_with_domains` as the authentication type, specify the domain(s) that you want to allow to view the recordings. ","type":"string","example":"example.com"},"id":{"description":" Authentication ID. If you are creating an authentication profile, you do not need to provide this field. The id field will be generated in the response once this API request is completed successfully. You can also use the Get Account Settings API with query parameter set to `meeting_authentication` to list the authentication id.<br><br>\nUse this field or the `name` field to identify the associated authentication option that you would like to update or delete.","type":"string","example":"dsfwefweff32324"},"name":{"description":"Unique name for the authentication option.","type":"string","example":"Unique name"},"type":{"description":"Specify one authentication type that is to be associated with this authentication configuration:<br>\n* `internally`: This option allows you specify a rule that only signed in users within your account can view the recording.<br>\n * `enforce_login`: This option allows any users to view the recording, as long as they are signed into their Zoom account.<br>\n * `enforce_login_with_domains`: This option, allows you to specify a rule so that only those Zoom users whose email addresses contain a certain domain, can view the recording. You can either add multiple domains using a comma in between and/or use a wildcard for listing domains.\n\n","enum":["internally","enforce_login","enforce_login_with_domains"],"type":"string","example":"enforce_login_with_domains"}},"type":"object"},"recording_authentication":{"description":"If set to `true`, only authenticated users can view the cloud recordings.<br><br>\nThe authentication profile **must first be set at the account level via the account settings**, and later can be disabled after enabling on the preferred level - i.e. user level using user settings or at group level via group settings  (if you do not want the settings to be enabled on the entire account).","type":"boolean","example":true}},"type":"object"}],"title":"AccountSettingsAuthenticationUpdate","type":"object"},{"description":"The account's updated meeting and webinar security settings.","properties":{"meeting_security":{"properties":{"auto_security":{"description":"Whether to require that all meetings are secured with at least one security option. \n\n This setting can only be disabled by Enterprise, ISV, Business (with more than 100 licenses), and Education accounts.","type":"boolean","example":true},"block_user_domain":{"description":"Whether to block users in specific domains from joining meetings and webinars.","type":"boolean","example":true},"block_user_domain_list":{"description":"The domain to block, up to 20 domains. For example, the `*.example.com` domain.","items":{"maxLength":30,"minLength":5,"type":"string","example":"example.com"},"maxItems":20,"type":"array"},"chat_etiquette_tool":{"description":"Information about the **Chat Etiquette** Tool.","properties":{"enable":{"default":false,"description":"Whether to enable the **Chat Etiquette Tool**. This value defaults to `false`. \n\n The **Chat Etiquette Tool** allows you to define specific keywords and text patterns in chat to prevent users from inadvertently sharing unwanted messages.","type":"boolean","example":true},"operate":{"description":"The policy operation to perform for the update: \n* `create` — Create policies. \n* `update` — Update policies. \n* `delete` — Delete policies.","enum":["create","update","delete"],"type":"string","x-enum-descriptions":["Add new policies.","Update policies.","Delete policies."],"example":"update"},"policies":{"description":"Information about the defined **Chat Etiquette Tool** policies.","items":{"properties":{"description":{"description":"The policy's description.","type":"string","example":"The policy's description"},"id":{"description":"The policy ID.","type":"string","example":"afwefwef243fwef132f2g43g43g44br"},"is_locked":{"default":false,"description":"Whether to lock the policy. When it is locked, users cannot update the policy. This value defaults to `false`.","type":"boolean","example":true},"keywords":{"description":"A list of defined rule keywords.","items":{"type":"string","example":"test"},"type":"array"},"name":{"description":"The policy name.","type":"string","example":"the policy name"},"regular_expression":{"description":"The regular expression to match to the content of chat messages.","type":"string","example":"^test"},"status":{"description":"The policy's current status: \n* `activated` — Activated. \n* `deactivated` — Deactivated.","enum":["activated","deactivated"],"type":"string","x-enum-descriptions":["Activated.","Deactivated."],"example":"activated"},"trigger_action":{"description":"The policy's trigger action: \n* `1` — Ask the user to confirm before they send the message. \n* `2` — Block the user's message.","enum":[1,2],"type":"integer","x-enum-descriptions":["Ask the user to confirm before they send the message.","Block the user's message."],"example":1}},"type":"object"},"type":"array"}},"type":"object"},"embed_password_in_join_link":{"description":"Whether the meeting password will be encrypted and included in the invitation link. The provided link will allow participants to join the meeting without having to enter the password.","type":"boolean","example":true},"encryption_type":{"description":"The type of encryption to use when starting a meeting: \n* `enhanced_encryption` — Use enhanced encryption. Encryption data is stored in the cloud. \n* `e2ee` — End-to-end encryption. The encryption key is stored on the local device and cannot be obtained by anyone else. Enabling E2EE also [**disables** certain features](https://support.zoom.us/hc/en-us/articles/360048660871), such as cloud recording, live streaming, and allowing participants to join before the host.","enum":["enhanced_encryption","e2ee"],"type":"string","example":"e2ee"},"end_to_end_encrypted_meetings":{"description":"Whether to enable end-to-end encryption for meetings. If enabled, you can specify the type of encryption in the `encryption_type` field.","type":"boolean","example":true},"meeting_password":{"description":"Whether all instant and scheduled meetings that users can join via client or Zoom Rooms systems are password-protected. [Personal Meeting ID (PMI)](https://support.zoom.us/hc/en-us/articles/203276937) meetings are **not** included in this setting.","type":"boolean","example":true},"meeting_password_requirement":{"description":"Information about the meeting and webinar [password requirements](https://support.zoom.us/hc/en-us/articles/360033559832-Meeting-and-webinar-passwords#h_a427384b-e383-4f80-864d-794bf0a37604).","properties":{"consecutive_characters_length":{"description":"The maximum length of consecutive characters (for example, `abcdef`) allowed in a password: \n* `4` through `8` — The maximum consecutive characters length. The length is `n` minus `1`, where `n` is the provided value. For example, if you provide the `4` value, there can only be a maximum of `3` consecutive characters in a password (for example, `abc1x@8fdh`). \n* `0` — Do not apply a consecutive character restriction.","enum":[0,4,5,6,7,8],"type":"integer","example":8},"have_letter":{"description":"Whether the password must contain at least one letter character.","type":"boolean","example":true},"have_number":{"description":"Whether the password must contain at least one numeric character.","type":"boolean","example":true},"have_special_character":{"description":"Whether the password must contain at least one special character. For example, `!`, `@`, and/or `#` characters.","type":"boolean","example":true},"have_upper_and_lower_characters":{"description":"Whether the password must include uppercase and lowercase characters.","type":"boolean","example":true},"length":{"description":"The password's minimum length.","type":"integer","example":8},"only_allow_numeric":{"description":"Whether the password must contain **only** numeric characters.","type":"boolean","example":true},"weak_enhance_detection":{"description":"Whether users will be informed when the provided password is weak.","type":"boolean","example":true}},"type":"object"},"only_authenticated_can_join_from_webclient":{"description":"Whether to specify that only authenticated users can join the meeting from the web client.","type":"boolean","example":true},"phone_password":{"description":"Whether to require a password for participants joining by phone. \n\n If enabled and the meeting is password-protected, a numeric password is required for participants to join by phone. For meetings with alphanumeric passwords, a numeric password will be generated.","type":"boolean","example":true},"pmi_password":{"description":"Whether all Personal Meeting ID (PMI) meetings that users can join via client or Zoom Rooms systems are password-protected.","type":"boolean","example":true},"require_password_for_scheduled_meeting":{"description":"Whether to require a password for meetings that have already been scheduled.","type":"boolean","example":true},"require_password_for_scheduled_webinar":{"description":"Whether to require a password for webinars that have already been scheduled.","type":"boolean","example":true},"waiting_room":{"description":"Whether participants are placed in the [**Waiting Room**](https://support.zoom.us/hc/en-us/articles/115000332726-Waiting-Room) when they join a meeting. \n\n If the **Waiting Room** feature is enabled, the [**Allow participants to join before host**](https://support.zoom.us/hc/en-us/articles/202828525-Allow-participants-to-join-before-host) setting is automatically disabled.","type":"boolean","example":true},"waiting_room_settings":{"description":"Information about the Waiting Room settings.","properties":{"participants_to_place_in_waiting_room":{"description":"The type of participants to be admitted to the Waiting Room: \n* `0` — All attendees. \n* `1` — Users who are not in your account. \n* `2` — Users who are not in your account and are not part of your [allowed domains list](https://support.zoom.us/hc/en-us/articles/360037117472-Configuring-authentication-profiles#h_e3cf0d5f-eec7-4c2a-ad29-ef2a5079a7da).","enum":[0,1,2],"type":"integer","example":0},"users_who_can_admit_participants_from_waiting_room":{"description":"The users who can admit participants from the Waiting Room: \n* `0` — Host and co-hosts only. \n* `1` — Host, co-hosts, and anyone who bypassed the Waiting Room if the host and co-hosts are not present.","enum":[0,1],"type":"integer","example":0},"whitelisted_domains_for_waiting_room":{"description":"If the `participants_to_place_in_waiting_room` field is `2`, a comma-separated list of the domains that can bypass the Waiting Room (`\"example.com,example2.com\"`).","type":"string","example":"example2.com"}},"type":"object"},"webinar_password":{"description":"Whether to generate a password when scheduling webinars. Participants must use the generated password to join the scheduled webinar.","type":"boolean","example":true}},"type":"object"}},"title":"Meeting or Webinar Security Account Settings","type":"object"},{"title":"Update Video SDK Account Settings","type":"object","properties":{"in_meeting":{"deprecated":true,"type":"object","properties":{"custom_data_center_regions":{"description":"Whether to use custom [data center regions](https://support.zoom.us/hc/en-us/articles/360042411451-Selecting-data-center-regions-for-meetings-webinars): \n* `true` — Users can [select data center regions](https://support.zoom.us/hc/en-us/articles/360042411451-Selecting-data-center-regions-for-hosted-meetings-and-webinars) to use for hosting real-time meeting traffic. The data center regions can be provided in the `data_center_regions` field. \n* `false` — Only use the default data center regions.","type":"boolean","example":false},"data_center_regions":{"type":"array","description":"If the value of `custom_data_center_regions` is `true`, a comma-separated list of the following [data center regions](https://support.zoom.us/hc/en-us/articles/360059254691-Datacenter-abbreviation-list) to opt in to: \n* `AU` — Australia.\n* `LA` — Latin America. \n* `CA` — Canada. \n* `CN` — China. \n* `DE` — Germany. \n* `HK` — Hong Kong SAR. \n* `IN` — India. \n* `IE` — Ireland. \n* `TY` — Japan. \n* `MX` — Mexico. \n* `NL` — Netherlands. \n* `SG` — Singapore. \n* `US` — United States.","items":{"type":"string","enum":["AU","LA","CA","CN","DE","HK","IN","IE","TY","MX","NL","SG","US"],"example":"US"}}}},"in_session":{"type":"object","properties":{"custom_data_center_regions":{"description":"Whether to use custom [data center regions](https://support.zoom.us/hc/en-us/articles/360042411451-Selecting-data-center-regions-for-meetings-webinars): \n* `true` — Users can [select data center regions](https://support.zoom.us/hc/en-us/articles/360042411451-Selecting-data-center-regions-for-hosted-meetings-and-webinars) to use for hosting real-time meeting traffic. The data center regions can be provided in the `data_center_regions` field. \n* `false` — Only use the default data center regions.","type":"boolean","example":false},"data_center_regions":{"type":"array","description":"If the value of `custom_data_center_regions` is `true`, a comma-separated list of the following [data center regions](https://support.zoom.us/hc/en-us/articles/360059254691-Datacenter-abbreviation-list) to opt in to: \n* `AU` — Australia.\n* `LA` — Latin America. \n* `CA` — Canada. \n* `CN` — China. \n* `DE` — Germany. \n* `HK` — Hong Kong SAR. \n* `IN` — India. \n* `IE` — Ireland. \n* `TY` — Japan. \n* `MX` — Mexico. \n* `NL` — Netherlands. \n* `SG` — Singapore. \n* `US` — United States.","items":{"type":"string","enum":["AU","LA","CA","CN","DE","HK","IN","IE","TY","MX","NL","SG","US"],"example":"US"}},"p2p_connetion":{"description":"Whether to enable the [**Peer to Peer connection while only 2 people are in a meeting**](https://support.zoom.us/hc/en-us/articles/360061410851-Enabling-Peer-to-Peer-connection-for-2-people-in-a-meeting) setting.","type":"boolean","example":true},"p2p_ports":{"description":"Whether to enable the **Listening ports range** setting.","type":"boolean","example":true},"ports_range":{"default":"","description":"When the `p2p_ports` value is `true`, the value is a semi-colon list of the peer to peer listening ports range, between `1` to `65535`. This value defaults to an empty string.","type":"string","example":"1;65535"},"dscp_audio":{"default":56,"description":"The DSCP audio marking value. This value defaults to `56`.","maximum":63,"minimum":1,"type":"integer","example":56},"dscp_marking":{"description":"Whether to enable [differentiated services code point (DSCP)](https://en.wikipedia.org/wiki/Differentiated_services) marking.","type":"boolean","example":true},"dscp_video":{"default":40,"description":"The DSCP video marking value. This value defaults to `40`.","maximum":63,"minimum":1,"type":"integer","example":40},"dscp_dual":{"type":"boolean","description":"Whether to use the differentiated services code point classifiers ('dscp_video', 'dscp_audio') in the dual way (incoming and outgoing).","example":false},"subsession":{"description":"Allow host to split meeting participants into separate, smaller rooms.","type":"boolean","example":true}}},"session_security":{"type":"object","properties":{"approved_or_denied_countries_or_regions":{"description":"Approve or block users from specific regions or countries from joining this meeting. \n","properties":{"approved_list":{"description":"List of countries/regions from where participants can join this meeting. ","items":{"type":"string","example":"CX"},"type":"array"},"denied_list":{"description":"List of countries/regions from where participants can not join this meeting. ","items":{"type":"string","example":"CA"},"type":"array"},"enable":{"description":"`true`: Setting enabled to either allow or block users from specific regions from joining your meetings. <br>\n\n`false`: Setting disabled.","type":"boolean","example":true},"method":{"description":"Specify whether to allow users from specific regions to join this meeting; or block users from specific regions from joining this meeting. <br><br>\n`approve`: Allow users from specific regions or countries to join this meeting. If this setting is selected, the approved regions or countries must be included in the `approved_list`.<br><br>\n`deny`: Block users from specific regions or countries from joining this meeting. If this setting is selected, the approved regions or countries must be included in the `denied_list`","enum":["approve","deny"],"type":"string","example":"approve"}},"type":"object"}}},"recording":{"type":"object","properties":{"record_speaker_view":{"type":"boolean","description":"Whether to enable the recording of the [**Active Speaker** view](https://support.zoom.us/hc/en-us/articles/360025561091-Recording-layouts#h_5c001397-33d6-47fb-bb40-1a3f68401581) during screen sharing.","example":true},"record_gallery_view":{"type":"boolean","description":"Whether to enable the recording of the [**Gallery** view](https://support.zoom.us/hc/en-us/articles/360025561091-Recording-layouts#h_889dc825-9d79-4139-b65d-e719669c546b) during screen sharing.","example":false},"record_audio_file":{"type":"boolean","description":"Whether to record a single audio file for all participants.","example":true},"save_chat_text":{"type":"boolean","description":"Whether to save meeting and webinar chat texts.","example":false},"show_timestamp":{"type":"boolean","description":"Whether to add timestamps to meeting and webinar recordings.","example":true},"cloud_recording_download":{"type":"boolean","description":"Whether to enable the [**Cloud recording downloads**](https://support.zoom.us/hc/en-us/articles/360060240972-Managing-cloud-recording-settings) setting.","example":true},"auto_delete_cmr":{"type":"boolean","description":"Whether to enable the automatic deletion of cloud recordings after a specific number of days.","example":true},"auto_delete_cmr_days":{"type":"integer","description":"When the `auto_delete_cmr` value is `true`, the number of days before Zoom automatically deletes cloud recordings: \n* `30` — 30 days. \n* `60` — 60 days. \n* `90` — 90 days. \n* `120` — 120 days.","enum":[30,60,90,120],"example":30}}}}}]}}},"required":true},"summary":"Update account settings"}},"/accounts/{accountId}/lock_settings":{"get":{"parameters":[{"description":"Unique Identifier of the account. To retrieve locked settings of the master account or a regular account, use \"me\" as the value of this field. <br> To retrieve locked settings of a sub account, provide the Account ID of the sub account in this field.","in":"path","name":"accountId","required":true,"schema":{"type":"string","example":"me"}},{"description":"Optional query parameters: \n* `meeting_security` — Use this query parameter to view the meeting security settings applied to the user's account.","in":"query","name":"option","schema":{"type":"string","example":"meeting_security"}},{"description":"Provide the name of the field by which you would like to filter the response. For example, if you provide \"host_video\" as the value of this field, you will get a response similar to the following:<br>\n{\n    \"schedule_meeting\": {\n        \"host_video\": false\n    }\n}\n<br>You can provide multiple values by separating them with commas(example: \"host_video,participant_video”).","in":"query","name":"custom_query_fields","schema":{"type":"string","example":"in_meeting"}}],"responses":{"200":{"content":{"application/json":{"schema":{"oneOf":[{"properties":{"audio_conferencing":{"properties":{"toll_free_and_fee_based_toll_call":{"description":"Whether the account has the [**Toll-free and Fee-based Toll Call**](https://support.zoom.us/hc/en-us/articles/360060950711-Enabling-Toll-free-and-Fee-based-Toll-Call#h_01F51680NJ7YHZDXGJNSKDGM2P) setting enabled.","type":"boolean","example":true}},"type":"object"},"chat":{"properties":{"share_files":{"description":"Users can share files in chats and channels.","type":"boolean","example":true},"chat_emojis":{"description":"Allow users to use the emoji library in direct messages or group conversations. Choose between allowing users to use any emoji in the library, or using only pre-selected emojis. If the setting is disabled, users can still use keyboard shortcuts to add emojis. Users can change their emoji skin tone in Settings.","type":"boolean","example":true},"record_voice_messages":{"description":"Allow users to record voice messages that can be sent in direct messages or group conversations.","type":"boolean","example":true},"record_video_messages":{"description":"Allow users to record video messages that can be sent in direct messages or group conversations. If the file share setting is disabled, they will not be able to record and send video messages.","type":"boolean","example":true},"share_links_in_chat":{"type":"boolean","description":"Share links to messages and channels in Team Chat.","example":true},"schedule_meetings_in_chat":{"type":"boolean","description":"Schedule a meeting from chat or channel.","example":true},"set_retention_period_in_cloud":{"type":"boolean","description":"By default, messages and files are stored in Zoom's cloud. Enable this setting to specify when they are deleted. When retention is disabled, messages sent by offline users can be received within 7 days before they are deleted.","example":true},"set_retention_period_in_local":{"type":"boolean","description":"Specify how long your messages are saved on local devices. If this setting is disabled, messages are never deleted locally.","example":true},"allow_users_to_add_contacts":{"description":"Whether to allow users to add contacts.","type":"boolean","example":true},"allow_users_to_chat_with_others":{"description":"Whether to Allow users to chat with others.","type":"boolean","example":true},"chat_etiquette_tool":{"description":"Whether to enable the **Chat Etiquette Tool**.","type":"boolean","example":true},"send_data_to_third_party_archiving_service":{"description":"Whether to send data to third-party archiving service.","type":"boolean","example":true}},"type":"object"},"email_notification":{"properties":{"alternative_host_reminder":{"description":"Notify the alternative host who is set or removed.","type":"boolean","example":true},"cancel_meeting_reminder":{"description":"Notify host and participants when the meeting is cancelled.","type":"boolean","example":true},"cloud_recording_available_reminder":{"description":"Whether to notify the host when a cloud recording is available.","type":"boolean","example":true},"jbh_reminder":{"description":"Notify host when participants join the meeting before them.","type":"boolean","example":true},"schedule_for_reminder":{"description":"Notify the host there is a meeting is scheduled, rescheduled, or cancelled.","type":"boolean","example":true}},"type":"object"},"in_meeting":{"properties":{"alert_guest_join":{"description":"Allow participants who belong to your account to see that a guest (someone who does not belong to your account) is participating in the meeting or webinar.","type":"boolean","example":true},"allow_users_to_delete_messages_in_meeting_chat":{"description":"If the value of this field is set to `true`,  allow users to delete messages in the in-meeting chat.\n","type":"boolean","example":true},"allow_live_streaming":{"description":"Whether to allow livestreaming.","type":"boolean","example":true},"allow_show_zoom_windows":{"description":"Show Zoom windows during screen share.","type":"boolean","example":true},"annotation":{"description":"Allow participants to use annotation tools to add information to shared screens.","type":"boolean","example":true},"anonymous_question_answer":{"description":"","type":"boolean","example":true},"attendee_on_hold":{"deprecated":true,"default":false,"description":"Allow host to put attendee on hold.\n\n**This field has been deprecated and is no longer supported.**","type":"boolean","example":true},"attention_mode_focus_mode":{"default":false,"description":"Whether to enable the [**Focus Mode**](https://support.zoom.us/hc/en-us/articles/360061113751-Using-focus-mode) feature. When enabled, this feature only displays the host and co-hosts' video and profile pictures during a meeting. \n\n This value defaults to `false`.","type":"boolean","example":true},"auto_answer":{"description":"Enable users to see and add contacts to 'auto-answer group' in the contact list on chat. Any call from members of this group will be automatically answered.","type":"boolean","example":true},"auto_generated_captions":{"description":"Whether to enable Zoom's [live transcription feature](https://support.zoom.us/hc/en-us/articles/207279736-Managing-closed-captioning-and-live-transcription#h_01FHGGHYJ4457H4GSZY0KM3NSB).","type":"boolean","example":true},"auto_saving_chat":{"description":"Automatically save all in-meeting chats.","type":"boolean","example":true},"breakout_room":{"description":"Allow host to split meeting participants into separate, smaller rooms.","type":"boolean","example":true},"chat":{"description":"Allow meeting participants to send chat message visible to all participants.","type":"boolean","example":true},"meeting_question_answer":{"description":"Allow participants to ask questions for the host and participants to answer.","type":"boolean","example":true},"closed_caption":{"description":"Allow host to type closed captions or assign a participant/third party device to add closed captions.","type":"boolean","example":true},"co_host":{"description":"Allow the host to add co-hosts. Co-hosts have the same in-meeting controls as the host.","type":"boolean","example":true},"custom_data_center_regions":{"description":"Displays whether or not custom [data center regions](https://support.zoom.us/hc/en-us/articles/360042411451-Selecting-data-center-regions-for-hosted-meetings-and-webinars) have been selected for meetings/webinars hosted by the account.","type":"boolean","example":true},"disable_screen_sharing_for_host_meetings":{"description":"Whether to enable the **Disable desktop screen sharing for meetings you host** setting.","type":"boolean","example":true},"disable_screen_sharing_for_in_meeting_guests":{"description":"Whether to enable the **Disable screen sharing when guests are in the meeting** setting.","type":"boolean","example":true},"dscp_marking":{"description":"Enable DSCP marking for signaling and media packets. (Default is 56 for audio, 40 for video, and 40 for signaling.) ","type":"boolean","example":true},"e2e_encryption":{"description":"Require that all meetings are encrypted using AES.","type":"boolean","example":true},"entry_exit_chime":{"description":"Play sound when participants join or leave.","type":"string","example":"none"},"far_end_camera_control":{"description":"Allow another user to take control of the camera during a meeting.","type":"boolean","example":true},"feedback":{"description":"Enable users to provide feedback to Zoom at the end of the meeting.","type":"boolean","example":true},"file_transfer":{"description":"Indicates whether [in-meeting file transfer](https://support.zoom.us/hc/en-us/articles/209605493-In-meeting-file-transfer) setting has been enabled for all users on the account or not.","type":"boolean","example":true},"full_transcript":{"description":"Whether full transcripts are available for viewing in the in-meeting side panel.","type":"boolean","example":true},"group_hd":{"description":"Enable higher quality video for host and participants. This will require more bandwidth.","type":"boolean","example":true},"language_interpretation":{"description":"Whether hosts can assign participants as interpreters to interpret one language into another in real-time.","type":"boolean","example":true},"manual_captions":{"description":"Whether to enable manual closed captioning. When [enabled](https://support.zoom.us/hc/en-us/articles/207279736-Managing-closed-captioning-and-live-transcription), the host or assigned participant can provide manual captioning or a [3rd-party device](https://support.zoom.us/hc/en-us/articles/115002212983) can be assigned to provide captioning.","type":"boolean","example":true},"meeting_reactions":{"description":"Whether meeting participants can [communicate using the emoji reactions](https://support.zoom.us/hc/en-us/articles/115001286183-Nonverbal-feedback-and-meeting-reactions) located in the **Reactions** menu in the meeting toolbar.","type":"boolean","example":true},"webinar_reactions":{"description":"Set this field to true to use [webinar reactions](https://support.zoom.us/hc/en-us/articles/4803536268429).","type":"boolean","example":true},"meeting_survey":{"description":"Whether the host can present a survey to participants once a meeting has ended. This feature is only available in version 5.7.3 or higher.","type":"boolean","example":true},"original_audio":{"description":"Allow users to select original sound during a meeting.","type":"boolean","example":true},"polling":{"description":"Add 'Polls' to the meeting controls. This allows the host to survey the attendees.","type":"boolean","example":true},"post_meeting_feedback":{"description":"Display end-of-meeting experience feedback survey.","type":"boolean","example":true},"private_chat":{"description":"Allow meeting participants to send a private 1:1 message to another participant.","type":"boolean","example":true},"remote_control":{"description":"During screen sharing, allow the person who is sharing to let others control the shared content.","type":"boolean","example":true},"non_verbal_feedback":{"default":false,"description":"Whether to enable the [**Non-verbal feedback**](https://support.zoom.us/hc/en-us/articles/115001286183-Nonverbal-feedback-and-meeting-reactions-) setting.  This value defaults to `false`.","type":"boolean","example":true},"remote_support":{"default":false,"description":"Whether to enable the [**Remote support**](https://support.zoom.us/hc/en-us/articles/360060951012-Enabling-remote-support) setting. This value defaults to `false`.","type":"boolean","example":true},"request_permission_to_unmute_participants":{"type":"boolean","description":"Whether to enable the [**Request permission to unmute participants**](https://support.zoom.us/hc/en-us/articles/203435537-Muting-and-unmuting-participants-in-a-meeting) setting.","example":true},"save_caption":{"description":"Whether participants can save closed captions or transcripts.","type":"boolean","example":true},"save_captions":{"description":"Whether participants can [save closed caption or transcripts](https://support.zoom.us/hc/en-us/articles/360060958752). \n\n **Note:** If the `full_transcript` field is set to `false`, participants **cannot** save captions.","type":"boolean","example":true},"screen_sharing":{"description":"Allow host and participants to share their screen or content during meetings.","type":"boolean","example":true},"sending_default_email_invites":{"description":"Allow users to invite participants by email only by default.","type":"boolean","example":true},"show_meeting_control_toolbar":{"description":"Always show meeting controls during a meeting.","type":"boolean","example":true},"slide_control":{"description":"Whether the person sharing during a presentation can allow others to control the slide presentation. This feature is only available in version 5.8.3 or higher.","type":"boolean","example":true},"stereo_audio":{"description":"Allow users to select stereo audio during a meeting.","type":"boolean","example":true},"use_html_format_email":{"description":"Allow  HTML formatting instead of plain text for meeting invitations scheduled with the Outlook plugin.","type":"boolean","example":true},"virtual_background":{"description":"Enable virtual background.","type":"boolean","example":true},"webinar_chat":{"description":"Whether to allow webinar participants to send chat messages.","type":"boolean","example":true},"webinar_live_streaming":{"description":"Whether to enable webinar livestreaming.","type":"boolean","example":true},"webinar_polling":{"description":"Whether the host can add polls before or during a webinar.","type":"boolean","example":true},"webinar_question_answer":{"description":"Whether attendees can ask the host and panelists questions in the webinar.","type":"boolean","example":true},"webinar_survey":{"description":"Whether the host can present surveys to attendees once a webinar has ended.","type":"boolean","example":true},"whiteboard":{"description":"Allow participants to share a whiteboard that includes annotation tools.","type":"boolean","example":true}},"type":"object"},"other_options":{"properties":{"blur_snapshot":{"description":"If true, iOS blurs the screenshot in the task switcher when multiple apps are open. Android hides the screenshot in the system-level list of recent apps.","type":"boolean","example":true},"webinar_registration_options":{"description":"Webinar registration options.","type":"boolean","example":true}},"type":"object"},"recording":{"properties":{"account_user_access_recording":{"description":"Make cloud recordings accessible to account members only.","type":"boolean","example":true},"auto_delete_cmr":{"description":"Allow Zoom to automatically delete recordings permanently after a specified number of days.","type":"boolean","example":true},"auto_recording":{"description":"Record meetings automatically as they start.","type":"boolean","example":true},"cloud_recording":{"description":"Allow hosts to record and save the meeting / webinar in the cloud.","type":"boolean","example":true},"cloud_recording_download":{"description":"Allow anyone with a link to the cloud recording to download.","type":"boolean","example":true},"host_delete_cloud_recording":{"description":"Allow the host to delete the recordings. If this option is disabled, the recordings cannot be deleted by the host and only admin can delete them.","type":"boolean","example":true},"ip_address_access_control":{"description":"Setting to allow cloud recording access only from specific IP address ranges.\n","type":"boolean","example":true},"local_recording":{"description":"Allow hosts and participants to record the meeting to a local file.","type":"boolean","example":true},"prevent_host_access_recording":{"description":"If set to `true`, meeting hosts cannot view their meeting cloud recordings. Only the admins who have recording management privilege can access them.\n\n","type":"boolean","example":true},"recording_authentication":{"description":"Only authenticated users can view cloud recordings","type":"boolean","example":true},"archive":{"description":"[Archiving solution](https://support.zoom.us/hc/en-us/articles/360050431572-Archiving-Meeting-and-Webinar-data) settings. This setting can only be used if you have been granted archiving solution access by the Zoom support team.","type":"boolean","example":true}},"type":"object"},"schedule_meeting":{"properties":{"audio_type":{"description":"Determine how participants can join the audio portion of the meeting.","type":"boolean","example":true},"embed_password_in_join_link":{"description":"If the value is set to `true`, the meeting password will be encrypted and included in the join meeting link to allow participants to join with just one click without having to enter the password.\n ","type":"boolean","example":true},"enforce_login":{"description":"Allow only signed-in users to join meetings.\n","type":"boolean","example":true},"enforce_login_domains":{"description":"Specify the domains from which users can join a meeting.\n","type":"string","example":"example.com"},"enforce_login_with_domains":{"description":"Allow only signed-in users with specified domains to join meetings.\n","type":"boolean","example":true},"host_video":{"description":"Start meetings with host video on.","type":"boolean","example":true},"join_before_host":{"description":"Allow participants to join the meeting before the host arrives","type":"boolean","example":true},"meeting_authentication":{"description":"Only authenticated users can join meetings","type":"boolean","example":true},"not_store_meeting_topic":{"description":"Whether to enable the [**Always display \"Zoom Meeting\" as the meeting topic**](https://support.zoom.us/hc/en-us/articles/201363253-Changing-account-settings#h_01EG9BJ646V2WJK1S3H2MP6YV6) setting.","type":"boolean","example":true},"always_display_zoom_webinar_as_topic":{"description":"Whether to enable the [**Always show \"Zoom Webinar\" as the webinar topic**](https://support.zoom.us/hc/en-us/articles/201363253-Changing-account-settings#h_01EG9BJ646V2WJK1S3H2MP6YV6) setting.","type":"boolean","example":false},"participant_video":{"description":"Start meetings with participant video on.","type":"boolean","example":true},"require_password_for_instant_meetings":{"description":"Require password for instant meetings. If you use a PMI for your instant meetings, this option will be disabled. This setting is always enabled for free accounts and Pro accounts with a single host and cannot be modified for these accounts.","type":"boolean","example":true},"require_password_for_pmi_meetings":{"description":"Require participants to enter password for PMI meetings. This setting is always enabled for free accounts and Pro accounts with a single host and cannot be modified for these accounts.","type":"boolean","example":true},"require_password_for_scheduling_new_meetings":{"description":"This setting applies for regular meetings that do not use a PMI. If enabled, a password will be generated while a host schedules a new meeting and participants will be required to enter the password before they can join the meeting. This setting is always enabled for free accounts and Pro accounts with a single host and cannot be modified for these accounts.","type":"boolean","example":true},"use_pmi_for_instant_meetings":{"description":"Use a Personal Meeting ID (PMI) when starting an instant meeting.","type":"boolean","example":true},"use_pmi_for_scheduled_meetings":{"description":"Use a Personal Meeting ID (PMI) when scheduling a meeting.","type":"boolean","example":true}},"type":"object"},"telephony":{"properties":{"telephony_regions":{"type":"boolean","example":true},"third_party_audio":{"description":"Allow users to join the meeting using the existing 3rd party audio configuration.","type":"boolean","example":true}},"type":"object"},"tsp":{"properties":{"call_out":{"description":"","type":"boolean","example":true},"show_international_numbers_link":{"description":"","type":"boolean","example":true}},"type":"object"}},"type":"object"},{"description":"The account's locked meeting and webinar security settings.","properties":{"meeting_security":{"properties":{"approved_or_denied_countries_or_regions":{"description":"Whether to enable the [**Approve or block entry for users from specific countries/regions**](https://support.zoom.us/hc/en-us/articles/360060086231-Joining-from-specific-countries-regions) setting.","type":"boolean","example":true},"auto_security":{"description":"Whether all meetings must be secured with at least one security option. \n\n This setting can only be disabled by Enterprise, ISV, Business (with more than 100 licenses), and Education accounts.","type":"boolean","example":true},"block_user_domain":{"description":"Whether users in specific domains are blocked from joining meetings and webinars.","type":"boolean","example":true},"chat_etiquette_tool":{"description":"Whether to enable the **Chat Etiquette Tool**.","type":"boolean","example":true},"embed_password_in_join_link":{"description":"Whether the meeting password is encrypted and included in the invitation link. The provided link will allow participants to join the meeting without having to enter the password.","type":"boolean","example":true},"encryption_type":{"description":"Whether use encryption to start a meeting.","type":"boolean","example":true},"end_to_end_encrypted_meetings":{"description":"Whether to enable end-to-end encryption for meetings.","type":"boolean","example":true},"meeting_password":{"description":"Whether all instant and scheduled meetings that users can join via client or Zoom Rooms systems are password-protected. [Personal Meeting ID (PMI)](https://support.zoom.us/hc/en-us/articles/203276937) meetings are **not** included in this setting.","type":"boolean","example":true},"only_authenticated_can_join_from_webclient":{"description":"Whether to specify that only authenticated users can join the meeting from the web client.","type":"boolean","example":true},"phone_password":{"description":"Whether passwords are required for participants joining by phone. \n\n If enabled and the meeting is password-protected, a numeric password is required for participants to join by phone. For meetings with alphanumeric passwords, a numeric password will be generated.","type":"boolean","example":true},"pmi_password":{"description":"Whether all Personal Meeting ID (PMI) meetings that users can join via client or Zoom Rooms systems are password-protected.","type":"boolean","example":true},"waiting_room":{"description":"Whether participants are placed in the [**Waiting Room**](https://support.zoom.us/hc/en-us/articles/115000332726-Waiting-Room) when they join a meeting. \n\n If the **Waiting Room** feature is enabled, the [**Allow participants to join before host**](https://support.zoom.us/hc/en-us/articles/202828525-Allow-participants-to-join-before-host) setting is automatically disabled.","type":"boolean","example":true},"webinar_password":{"description":"Whether to generate a password when scheduling webinars. Participants must use the generated password to join the scheduled webinar.","type":"boolean","example":true}},"type":"object"}},"title":"Meeting or Webinar Security Account Locked Settings","type":"object"}],"type":"object"}}},"description":"**Error Code:** `200`<br>\nOnly available for paid account:$accountId.\n\n**HTTP Status Code:** `200`<br>\nLocked settings for the Account returned.\n\n"},"400":{"description":"**HTTP Status Code:** `400`<br>\n**Error Code:** `2001`<br>\nAccount does not exist: $subAccountId."}},"tags":["Accounts"],"description":"[Account Locked Settings](https://support.zoom.us/hc/en-us/articles/115005269866) allow you turn settings on or off for all users in your account. No user except the account admin or account owner can change these settings. With lock settings, you force the settings on for all users.\nUse this API to retrieve an account's locked settings. \n\n**Note:** This API can be used by Zoom Accounts that are on a Pro or a higher plan as well accounts that have master and sub accounts options enabled. <br><br>\n**Prerequisites:**\n* Pro or a higher paid account. <br>\n\n**Scope**: `account:read:admin`.\n<br> **[Rate Limit Label](https://developers.zoom.us/docs/api/rest/rate-limits/):** `Medium`<br>\n\n\n\n\n\n**Scope:** account:read:admin","operationId":"getAccountLockSettings","summary":"Get locked settings"},"patch":{"parameters":[{"description":"Unique Identifier of the account. To retrieve locked settings of the master account or a regular account, provide \"me\" as the value of this field. <br> To retrieve locked settings of a sub account, provide the Account ID of the sub account in this field.","in":"path","name":"accountId","required":true,"schema":{"type":"string","example":"me"}}],"responses":{"200":{"description":"**Error Code:** `200`<br>\nOnly available for Paid account: $accountId.\n"},"204":{"description":"**HTTP Status Code:** `204`<br>\nAccount lock settings updated."},"404":{"description":"**HTTP Status Code:** `404`<br>\n**Error Code:** `2001`<br>\nTAccount does not exist: $subAccountId.\n"}},"security":[{"OAuth":[]}],"tags":["Accounts"],"description":"[Account Locked Settings](https://support.zoom.us/hc/en-us/articles/115005269866) allow you turn settings on or off for all users in your account. No user except the account admin or account owner can change these settings. With lock settings, you force the settings on for all users. Use this API to update an account's locked settings.\n\n**Note:** This API can be used by Zoom Accounts that are on a Pro or a higher plan as well accounts that have master and sub accounts options enabled.<br><br>\n**Prerequisites:**<br>\n* Pro or a higher paid account. <br>\n\n**Scope:** `account:write:admin`<br>\n**[Rate Limit Label](https://developers.zoom.us/docs/api/rest/rate-limits/):** `Medium`<br>\n\n\n ","operationId":"updateAccountLockSettings","requestBody":{"content":{"application/json":{"schema":{"oneOf":[{"properties":{"audio_conferencing":{"properties":{"toll_free_and_fee_based_toll_call":{"description":"Whether the account has the [**toll-free and fee-based toll call**](https://support.zoom.us/hc/en-us/articles/360060950711-Enabling-Toll-free-and-Fee-based-Toll-Call#h_01F51680NJ7YHZDXGJNSKDGM2P) setting enabled.","type":"boolean","example":true}},"type":"object"},"chat":{"properties":{"share_files":{"description":"Users can share files in chats and channels.","type":"boolean","example":true},"chat_emojis":{"description":"Allow users to use the emoji library in direct messages or group conversations. Choose between allowing users to use any emoji in the library, or allowing only pre-selected emojis. If the setting is disabled, users can still use keyboard shortcuts to add emojis. Users can change their emoji skin tone in **Settings**.","type":"boolean","example":true},"record_voice_messages":{"description":"Allow users to record voice messages that can be sent in direct messages or group conversations.","type":"boolean","example":true},"record_video_messages":{"description":"Allow users to record video messages that can be sent in direct messages or group conversations. If the file share setting is disabled, they will not be able to record and send video messages.","type":"boolean","example":true},"share_links_in_chat":{"type":"boolean","description":"Share links to messages and channels in Team Chat.","example":true},"schedule_meetings_in_chat":{"type":"boolean","description":"Schedule a meeting from chat or channel.","example":true},"set_retention_period_in_cloud":{"type":"boolean","description":"By default, messages and files are stored in Zoom's cloud. Enable this setting to specify when they are deleted. When retention is disabled, messages sent by offline users can be received within 7 days before they are deleted.","example":true},"set_retention_period_in_local":{"type":"boolean","description":"Specify how long your messages are saved on local devices. If this setting is disabled, messages are never deleted locally.","example":true},"allow_users_to_add_contacts":{"description":"Whether to allow users to add contacts.","type":"boolean","example":true},"allow_users_to_chat_with_others":{"description":"Whether to allow users to chat with others.","type":"boolean","example":true},"chat_etiquette_tool":{"description":"Whether to enable the **Chat Etiquette Tool**.","type":"boolean","example":true},"send_data_to_third_party_archiving_service":{"description":"Whether to send data to third-party archiving service.","type":"boolean","example":true}},"type":"object"},"email_notification":{"properties":{"alternative_host_reminder":{"description":"Notify the alternative host who is set or removed.","type":"boolean","example":true},"cancel_meeting_reminder":{"description":"Notify host and participants when the meeting is cancelled.","type":"boolean","example":true},"cloud_recording_available_reminder":{"description":"Whether to notify the host when a cloud recording is available.","type":"boolean","example":true},"jbh_reminder":{"description":"Notify host when participants join the meeting before them.","type":"boolean","example":true},"schedule_for_reminder":{"description":"Notify the host there is a meeting is scheduled, rescheduled, or cancelled.","type":"boolean","example":true}},"type":"object"},"in_meeting":{"properties":{"alert_guest_join":{"description":"Allow participants who belong to your account to see that a guest (someone who does not belong to your account) is participating in the meeting or webinar.","type":"boolean","example":true},"allow_users_to_delete_messages_in_meeting_chat":{"description":"If the value of this field is set to `true`,  allow users to delete messages in the in-meeting chat.\n","type":"boolean","example":true},"allow_live_streaming":{"description":"Whether to allow livestreaming.","type":"boolean","example":true},"allow_show_zoom_windows":{"description":"Show Zoom windows during screen share.","type":"boolean","example":true},"annotation":{"description":"Allow participants to use annotation tools to add information to shared screens.","type":"boolean","example":true},"anonymous_question_answer":{"description":"","type":"boolean","example":true},"attendee_on_hold":{"deprecated":true,"default":false,"description":"Allow host to put attendee on hold.\n\n**This field has been deprecated and is no longer supported.**","type":"boolean","example":true},"attention_mode_focus_mode":{"description":"Whether to enable the [**Focus Mode**](https://support.zoom.us/hc/en-us/articles/360061113751-Using-focus-mode) feature. When enabled, this feature only displays the host and co-hosts' video and profile pictures during a meeting.","type":"boolean","example":true},"auto_answer":{"description":"Enable users to see and add contacts to 'auto-answer group' in the contact list on chat. Any call from members of this group will be automatically answered.","type":"boolean","example":true},"auto_generated_captions":{"description":"Whether to enable Zoom's [live transcription feature](https://support.zoom.us/hc/en-us/articles/207279736-Managing-closed-captioning-and-live-transcription#h_01FHGGHYJ4457H4GSZY0KM3NSB).","type":"boolean","example":true},"auto_saving_chat":{"description":"Automatically save all in-meeting chats.","type":"boolean","example":true},"breakout_room":{"description":"Allow host to split meeting participants into separate, smaller rooms.","type":"boolean","example":true},"chat":{"description":"Allow meeting participants to send chat message visible to all participants.","type":"boolean","example":true},"meeting_question_answer":{"description":"Allow participants to ask questions for the host and participants to answer.","type":"boolean","example":true},"closed_caption":{"description":"Allow host to type closed captions or assign a participant/third party device to add closed captions.","type":"boolean","example":true},"co_host":{"description":"Allow the host to add co-hosts. Co-hosts have the same in-meeting controls as the host.","type":"boolean","example":true},"custom_data_center_regions":{"description":"If set to `true`, account owners and admins on paid accounts can [select data center regions](https://support.zoom.us/hc/en-us/articles/360042411451-Selecting-data-center-regions-for-hosted-meetings-and-webinars) to use for hosting their real-time meeting and webinar traffic. These regions can be provided in the `data_center_regions` field in the account settings. If set to `false`, the regions cannot be customized and the default regions will be used.","type":"boolean","example":true},"disable_screen_sharing_for_host_meetings":{"description":"Whether to enable the **Disable desktop screen sharing for meetings you host** setting.","type":"boolean","example":true},"disable_screen_sharing_for_in_meeting_guests":{"description":"Whether to enable the **Disable screen sharing when guests are in the meeting** setting.","type":"boolean","example":true},"dscp_marking":{"description":"Allow users to select stereo audio during a meeting.","type":"boolean","example":true},"e2e_encryption":{"description":"Require that all meetings are encrypted using AES.","type":"boolean","example":true},"entry_exit_chime":{"description":"Play sound when participants join or leave.","type":"string","example":"none"},"far_end_camera_control":{"description":"Allow another user to take control of the camera during a meeting.","type":"boolean","example":true},"feedback":{"description":"Enable users to provide feedback to Zoom at the end of the meeting.","type":"boolean","example":true},"file_transfer":{"description":"Indicates whether [in-meeting file transfer](https://support.zoom.us/hc/en-us/articles/209605493-In-meeting-file-transfer) setting has been enabled for all users on the account or not.","type":"boolean","example":true},"full_transcript":{"description":"Whether to enable the viewing of full transcripts in the in-meeting side panel.","type":"boolean","example":true},"group_hd":{"description":"Enable higher quality video for host and participants. This will require more bandwidth.","type":"boolean","example":true},"language_interpretation":{"description":"Whether to allow hosts to assign participants as interpreters who can interpret one language into another in real-time.","type":"boolean","example":true},"manual_captions":{"description":"Whether to enable manual closed captioning. When [enabled](https://support.zoom.us/hc/en-us/articles/207279736-Managing-closed-captioning-and-live-transcription), the host or assigned participant can provide manual captioning or a [3rd-party device](https://support.zoom.us/hc/en-us/articles/115002212983) can be assigned to provide captioning.","type":"boolean","example":true},"webinar_reactions":{"description":"Set this field to true to use [webinar reactions](https://support.zoom.us/hc/en-us/articles/4803536268429).","type":"boolean","example":true},"meeting_survey":{"description":"Whether to allow the host to present a survey to participants once a meeting has ended. This feature is only available in version 5.7.3 or higher.","type":"boolean","example":true},"original_audio":{"description":"Allow users to select original sound during a meeting.","type":"boolean","example":true},"polling":{"description":"Add 'Polls' to the meeting controls. This allows the host to survey the attendees.","type":"boolean","example":true},"post_meeting_feedback":{"description":"Display end-of-meeting experience feedback survey.","type":"boolean","example":true},"private_chat":{"description":"Allow meeting participants to send a private 1:1 message to another participant.","type":"boolean","example":true},"remote_control":{"description":"During screen sharing, allow the person who is sharing to let others control the shared content.","type":"boolean","example":true},"non_verbal_feedback":{"default":false,"description":"Whether to enable the [**Non-verbal feedback**](https://support.zoom.us/hc/en-us/articles/115001286183-Nonverbal-feedback-and-meeting-reactions-) setting.  This value defaults to `false`.","type":"boolean","example":true},"remote_support":{"default":false,"description":"Whether to enable the [**Remote support**](https://support.zoom.us/hc/en-us/articles/360060951012-Enabling-remote-support) setting. This value defaults to `false`.","type":"boolean","example":true},"request_permission_to_unmute_participants":{"type":"boolean","description":"Whether to enable the [**Request permission to unmute participants**](https://support.zoom.us/hc/en-us/articles/203435537-Muting-and-unmuting-participants-in-a-meeting) setting.","example":true},"save_caption":{"description":"Whether to allow participants to save closed captions or transcripts.","type":"boolean","example":true},"save_captions":{"description":"Whether to allow participants to [save closed captions or transcripts](https://support.zoom.us/hc/en-us/articles/360060958752). \n\n **Note:** If the `full_transcript` field is set to `false`, participants **cannot** save captions.","type":"boolean","example":true},"screen_sharing":{"description":"Allow host and participants to share their screen or content during meetings.","type":"boolean","example":true},"sending_default_email_invites":{"description":"Allow users to invite participants by email only by default.","type":"boolean","example":true},"show_meeting_control_toolbar":{"description":"Always show meeting controls during a meeting.","type":"boolean","example":true},"slide_control":{"description":"Whether the person sharing during a presentation can allow others to control the slide presentation. This feature is only available in version 5.8.3 or higher.","type":"boolean","example":true},"stereo_audio":{"description":"Allow users to select stereo audio during a meeting.","type":"boolean","example":true},"use_html_format_email":{"description":"Allow  HTML formatting instead of plain text for meeting invitations scheduled with the Outlook plugin.","type":"boolean","example":true},"virtual_background":{"description":"Enable virtual background.","type":"boolean","example":true},"webinar_chat":{"description":"Whether to allow webinar participants to send chat messages.","type":"boolean","example":true},"webinar_live_streaming":{"description":"Whether to enable webinar livestreaming.","type":"boolean","example":true},"webinar_polling":{"description":"Whether to allow the host to add polls before or during a webinar.","type":"boolean","example":true},"webinar_question_answer":{"description":"Whether attendees can ask the host and panelists questions in the webinar.","type":"boolean","example":true},"webinar_survey":{"description":"Whether to allow the host to present surveys to attendees once a webinar has ended.","type":"boolean","example":true},"whiteboard":{"description":"Allow participants to share a whiteboard that includes annotation tools.","type":"boolean","example":true}},"type":"object"},"other_options":{"properties":{"blur_snapshot":{"description":"If true, iOS blurs the screenshot in the task switcher when multiple apps are open. Android hides the screenshot in the system-level list of recent apps.","type":"boolean","example":true},"webinar_registration_options":{"description":"Webinar registration options.","type":"boolean","example":true}},"type":"object"},"recording":{"properties":{"account_user_access_recording":{"description":"Make cloud recordings accessible to account members only.","type":"boolean","example":true},"auto_delete_cmr":{"description":"Allow Zoom to automatically delete recordings permanently after a specified number of days.","type":"boolean","example":true},"auto_recording":{"description":"Record meetings automatically as they start.","type":"boolean","example":true},"cloud_recording":{"description":"Allow hosts to record and save the meeting / webinar in the cloud.","type":"boolean","example":true},"cloud_recording_download":{"description":"Allow anyone with a link to the cloud recording to download.","type":"boolean","example":true},"host_delete_cloud_recording":{"description":"Allow the host to delete the recordings. If this option is disabled, the recordings cannot be deleted by the host and only admin can delete them.","type":"boolean","example":true},"ip_address_access_control":{"description":"Setting to allow cloud recording access only from specific IP address ranges.\n","type":"boolean","example":true},"local_recording":{"description":"Allow hosts and participants to record the meeting to a local file.","type":"boolean","example":true},"prevent_host_access_recording":{"description":"If set to `true`, meeting hosts cannot view their meeting cloud recordings. Only the admins who have recording management privilege can access them.\n\n","type":"boolean","example":true},"recording_authentication":{"type":"boolean","example":true},"archive":{"description":"[Archiving solution](https://support.zoom.us/hc/en-us/articles/360050431572-Archiving-Meeting-and-Webinar-data) settings. This setting can only be used if you have been granted archiving solution access by the Zoom support team.","type":"boolean","example":true}},"type":"object"},"schedule_meeting":{"properties":{"audio_type":{"description":"Determine how participants can join the audio portion of the meeting.","type":"boolean","example":true},"embed_password_in_join_link":{"description":"If the value is set to `true`, the meeting password will be encrypted and included in the join meeting link to allow participants to join with just one click without having to enter the password.\n ","type":"boolean","example":true},"enforce_login":{"description":"Participants must always sign in before joining the scheduled meeting.","type":"boolean","example":true},"enforce_login_domains":{"description":"Specify the domains from which users can join a meeting.\n","type":"string","example":"example.com"},"enforce_login_with_domains":{"description":"Allow only signed-in users with specified domains to join meetings.\n","type":"boolean","example":true},"host_video":{"description":"Start meetings with host video on.","type":"boolean","example":true},"join_before_host":{"description":"Allow participants to join the meeting before the host arrives","type":"boolean","example":true},"meeting_authentication":{"type":"boolean","example":true},"not_store_meeting_topic":{"description":"Whether to enable the [**Always display \"Zoom Meeting\" as the meeting topic**](https://support.zoom.us/hc/en-us/articles/201363253-Changing-account-settings#h_01EG9BJ646V2WJK1S3H2MP6YV6) setting.","type":"boolean","example":true},"always_display_zoom_webinar_as_topic":{"description":"Whether to enable the [**Always show \"Zoom Webinar\" as the webinar topic**](https://support.zoom.us/hc/en-us/articles/201363253-Changing-account-settings#h_01EG9BJ646V2WJK1S3H2MP6YV6) setting.","type":"boolean","example":false},"participant_video":{"description":"Start meetings with participant video on.","type":"boolean","example":true},"personal_meeting":{"description":"Turn the lock setting on or off for the **Enable Personal Meeting ID** setting for an entire account.<br><br>\n`true`: Turn the **\"Enable Personal Meeting ID\"** setting **on** for all users in the account. Users can choose to use personal meeting ID for their meetings. <br><br>\n`false`: Turn **off** the **\"Enable Personal Meeting ID\"** setting. **If this setting is [disabled](https://support.zoom.us/hc/en-us/articles/201362843-Personal-meeting-ID-PMI-and-personal-link?flash_digest=eb7ac62d8c7fb4daf285916e3e15d87537806133#h_aa0335c8-3b06-41bc-bc1f-a8b84ef17f2a), meetings that were scheduled with a PMI by the users in the account will be invalid. Users will have to update previously scheduled PMI meetings.**<br><br>\nFor Zoom Phone only: If a user has been assigned a desk phone, **\"Elevate to Zoom Meeting\"** on desk phone will be disabled.\n\n\n","type":"boolean","example":true},"require_password_for_instant_meetings":{"description":"Require password for instant meetings. If you use a PMI for your instant meetings, this option will be disabled. This setting is always enabled for free accounts and Pro accounts with a single host and cannot be modified for these accounts.","type":"boolean","example":true},"require_password_for_pmi_meetings":{"description":"Require participants to enter password for PMI meetings. This setting is always enabled for free accounts and Pro accounts with a single host and cannot be modified for these accounts.","type":"boolean","example":true},"require_password_for_scheduling_new_meetings":{"description":"This setting applies for regular meetings that do not use a PMI. If enabled, a password will be generated while a host schedules a new meeting and participants will be required to enter the password before they can join the meeting. This setting is always enabled for free accounts and Pro accounts with a single host and cannot be modified for these accounts.","type":"boolean","example":true},"use_pmi_for_instant_meetings":{"description":"Use a Personal Meeting ID (PMI) when starting an instant meeting.","type":"boolean","example":true},"use_pmi_for_scheduled_meetings":{"description":"Use a Personal Meeting ID (PMI) when scheduling a meeting.","type":"boolean","example":true}},"type":"object"},"telephony":{"properties":{"telephony_regions":{"type":"boolean","example":true},"third_party_audio":{"description":"Allow users to join the meeting using the existing 3rd party audio configuration.","type":"boolean","example":true}},"type":"object"},"tsp":{"properties":{"call_out":{"description":"","type":"boolean","example":true},"show_international_numbers_link":{"description":"","type":"boolean","example":true}},"type":"object"}},"type":"object"},{"description":"The account's updated locked meeting and webinar security settings.","properties":{"meeting_security":{"properties":{"approved_or_denied_countries_or_regions":{"description":"Whether to enable the [**Approve or block entry for users from specific countries/regions**](https://support.zoom.us/hc/en-us/articles/360060086231-Joining-from-specific-countries-regions) setting.","type":"boolean","example":true},"auto_security":{"description":"Whether to require that all meetings are secured with at least one security option. \n\n This setting can only be disabled by Enterprise, ISV, Business (with more than 100 licenses), and Education accounts.","type":"boolean","example":true},"block_user_domain":{"description":"Whether to block users in specific domains from joining meetings and webinars.","type":"boolean","example":true},"chat_etiquette_tool":{"description":"Whether to enable the **Chat Etiquette Tool**.","type":"boolean","example":true},"embed_password_in_join_link":{"description":"Whether the meeting password will be encrypted and included in the invitation link. The provided link will allow participants to join the meeting without having to enter the password.","type":"boolean","example":true},"encryption_type":{"description":"The type of encryption to use when starting a meeting: \n* `enhanced_encryption` — Use enhanced encryption. Encryption data is stored in the cloud. \n* `e2ee` — End-to-end encryption. The encryption key is stored on the local device and cannot be obtained by anyone else. Enabling E2EE also [**disables** certain features](https://support.zoom.us/hc/en-us/articles/360048660871), such as cloud recording, live streaming, and allowing participants to join before the host.","enum":["enhanced_encryption","e2ee"],"type":"string","example":"e2ee"},"end_to_end_encrypted_meetings":{"description":"Whether to enable end-to-end encryption for meetings. If enabled, you can specify the type of encryption in the `encryption_type` field.","type":"boolean","example":true},"meeting_password":{"description":"Whether all instant and scheduled meetings that users can join via client or Zoom Rooms systems are password-protected. [Personal Meeting ID (PMI)](https://support.zoom.us/hc/en-us/articles/203276937) meetings are **not** included in this setting.","type":"boolean","example":true},"only_authenticated_can_join_from_webclient":{"description":"Whether to specify that only authenticated users can join the meeting from the web client.","type":"boolean","example":true},"phone_password":{"description":"Whether to require a password for participants joining by phone. \n\n If enabled and the meeting is password-protected, a numeric password is required for participants to join by phone. For meetings with alphanumeric passwords, a numeric password will be generated.","type":"boolean","example":true},"pmi_password":{"description":"Whether all Personal Meeting ID (PMI) meetings that users can join via client or Zoom Rooms systems are password-protected.","type":"boolean","example":true},"waiting_room":{"description":"Whether participants are placed in the [**Waiting Room**](https://support.zoom.us/hc/en-us/articles/115000332726-Waiting-Room) when they join a meeting. \n\n If the **Waiting Room** feature is enabled, the [**Allow participants to join before host**](https://support.zoom.us/hc/en-us/articles/202828525-Allow-participants-to-join-before-host) setting is automatically disabled.","type":"boolean","example":true},"webinar_password":{"description":"Whether to generate a password when scheduling webinars. Participants must use the generated password to join the scheduled webinar.","type":"boolean","example":true}},"type":"object"}},"title":"Meeting or Webinar Security Account Locked Settings","type":"object"}],"type":"object"}}}},"summary":"Update locked settings"}},"/accounts/{accountId}/settings/registration":{"get":{"parameters":[{"description":"The account's ID. For master accounts, pass the `me` value for this parameter.","in":"path","name":"accountId","required":true,"schema":{"type":"string","example":"me"}},{"allowEmptyValue":false,"name":"type","in":"query","description":"The type of registration's type: \n* `webinar` — webinar.","schema":{"type":"string","enum":["webinar"],"x-enum-descriptions":["webinar"],"example":"webinar"}}],"responses":{"200":{"content":{"application/json":{"schema":{"type":"object","properties":{"options":{"type":"object","description":"When participants submit registration, do something.","properties":{"host_email_notification":{"description":"Send an email to host when someone registers.","type":"boolean","example":true},"close_registration":{"description":"Close registration after event date.","type":"boolean","example":true},"allow_participants_to_join_from_multiple_devices":{"description":"Allow participants to join from multiple devices","type":"boolean","example":true},"show_social_share_buttons":{"description":"Show social share buttons on registration page","type":"boolean","example":true}}},"questions":{"type":"array","description":"Array of Registrant Questions.","items":{"type":"object","properties":{"field_name":{"type":"string","description":"Field name of the question.","enum":["last_name","address","city","country","zip","state","phone","industry","org","job_title","purchasing_time_frame","role_in_purchase_process","no_of_employees","comments"],"x-enum-descriptions":["Last Name","Address","City","Country/Region","Zip/Postal Code","State/Province","Phone","Industry","Organization","Job Title","Purchasing Time Frame","Role in Purchase Process","Number of Employees","Questions & Comments"],"example":"last_name"},"required":{"type":"boolean","description":"Decide whether this field are required.","example":true},"selected":{"type":"boolean","description":"Indicates whether or not the displayed fields are required to be filled out by registrants.","example":true}}}},"approve_type":{"type":"integer","description":"Approval type for the registration.","enum":[0,1],"x-enum-descriptions":["Automatically approve .","Manually approve"],"example":0},"custom_questions":{"type":"array","description":"Array of Registrant Custom Questions","items":{"type":"object","properties":{"title":{"type":"string","description":"Title of the custom question.","example":true},"type":{"type":"string","description":"Type of the question being asked.","enum":["short","single_dropdown","single_radio","multiple"],"x-enum-descriptions":["Short Text","Single Choice Dropdown","Single Choice Radio","Multiple Choice"],"example":"single_dropdown"},"required":{"type":"boolean","description":"Decide whether this field are required.","example":true},"selected":{"type":"boolean","description":"Indicates whether or not the custom question is required to be answered by participants or not.","example":true},"answers":{"type":"array","description":"Answer choices for the custom question. Can not be used for `short` question type as this type of question requires registrants to type out the answer.","items":{"type":"string","example":"option 1"}}}}}}}}},"description":"**HTTP Status Code:** `200` <br>\n Account settings registration returned. \n\n **Error Code:** `200` <br>\n Only available for paid accounts."},"404":{"description":"**HTTP Status Code:** `404` <br>\n Not Found \n\n **Error Code:** `2001` <br>\n Account does not exist: $accountId"}},"tags":["Accounts"],"description":"Use this API to get an account's webinar registration settings. To get the master account's webinar registration settings, use the `me` value for the `accountId` path parameter. \n\n **Scopes:** `account:read:admin` <br> **[Rate Limit Label](https://developers.zoom.us/docs/api/rest/rate-limits/):** `Medium` \n\n **Prerequisites:** \n* The account must be a paid account.","operationId":"accountSettingsRegistration","summary":"Get an account's webinar registration settings"},"patch":{"parameters":[{"description":"The account's ID. For master accounts, pass the `me` value for this parameter.","in":"path","name":"accountId","required":true,"schema":{"type":"string","example":"me"}},{"allowEmptyValue":false,"name":"type","in":"query","description":"The type of registration's type: \n* `webinar` — webinar.","schema":{"type":"string","enum":["webinar"],"x-enum-descriptions":["webinar"],"example":"webinar"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"options":{"type":"object","description":"When participants submit registration, do something.","properties":{"host_email_notification":{"description":"Send an email to host when someone registers.","type":"boolean","example":true},"close_registration":{"description":"Close registration after event date.","type":"boolean","example":true},"allow_participants_to_join_from_multiple_devices":{"description":"Allow participants to join from multiple devices","type":"boolean","example":true},"show_social_share_buttons":{"description":"Show social share buttons on registration page","type":"boolean","example":true}}},"questions":{"type":"array","description":"Array of Registrant Questions.","items":{"type":"object","properties":{"field_name":{"type":"string","description":"Field name of the question.","enum":["last_name","address","city","country","zip","state","phone","industry","org","job_title","purchasing_time_frame","role_in_purchase_process","no_of_employees","comments"],"x-enum-descriptions":["Last Name","Address","City","Country/Region","Zip/Postal Code","State/Province","Phone","Industry","Organization","Job Title","Purchasing Time Frame","Role in Purchase Process","Number of Employees","Questions & Comments"],"example":"last_name"},"required":{"type":"boolean","description":"Decide whether this field are required.","example":true},"selected":{"type":"boolean","description":"Indicates whether or not the displayed fields are required to be filled out by registrants.","example":true}}}},"approve_type":{"type":"integer","description":"Approval type for the registration.","enum":[0,1],"x-enum-descriptions":["Automatically approve .","Manually approve"],"example":0},"custom_questions":{"type":"array","description":"Array of Registrant Custom Questions","items":{"type":"object","properties":{"title":{"type":"string","description":"Title of the custom question.","example":true},"type":{"type":"string","description":"Type of the question being asked.","enum":["short","single_dropdown","single_radio","multiple"],"x-enum-descriptions":["Short Text","Single Choice Dropdown","Single Choice Radio","Multiple Choice"],"example":"single_dropdown"},"required":{"type":"boolean","description":"Decide whether this field are required.","example":true},"selected":{"type":"boolean","description":"Indicates whether or not the custom question is required to be answered by participants or not.","example":true},"answers":{"type":"array","description":"Answer choices for the custom question. Can not be used for `short` question type as this type of question requires registrants to type out the answer.","items":{"type":"string","example":"option 1"}}}}}}}}},"required":true},"responses":{"204":{"description":"**HTTP Status Code:** `204` <br>\nAccount settings updated."},"300":{"description":"**Error Code:** `300` <br>\nThe domains provided are invalid. If you are providing multiple domains, separate each domain with a comma."},"400":{"description":"**HTTP Status Code:** `400` <br>\nBad Request \n\n**Error Code:** `200` <br>\nOnly available for paid accounts."},"404":{"description":"**HTTP Status Code:** `404`<br>\nNot Found \n\n**Error Code:** `2001` <br>\nAccount does not exist: $accountId"}},"tags":["Accounts"],"description":"Use this API to update an account's webinar registration settings. To update the master account's webinar registration settings, pass the `me` value for the `accountId` path parameter. \n\n **Scopes:** `account:write:admin` <br> **[Rate Limit Label](https://developers.zoom.us/docs/api/rest/rate-limits/):** `Medium` \n\n **Prerequisites:** \n* The account must be a paid account.","operationId":"accountSettingsRegistrationUpdate","summary":"Update an account's webinar registration settings"}},"/groups/{groupId}/settings/registration":{"get":{"parameters":[{"name":"groupId","in":"path","required":true,"schema":{"type":"string","example":"0mgThLiRQH2bUHvIaL4t2g"}},{"allowEmptyValue":false,"name":"type","in":"query","description":"The registration type: \n* `webinar` — webinar.","schema":{"type":"string","enum":["webinar"],"x-enum-descriptions":["webinar"],"example":"webinar"}}],"responses":{"200":{"content":{"application/json":{"schema":{"type":"object","properties":{"options":{"type":"object","description":"When participants submit registration, do something.","properties":{"host_email_notification":{"description":"Send an email to host when someone registers.","type":"boolean","example":true},"close_registration":{"description":"Close registration after event date.","type":"boolean","example":true},"allow_participants_to_join_from_multiple_devices":{"description":"Allow participants to join from multiple devices","type":"boolean","example":true},"show_social_share_buttons":{"description":"Show social share buttons on registration page","type":"boolean","example":true}}},"questions":{"type":"array","description":"Array of Registrant Questions.","items":{"type":"object","properties":{"field_name":{"type":"string","description":"Field name of the question.","enum":["last_name","address","city","country","zip","state","phone","industry","org","job_title","purchasing_time_frame","role_in_purchase_process","no_of_employees","comments"],"x-enum-descriptions":["Last Name","Address","City","Country/Region","Zip/Postal Code","State/Province","Phone","Industry","Organization","Job Title","Purchasing Time Frame","Role in Purchase Process","Number of Employees","Questions & Comments"],"example":"last_name"},"required":{"type":"boolean","description":"Decide whether this field are required.","example":true},"selected":{"type":"boolean","description":"Indicates whether or not the displayed fields are required to be filled out by registrants.","example":true}}}},"approve_type":{"type":"integer","description":"Approval type for the registration.","enum":[0,1],"x-enum-descriptions":["Automatically approve .","Manually approve"],"example":0},"custom_questions":{"type":"array","description":"Array of Registrant Custom Questions","items":{"type":"object","properties":{"title":{"type":"string","description":"Title of the custom question.","example":true},"type":{"type":"string","description":"Type of the question being asked.","enum":["short","single_dropdown","single_radio","multiple"],"x-enum-descriptions":["Short Text","Single Choice Dropdown","Single Choice Radio","Multiple Choice"],"example":"single_dropdown"},"required":{"type":"boolean","description":"Decide whether this field are required.","example":true},"selected":{"type":"boolean","description":"Indicates whether or not the custom question is required to be answered by participants or not.","example":true},"answers":{"type":"array","description":"Answer choices for the custom question. Can not be used for `short` question type as this type of question requires registrants to type out the answer.","items":{"type":"string","example":"option 1"}}}}}}}}},"description":"**HTTP Status Code:** `200` <br>\n Group settings registration information returned."},"404":{"description":"**HTTP Status Code:** `404` <br>\n**Error Code:** `4130` <br>\nGroup does not exist: {groupId}."}},"tags":["Groups"],"description":"Get webinar registration settings for a [group](https://support.zoom.us/hc/en-us/articles/204519819-Group-Management-). \n**Prerequisite**: Pro, Business, or Education account<br>\n**Scopes**: `group:read:admin`<br>\n \n **[Rate Limit Label](https://developers.zoom.us/docs/api/rest/rate-limits/):** `Medium`","operationId":"groupSettingsRegistration","summary":"Get a group's webinar registration settings"},"patch":{"parameters":[{"name":"groupId","in":"path","required":true,"schema":{"type":"string","example":"0mgThLiRQH2bUHvIaL4t2g"}},{"allowEmptyValue":false,"name":"type","in":"query","description":"The registration type: \n* `webinar` — webinar.","schema":{"type":"string","enum":["webinar"],"x-enum-descriptions":["webinar"],"example":"webinar"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"options":{"type":"object","description":"When participants submit registration, do something.","properties":{"host_email_notification":{"description":"Send an email to host when someone registers.","type":"boolean","example":true},"close_registration":{"description":"Close registration after event date.","type":"boolean","example":true},"allow_participants_to_join_from_multiple_devices":{"description":"Allow participants to join from multiple devices","type":"boolean","example":true},"show_social_share_buttons":{"description":"Show social share buttons on registration page","type":"boolean","example":true}}},"questions":{"type":"array","description":"Array of Registrant Questions.","items":{"type":"object","properties":{"field_name":{"type":"string","description":"Field name of the question.","enum":["last_name","address","city","country","zip","state","phone","industry","org","job_title","purchasing_time_frame","role_in_purchase_process","no_of_employees","comments"],"x-enum-descriptions":["Last Name","Address","City","Country/Region","Zip/Postal Code","State/Province","Phone","Industry","Organization","Job Title","Purchasing Time Frame","Role in Purchase Process","Number of Employees","Questions & Comments"],"example":"last_name"},"required":{"type":"boolean","description":"Decide whether this field are required.","example":true},"selected":{"type":"boolean","description":"Indicates whether or not the displayed fields are required to be filled out by registrants.","example":true}}}},"approve_type":{"type":"integer","description":"Approval type for the registration.","enum":[0,1],"x-enum-descriptions":["Automatically approve .","Manually approve"],"example":0},"custom_questions":{"type":"array","description":"Array of Registrant Custom Questions","items":{"type":"object","properties":{"title":{"type":"string","description":"Title of the custom question.","example":true},"type":{"type":"string","description":"Type of the question being asked.","enum":["short","single_dropdown","single_radio","multiple"],"x-enum-descriptions":["Short Text","Single Choice Dropdown","Single Choice Radio","Multiple Choice"],"example":"single_dropdown"},"required":{"type":"boolean","description":"Decide whether this field are required.","example":true},"selected":{"type":"boolean","description":"Indicates whether or not the custom question is required to be answered by participants or not.","example":true},"answers":{"type":"array","description":"Answer choices for the custom question. Can not be used for `short` question type as this type of question requires registrants to type out the answer.","items":{"type":"string","example":"option 1"}}}}}}}}},"required":true},"responses":{"200":{"description":"**Error code:** `200`<br>\nOnly available for Paid account, {accountId}"},"204":{"description":"**HTTP Status Code:** `204`<br>\nSettings updated successfully."},"404":{"description":"**HTTP Status Code:** `404`<br>\n**Error Code:** `4130`<br>\nGroup does not exist: {groupId}."}},"tags":["Groups"],"description":"Update webinar registration settings for a [group](https://support.zoom.us/hc/en-us/articles/204519819-Group-Management-).<p style=\"background-color:#FEEFB3; color:#9F6000\"><br>Note:</b> The `force_pmi_jbh_password` field under meeting settings is planned to be deprecated on September 22, 2019. This field will be replaced by another field that will provide the same functionality.</p>\n**Prerequisite**: Pro, Business, or Education account<br> \n**Scopes**: `group:write:admin`<br>\n\n **[Rate Limit Label](https://developers.zoom.us/docs/api/rest/rate-limits/):** `Medium`","operationId":"groupSettingsRegistrationUpdate","summary":"Update a group's webinar registration settings"}},"/accounts/{accountId}/trusted_domains":{"get":{"parameters":[{"description":"The account's ID. For the Master account, pass the `me` value for this parameter.","in":"path","name":"accountId","required":true,"schema":{"type":"string","example":"q6gBJVO5TzexKYTb_I2rpg"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"trusted_domains":{"description":"A list of the account's trusted domains.","items":{"type":"string","example":"example.com"},"type":"array"}},"type":"object"}}},"description":"**HTTP Status Code:** `200` <br>\nAccount's trusted domains returned. \n\n**Error Code:** `2001` <br>\nAccount does not exist: $accountId"},"404":{"description":"**HTTP Status Code:** `404`<br>\nNot Found \n\n**Error Code:** `2001` <br>\nAccount does not exist: $accountId"}},"tags":["Accounts"],"description":"Use this API to get an account's [trusted domains](https://support.zoom.us/hc/en-us/articles/203395207). To get the Master account's trusted domains, use the `me` value for the `accountId` path parameter. \n\n **Scopes:** `account:read:admin` <br> **[Rate Limit Label](https://developers.zoom.us/docs/api/rest/rate-limits/):** `Light` \n\n **Prerequisites:** \n* The account must be a paid account.","operationId":"accountTrustedDomain","summary":"Get account's trusted domains"}},"/archive_files":{"get":{"parameters":[{"description":"The number of records returned within a single API call.","in":"query","name":"page_size","schema":{"default":30,"maximum":300,"type":"integer","example":30}},{"description":"Use the next page token to paginate through large result sets. A next page token is returned whenever the set of available results exceeds the current page size. This token's expiration period is 15 minutes.","in":"query","name":"next_page_token","schema":{"type":"string","example":"IAfJX3jsOLW7w3dokmFl84zOa0MAVGyMEB2"}},{"description":"The query start date, in `yyyy-MM-dd'T'HH:mm:ssZ` format. This value and the `to` query parameter value cannot exceed seven days.","in":"query","name":"from","schema":{"format":"date-time","type":"string","example":"2021-03-11T05:41:36Z"}},{"description":"The query end date, in `yyyy-MM-dd'T'HH:mm:ssZ` format. This value and the `from` query parameter value cannot exceed seven days.","in":"query","name":"to","schema":{"format":"date-time","type":"string","example":"2021-03-18T05:41:36Z"}},{"description":"The type of query date.\n* `meeting_start_time` \n* `archive_complete_time` \n\n This value defaults to `meeting_start_time`.","in":"query","name":"query_date_type","schema":{"default":"meeting_start_time","enum":["meeting_start_time","archive_complete_time"],"type":"string","example":"meeting_start_time"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"from":{"description":"The queried start date.","format":"date-time","type":"string","example":"2021-03-12T02:12:27Z"},"meetings":{"description":"Information about the meeting or webinar.","items":{"additionalProperties":false,"properties":{"account_name":{"description":"The user's account name.","example":"account_01","type":"string"},"archive_files":{"description":"Information about the archive files.","items":{"additionalProperties":false,"properties":{"download_url":{"description":"The URL to download the the archive file. \n\n **OAuth apps** \n\n If a user has authorized and installed your OAuth app that contains recording scopes, use the user's [OAuth access token](https://developers.zoom.us/docs/integrations/oauth/) to download the file. For example: \n\n `https://{{base-domain}}/rec/archive/download/xxx--header 'Authorization: Bearer {{OAuth-access-token}}'` \n\n **Note:** This field does **not** return for [Zoom On-Premise accounts](https://support.zoom.us/hc/en-us/articles/360034064852-Zoom-On-Premise-Deployment). Instead, this API will return the `file_path` field.","example":"https://example.com/recording/download/Qg75t7xZBtEbAkjdlgbfdngBBBB","type":"string"},"file_extension":{"description":"The archived file's extension.","example":"JSON","type":"string"},"file_path":{"description":"The file path to the on-premise account archive file. \n\n **Note:** The API only returns this field for [Zoom On-Premise accounts](https://support.zoom.us/hc/en-us/articles/360034064852-Zoom-On-Premise-Deployment). It does **not** return the `download_url` field.","type":"string","example":"/9090876528/path01/demo.mp4"},"file_size":{"description":"The archived file's size, in bytes.","example":165743,"type":"integer"},"file_type":{"description":"The archive file's type. \n* `MP4` — Video file. \n* `M4A` — Audio-only file. \n* `CHAT` — A TXT file containing in-meeting chat messages. \n* `CC` — A file containing the closed captions of the recording, in VTT file format. \n* `CSV` — A file containing polling data, in CSV format. \n* `CHAT_MESSAGE` — A JSON file encoded in base64 format containing chat messages. The file also includes waiting room chats, deleted messages, meeting emojis and non-verbal feedback.","enum":["MP4","M4A","CHAT","CC","CHAT_MESSAGE"],"example":"CHAT","type":"string"},"id":{"description":"The archive file's unique ID.","example":"a2f19f96-9294-4f51-8134-6f0eea108eb2","type":"string"},"individual":{"description":"Whether the archive file is an individual recording file. \n* `true` — An individual recording file. \n * `false` — An entire meeting file.","example":true,"type":"boolean"},"participant_email":{"description":"The individual recording file's participant email address. This value is returned when the `individual` value is `true`. If the participant is **not** part of the host's account, this returns an empty string value, with some exceptions. See [Email address display rules](https://marketplace.zoom.us/docs/api-reference/using-zoom-apis#email-address) for details.","example":"jchill@example.com","format":"email","type":"string"},"participant_join_time":{"description":"The join time for the generated recording file. If this value is returned when the individual value is true, then it is the recording file's participant join time. When the individual value is false, it returns the join time for the archiving gateway.","example":"2021-03-12T02:07:27Z","format":"date-time","type":"string"},"participant_leave_time":{"description":"The leave time for the generated recording file. If this value is returned when the individual value is true, then it is the recording file's participant leave time. When the individual value is false, it returns the leave time for the archiving gateway.","example":"2021-03-12T02:12:27Z","format":"date-time","type":"string"},"recording_type":{"description":"The archive file's recording type. \n* `shared_screen_with_speaker_view` \n* `audio_only` \n* `chat_file` \n* `closed_caption` \n* `chat_message` \n\n For more information, read our [Managing and sharing cloud recordings](https://support.zoom.us/hc/en-us/articles/205347605-Managing-and-sharing-cloud-recordings#h_9898497b-e736-4980-a749-d55608f10773) documentation.","enum":["shared_screen_with_speaker_view","audio_only","chat_file","closed_caption","chat_message"],"example":"chat_message","type":"string"},"status":{"description":"The archived file's processing status. \n* `completed` — The processing of the file is complete. \n* `processing` — The file is processing. \n* `failed` — The processing of the file failed.","enum":["completed","processing","failed"],"example":"completed","type":"string"},"encryption_fingerprint":{"description":"The archived file's encryption fingerprint, using the SHA256 hash algorithm.","example":"abf85f0fe6a4db3cdd8c37e505e1dd18a34d9696170a14b5bc6395677472cf43","type":"string"},"number_of_messages":{"description":"The number of `TXT` or `JSON` file messages. This field will return only when the `file_extension` is `JSON` or `TXT`","example":150,"type":"integer"}},"required":["id","file_type","file_extension","file_size","download_url","status","recording_type","individual","participant_join_time","participant_leave_time","encryption_fingerprint"],"type":"object"},"type":"array"},"complete_time":{"anyOf":[{"description":"The archive completion time.","format":"date-time","minLength":1,"example":"2021-03-12T02:12:27Z"},{"description":"An empty string.","enum":[""]}],"description":"The meeting or webinar's archive completion time.","example":"2021-03-12T02:57:27Z","format":"date-time","type":"string"},"duration":{"description":"The meeting or webinar's scheduled duration.","example":1,"type":"integer"},"duration_in_second":{"description":"The meeting or webinar's duration, in seconds.","example":1800,"type":"integer"},"host_id":{"description":"The ID of the user set as the host of the archived meeting or webinar.","example":"Dhjdfgdkg8w","type":"string"},"id":{"description":"The ID of the meeting (`meetingId`) or the webinar (`webinarId`).","example":553068284,"format":"int64","type":"integer"},"is_breakout_room":{"description":"Whether the room is a [breakout room](https://support.zoom.us/hc/en-us/articles/115005769646-Participating-in-breakout-rooms).","example":false,"type":"boolean"},"meeting_type":{"description":"Whether the meeting or webinar is internal or external. \n* `internal` — An internal meeting or webinar. \n* `external` — An external meeting or webinar. \n\n The `id`, `host_id`, and `topic` PII (Personal Identifiable Information) values in this response are removed when this value is `external`.","enum":["internal","external"],"example":"internal","type":"string"},"parent_meeting_id":{"description":"The parent meeting's universally unique ID (UUID). Each meeting or webinar instance generates a UUID. If the `is_breakout_room` value is `true`, the API returns this value.","type":"string","example":"atsXxhSEQWit9t+U02HXNQ=="},"recording_count":{"description":"The number of archived files returned in the API call response.","example":2,"type":"integer"},"start_time":{"description":"The meeting or webinar's start time.","example":"2021-04-26T05:23:18Z","format":"date-time","type":"string"},"timezone":{"description":"The meeting or webinar's [timezone](https://marketplace.zoom.us/docs/api-reference/other-references/abbreviation-lists#timezones).","example":"Asia/Shanghai","type":"string"},"topic":{"description":"The meeting or webinar topic.","example":"My Personal Meeting Room","type":"string"},"total_size":{"description":"The total size of the archive file, in bytes.","example":364463,"type":"integer"},"type":{"description":"The type of archived meeting or webinar. \n\n If the recording is of a meeting: \n* `1` — Instant meeting. \n* `2` — Scheduled meeting. \n* `3` — A recurring meeting with no fixed time. \n* `4` — A meeting created via PMI (Personal Meeting ID). \n* `7` — A [Personal Audio Conference](https://support.zoom.us/hc/en-us/articles/204517069-Getting-Started-with-Personal-Audio-Conference) (PAC). \n* `8` - Recurring meeting with a fixed time. \n\n If the recording is of a webinar: \n* `5` — A webinar. \n* `6` — A recurring webinar without a fixed time. \n* `9` — A recurring webinar with a fixed time. \n\n If the recording is **not** from a meeting or webinar: \n\n* `99` — A recording uploaded via the [**Recordings**](https://zoom.us/recording) interface on the Zoom Web Portal. \n* `100` — A [breakout room](https://support.zoom.us/hc/en-us/articles/115005769646-Participating-in-breakout-rooms).","enum":[1,2,3,4,5,6,7,8,9,100],"example":1,"type":"integer"},"uuid":{"description":"The universally unique identifier (UUID) of the recorded meeting or webinar instance. Each meeting or webinar instance generates a UUID.","example":"yO3dfhh3t467UkQ==","type":"string"},"status":{"description":"The archive's processing status. \n* `completed` — The archive's processing is complete. \n* `processing` — The archive is processing.","example":"completed","type":"string","enum":["completed","processing"]}},"required":["uuid","id","host_id","topic","type","start_time","timezone","duration","total_size","recording_count","meeting_type","account_name","complete_time","is_breakout_room","archive_files","status","duration_in_second"],"type":"object"},"type":"array"},"next_page_token":{"description":"Use the next page token to paginate through large result sets. A next page token is returned whenever the set of available results exceeds the current page size. This token's expiration period is 15 minutes.\n\n **Note:** if you use `next_page_token` as a parameter, your other request parameters should be changeless to make sure that the large result set is what you want. For example, if your `to` parameter is for a future time, Zoom resets this value to the current time and returns this value in the response body, along with the `next_page_token` value. Use these same `to` and `next_page_token` values in requests for the remaining results set; otherwise you will get an invalid token error.","type":"string","example":"At6eWnFZ1FB3arCXnRxqHLXKhbDW18yz2i2"},"page_size":{"description":"The number of records returned within a single API call.","type":"integer","example":20},"to":{"description":"The queried end date.","format":"date-time","type":"string","example":"2021-03-12T02:12:27Z"},"total_records":{"description":"The total number of returned meeting records.","type":"integer","example":20}},"type":"object"}}},"description":"**HTTP Status Code:** `200` <br>\n Archived files returned."},"400":{"description":"**HTTP Status Code:** `400` <br>\n Bad request.\n\n **Error Code:** `2001` <br>\n Account does not exist: {accountId}"}},"tags":["Archiving"],"description":"Get an account's archived meeting or webinar files. \n\n Zoom's [archiving solution](https://support.zoom.us/hc/en-us/articles/360050431572-Archiving-indicators) allows account administrators to set up an automated mechanism to record, collect, and archive meeting data to a 3rd-party platform of their choice to satisfy FINRA and/or other compliance requirements. \n\n **Scopes:** `recording:read:admin` <br> **[Rate Limit Label](https://developers.zoom.us/docs/api/rest/rate-limits/):** `Medium` \n\n **Prerequisites:** \n* The [**Meeting and Webinar Archiving** feature](https://support.zoom.us/hc/en-us/articles/4405656451213--Archiving-for-meetings-and-webinars) enabled for your account by [Zoom Support](https://support.zoom.us/hc/en-us/articles/201362003).","operationId":"listArchivedFiles","summary":"List archived files"}},"/rooms/calendar/services":{"get":{"summary":"List calendar services","description":"Use this API to list all the existing [calendar services](https://support.zoom.us/hc/en-us/articles/4409832833037) in a Zoom Room account. \n\n **Scopes:** `room:read:admin` <br> **[Rate Limit Label](https://developers.zoom.us/docs/api/rest/rate-limits/):** `Medium` \n\n **Prerequisites:** \n* A Pro or a higher plan with a [Zoom Rooms](https://zoom.us/zoomrooms) license.","operationId":"getCalendarServices","tags":["Zoom Rooms Calendar"],"responses":{"200":{"description":"**HTTP Status Code:** `200` <br>\nCalendar services returned successfully.","content":{"application/json":{"schema":{"type":"object","properties":{"calendar_services":{"type":"array","description":"Information about the calendar services.","items":{"type":"object","properties":{"calendar_service_id":{"type":"string","description":"The calendar service's ID.","example":"rNQUpdDXySFGhVycz7aR-SR"},"calendar_service_name":{"type":"string","description":"The calender service's name.","example":"zroom1@example.com"},"calendar_resource_total_number":{"type":"integer","description":"The total number of calendar resources.","example":100},"calendar_resource_assigned_number":{"type":"integer","description":"The number of assigned calendar resources.","example":10},"added_date_time":{"type":"string","format":"date-time","description":"The date and time at which the calendar service was added.","example":"2022-03-31T19:03:03Z"},"latest_synced_date_time":{"type":"string","format":"date-time","description":"The date and time at which the calendar service was last synced.","example":"2022-03-31T19:03:03Z"}}}}}}}}},"400":{"description":"**HTTP Status Code:** `400` <br>\nBad Request \n\n**Error Code:** `200` \n* Zoom Room subscription not found. Try again after purchasing a Zoom Room subscription. \n* At least one normal Zoom Rooms required."}},"security":[{"OAuth":[]}]}},"/rooms/calendar/services/{serviceId}":{"delete":{"summary":"Delete a calendar service","description":"Use this API to delete a Zoom Room account's calendar service. \n\n **Scopes:** `room:write:admin` <br> **[Rate Limit Label](https://developers.zoom.us/docs/api/rest/rate-limits/):** `Medium` \n\n **Prerequisites:** \n* A Pro or a higher plan with a [Zoom Rooms](https://zoom.us/zoomrooms) license.","operationId":"deleteACalendarService","tags":["Zoom Rooms Calendar"],"parameters":[{"name":"serviceId","in":"path","description":"The calendar service's ID.","required":true,"schema":{"type":"string","example":"qMOLddnySIGGVycz8aX_JQ"}}],"responses":{"204":{"description":"**HTTP Status Code:** `204` <br>\nCalendar service successfully deleted."},"400":{"description":"**HTTP Status Code:** `400` <br>\nBad Request \n\n**Error Code:** `200` \n* Zoom Room subscription not found. Try again after purchasing a Zoom Room subscription. \n* At least one normal Zoom Rooms required. \n\n**Error Code:** `4005` <br>\nCalendar resource assigned to a Zoom Room: {resourceId}"},"404":{"description":"**HTTP Status Code:** `404` <br>\nNot Found \n\n**Error Code:** `4061` <br>\nCalendar service does not exist: {serviceId}"}},"security":[{"OAuth":[]}]}},"/rooms/calendar/services/{serviceId}/sync":{"put":{"summary":"Start calendar service sync process","description":"Use this API to kick off the sync process for Zoom Room account's calendar service. \n\n **Scopes:** `room:write:admin` <br> **[Rate Limit Label](https://developers.zoom.us/docs/api/rest/rate-limits/):** `Medium` \n\n **Prerequisites:** \n* A Pro or a higher plan with a [Zoom Rooms](https://zoom.us/zoomrooms) license.","operationId":"syncACalendarService","tags":["Zoom Rooms Calendar"],"parameters":[{"name":"serviceId","in":"path","description":"The calendar service's ID.","required":true,"schema":{"type":"string","example":"qMOLddnySIGGVycz8aX_JQ"}}],"responses":{"202":{"description":"**HTTP Status Code:** `202` **Accepted**"},"400":{"description":"**HTTP Status Code:** `400` <br>\nBad Request \n\n**Error Code:** `200` \n* Zoom Room subscription not found. Try again after purchasing a Zoom Room subscription. \n* At least one normal Zoom Rooms required."},"404":{"description":"**HTTP Status Code:** `404` <br>\nNot Found \n\n**Error Code:** `4061` <br>\nCalendar service does not exist: {serviceId}"}},"security":[{"OAuth":[]}]}},"/rooms/calendar/services/{serviceId}/resources":{"get":{"summary":"List calendar resources by calendar service","description":"Use this API to list all of a Zoom Room account's [calendar resources](https://support.zoom.us/hc/en-us/articles/4409832833037). \n\n **Scopes:** `room:read:admin` <br> **[Rate Limit Label](https://developers.zoom.us/docs/api/rest/rate-limits/):** `Medium` \n\n **Prerequisites:** \n* A Pro or a higher plan with a [Zoom Rooms](https://zoom.us/zoomrooms) license.","operationId":"getCalendarResourcesByServiceId","tags":["Zoom Rooms Calendar"],"parameters":[{"description":"The number of records returned within a single API call.","in":"query","name":"page_size","schema":{"default":30,"maximum":300,"type":"integer","example":30}},{"description":"Use the next page token to paginate through large result sets. A next page token is returned whenever the set of available results exceeds the current page size. This token's expiration period is 15 minutes.","in":"query","name":"next_page_token","schema":{"type":"string","example":"IAfJX3jsOLW7w3dokmFl84zOa0MAVGyMEB2"}},{"name":"serviceId","in":"path","description":"The calendar service's ID.","required":true,"schema":{"type":"string","example":"qMOLddnySIGGVycz8aX_JQ"}}],"responses":{"200":{"description":"**HTTP Status Code:** `200` <br>\nCalendar resources successfully returned.","content":{"application/json":{"schema":{"type":"object","properties":{"next_page_token":{"type":"string","description":"The next page token is used to paginate through large result sets. A next page token will be returned whenever the set of available results exceeds the current page size. The expiration period for this token is 15 minutes.","example":"At6eWnFZ1FB3arCXnRxqHLXKhbDW18yz2i2"},"page_size":{"type":"integer","description":"The number of records returned within a single API call.","example":20},"calendar_resources":{"type":"array","description":"Information about existing calendar resources.","items":{"type":"object","properties":{"calendar_resource_id":{"type":"string","description":"The calendar resource's ID.","example":"rNQUpdDXySFGhVycz7aR-SR"},"calendar_resource_email":{"type":"string","format":"email","description":"The calendar resource's email address.","example":"zroom1@example.com"},"calendar_resource_name":{"type":"string","description":"The calendar resource's name.","example":"zroom1"},"assigned_room_id":{"type":"string","description":"The Zoom Room user ID that the calendar resource is assigned to.","example":"yLom99u5QuKBTw4Q7_P6Pw"},"sync_status":{"type":"string","description":"The calendar resource's sync status: \n* `Success` — Synched. \n* `Failed` — Not synced.","enum":["Success","Failed"],"example":"Success"}}}}}}}}},"400":{"description":"**HTTP Status Code:** `400` <br>\nBad Request \n\n**Error Code:** `200` \n* Zoom Room subscription not found. Try again after purchasing a Zoom Room subscription. \n* At least one normal Zoom Rooms required."},"404":{"description":"**HTTP Status Code:** `404` <br>\nNot Found \n\n**Error Code:** `4061` <br>\nCalendar service does not exist: {serviceId}"}},"security":[{"OAuth":[]}]},"post":{"summary":"Add a calendar resource to a calendar service","description":"Use this API to add a [calendar resource](https://support.zoom.us/hc/en-us/articles/4409832833037) to a Microsoft Exchange or Office 365 calendar service in a Zoom Room account. \n\n**Note:** This API does not support adding a calendar resource to a Google calendar service. \n\n **Scopes:** `room:write:admin` <br> **[Rate Limit Label](https://developers.zoom.us/docs/api/rest/rate-limits/):** `Medium` \n\n **Prerequisites:** \n* A Pro or a higher plan with a [Zoom Rooms](https://zoom.us/zoomrooms) license.","operationId":"addACalendarResourceToCalendarService","tags":["Zoom Rooms Calendar"],"parameters":[{"name":"serviceId","in":"path","description":"The calendar service's ID.","required":true,"schema":{"type":"string","example":"qMOLddnySIGGVycz8aX_JQ"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","required":["calendar_resource_email"],"properties":{"calendar_resource_email":{"type":"string","description":"The calendar resource's email address.","example":"zroom1@example.com"}}}}}},"responses":{"201":{"description":"**HTTP Status Code:** `201` <br>\nCalendar resource successfully added.","content":{"application/json":{"schema":{"type":"object","properties":{"calendar_resource_id":{"type":"string","description":"The calendar resource's ID.","example":"rNQUpdDXySFGhVycz7aR-SR"},"calendar_resource_email":{"type":"string","format":"email","description":"The calendar resource's email address.","example":"zroom1@example.com"},"calendar_resource_name":{"type":"string","description":"The calendar resource's name.","example":"zroom1"}}}}}},"400":{"description":"**HTTP Status Code:** `400` <br>\nBad Request \n\n**Error Code:** `200` \n* Zoom Room subscription not found. Try again after purchasing a Zoom Room subscription. \n* At least one normal Zoom Rooms required."},"404":{"description":"**HTTP Status Code:** `404` **Not Found** <br><br>\n**Error Code:** `4061`<br>\nCalendar service does not exist: {serviceId}"}},"security":[{"OAuth":[]}]}},"/rooms/calendar/services/{serviceId}/resources/{resourceId}":{"get":{"summary":"Get a calendar resource by ID","description":"Use this API to get a Zoom Room account's [calendar resource](https://support.zoom.us/hc/en-us/articles/4409832833037). \n\n **Scopes:** `room:read:admin` <br> **[Rate Limit Label](https://developers.zoom.us/docs/api/rest/rate-limits/):** `Medium` \n\n **Prerequisites:** \n* A Pro or a higher plan with a [Zoom Rooms](https://zoom.us/zoomrooms) license.","operationId":"getCalendarResourceById","tags":["Zoom Rooms Calendar"],"parameters":[{"name":"serviceId","in":"path","description":"The calendar service's ID.","required":true,"schema":{"type":"string","example":"qMOLddnySIGGVycz8aX_JQ"}},{"name":"resourceId","in":"path","description":"The calendar resource's ID.","required":true,"schema":{"type":"string","example":"rNQUpdDXySFGhVycz7aR-SR"}}],"responses":{"200":{"description":"**HTTP Status Code:** `200` <br>\nCalendar resources successfully returned.","content":{"application/json":{"schema":{"type":"object","properties":{"calendar_resource_id":{"type":"string","description":"The calendar resource's ID.","example":"rNQUpdDXySFGhVycz7aR-SR"},"calendar_resource_email":{"type":"string","format":"email","description":"The calendar resource's email address.","example":"zroom1@example.com"},"calendar_resource_name":{"type":"string","description":"The calendar resource's name.","example":"zroom1"},"assigned_room_id":{"type":"string","description":"The Zoom Room user ID that the calendar resource is assigned to.","example":"yLom99u5QuKBTw4Q7_P6Pw"},"sync_status":{"type":"string","description":"The calendar resource's sync status: \n* `Success` — Synched. \n* `Failed` — Not synced.","enum":["Success","Failed"],"example":"Success"}}}}}},"400":{"description":"**HTTP Status Code:** `400` <br>\nBad Request \n\n**Error Code:** `200` \n* Zoom Room subscription not found. Try again after purchasing a Zoom Room subscription. \n* At least one normal Zoom Rooms required."},"404":{"description":"**HTTP Status Code:** `404` <br>\nNot Found \n\n**Error Code:** `4061` <br>\nCalendar service does not exist: {serviceId} \n\n**Error Code:** `4060` <br>\nCalendar resource does not exist: {resourceId}"}},"security":[{"OAuth":[]}]},"delete":{"summary":"Delete a calendar resource","description":"Use this API to delete a Zoom Room account's [calendar resource](https://support.zoom.us/hc/en-us/articles/4409832833037) from a Microsoft Exchange or Office 365 calendar service. \n\n**Note:** This API does not support deleting a calendar resource from a Google calendar service. \n\n **Scopes:** `room:write:admin` <br> **[Rate Limit Label](https://developers.zoom.us/docs/api/rest/rate-limits/):** `Medium` \n\n **Prerequisites:** \n* A Pro or a higher plan with a [Zoom Rooms](https://zoom.us/zoomrooms) license.","operationId":"deleteACalendarResource","tags":["Zoom Rooms Calendar"],"parameters":[{"name":"serviceId","in":"path","description":"The calendar service's ID.","required":true,"schema":{"type":"string","example":"qMOLddnySIGGVycz8aX_JQ"}},{"name":"resourceId","in":"path","description":"The calendar resource's ID. You can get this value using the [**List Calendar Resources**](/docs/api-reference/zoom-api/methods#operation/listCalendarResources) API.","required":true,"schema":{"type":"string","example":"rNQUpdDXySFGhVycz7aR-SR"}}],"responses":{"204":{"description":"**HTTP Status Code:** `204` <br>\nCalendar resource successfully deleted."},"400":{"description":"**HTTP Status Code:** `400` <br>\nBad Request \n\n**Error Code:** `200` \n* Zoom Room subscription not found. Try again after purchasing a Zoom Room subscription. \n* At least one normal Zoom Rooms required. \n\n**Error Code:** `4005` <br>\nCalendar resource assigned to a Zoom Room: {resourceId}"},"404":{"description":"**HTTP Status Code:** `404` <br>\nNot Found \n\n**Error Code:** `4061` <br>\nCalendar service does not exist: {serviceId} \n\n**Error Code:** `4060` <br>\nCalendar resource does not exist: {resourceId}"}},"security":[{"OAuth":[]}]}},"/groups":{"get":{"responses":{"200":{"content":{"application/json":{"schema":{"description":"List of Groups.","properties":{"groups":{"description":"List of Group objects.","items":{"properties":{"id":{"description":"Group ID.","type":"string","example":"SobVexyrQjqCkcxjpBWi6w"},"name":{"description":"Group name.","type":"string","example":"Developers"},"total_members":{"description":"Total number of members in this group.","type":"integer","example":200}},"type":"object","description":"Group object."},"type":"array"},"total_records":{"description":"Total records.","type":"integer","example":200}},"type":"object"}}},"description":"**HTTP Status Code:** `200`<br>\nList of groups returned.<br>\n**Error Code:** `200`\nOnly available for paid accounts."},"404":{"description":"**HTTP Status Code:** `404`<br>\n**Error Code:** `4130`<br> A group with this {groupId} does not exist."}},"security":[{"OAuth":[]}],"tags":["Groups"],"description":"List [groups](https://support.zoom.us/hc/en-us/articles/204519819-Group-Management-) under an account.\n\n**Prerequisite**: Pro or higher account.<br>\n**Scopes**: `group:read:admin`<br>\n\n **[Rate Limit Label](https://developers.zoom.us/docs/api/rest/rate-limits/):** `Medium`","operationId":"groups","summary":"List groups"},"post":{"summary":"Create a group","description":"Use this API to create a [group](https://support.zoom.us/hc/en-us/articles/204519819-Group-Management). You can add a **maximum** of 100 groups in one account per day, and a maximum of 5000 groups in one account.\n\nIf you enabled a new group via the user interface, you can also choose whether to display the group and set its privacy level.\n\n**Scopes:** `group:write:admin`<br>**[Rate Limit Label](https://developers.zoom.us/docs/api/rest/rate-limits/):** `Light`\n\n**Prerequisites**: \n* A Pro or higher account","operationId":"groupCreate","tags":["Groups"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","description":"The group's name.","example":"Developers"}}}}}},"responses":{"200":{"description":"**Error Code:** `200` <br>\nOnly available for Paid account: {accountId}"},"201":{"content":{"application/json":{"schema":{"properties":{"id":{"type":"string","description":"The group ID.","example":"A4ql1FjgL913r"},"name":{"type":"string","description":"The group's name.","example":"Developers"},"total_members":{"type":"integer","description":"The group's total member count.","example":34}},"type":"object"}}},"description":"**HTTP Status Code:** `201` <br>\nGroup created."},"300":{"description":"**Error Code:** `300` <br>\nMissing field: {$name}"},"404":{"description":"**HTTP Status Code:** `404` <br>\n Not Found \n\n**Error Code:** `4130` <br>\nA group with the name \"{groupId}\" does not exist."},"409":{"description":"**HTTP Status Code:** `409` <br>\n Conflict \n\n**Error Code:** `4132` <br>\nThe group name \"{groupName}\" is already in use."},"429":{"description":"**HTTP Status Code:** `429` <br>\nYou have exceeded the daily rate limit ({0}) of Create a Group API request for this account. This limit resets at GMT 00:00:00."}},"security":[{"OAuth":[]}]}},"/groups/{groupId}":{"delete":{"parameters":[{"description":"The group ID.<br>\nRetrieve by calling the [**List groups**](/docs/api-reference/zoom-api/methods#operation/groups) API.","in":"path","name":"groupId","required":true,"schema":{"type":"string","example":"SobVexyrQjqCkcxjpBWi6w"}}],"responses":{"200":{"description":"**Error Code:** `200`<br>\nOnly available for Paid account,{accountId}."},"204":{"description":"**HTTP Status Code:** `204`<br>\nGroup deleted."},"300":{"description":"**Error Code:** `300`<br>\nGroup member not found."},"404":{"description":"**HTTP Status Code:** `404`<br>\nGroup not found.<br>\n**Error Code:** `4130`<br>\nA group with this {groupId} does not exist."}},"security":[{"OAuth":[]}],"tags":["Groups"],"description":"Use this API to delete a [group](https://support.zoom.us/hc/en-us/articles/204519819-Group-Management-).\n\n**Scopes:** `group:write:admin`<br>**[Rate Limit Label](https://developers.zoom.us/docs/api/rest/rate-limits/):** `Light`\n\n**Prerequisites:** \n* A Pro, Business, or Education account","operationId":"groupDelete","summary":"Delete a group"},"get":{"parameters":[{"description":"The group ID.<br>\nRetrieve by calling the [**List groups**](/docs/api-reference/zoom-api/methods#operation/groups) API.","in":"path","name":"groupId","required":true,"schema":{"type":"string","example":"SobVexyrQjqCkcxjpBWi6w"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"id":{"description":"Group ID.","type":"string","example":"825c9e31f1064c73b394c5e4557d3447"},"name":{"description":"Group name.","type":"string","example":"Developers"},"total_members":{"description":"Total count of members in the group.","type":"integer","example":100}},"type":"object"}}},"description":"**HTTP Status Code:** `200`<br> Group returned.<br>\n**Error Code:** `200`<br>\nOnly available for Paid account,{accountId}."},"400":{"description":"**HTTP Status Code:** `400`<br>\n**Error Code:** `1010`<br>\nGroup does not belong to your account."},"404":{"description":"**HTTP Status Code:** `404`<br>\nGroup not found.<br>\n**Error Code:** `4130`<br> A group with this {groupId} does not exist."}},"security":[{"OAuth":[]}],"tags":["Groups"],"description":"Get a [group](https://support.zoom.us/hc/en-us/articles/204519819-Group-Management-) under an account.\n\n**Prerequisite**: Pro, Business, or Education account<br>\n**Scopes**: `group:read:admin`<br>\n\n **[Rate Limit Label](https://developers.zoom.us/docs/api/rest/rate-limits/):** `Light`","operationId":"group","summary":"Get a group"},"patch":{"parameters":[{"description":"The group ID.<br>\nRetrieve by calling the [**List groups**](/docs/api-reference/zoom-api/methods#operation/groups) API.","in":"path","name":"groupId","required":true,"schema":{"type":"string","example":"SobVexyrQjqCkcxjpBWi6w"}}],"responses":{"200":{"description":"The group does not belong to this account:{accountId}."},"204":{"description":"Group updated."},"404":{"description":"**Status Code:** `404`<br>\nNot found.<br>\n**Error Code:** `4130`<br>\nA group with this {groupId} does not exist."},"409":{"description":"**Status Code:** `409`<br>\nConflict<br>\n**Error Code:** `4132`<br>\nGroup name {groupName} is already in use."}},"security":[{"OAuth":[]}],"tags":["Groups"],"description":"Update a [group](https://support.zoom.us/hc/en-us/articles/204519819-Group-Management-) under your account.\n\n**Prerequisite**: Pro, Business, or Education account<br>\n**Scopes**: `group:write:admin`<br>\n\n **[Rate Limit Label](https://developers.zoom.us/docs/api/rest/rate-limits/):** `Light`","operationId":"groupUpdate","requestBody":{"content":{"application/json":{"schema":{"properties":{"name":{"description":"Group name. It must be unique to one account and less than 128 characters.","type":"string","example":"Developers"}},"type":"object"}}},"required":true},"summary":"Update a group"}},"/groups/{groupId}/admins":{"get":{"parameters":[{"description":"The group ID.<br>\nRetrieve by calling the [**List groups**](/docs/api-reference/zoom-api/methods#operation/groups) API.","in":"path","name":"groupId","required":true,"schema":{"type":"string","example":"SobVexyrQjqCkcxjpBWi6w"}},{"description":"The number of records returned within a single API call.","in":"query","name":"page_size","schema":{"default":30,"maximum":300,"type":"integer","example":30}},{"description":"Use the next page token to paginate through large result sets. A next page token is returned whenever the set of available results exceeds the current page size. This token's expiration period is 15 minutes.","in":"query","name":"next_page_token","schema":{"type":"string","example":"IAfJX3jsOLW7w3dokmFl84zOa0MAVGyMEB2"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"admins":{"items":{"properties":{"email":{"description":"The user's email address.","format":"email","type":"string","example":"jchill@example.com"},"name":{"description":"The user's display name.","type":"string","example":"Jill Chill"}},"type":"object"},"type":"array"},"next_page_token":{"description":"The next page token is used to paginate through large result sets. A next page token is returned when the set of available results exceeds the current page size. The expiration period for this token is 15 minutes.","type":"string","example":"oMTCmjMRwzSfZtUXDIuWDswdksIQ3dyGUB1"},"page_size":{"description":"The number of records returned in a single API call.","type":"integer","example":1},"total_records":{"description":"The total number of records available across all pages.","type":"integer","example":20}},"type":"object"}}},"description":"**HTTP Status Code:** `200`<br> Only available for paid account: \"{accountId}\"."},"404":{"description":"**HTTP Status Code:** `404`<br>\nNot found.<br>\n**Error Code:** `4130`<br>\nA group with the \"{groupId}\" ID does not exist."}},"security":[{"OAuth":[]}],"tags":["Groups"],"description":"Use this API to return a list of [group](https://support.zoom.us/hc/en-us/articles/204519819-Group-Management-) administrators under your account.\n\n**Scopes:** `group:read:admin`<br>**[Rate Limit Label](https://developers.zoom.us/docs/api/rest/rate-limits/):** `Medium`\n\n**Prerequisites:** \n* A Pro, Business, or Education account","operationId":"groupAdmins","summary":"List group admins"},"post":{"parameters":[{"description":"The group ID.<br>\nRetrieve by calling the [**List groups**](/docs/api-reference/zoom-api/methods#operation/groups) API.","in":"path","name":"groupId","required":true,"schema":{"type":"string","example":"SobVexyrQjqCkcxjpBWi6w"}}],"responses":{"200":{"description":"**Status Code:** `200` <br> Only available for paid account: \"{accountId}\"."},"201":{"content":{"application/json":{"schema":{"properties":{"added_at":{"description":"The timestamp at which the administrator was added to the group.","format":"date-time","type":"string","example":"2022-03-25T03:08:12Z"},"ids":{"description":"The administrator IDs.","type":"string","example":"v4iyWT1LTfy8QvPG4GTvdg"}},"type":"object"}}},"description":"**Status Code:** `201` <br> Group administrator added."},"404":{"description":"**Status Code:** `404` <br> Not found. <br> **Error Code:** `4130` <br> A group with the \"{groupId}\" ID does not exist."}},"tags":["Groups"],"description":"Use this API to add administrators to a [group](https://support.zoom.us/hc/en-us/articles/204519819-Group-Management-) under your account.\n\n**Scopes:** `group:write:admin`<br>**[Rate Limit Label](https://developers.zoom.us/docs/api/rest/rate-limits/):** `Medium`\n\n**Prerequisites:** \n* A Pro, Business, or Education account","operationId":"groupAdminsCreate","requestBody":{"content":{"application/json":{"schema":{"properties":{"admins":{"description":"A list of the administrators to add to a group.","items":{"properties":{"email":{"description":"The user's email. Use this value if you do not have the user's ID.\n\nIf you pass the `id` value, the API ignores this parameter.","type":"string","example":"jchill@example.com"},"id":{"description":"The user's ID.","type":"string","example":"v4iyWT1LTfy8QvPG4GTvdg"}},"type":"object"},"maximum":10,"type":"array"}},"type":"object"}}},"required":true},"summary":"Add group admins"}},"/groups/{groupId}/admins/{userId}":{"delete":{"parameters":[{"description":"The group ID.<br>\nRetrieve by calling the [**List groups**](/docs/api-reference/zoom-api/methods#operation/groups) API.","in":"path","name":"groupId","required":true,"schema":{"type":"string","example":"SobVexyrQjqCkcxjpBWi6w"}},{"name":"userId","in":"path","description":"The user ID or email address of the user. For user-level apps, pass the `me` value.","required":true,"schema":{"oneOf":[{"type":"string","example":"6dfgdfgdg444447b0egga"},{"type":"string","format":"email","example":"jchill@example.com"},{"type":"string","enum":["me"],"example":"me"}]}}],"responses":{"200":{"description":"**Status Code:** `200` <br> Only available for paid account: \"{accountId}\"."},"204":{"description":"**Status Code:** `204` <br> Group administrator removed."},"400":{"description":"**Status Code:** `400` <br> Bad request. <br> **Error Code:** `4138` <br> That user is not an administrator for the group: \"{groupId}\"."},"404":{"description":"**Status Code:** `404` <br> Not found. <br> **Error Code:** `4130` <br> A group with the \"{groupId}\" ID does not exist."}},"security":[{"OAuth":[]}],"tags":["Groups"],"description":"Use this API to remove a [group](https://support.zoom.us/hc/en-us/articles/204519819-Group-Management-) administrator in a Zoom account.\n\n**Scopes:** `group:write:admin`<br>**[Rate Limit Label](https://developers.zoom.us/docs/api/rest/rate-limits/):** `Light`\n\n**Prerequisites:** \n* A Pro, Business, or Education account","operationId":"groupAdminsDelete","summary":"Delete a group admin"}},"/groups/{groupId}/lock_settings":{"get":{"parameters":[{"description":"Id of the group.","in":"path","name":"groupId","required":true,"schema":{"type":"string","example":"0mgThLiRQH2bUHvIaL4t2g"}},{"description":"Optional query parameters: \n* `meeting_security` — Use this query parameter to view the meeting security settings applied to the user's account.","in":"query","name":"option","schema":{"type":"string","example":"meeting_security"}}],"responses":{"200":{"content":{"application/json":{"schema":{"oneOf":[{"properties":{"audio_conferencing":{"properties":{"toll_free_and_fee_based_toll_call":{"description":"Whether the group has the [**Toll-free and Fee-based Toll Call**](https://support.zoom.us/hc/en-us/articles/360060950711-Enabling-Toll-free-and-Fee-based-Toll-Call) setting enabled.","type":"boolean","example":true}},"type":"object"},"email_notification":{"properties":{"alternative_host_reminder":{"description":"Notify the alternative host who is set or removed.","type":"boolean","example":true},"cancel_meeting_reminder":{"deprecated":true,"description":"Notify host and participants when the meeting is cancelled.","type":"boolean","example":true},"cloud_recording_available_reminder":{"description":"Whether to notify the host when a cloud recording is available.","type":"boolean","example":true},"jbh_reminder":{"description":"Notify host when participants join the meeting before them.","type":"boolean","example":true},"schedule_for_reminder":{"description":"Notify the host there is a meeting is scheduled, rescheduled, or cancelled.","type":"boolean","example":true}},"type":"object"},"in_meeting":{"properties":{"alert_guest_join":{"description":"Allow participants who belong to your account to see that a guest (someone who does not belong to your account) is participating in the meeting/webinar.","type":"boolean","example":true},"allow_users_to_delete_messages_in_meeting_chat":{"description":"If the value of this field is set to `true`,  allow users to delete messages in the in-meeting chat.\n","type":"boolean","example":true},"allow_live_streaming":{"description":"Whether to allow livestreaming.","type":"boolean","example":true},"allow_show_zoom_windows":{"description":"Show Zoom windows during screen share.","type":"boolean","example":true},"annotation":{"description":"Allow participants to use annotation tools to add information to shared screens.","type":"boolean","example":true},"attendee_on_hold":{"deprecated":true,"default":false,"description":"Allow host to put attendee on hold.\n\n**This field has been deprecated and is no longer supported.**","type":"boolean","example":true},"auto_answer":{"description":"Enable users to see and add contacts to 'auto-answer group' in the contact list on chat. Any call from members of this group will be automatically answered.","type":"boolean","example":true},"auto_generated_captions":{"description":"Whether to allow a live transcription service to transcribe meetings.","type":"boolean","example":true},"auto_saving_chat":{"description":"Automatically save all in-meeting chats.","type":"boolean","example":true},"breakout_room":{"description":"Allow host to split meeting participants into separate, smaller rooms.","type":"boolean","example":true},"chat":{"description":"Allow meeting participants to send chat message visible to all participants.","type":"boolean","example":true},"meeting_question_answer":{"description":"Allow participants to ask questions for the host and participants to answer.","type":"boolean","example":true},"closed_caption":{"description":"Allow host to type closed captions or assign a participant/third party device to add closed captions.","type":"boolean","example":true},"co_host":{"description":"Allow the host to add co-hosts. Co-hosts have the same in-meeting controls as the host.","type":"boolean","example":true},"custom_data_center_regions":{"description":"Displays whether or not custom [data center regions](https://support.zoom.us/hc/en-us/articles/360042411451-Selecting-data-center-regions-for-hosted-meetings-and-webinars) have been selected for meetings/webinars hosted by this group.","type":"boolean","example":true},"disable_screen_sharing_for_host_meetings":{"description":"Whether the **Disable desktop screen sharing for meetings you host** setting is enabled.","type":"boolean","example":true},"disable_screen_sharing_for_in_meeting_guests":{"description":"Whether the **Disable screen sharing when guests are in the meeting** setting is enabled.","type":"boolean","example":true},"e2e_encryption":{"description":"Require that all meetings are encrypted using AES.","type":"boolean","example":true},"entry_exit_chime":{"description":"Play sound when participants join or leave.","type":"string","example":"all"},"far_end_camera_control":{"description":"Allow another user to take control of the camera during a meeting.","type":"boolean","example":true},"feedback":{"description":"Enable users to provide feedback to Zoom at the end of the meeting.","type":"boolean","example":true},"file_transfer":{"description":"Indicates whether [in-meeting file transfer](https://support.zoom.us/hc/en-us/articles/209605493-In-meeting-file-transfer) setting has been enabled for the users in the group or not.","type":"boolean","example":true},"full_transcript":{"description":"Whether to allow the viewing of full transcripts in the in-meeting side panel.","type":"boolean","example":true},"group_hd":{"description":"Enable higher quality video for host and participants. This will require more bandwidth.","type":"boolean","example":true},"language_interpretation":{"description":"Whether to allow hosts to assign participants as interpreters who can interpret one language into another in real-time.","type":"boolean","example":true},"manual_captions":{"description":"Allow host to type closed captions or assign a participant/third party device to add closed captions.","type":"boolean","example":true},"meeting_reactions":{"description":"Whether meeting participants can [communicate using the emoji reactions](https://support.zoom.us/hc/en-us/articles/115001286183-Nonverbal-feedback-and-meeting-reactions) located in the **Reactions** menu in the meeting toolbar.","type":"boolean","example":true},"webinar_reactions":{"description":"Set this field to true to use [webinar reactions](https://support.zoom.us/hc/en-us/articles/4803536268429).","type":"boolean","example":true},"meeting_survey":{"description":"Whether the host can present a survey to participants once a meeting has ended. This feature is only available in version 5.7.3 or higher.","type":"boolean","example":true},"non_verbal_feedback":{"description":"Allow participants in a meeting can provide nonverbal feedback and express opinions by clicking on icons in the Participants panel.","type":"boolean","example":true},"original_audio":{"description":"Allow users to select original sound during a meeting.","type":"boolean","example":true},"polling":{"description":"Add 'Polls' to the meeting controls. This allows the host to survey the attendees.","type":"boolean","example":true},"post_meeting_feedback":{"description":"Display end-of-meeting experience feedback survey.","type":"boolean","example":true},"private_chat":{"description":"Allow meeting participants to send a private 1:1 message to another participant.","type":"boolean","example":true},"remote_control":{"description":"During screen sharing, allow the person who is sharing to let others control the shared content.","type":"boolean","example":true},"remote_support":{"description":"Allow meeting host to provide 1:1 remote support to another participant.","type":"boolean","example":true},"request_permission_to_unmute":{"description":"Indicates whether the [**Request permission to unmute participants**](https://support.zoom.us/hc/en-us/articles/203435537-Muting-and-unmuting-participants-in-a-meeting#h_01EGK4XFWS1SJGZ71MYGKF7260) option has been enabled and locked for the group or not.","type":"boolean","example":true},"save_caption":{"description":"Whether participants can save closed captions or transcripts.","type":"boolean","example":true},"save_captions":{"description":"Whether participants can save closed captions or transcripts.","type":"boolean","example":true},"screen_sharing":{"description":"Allow host and participants to share their screen or content during meetings.","type":"boolean","example":true},"sending_default_email_invites":{"description":"Allow users to invite participants by email only by default.","type":"boolean","example":true},"show_a_join_from_your_browser_link":{"description":"Whether to allow participants to join a meeting directly from their browser and bypass the Zoom application download process. This is useful for participants who cannot download, install, or run applications. Note that the meeting experience from the browser is limited.","type":"boolean","example":true},"show_browser_join_link":{"description":"Allow participants to join a meeting directly from their browser.","type":"boolean","example":true},"show_meeting_control_toolbar":{"description":"Always show meeting controls during a meeting.","type":"boolean","example":true},"slide_control":{"description":"Whether the person sharing during a presentation can allow others to control the slide presentation. This feature is only available in version 5.8.3 or higher.","type":"boolean","example":true},"stereo_audio":{"description":"Allow users to select stereo audio during a meeting.","type":"boolean","example":true},"use_html_format_email":{"description":"Allow  HTML formatting instead of plain text for meeting invitations scheduled with the Outlook plugin.","type":"boolean","example":true},"virtual_background":{"description":"Enable virtual background.","type":"boolean","example":true},"waiting_room":{"description":"Attendees cannot join a meeting until a host admits them individually from the waiting room.","type":"boolean","example":true},"webinar_chat":{"description":"Whether to allow webinar participants to send chat messages.","type":"boolean","example":true},"webinar_live_streaming":{"description":"Whether webinar livestreaming is enabled.","type":"boolean","example":true},"webinar_polling":{"description":"Whether the host can add polls before or during a webinar.","type":"boolean","example":true},"webinar_question_answer":{"description":"Whether attendees can ask the host and panelists questions in the webinar.","type":"boolean","example":true},"webinar_survey":{"description":"Whether the host can present surveys to attendees once a webinar has ended.","type":"boolean","example":true},"whiteboard":{"description":"Allow participants to share a whiteboard that includes annotation tools.","type":"boolean","example":true}},"type":"object"},"other_options":{"properties":{"blur_snapshot":{"description":"If true, iOS blurs the screenshot in the task switcher when multiple apps are open. Android hides the screenshot in the system-level list of recent apps.","type":"boolean","example":true}},"type":"object"},"recording":{"properties":{"account_user_access_recording":{"description":"Make cloud recordings accessible to account members only.","type":"boolean","example":true},"auto_delete_cmr":{"description":"Allow Zoom to automatically delete recordings permanently after a specified number of days.","type":"boolean","example":true},"auto_recording":{"description":"Record meetings automatically as they start.","type":"boolean","example":true},"cloud_recording":{"description":"Allow hosts to record and save the meeting / webinar in the cloud.","type":"boolean","example":true},"cloud_recording_download":{"description":"Allow anyone with a link to the cloud recording to download.","type":"boolean","example":true},"host_delete_cloud_recording":{"description":"Allow the host to delete the recordings. If this option is disabled, the recordings cannot be deleted by the host and only admin can delete them.","type":"boolean","example":true},"ip_address_access_control":{"description":"Setting to allow cloud recording access only from specific IP address ranges.\n","properties":{"enable":{"description":"If set to `true`, the cloud recordings of this account can only be accessed by the IP addresses defined in the `ip_addresses_or_ranges` property.\n\n","type":"boolean","example":true},"ip_addresses_or_ranges":{"description":"IP addresses or ranges that have access to the cloud recordings. Separate multiple IP ranges with comma. Use n.n.n.n, n.n.n.n/n or n.n.n.n - n.n.n.n syntax where n is a number.\n\nExample: `46.33.24.184, 48.99.100.2/25` or `200.181.108.17 - 220.181.108.157`\n\n","type":"string","example":"200.181.108.17 - 220.181.108.157"}},"type":"object"},"local_recording":{"description":"Allow hosts and participants to record the meeting to a local file.","type":"boolean","example":true},"prevent_host_access_recording":{"description":"If set to `true`, meeting hosts cannot view their meeting cloud recordings. Only the admins who have recording management privilege can access them.\n\n","type":"boolean","example":true},"recording_authentication":{"description":"Only authenticated users can view cloud recordings","type":"boolean","example":true},"archive":{"description":"[Archiving solution](https://support.zoom.us/hc/en-us/articles/360050431572-Archiving-Meeting-and-Webinar-data) settings. This setting can only be used if you have been granted archiving solution access by the Zoom support team.","type":"boolean","example":true}},"type":"object"},"schedule_meeting":{"properties":{"audio_type":{"description":"Determine how participants can join the audio portion of the meeting.","type":"boolean","example":true},"embed_password_in_join_link":{"description":"If the value is set to `true`, the meeting password will be encrypted and included in the join meeting link to allow participants to join with just one click without having to enter the password.\n ","type":"boolean","example":true},"force_pmi_jbh_password":{"description":"If join before host option is enabled for a personal meeting, then enforce password requirement.","type":"boolean","example":true},"host_video":{"description":"Start meetings with host video on.","type":"boolean","example":true},"join_before_host":{"description":"Allow participants to join the meeting before the host arrives","type":"boolean","example":true},"meeting_authentication":{"description":"Only authenticated users can join meetings","type":"boolean","example":true},"mute_upon_entry":{"description":"Automatically mute all participants when they join the meeting.","type":"boolean","example":true},"participant_video":{"description":"Start meetings with participant video on.","type":"boolean","example":true},"pstn_password_protected":{"description":"Generate and send new passwords for newly scheduled or edited meetings.","type":"boolean","example":true},"require_password_for_instant_meetings":{"description":"Require password for instant meetings. If you use PMI for your instant meetings, this option will be disabled.","type":"boolean","example":true},"require_password_for_pmi_meetings":{"description":"Require participants to enter password for PMI meetings.","type":"boolean","example":true},"require_password_for_scheduling_new_meetings":{"description":"This setting applies for regular meetings that do not use PMI. If enabled, a password will be generated while a host schedules a new meeting and participants will be required to enter the password before they can join the meeting.","type":"boolean","example":true},"upcoming_meeting_reminder":{"description":"Receive desktop notification for upcoming meetings.","type":"boolean","example":true}},"type":"object"},"telephony":{"properties":{"telephony_regions":{"type":"boolean","example":true},"third_party_audio":{"description":"Allow users to join the meeting using the existing 3rd party audio configuration.","type":"boolean","example":true}},"type":"object"}},"type":"object"},{"description":"The group's locked meeting and webinar security settings.","properties":{"meeting_security":{"properties":{"approved_or_denied_countries_or_regions":{"description":"Whether the [**Approve or block entry for users from specific countries/regions**](https://support.zoom.us/hc/en-us/articles/360060086231-Joining-from-specific-countries-regions) setting is enabled.","type":"boolean","example":true},"auto_security":{"description":"Whether all meetings must be secured with at least one security option. \n\n This setting can only be disabled by Enterprise, ISV, Business (with more than 100 licenses), and Education accounts.","type":"boolean","example":true},"block_user_domain":{"description":"Whether users in specific domains are blocked from joining meetings and webinars.","type":"boolean","example":true},"embed_password_in_join_link":{"description":"Whether the meeting password is encrypted and included in the invitation link. The provided link will allow participants to join the meeting without having to enter the password.","type":"boolean","example":true},"encryption_type":{"description":"The type of encryption used when starting a meeting: \n* `enhanced_encryption` — Enhanced encryption. Encryption data is stored in the cloud. \n* `e2ee` — End-to-end encryption. The encryption key is stored on the local device and cannot be obtained by anyone else. Enabling E2EE also [**disables** certain features](https://support.zoom.us/hc/en-us/articles/360048660871), such as cloud recording, live streaming, and allowing participants to join before the host.","enum":["enhanced_encryption","e2ee"],"type":"string","example":"enhanced_encryption"},"end_to_end_encrypted_meetings":{"description":"Whether end-to-end encryption is enabled for meetings.","type":"boolean","example":true},"meeting_password":{"description":"Whether all instant and scheduled meetings that users can join via client or Zoom Rooms systems are password-protected. [Personal Meeting ID (PMI)](https://support.zoom.us/hc/en-us/articles/203276937) meetings are **not** included in this setting.","type":"boolean","example":true},"only_authenticated_can_join_from_webclient":{"description":"Whether to specify that only authenticated users can join the meeting from the web client.","type":"boolean","example":true},"phone_password":{"description":"Whether passwords are required for participants joining by phone. \n\n If enabled and the meeting is password-protected, a numeric password is required for participants to join by phone. For meetings with alphanumeric passwords, a numeric password will be generated.","type":"boolean","example":true},"pmi_password":{"description":"Whether all Personal Meeting ID (PMI) meetings that users can join via client or Zoom Rooms systems are password-protected.","type":"boolean","example":true},"waiting_room":{"description":"Whether participants are placed in the [**Waiting Room**](https://support.zoom.us/hc/en-us/articles/115000332726-Waiting-Room) when they join a meeting. \n\n If the **Waiting Room** feature is enabled, the [**Allow participants to join before host**](https://support.zoom.us/hc/en-us/articles/202828525-Allow-participants-to-join-before-host) setting is automatically disabled.","type":"boolean","example":true},"webinar_password":{"description":"Whether to generate a password when scheduling webinars. Participants must use the generated password to join the scheduled webinar.","type":"boolean","example":true}},"type":"object"}},"title":"Meeting/Webinar Security Group Locked Settings","type":"object"}]}}},"description":"**Error Code:** `200`<br>\nOnly available for paid account.\n\n**Status Code:** `200`<br>\nLocked settings of group returned.\n"},"404":{"description":"**Status Code:** `404`<br>\nNot found.<br>\n**Error Code:** `4130`<br>\nGroup does not exist: {groupId}"}},"security":[{"OAuth":[]}],"tags":["Groups"],"description":"Retrieve a [group's](https://support.zoom.us/hc/en-us/articles/204519819-Group-Management-) locked settings. If you lock a setting, the group members will not be able to modify it individually. <p style=\"background-color:#FEEFB3; color:#9F6000\"><br>Note:</b> The `force_pmi_jbh_password` field under meeting settings is planned to be deprecated on September 22, 2019. This field will be replaced by another field that will provide the same functionality.</p>\n\n**Prerequisite**: Pro, Business, or Education account<br>\n**Scopes**: `group:read:admin`<br>\n\n **[Rate Limit Label](https://developers.zoom.us/docs/api/rest/rate-limits/):** `Medium`","operationId":"getGroupLockSettings","summary":"Get locked settings"},"patch":{"parameters":[{"description":"The Id of the group.","in":"path","name":"groupId","required":true,"schema":{"type":"string","example":"0mgThLiRQH2bUHvIaL4t2g"}},{"description":"Optional query parameters: \n* `meeting_security` — Use this query parameter to view the meeting security settings applied to the user's account.","in":"query","name":"option","schema":{"type":"string","example":"meeting_security"}}],"responses":{"204":{"description":"**Status Code:** `204`<br>\nGroup's locked settings updated."},"400":{"description":"**HTTP Status Code:** `400` **Bad Request**<br>\n**Error Code:** `200`<br>\nOnly available for paid account.\n"},"404":{"description":"**Status Code:** `404`<br>\nNot found.<br>\n**Error Code:** `4130`<br>\nThis group does not exist.\n"}},"security":[{"OAuth":[]}],"tags":["Groups"],"description":"Update a [group's](https://support.zoom.us/hc/en-us/articles/204519819-Group-Management-) locked settings. If you lock a setting, the group members will not be able to modify it individually. <p style=\"background-color:#FEEFB3; color:#9F6000\"><br>Note:</b> The `force_pmi_jbh_password` field under meeting settings is planned to be deprecated on September 22, 2019. This field will be replaced by another field that will provide the same functionality.</p>\n\n**Prerequisite**: Pro, Business, or Education account<br>\n**Scopes**: `group:write:admin`<br>\n\n **[Rate Limit Label](https://developers.zoom.us/docs/api/rest/rate-limits/):** `Medium`","operationId":"groupLockedSettings","requestBody":{"content":{"application/json":{"schema":{"oneOf":[{"properties":{"audio_conferencing":{"properties":{"toll_free_and_fee_based_toll_call":{"description":"Whether the group has the [**Toll-free and Fee-based Toll Call**](https://support.zoom.us/hc/en-us/articles/360060950711-Enabling-Toll-free-and-Fee-based-Toll-Call#h_01F51844DRCX3K7BRTMZ40381R) setting enabled.","type":"boolean","example":true}},"type":"object"},"email_notification":{"properties":{"alternative_host_reminder":{"description":"Notify the alternative host who is set or removed.","type":"boolean","example":true},"cancel_meeting_reminder":{"description":"Notify host and participants when the meeting is cancelled.","type":"boolean","example":true},"cloud_recording_available_reminder":{"description":"Whether to notify the host when a cloud recording is available.","type":"boolean","example":true},"jbh_reminder":{"description":"Notify host when participants join the meeting before them.","type":"boolean","example":true},"schedule_for_reminder":{"description":"Notify the host there is a meeting is scheduled, rescheduled, or cancelled.","type":"boolean","example":true}},"type":"object"},"in_meeting":{"properties":{"alert_guest_join":{"description":"Allow participants who belong to your account to see that a guest (someone who does not belong to your account) is participating in the meeting/webinar.","type":"boolean","example":true},"allow_users_to_delete_messages_in_meeting_chat":{"description":"If the value of this field is set to `true`,  allow users to delete messages in the in-meeting chat.\n","type":"boolean","example":true},"allow_live_streaming":{"description":"Whether to allow livestreaming.","type":"boolean","example":true},"allow_show_zoom_windows":{"description":"Show Zoom windows during screen share.","type":"boolean","example":true},"annotation":{"description":"Allow participants to use annotation tools to add information to shared screens.","type":"boolean","example":true},"attendee_on_hold":{"default":false,"description":"Allow host to put attendee on hold.\n\n**This field has been deprecated and is no longer supported.**","type":"boolean","example":true},"auto_answer":{"description":"Enable users to see and add contacts to 'auto-answer group' in the contact list on chat. Any call from members of this group will be automatically answered.","type":"boolean","example":true},"auto_generated_captions":{"description":"Whether to allow a live transcription service to transcribe meetings.","type":"boolean","example":true},"auto_saving_chat":{"description":"Automatically save all in-meeting chats.","type":"boolean","example":true},"breakout_room":{"description":"Allow host to split meeting participants into separate, smaller rooms.","type":"boolean","example":true},"chat":{"description":"Allow meeting participants to send chat message visible to all participants.","type":"boolean","example":true},"meeting_question_answer":{"description":"Allow participants to ask questions for the host and participants to answer.","type":"boolean","example":true},"closed_caption":{"description":"Allow host to type closed captions or assign a participant/third party device to add closed captions.","type":"boolean","example":true},"co_host":{"description":"Allow the host to add co-hosts. Co-hosts have the same in-meeting controls as the host.","type":"boolean","example":true},"custom_data_center_regions":{"description":"Displays whether or not custom [data center regions](https://support.zoom.us/hc/en-us/articles/360042411451-Selecting-data-center-regions-for-hosted-meetings-and-webinars) have been selected for meetings/webinars hosted by this group.","type":"boolean","example":true},"disable_screen_sharing_for_host_meetings":{"description":"Whether to enable the **Disable desktop screen sharing for meetings you host** setting.","type":"boolean","example":true},"disable_screen_sharing_for_in_meeting_guests":{"description":"Whether to enable the **Disable screen sharing when guests are in the meeting** setting.","type":"boolean","example":true},"e2e_encryption":{"description":"Require that all meetings are encrypted using AES.","type":"boolean","example":true},"entry_exit_chime":{"description":"Play sound when participants join or leave.","type":"string","example":"all"},"far_end_camera_control":{"description":"Allow another user to take control of the camera during a meeting.","type":"boolean","example":true},"feedback":{"description":"Enable users to provide feedback to Zoom at the end of the meeting.","type":"boolean","example":true},"file_transfer":{"description":"Indicates whether [in-meeting file transfer](https://support.zoom.us/hc/en-us/articles/209605493-In-meeting-file-transfer) setting has been enabled for the users in the group or not.","type":"boolean","example":true},"full_transcript":{"description":"Whether to allow the viewing of full transcripts in the in-meeting side panel.","type":"boolean","example":true},"group_hd":{"description":"Enable higher quality video for host and participants. This will require more bandwidth.","type":"boolean","example":true},"language_interpretation":{"description":"Whether to allow hosts to assign participants as interpreters who can interpret one language into another in real-time.","type":"boolean","example":true},"manual_captions":{"description":"Allow host to type closed captions or assign a participant/third party device to add closed captions.","type":"boolean","example":true},"meeting_reactions":{"description":"Whether meeting participants can [communicate using the emoji reactions](https://support.zoom.us/hc/en-us/articles/115001286183-Nonverbal-feedback-and-meeting-reactions) located in the **Reactions** menu in the meeting toolbar.","type":"boolean","example":true},"webinar_reactions":{"description":"Set this field to true to use [webinar reactions](https://support.zoom.us/hc/en-us/articles/4803536268429).","type":"boolean","example":true},"meeting_survey":{"description":"Whether to allow the host to present a survey to participants once a meeting has ended. This feature is only available in version 5.7.3 or higher.","type":"boolean","example":true},"non_verbal_feedback":{"description":"Allow participants in a meeting can provide nonverbal feedback and express opinions by clicking on icons in the Participants panel.","type":"boolean","example":true},"original_audio":{"description":"Allow users to select original sound during a meeting.","type":"boolean","example":true},"polling":{"description":"Add 'Polls' to the meeting controls. This allows the host to survey the attendees.","type":"boolean","example":true},"post_meeting_feedback":{"description":"Display end-of-meeting experience feedback survey.","type":"boolean","example":true},"private_chat":{"description":"Allow meeting participants to send a private 1:1 message to another participant.","type":"boolean","example":true},"remote_control":{"description":"During screen sharing, allow the person who is sharing to let others control the shared content.","type":"boolean","example":true},"remote_support":{"description":"Allow meeting host to provide 1:1 remote support to another participant.","type":"boolean","example":true},"request_permission_to_unmute":{"description":"Indicate whether the [**Request permission to unmute participants**](https://support.zoom.us/hc/en-us/articles/203435537-Muting-and-unmuting-participants-in-a-meeting#h_01EGK4XFWS1SJGZ71MYGKF7260) option should be enabled and locked for the group or not.","type":"boolean","example":true},"save_caption":{"description":"Whether to allow participants to save closed captions or transcripts.","type":"boolean","example":true},"save_captions":{"description":"Whether participants can save closed captions or transcripts.","type":"boolean","example":true},"screen_sharing":{"description":"Allow host and participants to share their screen or content during meetings.","type":"boolean","example":true},"sending_default_email_invites":{"description":"Allow users to invite participants by email only by default.","type":"boolean","example":true},"show_a_join_from_your_browser_link":{"description":"Whether to allow participants to join a meeting directly from their browser and bypass the Zoom application download process. This is useful for participants who cannot download, install, or run applications. Note that the meeting experience from the browser is limited.","type":"boolean","example":true},"show_browser_join_link":{"description":"Allow participants to join a meeting directly from their browser.","type":"boolean","example":true},"show_meeting_control_toolbar":{"description":"Always show meeting controls during a meeting.","type":"boolean","example":true},"slide_control":{"description":"Whether the person sharing during a presentation can allow others to control the slide presentation. This feature is only available in version 5.8.3 or higher.","type":"boolean","example":true},"stereo_audio":{"description":"Allow users to select stereo audio during a meeting.","type":"boolean","example":true},"use_html_format_email":{"description":"Allow  HTML formatting instead of plain text for meeting invitations scheduled with the Outlook plugin.","type":"boolean","example":true},"virtual_background":{"description":"Enable virtual background.","type":"boolean","example":true},"waiting_room":{"description":"Attendees cannot join a meeting until a host admits them individually from the waiting room.","type":"boolean","example":true},"webinar_chat":{"description":"Whether to allow webinar participants to send chat messages.","type":"boolean","example":true},"webinar_live_streaming":{"description":"Whether webinar livestreaming is enabled.","type":"boolean","example":true},"webinar_polling":{"description":"Whether to allow the host to add polls before or during a webinar.","type":"boolean","example":true},"webinar_question_answer":{"description":"Whether attendees can ask the host and panelists questions in the webinar.","type":"boolean","example":true},"webinar_survey":{"description":"Whether to allow the host to present surveys to attendees once a webinar has ended.","type":"boolean","example":true},"whiteboard":{"description":"Allow participants to share a whiteboard that includes annotation tools.","type":"boolean","example":true}},"type":"object"},"other_options":{"properties":{"blur_snapshot":{"description":"If true, iOS blurs the screenshot in the task switcher when multiple apps are open. Android hides the screenshot in the system-level list of recent apps.","type":"boolean","example":true}},"type":"object"},"recording":{"properties":{"account_user_access_recording":{"description":"Make cloud recordings accessible to account members only.","type":"boolean","example":true},"auto_delete_cmr":{"description":"Allow Zoom to automatically delete recordings permanently after a specified number of days.","type":"boolean","example":true},"auto_recording":{"description":"Record meetings automatically as they start.","type":"boolean","example":true},"cloud_recording":{"description":"Allow hosts to record and save the meeting / webinar in the cloud.","type":"boolean","example":true},"cloud_recording_download":{"description":"Allow anyone with a link to the cloud recording to download.","type":"boolean","example":true},"host_delete_cloud_recording":{"description":"Allow the host to delete the recordings. If this option is disabled, the recordings cannot be deleted by the host and only admin can delete them.","type":"boolean","example":true},"ip_address_access_control":{"description":"Setting to allow cloud recording access only from specific IP address ranges.\n","properties":{"enable":{"description":"If set to `true`, the cloud recordings of this account can only be accessed by the IP addresses defined in the `ip_addresses_or_ranges` property.\n\n","type":"boolean","example":true},"ip_addresses_or_ranges":{"description":"IP addresses or ranges that have access to the cloud recordings. Separate multiple IP ranges with comma. Use n.n.n.n, n.n.n.n/n or n.n.n.n - n.n.n.n syntax where n is a number.\n\nExample: `46.33.24.184, 48.99.100.2/25` or `200.181.108.17 - 220.181.108.157`\n\n","type":"string","example":"200.181.108.17 - 220.181.108.157"}},"type":"object"},"local_recording":{"description":"Allow hosts and participants to record the meeting to a local file.","type":"boolean","example":true},"recording_authentication":{"type":"boolean","example":true},"archive":{"description":"[Archiving solution](https://support.zoom.us/hc/en-us/articles/360050431572-Archiving-Meeting-and-Webinar-data) settings. This setting can only be used if you have been granted archiving solution access by the Zoom support team.","type":"boolean","example":true}},"type":"object"},"schedule_meeting":{"properties":{"audio_type":{"description":"Determine how participants can join the audio portion of the meeting.","type":"boolean","example":true},"embed_password_in_join_link":{"description":"If the value is set to `true`, the meeting password will be encrypted and included in the join meeting link to allow participants to join with just one click without having to enter the password.\n ","type":"boolean","example":true},"force_pmi_jbh_password":{"deprecated":true,"description":"If join before host option is enabled for a personal meeting, then enforce password requirement.","type":"boolean","example":true},"host_video":{"description":"Start meetings with host video on.","type":"boolean","example":true},"join_before_host":{"description":"Allow participants to join the meeting before the host arrives","type":"boolean","example":true},"meeting_authentication":{"description":"Only authenticated users can join meetings","type":"boolean","example":true},"mute_upon_entry":{"description":"Automatically mute all participants when they join the meeting.","type":"boolean","example":true},"participant_video":{"description":"Start meetings with participant video on.","type":"boolean","example":true},"personal_meeting":{"description":"Turn the lock setting on or off for the **Enable Personal Meeting ID** setting for a group.<br><br>\n`true`: Turn the **\"Enable Personal Meeting ID\"** setting **on** for all users in the group. Users can choose to use personal meeting ID for their meetings. <br><br>\n`false`: Turn **off** the **\"Enable Personal Meeting ID\"** setting. **If this setting is [disabled](https://support.zoom.us/hc/en-us/articles/201362843-Personal-meeting-ID-PMI-and-personal-link?flash_digest=eb7ac62d8c7fb4daf285916e3e15d87537806133#h_aa0335c8-3b06-41bc-bc1f-a8b84ef17f2a), meetings that were scheduled with PMI by this group members will be invalid. Users will have to update previously scheduled PMI meetings.**<br><br>\nFor Zoom Phone only:If a user has been assigned a desk phone, **\"Elevate to Zoom Meeting\"** on desk phone will be disabled.\n\n\n","type":"boolean","example":true},"pstn_password_protected":{"description":"Generate and send new passwords for newly scheduled or edited meetings.","type":"boolean","example":true},"require_password_for_instant_meetings":{"description":"Require password for instant meetings. If you use PMI for your instant meetings, this option will be disabled.","type":"boolean","example":true},"require_password_for_pmi_meetings":{"description":"Require participants to enter password for PMI meetings.","type":"boolean","example":true},"require_password_for_scheduling_new_meetings":{"description":"This setting applies for regular meetings that do not use PMI. If enabled, a password will be generated while a host schedules a new meeting and participants will be required to enter the password before they can join the meeting.","type":"boolean","example":true},"upcoming_meeting_reminder":{"description":"Receive desktop notification for upcoming meetings.","type":"boolean","example":true}},"type":"object"},"telephony":{"properties":{"telephony_regions":{"type":"boolean","example":true},"third_party_audio":{"description":"Allow users to join the meeting using the existing 3rd party audio configuration.","type":"boolean","example":true}},"type":"object"}},"type":"object"},{"description":"The group's updated locked meeting and webinar security settings.","properties":{"meeting_security":{"properties":{"approved_or_denied_countries_or_regions":{"description":"Whether to enable the [**Approve or block entry for users from specific countries/regions**](https://support.zoom.us/hc/en-us/articles/360060086231-Joining-from-specific-countries-regions) setting.","type":"boolean","example":true},"auto_security":{"description":"Whether to require that all meetings are secured with at least one security option. \n\n This setting can only be disabled by Enterprise, ISV, Business (with more than 100 licenses), and Education accounts.","type":"boolean","example":true},"block_user_domain":{"description":"Whether to block users in specific domains from joining meetings and webinars.","type":"boolean","example":true},"embed_password_in_join_link":{"description":"Whether the meeting password will be encrypted and included in the invitation link. The provided link will allow participants to join the meeting without having to enter the password.","type":"boolean","example":true},"encryption_type":{"description":"The type of encryption to use when starting a meeting: \n* `enhanced_encryption` — Use enhanced encryption. Encryption data is stored in the cloud. \n* `e2ee` — End-to-end encryption. The encryption key is stored on the local device and cannot be obtained by anyone else. Enabling E2EE also [**disables** certain features](https://support.zoom.us/hc/en-us/articles/360048660871), such as cloud recording, live streaming, and allowing participants to join before the host.","enum":["enhanced_encryption","e2ee"],"type":"string","example":"enhanced_encryption"},"end_to_end_encrypted_meetings":{"description":"Whether to enable end-to-end encryption for meetings. If enabled, you can specify the type of encryption in the `encryption_type` field.","type":"boolean","example":true},"meeting_password":{"description":"Whether all instant and scheduled meetings that users can join via client or Zoom Rooms systems are password-protected. [Personal Meeting ID (PMI)](https://support.zoom.us/hc/en-us/articles/203276937) meetings are **not** included in this setting.","type":"boolean","example":true},"only_authenticated_can_join_from_webclient":{"description":"Whether to specify that only authenticated users can join the meeting from the web client.","type":"boolean","example":true},"phone_password":{"description":"Whether to require a password for participants joining by phone. \n\n If enabled and the meeting is password-protected, a numeric password is required for participants to join by phone. For meetings with alphanumeric passwords, a numeric password will be generated.","type":"boolean","example":true},"pmi_password":{"description":"Whether all Personal Meeting ID (PMI) meetings that users can join via client or Zoom Rooms systems are password-protected.","type":"boolean","example":true},"waiting_room":{"description":"Whether participants are placed in the [**Waiting Room**](https://support.zoom.us/hc/en-us/articles/115000332726-Waiting-Room) when they join a meeting. \n\n If the **Waiting Room** feature is enabled, the [**Allow participants to join before host**](https://support.zoom.us/hc/en-us/articles/202828525-Allow-participants-to-join-before-host) setting is automatically disabled.","type":"boolean","example":true},"webinar_password":{"description":"Whether to generate a password when scheduling webinars. Participants must use the generated password to join the scheduled webinar.","type":"boolean","example":true}},"type":"object"}},"title":"Meeting/Webinar Security Group Locked Settings","type":"object"}]}}}},"summary":"Update locked settings"}},"/groups/{groupId}/members":{"get":{"parameters":[{"description":"The group ID.<br>\nRetrieve by calling the [**List groups**](/docs/api-reference/zoom-api/methods#operation/groups) API.","in":"path","name":"groupId","required":true,"schema":{"type":"string","example":"SobVexyrQjqCkcxjpBWi6w"}},{"description":"The number of records returned within a single API call.","in":"query","name":"page_size","schema":{"default":30,"maximum":300,"type":"integer","example":30}},{"deprecated":true,"description":"**Deprecated.** We will no longer support this field in a future release. Instead, use the `next_page_token` for pagination.","in":"query","name":"page_number","schema":{"default":1,"type":"integer","example":1}},{"description":"Use the next page token to paginate through large result sets. A next page token is returned whenever the set of available results exceeds the current page size. This token's expiration period is 15 minutes.","in":"query","name":"next_page_token","schema":{"type":"string","example":"IAfJX3jsOLW7w3dokmFl84zOa0MAVGyMEB2"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"members":{"items":{"properties":{"email":{"description":"User's email address.","type":"string","example":"jchill@example.com"},"first_name":{"description":"First name of the user.","type":"string","example":"Jill"},"id":{"description":"Unique Identifier of the user. ","type":"string","example":"v4iyWT1LTfy8QvPG4GTvdg"},"last_name":{"description":"Last name of the user.","type":"string","example":"Chill"},"type":{"description":"User type: <br> `1` - Basic<br> `2` - Licensed","type":"integer","example":1}},"type":"object"},"type":"array"},"next_page_token":{"description":"The next page token is used to paginate through large result sets. A next page token will be returned whenever the set of available results exceeds the current page size. The expiration period for this token is 15 minutes.","type":"string","example":"R4aF9Oj0fVM2hhezJTEmSKaBSkfesDwGy42"},"page_count":{"description":"The number of pages returned from this request.","type":"integer","example":20},"page_number":{"description":"The page number of the current results.","type":"integer","example":1},"page_size":{"description":"The number of records returned from a single API call.","type":"integer","example":10},"total_records":{"description":"The total number of records available across all pages.","type":"integer","example":200}},"type":"object"}}},"description":"**HTTP Status Code:** `200`<br> Only available for paid account,{accountId}."},"404":{"description":"**HTTP Status Code:** `404`<br>\nNot found.<br>\n**Error Code:** `4130`<br>\nA group with this {groupId} does not exist."}},"security":[{"OAuth":[]}],"tags":["Groups"],"description":"List the members of a [group](https://support.zoom.us/hc/en-us/articles/204519819-Group-Management-) under your account.\n\n**Prerequisite**: Pro, Business, or Education account<br>\n**Scopes**: `group:read:admin`<br>\n\n **[Rate Limit Label](https://developers.zoom.us/docs/api/rest/rate-limits/):** `Medium`","operationId":"groupMembers","summary":"List group members "},"post":{"parameters":[{"description":"The group ID.<br>\nRetrieve by calling the [**List groups**](/docs/api-reference/zoom-api/methods#operation/groups) API.","in":"path","name":"groupId","required":true,"schema":{"type":"string","example":"SobVexyrQjqCkcxjpBWi6w"}}],"responses":{"200":{"description":"Only available for paid account,{accountId}."},"201":{"content":{"application/json":{"schema":{"properties":{"added_at":{"format":"date-time","type":"string","example":"2022-03-25T03:08:12Z"},"ids":{"type":"string","example":"v4iyWT1LTfy8QvPG4GTvdg"}},"type":"object"}}},"description":"Member added."},"404":{"description":"**Status Code:** `404`<br>\nNot found.<br>\n**Error Code:** `4130`<br>\nA group with this {groupId} does not exist."}},"tags":["Groups"],"description":"Use this API to add users to a [group](https://support.zoom.us/hc/en-us/articles/204519819-Group-Management-) in your account.\n\n**Scopes:** `group:write:admin`<br>**[Rate Limit Label](https://developers.zoom.us/docs/api/rest/rate-limits/):** `Medium`\n\n**Prerequisites:** \n* A Pro, Business, or Education account","operationId":"groupMembersCreate","requestBody":{"content":{"application/json":{"schema":{"properties":{"members":{"description":"List of Group members","items":{"properties":{"email":{"description":"User email. If the user ID is given then the user email should be ignored.","type":"string","example":"jchill@example.com"},"id":{"description":"User ID.","type":"string","example":"v4iyWT1LTfy8QvPG4GTvdg"}},"type":"object"},"maximum":30,"type":"array"}},"type":"object"}}},"required":true},"summary":"Add group members"}},"/groups/{groupId}/members/{memberId}":{"delete":{"parameters":[{"description":"The group ID.<br>\nRetrieve by calling the [**List groups**](/docs/api-reference/zoom-api/methods#operation/groups) API.","in":"path","name":"groupId","required":true,"schema":{"type":"string","example":"SobVexyrQjqCkcxjpBWi6w"}},{"description":"The member ID or email address.","in":"path","name":"memberId","required":true,"schema":{"type":"string","example":"-cn1DHGRRTSOlnVwyZNhKw"}}],"responses":{"200":{"description":"Only available for paid account,{accountId}."},"204":{"description":"Group member deleted."},"400":{"description":"**Status Code:** `400`<br>\nBad request.<br>\n**Error Code:** `1010`<br>\nGroup does not belong to this account:{accountId}."},"404":{"description":"**Status Code:** `404`<br>\nNot found.<br>\n**Error Code:** `4130`<br>\nA group with this {groupId} does not exist."}},"security":[{"OAuth":[]}],"tags":["Groups"],"description":"Use this API to remove a user from a [group](https://support.zoom.us/hc/en-us/articles/204519819-Group-Management-) in an account.\n\n**Scopes:** `group:write:admin`<br>**[Rate Limit Label](https://developers.zoom.us/docs/api/rest/rate-limits/):** `Light`\n\n**Prerequisites:** \n* A Pro, Business, or Education account","operationId":"groupMembersDelete","summary":"Delete a group member"},"patch":{"parameters":[{"description":"The group's unique ID. To get this value, use the [**List groups**](/docs/api-reference/zoom-api/methods#operation/groups) API.\n* To set a user's primary group, use the `target_group_id` value for this parameter's value. \n* To move a group member from one group to another, use the `groupId` of the designated group.","in":"path","name":"groupId","required":true,"schema":{"type":"string","example":"SobVexyrQjqCkcxjpBWi6w"}},{"description":"The group member's unique ID. To get this value, use the [**List group members**](/docs/api-reference/zoom-api/methods#operation/groupMembers) API.","in":"path","name":"memberId","required":true,"schema":{"type":"string","example":"v4iyWT1LTfy8QvPG4GTvdg"}}],"responses":{"204":{"description":"**HTTP Status Code:** `204` **No Content**<br>\nGroup member updated."},"400":{"description":"**HTTP Status Code:** `400` **Bad Request**<br>\n**Error Code:** `200`<br>\n Only available for Paid account, {accountId}.<br><br>\n **Error Code:** `300`<br>\n The target_group_id can not be empty.<br><br>\n **Error Code:** `1010`<br>\n Group does not belong to this account:{accountId}.\n\n\n"},"404":{"description":"**HTTP Status Code:** `404` **Not Found**<br>\n**Error Code:** `4130`<br>\nA group with this {groupId} does not exist."}},"security":[{"OAuth":[]}],"tags":["Groups"],"description":"Use this API to perform either of the following tasks: \n* Remove a group member from one group and move them to a different group. \n* Set a user's primary group. By default, the primary group is the first group that user is added to.\n\nIf a user is a member of multiple groups, you can [assign the user a primary group](https://support.zoom.us/hc/en-us/articles/204519819-Group-Management-#h_d07c7dcd-4fd8-485a-b5fe-a322e8d21c09). The user will use the primary group's settings by default. However, if the user is a member of a group with locked settings, those group settings will remain locked to the user.\n\n**Scopes:** `group:write:admin`<br>**[Rate Limit Label](https://developers.zoom.us/docs/api/rest/rate-limits/):** `Medium`\n\n**Prerequisites:** \n* A Pro or higher account","operationId":"updateAGroupMember","requestBody":{"content":{"application/json":{"schema":{"properties":{"action":{"description":"The action to perform: \n* `move` — Remove the group member from one group and move them to a different group. \n* `set_primary` — Set the user's primary group.","enum":["move","set_primary"],"type":"string","example":"move"},"target_group_id":{"description":"The target group's ID. To get this value, use the [**List groups**](/docs/api-reference/zoom-api/methods#operation/groups) API. \n* To set a user's primary group, use the designated primary group's `groupId` value. \n* To move a group member from one group to another, use the `groupId` of the designated group.","type":"string","example":"SobVexyrQjqCkcxjpBWi6w"}},"required":["action"],"type":"object"}}}},"summary":"Update a group member"}},"/groups/{groupId}/settings":{"get":{"summary":"Get a group's settings","description":"Get settings for a [group](https://support.zoom.us/hc/en-us/articles/204519819-Group-Management-). \n**Prerequisite**: Pro, Business, or Education account<br>\n**Scopes**: `group:read:admin`<br>\n \n **[Rate Limit Label](https://developers.zoom.us/docs/api/rest/rate-limits/):** `Medium`","operationId":"getGroupSettings","tags":["Groups"],"parameters":[{"name":"option","in":"query","allowEmptyValue":true,"description":"Optional query parameters: \n* `meeting_authentication` — Use this query parameter to view the [meeting authentication settings](https://support.zoom.us/hc/en-us/articles/360037117472-Authentication-Profiles-for-Meetings-and-Webinars) applied to the user's account. \n* `recording_authentication` — Use this query parameter to view the [recording authentication settings](https://support.zoom.us/hc/en-us/articles/360037756671-Authentication-Profiles-for-Cloud-Recordings) applied to the user's account. \n* `meeting_security` — Use this query parameter to view the meeting security settings applied to the user's account.","schema":{"type":"string","enum":["meeting_authentication","recording_authentication","meeting_security"],"example":"meeting_security"}},{"name":"groupId","in":"path","required":true,"schema":{"type":"string","example":"0mgThLiRQH2bUHvIaL4t2g"}},{"name":"custom_query_fields","in":"query","description":"Provide the name of the field by which you would like to filter the response. For example, if you provide \"host_video\" as the value of this field, you will get a response similar to the following: \n\n{\n \"schedule_meeting\": {\n \"host_video\": false\n }\n} \n\nYou can provide multiple values by separating them with commas(example: \"host_video,participant_video\").","schema":{"type":"string","example":"host_video"}}],"responses":{"200":{"content":{"application/json":{"schema":{"oneOf":[{"properties":{"audio_conferencing":{"description":"The group's audio conference settings.","properties":{"toll_free_and_fee_based_toll_call":{"description":"The group's [**Toll-free and Fee-based Toll Call**](https://support.zoom.us/hc/en-us/articles/360060950711-Enabling-Toll-free-and-Fee-based-Toll-Call#h_01F51844DRCX3K7BRTMZ40381R) settings.","properties":{"allow_webinar_attendees_dial":{"description":"Whether webinar attendees can dial in through the account's **Toll-free and Fee-based Toll Call** phone numbers. This feature is only available in version 5.2.2 and higher.","type":"boolean","example":true},"enable":{"description":"Whether the group has the [**Toll-free and Fee-based Toll Call**](https://support.zoom.us/hc/en-us/articles/360060950711-Enabling-Toll-free-and-Fee-based-Toll-Call#h_01F51844DRCX3K7BRTMZ40381R) setting enabled.","type":"boolean","example":true},"numbers":{"description":"The group's **Toll-free and Fee-based Toll Call** phone number information.","items":{"properties":{"code":{"description":"The phone number's [E.164 country calling code](https://en.wikipedia.org/wiki/List_of_country_calling_codes).","type":"string","example":"86"},"country_code":{"description":"The phone number's [country code](https://marketplace.zoom.us/docs/api-reference/other-references/abbreviation-lists#countries).","type":"string","example":"CN"},"country_name":{"description":"The country name.","type":"string","example":"China"},"display_number":{"description":"The phone number's display number.","maxLength":30,"type":"string","example":"+86 7777 777"},"number":{"description":"The phone number.","maxLength":30,"type":"string","example":"7777 777"}},"type":"object"},"maxItems":100,"type":"array"}},"type":"object"}},"type":"object"},"email_notification":{"properties":{"alternative_host_reminder":{"description":"Notify the alternative host who is set or removed.","type":"boolean","example":true},"cancel_meeting_reminder":{"description":"Notify host and participants when the meeting is cancelled.","type":"boolean","example":true},"cloud_recording_available_reminder":{"description":"Whether to notify the host when a cloud recording is available.","type":"boolean","example":true},"jbh_reminder":{"description":"Notify host when participants join the meeting before them.","type":"boolean","example":true},"recording_available_reminder_alternative_hosts":{"description":"Whether to notify any alternative hosts when a cloud recording is available.","type":"boolean","example":true},"recording_available_reminder_schedulers":{"description":"Whether to notify the person who scheduled the meeting or webinar for the host when a cloud recording is available.","type":"boolean","example":true},"schedule_for_reminder":{"description":"Notify the host there is a meeting is scheduled, rescheduled, or cancelled.","type":"boolean","example":true}},"type":"object"},"in_meeting":{"properties":{"alert_guest_join":{"description":"Allow participants who belong to your account to see that a guest (someone who does not belong to your account) is participating in the meeting/webinar.","type":"boolean","example":true},"allow_users_to_delete_messages_in_meeting_chat":{"description":"If the value of this field is set to `true`,  allow users to delete messages in the in-meeting chat.\n","type":"boolean","example":true},"allow_live_streaming":{"description":"Whether livestreaming is enabled.","type":"boolean","example":true},"allow_participants_chat_with":{"description":"Whether to allow participants to only chat with certain groups:\n* `1` — The participant cannot use chat.\n* `2` — Host and co-hosts only.\n * `3` — The participant can chat with other participants publicly.\n* `4` - The participant can chat with other participants publicly and privately.\n\n**Note:** This setting is only available with client versions 5.7.3 and above.","enum":[1,2,3,4],"type":"integer","x-enum-descriptions":["No one","Host and co-hosts","Everyone","Everyone and anyone directly"],"example":1},"allow_show_zoom_windows":{"description":"Show Zoom windows during screen share.","type":"boolean","example":true},"allow_users_save_chats":{"description":"Whether to allow participants to save meeting chats:\n* `1` — Participants cannot save meeting chats.\n* `2` — Participants can only save host and co-host meeting chats.\n* `3` — Participants can save all meeting chats.","enum":[1,2,3],"type":"integer","x-enum-descriptions":["Not allow","Host and co-hosts","Everyone"],"example":1},"annotation":{"description":"Allow participants to use annotation tools to add information to shared screens.","type":"boolean","example":true},"attendee_on_hold":{"default":false,"description":"Allow host to put attendee on hold.\n\n**This field has been deprecated and is no longer supported.**","type":"boolean","example":true},"auto_answer":{"description":"Enable users to see and add contacts to 'auto-answer group' in the contact list on chat. Any call from members of this group will be automatically answered.","type":"boolean","example":true},"auto_saving_chat":{"description":"Automatically save all in-meeting chats.","type":"boolean","example":true},"breakout_room":{"description":"Allow host to split meeting participants into separate, smaller rooms.","type":"boolean","example":true},"breakout_room_schedule":{"description":"Whether the host can assign participants to breakout rooms when scheduling. This feature is **only** available in version 4.5.0 or higher.","type":"boolean","example":true},"chat":{"description":"Allow meeting participants to send chat message visible to all participants.","type":"boolean","example":true},"meeting_question_answer":{"description":"Allow participants to ask questions for the host and participants to answer.","type":"boolean","example":true},"closed_caption":{"description":"Allow host to type closed captions or assign a participant/third party device to add closed captions.","type":"boolean","example":true},"closed_captioning":{"description":"Information about the group's closed captioning settings.","properties":{"auto_transcribing":{"description":"Whether to allow a live transcription service to transcribe meetings.","type":"boolean","example":true},"enable":{"description":"Whether to allow the host to type closed captions or assign a participant or 3rd-party service to provide closed captioning.","type":"boolean","example":true},"save_caption":{"description":"Whether to allow participants to save closed captions or transcripts.","type":"boolean","example":true},"third_party_captioning_service":{"description":"Whether to allow the use of an API token to integrate with 3rd-party closed captioning services.","type":"boolean","example":true},"view_full_transcript":{"description":"Whether to allow the viewing of full transcripts in the in-meeting side panel.","type":"boolean","example":true}},"type":"object"},"co_host":{"description":"Allow the host to add co-hosts. Co-hosts have the same in-meeting controls as the host.","type":"boolean","example":true},"custom_data_center_regions":{"description":"If set to `true`, you can [select data center regions](https://support.zoom.us/hc/en-us/articles/360042411451-Selecting-data-center-regions-for-hosted-meetings-and-webinars) to be used by this group for hosting their real-time meeting and webinar traffic. These regions can be provided in the `data_center_regions` field. If set to `false`, the regions cannot be customized and the default regions will be used.","type":"boolean","example":true},"custom_live_streaming_service":{"description":"Whether custom livestreaming is enabled.","type":"boolean","example":true},"custom_service_instructions":{"description":"The specific instructions to allow your account's meeting hosts to configure a custom livestream.","type":"string","example":"The specific instructions"},"data_center_regions":{"type":"array","description":"If the value of `custom_data_center_regions` is `true`, a comma-separated list of the following [data center regions](https://support.zoom.us/hc/en-us/articles/360059254691-Datacenter-abbreviation-list) to opt in to: \n* `AU` — Australia.\n* `LA` — Latin America. \n* `CA` — Canada. \n* `CN` — China. \n* `DE` — Germany. \n* `HK` — Hong Kong SAR. \n* `IN` — India. \n* `IE` — Ireland. \n* `TY` — Japan. \n* `MX` — Mexico. \n* `NL` — Netherlands. \n* `SG` — Singapore. \n* `US` — United States.","items":{"type":"string","enum":["AU","LA","CA","CN","DE","HK","IN","IE","TY","MX","NL","SG","US"],"example":"AU"}},"disable_screen_sharing_for_host_meetings":{"description":"Whether the **Disable desktop screen sharing for meetings you host** setting is enabled.","type":"boolean","example":true},"disable_screen_sharing_for_in_meeting_guests":{"description":"Whether the **Disable screen sharing when guests are in the meeting** setting is enabled.","type":"boolean","example":true},"e2e_encryption":{"description":"Require that all meetings are encrypted using AES.","type":"boolean","example":true},"entry_exit_chime":{"description":"Play sound when participants join or leave.","type":"string","example":"all"},"far_end_camera_control":{"description":"Allow another user to take control of the camera during a meeting.","type":"boolean","example":true},"feedback":{"description":"Enable users to provide feedback to Zoom at the end of the meeting.","type":"boolean","example":true},"file_transfer":{"description":"Indicates whether [in-meeting file transfer](https://support.zoom.us/hc/en-us/articles/209605493-In-meeting-file-transfer) setting has been enabled for the users in the group or not.","type":"boolean","example":true},"group_hd":{"description":"Enable higher quality video for host and participants. This will require more bandwidth.","type":"boolean","example":true},"join_from_desktop":{"description":"Whether to allow participants to join a meeting directly from their desktop browser. Note that the meeting experience from the desktop browser is limited.","type":"boolean","example":true},"join_from_mobile":{"description":"Whether to allow participants to join a meeting directly from their mobile browser. Note that the meeting experience from the mobile browser is limited.","type":"boolean","example":true},"auto_generated_translation":{"description":"Information about the [Translate captions](https://support.zoom.us/hc/en-us/articles/8158738379917-Managing-automated-captions-) settings in meetings.","properties":{"language_item_pairList":{"description":"Information about all  speak languages and  translation languages in meetings.","type":"object","properties":{"trans_lang_config":{"type":"array","description":"A list of speak languages and  translation languages.","items":{"type":"object","description":"A item of speak language and  translation languages in meetings.","properties":{"speak_language":{"type":"object","description":"language used in meetings","properties":{"name":{"type":"string","enum":["Chinese (Simplified)","Dutch","English","French","German","Italian","Japanese","Korean","Portuguese","Russian","Spanish","Ukrainian"],"example":"Chinese (Simplified)","description":"the name of language"},"code":{"type":"string","enum":["zh","nl","en","fr","de","it","ja","ko","pt","ru","es","uk"],"example":"zh","description":"th code for the language"}}},"translate_to":{"type":"object","description":"Information about all the translation languages.","properties":{"all":{"type":"boolean","example":true,"description":"Whether to select all the translation languages"},"language_config":{"type":"array","description":"A list of the translation languages.","items":{"type":"object","description":"A item of translation languages.","properties":{"name":{"type":"string","example":"English","enum":["English"],"description":"the name of translation language"},"code":{"type":"string","enum":["en"],"example":"en","description":"the code of translation language"}}}}}}}}},"all":{"description":"Whether to select all speak languages and translation languages","type":"boolean","example":true}}},"enable":{"description":"Whether to allow users to enable automated translated captions in these language pairs in meetings.","type":"boolean","example":true}},"type":"object"},"language_interpretation":{"description":"Information about the [language interpretation](https://support.zoom.us/hc/en-us/articles/360034919791-Using-Language-Interpretation-in-your-meeting-or-webinar) settings.","properties":{"custom_languages":{"description":"A list of user-defined supported languages.","items":{"type":"string","example":"English"},"type":"array"},"enable_language_interpretation_by_default":{"description":"Whether enable language interpretation by default.","type":"boolean","example":true},"allow_participants_to_speak_in_listening_channel":{"description":"Whether to allow participants to speak in listening channel.","type":"boolean","example":true},"allow_up_to_25_custom_languages_when_scheduling_meetings":{"description":"Whether to allow up to 25 custom languages when scheduling meetings.","type":"boolean","example":true},"enable":{"description":"Whether to allow hosts to assign participants as interpreters who can interpret one language into another in real-time.","type":"boolean","example":true},"languages":{"description":"A list of system-supported languages.","enum":["English","Chinese","Japanese","German","French","Russian","Portuguese","Spanish","Korean"],"items":{"type":"string","example":"English"},"type":"array"}},"type":"object"},"live_streaming_facebook":{"description":"Whether Facebook livestreaming is enabled.","type":"boolean","example":true},"live_streaming_youtube":{"description":"Whether YouTube livestreaming is enabled.","type":"boolean","example":true},"manual_captioning":{"description":"Information about manual captioning settings.","properties":{"allow_to_type":{"description":"Whether to allow the host to manually caption or let the host assign a participant to provide manual captioning.","type":"boolean","example":true},"auto_generated_captions":{"description":"Whether to enable Zoom's [live transcription feature](https://support.zoom.us/hc/en-us/articles/207279736-Managing-closed-captioning-and-live-transcription#h_01FHGGHYJ4457H4GSZY0KM3NSB).","type":"boolean","example":true},"full_transcript":{"description":"Whether to enable the viewing of full transcripts in the in-meeting side panel.","type":"boolean","example":true},"manual_captions":{"description":"Whether to [enable manual closed captioning](https://support.zoom.us/hc/en-us/articles/207279736-Managing-closed-captioning-and-live-transcription).","type":"boolean","example":true},"save_captions":{"description":"Whether to allow participants to [save closed captions or transcripts](https://support.zoom.us/hc/en-us/articles/360060958752). \n\n **Note:** If the `full_transcript` field is set to `false`, participants **cannot** save captions.","type":"boolean","example":true},"third_party_captioning_service":{"description":"Whether to allow the use of an API token to integrate with a [3rd-party device](https://support.zoom.us/hc/en-us/articles/115002212983) to provide closed captioning.","type":"boolean","example":true}},"type":"object"},"meeting_reactions":{"description":"Whether meeting participants can [communicate using the emoji reactions](https://support.zoom.us/hc/en-us/articles/115001286183-Nonverbal-feedback-and-meeting-reactions) located in the **Reactions** menu in the meeting toolbar.","type":"boolean","example":true},"meeting_reactions_emojis":{"description":"Choose from the following meeting reaction options:\n* `all` — All emojis: Allow meeting participants to use any emoji available in Zoom chat as a reaction in a meeting.\n* `selected` — Selected emojis: Allow meeting participants to use the 6 standard meeting reaction emojis: Clapping Hands, Thumbs Up, Heart, Tears of Joy, Open Mouth, Party Popper (Tada, Celebration) ","type":"string","enum":["all","selected"],"x-enum-descriptions":["Allow meeting participants to use any emoji available in Zoom chat as a reaction in a meeting.","Allow meeting participants to use the 6 standard meeting reaction emojis: Clapping Hands, Thumbs Up, Heart, Tears of Joy, Open Mouth, Party Popper (Tada, Celebration) ."],"example":"all"},"allow_host_panelists_to_use_audible_clap":{"description":"Whether to allow host and panelist to use audible clap.","type":"boolean","example":true},"webinar_reactions":{"description":"Set this field to true to use [webinar reactions](https://support.zoom.us/hc/en-us/articles/4803536268429).","type":"boolean","example":true},"meeting_survey":{"description":"Whether to allow the host to present a survey to participants once a meeting has ended. This feature is only available in version 5.7.3 or higher.","type":"boolean","example":true},"non_verbal_feedback":{"description":"Allow participants in a meeting can provide nonverbal feedback and express opinions by clicking on icons in the Participants panel.","type":"boolean","example":true},"only_host_view_device_list":{"description":"Show the list of H.323/SIP devices only to the host.","type":"boolean","example":true},"original_audio":{"description":"Allow users to select original sound during a meeting.","type":"boolean","example":true},"polling":{"description":"Add 'Polls' to the meeting controls. This allows the host to survey the attendees.","type":"boolean","example":true},"post_meeting_feedback":{"description":"Display end-of-meeting experience feedback survey.","type":"boolean","example":true},"private_chat":{"description":"Allow meeting participants to send a private 1:1 message to another participant.","type":"boolean","example":true},"record_play_own_voice":{"description":"When each participant joins by telephone, allow the option to record and play their own voice as entry and exit chimes.","type":"boolean","example":true},"remote_control":{"description":"During screen sharing, allow the person who is sharing to let others control the shared content.","type":"boolean","example":true},"remote_support":{"description":"Allow meeting host to provide 1:1 remote support to another participant.","type":"boolean","example":true},"request_permission_to_unmute":{"description":"Indicates whether the [**Request permission to unmute participants**](https://support.zoom.us/hc/en-us/articles/203435537-Muting-and-unmuting-participants-in-a-meeting#h_01EGK4XFWS1SJGZ71MYGKF7260) option has been enabled for the group or not.","type":"boolean","example":true},"screen_sharing":{"description":"Allow host and participants to share their screen or content during meetings.","type":"boolean","example":true},"sending_default_email_invites":{"description":"Allow users to invite participants by email only by default.","type":"boolean","example":true},"show_a_join_from_your_browser_link":{"description":"Whether to allow participants to join a meeting directly from their browser and bypass the Zoom application download process. This is useful for participants who cannot download, install, or run applications. Note that the meeting experience from the browser is limited.","type":"boolean","example":true},"show_browser_join_link":{"description":"Allow participants to join a meeting directly from their browser.","type":"boolean","example":true},"show_device_list":{"description":"Show the list of H.323/SIP devices.","type":"boolean","example":true},"show_meeting_control_toolbar":{"description":"Always show meeting controls during a meeting.","type":"boolean","example":true},"slide_control":{"description":"Whether the person sharing during a presentation can allow others to control the slide presentation. This feature is only available in version 5.8.3 or higher.","type":"boolean","example":true},"stereo_audio":{"description":"Allow users to select stereo audio during a meeting.","type":"boolean","example":true},"unchecked_data_center_regions":{"description":"If the value of `custom_data_center_regions` is `true`, a comma-separated list of the following [data center regions](https://support.zoom.us/hc/en-us/articles/360059254691-Datacenter-abbreviation-list) to **not** opt in to: \n* `EU` — Europe. \n* `HK` — Hong Kong. \n* `AU` — Australia. \n* `IN` — India. \n* `LA` — Latin America. \n* `TY` — Tokyo. \n* `CN` — China. \n* `US` — United States. \n* `CA` — Canada.","enum":["EU","HK","AU","IN","TY","CN","US","CA","DE","NL","LA"],"items":{"type":"string","example":"EU"},"type":"array"},"use_html_format_email":{"description":"Allow  HTML formatting instead of plain text for meeting invitations scheduled with the Outlook plugin.","type":"boolean","example":true},"virtual_background":{"description":"Enable virtual background.","type":"boolean","example":true},"virtual_background_settings":{"description":"Settings to manage virtual background.","properties":{"allow_upload_custom":{"description":"Allow users to upload custom backgrounds.","type":"boolean","example":true},"allow_videos":{"description":"Allow use of videos for virtual backgrounds.","type":"boolean","example":true},"enable":{"description":"Enable virtual background.","type":"boolean","example":true},"files":{"items":{"properties":{"id":{"description":"Unique identifier of the file.","type":"string","example":"fawegw4tq43t35h4nhgfnethswe"},"is_default":{"description":"Indicates whether or not this file is the default virtual background file.","type":"boolean","example":true},"name":{"description":"File name.","type":"string","example":"File name"},"size":{"description":"File size.","type":"integer","example":1435},"type":{"description":"File type.","type":"string","example":"image"}},"type":"object"},"type":"array"}},"type":"object"},"waiting_room":{"description":"Attendees cannot join a meeting until a host admits them individually from the waiting room.","type":"boolean","example":true},"webinar_chat":{"properties":{"allow_attendees_chat_with":{"description":"Allow webinar attendees to chat with:\n* `1` — No one.\n* `2` — Host and all panelists.\n* `3` — Everyone.","enum":[1,2,3],"type":"integer","example":1},"allow_auto_save_local_chat_file":{"description":"Whether to automatically save chat messages to a local file on the host's computer when the webinar ends.","type":"boolean","example":true},"allow_panelists_chat_with":{"description":"Allow webinar panelists to chat with:\n* `1` — Host and all panelists.\n* `2` — Everyone.","enum":[1,2],"type":"integer","example":2},"allow_panelists_send_direct_message":{"description":"Whether to allow webinar panelists to send direct messages to other panelists.","type":"boolean","example":true},"allow_users_save_chats":{"description":"Whether to allow webinar attendees to save chats:\n* `0` — Attendees cannot save chats.\n* `1` — Attendees can only save host and panelist chats.\n* `2` — Attendees can save all chats.","enum":[0,1,2],"type":"integer","example":0},"default_attendees_chat_with":{"description":"By default, allow webinar attendees to chat with:\n* `1` — Host and all panelists.\n* `2` — Everyone.","enum":[1,2],"type":"integer","example":1},"enable":{"description":"Whether to allow webinar participants to send chat messages.","type":"boolean","example":true}},"type":"object"},"webinar_live_streaming":{"properties":{"custom_service_instructions":{"description":"The specific instructions to allow your account's meeting hosts to configure a custom livestream.","type":"string","example":"The specific instructions test"},"enable":{"description":"Whether webinar livestreaming is enabled.","type":"boolean","example":true},"live_streaming_reminder":{"description":"Whether to notify users to watch the livestream. This does not apply to custom RTMP (real-time messaging protocol).","type":"boolean","example":true},"live_streaming_service":{"description":"The available livestreaming services:\n* `facebook`\n* `workplace_by_facebook`\n* `youtube`\n* `custom_live_streaming_service`","items":{"enum":["facebook","workplace_by_facebook","youtube","custom_live_streaming_service"],"type":"string","x-enum-descriptions":["Facebook","Workplace by Facebook","YouTube","Custom Live Streaming Service"],"example":"facebook"},"type":"array"}},"type":"object"},"meeting_polling":{"type":"object","description":"Information about the account's meeting polling settings.","properties":{"enable":{"type":"boolean","description":"Whether to allow the host to add polls before or during a meeting.","example":true},"advanced_polls":{"type":"boolean","description":"Whether to allow host to create advanced polls and quizzes. Advanced polls and quizzes include single choice, multiple choice, drop down, matching, short answer, long answer, rank order, and fill-in-the-blank questions. Hosts can also set the correct answers for quizzes they create.","example":true},"manage_saved_polls_and_quizzes":{"description":"Whether to allow users to manage saved polls and quizzes from Meetings","type":"boolean","example":true},"require_answers_to_be_anonymous":{"description":"Whether to require answers to be anonymous.","type":"boolean","example":true},"allow_alternative_host_to_add_edit":{"type":"boolean","description":"Whether to allow alternative hosts to add or edit polls and quizzes.","example":true},"allow_host_to_upload_image":{"description":"Whether to allow host to upload an image for each question.","type":"boolean","example":true}}},"webinar_polling":{"properties":{"enable":{"description":"Whether to allow the host to add polls before or during a webinar.","type":"boolean","example":true},"advanced_polls":{"description":"Whether to allow host to create advanced polls and quizzes. Advanced polls and quizzes include single choice, multiple choice, drop down, matching, short answer, long answer, rank order, and fill-in-the-blank questions. Hosts can also set the correct answers for quizzes they create.","type":"boolean","example":true},"manage_saved_polls_and_quizzes":{"description":"Whether to allow users to manage saved polls and quizzes from Meetings","type":"boolean","example":true},"require_answers_to_be_anonymous":{"description":"Whether to require answers to be anonymous.","type":"boolean","example":true},"allow_host_to_upload_image":{"description":"Whether to allow host to upload an image for each question.","type":"boolean","example":true},"allow_alternative_host_to_add_edit":{"type":"boolean","description":"Whether to allow alternative hosts to add or edit polls and quizzes.","example":true}},"type":"object"},"webinar_question_answer":{"description":"Whether attendees can ask the host and panelists questions in the webinar.","type":"boolean","example":true},"webinar_survey":{"description":"Whether to allow the host to present surveys to attendees once a webinar has ended.","type":"boolean","example":true},"whiteboard":{"description":"Allow participants to share a whiteboard that includes annotation tools.","type":"boolean","example":true},"who_can_share_screen":{"description":"Indicates who can share their screen or content during meetings. The value can be one of the following: <br>\n`host`: Only host can share the screen.<br>\n`all`: Both hosts and attendees can share their screen during meetings. For Webinar, the hosts and panelists can start screen sharing, but not the attendees.\n","enum":["host","all"],"type":"string","example":"host"},"who_can_share_screen_when_someone_is_sharing":{"description":"Indicates who is allowed to start sharing screen when someone else in the meeting is sharing their screen. The value can be one of the following:<br>\n`host`: Only a host can share the screen when someone else is sharing.<br>\n`all`: Anyone in the meeting is allowed to start sharing their screen when someone else is sharing. For Webinar, the hosts and panelists can start screen sharing, but not the attendees.\n","enum":["host","all"],"type":"string","example":"all"},"participants_share_simultaneously":{"description":"Indicates how many participants can share at the same time. The value can be one of the following:<br>\n`one`: Only one participant can share at a time\n.<br>\n`multiple`: Multiple participants can share simultaneously (dual monitors recommended)\n. For Webinar, the hosts and panelists can start screen sharing, but not the attendees.\n","enum":["multiple","one"],"type":"string","example":"multiple"},"workplace_by_facebook":{"description":"Whether Workplace by Facebook is enabled.","type":"boolean","example":true}},"type":"object"},"other_options":{"properties":{"allow_users_contact_support_via_chat":{"description":"Whether to display the Zoom help badge on the bottom-right of the page.","type":"boolean","example":true},"blur_snapshot":{"description":"Whether iOS blurs the screenshot in the task switcher when multiple apps are open. Android hides the screenshot in the system-level list of recent apps.","type":"boolean","example":true},"webinar_registration_options":{"type":"object","description":"Webinar registration options.","properties":{"allow_host_to_enable_join_info":{"type":"boolean","description":"Allow host to enable \"Show join info on registration confirmation page\".","example":true},"allow_host_to_enable_social_share_buttons":{"type":"boolean","description":"Allow host to enable \"Show social share buttons on registration page\".","example":true},"enable_custom_questions":{"type":"boolean","description":"Enable custom questions.","example":true}}}},"type":"object"},"profile":{"properties":{"recording_storage_location":{"properties":{"allowed_values":{"description":"Users can choose the country to store their recorded content. Content can include meeting, webinar, and phone recordings, as well as voicemail, transcripts, and custom greeting prompts. See [Managing the Communications Content storage location](https://support.zoom.us/hc/en-us/articles/360050781131) for details.\n\nProvide abbreviated country codes as the value for this field. See the [Countries abbreviation list](https://marketplace.zoom.us/docs/api-reference/other-references/abbreviation-lists#countries) for details.","items":{"type":"string","example":"US"},"type":"array"},"value":{"description":"Abbreviated country code.","type":"string","example":"US"}},"type":"object"}},"title":"Profile","type":"object"},"recording":{"properties":{"account_user_access_recording":{"description":"Make cloud recordings accessible to account members only.","type":"boolean","example":true},"archive":{"description":"[Archiving solution](https://support.zoom.us/hc/en-us/articles/360050431572-Archiving-Meeting-and-Webinar-data) settings. This setting can only be used if you have been granted archiving solution access by the Zoom Support team.","properties":{"enable":{"description":"Enable the archiving feature.","type":"boolean","example":true},"settings":{"properties":{"audio_file":{"description":"Include in-meeting and/or in-webinar audio in the archive.","type":"boolean","example":true},"cc_transcript_file":{"description":"Include closed caption or transcript in the archive.","type":"boolean","example":true},"chat_file":{"description":"Include in-meeting chat in the archive.","type":"boolean","example":true},"chat_with_sender_email":{"description":"Include user email in in-meeting chat file.","type":"boolean","example":true},"video_file":{"description":"Include in-meeting and/or in-webinar video in the archive.","type":"boolean","example":true},"chat_with_direct_message":{"description":"Include direct message in in-meeting chat file.","type":"boolean","example":true},"archive_retention":{"description":"The retention period for archiving content, in days.","type":"integer","example":1,"enum":[1,2,3,4,5,6,7,8,9,10,11,12,13,14,15,16,17,18,19,20,21,22,23,24,25,26,27,28,29,30]},"action_when_archive_failed":{"description":"Perform the action when meetings or webinars cannot be archived.<br>`1` - Participants can stay in the meeting and will receive a notification.<br>`2` - Nobody can join or stay in the meeting.","type":"integer","example":1,"enum":[1,2]},"notification_when_archiving_starts":{"description":"Show notification when video or audio archiving starts.<br>`1` - Participants can stay in the meeting and will receive a notification.<br>`2` - Nobody can join or stay in the meeting.","type":"string","example":"participants","enum":["participants","guest"]},"play_voice_prompt_when_archiving_starts":{"description":"Play voice prompt when video or audio archiving starts.<br>`1` - Participants can stay in the meeting and will receive a notification.<br>`2` - Nobody can join or stay in the meeting.","type":"string","example":"guest","enum":["participants","guest","none"]}},"type":"object"},"type":{"description":"Archive types:\n\n* `1`: Only meetings are archived.<br>\n* `2`: Only webinars are archived.<br>\n* `3`: Both meetings and webinars are archived.","enum":[1,2,3],"type":"integer","example":2}},"type":"object"},"auto_recording":{"description":"Record meetings automatically as they start.","type":"string","example":"local"},"cloud_recording":{"description":"Allow hosts to record and save the meeting / webinar in the cloud.","type":"boolean","example":true},"cloud_recording_download":{"description":"Allow anyone with a link to the cloud recording to download.","type":"boolean","example":true},"cloud_recording_download_host":{"description":"Allow only the host with a link to the cloud recording to download.","type":"boolean","example":true},"host_delete_cloud_recording":{"description":"Allow the host to delete the recordings. If this option is disabled, the recordings cannot be deleted by the host and only admin can delete them.","type":"boolean","example":true},"record_files_separately":{"type":"object","description":"The account's [**Record active speaker, gallery view and shared screen separately**](https://support.zoom.us/hc/en-us/articles/360060316092-Changing-basic-and-advanced-cloud-recording-settings#h_01F4CYJTCTXNS2MXH00W9EFG6R) settings.","properties":{"active_speaker":{"type":"boolean","description":"Whether recording only the active speaker is enabled.","example":true},"gallery_view":{"type":"boolean","description":"Whether recording only the gallery view is enabled.","example":true},"shared_screen":{"type":"boolean","description":"Whether recording only shared screen is enabled.","example":true}}},"display_participant_name":{"type":"boolean","description":"Whether participants' names display in the recording.","example":true},"recording_thumbnails":{"type":"boolean","description":"Whether thumbnails of the presenter are recorded when they are sharing their screen.","example":true},"optimize_recording_for_3rd_party_video_editor":{"description":"Whether recordings will be optimized for a 3rd party video editor. This can increase the file size and the time it takes to generate recording files.","type":"boolean","example":true},"recording_highlight":{"description":"Whether the [recording highlights](https://support.zoom.us/hc/en-us/articles/360060802432) feature is enabled.","type":"boolean","example":true},"save_panelist_chat":{"description":"Whether panelist chats are saved to the recording.","type":"boolean","example":true},"save_poll_results":{"description":"Whether poll results shared during the meeting or webinar are saved. This also includes poll results shared during the meeting or webinar.","type":"boolean","example":true},"save_close_caption":{"description":"Whether [closed captions](https://support.zoom.us/hc/en-us/articles/207279736) are saved as a VTT (Video Track Text) file.","type":"boolean","example":true},"ip_address_access_control":{"description":"Setting to allow cloud recording access only from specific IP address ranges.\n","properties":{"enable":{"description":"If set to `true`, the cloud recordings of this account can only be accessed by the IP addresses defined in the `ip_addresses_or_ranges` property.\n\n","type":"boolean","example":true},"ip_addresses_or_ranges":{"description":"IP addresses or ranges that have access to the cloud recordings. Separate multiple IP ranges with comma. Use n.n.n.n, n.n.n.n/n or n.n.n.n - n.n.n.n syntax where n is a number.\n\nExample: `46.33.24.184, 48.99.100.2/25` or `200.181.108.17 - 220.181.108.157`\n\n","type":"string","example":"200.181.108.17 - 220.181.108.157"}},"type":"object"},"local_recording":{"description":"Allow hosts and participants to record the meeting to a local file.","type":"boolean","example":true},"prevent_host_access_recording":{"description":"If set to `true`, meeting hosts cannot view their meeting cloud recordings. Only the admins who have recording management privilege can access them.\n\n","type":"boolean","example":true},"record_audio_file":{"description":"Whether to record one audio file for all participants.","type":"boolean","example":true},"record_gallery_view":{"description":"When someone is sharing their screen, active speaker will show on the top right corner of the shared screen.","type":"boolean","example":true},"record_speaker_view":{"description":"Record active speaker with shared screen.","type":"boolean","example":true},"recording_audio_transcript":{"description":"Automatically transcribe the audio of a meeting or webinar for cloud recordings.","type":"boolean","example":true},"smart_recording":{"description":"By selecting this option, your recording will have meeting smart chapters, and next steps. You are directing Zoom to access, process, and use your account's recording data for the purpose of analysis and insights.","properties":{"create_recording_highlights":{"description":"By selecting this option, meeting details in the audio transcript will be highlighted. Hosts can modify highlighted sections and generate a video summary (highlighted sections may have a 3-second offset) based on these sections. The summary is for informational purposes only and may not be complete.","type":"boolean","example":true},"create_smart_chapters":{"description":"By selecting this option, your recording will have chapters with overview. Hosts can edit the chapters.","type":"boolean","example":true},"create_next_steps":{"description":"By selecting this option, there will be a summary of actions to take after the recorded meeting.","type":"boolean","example":true}},"type":"object"},"save_chat_text":{"description":"Save chat messages from the meeting / webinar.","type":"boolean","example":true},"show_timestamp":{"description":"Add a timestamp to the recording.","type":"boolean","example":true}},"type":"object"},"schedule_meeting":{"properties":{"audio_type":{"description":"Determine how participants can join the audio portion of the meeting.","type":"string","example":"both"},"embed_password_in_join_link":{"description":"If the value is set to `true`, the meeting password will be encrypted and included in the join meeting link to allow participants to join with just one click without having to enter the password.\n ","type":"boolean","example":true},"force_pmi_jbh_password":{"deprecated":true,"description":"If join before host option is enabled for a personal meeting, then enforce password requirement.\n\n\n**This field will be deprecated in near future.** If you would like to enable this setting, we highly encourage you to use the `require_password_for_pmi_meetings` field.\n\n","type":"boolean","example":true},"host_video":{"description":"Start meetings with host video on.","type":"boolean","example":true},"join_before_host":{"description":"Allow participants to join the meeting before the host arrives","type":"boolean","example":true},"mute_upon_entry":{"description":"Automatically mute all participants when they join the meeting.","type":"boolean","example":true},"participant_video":{"description":"Start meetings with participant video on.","type":"boolean","example":true},"personal_meeting":{"description":"Personal Meeting Setting.<br><br>\n`true`: Indicates that the **\"Enable Personal Meeting ID\"** setting is turned on. Users can choose to use personal meeting ID for their meetings. <br><br>\n`false`: Indicates that the **\"Enable Personal Meeting ID\"** setting is [turned off](https://support.zoom.us/hc/en-us/articles/201362843-Personal-meeting-ID-PMI-and-personal-link#h_aa0335c8-3b06-41bc-bc1f-a8b84ef17f2a). If this setting is disabled, meetings that were scheduled with PMI will be invalid. Scheduled meetings will need to be manually updated.\nFor Zoom Phone only:If a user has been assigned a desk phone, **\"Elevate to Zoom Meeting\"** on desk phone will be disabled.\n\n\n","type":"boolean","example":true},"pstn_password_protected":{"description":"Generate and send new passwords for newly scheduled or edited meetings.","type":"boolean","example":true},"require_password_for_instant_meetings":{"description":"If enabled, a random password will be generated on the user's end who starts the instant meeting. Other participants will have to enter the password to join the meeting. If you use PMI for your instant meetings, this option will be disabled.","type":"boolean","example":true},"require_password_for_pmi_meetings":{"description":"Indicates whether a password is required for [PMI](https://support.zoom.us/hc/en-us/articles/203276937-Using-Personal-Meeting-ID-PMI-) meetings or not. The value can be one of the following:<br>\n`none`: Do not require password for PMI meetings.<br> \n`all`: Require participants to enter password for all PMI enabled meetings.<br> `jbh_only`: Require password only for meetings where the **\"join before host\"** setting is enabled.","enum":["all","jbh_only","none"],"type":"string","example":"jbh_only"},"require_password_for_scheduled_meetings":{"description":"Require a password for meetings which have already been scheduled\n","type":"boolean","example":true},"require_password_for_scheduling_new_meetings":{"description":"This setting applies for regular meetings that do not use PMI. If enabled, a password will be generated while a host schedules a new meeting and participants will be required to enter the password before they can join the meeting.","type":"boolean","example":true},"upcoming_meeting_reminder":{"description":"Receive desktop notification for upcoming meetings.","type":"boolean","example":true},"use_pmi_for_instant_meetings":{"description":"Indicates whether PMI is enabled for all instant meetings or not.","type":"boolean","example":true},"use_pmi_for_schedule_meetings":{"description":"Indicates whether PMI is enabled for all scheduled meetings or not.","type":"boolean","example":true},"always_display_zoom_meeting_as_topic":{"description":"Information about the [**Always display \"Zoom Meeting\" as the meeting topic**](https://support.zoom.us/hc/en-us/articles/201363253-Changing-account-settings#h_01EG9BJ646V2WJK1S3H2MP6YV6) setting.","type":"object","properties":{"enable":{"description":"Whether the **Always display \"Zoom Meeting\" as the meeting topic** setting is enabled.","type":"boolean","example":false},"display_topic_for_scheduled_meetings":{"description":"Whether to display \"Zoom Meeting\" as the topic for already-scheduled meetings.","type":"boolean","example":false}}},"always_display_zoom_webinar_as_topic":{"type":"object","description":"Information about the [**Always show \"Zoom Webinar\" as the webinar topic**](https://support.zoom.us/hc/en-us/articles/201363253-Changing-account-settings#h_01EG9BJ646V2WJK1S3H2MP6YV6) setting.","properties":{"enable":{"description":"Whether the **Always show \"Zoom Webinar\" as the webinar topic** setting is enabled.","type":"boolean","example":false},"display_topic_for_scheduled_webinars":{"description":"Whether to display \"Zoom Webinar\" as the topic for already-scheduled meetings.","type":"boolean","example":false}}}},"type":"object"},"telephony":{"properties":{"audio_conference_info":{"description":"","type":"string","example":"test"},"telephony_regions":{"description":"Indicates where most of the participants call into or call from during a meeting.","properties":{"selection_values":{"description":"The account's selected telephony regions that indicate where most participants call into or call from during a meeting.","type":"string","example":"CNTB"}},"type":"object"},"third_party_audio":{"description":"Allow users to join the meeting using the existing 3rd party audio configuration.","type":"boolean","example":true}},"type":"object"},"chat":{"type":"object","description":"The account's chat settings.","properties":{"share_files":{"type":"object","description":"Users can share files in chats and channels.","properties":{"enable":{"type":"boolean","description":"Allow users of this account to send and receive files in chats and channels. When disabled, users can still take and share screenshots.","example":true},"share_option":{"type":"string","description":"Allow users of this account to send and receive files in chats and channels. When disabled, users can still take and share screenshots.","enum":["anyone","account","organization"],"x-enum-descriptions":["Anyone (internal and external contacts)","In the same account","In the same organization"],"example":true}}},"chat_emojis":{"type":"object","description":"Chat emojis.","properties":{"enable":{"type":"boolean","description":"Allow users to use the emoji library in direct messages or group conversations. Choose between allowing users to use any emoji in the library, or choose to allow only pre-selected emojis. If the setting is disabled, users can still use keyboard shortcuts to add emojis. Users can change their emoji skin tone in Settings.","example":true},"emojis_option":{"type":"string","example":"all","enum":["all","selected"],"x-enum-descriptions":["All emojis","Selected emojis"]}}},"record_voice_messages":{"description":"Allow users to record voice messages that can be sent in direct messages or group conversations.","type":"boolean","example":true},"record_video_messages":{"description":"Allow users to record video messages that can be sent in direct messages or group conversations. If the file share setting is disabled, they will not be able to record and send video messages.","type":"boolean","example":true},"create_public_channels":{"type":"boolean","description":"Allow users to create public channels.","example":true},"create_private_channels":{"type":"boolean","description":"Allow users to create private channels.","example":true},"share_links_in_chat":{"type":"boolean","description":"Share links to messages and channels in Team Chat.","example":true},"schedule_meetings_in_chat":{"type":"boolean","description":"Schedule a meeting from chat or channel.","example":true},"set_retention_period_in_cloud":{"type":"object","description":"Set retention period for messages and files in Zoom's cloud.","properties":{"enable":{"type":"boolean","description":"By default, messages and files are stored in Zoom's cloud. Enable this setting to specify when they are deleted. When retention is disabled, messages sent by offline users can be received within 7 days before they are deleted.","example":true},"retention_period_of_direct_messages_and_group_conversation":{"type":"string","description":"Delete direct messages and group conversations after retention period. 'y' - year, 'm' - month, 'd' - day","example":"2m"},"retention_period_of_channels":{"type":"string","description":"Delete data in channels after retention period. 'y' - year, 'm' - month, 'd' - day","example":"2m"}}},"set_retention_period_in_local":{"type":"object","description":"Store messages on local devices, excluding personal channel messages.","properties":{"enable":{"type":"boolean","description":"Specify how long your messages are saved on local devices. If this setting is disabled, messages are never deleted locally.","example":true},"retention_period_of_direct_messages_and_group_conversation":{"type":"string","description":"Delete direct messages and group conversations after retention period. 'y' - year, 'm' - month, 'd' - day","example":"2m"},"retention_period_of_channels":{"type":"string","description":"Delete data in channels after retention period. 'y' - year, 'm' - month, 'd' - day","example":"2m"}}},"allow_users_to_search_others_options":{"description":"Allow users to search others, when selecting multiple items, separate them with commas. \n* ''-none. \n* '1' — In the same account. \n* '2' — Under the same master account, including all sub acounts. \n* '3' — Under the same organization.","type":"string","example":"1,3"},"allow_users_to_add_contacts":{"description":"Allow users to add contacts.","type":"object","properties":{"enable":{"description":"By disabling this setting, users will not be able to add contacts.","type":"boolean","example":true},"selected_option":{"description":"The type of allowing users to add contacts: \n* 1 — Anyone (internal and external contacts). \n* 2 — In the same organization. \n* 3 — In the same organization and specified domains. \n* 4 — In the same organization and specified users.","enum":[1,2,3,4],"type":"integer","example":4},"user_email_addresses":{"description":"The domains or emails (internal or external). \n* When the `selected_option` field value is `3`, the value is internal or external domains. Use a comma to separate multiple domains. Example: company.com. \n* When the `selected_option` field value is `4`, the value is internal or external email addresses. Use a comma to separate multiple emails.","type":"string","example":"123@test.com"}}},"allow_users_to_chat_with_others":{"description":"Allow users to chat with others.","type":"object","properties":{"enable":{"description":"If you select 'In the same organization', users may still be able to chat with external users if they are added to channels or group chats with external users.","type":"boolean","example":true},"selected_option":{"description":"The type of allowing users to add contacts: \n* 1 — Anyone (internal and external contacts). \n* 2 — In the same organization. \n* 3 — In the same organization and specified domains. \n* 4 — In the same organization and specified users.","enum":[1,2,3,4],"type":"integer","example":4},"user_email_addresses":{"description":"The domains or emails (internal or external). \n* When the `selected_option` field value is `3`, the value is internal or external domains. Use a comma to separate multiple domains. Example: company.com. \n* When the `selected_option` field value is `4`, the value is internal or external email addresses. Use a comma to separate multiple emails.","type":"string","example":"123@test.com"}}},"chat_etiquette_tool":{"description":"Information about the Chat Etiquette tool.","properties":{"enable":{"description":"Whether the **Chat Etiquette Tool** is enabled.","type":"boolean","example":true},"policies":{"description":"Information about the defined **Chat Etiquette Tool** policies.","items":{"properties":{"description":{"description":"The policy's description.","type":"string","example":"The policy's description"},"id":{"description":"The policy ID.","type":"string","example":"dvgerwe98z8v9vgbug43iubkjn"},"is_locked":{"description":"Whether the policy is locked by an account-level user. When it is locked, users cannot update the policy.","type":"boolean","example":true},"keywords":{"description":"A list of defined rule keywords.","items":{"type":"string","example":"key"},"type":"array"},"name":{"description":"The policy name.","type":"string","example":"The policy name"},"regular_expression":{"description":"The regular expression to match to the content of chat messages.","type":"string","example":"^test"},"status":{"description":"The policy's current status: \n* `activated` — Activated. \n* `deactivated` — Deactivated.","enum":["activated","deactivated"],"type":"string","x-enum-descriptions":["Activated.","Deactivated."],"example":"Activated"},"trigger_action":{"description":"The policy's trigger action. \n* `1` — Ask the user to confirm before they send the message. \n* `2` — Block the user's message.","enum":[1,2],"type":"integer","x-enum-descriptions":["Ask the user to confirm before they send the message.","Block the user's message."],"example":2}},"type":"object"},"type":"array"}},"type":"object"},"send_data_to_third_party_archiving_service":{"type":"object","description":"Send data to third-party archiving service.","properties":{"enable":{"type":"boolean","description":"Allow users to send data to third-party archiving service.","example":true}}}}}},"type":"object"},{"oneOf":[{"properties":{"allow_authentication_exception":{"description":"Whether the [**Allow authentication exception**](https://support.zoom.us/hc/en-us/articles/360037117472#h_01F13A9N1FQFNVESC9C21NRHXY) setting is enabled. This lets hosts invite users who can bypass authentication.","type":"boolean","example":true},"authentication_options":{"description":"Meeting Authentication Options","items":{"properties":{"default_option":{"description":"Authentication default option","type":"boolean","example":true},"domains":{"description":"Authentication domains","type":"string","example":"example.com"},"id":{"description":"Authentication id","type":"string","example":"ewf22f42fewf4232fgg4343lki4"},"name":{"description":"Authentication name","type":"string","example":"Authentication name"},"type":{"description":" Authentication type. Specify one of the following authentication types for the authentication profile:<br>\n * `enforce_login`: This option allows any users to join the meeting or webinar, as long as they are signed into their Zoom account.\n * `enforce_login_with_domains`: This option, allows you to specify a rule so that only those Zoom users whose email addresses contain a certain domain, can join the meeting or webinar. You can either add multiple domains using a comma in between and/or use a wildcard for listing domains.<br>\n * `enforce_login_with_same_account`: This option allows users to join the meeting or webinar with the same Zoom account.","enum":["enforce_login","enforce_login_with_same_account","enforce_login_with_domains"],"type":"string","example":"enforce_login_with_domains"},"visible":{"description":"Authentication visible","type":"boolean","example":true}},"type":"object"},"type":"array"},"meeting_authentication":{"description":"Only authenticated users can join meetings","type":"boolean","example":true}},"type":"object"},{"properties":{"authentication_options":{"description":"Authentication Options","items":{"properties":{"default_option":{"description":"Authentication default option","type":"boolean","example":true},"domains":{"description":"Authentication domains","type":"string","example":"example.com"},"id":{"description":"Authentication id","type":"string","example":"ewf22f42fewf4232fgg4343lki4"},"name":{"description":"Authentication name","type":"string","example":"Authentication name"},"type":{"description":"Authentication type","enum":["internally","enforce_login","enforce_login_with_domains"],"type":"string","example":"enforce_login_with_domains"},"visible":{"description":"Authentication visible","type":"boolean","example":true}},"type":"object"},"type":"array"},"recording_authentication":{"description":"Only authenticated users can view cloud recordings","type":"boolean","example":true}},"type":"object"}],"type":"object"},{"description":"The group's meeting and webinar security settings.","properties":{"meeting_security":{"properties":{"auto_security":{"description":"Whether all meetings are required to be secured with at least one security option. \n\n This setting can only be disabled by Enterprise, ISV, Business (with more than 100 licenses), and Education accounts.","type":"boolean","example":true},"block_user_domain":{"description":"Whether users in specific domains are blocked from joining meetings and webinars.","type":"boolean","example":true},"block_user_domain_list":{"description":"A list of blocked domains.","items":{"maxLength":30,"minLength":5,"type":"string","example":"example.com"},"maxItems":20,"type":"array"},"chat_etiquette_tool":{"description":"Information about the Chat Etiquette Tool.","properties":{"enable":{"description":"Whether the **Chat Etiquette Tool** is enabled.","type":"boolean","example":true},"policies":{"description":"Information about the defined **Chat Etiquette Tool** policies.","items":{"properties":{"description":{"description":"The policy's description.","type":"string","example":"The policy's description"},"id":{"description":"The policy ID.","type":"string","example":"dvgerwe98z8v9vgbug43iubkjn"},"is_locked":{"description":"Whether the policy is locked by an account-level user. When it is locked, users cannot update the policy.","type":"boolean","example":true},"keywords":{"description":"A list of defined rule keywords.","items":{"type":"string","example":"key"},"type":"array"},"name":{"description":"The policy name.","type":"string","example":"The policy name"},"regular_expression":{"description":"The regular expression to match to the content of chat messages.","type":"string","example":"^test"},"status":{"description":"The policy's current status: \n* `activated` — Activated. \n* `deactivated` — Deactivated.","enum":["activated","deactivated"],"type":"string","x-enum-descriptions":["Activated.","Deactivated."],"example":"Activated"},"trigger_action":{"description":"The policy's trigger action: \n* `1` — Ask the user to confirm before they send the message. \n* `2` — Block the user's message.","enum":[1,2],"type":"integer","x-enum-descriptions":["Ask the user to confirm before they send the message.","Block the user's message."],"example":2}},"type":"object"},"type":"array"}},"type":"object"},"embed_password_in_join_link":{"description":"Whether the meeting password will be encrypted and included in the invitation link. The provided link will allow participants to join the meeting without having to enter the password.","type":"boolean","example":true},"encryption_type":{"description":"The type of encryption used to start a meeting: \n* `enhanced_encryption` — Enhanced encryption. Encryption data is stored in the cloud. \n* `e2ee` — End-to-end encryption. The encryption key is stored on the local device and cannot be obtained by anyone else. E2EE also [**disables** certain features](https://support.zoom.us/hc/en-us/articles/360048660871), such as cloud recording, live streaming, and allowing participants to join before the host.","enum":["enhanced_encryption","e2ee"],"type":"string","example":"enhanced_encryption"},"end_to_end_encrypted_meetings":{"description":"Whether end-to-end encryption is enabled for meetings.","type":"boolean","example":true},"meeting_password":{"description":"Whether all instant and scheduled meetings that users can join via client or Zoom Rooms systems are password-protected. [Personal Meeting ID (PMI)](https://support.zoom.us/hc/en-us/articles/203276937) meetings are **not** included in this setting.","type":"boolean","example":true},"meeting_password_requirement":{"description":"Information about the meeting and webinar [password requirements](https://support.zoom.us/hc/en-us/articles/360033559832-Meeting-and-webinar-passwords#h_a427384b-e383-4f80-864d-794bf0a37604).","properties":{"consecutive_characters_length":{"description":"The maximum length of consecutive characters (for example, `abcdef`) allowed in a password: \n* `4` through `8` — The maximum consecutive characters length. The length is `n` minus `1`, where `n` is the provided value. For example, if you provide the `4` value, there can only be a maximum of `3` consecutive characters in a password (for example, `abc1x@8fdh`). \n* `0` — Do not apply a consecutive character restriction.","enum":[0,4,5,6,7,8],"type":"integer","example":8},"have_letter":{"description":"Whether the password must contain at least one letter character.","type":"boolean","example":true},"have_number":{"description":"Whether the password must contain at least one numeric character.","type":"boolean","example":true},"have_special_character":{"description":"Whether the password must contain at least one special character. For example, `!`, `@`, and/or `#` characters.","type":"boolean","example":true},"have_upper_and_lower_characters":{"description":"Whether the password must include uppercase and lowercase characters.","type":"boolean","example":true},"length":{"description":"The password's minimum length.","type":"integer","example":10},"only_allow_numeric":{"description":"Whether the password must contain **only** numeric characters.","type":"boolean","example":true},"weak_enhance_detection":{"description":"Whether users will be informed when the provided password is weak.","type":"boolean","example":true}},"type":"object"},"only_authenticated_can_join_from_webclient":{"description":"Whether to specify that only authenticated users can join the meeting from the web client.","type":"boolean","example":true},"phone_password":{"description":"Whether a password is required for participants joining by phone. \n\n If enabled and the meeting is password-protected, a numeric password is required for participants to join by phone. For meetings with alphanumeric passwords, a numeric password will be generated.","type":"boolean","example":true},"pmi_password":{"description":"Whether all Personal Meeting ID (PMI) meetings that users can join via client or Zoom Rooms systems are password-protected.","type":"boolean","example":true},"require_password_for_scheduled_meeting":{"description":"Whether a password is required for meetings that have already been scheduled.","type":"boolean","example":true},"require_password_for_scheduled_webinar":{"description":"Whether a password is required for webinars that have already been scheduled.","type":"boolean","example":true},"waiting_room":{"description":"Whether participants are placed in the [**Waiting Room**](https://support.zoom.us/hc/en-us/articles/115000332726-Waiting-Room) when they join a meeting. \n\n When the **Waiting Room** feature is enabled, the [**Allow participants to join before host**](https://support.zoom.us/hc/en-us/articles/202828525-Allow-participants-to-join-before-host) setting is disabled.","type":"boolean","example":true},"waiting_room_settings":{"description":"Information about the Waiting Room settings.","properties":{"participants_to_place_in_waiting_room":{"description":"The type of participants to be admitted to the Waiting Room: \n* `0` — All attendees. \n* `1` — Users who are not in your account. \n* `2` — Users who are not in your account and are not part of your [allowed domains list](https://support.zoom.us/hc/en-us/articles/360037117472-Configuring-authentication-profiles#h_e3cf0d5f-eec7-4c2a-ad29-ef2a5079a7da).","enum":[0,1,2],"type":"integer","example":0},"users_who_can_admit_participants_from_waiting_room":{"description":"The users who can admit participants from the Waiting Room: \n* `0` — Host and co-hosts only. \n* `1` — Host, co-hosts, and anyone who bypassed the Waiting Room if the host and co-hosts are not present.","enum":[0,1],"type":"integer","example":1},"whitelisted_domains_for_waiting_room":{"description":"If the `participants_to_place_in_waiting_room` field is `2`, a comma-separated list of the domains that can bypass the Waiting Room (`\"example.com,example2.com\"`).","type":"string","example":"example.com"}},"type":"object"},"webinar_password":{"description":"Whether a password is generated when scheduling webinars. Participants must use the generated password to join the scheduled webinar.","type":"boolean","example":true}},"type":"object"}},"title":"Meeting/Webinar Security Group Settings","type":"object"}]}}},"description":"**Error Code**: `200` <br>\nOnly available for paid account.\n\n**HTTP Status Code**: `200` <br>\nGroup Settings Returned.\n"},"404":{"description":"**HTTP Status Code:** `404` <br>\n**Error Code:** `4130` <br>\nGroup does not exist: {groupId}."}},"security":[{"OAuth":[]}]},"patch":{"parameters":[{"description":"Id of the group.","in":"path","name":"groupId","required":true,"schema":{"type":"string","example":"0mgThLiRQH2bUHvIaL4t2g"}},{"allowEmptyValue":true,"description":"Optional query parameters: \n* `meeting_authentication` — [Meeting authentication settings](https://support.zoom.us/hc/en-us/articles/360037117472-Authentication-Profiles-for-Meetings-and-Webinars). \n* `recording_authentication` — [Recording authentication settings](https://support.zoom.us/hc/en-us/articles/360037756671-Authentication-Profiles-for-Cloud-Recordings). \n* `meeting_security` — Meeting security settings.","in":"query","name":"option","schema":{"enum":["meeting_authentication","recording_authentication","meeting_security"],"type":"string","example":"meeting_security"}}],"responses":{"200":{"description":"**Error code:** `200`<br>\nOnly available for Paid account, {accountId}"},"204":{"description":"**HTTP Status Code:** `204`<br>\nSettings updated successfully."},"404":{"description":"**HTTP Status Code:** `404`<br>\n**Error Code:** `4130`<br>\nGroup does not exist: {groupId}."}},"tags":["Groups"],"description":"Update settings for a [group](https://support.zoom.us/hc/en-us/articles/204519819-Group-Management-).<p style=\"background-color:#FEEFB3; color:#9F6000\"><br>Note:</b> The `force_pmi_jbh_password` field under meeting settings is planned to be deprecated on September 22, 2019. This field will be replaced by another field that will provide the same functionality.</p>\n**Prerequisite**: Pro, Business, or Education account<br> \n**Scopes**: `group:write:admin`<br>\n\n **[Rate Limit Label](https://developers.zoom.us/docs/api/rest/rate-limits/):** `Medium`","operationId":"updateGroupSettings","requestBody":{"content":{"application/json":{"schema":{"oneOf":[{"properties":{"audio_conferencing":{"description":"The group's audio conference settings.","properties":{"toll_free_and_fee_based_toll_call":{"description":"The group's [**Toll-free and Fee-based Toll Call**](https://support.zoom.us/hc/en-us/articles/360060950711-Enabling-Toll-free-and-Fee-based-Toll-Call#h_01F51844DRCX3K7BRTMZ40381R) settings.","properties":{"allow_webinar_attendees_dial":{"description":"Whether webinar attendees can dial in through the account's **Toll-free and Fee-based Toll Call** phone numbers. This feature is only available in version 5.2.2 and higher.","type":"boolean","example":true},"enable":{"description":"Whether the group has the [**Toll-free and Fee-based Toll Call**](https://support.zoom.us/hc/en-us/articles/360060950711-Enabling-Toll-free-and-Fee-based-Toll-Call#h_01F51844DRCX3K7BRTMZ40381R) setting enabled.","type":"boolean","example":true},"numbers":{"description":"The group's **Toll-free and Fee-based Toll Call** phone number information.","items":{"properties":{"code":{"description":"The phone number's [E.164 country calling code](https://en.wikipedia.org/wiki/List_of_country_calling_codes).","type":"string","example":"86"},"country_code":{"description":"The phone number's [country code](https://marketplace.zoom.us/docs/api-reference/other-references/abbreviation-lists#countries).","type":"string","example":"CN"},"country_name":{"description":"The country name.","type":"string","example":"China"},"display_number":{"description":"The phone number's display number.","maxLength":30,"type":"string","example":"+86 7777 777"},"number":{"description":"The phone number.","maxLength":30,"type":"string","example":"7777 777"}},"type":"object"},"maxItems":100,"type":"array"}},"type":"object"}},"type":"object"},"email_notification":{"properties":{"alternative_host_reminder":{"description":"Notify the alternative host who is set or removed.","type":"boolean","example":true},"cancel_meeting_reminder":{"description":"Notify host and participants when the meeting is cancelled.","type":"boolean","example":true},"cloud_recording_available_reminder":{"description":"Whether to notify the host when a cloud recording is available.","type":"boolean","example":true},"jbh_reminder":{"description":"Notify host when participants join the meeting before them.","type":"boolean","example":true},"recording_available_reminder_alternative_hosts":{"description":"Whether to notify any alternative hosts when a cloud recording is available.","type":"boolean","example":true},"recording_available_reminder_schedulers":{"description":"Whether to notify the person who scheduled the meeting or webinar for the host when a cloud recording is available.","type":"boolean","example":true},"schedule_for_reminder":{"description":"Notify the host there is a meeting is scheduled, rescheduled, or cancelled.","type":"boolean","example":true}},"type":"object"},"in_meeting":{"properties":{"alert_guest_join":{"description":"Allow participants who belong to your account to see that a guest (someone who does not belong to your account) is participating in the meeting/webinar.","type":"boolean","example":true},"allow_users_to_delete_messages_in_meeting_chat":{"description":"If the value of this field is set to `true`,  allow users to delete messages in the in-meeting chat.\n","type":"boolean","example":true},"allow_live_streaming":{"description":"Whether livestreaming is enabled.","type":"boolean","example":true},"allow_participants_chat_with":{"description":"Whether to allow participants to only chat with certain groups:\n* `1` — The participant cannot use chat.\n* `2` — Host and co-hosts only.\n * `3` — The participant can chat with other participants publicly.\n* `4` - The participant can chat with other participants publicly and privately.\n\n**Note:** This setting is only available with client versions 5.7.3 and above.","enum":[1,2,3,4],"type":"integer","x-enum-descriptions":["No one","Host and co-hosts","Everyone","Everyone and anyone directly"],"example":1},"allow_show_zoom_windows":{"description":"Show Zoom windows during screen share.","type":"boolean","example":true},"allow_users_save_chats":{"description":"Whether to allow participants to save meeting chats:\n* `1` — Participants cannot save meeting chats.\n* `2` — Participants can only save host and co-host meeting chats.\n* `3` — Participants can save all meeting chats.","enum":[1,2,3],"type":"integer","x-enum-descriptions":["Not allow","Host and co-hosts","Everyone"],"example":3},"annotation":{"description":"Allow participants to use annotation tools to add information to shared screens.","type":"boolean","example":true},"attendee_on_hold":{"default":false,"description":"Allow host to put attendee on hold.\n\n**This field has been deprecated and is no longer supported.**","type":"boolean","example":true},"auto_answer":{"description":"Enable users to see and add contacts to 'auto-answer group' in the contact list on chat. Any call from members of this group will be automatically answered.","type":"boolean","example":true},"auto_saving_chat":{"description":"Automatically save all in-meeting chats.","type":"boolean","example":true},"breakout_room":{"description":"Allow host to split meeting participants into separate, smaller rooms.","type":"boolean","example":true},"breakout_room_schedule":{"description":"Whether the host can assign participants to breakout rooms when scheduling. This feature is **only** available in version 4.5.0 or higher.","type":"boolean","example":true},"chat":{"description":"Allow meeting participants to send chat message visible to all participants.","type":"boolean","example":true},"meeting_question_answer":{"description":"Allow participants to ask questions for the host and participants to answer.","type":"boolean","example":true},"closed_caption":{"description":"Allow host to type closed captions or assign a participant/third party device to add closed captions.","type":"boolean","example":true},"closed_captioning":{"description":"Information about the group's closed captioning settings.","properties":{"auto_transcribing":{"description":"Whether to allow a live transcription service to transcribe meetings.","type":"boolean","example":true},"enable":{"description":"Whether to allow the host to type closed captions or assign a participant or 3rd-party service to provide closed captioning.","type":"boolean","example":true},"save_caption":{"description":"Whether to allow participants to save closed captions or transcripts.","type":"boolean","example":true},"third_party_captioning_service":{"description":"Whether to allow the use of an API token to integrate with 3rd-party closed captioning services.","type":"boolean","example":true},"view_full_transcript":{"description":"Whether to allow the viewing of full transcripts in the in-meeting side panel.","type":"boolean","example":true}},"type":"object"},"co_host":{"description":"Allow the host to add co-hosts. Co-hosts have the same in-meeting controls as the host.","type":"boolean","example":true},"custom_data_center_regions":{"description":"If set to `true`, you can [select data center regions](https://support.zoom.us/hc/en-us/articles/360042411451-Selecting-data-center-regions-for-hosted-meetings-and-webinars) to be used by this group for hosting their real-time meeting and webinar traffic. These regions can be provided in the `data_center_regions` field. If set to `false`, the regions cannot be customized and the default regions will be used.","type":"boolean","example":true},"custom_live_streaming_service":{"description":"Whether custom livestreaming is enabled.","type":"boolean","example":true},"custom_service_instructions":{"description":"The specific instructions to allow your account's meeting hosts to configure a custom livestream.","type":"string","example":"The specific instructions"},"data_center_regions":{"type":"array","description":"If the value of `custom_data_center_regions` is `true`, a comma-separated list of the following [data center regions](https://support.zoom.us/hc/en-us/articles/360059254691-Datacenter-abbreviation-list) to opt in to: \n* `AU` — Australia.\n* `LA` — Latin America. \n* `CA` — Canada. \n* `CN` — China. \n* `DE` — Germany. \n* `HK` — Hong Kong SAR. \n* `IN` — India. \n* `IE` — Ireland. \n* `TY` — Japan. \n* `MX` — Mexico. \n* `NL` — Netherlands. \n* `SG` — Singapore. \n* `US` — United States.","items":{"type":"string","enum":["AU","LA","CA","CN","DE","HK","IN","IE","TY","MX","NL","SG","US"],"example":"US"}},"disable_screen_sharing_for_host_meetings":{"description":"Whether to enable the **Disable desktop screen sharing for meetings you host** setting.","type":"boolean","example":true},"disable_screen_sharing_for_in_meeting_guests":{"description":"Whether to enable the **Disable screen sharing when guests are in the meeting** setting.","type":"boolean","example":true},"e2e_encryption":{"description":"Require that all meetings are encrypted using AES.","type":"boolean","example":true},"entry_exit_chime":{"description":"Play sound when participants join or leave.","enum":["host","all","none"],"type":"string","example":"host"},"far_end_camera_control":{"description":"Allow another user to take control of the camera during a meeting.","type":"boolean","example":true},"feedback":{"description":"Enable users to provide feedback to Zoom at the end of the meeting.","type":"boolean","example":true},"file_transfer":{"description":"Indicates whether [in-meeting file transfer](https://support.zoom.us/hc/en-us/articles/209605493-In-meeting-file-transfer) setting has been enabled for the users in the group or not.","type":"boolean","example":true},"group_hd":{"description":"Enable higher quality video for host and participants. This will require more bandwidth.","type":"boolean","example":true},"join_from_desktop":{"description":"Whether to allow participants to join a meeting directly from their desktop browser. Note that the meeting experience from the desktop browser is limited.","type":"boolean","example":true},"join_from_mobile":{"description":"Whether to allow participants to join a meeting directly from their mobile browser. Note that the meeting experience from the mobile browser is limited.","type":"boolean","example":true},"auto_generated_translation":{"description":"Information about the [Translate captions](https://support.zoom.us/hc/en-us/articles/8158738379917-Managing-automated-captions-) settings in meetings.","properties":{"language_item_pairList":{"description":"Information about all  speak languages and  translation languages in meetings.","type":"object","properties":{"trans_lang_config":{"type":"array","description":"A list of speak languages and  translation languages.","items":{"type":"object","description":"A item of speak language and  translation languages in meetings.","properties":{"speak_language":{"type":"object","description":"language used in meetings","properties":{"name":{"type":"string","enum":["Chinese (Simplified)","Dutch","English","French","German","Italian","Japanese","Korean","Portuguese","Russian","Spanish","Ukrainian"],"example":"Chinese (Simplified)","description":"the name of language"},"code":{"type":"string","enum":["zh","nl","en","fr","de","it","ja","ko","pt","ru","es","uk"],"example":"zh","description":"th code for the language"}}},"translate_to":{"type":"object","description":"Information about all the translation languages.","properties":{"all":{"type":"boolean","example":true,"description":"Whether to select all the translation languages"},"language_config":{"type":"array","description":"A list of the translation languages.","items":{"type":"object","description":"A item of translation languages.","properties":{"name":{"type":"string","example":"English","enum":["English"],"description":"the name of translation language"},"code":{"type":"string","enum":["en"],"example":"en","description":"the code of translation language"}}}}}}}}},"all":{"description":"Whether to select all speak languages and translation languages","type":"boolean","example":true}}},"enable":{"description":"Whether to allow users to enable automated translated captions in these language pairs in meetings.","type":"boolean","example":true}},"type":"object"},"language_interpretation":{"description":"Information about the [language interpretation](https://support.zoom.us/hc/en-us/articles/360034919791-Using-Language-Interpretation-in-your-meeting-or-webinar) settings.","properties":{"custom_languages":{"description":"A list of user-defined supported languages.","items":{"type":"string","example":"English"},"type":"array"},"enable_language_interpretation_by_default":{"description":"Whether enable language interpretation by default.","type":"boolean","example":true},"allow_participants_to_speak_in_listening_channel":{"description":"Whether to allow participants to speak in listening channel.","type":"boolean","example":true},"allow_up_to_25_custom_languages_when_scheduling_meetings":{"description":"Whether to allow up to 25 custom languages when scheduling meetings.","type":"boolean","example":true},"enable":{"description":"Whether to allow hosts to assign participants as interpreters who can interpret one language into another in real-time.","type":"boolean","example":true}},"type":"object"},"live_streaming_facebook":{"description":"Whether Facebook livestreaming is enabled.","type":"boolean","example":true},"live_streaming_youtube":{"description":"Whether YouTube livestreaming is enabled.","type":"boolean","example":true},"manual_captioning":{"properties":{"allow_to_type":{"description":"Allow host to type or assign a participant to type.","type":"boolean","example":true},"auto_generated_captions":{"description":"Whether to allow a live transcription service to transcribe meetings.","type":"boolean","example":true},"full_transcript":{"description":"Whether to allow the viewing of full transcripts in the in-meeting side panel.","type":"boolean","example":true},"manual_captions":{"description":"Allow host to type closed captions or assign a participant/third party device to add closed captions.","type":"boolean","example":true},"save_captions":{"description":"Whether participants can save closed captions or transcripts.","type":"boolean","example":true},"third_party_captioning_service":{"description":"Whether to allow the use of an API token to integrate with 3rd-party closed captioning services.","type":"boolean","example":true}},"type":"object"},"meeting_reactions":{"description":"Whether meeting participants can [communicate using the emoji reactions](https://support.zoom.us/hc/en-us/articles/115001286183-Nonverbal-feedback-and-meeting-reactions) located in the **Reactions** menu in the meeting toolbar.","type":"boolean","example":true},"meeting_reactions_emojis":{"description":"Choose from the following meeting reaction options:\n* `all` — All emojis: Allow meeting participants to use any emoji available in Zoom chat as a reaction in a meeting.\n* `selected` — Selected emojis: Allow meeting participants to use the 6 standard meeting reaction emojis: Clapping Hands, Thumbs Up, Heart, Tears of Joy, Open Mouth, Party Popper (Tada, Celebration) ","type":"string","enum":["all","selected"],"x-enum-descriptions":["Allow meeting participants to use any emoji available in Zoom chat as a reaction in a meeting.","Allow meeting participants to use the 6 standard meeting reaction emojis: Clapping Hands, Thumbs Up, Heart, Tears of Joy, Open Mouth, Party Popper (Tada, Celebration) ."],"example":"all"},"allow_host_panelists_to_use_audible_clap":{"description":"Whether to allow host and panelist to use audible clap.","type":"boolean","example":true},"webinar_reactions":{"description":"Set this field to true to use [webinar reactions](https://support.zoom.us/hc/en-us/articles/4803536268429).","type":"boolean","example":true},"meeting_survey":{"description":"Whether to allow the host to present a survey to participants once a meeting has ended. This feature is only available in version 5.7.3 or higher.","type":"boolean","example":true},"non_verbal_feedback":{"description":"Allow participants in a meeting can provide nonverbal feedback and express opinions by clicking on icons in the Participants panel.","type":"boolean","example":true},"only_host_view_device_list":{"description":"Show the list of H.323/SIP devices only to the host.","type":"boolean","example":true},"original_audio":{"description":"Allow users to select original sound during a meeting.","type":"boolean","example":true},"polling":{"description":"Add 'Polls' to the meeting controls. This allows the host to survey the attendees.","type":"boolean","example":true},"post_meeting_feedback":{"description":"Display end-of-meeting experience feedback survey.","type":"boolean","example":true},"private_chat":{"description":"Allow meeting participants to send a private 1:1 message to another participant.","type":"boolean","example":true},"record_play_own_voice":{"description":"When each participant joins by telephone, allow the option to record and play their own voice as entry and exit chimes.","type":"boolean","example":true},"remote_control":{"description":"During screen sharing, allow the person who is sharing to let others control the shared content.","type":"boolean","example":true},"remote_support":{"description":"Allow meeting host to provide 1:1 remote support to another participant.","type":"boolean","example":true},"request_permission_to_unmute":{"description":"Indicate whether the [**Request permission to unmute participants**](https://support.zoom.us/hc/en-us/articles/203435537-Muting-and-unmuting-participants-in-a-meeting#h_01EGK4XFWS1SJGZ71MYGKF7260) option should be enabled for the group or not.","type":"boolean","example":true},"screen_sharing":{"description":"Allow host and participants to share their screen or content during meetings.","type":"boolean","example":true},"sending_default_email_invites":{"description":"Allow users to invite participants by email only by default.","type":"boolean","example":true},"show_a_join_from_your_browser_link":{"description":"Whether to allow participants to join a meeting directly from their browser and bypass the Zoom application download process. This is useful for participants who cannot download, install, or run applications. Note that the meeting experience from the browser is limited.","type":"boolean","example":true},"show_browser_join_link":{"description":"Allow participants to join a meeting directly from their browser.","type":"boolean","example":true},"show_device_list":{"description":"Show the list of H.323/SIP devices.","type":"boolean","example":true},"show_meeting_control_toolbar":{"description":"Always show meeting controls during a meeting.","type":"boolean","example":true},"slide_control":{"description":"Whether the person sharing during a presentation can allow others to control the slide presentation. This feature is only available in version 5.8.3 or higher.","type":"boolean","example":true},"stereo_audio":{"description":"Allow users to select stereo audio during a meeting.","type":"boolean","example":true},"use_html_format_email":{"description":"Allow  HTML formatting instead of plain text for meeting invitations scheduled with the Outlook plugin.","type":"boolean","example":true},"virtual_background":{"description":"Enable virtual background.","type":"boolean","example":true},"waiting_room":{"description":"Attendees cannot join a meeting until a host admits them individually from the waiting room.","type":"boolean","example":true},"webinar_chat":{"properties":{"allow_attendees_chat_with":{"description":"Allow webinar attendees to chat with:\n* `1` — No one.\n* `2` — Host and all panelists.\n* `3` — Everyone.","enum":[1,2,3],"type":"integer","example":3},"allow_auto_save_local_chat_file":{"description":"Whether to automatically save chat messages to a local file on the host's computer when the webinar ends.","type":"boolean","example":true},"allow_panelists_chat_with":{"description":"Allow webinar panelists to chat with:\n* `1` — Host and all panelists.\n* `2` — Everyone.","enum":[1,2],"type":"integer","example":2},"allow_panelists_send_direct_message":{"description":"Whether to allow webinar panelists to send direct messages to other panelists.","type":"boolean","example":true},"allow_users_save_chats":{"description":"Whether webinar attendees can save chats:\n* `0` — Attendees cannot save chats.\n* `1` — Attendees can only save host and panelist chats.\n* `2` — Attendees can save all chats.","enum":[0,1,2],"type":"integer","example":0},"default_attendees_chat_with":{"description":"By default, allow webinar attendees to chat with:\n* `1` — Host and all panelists.\n* `2` — Everyone.","enum":[1,2],"type":"integer","example":1},"enable":{"description":"Whether to allow webinar participants to send chat messages.","type":"boolean","example":true}},"type":"object"},"webinar_live_streaming":{"properties":{"custom_service_instructions":{"description":"The specific instructions to allow your account's meeting hosts to configure a custom livestream.","type":"string","example":"The specific instructions"},"enable":{"description":"Whether webinar livestreaming is enabled.","type":"boolean","example":true},"live_streaming_reminder":{"description":"Whether to notify users to watch the livestream. This does not apply to custom RTMP (real-time messaging protocol).","type":"boolean","example":true},"live_streaming_service":{"description":"The available livestreaming services:\n* `facebook`\n* `workplace_by_facebook`\n* `youtube`\n* `custom_live_streaming_service`","items":{"enum":["facebook","workplace_by_facebook","youtube","custom_live_streaming_service"],"type":"string","x-enum-descriptions":["Facebook","Workplace by Facebook","YouTube","Custom Live Streaming Service"],"example":"Facebook"},"type":"array"}},"type":"object"},"meeting_polling":{"type":"object","description":"Information about the account's meeting polling settings.","properties":{"enable":{"type":"boolean","description":"Whether to allow the host to add polls before or during a meeting.","example":true},"advanced_polls":{"type":"boolean","description":"Whether to allow host to create advanced polls and quizzes. Advanced polls and quizzes include single choice, multiple choice, drop down, matching, short answer, long answer, rank order, and fill-in-the-blank questions. Hosts can also set the correct answers for quizzes they create.","example":true},"manage_saved_polls_and_quizzes":{"description":"Whether to allow users to manage saved polls and quizzes from Meetings","type":"boolean","example":true},"require_answers_to_be_anonymous":{"description":"Whether to require answers to be anonymous.","type":"boolean","example":true},"allow_host_to_upload_image":{"description":"Whether to allow host to upload an image for each question.","type":"boolean","example":true},"allow_alternative_host_to_add_edit":{"type":"boolean","description":"Whether to allow alternative hosts to add or edit polls and quizzes.","example":true}}},"webinar_polling":{"properties":{"advanced_polls":{"description":"Whether to allow host to create advanced polls and quizzes. Advanced polls and quizzes include single choice, multiple choice, drop down, matching, short answer, long answer, rank order, and fill-in-the-blank questions. Hosts can also set the correct answers for quizzes they create.","type":"boolean","example":true},"allow_alternative_host_to_add_edit":{"description":"Whether to allow alternative hosts to add or edit polls and quizzes.","type":"boolean","example":true},"manage_saved_polls_and_quizzes":{"description":"Whether to allow users to manage saved polls and quizzes from Webinars","type":"boolean","example":true},"require_answers_to_be_anonymous":{"description":"Whether to require answers to be anonymous.","type":"boolean","example":true},"allow_host_to_upload_image":{"description":"Whether to allow host to upload an image for each question.","type":"boolean","example":true},"enable":{"description":"Whether to allow the host to add polls before or during a webinar.","type":"boolean","example":true}},"type":"object"},"webinar_question_answer":{"description":"Whether attendees can ask the host and panelists questions in the webinar.","type":"boolean","example":true},"webinar_survey":{"description":"Whether to allow the host to present surveys to attendees once a webinar has ended.","type":"boolean","example":true},"whiteboard":{"description":"Allow participants to share a whiteboard that includes annotation tools.","type":"boolean","example":true},"who_can_share_screen":{"description":"Indicates who can share their screen or content during meetings. The value can be one of the following: <br>\n`host`: Only host can share the screen.<br>\n`all`: Both hosts and attendees can share their screen during meetings. For Webinar, the hosts and panelists can start screen sharing, but not the attendees.\n","enum":["host","all"],"type":"string","example":"host"},"who_can_share_screen_when_someone_is_sharing":{"description":"Indicates who is allowed to start sharing screen when someone else in the meeting is sharing their screen. The value can be one of the following:<br>\n`host`: Only a host can share the screen when someone else is sharing.<br>\n`all`: Anyone in the meeting is allowed to start sharing their screen when someone else is sharing. For Webinar, the hosts and panelists can start screen sharing, but not the attendees.\n","enum":["host","all"],"type":"string","example":"all"},"participants_share_simultaneously":{"description":"Indicates how many participants can share at the same time. The value can be one of the following:<br>\n`one`: Only one participant can share at a time\n.<br>\n`multiple`: Multiple participants can share simultaneously (dual monitors recommended)\n. For Webinar, the hosts and panelists can start screen sharing, but not the attendees.\n","enum":["multiple","one"],"type":"string","example":"multiple"},"workplace_by_facebook":{"description":"Whether Workplace by Facebook is enabled.","type":"boolean","example":true}},"type":"object"},"other_options":{"properties":{"allow_users_contact_support_via_chat":{"description":"Whether to display the Zoom help badge on the bottom-right of the page.","type":"boolean","example":true},"blur_snapshot":{"description":"Whether iOS blurs the screenshot in the task switcher when multiple apps are open. Android hides the screenshot in the system-level list of recent apps.","type":"boolean","example":true},"webinar_registration_options":{"type":"object","description":"Webinar registration options.","properties":{"allow_host_to_enable_join_info":{"type":"boolean","description":"Allow host to enable \"Show join info on registration confirmation page\".","example":true},"allow_host_to_enable_social_share_buttons":{"type":"boolean","description":"Allow host to enable \"Show social share buttons on registration page\".","example":true},"enable_custom_questions":{"type":"boolean","description":"Enable custom questions.","example":true}}}},"type":"object"},"profile":{"properties":{"recording_storage_location":{"properties":{"allowed_values":{"description":"Users can choose the country to store their recorded content. Content can include meeting, webinar, and phone recordings, as well as voicemail, transcripts, and custom greeting prompts. See [Managing the Communications Content storage location](https://support.zoom.us/hc/en-us/articles/360050781131) for details.\n\nProvide abbreviated country codes as the value for this field. See the [Countries abbreviation list](https://marketplace.zoom.us/docs/api-reference/other-references/abbreviation-lists#countries) for details.","items":{"type":"string","example":"US"},"type":"array"},"value":{"description":"Abbreviated country code.","type":"string","example":"US"}},"type":"object"}},"title":"Profile","type":"object"},"recording":{"properties":{"account_user_access_recording":{"description":"Make cloud recordings accessible to account members only.","type":"boolean","example":true},"archive":{"description":"[Archiving solution](https://support.zoom.us/hc/en-us/articles/360050431572-Archiving-Meeting-and-Webinar-data) settings. This setting can only be used if you have been granted archiving solution access by the Zoom Support team.","properties":{"enable":{"description":"Enable the archiving feature.","type":"boolean","example":true},"settings":{"properties":{"audio_file":{"description":"Include in-meeting and/or in-webinar audio in the archive.","type":"boolean","example":true},"cc_transcript_file":{"description":"Include closed caption or transcript in the archive.","type":"boolean","example":true},"chat_file":{"description":"Include in-meeting chat in the archive.","type":"boolean","example":true},"chat_with_sender_email":{"description":"Include user email in in-meeting chat file.","type":"boolean","example":true},"video_file":{"description":"Include in-meeting and/or in-webinar video in the archive.","type":"boolean","example":true}},"type":"object"},"type":{"description":"Archive types:\n\n* `1`: Only meetings are archived.<br>\n* `2`: Only webinars are archived.<br>\n* `3`: Both meetings and webinars are archived.","enum":[1,2,3],"type":"integer","example":1}},"type":"object"},"auto_recording":{"description":"Record meetings automatically as they start.","type":"string","example":"local"},"cloud_recording":{"description":"Allow hosts to record and save the meeting / webinar in the cloud.","type":"boolean","example":true},"cloud_recording_download":{"description":"Allow anyone with a link to the cloud recording to download.","type":"boolean","example":true},"cloud_recording_download_host":{"description":"Allow only the host with a link to the cloud recording to download.","type":"boolean","example":true},"host_delete_cloud_recording":{"description":"Allow the host to delete the recordings. If this option is disabled, the recordings cannot be deleted by the host and only admin can delete them.","type":"boolean","example":true},"record_files_separately":{"type":"object","description":"The account's [**Record active speaker, gallery view and shared screen separately**](https://support.zoom.us/hc/en-us/articles/360060316092-Changing-basic-and-advanced-cloud-recording-settings#h_01F4CYJTCTXNS2MXH00W9EFG6R) settings.","properties":{"active_speaker":{"type":"boolean","description":"Whether recording only the active speaker is enabled.","example":true},"gallery_view":{"type":"boolean","description":"Whether recording only the gallery view is enabled.","example":true},"shared_screen":{"type":"boolean","description":"Whether recording only shared screen is enabled.","example":true}}},"display_participant_name":{"type":"boolean","description":"Whether participants' names display in the recording.","example":true},"recording_thumbnails":{"type":"boolean","description":"Whether thumbnails of the presenter are recorded when they are sharing their screen.","example":true},"optimize_recording_for_3rd_party_video_editor":{"description":"Whether recordings will be optimized for a 3rd party video editor. This can increase the file size and the time it takes to generate recording files.","type":"boolean","example":true},"recording_highlight":{"description":"Whether the [recording highlights](https://support.zoom.us/hc/en-us/articles/360060802432) feature is enabled.","type":"boolean","example":true,"deprecated":true},"save_panelist_chat":{"description":"Whether panelist chats are saved to the recording.","type":"boolean","example":true},"save_poll_results":{"description":"Whether poll results shared during the meeting or webinar are saved. This also includes poll results shared during the meeting or webinar.","type":"boolean","example":true},"save_close_caption":{"description":"Whether [closed captions](https://support.zoom.us/hc/en-us/articles/207279736) are saved as a VTT (Video Track Text) file.","type":"boolean","example":true},"ip_address_access_control":{"description":"Setting to allow cloud recording access only from specific IP address ranges.\n","properties":{"enable":{"description":"If set to `true`, the cloud recordings of this account can only be accessed by the IP addresses defined in the `ip_addresses_or_ranges` property.\n\n","type":"boolean","example":true},"ip_addresses_or_ranges":{"description":"IP addresses or ranges that have access to the cloud recordings. Separate multiple IP ranges with comma. Use n.n.n.n, n.n.n.n/n or n.n.n.n - n.n.n.n syntax where n is a number.\n\nExample: `46.33.24.184, 48.99.100.2/25` or `200.181.108.17 - 220.181.108.157`\n\n","type":"string","example":"200.181.108.17 - 220.181.108.157"}},"type":"object"},"local_recording":{"description":"Allow hosts and participants to record the meeting to a local file.","type":"boolean","example":true},"prevent_host_access_recording":{"description":"If set to `true`, meeting hosts cannot view their meeting cloud recordings. Only the admins who have recording management privilege can access them.\n\n","type":"boolean","example":true},"record_audio_file":{"description":"Whether to record one audio file for all participants.","type":"boolean","example":true},"record_gallery_view":{"description":"When someone is sharing their screen, active speaker will show on the top right corner of the shared screen.","type":"boolean","example":true},"record_speaker_view":{"description":"Record active speaker with shared screen.","type":"boolean","example":true},"recording_audio_transcript":{"description":"Automatically transcribe the audio of a meeting or webinar for cloud recordings.","type":"boolean","example":true},"smart_recording":{"description":"By selecting this option, your recording will have meeting smart chapters, and next steps. You are directing Zoom to access, process, and use your account's recording data for the purpose of analysis and insights.","properties":{"create_recording_highlights":{"description":"By selecting this option, meeting details in the audio transcript will be highlighted. Hosts can modify highlighted sections and generate a video summary (highlighted sections may have a 3-second offset) based on these sections. The summary is for informational purposes only and may not be complete.","type":"boolean","example":true},"create_smart_chapters":{"description":"By selecting this option, your recording will have chapters with overview. Hosts can edit the chapters.","type":"boolean","example":true},"create_next_steps":{"description":"By selecting this option, there will be a summary of actions to take after the recorded meeting.","type":"boolean","example":true}},"type":"object"},"save_chat_text":{"description":"Save chat messages from the meeting / webinar.","type":"boolean","example":true},"show_timestamp":{"description":"Add a timestamp to the recording.","type":"boolean","example":true}},"type":"object"},"schedule_meeting":{"properties":{"audio_type":{"description":"Determine how participants can join the audio portion of the meeting.","type":"string","example":"both"},"embed_password_in_join_link":{"description":"If the value is set to `true`, the meeting password will be encrypted and included in the join meeting link to allow participants to join with just one click without having to enter the password.\n ","type":"boolean","example":true},"force_pmi_jbh_password":{"deprecated":true,"description":"If join before host option is enabled for a personal meeting, then enforce password requirement.","type":"boolean","example":true},"host_video":{"description":"Start meetings with host video on.","type":"boolean","example":true},"join_before_host":{"description":"Allow participants to join the meeting before the host arrives","type":"boolean","example":true},"mute_upon_entry":{"description":"Automatically mute all participants when they join the meeting.","type":"boolean","example":true},"participant_video":{"description":"Start meetings with participant video on.","type":"boolean","example":true},"pstn_password_protected":{"description":"Generate and send new passwords for newly scheduled or edited meetings.","type":"boolean","example":true},"require_password_for_all_meetings":{"description":"Require password from all participants before joining a meeting.","type":"boolean","example":true},"require_password_for_instant_meetings":{"description":"If enabled, a random password will be generated on the user's end who starts the instant meeting. Other participants will have to enter the password to join the meeting. If you use PMI for your instant meetings, this option will be disabled.","type":"boolean","example":true},"require_password_for_pmi_meetings":{"description":"Indicates whether a password is required for [PMI](https://support.zoom.us/hc/en-us/articles/203276937-Using-Personal-Meeting-ID-PMI-) meetings or not. The value can be one of the following:<br>\n`none`: Do not require password for PMI meetings.<br> \n`all`: Require participants to enter password for all PMI enabled meetings.<br> `jbh_only`: Require password only for meetings where the **\"join before host\"** setting is enabled.","enum":["all","jbh_only","none"],"type":"string","example":"jbh_only"},"require_password_for_scheduled_meetings":{"description":"Require a password for meetings which have already been scheduled\n","type":"boolean","example":true},"require_password_for_scheduling_new_meetings":{"description":"This setting applies for regular meetings that do not use PMI. If enabled, a password will be generated while a host schedules a new meeting and participants will be required to enter the password before they can join the meeting. ","type":"boolean","example":true},"upcoming_meeting_reminder":{"description":"Receive desktop notification for upcoming meetings.","type":"boolean","example":true},"always_display_zoom_meeting_as_topic":{"description":"Information about the [**Always display \"Zoom Meeting\" as the meeting topic**](https://support.zoom.us/hc/en-us/articles/201363253-Changing-account-settings#h_01EG9BJ646V2WJK1S3H2MP6YV6) setting.","type":"object","properties":{"enable":{"type":"boolean","description":"Whether to enable the **Always display \"Zoom Meeting\" as the meeting topic** setting.","example":false},"display_topic_for_scheduled_meetings":{"type":"boolean","description":"Whether to display \"Zoom Meeting\" as the topic for already-scheduled meetings.","example":false}}},"always_display_zoom_webinar_as_topic":{"type":"object","description":"Information about the [**Always show \"Zoom Webinar\" as the webinar topic**](https://support.zoom.us/hc/en-us/articles/201363253-Changing-account-settings#h_01EG9BJ646V2WJK1S3H2MP6YV6) setting.","properties":{"enable":{"type":"boolean","description":"Whether to enable the **Always show \"Zoom Webinar\" as the webinar topic** setting.","example":false},"display_topic_for_scheduled_webinars":{"type":"boolean","description":"Whether to display \"Zoom Webinar\" as the topic for already-scheduled meetings.","example":false}}}},"type":"object"},"telephony":{"properties":{"audio_conference_info":{"description":"","type":"string","example":"test"},"third_party_audio":{"description":"Allow users to join the meeting using the existing 3rd party audio configuration.","type":"boolean","example":true}},"type":"object"},"chat":{"type":"object","description":"The account's chat settings.","properties":{"share_files":{"type":"object","description":"Users can share files in chats and channels.","properties":{"enable":{"type":"boolean","description":"Allow users of this account to send and receive files in chats and channels. When disabled, users can still take and share screenshots.","example":true},"share_option":{"type":"string","description":"Allow users of this account to send and receive files in chats and channels. When disabled, users can still take and share screenshots.","enum":["anyone","account","organization"],"x-enum-descriptions":["Anyone (internal and external contacts)","In the same account","In the same organization"],"example":true}}},"chat_emojis":{"type":"object","description":"Chat emojis.","properties":{"enable":{"type":"boolean","description":"Allow users to use the emoji library in direct messages or group conversations. Choose between allowing users to use any emoji in the library, or choose to allow only pre-selected emojis. If the setting is disabled, users can still use keyboard shortcuts to add emojis. Users can change their emoji skin tone in Settings.","example":true},"emojis_option":{"type":"string","example":"all","enum":["all","selected"],"x-enum-descriptions":["All emojis","Selected emojis"]}}},"record_voice_messages":{"description":"Allow users to record voice messages that can be sent in direct messages or group conversations.","type":"boolean","example":true},"record_video_messages":{"description":"Allow users to record video messages that can be sent in direct messages or group conversations. If the file share setting is disabled, they will not be able to record and send video messages.","type":"boolean","example":true},"create_public_channels":{"type":"boolean","description":"Allow users to create public channels.","example":true},"create_private_channels":{"type":"boolean","description":"Allow users to create private channels.","example":true},"share_links_in_chat":{"type":"boolean","description":"Share links to messages and channels in Team Chat.","example":true},"schedule_meetings_in_chat":{"type":"boolean","description":"Schedule a meeting from chat or channel.","example":true},"set_retention_period_in_cloud":{"type":"object","description":"Set retention period for messages and files in Zoom's cloud.","properties":{"enable":{"type":"boolean","description":"By default, messages and files are stored in Zoom's cloud. Enable this setting to specify when they are deleted. When retention is disabled, messages sent by offline users can be received within 7 days before they are deleted.","example":true},"retention_period_of_direct_messages_and_group_conversation":{"type":"string","description":"Delete direct messages and group conversations after retention period. 'y' - year, 'm' - month, 'd' - day","example":"2m"},"retention_period_of_channels":{"type":"string","description":"Delete data in channels after retention period. 'y' - year, 'm' - month, 'd' - day","example":"2m"}}},"set_retention_period_in_local":{"type":"object","description":"Store messages on local devices, excluding personal channel messages.","properties":{"enable":{"type":"boolean","description":"Specify how long your messages are saved on local devices. If this setting is disabled, messages are never deleted locally.","example":true},"retention_period_of_direct_messages_and_group_conversation":{"type":"string","description":"Delete direct messages and group conversations after retention period. 'y' - year, 'm' - month, 'd' - day","example":"2m"},"retention_period_of_channels":{"type":"string","description":"Delete data in channels after retention period. 'y' - year, 'm' - month, 'd' - day","example":"2m"}}},"allow_users_to_search_others_options":{"description":"Allow users to search others, when selecting multiple items, separate them with commas. \n* ''-none. \n* '1' — In the same account. \n* '2' — Under the same master account, including all sub acounts. \n* '3' — Under the same organization.","type":"string","example":"1,3"},"allow_users_to_add_contacts":{"description":"Allow users to add contacts.","type":"object","properties":{"enable":{"description":"By disabling this setting, users will not be able to add contacts.","type":"boolean","example":true},"selected_option":{"description":"The type of allowing users to add contacts: \n* 1 — Anyone (internal and external contacts). \n* 2 — In the same organization. \n* 3 — In the same organization and specified domains. \n* 4 — In the same organization and specified users.","enum":[1,2,3,4],"type":"integer","example":4},"user_email_addresses":{"description":"The domains or emails (internal or external). \n* When the `selected_option` field value is `3`, the value is internal or external domains. Use a comma to separate multiple domains. Example: company.com. \n* When the `selected_option` field value is `4`, the value is internal or external email addresses. Use a comma to separate multiple emails.","type":"string","example":"123@test.com"}}},"allow_users_to_chat_with_others":{"description":"Allow users to chat with others.","type":"object","properties":{"enable":{"description":"If you select 'In the same organization', users may still be able to chat with external users if they are added to channels or group chats with external users.","type":"boolean","example":true},"selected_option":{"description":"The type of allowing users to add contacts: \n* 1 — Anyone (internal and external contacts). \n* 2 — In the same organization. \n* 3 — In the same organization and specified domains. \n* 4 — In the same organization and specified users.","enum":[1,2,3,4],"type":"integer","example":4},"user_email_addresses":{"description":"The domains or emails (internal or external). \n* When the `selected_option` field value is `3`, the value is internal or external domains. Use a comma to separate multiple domains. Example: company.com. \n* When the `selected_option` field value is `4`, the value is internal or external email addresses. Use a comma to separate multiple emails.","type":"string","example":"123@test.com"}}},"chat_etiquette_tool":{"description":"Information about the **Chat Etiquette** Tool.","properties":{"enable":{"default":false,"description":"Whether to enable the **Chat Etiquette Tool**. This value defaults to `false`. \n\n The **Chat Etiquette Tool** allows you to define specific keywords and text patterns in chat to prevent users from inadvertently sharing unwanted messages.","type":"boolean","example":true},"policies":{"description":"Information about the defined **Chat Etiquette Tool** policies.","items":{"properties":{"id":{"description":"The policy ID.","type":"string","example":"aefwf23dsv;sdo-khuity8"},"status":{"description":"The policy's current status: \n* `activated` — Activated. \n* `deactivated` — Deactivated.","enum":["activated","deactivated"],"type":"string","x-enum-descriptions":["Activated.","Deactivated."],"example":"Activated"}},"type":"object"},"type":"array"}},"type":"object"},"send_data_to_third_party_archiving_service":{"type":"object","description":"Send data to third-party archiving service.","properties":{"enable":{"type":"boolean","description":"Allow users to send data to third-party archiving service.","example":true}}}}}},"type":"object"},{"oneOf":[{"properties":{"authentication_option":{"description":"Meeting Authentication Options","properties":{"action":{"description":"Authentication action","enum":["update","show","hide"],"type":"string","example":"update"},"default_option":{"description":"Authentication default option","type":"boolean","example":true},"domains":{"description":"Authentication domains","type":"string","example":"example.com"},"id":{"description":"Authentication id","type":"string","example":"ewf22f42fewf4232fgg4343lki4"},"name":{"description":"Authentication name","type":"string","example":"Authentication name"},"type":{"description":" Authentication type. Specify one of the following authentication types for the authentication profile:<br>\n * `enforce_login`: This option allows any users to join the meeting or webinar, as long as they are signed into their Zoom account.\n * `enforce_login_with_domains`: This option, allows you to specify a rule so that only those Zoom users whose email addresses contain a certain domain, can join the meeting or webinar. You can either add multiple domains using a comma in between and/or use a wildcard for listing domains.<br>\n * `enforce_login_with_same_account`: This option allows users to join the meeting or webinar with the same Zoom account.","enum":["enforce_login","enforce_login_with_same_account","enforce_login_with_domains"],"type":"string","example":"enforce_login_with_domains"}},"type":"object"},"meeting_authentication":{"description":"Only authenticated users can join meetings","type":"boolean","example":true}},"type":"object"},{"properties":{"authentication_option":{"description":"Authentication Options","properties":{"action":{"description":"Authentication action","enum":["update","show","hide"],"type":"string","example":"update"},"default_option":{"description":"Authentication default option","type":"boolean","example":true},"domains":{"description":"Authentication domains","type":"string","example":"example.com"},"id":{"description":"Authentication id","type":"string","example":"ewf22f42fewf4232fgg4343lki4"},"name":{"description":"Authentication name","type":"string","example":"Authentication name"},"type":{"description":"Authentication type","enum":["internally","enforce_login","enforce_login_with_domains"],"type":"string","example":"enforce_login_with_domains"}},"type":"object"},"recording_authentication":{"description":"Only authenticated users can view cloud recordings","type":"boolean","example":true}},"type":"object"}],"title":"GroupSettingsAuthenticationUpdate","type":"object"},{"description":"The group's updated meeting and webinar security settings.","properties":{"meeting_security":{"properties":{"auto_security":{"description":"Whether to require that all meetings are secured with at least one security option. \n\n This setting can only be disabled by Enterprise, ISV, Business (with more than 100 licenses), and Education accounts.","type":"boolean","example":true},"block_user_domain":{"description":"Whether to block users in specific domains from joining meetings and webinars.","type":"boolean","example":true},"block_user_domain_list":{"description":"The domain to block, up to 20 domains. For example, the `*.example.com` domain.","items":{"maxLength":30,"minLength":5,"type":"string","example":"*.example.com"},"maxItems":20,"type":"array"},"chat_etiquette_tool":{"description":"Information about the **Chat Etiquette** Tool.","properties":{"enable":{"default":false,"description":"Whether to enable the **Chat Etiquette Tool**. This value defaults to `false`. \n\n The **Chat Etiquette Tool** allows you to define specific keywords and text patterns in chat to prevent users from inadvertently sharing unwanted messages.","type":"boolean","example":true},"policies":{"description":"Information about the defined **Chat Etiquette Tool** policies.","items":{"properties":{"id":{"description":"The policy ID.","type":"string","example":"aefwf23dsv;sdo-khuity8"},"status":{"description":"The policy's current status: \n* `activated` — Activated. \n* `deactivated` — Deactivated.","enum":["activated","deactivated"],"type":"string","x-enum-descriptions":["Activated.","Deactivated."],"example":"Activated"}},"type":"object"},"type":"array"}},"type":"object"},"embed_password_in_join_link":{"description":"Whether the meeting password will be encrypted and included in the invitation link. The provided link will allow participants to join the meeting without having to enter the password.","type":"boolean","example":true},"encryption_type":{"description":"The type of encryption to use when starting a meeting: \n* `enhanced_encryption` — Use enhanced encryption. Encryption data is stored in the cloud. \n* `e2ee` — End-to-end encryption. The encryption key is stored on the local device and cannot be obtained by anyone else. Enabling E2EE also [**disables** certain features](https://support.zoom.us/hc/en-us/articles/360048660871), such as cloud recording, live streaming, and allowing participants to join before the host.","enum":["enhanced_encryption","e2ee"],"type":"string","example":"e2ee"},"end_to_end_encrypted_meetings":{"description":"Whether to enable end-to-end encryption for meetings. If enabled, you can specify the type of encryption in the `encryption_type` field.","type":"boolean","example":true},"meeting_password":{"description":"Whether all instant and scheduled meetings that users can join via client or Zoom Rooms systems are password-protected. [Personal Meeting ID (PMI)](https://support.zoom.us/hc/en-us/articles/203276937) meetings are **not** included in this setting.","type":"boolean","example":true},"meeting_password_requirement":{"description":"Information about the meeting and webinar [password requirements](https://support.zoom.us/hc/en-us/articles/360033559832-Meeting-and-webinar-passwords#h_a427384b-e383-4f80-864d-794bf0a37604).","properties":{"consecutive_characters_length":{"description":"The maximum length of consecutive characters (for example, `abcdef`) allowed in a password: \n* `4` through `8` — The maximum consecutive characters length. The length is `n` minus `1`, where `n` is the provided value. For example, if you provide the `4` value, there can only be a maximum of `3` consecutive characters in a password (for example, `abc1x@8fdh`). \n* `0` — Do not apply a consecutive character restriction.","enum":[0,4,5,6,7,8],"type":"integer","example":8},"have_letter":{"description":"Whether the password must contain at least one letter character.","type":"boolean","example":true},"have_number":{"description":"Whether the password must contain at least one numeric character.","type":"boolean","example":true},"have_special_character":{"description":"Whether the password must contain at least one special character. For example, `!`, `@`, and/or `#` characters.","type":"boolean","example":true},"have_upper_and_lower_characters":{"description":"Whether the password must include uppercase and lowercase characters.","type":"boolean","example":true},"length":{"description":"The password's minimum length.","type":"integer","example":10},"only_allow_numeric":{"description":"Whether the password must contain **only** numeric characters.","type":"boolean","example":true},"weak_enhance_detection":{"description":"Whether users will be informed when the provided password is weak.","type":"boolean","example":true}},"type":"object"},"only_authenticated_can_join_from_webclient":{"description":"Whether to specify that only authenticated users can join the meeting from the web client.","type":"boolean","example":true},"phone_password":{"description":"Whether to require a password for participants joining by phone. \n\n If enabled and the meeting is password-protected, a numeric password is required for participants to join by phone. For meetings with alphanumeric passwords, a numeric password will be generated.","type":"boolean","example":true},"pmi_password":{"description":"Whether all Personal Meeting ID (PMI) meetings that users can join via client or Zoom Rooms systems are password-protected.","type":"boolean","example":true},"require_password_for_scheduled_meeting":{"description":"Whether to require a password for meetings that have already been scheduled.","type":"boolean","example":true},"require_password_for_scheduled_webinar":{"description":"Whether to require a password for webinars that have already been scheduled.","type":"boolean","example":true},"waiting_room":{"description":"Whether participants are placed in the [**Waiting Room**](https://support.zoom.us/hc/en-us/articles/115000332726-Waiting-Room) when they join a meeting. \n\n If the **Waiting Room** feature is enabled, the [**Allow participants to join before host**](https://support.zoom.us/hc/en-us/articles/202828525-Allow-participants-to-join-before-host) setting is automatically disabled.","type":"boolean","example":true},"waiting_room_settings":{"description":"Information about the Waiting Room settings.","properties":{"participants_to_place_in_waiting_room":{"description":"The type of participants to be admitted to the Waiting Room: \n* `0` — All attendees. \n* `1` — Users who are not in your account. \n* `2` — Users who are not in your account and are not part of your [allowed domains list](https://support.zoom.us/hc/en-us/articles/360037117472-Configuring-authentication-profiles#h_e3cf0d5f-eec7-4c2a-ad29-ef2a5079a7da).","enum":[0,1,2],"type":"integer","example":1},"users_who_can_admit_participants_from_waiting_room":{"description":"The users who can admit participants from the Waiting Room: \n* `0` — Host and co-hosts only. \n* `1` — Host, co-hosts, and anyone who bypassed the Waiting Room if the host and co-hosts are not present.","enum":[0,1],"type":"integer","example":1},"whitelisted_domains_for_waiting_room":{"description":"If the `participants_to_place_in_waiting_room` field is `2`, a comma-separated list of the domains that can bypass the Waiting Room (`\"example.com,example2.com\"`).","type":"string","example":"example.com"}},"type":"object"},"webinar_password":{"description":"Whether to generate a password when scheduling webinars. Participants must use the generated password to join the scheduled webinar.","type":"boolean","example":true}},"type":"object"}},"title":"Meeting/Webinar Security Group Settings","type":"object"}]}}}},"summary":"Update a group's settings"}},"/groups/{groupId}/settings/virtual_backgrounds":{"delete":{"parameters":[{"description":"The group ID. To get a group's ID, use the [**List groups**](/docs/api-reference/zoom-api/methods#operation/groups) API.","in":"path","name":"groupId","required":true,"schema":{"type":"string","example":"0mgThLiRQH2bUHvIaL4t2g"}},{"description":"A comma-separated list of the file IDs to delete.","in":"query","name":"file_ids","schema":{"type":"string","example":"6SEYvTU4SuG257lOHuJKOQ"}}],"responses":{"204":{"description":"**HTTP Status Code:** `204` <br>\n* No content. \n* Deleted."},"400":{"description":"**HTTP Status Code:** `400` <br>\n Bad Request \n\n **Error Code:** `300` <br>\n* Invalid parameter: {file_ids} \n* Group member not found."},"404":{"description":"**HTTP Status Code:** `404` <br>\n Not Found \n\n **Error Code:** `4130` <br>\n A group with this {groupId} does not exist."}},"tags":["Groups"],"description":"Use this API to delete a group's [Virtual Background files](https://support.zoom.us/hc/en-us/articles/210707503-Virtual-Background#h_01EJF3YFEWGT8YA0ZJ079JEDQE). \n\n **Scope:** `group:write:admin` <br> **[Rate Limit Label](https://developers.zoom.us/docs/api/rest/rate-limits/):** `Light` \n\n **Prerequisites:** \n* The [Virtual Background feature](https://support.zoom.us/hc/en-us/articles/210707503-Virtual-Background#h_2ef28080-fce9-4ac2-b567-dc958afab1b7) must be enabled on the account.","operationId":"delGroupVB","summary":"Delete Virtual Background files"},"post":{"parameters":[{"description":"The group ID. To get a group's ID, use the [**List groups**](/docs/api-reference/zoom-api/methods#operation/groups) API.","in":"path","name":"groupId","required":true,"schema":{"type":"string","example":"0mgThLiRQH2bUHvIaL4t2g"}}],"responses":{"201":{"content":{"application/json":{"schema":{"description":"Information about the Virtual Background file.","properties":{"id":{"description":"The file's ID.","type":"string","example":"6SEYvTU4SuG257lOHuJKOQ"},"is_default":{"description":"Whether the file is the default Virtual Background file.","type":"boolean","example":true},"name":{"description":"The file's name.","type":"string","example":"San Francisco"},"size":{"description":"The file's size, in bytes.","type":"string","example":"7220"},"type":{"description":"The file type.","type":"string","example":"image"}},"type":"object"}}},"description":"**HTTP Status Code:** `201` <br>\n Created"},"400":{"description":"**HTTP Status Code:** `400` **Bad Request** <br>\n**Error Code:** `120`<br>\nNo file uploaded, verify that a file has been uploaded.<br>\nFile size cannot exceed 15M.<br>\nA maximum of 10 files are allowed for a user.<br>\nOnly jpg/jpeg or png image file can be uploaded.\n\n"},"404":{"description":"**HTTP Status Code:** `404` **Not Found** <br>\n**Error Code:** `1001`<br>\nUser not exist.<br>\nUser {email} not exist or not belong to this account."}},"tags":["Groups"],"description":"Use this API to [upload Virtual Background files](https://support.zoom.us/hc/en-us/articles/210707503-Virtual-Background#h_01EJF3YFEWGT8YA0ZJ079JEDQE) for all users in a group to use. \n\n **Scopes:** `group:write:admin` <br> **[Rate Limit Label](https://developers.zoom.us/docs/api/rest/rate-limits/):** `Medium` \n\n**Prerequisites:** \n* The [Virtual Background feature](https://support.zoom.us/hc/en-us/articles/210707503-Virtual-Background#h_2ef28080-fce9-4ac2-b567-dc958afab1b7) must be enabled on the account.","operationId":"uploadGroupVB","requestBody":{"content":{"multipart/form-data":{"schema":{"properties":{"file":{"description":"The Virtual Background file's path.","type":"string","example":"binary"}},"type":"object"}}}},"summary":"Upload Virtual Background files"}},"/contacts/groups":{"get":{"parameters":[{"description":"The number of records returned with a single API call. ","in":"query","name":"page_size","schema":{"type":"integer","default":10,"maximum":50,"example":10}},{"description":"The next page token is used to paginate through large result sets. A next page token will be returned whenever the set of available results exceeds the current page size. The expiration period for this token is 15 minutes.","in":"query","name":"next_page_token","schema":{"type":"string","example":"R4aF9Oj0fVM2hhezJTEmSKaBSkfesDwGy42"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"groups":{"description":"List of contact group objects.","items":{"properties":{"group_id":{"description":"The group ID.","type":"string","example":"dir.JquKVDGlQ9K6S0QVWGcysw"},"group_name":{"description":"The group name.","type":"string","example":"Developers"},"group_privacy":{"description":"The contact group privacy configuration:<br>`1` - Visible to anyone, searchable by anyone.<br>`2` - Visible to members only, searchable by anyone.<br>`3` - Visible to members only, searchable by members only.","type":"integer","enum":[1,2,3],"example":1},"description":{"description":"The group description.","type":"string","example":"A contact group for office A"}},"type":"object"},"type":"array"},"next_page_token":{"type":"string","description":"The next page token is used to paginate through large result sets. A next page token will be returned whenever the set of available results exceeds the current page size. The expiration period for this token is 15 minutes.\n","example":"R4aF9Oj0fVM2hhezJTEmSKaBSkfesDwGy42"},"page_size":{"type":"integer","description":"The number of records returned within a single API call.","example":10}},"type":"object"}}},"description":"**HTTP Status Code:** `200`<br>\nList of contact groups returned."},"400":{"description":"**Error Code:** `200` <br>\nOnly available for paid account: {accountId}"}},"security":[{"OAuth":[]}],"tags":["Contact Groups"],"description":"List [contact groups](https://support.zoom.us/hc/en-us/articles/204519819-Group-Management-) under an account.\n\n**Prerequisite**: Pro or higher account.<br>\n**Scopes**: `contact_group:read:admin`<br>\n **[Rate Limit Label](https://developers.zoom.us/docs/api/rest/rate-limits/):** `Medium`","operationId":"contactGroups","summary":"List contact groups"},"post":{"summary":"Create a contact group","description":"Use this API to create a [contact group](https://support.zoom.us/hc/en-us/articles/204519819-Group-Management).\n\n**Prerequisite**: Pro or higher account.<br>**Scopes:** `contact_group:write:admin`<br>**[Rate Limit Label](https://developers.zoom.us/docs/api/rest/rate-limits/):** `Heavy`","operationId":"contactGroupCreate","tags":["Contact Groups"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"group_name":{"type":"string","description":"The contact group's name.","example":"Developers"},"group_privacy":{"description":"Contact group privacy configuration:<br>`1` - Visible to anyone, searchable by anyone.<br>`2` - Visible to members only, searchable by anyone.<br>`3` - Visible to members only, searchable by members only.","type":"integer","enum":[1,2,3],"example":1},"description":{"description":"The group description.","type":"string","example":"A contact group."},"group_members":{"items":{"description":"The contact group member information. The member type can be a `user` or `user group`. The maximum number members per request is 50 for the `user` and 3 for the `user group`.","properties":{"type":{"description":"Contact group member types:<br>`1` - user.<br>`2` - user group.","type":"integer","enum":[1,2],"example":2},"id":{"description":"The member ID: user ID (`user`) or user group ID (`user group`).","type":"string","example":"n22T5G6bQDCugVm1V59TAQ"}},"type":"object"},"type":"array"}}}}}},"responses":{"201":{"content":{"application/json":{"schema":{"properties":{"group_id":{"type":"string","description":"The contact group ID.","example":"A4ql1FjgL913r"},"group_name":{"type":"string","description":"The contact group's name.","example":"Developers"},"total_members":{"type":"integer","description":"The contact group's total member count.","example":34},"group_privacy":{"description":"Contact group privacy configuration:<br>`1` - Visible to anyone, searchable by anyone.<br>`2` - Visible to members only, searchable by anyone.<br>`3` - Visible to members only, searchable by members only.","type":"integer","enum":[1,2,3],"example":1},"description":{"description":"The group description.","type":"string","example":"A contact group."}},"type":"object"}}},"description":"**HTTP Status Code:** `201` <br>\nGroup created."},"400":{"description":"**Error Code:** `200` <br>\nOnly available for paid account: {accountId}<br>\n**Error Code:** `300`<br>\nThe maximum number of user member per request is 50.<br>\n**Error Code:** `300`<br>\nThe maximum number of group member per request is 3."}},"security":[{"OAuth":[]}]}},"/contacts/groups/{groupId}":{"delete":{"parameters":[{"description":"The contact group ID.<br>\nRetrieve by calling the [**List contact groups**](/docs/api-reference/zoom-api/methods#operation/contactGroups) API.","in":"path","name":"groupId","required":true,"schema":{"type":"string","example":"dir.JquKVDGlQ9K6S0QVWGcysw"}}],"responses":{"204":{"description":"**HTTP Status Code:** `204`<br>\nGroup deleted."},"400":{"description":"**Error Code:** `200`<br>\nOnly available for paid account,{accountId}.<br>\n**Error Code:** `300`<br>\nA group with this groupId: {groupId} does not exist."}},"security":[{"OAuth":[]}],"tags":["Contact Groups"],"description":"Use this API to delete a [contact group](https://support.zoom.us/hc/en-us/articles/204519819-Group-Management-).\n\n**Prerequisite**: Pro or higher account.<br>**Scopes:** `contact_group:write:admin`<br>**[Rate Limit Label](https://developers.zoom.us/docs/api/rest/rate-limits/):** `Heavy`","operationId":"contactGroupDelete","summary":"Delete a contact group"},"get":{"parameters":[{"description":"The contact group ID.<br>\nRetrieve by calling the [**List contact groups**](/docs/api-reference/zoom-api/methods#operation/contactGroups) API.","in":"path","name":"groupId","required":true,"schema":{"type":"string","example":"dir.JquKVDGlQ9K6S0QVWGcysw"}}],"responses":{"200":{"content":{"application/json":{"schema":{"description":"The contact group information.","properties":{"group_id":{"description":"The group ID.","type":"string","example":"dir.JquKVDGlQ9K6S0QVWGcysw"},"group_name":{"description":"The group name.","type":"string","example":"Developers"},"total_members":{"description":"The total number of members in a contact group.","type":"integer","example":10},"group_privacy":{"description":"The contact group privacy configuration:<br>`1` - Visible to anyone, searchable by anyone.<br>`2` - Visible to members only, searchable by anyone.<br>`3` - Visible to members only, searchable by members only.","type":"integer","enum":[1,2,3],"example":1},"description":{"description":"The group description.","type":"string","example":"A contact group for office A"}},"type":"object"}}},"description":"**HTTP Status Code:** `200`<br> Group returned."},"400":{"description":"**Error Code:** `200` <br>\nOnly available for paid account: {accountId}<br>**Error Code:** `300`<br>\nA group with this groupId: {groupId} does not exist."}},"security":[{"OAuth":[]}],"tags":["Contact Groups"],"description":"Get a [contact group](https://support.zoom.us/hc/en-us/articles/204519819-Group-Management-) under an account.\n\n**Prerequisite**: Pro or higher account.<br>\n**Scopes**: `contact_group:write:admin`<br>\n **[Rate Limit Label](https://developers.zoom.us/docs/api/rest/rate-limits/):** `Light`","operationId":"contactGroup","summary":"Get a contact group"},"patch":{"parameters":[{"description":"The contact group ID.<br>\nRetrieve by calling the [**List contact groups**](/docs/api-reference/zoom-api/methods#operation/contactGroups) API.","in":"path","name":"groupId","required":true,"schema":{"type":"string","example":"dir.JquKVDGlQ9K6S0QVWGcysw"}}],"responses":{"204":{"description":"Contact group updated."},"400":{"description":"**Error Code:** `200` <br>\nOnly available for paid account: {accountId}<br>**Error Code:** `300`<br>\nA group with this groupId: {groupId} does not exist."}},"security":[{"OAuth":[]}],"tags":["Contact Groups"],"description":"Update a [contact group](https://support.zoom.us/hc/en-us/articles/204519819-Group-Management-) under your account.\n\n**Prerequisite**: Pro or higher account.<br>\n**Scopes**: `contact_group:write:admin`<br>\n **[Rate Limit Label](https://developers.zoom.us/docs/api/rest/rate-limits/):** `Heavy`","operationId":"contactGroupUpdate","requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","description":"The contact group's name.","example":"Developers"},"privacy":{"description":"Contact group privacy configuration:<br>`1` - Visible to anyone, searchable by anyone.<br>`2` - Visible to members only, searchable by anyone.<br>`3` - Visible to members only, searchable by members only.","type":"integer","enum":[1,2,3],"example":1},"description":{"description":"The group description.","type":"string","example":"A contact group."}}}}},"required":true},"summary":"Update a contact group"}},"/contacts/groups/{groupId}/members":{"delete":{"parameters":[{"description":"The member's ID in a contact group. Use commas (,) to separate a maximum of 20 ids. <br>\nCan be retrieved by calling the [**List contact groups**](/docs/api-reference/zoom-api/methods#operation/contactGroupMembers) API.","in":"query","name":"member_ids","required":true,"schema":{"type":"string","example":"n22T5G6bQDCugVm1V59TAQ"}}],"responses":{"204":{"description":"**HTTP Status Code:** `204`<br>\nMember removed."},"400":{"description":"**Error Code:** `200`<br>\nOnly available for paid account,{accountId}.<br>\n**Error Code:** `300`<br>\nA group with this groupId: {groupId} does not exist.<br>\n**Error Code:** `300`<br>\nThe maximum number of memberId is 20.<br>\n**Error Code:** `300`<br> A member with this memberId: {memberId} does not exist.<br>\n**Error Code:** `300`<br> A group must have at least one member."}},"security":[{"OAuth":[]}],"tags":["Contact Groups"],"description":"Use this API to remove members in a [contact group](https://support.zoom.us/hc/en-us/articles/204519819-Group-Management-).\n\n**Prerequisite**: Pro or higher account.<br>**Scopes:** `contact_group:write:admin`<br>**[Rate Limit Label](https://developers.zoom.us/docs/api/rest/rate-limits/):** `Heavy`","operationId":"contactGroupMemberRemove","summary":"Remove members in a contact group"},"get":{"parameters":[{"description":"The number of records returned with a single API call. ","in":"query","name":"page_size","schema":{"type":"integer","default":10,"maximum":50,"example":10}},{"description":"The next page token is used to paginate through large result sets. A next page token will be returned whenever the set of available results exceeds the current page size. The expiration period for this token is 15 minutes.","in":"query","name":"next_page_token","schema":{"type":"string","example":"R4aF9Oj0fVM2hhezJTEmSKaBSkfesDwGy42"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"members":{"description":"List of contact group members.","items":{"description":"The contact group member information for `user` or `user group`.","properties":{"type":{"description":"Contact group member types:<br>`1` - user.<br>`2` - user group.","type":"integer","enum":[1,2],"example":2},"id":{"description":"The member ID: user ID (`user`) or user group ID (`user group`).","type":"string","example":"n22T5G6bQDCugVm1V59TAQ"},"name":{"description":"The member's name: user's name (`user`) or the group's name (`user group`).","type":"string","example":"Developer group"}},"type":"object"},"type":"array"},"next_page_token":{"type":"string","description":"The next page token is used to paginate through large result sets. A next page token will be returned whenever the set of available results exceeds the current page size. The expiration period for this token is 15 minutes.\n","example":"R4aF9Oj0fVM2hhezJTEmSKaBSkfesDwGy42"},"page_size":{"type":"integer","description":"The number of records returned within a single API call.","example":10}},"type":"object"}}},"description":"**HTTP Status Code:** `200`<br>\nList of contact group members returned."},"400":{"description":"**Error Code:** `200` <br>\nOnly available for paid account: {accountId}<br>\n**Error Code:** `300`<br>\nA group with this groupId: {groupId} does not exist."}},"security":[{"OAuth":[]}],"tags":["Contact Groups"],"description":"List members in [contact groups](https://support.zoom.us/hc/en-us/articles/204519819-Group-Management-) under an account.\n\n**Prerequisite**: Pro or higher account.<br>\n**Scopes**: `contact_group:read:admin`<br>\n **[Rate Limit Label](https://developers.zoom.us/docs/api/rest/rate-limits/):** `Medium`","operationId":"contactGroupMembers","summary":"List contact group members"},"post":{"summary":"Add contact group members","description":"Use this API to add members to a [contact group](https://support.zoom.us/hc/en-us/articles/204519819-Group-Management).\n\n**Prerequisite**: Pro or higher account.<br>**Scopes:** `contact_group:write:admin`<br>**[Rate Limit Label](https://developers.zoom.us/docs/api/rest/rate-limits/):** `Heavy`","operationId":"contactGroupMemberAdd","tags":["Contact Groups"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"group_members":{"items":{"description":"The contact group member information. The member type can be a `user` or `user group`. The maximum number members per request is 50 for the `user` and 3 for the `user group`.","properties":{"type":{"description":"Contact group member types:<br>`1` - user.<br>`2` - user group.","type":"integer","enum":[1,2],"example":2},"id":{"description":"The member ID: user ID (`user`) or user group ID (`user group`).","type":"string","example":"n22T5G6bQDCugVm1V59TAQ"}},"type":"object"},"type":"array"}}}}}},"responses":{"201":{"content":{"application/json":{"schema":{"properties":{"member_ids":{"type":"array","items":{"description":"The member ID of the member that is added successfully.","type":"string","example":"KT6h5SfCSm6YNjZo7i8few"}}}}}},"description":"**HTTP Status Code:** `201` <br>\nMember added."},"400":{"description":"**Error Code:** `200` <br>\nOnly available for paid account: {accountId}<br>\n**Error Code:** `300`<br>\nA group with this groupId: {groupId} does not exist.<br>\n**Error Code:** `300`<br>\nThe maximum number of user member per request is 50.<br>\n**Error Code:** `300`<br>\nThe maximum number of group member per request is 3."}},"security":[{"OAuth":[]}]}},"/h323/devices":{"get":{"parameters":[{"description":"The number of records returned within a single API call.","in":"query","name":"page_size","schema":{"default":30,"maximum":300,"type":"integer","example":30}},{"deprecated":true,"description":"**Deprecated.** We will no longer support this field in a future release. Instead, use the `next_page_token` for pagination.","in":"query","name":"page_number","schema":{"default":1,"type":"integer","example":1}},{"description":"Use the next page token to paginate through large result sets. A next page token is returned whenever the set of available results exceeds the current page size. This token's expiration period is 15 minutes.","in":"query","name":"next_page_token","schema":{"type":"string","example":"IAfJX3jsOLW7w3dokmFl84zOa0MAVGyMEB2"}}],"responses":{"200":{"content":{"application/json":{"schema":{"description":"List of H.323/SIP Devices.","properties":{"next_page_token":{"type":"string","description":"The next page token is used to paginate through large result sets. A next page token will be returned whenever the set of available results exceeds the current page size. The expiration period for this token is 15 minutes.","example":"w7587w4eiyfsudgf"},"page_count":{"type":"integer","description":"The number of pages returned for the request made.","example":1},"page_number":{"deprecated":true,"type":"integer","default":1,"description":"**Deprecated.** We will no longer support this field in a future release. Instead, use the `next_page_token` for pagination.","example":1},"page_size":{"type":"integer","maximum":300,"default":30,"description":"The number of records returned with a single API call.","example":30},"total_records":{"type":"integer","description":"The total number of all the records available across pages.","example":20},"devices":{"description":"List of H.323/SIP Device objects.","items":{"properties":{"id":{"description":"Device ID.","type":"string","example":"abceHewahkrehwiK"},"encryption":{"description":"Device encryption:<br>`auto` - auto.<br>`yes` - yes.<br>`no` - no.","enum":["auto","yes","no"],"type":"string","x-enum-descriptions":["auto","yes","no"],"example":"auto"},"ip":{"description":"Device IP.","type":"string","example":"127.0.0.1"},"name":{"description":"Device name.","maxLength":64,"type":"string","example":"api_test_20190508"},"protocol":{"description":"Device protocol:<br>`H.323` - H.323.<br>`SIP` - SIP.","enum":["H.323","SIP"],"type":"string","x-enum-descriptions":["H.323","SIP"],"example":"H.323"}},"type":"object","description":"The H.323/SIP device object.","required":["name","protocol","ip","encryption"],"title":"The H.323/SIP device object."},"type":"array"}},"type":"object","title":"H.323/SIP Device List"}}},"description":"**HTTP Status Code:** `200`<br>\nList of H.323/SIP devices returned.<br>\n**Error Code:** `200`<br>\nNo permission."}},"security":[{"OAuth":[]}],"tags":["H323 Devices"],"description":"A H.323 or SIP device can make a video call to a [Room Connector](https://support.zoom.us/hc/en-us/articles/201363273-Getting-Started-With-H-323-SIP-Room-Connector) to join a Zoom cloud meeting. A Room Connector can also call out to a H.323 or SIP device to join a Zoom cloud meeting. Use this API to list all H.323/SIP Devices on a Zoom account.<br><br>\n**Scopes:** `h323:read:admin`<br>\n\n **[Rate Limit Label](https://developers.zoom.us/docs/api/rest/rate-limits/):** `Medium`<br>","operationId":"deviceList","summary":"List H.323/SIP devices"},"post":{"responses":{"201":{"content":{"application/json":{"schema":{"properties":{"id":{"description":"Device ID.","type":"string","example":"abceHewahkrehwiK"},"encryption":{"description":"Device encryption:<br>`auto` - auto.<br>`yes` - yes.<br>`no` - no.","enum":["auto","yes","no"],"type":"string","x-enum-descriptions":["auto","yes","no"],"example":"auto"},"ip":{"description":"Device IP.","type":"string","example":"127.0.0.1"},"name":{"description":"Device name.","maxLength":64,"type":"string","example":"api_test_20190508"},"protocol":{"description":"Device protocol:<br>`H.323` - H.323.<br>`SIP` - SIP.","enum":["H.323","SIP"],"type":"string","x-enum-descriptions":["H.323","SIP"],"example":"H.323"}},"type":"object","description":"The H.323/SIP device object.","required":["name","protocol","ip","encryption"],"title":"The H.323/SIP device object."}}},"description":"**HTTP Status Code:** `201`<br>\nH.323/SIP device created."},"400":{"description":"**Error Code:** `200`<br>\nNo permission."},"404":{"description":"**HTTP Status Code:** `404`<br>\n**Error Code:** `2020`<br>\nH.323 device's display name:{displayName} is already in use.\n"}},"security":[{"OAuth":[]}],"tags":["H323 Devices"],"description":"A H.323 or SIP device can make a video call to a [Room Connector](https://support.zoom.us/hc/en-us/articles/201363273-Getting-Started-With-H-323-SIP-Room-Connector) to join a Zoom cloud meeting. A Room Connector can also call out to a H.323 or SIP device to join a Zoom cloud meeting. Use this API to add a H.323/SIP device to your Zoom account<br><br>\n**Scopes:** `h323:write:admin`<br>\n\n **[Rate Limit Label](https://developers.zoom.us/docs/api/rest/rate-limits/):** `Light` <br>","operationId":"deviceCreate","requestBody":{"content":{"application/json":{"schema":{"description":"The H.323/SIP device object.","properties":{"encryption":{"description":"Device encryption:<br>`auto` - auto.<br>`yes` - yes.<br>`no` - no.","enum":["auto","yes","no"],"type":"string","x-enum-descriptions":["auto","yes","no"],"example":"auto"},"ip":{"description":"Device IP.","type":"string","example":"127.0.0.1"},"name":{"description":"Device name.","maxLength":64,"type":"string","example":"api_test_20190508"},"protocol":{"description":"Device protocol:<br>`H.323` - H.323.<br>`SIP` - SIP.","enum":["H.323","SIP"],"type":"string","x-enum-descriptions":["H.323","SIP"],"example":"H.323"}},"required":["name","protocol","ip","encryption"],"title":"The H.323/SIP device object.","type":"object"}}},"description":"H.323/SIP device.","required":true},"summary":"Create a H.323/SIP device"}},"/h323/devices/{deviceId}":{"delete":{"parameters":[{"description":"The device ID.","in":"path","name":"deviceId","required":true,"schema":{"type":"string","example":"abceHewahkrehwiK"}}],"responses":{"200":{"description":"You do not have the permission to delete this device."},"204":{"description":"H.323/SIP device deleted."},"300":{"description":"H.323 device does not exist: {deviceId}."},"404":{"description":"H.323/SIP device not found."}},"tags":["H323 Devices"],"description":"A H.323 or SIP device can make a video call to a [Room Connector](https://support.zoom.us/hc/en-us/articles/201363273-Getting-Started-With-H-323-SIP-Room-Connector) to join a Zoom cloud meeting. A Room Connector can also call out to a H.323 or SIP device to join a Zoom cloud meeting. Use this API to delete a H.323/SIP device from your Zoom account.<br><br>\n**Scopes:** `h323:write:admin`<br>\n\n **[Rate Limit Label](https://developers.zoom.us/docs/api/rest/rate-limits/):** `Light`<br>","operationId":"deviceDelete","summary":"Delete a H.323/SIP device"},"patch":{"parameters":[{"description":"The device ID.","in":"path","name":"deviceId","required":true,"schema":{"type":"string","example":"abceHewahkrehwiK"}}],"responses":{"204":{"description":"**HTTP Status Code:** `204`<br>\nH.323/SIP device updated."},"300":{"description":"**Error Code:** `300`<br>\nH.323 Device does not exist: {deviceId}."},"404":{"description":"**HTTP Status Code:** `404`<br>\n**Error Code:** `2020`<br>\nH.323 device's display name:{displayName} is already in use.\n"}},"tags":["H323 Devices"],"description":"A H.323 or SIP device can make a video call to a [Room Connector](https://support.zoom.us/hc/en-us/articles/201363273-Getting-Started-With-H-323-SIP-Room-Connector) to join a Zoom cloud meeting. A Room Connector can also call out to a H.323 or SIP device to join a Zoom cloud meeting. Use this API to edit information of a H.323/SIP device from your Zoom account.<br><br>\n**Scopes:** `h323:write:admin`<br>\n <br>\n **[Rate Limit Label](https://developers.zoom.us/docs/api/rest/rate-limits/):** `Light`","operationId":"deviceUpdate","requestBody":{"content":{"application/json":{"schema":{"description":"The H.323/SIP device object.","properties":{"encryption":{"description":"Device encryption:<br>`auto` - auto.<br>`yes` - yes.<br>`no` - no.","enum":["auto","yes","no"],"type":"string","x-enum-descriptions":["auto","yes","no"],"example":"auto"},"ip":{"description":"Device IP.","type":"string","example":"127.0.0.1"},"name":{"description":"Device name.","maxLength":64,"type":"string","example":"api_test_20190508"},"protocol":{"description":"Device protocol:<br>`H.323` - H.323.<br>`SIP` - SIP.","enum":["H.323","SIP"],"type":"string","x-enum-descriptions":["H.323","SIP"],"example":"H.323"}},"required":["name","protocol","ip","encryption"],"title":"The H.323/SIP device object.","type":"object"}}},"required":true},"summary":"Update a H.323/SIP device"}},"/devices/{deviceId}/assignment":{"patch":{"parameters":[{"name":"deviceId","in":"path","description":"Unique identifier of the device.","required":true,"schema":{"type":"string","example":"F1C6E9DF-429E-4FA1-85DA-AC95464F3D18"}}],"responses":{"204":{"description":"**HTTP Status Code:** `204` **No Content**<br>\nRequest processed successfully."},"400":{"description":"**HTTP Status Code:** `400` <br>Bad Request<br>\n\n**Error Code:** `8500` <br>Device not enrolled in Zoom Device Management.\n\n**Error Code:** `8501` <br>Device does not support this app.\n\n**Error Code:** `8502` <br>Room does not support this app."},"404":{"description":"**HTTP Status Code:** `404` <br>Not Found<br>\n\n**Error Code:** `1012` <br>\nRoom does not exist: {roomId}.\n\n**Error Code:** `8503` <br>\nDevice does not exist: {deviceId}."}},"tags":["Devices"],"description":"This Device API lets you change device association from one Zoom Room to another. \n\n**Prerequisites:**\n* Device must be enrolled in ZMD (Zoom Device Management) \n\n**Scope:** `device:write:admin` <br>\n **[Rate Limit Label](https://developers.zoom.us/docs/api/rest/rate-limits/):** `Medium`","operationId":"changeDeviceAssociation","requestBody":{"required":true,"content":{"application/json":{"schema":{"required":["action"],"properties":{"room_id":{"description":"The Zoom Room ID which device is being associated to. The `room_id` is required when `assign` is selected for `action` field.","type":"string","example":"qMOLddnySIGGVycz8aX_JQ"},"app_type":{"description":"Specify one of the following values for this field:\n\n`ZR`: Zoom Room Computer.<br>\n`ZRC`: Zoom Room Controller.<br>\n`ZRP`: Scheduling Display.<br>\n`ZRW`: Companion Whiteboard.","enum":["ZR","ZRC","ZRP","ZRW"],"type":"string","example":"ZR","default":"ZR"}},"type":"object"}}}},"summary":"Change device association"}},"/im/groups":{"get":{"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"total_records":{"description":"Total number of records returned.","type":"integer","example":200},"groups":{"description":"List of group objects.","items":{"properties":{"id":{"description":"IM group ID.","type":"string","example":"MIuNMURBTkuwfZ20jteRJg"},"name":{"description":"Group name.","type":"string","example":"Developers"},"total_members":{"description":"Total number of members in this group.","type":"integer","example":200},"search_by_account":{"description":"Members can search for others under same account.","type":"boolean","example":true},"search_by_domain":{"description":"Members can search for others in the same email domain.","type":"boolean","example":true},"search_by_ma_account":{"description":"Members can search for others under same master account - including all sub accounts.","type":"boolean","example":true},"type":{"default":"normal","description":"IM Group types:<br>`normal` - Only members can see the other members in the group. Other people can search for members in the group.<br>`shared` - Everyone in the account can see the group and members. <br>`restricted` - No one except group members can see the group or search for other group members. ","enum":["normal","shared","restricted"],"type":"string","x-enum-descriptions":["Only members can see the group automatically. Other people can search members in the group.","All people in the account can see the group and members automatically","Nobody can see the group or search members except the members in the group"],"example":"normal"}},"type":"object","description":"IM group object."},"type":"array"}},"type":"object","description":"List of IM Groups.","title":"IM Group List"}}},"description":"**HTTP Status Code:** `200` <br>\nList of groups returned.\n**Error Code:** `200` <br>\nList of IM groups returned.<br>\nOnly available for paid account:{accountId}."},"404":{"description":"**HTTP Status Code:** `404` <br>\n**Error Code:** `4130` <br>\nGroup does not exist:{groupId}."}},"tags":["IM Groups"],"description":"List [IM directory groups](https://support.zoom.us/hc/en-us/articles/203749815-IM-Management).<br><br>\n**Scopes**: `imgroup:read:admin`<br>\n \n **[Rate Limit Label](https://developers.zoom.us/docs/api/rest/rate-limits/):** `Medium`","operationId":"imGroups","summary":"List IM directory groups"},"post":{"responses":{"200":{"description":"**Error Code:** `200` <br>\nOnly available for paid account:{accountId}."},"201":{"content":{"application/json":{"schema":{"properties":{"id":{"description":"Group ID.","type":"string","example":"MIuNMURBTkuwfZ20jteRJg"},"name":{"description":"Group name.","type":"string","example":"Developers"},"search_by_account":{"description":"Members can search for others under same account.","type":"boolean","example":true},"search_by_domain":{"description":"Members can search for others in the same email domain.","type":"boolean","example":true},"search_by_ma_account":{"description":"Members can search for others under same master account, including all sub accounts.","type":"boolean","example":true},"total_members":{"description":"Group member count.","type":"integer","example":200}},"type":"object"}},"new":{}},"description":"**HTTP Status Code:** `201`<br>\nIM Group created."},"404":{"description":"**HTTP Status Code:** `404` <br>\n**Error Code:** `4130` <br>\nGroup does not exist:{groupId}."},"409":{"description":"**HTTP Status Code:** `409` <br>\n**Error Code:** `4132` <br>\nGroup name {groupName} is already in use."}},"tags":["IM Groups"],"description":"Create an IM directory group under your account.<br><br>\n**Scopes**: `imgroup:write:admin`<br>\n \n **[Rate Limit Label](https://developers.zoom.us/docs/api/rest/rate-limits/):** `Light`","operationId":"imGroupCreate","requestBody":{"content":{"application/json":{"schema":{"properties":{"name":{"description":"Group name: must be unique to one account.","maxLength":128,"type":"string","example":"Developers"},"search_by_account":{"description":"Members can search for others under same account.","type":"boolean","example":true},"search_by_domain":{"description":"Members can search for others in the same email domain.","type":"boolean","example":true},"search_by_ma_account":{"description":"Members can search for others under same master account, including all sub accounts.","type":"boolean","example":true},"type":{"default":"normal","description":"IM Group types:<br>`normal` - Only members can see automatically see the other members of this group. Other people can search for members within this group. <br>`shared` - Everyone under an account can see the group members automatically.<br>`restricted` - Nobody can see the group or search for members except the members in the group.","enum":["normal","shared","restricted"],"type":"string","x-enum-descriptions":["Only members can see the group automatically. Other people can search members in the group.","All people in the account can see the group and members automatically","Nobody can see the group or search members except the members in the group"],"example":"normal"}},"type":"object"}}},"required":true},"summary":"Create an IM directory group"}},"/im/groups/{groupId}":{"delete":{"parameters":[{"description":"The group ID.<br>\nRetrieve by calling the [**List groups**](/docs/api-reference/zoom-api/methods#operation/groups) API.","in":"path","name":"groupId","required":true,"schema":{"type":"string","example":"SobVexyrQjqCkcxjpBWi6w"}}],"responses":{"204":{"description":"**HTTP Status Code:** `204` <br>\nIM group deleted.\n\n"},"300":{"description":"**Error Code:** `300` <br>\nMissing field: name."},"404":{"description":"**HTTP Status Code:** `404` <br>\nIM Group not found.\n**Error Code:** `4130` <br>\nGroup does not exist:{groupId}."}},"tags":["IM Groups"],"description":"Delete an [IM directory group](https://support.zoom.us/hc/en-us/articles/203749815-IM-Management) under your account.<br><br>\nScopes: `imgroup:write:admin`<br>\n \n **[Rate Limit Label](https://developers.zoom.us/docs/api/rest/rate-limits/):** `Light`","operationId":"imGroupDelete","summary":"Delete an IM directory group"},"get":{"parameters":[{"description":"The group ID.<br>\nRetrieve by calling the [**List groups**](/docs/api-reference/zoom-api/methods#operation/groups) API.","in":"path","name":"groupId","required":true,"schema":{"type":"string","example":"SobVexyrQjqCkcxjpBWi6w"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"id":{"description":"Group ID.","type":"string","example":"MIuNMURBTkuwfZ20jteRJg"},"name":{"description":"Group name.","type":"string","example":"Developers"},"total_members":{"description":"Total number of members in this group.","type":"integer","example":200},"search_by_account":{"description":"Members can search for others under same account.","type":"boolean","example":true},"search_by_domain":{"description":"Members can search for others in the same email domain.","type":"boolean","example":true},"search_by_ma_account":{"description":"Members can search for others under same master account - including all sub accounts.","type":"boolean","example":true},"type":{"default":"normal","description":"IM Group types:<br>`normal` - Only members can see the other members in the group. Other people can search for members in the group.<br>`shared` - Everyone in the account can see the group and members. <br>`restricted` - No one except group members can see the group or search for other group members. ","enum":["normal","shared","restricted"],"type":"string","x-enum-descriptions":["Only members can see the group automatically. Other people can search members in the group.","All people in the account can see the group and members automatically","Nobody can see the group or search members except the members in the group"],"example":"normal"}},"type":"object","description":"IM group object."}}},"description":"**HTTP Status Code:** `200` <br>\nIM group object returned.<br>\n**Error Code:** `200` <br>\nOnly available for paid account:{accountId}."},"300":{"description":"**Error Code:** `300` <br>\nMissing field: name."},"404":{"description":"**HTTP Status Code:** <br>\nIM Group not found.<br>\n**Error Code:** `4130` <br>\nGroup does not exist:{groupId}."}},"tags":["IM Groups"],"description":"Retrieve an [IM directory group](https://support.zoom.us/hc/en-us/articles/203749815-IM-Management) under your account.<br><br>\nScopes: `imgroup:read:admin`<br>\n\n **[Rate Limit Label](https://developers.zoom.us/docs/api/rest/rate-limits/):** `Light` ","operationId":"imGroup","summary":"Retrieve an IM directory group"},"patch":{"parameters":[{"description":"The group ID.<br>\nRetrieve by calling the [**List groups**](/docs/api-reference/zoom-api/methods#operation/groups) API.","in":"path","name":"groupId","required":true,"schema":{"type":"string","example":"SobVexyrQjqCkcxjpBWi6w"}}],"responses":{"204":{"description":"**HTTP Status Code:** `204` <br>\nIM group updated."},"300":{"description":"**Error Code:** `300` <br>\nMissing field: name"},"404":{"description":"**HTTP Status Code:** `404` <br>\nIM Group not found.\n**Error Code:** `4130`<br>\nGroup does not exist:{groupId}."}},"tags":["IM Groups"],"description":"Update an [IM directory group](https://support.zoom.us/hc/en-us/articles/203749815-IM-Management) under your account.<br><br>\n**Scopes**: `imgroup:write:admin`<br>\n\n **[Rate Limit Label](https://developers.zoom.us/docs/api/rest/rate-limits/):** `Light`","operationId":"imGroupUpdate","requestBody":{"content":{"application/json":{"schema":{"properties":{"name":{"description":"Group name: must be unique to one account.","maxLength":128,"type":"string","example":"Developers"},"search_by_account":{"description":"Members can search for others under same account.","type":"boolean","example":true},"search_by_domain":{"description":"Members can search for others in the same email domain.","type":"boolean","example":true},"search_by_ma_account":{"description":"Members can search for others under same master account, including all sub accounts.","type":"boolean","example":true},"type":{"description":"IM Group types:<br>`normal` - Only group members can automatically see others in their group. Other people can search for members in the group.<br>`shared` - Everyone under the account can see the group and members automatically.<br>`restricted` - Nobody can see the group or search for members except for the members in the group.","enum":["normal","shared","restricted"],"type":"string","x-enum-descriptions":["Only members can see the group automatically. Other people can search members in the group.","All people in the account can see the group and members automatically","Nobody can see the group or search members except the members in the group"],"example":"normal"}},"type":"object"}}},"required":true},"summary":"Update an IM directory group"}},"/im/groups/{groupId}/members":{"get":{"parameters":[{"description":"The group ID.<br>\nRetrieve by calling the [**List groups**](/docs/api-reference/zoom-api/methods#operation/groups) API.","in":"path","name":"groupId","required":true,"schema":{"type":"string","example":"SobVexyrQjqCkcxjpBWi6w"}},{"description":"The number of records returned within a single API call.","in":"query","name":"page_size","schema":{"default":30,"maximum":300,"type":"integer","example":30}},{"deprecated":true,"description":"**Deprecated.** We will no longer support this field in a future release. Instead, use the `next_page_token` for pagination.","in":"query","name":"page_number","schema":{"default":1,"type":"integer","example":1}},{"description":"Use the next page token to paginate through large result sets. A next page token is returned whenever the set of available results exceeds the current page size. This token's expiration period is 15 minutes.","in":"query","name":"next_page_token","schema":{"type":"string","example":"IAfJX3jsOLW7w3dokmFl84zOa0MAVGyMEB2"}}],"responses":{"200":{"content":{"application/json":{"schema":{"description":"List of group members.","properties":{"next_page_token":{"type":"string","description":"The next page token is used to paginate through large result sets. A next page token will be returned whenever the set of available results exceeds the current page size. The expiration period for this token is 15 minutes.","example":"w7587w4eiyfsudgf"},"page_count":{"type":"integer","description":"The number of pages returned for the request made.","example":1},"page_number":{"deprecated":true,"type":"integer","default":1,"description":"**Deprecated.** We will no longer support this field in a future release. Instead, use the `next_page_token` for pagination.","example":1},"page_size":{"type":"integer","maximum":300,"default":30,"description":"The number of records returned with a single API call.","example":30},"total_records":{"type":"integer","description":"The total number of all the records available across pages.","example":20},"members":{"description":"List of group member objects.","items":{"description":"Group member object.","properties":{"email":{"description":"User email.","type":"string","example":"jchill@example.com"},"first_name":{"description":"User first name.","type":"string","example":"Jill"},"id":{"description":"User ID.","type":"string","example":"v4iyWT1LTfy8QvPG4GTvdg"},"last_name":{"description":"User last name.","type":"string","example":"Chill"},"type":{"description":"User type.<br>\n`1` - Basic<br> `2` - Licensed<br>","type":"integer","example":1}},"type":"object"},"type":"array"}},"type":"object","title":"Group Member List"}}},"description":"**HTTP Status Code:** `200` <br>\nIM group member list returned.<br>\n**Error Code:** `200` <br> \nOnly available for paid account:{accountId}."},"300":{"description":"**Error Code:** `300` <br>\nMissing field: name."},"404":{"description":"**HTTP Status Code:** `404` <br>\nIM Group not found."}},"security":[{"OAuth":[]}],"tags":["IM Groups"],"description":"List the members of an [IM directory group](https://support.zoom.us/hc/en-us/articles/203749815-IM-Management).<br><br>\n**Scope:** `imgroup:read:admin`<br>\n\n **[Rate Limit Label](https://developers.zoom.us/docs/api/rest/rate-limits/):** `Medium`","operationId":"imGroupMembers","summary":"List IM directory group members"},"post":{"parameters":[{"description":"The group ID.<br>\nRetrieve by calling the [**List groups**](/docs/api-reference/zoom-api/methods#operation/groups) API.","in":"path","name":"groupId","required":true,"schema":{"type":"string","example":"SobVexyrQjqCkcxjpBWi6w"}}],"responses":{"200":{"description":"**Error Code:** `200` <br>\nOnly available for paid account:{accountId}."},"201":{"content":{"application/json":{"schema":{"properties":{"added_at":{"format":"date-time","type":"string","example":"2022-03-25T03:08:12Z"},"ids":{"type":"string","example":"v4iyWT1LTfy8QvPG4GTvdg"}},"type":"object"}}},"description":"**HTTP Status Code:** `201` <br>\nMember added."},"300":{"description":"**Error Code:** `300` <br>\nMissing field: name."},"404":{"description":"**HTTP Status Code:** `404` <br>\nIM Group not found"}},"security":[{"OAuth":[]}],"tags":["IM Groups"],"description":"Add members to an [IM directory group](https://support.zoom.us/hc/en-us/articles/203749815-IM-Management) under an account.<br><br>\n**Scope:** `imgroup:write:admin`<br>\n\n **[Rate Limit Label](https://developers.zoom.us/docs/api/rest/rate-limits/):** `Medium`","operationId":"imGroupMembersCreate","requestBody":{"content":{"application/json":{"schema":{"properties":{"members":{"description":"List of IM group members.","items":{"properties":{"email":{"description":"User email. If the user ID is given then ignore the user email. ","type":"string","example":"jchill@example.com"},"id":{"description":"User ID.","type":"string","example":"v4iyWT1LTfy8QvPG4GTvdg"}},"type":"object"},"maximum":10,"type":"array"}},"type":"object"}}},"required":true},"summary":"Add IM directory group members"}},"/im/groups/{groupId}/members/{memberId}":{"delete":{"parameters":[{"description":"The group ID.<br>\nRetrieve by calling the [**List groups**](/docs/api-reference/zoom-api/methods#operation/groups) API.","in":"path","name":"groupId","required":true,"schema":{"type":"string","example":"SobVexyrQjqCkcxjpBWi6w"}},{"description":"The member ID.","in":"path","name":"memberId","required":true,"schema":{"type":"string","example":"v4iyWT1LTfy8QvPG4GTvdg"}}],"responses":{"200":{"description":"**Error Code:** `200` <br>\nOnly available for paid account, {accountId}."},"204":{"description":"**HTTP Status Code:** `204` <br>\nIM group member deleted."},"300":{"description":"**Error Code:** `300` <br>\nMissing field: name.<br>\nCan not delete account from default group:{groupId}."},"404":{"description":"**HTTP Status Code:** `404` <br>\nIM Group or IM Group member not found.<br>\n**Error Code:** `4130` <br>\nGroup does not exist:{groupId}."}},"security":[{"OAuth":[]}],"tags":["IM Groups"],"description":"Delete a member from an [IM directory group](https://support.zoom.us/hc/en-us/articles/203749815-IM-Management) under an account.<br><br>\nScopes: `imgroup:write:admin`<br>\n \n **[Rate Limit Label](https://developers.zoom.us/docs/api/rest/rate-limits/):** `Light`","operationId":"imGroupMembersDelete","summary":"Delete IM directory group member"}},"/users/{userId}/meetings":{"get":{"parameters":[{"name":"userId","in":"path","description":"The user ID or email address of the user. For user-level apps, pass the `me` value.","required":true,"schema":{"oneOf":[{"type":"string","example":"6dfgdfgdg444447b0egga"},{"type":"string","format":"email","example":"jchill@example.com"},{"type":"string","enum":["me"],"example":"me"}]}},{"description":"The type of meeting: \n* `scheduled` — All valid previous (unexpired) meetings, live meetings, and upcoming scheduled meetings. \n* `live` — All the ongoing meetings. \n* `upcoming` — All upcoming meetings, including live meetings. \n* `upcoming_meetings` — All upcoming meetings, including live meetings. \n* `previous_meetings` — All the previous meetings.","in":"query","name":"type","schema":{"type":"string","default":"scheduled","enum":["scheduled","live","upcoming","upcoming_meetings","previous_meetings"],"example":"scheduled"}},{"description":"The number of records returned within a single API call.","in":"query","name":"page_size","schema":{"default":30,"maximum":300,"type":"integer","example":30}},{"description":"Use the next page token to paginate through large result sets. A next page token is returned whenever the set of available results exceeds the current page size. This token's expiration period is 15 minutes.","in":"query","name":"next_page_token","schema":{"type":"string","example":"IAfJX3jsOLW7w3dokmFl84zOa0MAVGyMEB2"}},{"description":"The page number of the current page in the returned records.","in":"query","name":"page_number","schema":{"type":"integer","example":1}},{"description":"The start date.","in":"query","name":"from","schema":{"format":"date","type":"string","example":"2023-01-01"}},{"description":"The end data.","in":"query","name":"to","schema":{"format":"date","type":"string","example":"2023-01-16"}}],"responses":{"200":{"content":{"application/json":{"schema":{"description":"List of meetings.","properties":{"next_page_token":{"description":"Use the next page token to paginate through large result sets. A next page token will be returned whenever the set of available results exceeds the current page size. This token's expiration period is 15 minutes.","type":"string","example":"Tva2CuIdTgsv8wAnhyAdU3m06Y2HuLQtlh3"},"page_count":{"description":"The number of pages returned for the request made.","type":"integer","example":1},"page_number":{"default":1,"description":"The page number of the current results.","type":"integer","example":1},"page_size":{"default":30,"description":"The number of records returned with a single API call.","maximum":300,"type":"integer","example":30},"total_records":{"description":"The total number of all the records available across pages.","type":"integer","example":1},"meetings":{"description":"List of Meeting objects.","items":{"properties":{"agenda":{"description":"Meeting description. The length of agenda gets truncated to 250 characters when you list all meetings for a user. To view the complete agenda of a meeting, retrieve details for a single meeting, use the [**Get a meeting**](/docs/api-reference/zoom-api/methods#operation/meeting) API.","type":"string","example":"My Meeting"},"created_at":{"description":"Time of creation. ","format":"date-time","type":"string","example":"2022-03-23T05:31:16Z"},"duration":{"description":"Meeting duration.","type":"integer","example":60},"host_id":{"description":"ID of the user who is set as the host of the meeting.","type":"string","example":"30R7kT7bTIKSNUFEuH_Qlg"},"id":{"description":"Meeting ID - also known as the meeting number in long (int64) format.","format":"int64","type":"integer","example":97763643886},"join_url":{"description":"URL using which participants can join a meeting.","type":"string","example":"https://example.com/j/11111"},"pmi":{"description":"[Personal meeting ID](https://marketplace.zoom.us/docs/api-reference/using-zoom-apis/#understanding-personal-meeting-id-pmi). This field is only returned if PMI was used to schedule the meeting.","type":"string","example":"97891943927"},"start_time":{"description":"Meeting start time.","format":"date-time","type":"string","example":"2022-03-23T06:00:00Z"},"timezone":{"description":"Timezone to format the meeting start time. ","type":"string","example":"America/Los_Angeles"},"topic":{"description":"Meeting topic.","type":"string","example":"My Meeting"},"type":{"description":"Meeting Types:<br>`1` - Instant meeting.<br>`2` - Scheduled meeting.<br>`3` - Recurring meeting with no fixed time.<br>`8` - Recurring meeting with fixed time.","enum":[1,2,3,8],"type":"integer","x-enum-descriptions":["Instant Meeting","Scheduled Meeting","Recurring Meeting with no fixed time","Recurring Meeting with fixed time"],"example":2},"uuid":{"description":"Unique Meeting ID. Each meeting instance will generate its own Meeting UUID.","type":"string","example":"aDYlohsHRtCd4ii1uC2+hA=="}},"type":"object"},"type":"array"}},"type":"object","title":"Group List"}}},"description":"**HTTP Status Code:** `200`<br>\nList of meeting objects returned."},"400":{"description":"**HTTP Status Code:** `400` <br>\n Bad Request \n\n **Error Code:** `3161` <br>\nMeeting hosting and scheduling capabilities are not allowed for your user account."},"404":{"description":"**HTTP Status Code:** `404`<br>\nUser ID not found.<br>\n**Error Code:** `1001`<br>\nUser {userId} not exist or not belong to this account.<br>"}},"security":[{"OAuth":[]}],"tags":["Meetings"],"description":"List a user's (meeting host) scheduled meetings. For user-level apps, pass [the `me` value](https://marketplace.zoom.us/docs/api-reference/using-zoom-apis#mekeyword) instead of the `userId` parameter. \n\n**Note:** \n* This API **only** supports scheduled meetings. This API does not return information about instant meetings. \n* This API only returns a user's [unexpired meetings](https://support.zoom.us/hc/en-us/articles/201362373-Meeting-ID#h_c73f9b08-c1c0-4a1a-b538-e01ebb98e844). \n\n **Scopes:** `meeting:read:admin`, `meeting:read` </br> **[Rate Limit Label](https://developers.zoom.us/docs/api/rest/rate-limits/):** `Medium`","operationId":"meetings","summary":"List meetings"},"post":{"parameters":[{"name":"userId","in":"path","description":"The user ID or email address of the user. For user-level apps, pass the `me` value.","required":true,"schema":{"oneOf":[{"type":"string","example":"6dfgdfgdg444447b0egga"},{"type":"string","format":"email","example":"jchill@example.com"},{"type":"string","enum":["me"],"example":"me"}]}}],"responses":{"201":{"content":{"application/json":{"schema":{"properties":{"assistant_id":{"description":"The ID of the user who scheduled this meeting on behalf of the host.","type":"string","example":"kFFvsJc-Q1OSxaJQLvaa_A"},"host_email":{"description":"Email address of the meeting host.","format":"email","type":"string","example":"jchill@example.com"},"id":{"description":"[Meeting ID](https://support.zoom.us/hc/en-us/articles/201362373-What-is-a-Meeting-ID-): Unique identifier of the meeting in \"**long**\" format(represented as int64 data type in JSON), also known as the meeting number.","format":"int64","type":"integer","example":92674392836},"registration_url":{"description":"URL using which registrants can register for a meeting. This field is only returned for meetings that have enabled registration.","type":"string","example":"https://example.com/meeting/register/7ksAkRCoEpt1Jm0wa-E6lICLur9e7Lde5oW6"},"agenda":{"description":"Agenda","type":"string","example":"My Meeting"},"created_at":{"description":"The date and time at which this meeting was created.","format":"date-time","type":"string","example":"2022-03-25T07:29:29Z"},"duration":{"description":"Meeting duration.","type":"integer","example":60},"h323_password":{"description":"H.323/SIP room system password","type":"string","example":"123456"},"join_url":{"description":"URL for participants to join the meeting. This URL should only be shared with users that you would like to invite for the meeting.","type":"string","example":"https://example.com/j/11111"},"occurrences":{"description":"Array of occurrence objects.","items":{"description":"Occurrence object. This object is only returned for Recurring Webinars.","properties":{"duration":{"description":"Duration.","type":"integer","example":60},"occurrence_id":{"description":"Occurrence ID: Unique Identifier that identifies an occurrence of a recurring webinar. [Recurring webinars](https://support.zoom.us/hc/en-us/articles/216354763-How-to-Schedule-A-Recurring-Webinar) can have a maximum of 50 occurrences.","type":"string","example":"1648194360000"},"start_time":{"description":"Start time.","format":"date-time","type":"string","example":"2022-03-25T07:46:00Z"},"status":{"description":"Occurrence status.","type":"string","example":"available"}},"type":"object"},"type":"array"},"password":{"description":"Meeting password. Password may only contain the following characters: `[a-z A-Z 0-9 @ - _ * !]`\n\nIf \"Require a password when scheduling new meetings\" setting has been **enabled** **and** [locked](https://support.zoom.us/hc/en-us/articles/115005269866-Using-Tiered-Settings#locked) for the user, the password field will be autogenerated in the response even if it is not provided in the API request. \n\n\n","type":"string","example":"123456"},"pmi":{"description":"[Personal Meeting ID (PMI)](https://marketplace.zoom.us/docs/api-reference/using-zoom-apis#understanding-personal-meeting-id-pmi). Only used for scheduled meetings and recurring meetings with no fixed time.","type":"string","example":"97891943927"},"pre_schedule":{"default":false,"description":"Whether the prescheduled meeting was created via the [GSuite app](https://support.zoom.us/hc/en-us/articles/360020187492-Zoom-for-GSuite-add-on). This **only** supports the meeting `type` value of `2` (scheduled meetings) and `3` (recurring meetings with no fixed time): \n* `true` — A GSuite prescheduled meeting. \n* `false` — A regular meeting.","type":"boolean","example":false},"recurrence":{"description":"Recurrence object. Use this object only for a meeting with type `8` i.e., a recurring meeting with fixed time. ","properties":{"end_date_time":{"description":"Select the final date on which the meeting will recur before it is canceled. Should be in UTC time, such as 2017-11-25T12:00:00Z. (Cannot be used with \"end_times\".)","format":"date-time","type":"string","example":"2022-04-02T15:59:00Z"},"end_times":{"default":1,"description":"Select how many times the meeting should recur before it is canceled. The default recurrence is 50 times. To support meetings recurring more than 50 times, contact Zoom support. Cannot be used with \"end_date_time\".","maximum":365,"type":"integer","example":7},"monthly_day":{"default":1,"description":"Use this field **only if you're scheduling a recurring meeting of type** `3` to state which day in a month, the meeting should recur. The value range is from 1 to 31.\n\nFor instance, if you would like the meeting to recur on 23rd of each month, provide `23` as the value of this field and `1` as the value of the `repeat_interval` field. Instead, if you would like the meeting to recur every three months, on 23rd of the month, change the value of the `repeat_interval` field to `3`.","type":"integer","example":1},"monthly_week":{"description":"Use this field **only if you're scheduling a recurring meeting of type** `3` to state the week of the month when the meeting should recur. If you use this field, **you must also use the `monthly_week_day` field to state the day of the week when the meeting should recur.** <br>`-1` - Last week of the month.<br>`1` - First week of the month.<br>`2` - Second week of the month.<br>`3` - Third week of the month.<br>`4` - Fourth week of the month.","enum":[-1,1,2,3,4],"type":"integer","x-enum-descriptions":["Last week","First week","Second week","Third week","Fourth week"],"example":1},"monthly_week_day":{"description":"Use this field **only if you're scheduling a recurring meeting of type** `3` to state a specific day in a week when the monthly meeting should recur. To use this field, you must also use the `monthly_week` field. \n\n<br>`1` - Sunday.<br>`2` - Monday.<br>`3` - Tuesday.<br>`4` -  Wednesday.<br>`5` - Thursday.<br>`6` - Friday.<br>`7` - Saturday.","enum":[1,2,3,4,5,6,7],"type":"integer","x-enum-descriptions":["Sunday","Monday","Tuesday","Wednesday","Thursday","Friday","Saturday"],"example":1},"repeat_interval":{"description":"Define the interval at which the meeting should recur. For instance, if you would like to schedule a meeting that recurs every two months, you must set the value of this field as `2` and the value of the `type` parameter as `3`. \n\nFor a daily meeting, the maximum interval you can set is `90` days. For a weekly meeting the maximum interval that you can set is  of `12` weeks. For a monthly meeting, there is a maximum of `3` months.\n\n","type":"integer","example":1},"type":{"description":"Recurrence meeting types:<br>`1` - Daily.<br>`2` - Weekly.<br>`3` - Monthly.","enum":[1,2,3],"type":"integer","x-enum-descriptions":["Daily","Weekly","Monthly"],"example":1},"weekly_days":{"type":"string","default":"1","description":"This field is required **if you're scheduling a recurring meeting of type** `2` to state which day(s) of the week the meeting should repeat. <br> <br> The value for this field could be a number between `1` to `7` in string format. For instance, if the meeting should recur on Sunday, provide `\"1\"` as the value of this field.<br><br> **Note:** If you would like the meeting to occur on multiple days of a week, you should provide comma separated values for this field. For instance, if the meeting should recur on Sundays and Tuesdays provide `\"1,3\"` as the value of this field.\n\n <br>`1`  - Sunday. <br>`2` - Monday.<br>`3` - Tuesday.<br>`4` -  Wednesday.<br>`5` -  Thursday.<br>`6` - Friday.<br>`7` - Saturday.","enum":["1","2","3","4","5","6","7"],"example":"1"}},"required":["type"],"type":"object"},"settings":{"description":"Meeting settings.","properties":{"allow_multiple_devices":{"description":"Allow attendees to join the meeting from multiple devices. This setting only works for meetings that require [registration](https://support.zoom.us/hc/en-us/articles/211579443-Setting-up-registration-for-a-meeting).","type":"boolean","example":true},"alternative_hosts":{"description":"A semicolon-separated list of the meeting's alternative hosts' email addresses or IDs.","type":"string","example":"jchill@example.com;thill@example.com"},"alternative_hosts_email_notification":{"default":true,"description":"Flag to determine whether to send email notifications to alternative hosts, default value is true.","type":"boolean","example":true},"alternative_host_update_polls":{"type":"boolean","description":"Whether the **Allow alternative hosts to add or edit polls** feature is enabled. This requires Zoom version 5.8.0 or higher.","example":true},"approval_type":{"default":2,"description":"Enable registration and set approval for the registration. Note that this feature requires the host to be of **Licensed** user type. **Registration cannot be enabled for a basic user.** <br><br>\n\n`0` - Automatically approve.<br>`1` - Manually approve.<br>`2` - No registration required.","enum":[0,1,2],"type":"integer","x-enum-descriptions":["Automatically Approve","Manually Approve","No Registration Required"],"example":0},"approved_or_denied_countries_or_regions":{"description":"Approve or block users from specific regions/countries from joining this meeting. \n","properties":{"approved_list":{"description":"List of countries/regions from where participants can join this meeting. ","items":{"type":"string","example":"CX"},"type":"array"},"denied_list":{"description":"List of countries/regions from where participants can not join this meeting. ","items":{"type":"string","example":"CA"},"type":"array"},"enable":{"description":"`true`: Setting enabled to either allow users or block users from specific regions to join your meetings. <br>\n\n`false`: Setting disabled.","type":"boolean","example":true},"method":{"description":"Specify whether to allow users from specific regions to join this meeting; or block users from specific regions from joining this meeting. <br><br>\n`approve`: Allow users from specific regions/countries to join this meeting. If this setting is selected, the approved regions/countries must be included in the `approved_list`.<br><br>\n`deny`: Block users from specific regions/countries from joining this meeting. If this setting is selected, the approved regions/countries must be included in the `denied_list`","enum":["approve","deny"],"type":"string","example":"approve"}},"type":"object"},"audio":{"default":"both","description":"Determine how participants can join the audio portion of the meeting.<br>`both` - Both Telephony and VoIP.<br>`telephony` - Telephony only.<br>`voip` - VoIP only.<br>`thirdParty` - Third party audio conference.","enum":["both","telephony","voip","thirdParty"],"type":"string","x-enum-descriptions":["Both Telephony and VoIP","Telephony only","VoIP only","Third party audio conference"],"example":"telephony"},"audio_conference_info":{"description":"Third party audio conference info.","type":"string","maxLength":2048,"example":"test"},"authentication_domains":{"description":"If user has configured [\"Sign Into Zoom with Specified Domains\"](https://support.zoom.us/hc/en-us/articles/360037117472-Authentication-Profiles-for-Meetings-and-Webinars#h_5c0df2e1-cfd2-469f-bb4a-c77d7c0cca6f) option, this will list the domains that are authenticated.","type":"string","example":"example.com"},"authentication_exception":{"description":"The participants added here will receive unique meeting invite links and bypass authentication.","items":{"properties":{"email":{"description":"Email address of the participant.","format":"email","type":"string","example":"jchill@example.com"},"name":{"description":"Name of the participant.","type":"string","example":"Jill Chill"},"join_url":{"description":"URL for participants to join the meeting","type":"string","example":"https://example.com/s/11111"}},"type":"object"},"type":"array"},"authentication_name":{"description":"Authentication name set in the [authentication profile](https://support.zoom.us/hc/en-us/articles/360037117472-Authentication-Profiles-for-Meetings-and-Webinars#h_5c0df2e1-cfd2-469f-bb4a-c77d7c0cca6f).","type":"string","example":"Sign in to Zoom"},"authentication_option":{"description":"Meeting authentication option id.","type":"string","example":"signIn_D8cJuqWVQ623CI4Q8yQK0Q"},"auto_recording":{"default":"none","description":"Automatic recording:<br>`local` - Record on local.<br>`cloud` -  Record on cloud.<br>`none` - Disabled.","enum":["local","cloud","none"],"type":"string","x-enum-descriptions":["Record to local device","Record to cloud","No Recording"],"example":"cloud"},"breakout_room":{"description":"Setting to [pre-assign breakout rooms](https://support.zoom.us/hc/en-us/articles/360032752671-Pre-assigning-participants-to-breakout-rooms#h_36f71353-4190-48a2-b999-ca129861c1f4).","properties":{"enable":{"description":"Set the value of this field to `true` if you would like to enable the [breakout room pre-assign](https://support.zoom.us/hc/en-us/articles/360032752671-Pre-assigning-participants-to-breakout-rooms#h_36f71353-4190-48a2-b999-ca129861c1f4) option.","type":"boolean","example":true},"rooms":{"description":"Create room(s).","items":{"properties":{"name":{"description":"Name of the breakout room.","type":"string","example":"room1"},"participants":{"description":"Email addresses of the participants who are to be assigned to the breakout room.","items":{"type":"string","example":"jchill@example.com"},"type":"array"}},"type":"object"},"type":"array"}},"type":"object"},"calendar_type":{"description":"Indicates the type of calendar integration used to schedule the meeting: \n* `1` — [Zoom Outlook add-in](https://support.zoom.us/hc/en-us/articles/360031592971-Getting-started-with-Outlook-plugin-and-add-in) \n* `2` — [Zoom for Google Workspace add-on](https://support.zoom.us/hc/en-us/articles/360020187492-Using-the-Zoom-for-Google-Workspace-add-on)\n\nWorks with the `private_meeting` field to determine whether to share details of meetings or not.","enum":[1,2],"type":"integer","x-enum-descriptions":["Outlook","Google Calendar"],"example":1},"close_registration":{"default":false,"description":"Close registration after event date","type":"boolean","example":false},"cn_meeting":{"type":"boolean","default":false,"deprecated":true,"description":"Host meeting in China.","example":false},"contact_email":{"description":"Contact email for registration","type":"string","example":"jchill@example.com"},"contact_name":{"description":"Contact name for registration","type":"string","example":"Jill Chill"},"custom_keys":{"description":"Custom keys and values assigned to the meeting.","items":{"properties":{"key":{"description":"Custom key associated with the user.","maxLength":64,"type":"string","example":"key1"},"value":{"description":"Value of the custom key associated with the user.","maxLength":256,"type":"string","example":"value1"}},"type":"object"},"maxItems":10,"type":"array"},"email_notification":{"default":true,"description":"Whether to send email notifications to [alternative hosts](https://support.zoom.us/hc/en-us/articles/208220166) and [users with scheduling privileges](https://support.zoom.us/hc/en-us/articles/201362803-Scheduling-privilege). This value defaults to `true`.","type":"boolean","example":true},"encryption_type":{"description":"Choose between enhanced encryption and [end-to-end encryption](https://support.zoom.us/hc/en-us/articles/360048660871) when starting or a meeting. When using end-to-end encryption, several features (e.g. cloud recording, phone/SIP/H.323 dial-in) will be **automatically disabled**. <br><br>The value of this field can be one of the following:<br>\n`enhanced_encryption`: Enhanced encryption. Encryption is stored in the cloud if you enable this option. <br>\n\n`e2ee`: [End-to-end encryption](https://support.zoom.us/hc/en-us/articles/360048660871). The encryption key is stored in your local device and can not be obtained by anyone else. Enabling this setting also **disables** the following features: join before host, cloud recording, streaming, live transcription, breakout rooms, polling, 1:1 private chat, and meeting reactions.","enum":["enhanced_encryption","e2ee"],"type":"string","example":"enhanced_encryption"},"enforce_login":{"deprecated":true,"description":"Only signed in users can join this meeting.\n\n**This field is deprecated and will not be supported in the future.**  <br><br>As an alternative, use the \"meeting_authentication\", \"authentication_option\" and \"authentication_domains\" fields to understand the [authentication configurations](https://support.zoom.us/hc/en-us/articles/360037117472-Authentication-Profiles-for-Meetings-and-Webinars) set for the meeting.","type":"boolean","example":true},"enforce_login_domains":{"deprecated":true,"description":"Only signed in users with specified domains can join meetings.\n\n**This field is deprecated and will not be supported in the future.**  <br><br>As an alternative, use the \"meeting_authentication\", \"authentication_option\" and \"authentication_domains\" fields to understand the [authentication configurations](https://support.zoom.us/hc/en-us/articles/360037117472-Authentication-Profiles-for-Meetings-and-Webinars) set for the meeting.","type":"string","example":"example.com"},"focus_mode":{"description":"Whether the [**Focus Mode** feature](https://support.zoom.us/hc/en-us/articles/360061113751-Using-focus-mode) is enabled when the meeting starts.","type":"boolean","example":true},"global_dial_in_countries":{"description":"List of global dial-in countries","items":{"type":"string","example":"US"},"type":"array"},"global_dial_in_numbers":{"description":"Global Dial-in Countries/Regions","items":{"properties":{"city":{"description":"City of the number, if any. For example, Chicago.","type":"string","example":"New York"},"country":{"description":"Country code. For example, BR.","type":"string","example":"US"},"country_name":{"description":"Full name of country. For example, Brazil.","type":"string","example":"US"},"number":{"description":"Phone number. For example, +1 2332357613.","type":"string","example":"+1 1000200200"},"type":{"description":"Type of number. ","enum":["toll","tollfree"],"type":"string","example":"toll"}},"type":"object"},"type":"array"},"host_video":{"description":"Start video when the host joins the meeting.","type":"boolean","example":true},"in_meeting":{"type":"boolean","default":false,"deprecated":true,"description":"Host meeting in India.","example":false},"jbh_time":{"description":"If the value of \"join_before_host\" field is set to true, this field can be used to indicate time limits within which a participant may join a meeting before a host. The value of this field can be one of the following:\n\n*  `0`: Allow participant to join anytime.\n*  `5`: Allow participant to join 5 minutes before meeting start time.\n * `10`: Allow participant to join 10 minutes before meeting start time.","enum":[0,5,10],"type":"integer","example":0},"join_before_host":{"default":false,"description":"Allow participants to join the meeting before the host starts the meeting. Only used for scheduled or recurring meetings.","type":"boolean","example":true},"language_interpretation":{"description":"The meeting's [language interpretation settings](https://support.zoom.us/hc/en-us/articles/360034919791-Language-interpretation-in-meetings-and-webinars). Make sure to add the language in the web portal in order to use it in the API. See link for details. \n\n**Note:** This feature is only available for certain Meeting add-on, Education, and Business and higher plans. If this feature is not enabled on the host's account, this setting will **not** be applied to the meeting.","properties":{"enable":{"description":"Whether to enable [language interpretation](https://support.zoom.us/hc/en-us/articles/360034919791-Language-interpretation-in-meetings-and-webinars) for the meeting.","type":"boolean","example":true},"interpreters":{"description":"Information about the meeting's language interpreters.","items":{"properties":{"email":{"description":"The interpreter's email address.","format":"email","type":"string","example":"interpreter@example.com"},"languages":{"description":"A comma-separated list of the interpreter's languages. The string must contain two [country IDs](https://marketplace.zoom.us/docs/api-reference/other-references/abbreviation-lists#countries). \n\nFor example, if the interpreter will translate from English to Chinese, then this value will be `US,CN`.","type":"string","example":"US,FR"}},"type":"object"},"type":"array"}},"type":"object"},"meeting_authentication":{"description":"`true`- Only authenticated users can join meetings.","type":"boolean","example":true},"mute_upon_entry":{"default":false,"description":"Mute participants upon entry.","type":"boolean","example":false},"participant_video":{"description":"Start video when participants join the meeting.","type":"boolean","example":false},"private_meeting":{"description":"Whether the meeting is set as private.","type":"boolean","example":false},"registrants_confirmation_email":{"description":"Whether to send registrants an email confirmation:\n* `true` — Send a confirmation email.\n* `false` — Do not send a confirmation email.","type":"boolean","example":true},"registrants_email_notification":{"description":"Whether to send registrants email notifications about their registration approval, cancellation, or rejection:\n\n* `true` — Send an email notification.\n* `false` — Do not send an email notification.\n\n Set this value to `true` to also use the `registrants_confirmation_email` parameter.","type":"boolean","example":true},"registration_type":{"default":1,"description":"Registration type. Used for recurring meeting with fixed time only. <br>`1` Attendees register once and can attend any of the occurrences.<br>`2` Attendees need to register for each occurrence to attend.<br>`3` Attendees register once and can choose one or more occurrences to attend.","enum":[1,2,3],"type":"integer","x-enum-descriptions":["Attendees register once and can attend any of the occurrences","Attendees need to register for each occurrence to attend","Attendees register once and can choose one or more occurrences to attend"],"example":1},"show_share_button":{"description":"Show social share buttons on the meeting registration page.\nThis setting only works for meetings that require [registration](https://support.zoom.us/hc/en-us/articles/211579443-Setting-up-registration-for-a-meeting).","type":"boolean","example":true},"use_pmi":{"default":false,"description":"Use a [Personal Meeting ID (PMI)](https://marketplace.zoom.us/docs/api-reference/using-zoom-apis#understanding-personal-meeting-id-pmi). Only used for scheduled meetings and recurring meetings with no fixed time.","type":"boolean","example":false},"waiting_room":{"default":false,"description":"Enable waiting room","type":"boolean","example":false},"watermark":{"default":false,"description":"Add watermark when viewing a shared screen.","type":"boolean","example":false},"host_save_video_order":{"type":"boolean","description":"Whether the **Allow host to save video order** feature is enabled.","example":true}},"type":"object"},"start_time":{"description":"Meeting start date-time in UTC/GMT. Example: \"2020-03-31T12:02:00Z\"","format":"date-time","type":"string","example":"2022-03-25T07:29:29Z"},"start_url":{"description":"URL to start the meeting. This URL should only be used by the host of the meeting and **should not be shared with anyone other than the host** of the meeting as anyone with this URL will be able to login to the Zoom Client as the host of the meeting.","type":"string","example":"https://example.com/s/11111"},"timezone":{"description":"Timezone to format start_time","type":"string","example":"America/Los_Angeles"},"topic":{"description":"Meeting topic","maxLength":200,"type":"string","example":"My Meeting"},"tracking_fields":{"description":"Tracking fields","items":{"properties":{"field":{"description":"Label of the tracking field.","type":"string","example":"field1"},"value":{"description":"Value for the field.","type":"string","example":"value1"},"visible":{"description":"Indicates whether the [tracking field](https://support.zoom.us/hc/en-us/articles/115000293426-Scheduling-Tracking-Fields) is visible in the meeting scheduling options in the Zoom Web Portal or not.\n\n`true`: Tracking field is visible. <br>\n\n`false`: Tracking field is not visible to the users in the meeting options in the Zoom Web Portal but the field was used while scheduling this meeting via API. An invisible tracking field can be used by users while scheduling meetings via API only. ","type":"boolean","example":true}},"type":"object"},"type":"array"},"type":{"default":2,"description":"Meeting Type","enum":[1,2,3,8],"type":"integer","x-enum-descriptions":["Instant Meeting","Scheduled Meeting","Recurring Meeting with no fixed time","Recurring Meeting with fixed time"],"example":2}},"type":"object","description":"Meeting object"}}},"description":"**HTTP Status Code:** `201`<br>\nMeeting created."},"400":{"description":"**HTTP Status Code:** `400` **Bad Request**<br>\n**Error Code:** `3000`<br> \n* Instant meetings do not support the schedule_for parameter; you cannot schedule an instant meeting for another user.<br>\n* Users in '{0}' have been blocked from joining meetings and webinars. To unblock them, go to the Settings page in the Zoom web portal and update 'Block users in specific domains from joining meetings and webinars'.<br> \n* You cannot schedule a meeting for {0}. \n\n **Error Code:** `3161` <br>\nMeeting hosting and scheduling capabilities are not allowed for your user account. \n\n **Error Code:** `300` <br> \n* The value that you entered for the schedule_for field is invalid. Enter a valid value and try again. <br> \n* Invalid enforce_login_domains, separate multiple domains by semicolon."},"404":{"description":"**HTTP Status Code:** `404` **Not Found**<br>\nUser not found.<br>\n\n**Error Code:** `1001`<br> User {userId} not exist or not belong to this account.\n"},"429":{"description":"**HTTP Status Code:** `429` <br>\n You have exceeded the daily rate limit ({rateLimitNumber}) of Meeting Create/Update API requests permitted for this particular user. You may resume these requests at GMT 00:00:00."}},"tags":["Meetings"],"description":"[Create a meeting](https://support.zoom.us/hc/en-us/articles/201362413-Scheduling-meetings) for a user. For user-level apps, pass [the `me` value](https://marketplace.zoom.us/docs/api-reference/using-zoom-apis#mekeyword) instead of the `userId` parameter.\n\n* A meeting's `start_url` value is the URL a host or an alternative host can use to start a meeting. The expiration time for the `start_url` value is **two hours** for all regular users.\n* For `custCreate` meeting hosts (users created with the `custCreate` parameter via the [**Create users**](/api-reference/zoom-api/methods#operation/userCreate) API), the expiration time of the `start_url` parameter is **90 days** from the generation of the `start_url`.\n\n**Note:** \n\nFor security reasons, the recommended way to programmatically (after expiry) get the updated `start_url` value is to call the [**Get a meeting**](/api-reference/zoom-api/methods#operation/meeting) API. Refer to the `start_url` value in the response. \n\n **Scopes:** `meeting:write:admin`, `meeting:write`\n\n**[Rate Limit Label](https://developers.zoom.us/docs/api/rest/rate-limits/):** `Medium` <br>\n* This API has a daily rate limit of **100 requests per day**. The rate limit is applied against the `userId` of the **meeting host** used to make the request.","operationId":"meetingCreate","requestBody":{"content":{"application/json":{"schema":{"description":"The base meeting object.","properties":{"agenda":{"description":"The meeting's agenda. This value has a maximum length of 2,000 characters.","maxLength":2000,"type":"string","example":"My Meeting"},"default_password":{"default":false,"description":"Whether to generate a default password using the user's settings. This value defaults to `false`. \n\nIf this value is `true` and the user has the PMI setting enabled with a password, then the user's meetings will use the PMI password. It will **not** use a default password.","type":"boolean","example":false},"duration":{"description":"The meeting's scheduled duration, in minutes. This field is only used for scheduled meetings (`2`).","type":"integer","example":60},"password":{"description":"The password required to join the meeting. By default, a password can **only** have a maximum length of 10 characters and only contain alphanumeric characters and the `@`, `-`, `_`, and `*` characters. \n* If the account owner or administrator has configured [minimum passcode requirement settings](https://support.zoom.us/hc/en-us/articles/360033559832-Meeting-and-webinar-passwords#h_a427384b-e383-4f80-864d-794bf0a37604), the password **must** meet those requirements. \n* If password requirements are enabled, use the [**Get user settings**](/docs/api-reference/zoom-api/methods#operation/userSettings) API or the [**Get account settings**](/docs/api-reference/zoom-api/ma#operation/accountSettings) API to get the requirements.","maxLength":10,"type":"string","example":"123456"},"pre_schedule":{"default":false,"description":"Whether to create a prescheduled meeting via the [GSuite app](https://support.zoom.us/hc/en-us/articles/360020187492-Zoom-for-GSuite-add-on). This **only** supports the meeting `type` value of `2` (scheduled meetings) and `3` (recurring meetings with no fixed time): \n* `true` — Create a prescheduled meeting. \n* `false` — Create a regular meeting.","type":"boolean","example":false},"recurrence":{"description":"Recurrence object. Use this object only for a meeting with type `8` i.e., a recurring meeting with fixed time. ","properties":{"end_date_time":{"description":"Select the final date on which the meeting will recur before it is canceled. Should be in UTC time, such as 2017-11-25T12:00:00Z. (Cannot be used with \"end_times\".)","format":"date-time","type":"string","example":"2022-04-02T15:59:00Z"},"end_times":{"default":1,"description":"Select how many times the meeting should recur before it is canceled. The default recurrence is 50 times. To support meetings recurring more than 50 times, contact Zoom support. Cannot be used with \"end_date_time\".","maximum":365,"type":"integer","example":7},"monthly_day":{"default":1,"description":"Use this field **only if you're scheduling a recurring meeting of type** `3` to state which day in a month, the meeting should recur. The value range is from 1 to 31.\n\nFor instance, if you would like the meeting to recur on 23rd of each month, provide `23` as the value of this field and `1` as the value of the `repeat_interval` field. Instead, if you would like the meeting to recur every three months, on 23rd of the month, change the value of the `repeat_interval` field to `3`.","type":"integer","example":1},"monthly_week":{"description":"Use this field **only if you're scheduling a recurring meeting of type** `3` to state the week of the month when the meeting should recur. If you use this field, **you must also use the `monthly_week_day` field to state the day of the week when the meeting should recur.** <br>`-1` - Last week of the month.<br>`1` - First week of the month.<br>`2` - Second week of the month.<br>`3` - Third week of the month.<br>`4` - Fourth week of the month.","enum":[-1,1,2,3,4],"type":"integer","x-enum-descriptions":["Last week","First week","Second week","Third week","Fourth week"],"example":1},"monthly_week_day":{"description":"Use this field **only if you're scheduling a recurring meeting of type** `3` to state a specific day in a week when the monthly meeting should recur. To use this field, you must also use the `monthly_week` field. \n\n<br>`1` - Sunday.<br>`2` - Monday.<br>`3` - Tuesday.<br>`4` -  Wednesday.<br>`5` - Thursday.<br>`6` - Friday.<br>`7` - Saturday.","enum":[1,2,3,4,5,6,7],"type":"integer","x-enum-descriptions":["Sunday","Monday","Tuesday","Wednesday","Thursday","Friday","Saturday"],"example":1},"repeat_interval":{"description":"Define the interval at which the meeting should recur. For instance, if you would like to schedule a meeting that recurs every two months, you must set the value of this field as `2` and the value of the `type` parameter as `3`. \n\nFor a daily meeting, the maximum interval you can set is `90` days. For a weekly meeting the maximum interval that you can set is  of `12` weeks. For a monthly meeting, there is a maximum of `3` months.\n\n","type":"integer","example":1},"type":{"description":"Recurrence meeting types:<br>`1` - Daily.<br>`2` - Weekly.<br>`3` - Monthly.","enum":[1,2,3],"type":"integer","x-enum-descriptions":["Daily","Weekly","Monthly"],"example":1},"weekly_days":{"type":"string","default":"1","description":"This field is required **if you're scheduling a recurring meeting of type** `2` to state which day(s) of the week the meeting should repeat. <br> <br> The value for this field could be a number between `1` to `7` in string format. For instance, if the meeting should recur on Sunday, provide `\"1\"` as the value of this field.<br><br> **Note:** If you would like the meeting to occur on multiple days of a week, you should provide comma separated values for this field. For instance, if the meeting should recur on Sundays and Tuesdays provide `\"1,3\"` as the value of this field.\n\n <br>`1`  - Sunday. <br>`2` - Monday.<br>`3` - Tuesday.<br>`4` -  Wednesday.<br>`5` -  Thursday.<br>`6` - Friday.<br>`7` - Saturday.","enum":["1","2","3","4","5","6","7"],"example":"1"}},"required":["type"],"type":"object"},"schedule_for":{"description":"The email address or user ID of the user to schedule a meeting for.","type":"string","example":"jchill@example.com"},"settings":{"description":"Information about the meeting's settings.","properties":{"additional_data_center_regions":{"description":"Add additional meeting [data center regions](https://support.zoom.us/hc/en-us/articles/360042411451-Selecting-data-center-regions-for-hosted-meetings-and-webinars). Provide this value as an array of [country codes](https://marketplace.zoom.us/docs/api-reference/other-references/abbreviation-lists#countries) for the countries available as data center regions in the [**Account Profile**](https://zoom.us/account/setting) interface but have been opted out of in the [user settings](https://zoom.us/profile).\n\nFor example, the data center regions selected in your [**Account Profile**](https://zoom.us/account) are \"Europe\", \"Hong Kong SAR\", \"Australia\", \"India\", \"Japan\", \"China\", \"United States\", and \"Canada\". However, in the [**My Profile**](https://zoom.us/profile) settings, you did **not** select \"India\" and \"Japan\" for meeting and webinar traffic routing.\n\nTo include \"India\" and \"Japan\" as additional data centers, use the `[\"IN\", \"TY\"]` value for this field.","items":{"type":"string","example":"TY"},"type":"array"},"allow_multiple_devices":{"description":"Whether to allow attendees to join a meeting from multiple devices. This setting is only applied to meetings with registration enabled.","type":"boolean","example":true},"alternative_hosts":{"description":"A semicolon-separated list of the meeting's alternative hosts' email addresses or IDs.","type":"string","example":"jchill@example.com;thill@example.com"},"alternative_hosts_email_notification":{"default":true,"description":"Whether to send email notifications to alternative hosts. This value defaults to `true`.","type":"boolean","example":true},"approval_type":{"default":2,"description":"Enable meeting registration approval: \n* `0` — Automatically approve registration.\n* `1` — Manually approve registration.\n* `2` — No registration required.\n\nThis value defaults to `2`.","enum":[0,1,2],"type":"integer","x-enum-descriptions":["Automatically approve registration.","Manually approve registration.","No registration required."],"example":2},"approved_or_denied_countries_or_regions":{"description":"The list of approved or blocked users from specific countries or regions who can join the meeting.","properties":{"approved_list":{"description":"The list of approved countries or regions.","items":{"type":"string","example":"CX"},"type":"array"},"denied_list":{"description":"The list of blocked countries or regions.","items":{"type":"string","example":"CA"},"type":"array"},"enable":{"description":"Whether to enable the [**Approve or block entry for users from specific countries/regions**](https://support.zoom.us/hc/en-us/articles/360060086231-Approve-or-block-entry-for-users-from-specific-countries-regions) setting.","type":"boolean","example":true},"method":{"description":"Whether to allow or block users from specific countries or regions: \n* `approve` — Allow users from specific countries or regions to join the meeting. If you select this setting, you must include the approved countries or regions in the `approved_list` field. \n* `deny` — Block users from specific countries or regions from joining the meeting. If you select this setting, you must include the blocked countries or regions in the `denied_list` field.","enum":["approve","deny"],"type":"string","example":"approve"}},"type":"object"},"audio":{"default":"both","description":"How participants join the audio portion of the meeting: \n* `both` — Both telephony and VoIP. \n* `telephony` — Telephony only. \n* `voip` — VoIP only. \n* `thirdParty` - Third party audio conference.","enum":["both","telephony","voip","thirdParty"],"type":"string","x-enum-descriptions":["Telephony and VoIP.","Telephony only.","VoIP only.","Third party audio conference."],"example":"telephony"},"audio_conference_info":{"description":"Third party audio conference info.","type":"string","maxLength":2048,"example":"test"},"authentication_domains":{"description":"The meeting's authenticated domains. Only Zoom users whose email address contains an authenticated domain can join the meeting. Comma-separate multiple domains or use a wildcard for listing domains.","type":"string","example":"example.com"},"authentication_exception":{"description":"A list of participants that can bypass meeting authentication. These participants will receive a unique meeting invite.","items":{"properties":{"email":{"description":"The participant's email address.","format":"email","type":"string","example":"jchill@example.com"},"name":{"description":"The participant's name.","type":"string","example":"Jill Chill"}},"type":"object"},"type":"array"},"authentication_option":{"description":"If the `meeting_authentication` value is `true`, the type of authentication required for users to join a meeting.\n\nTo get this value, use the `authentication_options` array's `id` value in the [**Get user settings**](/docs/api-reference/zoom-api/methods#operation/userSettings) API response.","type":"string","example":"signIn_D8cJuqWVQ623CI4Q8yQK0Q"},"auto_recording":{"default":"none","description":"The automatic recording settings: \n* `local` — Record the meeting locally. \n* `cloud` — Record the meeting to the cloud. \n* `none` — Auto-recording disabled.\n\nThis value defaults to `none`.","enum":["local","cloud","none"],"type":"string","x-enum-descriptions":["Record the meeting locally.","Record the meeting to the cloud.","Auto-recording disabled."],"example":"cloud"},"breakout_room":{"description":"The [pre-assigned breakout rooms](https://support.zoom.us/hc/en-us/articles/360032752671-Pre-assigning-participants-to-breakout-rooms) settings.","properties":{"enable":{"description":"Whether to enable the [**Breakout Room pre-assign**](https://support.zoom.us/hc/en-us/articles/360032752671-Pre-assigning-participants-to-breakout-rooms) option.","type":"boolean","example":true},"rooms":{"description":"Information about the breakout rooms.","items":{"properties":{"name":{"description":"The breakout room's name.","type":"string","example":"room1"},"participants":{"description":"The email addresses of the participants to assign to the breakout room.","items":{"type":"string","example":"jchill@example.com"},"type":"array"}},"type":"object"},"type":"array"}},"type":"object"},"calendar_type":{"description":"Indicates the type of calendar integration used to schedule the meeting: \n* `1` — [Zoom Outlook add-in](https://support.zoom.us/hc/en-us/articles/360031592971-Getting-started-with-Outlook-plugin-and-add-in) \n* `2` — [Zoom for Google Workspace add-on](https://support.zoom.us/hc/en-us/articles/360020187492-Using-the-Zoom-for-Google-Workspace-add-on)\n\nWorks with the `private_meeting` field to determine whether to share details of meetings or not.","enum":[1,2],"type":"integer","x-enum-descriptions":["Outlook","Google Calendar"],"example":1},"close_registration":{"default":false,"description":"Whether to close registration after the event date. This value defaults to `false`.","type":"boolean","example":false},"cn_meeting":{"type":"boolean","default":false,"deprecated":true,"description":"Whether to host the meeting in China (CN). This value defaults to `false`.","example":false},"contact_email":{"description":"The contact email address for meeting registration.","type":"string","example":"jchill@example.com"},"contact_name":{"description":"The contact name for meeting registration.","type":"string","example":"Jill Chill"},"email_notification":{"default":true,"description":"Whether to send email notifications to [alternative hosts](https://support.zoom.us/hc/en-us/articles/208220166) and [users with scheduling privileges](https://support.zoom.us/hc/en-us/articles/201362803-Scheduling-privilege). This value defaults to `true`.","type":"boolean","example":true},"encryption_type":{"description":"The type of [end-to-end (E2EE) encryption](https://support.zoom.us/hc/en-us/articles/360048660871) to use for the meeting: \n* `enhanced_encryption` — Enhanced encryption. Encryption is stored in the cloud when you enable this option. \n* `e2ee` — End-to-end encryption. The encryption key is stored on your local device and **cannot** be obtained by anyone else. When you use E2EE encryption, [certain features](https://support.zoom.us/hc/en-us/articles/360048660871), such as cloud recording or phone and SIP/H.323 dial-in, are **disabled**.","enum":["enhanced_encryption","e2ee"],"type":"string","example":"enhanced_encryption"},"focus_mode":{"description":"Whether to enable the [**Focus Mode** feature](https://support.zoom.us/hc/en-us/articles/360061113751-Using-focus-mode) when the meeting starts.","type":"boolean","example":true},"global_dial_in_countries":{"description":"A list of available global dial-in countries.","items":{"type":"string","example":"US"},"type":"array"},"host_video":{"description":"Whether to start meetings with the host video on.","type":"boolean","example":true},"in_meeting":{"type":"boolean","default":false,"deprecated":true,"description":"Whether to host the meeting in India (IN). This value defaults to `false`.","example":false},"jbh_time":{"description":"If the value of the `join_before_host` field is `true`, this field indicates the time limits within which a participant can join a meeting before the meeting's host:\n\n* `0` — Allow the participant to join the meeting at anytime.\n* `5` — Allow the participant to join 5 minutes before the meeting's start time.\n* `10` — Allow the participant to join 10 minutes before the meeting's start time.","enum":[0,5,10],"type":"integer","example":0},"join_before_host":{"default":false,"description":"Whether participants can join the meeting before its host. This field is only used for scheduled meetings (`2`) or recurring meetings (`3` and `8`). This value defaults to `false`.\n\nIf the [**Waiting Room** feature](https://support.zoom.us/hc/en-us/articles/115000332726-Waiting-Room) is enabled, this setting is **disabled**.","type":"boolean","example":false},"language_interpretation":{"description":"The meeting's [language interpretation settings](https://support.zoom.us/hc/en-us/articles/360034919791-Language-interpretation-in-meetings-and-webinars). Make sure to add the language in the web portal in order to use it in the API. See link for details. \n\n**Note:** This feature is only available for certain Meeting add-on, Education, and Business and higher plans. If this feature is not enabled on the host's account, this setting will **not** be applied to the meeting.","properties":{"enable":{"description":"Whether to enable [language interpretation](https://support.zoom.us/hc/en-us/articles/360034919791-Language-interpretation-in-meetings-and-webinars) for the meeting.","type":"boolean","example":true},"interpreters":{"description":"Information about the meeting's language interpreters.","items":{"properties":{"email":{"description":"The interpreter's email address.","format":"email","type":"string","example":"interpreter@example.com"},"languages":{"description":"A comma-separated list of the interpreter's languages. The string must contain two [country IDs](https://marketplace.zoom.us/docs/api-reference/other-references/abbreviation-lists#countries). \n\nFor example, if the interpreter will translate from English to Chinese, then this value will be `US,CN`.","type":"string","example":"US,FR"}},"type":"object"},"type":"array"}},"type":"object"},"meeting_authentication":{"description":"If true, only [authenticated](https://support.zoom.us/hc/en-us/articles/360037117472-Authentication-Profiles-for-Meetings-and-Webinars) users can join the meeting.","type":"boolean","example":true},"meeting_invitees":{"description":"A list of the meeting's invitees.","items":{"properties":{"email":{"description":"The invitee's email address.","format":"email","type":"string","example":"jchill@example.com"}},"type":"object"},"type":"array"},"mute_upon_entry":{"default":false,"description":"Whether to mute participants upon entry.","type":"boolean","example":false},"participant_video":{"description":"Whether to start meetings with the participant video on.","type":"boolean","example":false},"private_meeting":{"description":"Whether to set the meeting as private.","type":"boolean","example":false},"registrants_confirmation_email":{"description":"Whether to send registrants an email confirmation: \n* `true` — Send a confirmation email. \n* `false` — Do not send a confirmation email.","type":"boolean","example":true},"registrants_email_notification":{"description":"Whether to send registrants email notifications about their registration approval, cancellation, or rejection:\n\n* `true` — Send an email notification.\n* `false` — Do not send an email notification.\n\n Set this value to `true` to also use the `registrants_confirmation_email` parameter.","type":"boolean","example":true},"registration_type":{"default":1,"description":"The meeting's registration type: \n* `1` — Attendees register once and can attend any meeting occurrence. \n* `2` — Attendees must register for each meeting occurrence. \n* `3` — Attendees register once and can select one or more meeting occurrences to attend.\n\nThis field is only for recurring meetings with fixed times (`8`). This value defaults to `1`.","enum":[1,2,3],"type":"integer","x-enum-descriptions":["Attendees register once and can attend any meeting occurrence.","Attendees must register for each meeting occurrence.","Attendees register once and can select one or more meeting occurrences to attend."],"example":1},"show_share_button":{"description":"Whether to include social media sharing buttons on the meeting's registration page. This setting is only applied to meetings with registration enabled.","type":"boolean","example":true},"use_pmi":{"default":false,"description":"Whether to use a [Personal Meeting ID (PMI)](https://marketplace.zoom.us/docs/api-reference/using-zoom-apis#understanding-personal-meeting-id-pmi) instead of a generated meeting ID. This field is only used for scheduled meetings (`2`), instant meetings (`1`), or recurring meetings with no fixed time (`3`). This value defaults to `false`.","type":"boolean","example":false},"waiting_room":{"description":"Whether to enable the [**Waiting Room** feature](https://support.zoom.us/hc/en-us/articles/115000332726-Waiting-Room). If this value is `true`, this **disables** the `join_before_host` setting.","type":"boolean","example":false},"watermark":{"default":false,"description":"Whether to add a watermark when viewing a shared screen.","type":"boolean","example":false},"host_save_video_order":{"type":"boolean","description":"Whether the **Allow host to save video order** feature is enabled.","example":true},"alternative_host_update_polls":{"type":"boolean","description":"Whether the **Allow alternative hosts to add or edit polls** feature is enabled. This requires Zoom version 5.8.0 or higher.","example":true}},"type":"object"},"start_time":{"description":"The meeting's start time. This field is only used for scheduled and/or recurring meetings with a fixed time. This supports local time and GMT formats. \n* To set a meeting's start time in GMT, use the `yyyy-MM-ddTHH:mm:ssZ` date-time format. For example, `2020-03-31T12:02:00Z`. \n* To set a meeting's start time using a specific timezone, use the `yyyy-MM-ddTHH:mm:ss` date-time format and specify the [timezone ID](https://marketplace.zoom.us/docs/api-reference/other-references/abbreviation-lists#timezones) in the `timezone` field. If you do not specify a timezone, the `timezone` value defaults to your Zoom account's timezone. You can also use `UTC` for the `timezone` value.","format":"date-time","type":"string","example":"2022-03-25T07:32:55Z"},"template_id":{"description":"The **account admin meeting template** ID with which to schedule a meeting using a [meeting template](https://support.zoom.us/hc/en-us/articles/360036559151-Meeting-templates). For a list of account admin-provided meeting templates, use the [**List meeting templates**](/docs/api-reference/zoom-api/methods#operation/listMeetingTemplates) API. \n* At this time, this field **only** accepts account admin meeting template IDs. \n* To enable the account admin meeting templates feature, [contact Zoom support](https://support.zoom.us/hc/en-us).","type":"string","example":"Dv4YdINdTk+Z5RToadh5ug=="},"timezone":{"description":"The timezone to assign to the `start_time` value. This field is only used for scheduled meetings (`2`).\n\nFor a list of supported timezones and their format, refer to our [timezone list documentation](https://marketplace.zoom.us/docs/api-reference/other-references/abbreviation-lists#timezones).","type":"string","example":"America/Los_Angeles"},"topic":{"description":"The meeting's topic.","type":"string","maxLength":200,"example":"My Meeting"},"tracking_fields":{"description":"Information about the meeting's tracking fields.","items":{"properties":{"field":{"description":"The tracking field's label.","type":"string","example":"field1"},"value":{"description":"The tracking field's value.","type":"string","example":"value1"}},"required":["field"],"type":"object"},"type":"array"},"type":{"default":2,"description":"The type of meeting:\n* `1` — An instant meeting. \n* `2` — A scheduled meeting. \n* `3` — A recurring meeting with no fixed time. \n* `8` — A recurring meeting with fixed time.","enum":[1,2,3,8],"type":"integer","x-enum-descriptions":["Instant meeting.","Scheduled meeting.","Recurring meeting with no fixed time.","Recurring meeting with fixed time."],"example":2}},"type":"object"}}},"description":"Meeting object.","required":true},"summary":"Create a meeting"}},"/meetings/{meetingId}":{"delete":{"parameters":[{"in":"path","name":"meetingId","required":true,"description":"The meeting's ID. \n\n When storing this value in your database, you must store it as a long format integer and **not** an integer. Meeting IDs can exceed 10 digits.","schema":{"format":"int64","type":"integer","example":85746065}},{"description":"The meeting or webinar occurrence ID.","in":"query","name":"occurrence_id","schema":{"type":"string","example":"1648194360000"}},{"description":"`true`: Notify host and alternative host about the meeting cancellation via email.\n`false`: Do not send any email notification.","in":"query","name":"schedule_for_reminder","schema":{"type":"boolean","example":true}},{"description":"`true`: Notify registrants about the meeting cancellation via email. \n\n`false`: Do not send any email notification to meeting registrants. \n\nThe default value of this field is `false`.","in":"query","name":"cancel_meeting_reminder","schema":{"type":"boolean","example":true}}],"responses":{"204":{"description":"**HTTP Status Code**: `204` <br>\nMeeting deleted."},"400":{"description":"**HTTP Status Code**: `400` <br>\n**Error Code**: `1010` <br>\nUser does not belong to this account: {accountId}.<br>\n**Error Code**: `3000` <br>Cannot access meeting information.<br>Invalid occurrence_id.<br>\n**Error Code**: `3002` <br>\nSorry, you cannot delete this meeting since it is in progress.<br>**Error Code**: `3003` <br>You are not the meeting host.<br>\n**Error Code**: `3007` <br>Sorry, you cannot delete this meeting since it has ended.<br>**Error Code**: `3018` <br>\nNot allowed to delete PMI.<br>**Error Code**: `3037` <br>Not allowed to delete PAC. \n\n **Error Code:** `3161` <br>\nMeeting hosting and scheduling capabilities are not allowed for your user account."},"404":{"description":"**HTTP Status Code**: `404` <br>\nMeeting not found.\n**Error Code**: `1001` <br>\nUser does not exist: {userId}.<br>\n**Error Code**: `3001` <br>\nMeeting with this {meetingId} is not found or has expired."}},"security":[{"OAuth":[]}],"tags":["Meetings"],"description":"Delete a meeting.<br><br>\n**Scopes:** `meeting:write:admin` `meeting:write`<br>\n\n **[Rate Limit Label](https://developers.zoom.us/docs/api/rest/rate-limits/):** `Light` \n\n","operationId":"meetingDelete","summary":"Delete a meeting"},"get":{"parameters":[{"in":"path","name":"meetingId","required":true,"description":"The meeting's ID. \n\n When storing this value in your database, you must store it as a long format integer and **not** an integer. Meeting IDs can exceed 10 digits.","schema":{"format":"int64","type":"integer","example":85746065}},{"description":"Meeting Occurrence ID. Provide this field to view meeting details of a particular occurrence of the [recurring meeting](https://support.zoom.us/hc/en-us/articles/214973206-Scheduling-Recurring-Meetings).","in":"query","name":"occurrence_id","schema":{"type":"string","example":"1648194360000"}},{"description":"Set the value of this field to `true` if you would like to view meeting details of all previous occurrences of a [recurring meeting](https://support.zoom.us/hc/en-us/articles/214973206-Scheduling-Recurring-Meetings). ","in":"query","name":"show_previous_occurrences","schema":{"type":"boolean","example":true}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"assistant_id":{"description":"The ID of the user who scheduled this meeting on behalf of the host.","type":"string","example":"kFFvsJc-Q1OSxaJQLvaa_A"},"host_email":{"description":"Email address of the meeting host.","format":"email","type":"string","example":"jchill@example.com"},"host_id":{"description":"ID of the user who is set as host of meeting.","type":"string","example":"30R7kT7bTIKSNUFEuH_Qlg"},"id":{"description":"[Meeting ID](https://support.zoom.us/hc/en-us/articles/201362373-What-is-a-Meeting-ID-): Unique identifier of the meeting in \"**long**\" format(represented as int64 data type in JSON), also known as the meeting number.","format":"int64","type":"integer","example":97763643886},"uuid":{"description":"Unique meeting ID. Each meeting instance will generate its own Meeting UUID (i.e., after a meeting ends, a new UUID will be generated for the next instance of the meeting). You can retrieve a list of UUIDs from past meeting instances using the [**List past meeting instances**](/docs/api-reference/zoom-api/methods#operation/pastMeetings) API. [Double encode](https://marketplace.zoom.us/docs/api-reference/using-zoom-apis/#meeting-id-and-uuid) your UUID when using it for API calls if the UUID begins with a `/` or contains `//` in it.\n","type":"string","example":"aDYlohsHRtCd4ii1uC2+hA=="},"agenda":{"description":"Meeting description","maxLength":2000,"type":"string","example":"My Meeting"},"created_at":{"description":"Time of creation. ","format":"date-time","type":"string","example":"2022-03-25T07:29:29Z"},"duration":{"description":"Meeting duration.","type":"integer","example":60},"encrypted_password":{"description":"Encrypted passcode for third party endpoints (H323/SIP).","type":"string","example":"8pEkRweVXPV3Ob2KJYgFTRlDtl1gSn.1"},"h323_password":{"description":"H.323/SIP room system passcode.","type":"string","example":"123456"},"join_url":{"description":"URL for participants to join the meeting. This URL should only be shared with users that you would like to invite for the meeting.","type":"string","example":"https://example.com/j/11111"},"occurrences":{"description":"Array of occurrence objects.","items":{"description":"Occurrence object. This object is only returned for Recurring Webinars.","properties":{"duration":{"description":"Duration.","type":"integer","example":60},"occurrence_id":{"description":"Occurrence ID: Unique Identifier that identifies an occurrence of a recurring webinar. [Recurring webinars](https://support.zoom.us/hc/en-us/articles/216354763-How-to-Schedule-A-Recurring-Webinar) can have a maximum of 50 occurrences.","type":"string","example":"1648194360000"},"start_time":{"description":"Start time.","format":"date-time","type":"string","example":"2022-03-25T07:46:00Z"},"status":{"description":"Occurrence status.","type":"string","example":"available"}},"type":"object"},"type":"array"},"password":{"description":"Meeting passcode.","minimum":8,"type":"string","example":"123456"},"pmi":{"description":"[Personal Meeting ID (PMI)](https://marketplace.zoom.us/docs/api-reference/using-zoom-apis#understanding-personal-meeting-id-pmi). Only used for scheduled meetings and recurring meetings with no fixed time.","type":"string","example":"97891943927"},"pre_schedule":{"default":false,"description":"Whether the prescheduled meeting was created via the [GSuite app](https://support.zoom.us/hc/en-us/articles/360020187492-Zoom-for-GSuite-add-on). This **only** supports the meeting `type` value of `2` (scheduled meetings) and `3` (recurring meetings with no fixed time): \n* `true` — A GSuite prescheduled meeting. \n* `false` — A regular meeting.","type":"boolean","example":false},"recurrence":{"description":"Recurrence object. Use this object only for a meeting with type `8` i.e., a recurring meeting with fixed time. ","properties":{"end_date_time":{"description":"Select the final date on which the meeting will recur before it is canceled. Should be in UTC time, such as 2017-11-25T12:00:00Z. (Cannot be used with \"end_times\".)","format":"date-time","type":"string","example":"2022-04-02T15:59:00Z"},"end_times":{"default":1,"description":"Select how many times the meeting should recur before it is canceled. The default recurrence is 50 times. To support meetings recurring more than 50 times, contact Zoom support. Cannot be used with \"end_date_time\".","maximum":365,"type":"integer","example":7},"monthly_day":{"default":1,"description":"Use this field **only if you're scheduling a recurring meeting of type** `3` to state which day in a month, the meeting should recur. The value range is from 1 to 31.\n\nFor instance, if you would like the meeting to recur on 23rd of each month, provide `23` as the value of this field and `1` as the value of the `repeat_interval` field. Instead, if you would like the meeting to recur every three months, on 23rd of the month, change the value of the `repeat_interval` field to `3`.","type":"integer","example":1},"monthly_week":{"description":"Use this field **only if you're scheduling a recurring meeting of type** `3` to state the week of the month when the meeting should recur. If you use this field, **you must also use the `monthly_week_day` field to state the day of the week when the meeting should recur.** <br>`-1` - Last week of the month.<br>`1` - First week of the month.<br>`2` - Second week of the month.<br>`3` - Third week of the month.<br>`4` - Fourth week of the month.","enum":[-1,1,2,3,4],"type":"integer","x-enum-descriptions":["Last week","First week","Second week","Third week","Fourth week"],"example":1},"monthly_week_day":{"description":"Use this field **only if you're scheduling a recurring meeting of type** `3` to state a specific day in a week when the monthly meeting should recur. To use this field, you must also use the `monthly_week` field. \n\n<br>`1` - Sunday.<br>`2` - Monday.<br>`3` - Tuesday.<br>`4` -  Wednesday.<br>`5` - Thursday.<br>`6` - Friday.<br>`7` - Saturday.","enum":[1,2,3,4,5,6,7],"type":"integer","x-enum-descriptions":["Sunday","Monday","Tuesday","Wednesday","Thursday","Friday","Saturday"],"example":1},"repeat_interval":{"description":"Define the interval at which the meeting should recur. For instance, if you would like to schedule a meeting that recurs every two months, you must set the value of this field as `2` and the value of the `type` parameter as `3`. \n\nFor a daily meeting, the maximum interval you can set is `90` days. For a weekly meeting the maximum interval that you can set is  of `12` weeks. For a monthly meeting, there is a maximum of `3` months.\n\n","type":"integer","example":1},"type":{"description":"Recurrence meeting types:<br>`1` - Daily.<br>`2` - Weekly.<br>`3` - Monthly.","enum":[1,2,3],"type":"integer","x-enum-descriptions":["Daily","Weekly","Monthly"],"example":1},"weekly_days":{"type":"string","default":"1","description":"This field is required **if you're scheduling a recurring meeting of type** `2` to state which day(s) of the week the meeting should repeat. <br> <br> The value for this field could be a number between `1` to `7` in string format. For instance, if the meeting should recur on Sunday, provide `\"1\"` as the value of this field.<br><br> **Note:** If you would like the meeting to occur on multiple days of a week, you should provide comma separated values for this field. For instance, if the meeting should recur on Sundays and Tuesdays provide `\"1,3\"` as the value of this field.\n\n <br>`1`  - Sunday. <br>`2` - Monday.<br>`3` - Tuesday.<br>`4` -  Wednesday.<br>`5` -  Thursday.<br>`6` - Friday.<br>`7` - Saturday.","enum":["1","2","3","4","5","6","7"],"example":"1"}},"required":["type"],"type":"object"},"settings":{"description":"Meeting settings.","properties":{"allow_multiple_devices":{"description":"Allow attendees to join the meeting from multiple devices. This setting only works for meetings that require [registration](https://support.zoom.us/hc/en-us/articles/211579443-Setting-up-registration-for-a-meeting).","type":"boolean","example":true},"alternative_hosts":{"description":"A semicolon-separated list of the meeting's alternative hosts' email addresses or IDs.","type":"string","example":"jchill@example.com;thill@example.com"},"alternative_hosts_email_notification":{"default":true,"description":"Flag to determine whether to send email notifications to alternative hosts, default value is true.","type":"boolean","example":true},"alternative_host_update_polls":{"type":"boolean","description":"Whether the **Allow alternative hosts to add or edit polls** feature is enabled. This requires Zoom version 5.8.0 or higher.","example":true},"approval_type":{"default":2,"description":"Enable registration and set approval for the registration. Note that this feature requires the host to be of **Licensed** user type. **Registration cannot be enabled for a basic user.** <br><br>\n\n`0` - Automatically approve.<br>`1` - Manually approve.<br>`2` - No registration required.","enum":[0,1,2],"type":"integer","x-enum-descriptions":["Automatically Approve","Manually Approve","No Registration Required"],"example":0},"approved_or_denied_countries_or_regions":{"description":"Approve or block users from specific regions/countries from joining this meeting. \n","properties":{"approved_list":{"description":"List of countries/regions from where participants can join this meeting. ","items":{"type":"string","example":"CX"},"type":"array"},"denied_list":{"description":"List of countries/regions from where participants can not join this meeting. ","items":{"type":"string","example":"CA"},"type":"array"},"enable":{"description":"`true`: Setting enabled to either allow users or block users from specific regions to join your meetings. <br>\n\n`false`: Setting disabled.","type":"boolean","example":true},"method":{"description":"Specify whether to allow users from specific regions to join this meeting; or block users from specific regions from joining this meeting. <br><br>\n`approve`: Allow users from specific regions/countries to join this meeting. If this setting is selected, the approved regions/countries must be included in the `approved_list`.<br><br>\n`deny`: Block users from specific regions/countries from joining this meeting. If this setting is selected, the approved regions/countries must be included in the `denied_list`","enum":["approve","deny"],"type":"string","example":"approve"}},"type":"object"},"audio":{"default":"both","description":"Determine how participants can join the audio portion of the meeting.<br>`both` - Both Telephony and VoIP.<br>`telephony` - Telephony only.<br>`voip` - VoIP only.<br>`thirdParty` - Third party audio conference.","enum":["both","telephony","voip","thirdParty"],"type":"string","x-enum-descriptions":["Both Telephony and VoIP","Telephony only","VoIP only","Third party audio conference"],"example":"telephony"},"audio_conference_info":{"description":"Third party audio conference info.","type":"string","maxLength":2048,"example":"test"},"authentication_domains":{"description":"If user has configured [\"Sign Into Zoom with Specified Domains\"](https://support.zoom.us/hc/en-us/articles/360037117472-Authentication-Profiles-for-Meetings-and-Webinars#h_5c0df2e1-cfd2-469f-bb4a-c77d7c0cca6f) option, this will list the domains that are authenticated.","type":"string","example":"example.com"},"authentication_exception":{"description":"The participants added here will receive unique meeting invite links and bypass authentication.","items":{"properties":{"email":{"description":"Email address of the participant.","format":"email","type":"string","example":"jchill@example.com"},"name":{"description":"Name of the participant.","type":"string","example":"Jill Chill"},"join_url":{"description":"URL for participants to join the meeting","type":"string","example":"https://example.com/s/11111"}},"type":"object"},"type":"array"},"authentication_name":{"description":"Authentication name set in the [authentication profile](https://support.zoom.us/hc/en-us/articles/360037117472-Authentication-Profiles-for-Meetings-and-Webinars#h_5c0df2e1-cfd2-469f-bb4a-c77d7c0cca6f).","type":"string","example":"Sign in to Zoom"},"authentication_option":{"description":"Meeting authentication option id.","type":"string","example":"signIn_D8cJuqWVQ623CI4Q8yQK0Q"},"auto_recording":{"default":"none","description":"Automatic recording:<br>`local` - Record on local.<br>`cloud` -  Record on cloud.<br>`none` - Disabled.","enum":["local","cloud","none"],"type":"string","x-enum-descriptions":["Record to local device","Record to cloud","No Recording"],"example":"cloud"},"breakout_room":{"description":"Setting to [pre-assign breakout rooms](https://support.zoom.us/hc/en-us/articles/360032752671-Pre-assigning-participants-to-breakout-rooms#h_36f71353-4190-48a2-b999-ca129861c1f4).","properties":{"enable":{"description":"Set the value of this field to `true` if you would like to enable the [breakout room pre-assign](https://support.zoom.us/hc/en-us/articles/360032752671-Pre-assigning-participants-to-breakout-rooms#h_36f71353-4190-48a2-b999-ca129861c1f4) option.","type":"boolean","example":true},"rooms":{"description":"Create room(s).","items":{"properties":{"name":{"description":"Name of the breakout room.","type":"string","example":"room1"},"participants":{"description":"Email addresses of the participants who are to be assigned to the breakout room.","items":{"type":"string","example":"jchill@example.com"},"type":"array"}},"type":"object"},"type":"array"}},"type":"object"},"calendar_type":{"description":"Indicates the type of calendar integration used to schedule the meeting: \n* `1` — [Zoom Outlook add-in](https://support.zoom.us/hc/en-us/articles/360031592971-Getting-started-with-Outlook-plugin-and-add-in) \n* `2` — [Zoom for Google Workspace add-on](https://support.zoom.us/hc/en-us/articles/360020187492-Using-the-Zoom-for-Google-Workspace-add-on)\n\nWorks with the `private_meeting` field to determine whether to share details of meetings or not.","enum":[1,2],"type":"integer","x-enum-descriptions":["Outlook","Google Calendar"],"example":1},"close_registration":{"default":false,"description":"Close registration after event date","type":"boolean","example":false},"cn_meeting":{"type":"boolean","default":false,"deprecated":true,"description":"Host meeting in China.","example":false},"contact_email":{"description":"Contact email for registration","type":"string","example":"jchill@example.com"},"contact_name":{"description":"Contact name for registration","type":"string","example":"Jill Chill"},"custom_keys":{"description":"Custom keys and values assigned to the meeting.","items":{"properties":{"key":{"description":"Custom key associated with the user.","maxLength":64,"type":"string","example":"key1"},"value":{"description":"Value of the custom key associated with the user.","maxLength":256,"type":"string","example":"value1"}},"type":"object"},"maxItems":10,"type":"array"},"email_notification":{"default":true,"description":"Whether to send email notifications to [alternative hosts](https://support.zoom.us/hc/en-us/articles/208220166) and [users with scheduling privileges](https://support.zoom.us/hc/en-us/articles/201362803-Scheduling-privilege). This value defaults to `true`.","type":"boolean","example":true},"encryption_type":{"description":"Choose between enhanced encryption and [end-to-end encryption](https://support.zoom.us/hc/en-us/articles/360048660871) when starting or a meeting. When using end-to-end encryption, several features (e.g. cloud recording, phone/SIP/H.323 dial-in) will be **automatically disabled**. <br><br>The value of this field can be one of the following:<br>\n`enhanced_encryption`: Enhanced encryption. Encryption is stored in the cloud if you enable this option. <br>\n\n`e2ee`: [End-to-end encryption](https://support.zoom.us/hc/en-us/articles/360048660871). The encryption key is stored in your local device and can not be obtained by anyone else. Enabling this setting also **disables** the following features: join before host, cloud recording, streaming, live transcription, breakout rooms, polling, 1:1 private chat, and meeting reactions.","enum":["enhanced_encryption","e2ee"],"type":"string","example":"enhanced_encryption"},"enforce_login":{"deprecated":true,"description":"Only signed in users can join this meeting.\n\n**This field is deprecated and will not be supported in the future.**  <br><br>As an alternative, use the \"meeting_authentication\", \"authentication_option\" and \"authentication_domains\" fields to understand the [authentication configurations](https://support.zoom.us/hc/en-us/articles/360037117472-Authentication-Profiles-for-Meetings-and-Webinars) set for the meeting.","type":"boolean","example":true},"enforce_login_domains":{"deprecated":true,"description":"Only signed in users with specified domains can join meetings.\n\n**This field is deprecated and will not be supported in the future.**  <br><br>As an alternative, use the \"meeting_authentication\", \"authentication_option\" and \"authentication_domains\" fields to understand the [authentication configurations](https://support.zoom.us/hc/en-us/articles/360037117472-Authentication-Profiles-for-Meetings-and-Webinars) set for the meeting.","type":"string","example":"example.com"},"focus_mode":{"description":"Whether the [**Focus Mode** feature](https://support.zoom.us/hc/en-us/articles/360061113751-Using-focus-mode) is enabled when the meeting starts.","type":"boolean","example":true},"global_dial_in_countries":{"description":"List of global dial-in countries","items":{"type":"string","example":"US"},"type":"array"},"global_dial_in_numbers":{"description":"Global Dial-in Countries/Regions","items":{"properties":{"city":{"description":"City of the number, if any. For example, Chicago.","type":"string","example":"New York"},"country":{"description":"Country code. For example, BR.","type":"string","example":"US"},"country_name":{"description":"Full name of country. For example, Brazil.","type":"string","example":"US"},"number":{"description":"Phone number. For example, +1 2332357613.","type":"string","example":"+1 1000200200"},"type":{"description":"Type of number. ","enum":["toll","tollfree"],"type":"string","example":"toll"}},"type":"object"},"type":"array"},"host_video":{"description":"Start video when the host joins the meeting.","type":"boolean","example":true},"in_meeting":{"type":"boolean","default":false,"deprecated":true,"description":"Host meeting in India.","example":false},"jbh_time":{"description":"If the value of \"join_before_host\" field is set to true, this field can be used to indicate time limits within which a participant may join a meeting before a host. The value of this field can be one of the following:\n\n*  `0`: Allow participant to join anytime.\n*  `5`: Allow participant to join 5 minutes before meeting start time.\n * `10`: Allow participant to join 10 minutes before meeting start time.","enum":[0,5,10],"type":"integer","example":0},"join_before_host":{"default":false,"description":"Allow participants to join the meeting before the host starts the meeting. Only used for scheduled or recurring meetings.","type":"boolean","example":true},"language_interpretation":{"description":"The meeting's [language interpretation settings](https://support.zoom.us/hc/en-us/articles/360034919791-Language-interpretation-in-meetings-and-webinars). Make sure to add the language in the web portal in order to use it in the API. See link for details. \n\n**Note:** This feature is only available for certain Meeting add-on, Education, and Business and higher plans. If this feature is not enabled on the host's account, this setting will **not** be applied to the meeting.","properties":{"enable":{"description":"Whether to enable [language interpretation](https://support.zoom.us/hc/en-us/articles/360034919791-Language-interpretation-in-meetings-and-webinars) for the meeting.","type":"boolean","example":true},"interpreters":{"description":"Information about the meeting's language interpreters.","items":{"properties":{"email":{"description":"The interpreter's email address.","format":"email","type":"string","example":"interpreter@example.com"},"languages":{"description":"A comma-separated list of the interpreter's languages. The string must contain two [country IDs](https://marketplace.zoom.us/docs/api-reference/other-references/abbreviation-lists#countries). \n\nFor example, if the interpreter will translate from English to Chinese, then this value will be `US,CN`.","type":"string","example":"US,FR"}},"type":"object"},"type":"array"}},"type":"object"},"meeting_authentication":{"description":"`true`- Only authenticated users can join meetings.","type":"boolean","example":true},"mute_upon_entry":{"default":false,"description":"Mute participants upon entry.","type":"boolean","example":false},"participant_video":{"description":"Start video when participants join the meeting.","type":"boolean","example":false},"private_meeting":{"description":"Whether the meeting is set as private.","type":"boolean","example":false},"registrants_confirmation_email":{"description":"Whether to send registrants an email confirmation:\n* `true` — Send a confirmation email.\n* `false` — Do not send a confirmation email.","type":"boolean","example":true},"registrants_email_notification":{"description":"Whether to send registrants email notifications about their registration approval, cancellation, or rejection:\n\n* `true` — Send an email notification.\n* `false` — Do not send an email notification.\n\n Set this value to `true` to also use the `registrants_confirmation_email` parameter.","type":"boolean","example":true},"registration_type":{"default":1,"description":"Registration type. Used for recurring meeting with fixed time only. <br>`1` Attendees register once and can attend any of the occurrences.<br>`2` Attendees need to register for each occurrence to attend.<br>`3` Attendees register once and can choose one or more occurrences to attend.","enum":[1,2,3],"type":"integer","x-enum-descriptions":["Attendees register once and can attend any of the occurrences","Attendees need to register for each occurrence to attend","Attendees register once and can choose one or more occurrences to attend"],"example":1},"show_share_button":{"description":"Show social share buttons on the meeting registration page.\nThis setting only works for meetings that require [registration](https://support.zoom.us/hc/en-us/articles/211579443-Setting-up-registration-for-a-meeting).","type":"boolean","example":true},"use_pmi":{"default":false,"description":"Use a [Personal Meeting ID (PMI)](https://marketplace.zoom.us/docs/api-reference/using-zoom-apis#understanding-personal-meeting-id-pmi). Only used for scheduled meetings and recurring meetings with no fixed time.","type":"boolean","example":false},"waiting_room":{"default":false,"description":"Enable waiting room","type":"boolean","example":false},"watermark":{"default":false,"description":"Add watermark when viewing a shared screen.","type":"boolean","example":false},"host_save_video_order":{"type":"boolean","description":"Whether the **Allow host to save video order** feature is enabled.","example":true}},"type":"object"},"start_time":{"description":"Meeting start time in GMT/UTC. Start time will not be returned if the meeting is an **instant** meeting. \n","format":"date-time","type":"string","example":"2022-03-25T07:29:29Z"},"start_url":{"description":"<br><aside>The <code>start_url</code> of a Meeting is a URL using which a host or an alternative host can start the Meeting. \n\nThe expiration time for the <code>start_url</code> field listed in the response of the [**Create a meeting**](/docs/api-reference/zoom-api/methods#operation/meetingCreate) API is two hours for all regular users. \n\t\nFor users created using the <code>custCreate</code> option via the [**Create users**](/docs/api-reference/zoom-api/methods#operation/userCreate) API, the expiration time of the <code>start_url</code> field is 90 days.\n\t\nFor security reasons, to retrieve the updated value for the <code>start_url</code> field programmatically (after the expiry time), you must call the [**Get a meeting](/docs/api-reference/zoom-api/methods#operation/meeting) API and refer to the value of the <code>start_url</code> field in the response.</aside><br>This URL should only be used by the host of the meeting and **should not be shared with anyone other than the host** of the meeting as anyone with this URL will be able to login to the Zoom Client as the host of the meeting.","type":"string","example":"https://example.com/s/11111"},"status":{"description":"Meeting status","enum":["waiting","started"],"type":"string","example":"waiting"},"timezone":{"description":"Timezone to format the meeting start time on the .","type":"string","example":"America/Los_Angeles"},"topic":{"description":"Meeting topic.","type":"string","example":"My Meeting"},"tracking_fields":{"description":"Tracking fields","items":{"properties":{"field":{"description":"Label of the tracking field.","type":"string","example":"field1"},"value":{"description":"Value for the field.","type":"string","example":"value1"},"visible":{"description":"Indicates whether the [tracking field](https://support.zoom.us/hc/en-us/articles/115000293426-Scheduling-Tracking-Fields) is visible in the meeting scheduling options in the Zoom Web Portal or not.\n\n`true`: Tracking field is visible. <br>\n\n`false`: Tracking field is not visible to the users when they look at the meeting details in the Zoom Web Portal but the field was used while scheduling this meeting via API. An invisible tracking field can be used by users while scheduling meetings via API only. ","type":"boolean","example":true}},"type":"object"},"type":"array"},"type":{"default":2,"description":"Meeting Types:<br>`1` - Instant meeting.<br>`2` - Scheduled meeting.<br>`3` - Recurring meeting with no fixed time.<br>`4` - PMI Meeting<br>\n`8` - Recurring meeting with a fixed time.","enum":[1,2,3,8],"type":"integer","x-enum-descriptions":["Instant Meeting","Scheduled Meeting","Recurring Meeting with no fixed time","Recurring Meeting with fixed time"],"example":2}},"type":"object","description":"Meeting object."}}},"description":"**HTTP Status Code:** `200`<br>\nMeeting object returned."},"400":{"description":"**HTTP Status Code:** `400`<br>\n**Error Code:** `1010`<br>\nUser not found on this account: {accountId}.<br>**Error Code:** `3000`<br>\nCannot access webinar info. \n\n **Error Code:** `3161` <br>\nMeeting hosting and scheduling capabilities are not allowed for your user account."},"404":{"description":"**HTTP Status Code:** `404`<br>\nMeeting not found.<br>\n**Error Code:** `1001`<br>\nUser not exist: {userId}.<br>**Error Code:** `3001`<br>\nMeeting {meetingId} is not found or has expired."}},"security":[{"OAuth":[]}],"tags":["Meetings"],"description":"Retrieve the details of a meeting.<br><br>\n**Scopes:** `meeting:read:admin` `meeting:read`<br>\n\n **[Rate Limit Label](https://developers.zoom.us/docs/api/rest/rate-limits/):** `Light` \n\n","operationId":"meeting","summary":"Get a meeting"},"patch":{"parameters":[{"in":"path","name":"meetingId","required":true,"description":"The meeting's ID. \n\n When storing this value in your database, you must store it as a long format integer and **not** an integer. Meeting IDs can exceed 10 digits.","schema":{"format":"int64","type":"integer","example":85746065}},{"description":"Meeting occurrence id. Support change of agenda, start_time, duration, settings: {host_video, participant_video, join_before_host, mute_upon_entry, waiting_room, watermark, auto_recording}","in":"query","name":"occurrence_id","schema":{"type":"string","example":"1648194360000"}}],"responses":{"204":{"description":"**HTTP Status Code:** `204`<br>\nMeeting updated."},"400":{"description":"**HTTP Status Code:** `400` <br>\n Bad Request \n\n **Error Code:** `1010` <br>\n User not found on this account: {accountId} \n\n **Error Code:** `3000` <br>\n Cannot access meeting information.\n\n **Error Code:** `3003` <br>\n You are not the meeting host. \n\n **Error Code:** `3000` <br>\n* Instant meetings do not support the \"schedule_for\" parameter. You cannot schedule an instant meeting for another user. \n* Users in \"{0}\" have been blocked from joining meetings and webinars. To unblock them, go to the \"Settings\" page in the Zoom web portal and update the \"Block users in specific domains from joining meetings and webinars\" setting. \n* Prescheduling is only available for scheduled meetings (type 2) and recurring meetings with no fixed time (type 3). \n* You cannot schedule a meeting for \"{0}\". \n* You cannot update or delete meetings that have started using this method. \n\n **Error Code:** `3161` <br>\n Meeting hosting and scheduling capabilities are not allowed for your user account. \n\n **Error Code:** `300` <br> \n* The value that you entered for the schedule_for field is invalid. Enter a valid value and try again. <br> \n* Invalid enforce_login_domains, separate multiple domains by semicolon."},"404":{"description":"**HTTP Status Code:** `404`<br>\nMeeting not found.<br>\n**Error Code:** `1001`<br>\nUser does not exist: {userId}.<br>\n**Error Code:** `3001`<br>\nA meeting with this {meetingId} is not found or has expired."},"429":{"description":"**HTTP Status Code:** `429` <br>\n You have exceeded the daily rate limit ({rateLimitNumber}) of Meeting Create/Update API requests permitted for this particular user. You may resume these requests at GMT 00:00:00."}},"security":[{"OAuth":[]}],"tags":["Meetings"],"description":"Update a meeting's details.\n\n**Note:** \n* This API has a rate limit of **100 requests per day**. Because of this, a meeting can only be updated for a maximum of **100 times within a 24-hour period**. \n* The `start_time` value **must** be a future date. If the value is omitted or a date in the past, the API ignores this value and will **not** update any recurring meetings. \n* If the `start_time` value is a future date, the `recurrence` object is **required**.\n\n**Scopes:** `meeting:write:admin`, `meeting:write`</br>**[Rate Limit Label](https://developers.zoom.us/docs/api/rest/rate-limits/):** `Light`","operationId":"meetingUpdate","requestBody":{"content":{"application/json":{"schema":{"properties":{"schedule_for":{"description":"The email address or `userId` of the user to schedule a meeting for.","type":"string","example":"jchill@example.com"},"agenda":{"description":"Meeting description.","maxLength":2000,"type":"string","example":"My Meeting"},"duration":{"description":"Meeting duration (minutes). Used for scheduled meetings only.","type":"integer","example":60},"password":{"description":"Meeting passcode. Passcode may only contain the following characters: [a-z A-Z 0-9 @ - _ *] and can have a maximum of 10 characters.\n\n**Note:** If the account owner or the admin has configured [minimum passcode requirement settings](https://support.zoom.us/hc/en-us/articles/360033559832-Meeting-and-webinar-passwords#h_a427384b-e383-4f80-864d-794bf0a37604), the passcode value provided here must meet those requirements. <br><br>If the requirements are enabled, you can view those requirements by calling either the [**Get user settings**](/docs/api-reference/zoom-api/methods#operation/userSettings) API or the [**Get account settings**](/docs/api-reference/zoom-api/ma#operation/accountSettings) API.","maxLength":10,"type":"string","example":"123456"},"pre_schedule":{"default":false,"description":"Whether to create a prescheduled meeting via the [GSuite app](https://support.zoom.us/hc/en-us/articles/360020187492-Zoom-for-GSuite-add-on). This **only** supports the meeting `type` value of `2` (scheduled meetings) and `3` (recurring meetings with no fixed time): \n* `true` — Create a prescheduled meeting. \n* `false` — Create a regular meeting.","type":"boolean","example":false},"recurrence":{"description":"Recurrence object. Use this object only for a meeting with type `8` i.e., a recurring meeting with fixed time. ","properties":{"end_date_time":{"description":"Select the final date on which the meeting will recur before it is canceled. Should be in UTC time, such as 2017-11-25T12:00:00Z. (Cannot be used with \"end_times\".)","format":"date-time","type":"string","example":"2022-04-02T15:59:00Z"},"end_times":{"default":1,"description":"Select how many times the meeting should recur before it is canceled. The default recurrence is 50 times. To support meetings recurring more than 50 times, contact Zoom support. Cannot be used with \"end_date_time\".","maximum":365,"type":"integer","example":7},"monthly_day":{"default":1,"description":"Use this field **only if you're scheduling a recurring meeting of type** `3` to state which day in a month, the meeting should recur. The value range is from 1 to 31.\n\nFor instance, if you would like the meeting to recur on 23rd of each month, provide `23` as the value of this field and `1` as the value of the `repeat_interval` field. Instead, if you would like the meeting to recur every three months, on 23rd of the month, change the value of the `repeat_interval` field to `3`.","type":"integer","example":1},"monthly_week":{"description":"Use this field **only if you're scheduling a recurring meeting of type** `3` to state the week of the month when the meeting should recur. If you use this field, **you must also use the `monthly_week_day` field to state the day of the week when the meeting should recur.** <br>`-1` - Last week of the month.<br>`1` - First week of the month.<br>`2` - Second week of the month.<br>`3` - Third week of the month.<br>`4` - Fourth week of the month.","enum":[-1,1,2,3,4],"type":"integer","x-enum-descriptions":["Last week","First week","Second week","Third week","Fourth week"],"example":1},"monthly_week_day":{"description":"Use this field **only if you're scheduling a recurring meeting of type** `3` to state a specific day in a week when the monthly meeting should recur. To use this field, you must also use the `monthly_week` field. \n\n<br>`1` - Sunday.<br>`2` - Monday.<br>`3` - Tuesday.<br>`4` -  Wednesday.<br>`5` - Thursday.<br>`6` - Friday.<br>`7` - Saturday.","enum":[1,2,3,4,5,6,7],"type":"integer","x-enum-descriptions":["Sunday","Monday","Tuesday","Wednesday","Thursday","Friday","Saturday"],"example":1},"repeat_interval":{"description":"Define the interval at which the meeting should recur. For instance, if you would like to schedule a meeting that recurs every two months, you must set the value of this field as `2` and the value of the `type` parameter as `3`. \n\nFor a daily meeting, the maximum interval you can set is `90` days. For a weekly meeting the maximum interval that you can set is  of `12` weeks. For a monthly meeting, there is a maximum of `3` months.\n\n","type":"integer","example":1},"type":{"description":"Recurrence meeting types:<br>`1` - Daily.<br>`2` - Weekly.<br>`3` - Monthly.","enum":[1,2,3],"type":"integer","x-enum-descriptions":["Daily","Weekly","Monthly"],"example":1},"weekly_days":{"type":"string","default":"1","description":"This field is required **if you're scheduling a recurring meeting of type** `2` to state which day(s) of the week the meeting should repeat. <br> <br> The value for this field could be a number between `1` to `7` in string format. For instance, if the meeting should recur on Sunday, provide `\"1\"` as the value of this field.<br><br> **Note:** If you would like the meeting to occur on multiple days of a week, you should provide comma separated values for this field. For instance, if the meeting should recur on Sundays and Tuesdays provide `\"1,3\"` as the value of this field.\n\n <br>`1`  - Sunday. <br>`2` - Monday.<br>`3` - Tuesday.<br>`4` -  Wednesday.<br>`5` -  Thursday.<br>`6` - Friday.<br>`7` - Saturday.","enum":["1","2","3","4","5","6","7"],"example":"1"}},"required":["type"],"type":"object"},"settings":{"description":"Meeting settings.","properties":{"allow_multiple_devices":{"description":"Allow attendees to join the meeting from multiple devices. This setting only works for meetings that require [registration](https://support.zoom.us/hc/en-us/articles/211579443-Setting-up-registration-for-a-meeting).","type":"boolean","example":true},"alternative_hosts":{"description":"A semicolon-separated list of the meeting's alternative hosts' email addresses or IDs.","type":"string","example":"jchill@example.com;thill@example.com"},"alternative_hosts_email_notification":{"default":true,"description":"Flag to determine whether to send email notifications to alternative hosts, default value is true.","type":"boolean","example":true},"alternative_host_update_polls":{"type":"boolean","description":"Whether the **Allow alternative hosts to add or edit polls** feature is enabled. This requires Zoom version 5.8.0 or higher.","example":true},"approval_type":{"default":2,"description":"Enable registration and set approval for the registration. Note that this feature requires the host to be of **Licensed** user type. **Registration cannot be enabled for a basic user.** <br><br>\n\n`0` - Automatically approve.<br>`1` - Manually approve.<br>`2` - No registration required.","enum":[0,1,2],"type":"integer","x-enum-descriptions":["Automatically Approve","Manually Approve","No Registration Required"],"example":0},"approved_or_denied_countries_or_regions":{"description":"Approve or block users from specific regions/countries from joining this meeting. \n","properties":{"approved_list":{"description":"List of countries/regions from where participants can join this meeting. ","items":{"type":"string","example":"CX"},"type":"array"},"denied_list":{"description":"List of countries/regions from where participants can not join this meeting. ","items":{"type":"string","example":"CA"},"type":"array"},"enable":{"description":"`true`: Setting enabled to either allow users or block users from specific regions to join your meetings. <br>\n\n`false`: Setting disabled.","type":"boolean","example":true},"method":{"description":"Specify whether to allow users from specific regions to join this meeting; or block users from specific regions from joining this meeting. <br><br>\n`approve`: Allow users from specific regions/countries to join this meeting. If this setting is selected, the approved regions/countries must be included in the `approved_list`.<br><br>\n`deny`: Block users from specific regions/countries from joining this meeting. If this setting is selected, the approved regions/countries must be included in the `denied_list`","enum":["approve","deny"],"type":"string","example":"approve"}},"type":"object"},"audio":{"default":"both","description":"Determine how participants can join the audio portion of the meeting.<br>`both` - Both Telephony and VoIP.<br>`telephony` - Telephony only.<br>`voip` - VoIP only.<br>`thirdParty` - Third party audio conference.","enum":["both","telephony","voip","thirdParty"],"type":"string","x-enum-descriptions":["Both Telephony and VoIP","Telephony only","VoIP only","Third party audio conference"],"example":"telephony"},"audio_conference_info":{"description":"Third party audio conference info.","type":"string","maxLength":2048,"example":"test"},"authentication_domains":{"description":"If user has configured [\"Sign Into Zoom with Specified Domains\"](https://support.zoom.us/hc/en-us/articles/360037117472-Authentication-Profiles-for-Meetings-and-Webinars#h_5c0df2e1-cfd2-469f-bb4a-c77d7c0cca6f) option, this will list the domains that are authenticated.","type":"string","example":"example.com"},"authentication_exception":{"description":"The participants added here will receive unique meeting invite links and bypass authentication.","items":{"properties":{"email":{"description":"Email address of the participant.","format":"email","type":"string","example":"jchill@example.com"},"name":{"description":"Name of the participant.","type":"string","example":"Jill Chill"},"join_url":{"description":"URL for participants to join the meeting","type":"string","example":"https://example.com/s/11111"}},"type":"object"},"type":"array"},"authentication_name":{"description":"Authentication name set in the [authentication profile](https://support.zoom.us/hc/en-us/articles/360037117472-Authentication-Profiles-for-Meetings-and-Webinars#h_5c0df2e1-cfd2-469f-bb4a-c77d7c0cca6f).","type":"string","example":"Sign in to Zoom"},"authentication_option":{"description":"Meeting authentication option id.","type":"string","example":"signIn_D8cJuqWVQ623CI4Q8yQK0Q"},"auto_recording":{"default":"none","description":"Automatic recording:<br>`local` - Record on local.<br>`cloud` -  Record on cloud.<br>`none` - Disabled.","enum":["local","cloud","none"],"type":"string","x-enum-descriptions":["Record to local device","Record to cloud","No Recording"],"example":"cloud"},"breakout_room":{"description":"Setting to [pre-assign breakout rooms](https://support.zoom.us/hc/en-us/articles/360032752671-Pre-assigning-participants-to-breakout-rooms#h_36f71353-4190-48a2-b999-ca129861c1f4).","properties":{"enable":{"description":"Set the value of this field to `true` if you would like to enable the [breakout room pre-assign](https://support.zoom.us/hc/en-us/articles/360032752671-Pre-assigning-participants-to-breakout-rooms#h_36f71353-4190-48a2-b999-ca129861c1f4) option.","type":"boolean","example":true},"rooms":{"description":"Create room(s).","items":{"properties":{"name":{"description":"Name of the breakout room.","type":"string","example":"room1"},"participants":{"description":"Email addresses of the participants who are to be assigned to the breakout room.","items":{"type":"string","example":"jchill@example.com"},"type":"array"}},"type":"object"},"type":"array"}},"type":"object"},"calendar_type":{"description":"Indicates the type of calendar integration used to schedule the meeting: \n* `1` — [Zoom Outlook add-in](https://support.zoom.us/hc/en-us/articles/360031592971-Getting-started-with-Outlook-plugin-and-add-in) \n* `2` — [Zoom for Google Workspace add-on](https://support.zoom.us/hc/en-us/articles/360020187492-Using-the-Zoom-for-Google-Workspace-add-on)\n\nWorks with the `private_meeting` field to determine whether to share details of meetings or not.","enum":[1,2],"type":"integer","x-enum-descriptions":["Outlook","Google Calendar"],"example":1},"close_registration":{"default":false,"description":"Close registration after event date","type":"boolean","example":false},"cn_meeting":{"type":"boolean","default":false,"deprecated":true,"description":"Host meeting in China.","example":false},"contact_email":{"description":"Contact email for registration","type":"string","example":"jchill@example.com"},"contact_name":{"description":"Contact name for registration","type":"string","example":"Jill Chill"},"custom_keys":{"description":"Custom keys and values assigned to the meeting.","items":{"properties":{"key":{"description":"Custom key associated with the user.","maxLength":64,"type":"string","example":"key1"},"value":{"description":"Value of the custom key associated with the user.","maxLength":256,"type":"string","example":"value1"}},"type":"object"},"maxItems":10,"type":"array"},"email_notification":{"default":true,"description":"Whether to send email notifications to [alternative hosts](https://support.zoom.us/hc/en-us/articles/208220166) and [users with scheduling privileges](https://support.zoom.us/hc/en-us/articles/201362803-Scheduling-privilege). This value defaults to `true`.","type":"boolean","example":true},"encryption_type":{"description":"Choose between enhanced encryption and [end-to-end encryption](https://support.zoom.us/hc/en-us/articles/360048660871) when starting or a meeting. When using end-to-end encryption, several features (e.g. cloud recording, phone/SIP/H.323 dial-in) will be **automatically disabled**. <br><br>The value of this field can be one of the following:<br>\n`enhanced_encryption`: Enhanced encryption. Encryption is stored in the cloud if you enable this option. <br>\n\n`e2ee`: [End-to-end encryption](https://support.zoom.us/hc/en-us/articles/360048660871). The encryption key is stored in your local device and can not be obtained by anyone else. Enabling this setting also **disables** the following features: join before host, cloud recording, streaming, live transcription, breakout rooms, polling, 1:1 private chat, and meeting reactions.","enum":["enhanced_encryption","e2ee"],"type":"string","example":"enhanced_encryption"},"enforce_login":{"deprecated":true,"description":"Only signed in users can join this meeting.\n\n**This field is deprecated and will not be supported in the future.**  <br><br>As an alternative, use the \"meeting_authentication\", \"authentication_option\" and \"authentication_domains\" fields to understand the [authentication configurations](https://support.zoom.us/hc/en-us/articles/360037117472-Authentication-Profiles-for-Meetings-and-Webinars) set for the meeting.","type":"boolean","example":true},"enforce_login_domains":{"deprecated":true,"description":"Only signed in users with specified domains can join meetings.\n\n**This field is deprecated and will not be supported in the future.**  <br><br>As an alternative, use the \"meeting_authentication\", \"authentication_option\" and \"authentication_domains\" fields to understand the [authentication configurations](https://support.zoom.us/hc/en-us/articles/360037117472-Authentication-Profiles-for-Meetings-and-Webinars) set for the meeting.","type":"string","example":"example.com"},"focus_mode":{"description":"Whether the [**Focus Mode** feature](https://support.zoom.us/hc/en-us/articles/360061113751-Using-focus-mode) is enabled when the meeting starts.","type":"boolean","example":true},"global_dial_in_countries":{"description":"List of global dial-in countries","items":{"type":"string","example":"US"},"type":"array"},"global_dial_in_numbers":{"description":"Global Dial-in Countries/Regions","items":{"properties":{"city":{"description":"City of the number, if any. For example, Chicago.","type":"string","example":"New York"},"country":{"description":"Country code. For example, BR.","type":"string","example":"US"},"country_name":{"description":"Full name of country. For example, Brazil.","type":"string","example":"US"},"number":{"description":"Phone number. For example, +1 2332357613.","type":"string","example":"+1 1000200200"},"type":{"description":"Type of number. ","enum":["toll","tollfree"],"type":"string","example":"toll"}},"type":"object"},"type":"array"},"host_video":{"description":"Start video when the host joins the meeting.","type":"boolean","example":true},"in_meeting":{"type":"boolean","default":false,"deprecated":true,"description":"Host meeting in India.","example":false},"jbh_time":{"description":"If the value of \"join_before_host\" field is set to true, this field can be used to indicate time limits within which a participant may join a meeting before a host. The value of this field can be one of the following:\n\n*  `0`: Allow participant to join anytime.\n*  `5`: Allow participant to join 5 minutes before meeting start time.\n * `10`: Allow participant to join 10 minutes before meeting start time.","enum":[0,5,10],"type":"integer","example":0},"join_before_host":{"default":false,"description":"Allow participants to join the meeting before the host starts the meeting. Only used for scheduled or recurring meetings.","type":"boolean","example":true},"language_interpretation":{"description":"The meeting's [language interpretation settings](https://support.zoom.us/hc/en-us/articles/360034919791-Language-interpretation-in-meetings-and-webinars). Make sure to add the language in the web portal in order to use it in the API. See link for details. \n\n**Note:** This feature is only available for certain Meeting add-on, Education, and Business and higher plans. If this feature is not enabled on the host's account, this setting will **not** be applied to the meeting.","properties":{"enable":{"description":"Whether to enable [language interpretation](https://support.zoom.us/hc/en-us/articles/360034919791-Language-interpretation-in-meetings-and-webinars) for the meeting.","type":"boolean","example":true},"interpreters":{"description":"Information about the meeting's language interpreters.","items":{"properties":{"email":{"description":"The interpreter's email address.","format":"email","type":"string","example":"interpreter@example.com"},"languages":{"description":"A comma-separated list of the interpreter's languages. The string must contain two [country IDs](https://marketplace.zoom.us/docs/api-reference/other-references/abbreviation-lists#countries). \n\nFor example, if the interpreter will translate from English to Chinese, then this value will be `US,CN`.","type":"string","example":"US,FR"}},"type":"object"},"type":"array"}},"type":"object"},"meeting_authentication":{"description":"`true`- Only authenticated users can join meetings.","type":"boolean","example":true},"mute_upon_entry":{"default":false,"description":"Mute participants upon entry.","type":"boolean","example":false},"participant_video":{"description":"Start video when participants join the meeting.","type":"boolean","example":false},"private_meeting":{"description":"Whether the meeting is set as private.","type":"boolean","example":false},"registrants_confirmation_email":{"description":"Send confirmation Email to Registrants","type":"boolean","example":true},"registrants_email_notification":{"description":"Whether to send registrants email notifications about their registration approval, cancellation, or rejection:\n\n* `true` — Send an email notification.\n* `false` — Do not send an email notification.\n\n Set this value to `true` to also use the `registrants_confirmation_email` parameter.","type":"boolean","example":true},"registration_type":{"default":1,"description":"Registration type. Used for recurring meeting with fixed time only. <br>`1` Attendees register once and can attend any of the occurrences.<br>`2` Attendees need to register for each occurrence to attend.<br>`3` Attendees register once and can choose one or more occurrences to attend.","enum":[1,2,3],"type":"integer","x-enum-descriptions":["Attendees register once and can attend any of the occurrences","Attendees need to register for each occurrence to attend","Attendees register once and can choose one or more occurrences to attend"],"example":1},"show_share_button":{"description":"Show social share buttons on the meeting registration page.\nThis setting only works for meetings that require [registration](https://support.zoom.us/hc/en-us/articles/211579443-Setting-up-registration-for-a-meeting).","type":"boolean","example":true},"use_pmi":{"default":false,"description":"Use a [Personal Meeting ID (PMI)](https://marketplace.zoom.us/docs/api-reference/using-zoom-apis#understanding-personal-meeting-id-pmi). Only used for scheduled meetings and recurring meetings with no fixed time.","type":"boolean","example":false},"waiting_room":{"default":false,"description":"Enable waiting room","type":"boolean","example":false},"watermark":{"default":false,"description":"Add watermark when viewing a shared screen.","type":"boolean","example":false},"host_save_video_order":{"type":"boolean","description":"Whether the **Allow host to save video order** feature is enabled.","example":true},"meeting_invitees":{"description":"A list of the meeting's invitees.","items":{"properties":{"email":{"description":"The invitee's email address.","format":"email","type":"string","example":"jchil@example.com"}},"type":"object"},"type":"array"}},"type":"object"},"start_time":{"description":"Meeting start time. When using a format like \"yyyy-MM-dd'T'HH:mm:ss'Z'\", always use GMT time. When using a format like \"yyyy-MM-dd'T'HH:mm:ss\", you should use local time and  specify the time zone. Only used for scheduled meetings and recurring meetings with a fixed time.","format":"date-time","type":"string","example":"2022-03-25T07:29:29Z"},"template_id":{"description":"Unique identifier of the meeting template. \n\nUse this field if you would like to [schedule the meeting from a meeting template](https://support.zoom.us/hc/en-us/articles/360036559151-Meeting-templates#h_86f06cff-0852-4998-81c5-c83663c176fb). You can retrieve the value of this field by calling the [List meeting templates](https://marketplace.zoom.us/docs/api-reference/zoom-api/methods#operation/listMeetingTemplates) API.","type":"string","example":"5Cj3ceXoStO6TGOVvIOVPA=="},"timezone":{"description":"Time zone to format start_time. For example, \"America/Los_Angeles\". For scheduled meetings only. Please reference our [time zone](#timezones) list for supported time zones and their formats.","type":"string","example":"America/Los_Angeles"},"topic":{"description":"Meeting topic.","type":"string","maxLength":200,"example":"My Meeting"},"tracking_fields":{"description":"Tracking fields","items":{"properties":{"field":{"description":"Tracking fields type","type":"string","example":"field1"},"value":{"description":"Tracking fields value","type":"string","example":"value1"}},"type":"object"},"type":"array"},"type":{"default":2,"description":"Meeting Types:<br>`1` - Instant meeting.<br>`2` - Scheduled meeting.<br>`3` - Recurring meeting with no fixed time.<br>`8` - Recurring meeting with a fixed time.","enum":[1,2,3,8],"type":"integer","x-enum-descriptions":["Instant Meeting","Scheduled Meeting","Recurring Meeting with no fixed time","Recurring Meeting with fixed time"],"example":2}},"type":"object","description":"Meeting object"}}},"description":"Meeting","required":true},"summary":"Update a meeting"}},"/meetings/{meetingId}/status":{"put":{"parameters":[{"in":"path","name":"meetingId","required":true,"description":"The meeting's ID. \n\n When storing this value in your database, you must store it as a long format integer and **not** an integer. Meeting IDs can exceed 10 digits.","schema":{"format":"int64","type":"integer","example":85746065}}],"responses":{"204":{"description":"**HTTP Status Code:** `204`<br>\nMeeting updated."},"400":{"description":"**HTTP Status Code:** `400`<br>\n**Error Code:** `1010`<br>\nUser does not belong to this account: {accountId}.\n**Error Code:** `3000`<br>\nCannot access meeting info.\n**Error Code:** `3003`<br>\nYou're not the meeting host.\n**Error Code:** `3063`<br>\nCan not end on-premise user's meeting: {meetingId}. \n\n **Error Code:** `3161` <br>\nMeeting hosting and scheduling capabilities are not allowed for your user account."},"404":{"description":"**HTTP Status Code:** `404`<br>\nMeeting not found.<br>\n**Error Code:** `1001`<br>\nMeeting host does not exist: {userId}.\n\n"}},"security":[{"OAuth":[]}],"tags":["Meetings"],"description":"Update the status of a meeting.<br><br>\n**Scopes:** `meeting:write:admin` `meeting:write`\n **[Rate Limit Label](https://developers.zoom.us/docs/api/rest/rate-limits/):** `Light`","operationId":"meetingStatus","requestBody":{"content":{"application/json":{"schema":{"properties":{"action":{"description":"`end` - End a meeting.<br>\n`recover` - [Recover](https://support.zoom.us/hc/en-us/articles/360038297111-Recover-a-deleted-meeting) a deleted meeting.\n","enum":["end","recover"],"type":"string","example":"recover"}},"type":"object"}}},"required":true},"summary":"Update meeting status"}},"/meetings/{meetingId}/invite_links":{"post":{"summary":"Create meeting's invite links","description":"Create a batch of invitation links for a meeting.\n\n**Scopes**: `meeting:write:admin`, `meeting:write`</br>**[Rate Limit Label](https://developers.zoom.us/docs/api/rest/rate-limits/):** `Light`","tags":["Meetings"],"operationId":"meetingInviteLinksCreate","parameters":[{"in":"path","name":"meetingId","required":true,"description":"The meeting's ID. \n\n When storing this value in your database, you must store it as a long format integer and **not** an integer. Meeting IDs can exceed 10 digits.","schema":{"format":"int64","type":"integer","example":85746065}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"description":"Invite Links","properties":{"attendees":{"description":"The attendees list.","items":{"properties":{"name":{"description":"User display name.","maxLength":64,"type":"string","example":"Jill Chill"}},"required":["name"],"type":"object"},"type":"array","minItems":1,"maxItems":500},"ttl":{"default":7200,"description":"The invite link's expiration time, in seconds. \n\nThis value defaults to `7200`.","format":"int64","maximum":7776000,"minimum":0,"type":"integer","example":1000}},"title":"Invite Links","type":"object"}}}},"responses":{"201":{"content":{"application/json":{"schema":{"description":"Invite links response.","properties":{"attendees":{"description":"The attendee list.","items":{"properties":{"join_url":{"description":"The URL to join the meeting.","type":"string","example":"https://example.com/j/11111"},"name":{"description":"The user's display name.","type":"string","example":"Jill Chill"}},"type":"object"},"type":"array"}},"title":"Invite Links","type":"object"}}},"description":"**HTTP Status Code:** `201` <br>\nMeeting invitation links created."},"400":{"description":"**HTTP Status Code:** `400` <br>\nBad Request \n\n**Error Code:** `300` <br>\n* Meeting ID does not exist. \n* Invalid meeting ID. \n\n**Error Code:** `3000` <br>\nCannot access webinar information. \n\n**Error Code:** `3001` <br>\nMeeting does not exist: {meetingId} \n\n**Error Code:** `3161` <br>\nMeeting hosting and scheduling capabilities are not allowed for your user account."}},"security":[{"OAuth":[]}]}},"/information_barriers/policies":{"get":{"responses":{"200":{"content":{"application/json":{"schema":{"additionalProperties":false,"properties":{"policies":{"items":{"additionalProperties":false,"properties":{"assigned_group_id":{"description":"The assigner group's (Group 1) ID.","type":"string","example":"SsxAmMT7QPOH19Kf9ZHz6g"},"id":{"description":"The Information Barriers policy's ID.","type":"string","example":"ErxAmMT7QPOH19Kf9Z55ty"},"policy_name":{"description":"The Information Barriers policy's name.","type":"string","example":"test"},"settings":{"additionalProperties":false,"description":"The Information Barriers policy's settings. \n* If the `meeting` setting is `true`, then a [hard block](https://support.zoom.us/hc/en-us/articles/360040913711-Information-Barriers#h_a603c6f7-05c8-4de5-b4b6-91982d748b34) exists between both groups. \n* If the `meeting` setting is `false` but the `screen_share`, `file_transfer`, `in_meeting_chat`, `im`, and/or `recording` settings are `true`, then a [soft block](https://support.zoom.us/hc/en-us/articles/360040913711-Information-Barriers#h_a603c6f7-05c8-4de5-b4b6-91982d748b34) exists between both groups.","properties":{"complete_phone_calls":{"description":"If true, users between groups **cannot** call each other.","type":"boolean","example":false},"file_transfer":{"description":"If true, users between groups **cannot** transfer files in a meeting. This also creates a [soft block](https://support.zoom.us/hc/en-us/articles/360040913711-Information-Barriers#h_a603c6f7-05c8-4de5-b4b6-91982d748b34) between both groups if the `meeting` value is `false`.","type":"boolean","example":false},"im":{"description":"If true, users between groups **cannot** IM chat. This also creates a [soft block](https://support.zoom.us/hc/en-us/articles/360040913711-Information-Barriers#h_a603c6f7-05c8-4de5-b4b6-91982d748b34) between both groups if the `meeting` value is `false`.","type":"boolean","example":false},"in_meeting_chat":{"description":"If true, users between groups **cannot** use chat in a meeting. This also creates a [soft block](https://support.zoom.us/hc/en-us/articles/360040913711-Information-Barriers#h_a603c6f7-05c8-4de5-b4b6-91982d748b34) between both groups if the `meeting` value is `false`.","type":"boolean","example":false},"meeting":{"description":"If true, the users between groups **cannot** meet. This also creates a [hard block](https://support.zoom.us/hc/en-us/articles/360040913711-Information-Barriers#h_a603c6f7-05c8-4de5-b4b6-91982d748b34) between both groups.","type":"boolean","example":false},"message_via_sms":{"description":"If true, users between groups **cannot** user SMS.","type":"boolean","example":false},"recording":{"description":"If true, users between groups **cannot** record the meeting. This also creates a [soft block](https://support.zoom.us/hc/en-us/articles/360040913711-Information-Barriers#h_a603c6f7-05c8-4de5-b4b6-91982d748b34) between both groups if the `meeting` value is `false`. \n\nThis feature is only available for Zoom Client v5.6.0 and higher.","type":"boolean","example":false},"screen_share":{"description":"If true, users between groups **cannot** share screens in a meeting. This also creates a [soft block](https://support.zoom.us/hc/en-us/articles/360040913711-Information-Barriers#h_a603c6f7-05c8-4de5-b4b6-91982d748b34) between both groups if the `meeting` value is `false`.","type":"boolean","example":false}},"required":["meeting","screen_share","file_transfer","in_meeting_chat","complete_phone_calls","message_via_sms","im","recording"],"type":"object"},"status":{"description":"The Information Barriers policy's status. \n* `0` — Disabled. \n* `1` — Enabled.","enum":[0,1],"type":"integer","example":1},"to_group_id":{"description":"The assignee group's (Group 2) ID.","type":"string","example":"mjLMOSAERBaakF8kSDWB7g"},"type":{"default":0,"description":"The Information Barriers policy's type of `settings` restrictions. \n* `0` — A [hard or soft block](https://support.zoom.us/hc/en-us/articles/360040913711-Information-Barriers#h_a603c6f7-05c8-4de5-b4b6-91982d748b34) exists, but users in Group 1 and Group 2 can chat with each other. \n* `1` — A [hard or soft block](https://support.zoom.us/hc/en-us/articles/360040913711-Information-Barriers#h_a603c6f7-05c8-4de5-b4b6-91982d748b34) exists and only users in Group 1 can chat with users in Group 2. \n* `2` — No blocks exist, but only users in Group 1 can chat with users in Group 2. \n* `3` — No blocks exist and users in Group 1 and Group 2 can chat with each other. \n\nThis field only supports `0`.","enum":[0,1,2,3],"type":"integer","example":1}},"required":["id","assigned_group_id","to_group_id","policy_name","settings","type","status"],"type":"object"},"type":"array"},"total_records":{"description":"The total count of Information Barriers policies.","type":"integer","example":30}},"required":["total_records","policies"],"type":"object"}}},"description":"**HTTP Status Code:** `200` <br> InformationBarriers returned."}},"tags":["Information Barriers"],"description":"Return a list of all [Information Barriers](https://support.zoom.us/hc/en-us/articles/360040913711-Information-Barriers) policies and their information. \n\n **Scope:** `information_barriers:read:admin` <br> **[Rate Limit Label](https://developers.zoom.us/docs/api/rest/rate-limits/):** `Medium` \n\n**Prerequisites:** \n* [Contact Zoom Support](https://support.zoom.us/hc/en-us/articles/201362003) to enable Information Barriers for your account.","operationId":"InformationBarriersList","summary":"List information Barrier policies"},"post":{"responses":{"201":{"content":{"application/json":{"schema":{"additionalProperties":false,"properties":{"assigned_group_id":{"description":"The assigner group's (Group 1) ID.","type":"string","example":"SsxAmMT7QPOH19Kf9ZHz6g"},"id":{"description":"The Information Barriers policy's ID.","type":"string","example":"ErxAmMT7QPOH19Kf9Z55ty"},"policy_name":{"description":"The Information Barriers policy's name.","type":"string","example":"test"},"settings":{"additionalProperties":false,"description":"The Information Barriers policy's settings. \n* If the `meeting` setting is `true`, then a [hard block](https://support.zoom.us/hc/en-us/articles/360040913711-Information-Barriers#h_a603c6f7-05c8-4de5-b4b6-91982d748b34) exists between both groups. \n* If the `meeting` setting is `false` but the `screen_share`, `file_transfer`, `in_meeting_chat`, `im`, and/or `recording` settings are `true`, then a [soft block](https://support.zoom.us/hc/en-us/articles/360040913711-Information-Barriers#h_a603c6f7-05c8-4de5-b4b6-91982d748b34) exists between both groups.","properties":{"complete_phone_calls":{"description":"If true, users between groups **cannot** call each other.","type":"boolean","example":false},"file_transfer":{"description":"If true, users between groups **cannot** transfer files in a meeting. This also creates a [soft block](https://support.zoom.us/hc/en-us/articles/360040913711-Information-Barriers#h_a603c6f7-05c8-4de5-b4b6-91982d748b34) between both groups if the `meeting` value is `false`.","type":"boolean","example":false},"im":{"description":"If true, users between groups **cannot** IM chat. This also creates a [soft block](https://support.zoom.us/hc/en-us/articles/360040913711-Information-Barriers#h_a603c6f7-05c8-4de5-b4b6-91982d748b34) between both groups if the `meeting` value is `false`.","type":"boolean","example":false},"in_meeting_chat":{"description":"If true, users between groups **cannot** use chat in a meeting. This also creates a [soft block](https://support.zoom.us/hc/en-us/articles/360040913711-Information-Barriers#h_a603c6f7-05c8-4de5-b4b6-91982d748b34) between both groups if the `meeting` value is `false`.","type":"boolean","example":false},"meeting":{"description":"If true, the users between groups **cannot** meet. This also creates a [hard block](https://support.zoom.us/hc/en-us/articles/360040913711-Information-Barriers#h_a603c6f7-05c8-4de5-b4b6-91982d748b34) between both groups.","type":"boolean","example":false},"message_via_sms":{"description":"If true, users between groups **cannot** user SMS.","type":"boolean","example":false},"recording":{"description":"If true, users between groups **cannot** record the meeting. This also creates a [soft block](https://support.zoom.us/hc/en-us/articles/360040913711-Information-Barriers#h_a603c6f7-05c8-4de5-b4b6-91982d748b34) between both groups if the `meeting` value is `false`. \n\nThis feature is only available for Zoom Client v5.6.0 and higher.","type":"boolean","example":false},"screen_share":{"description":"If true, users between groups **cannot** share screens in a meeting. This also creates a [soft block](https://support.zoom.us/hc/en-us/articles/360040913711-Information-Barriers#h_a603c6f7-05c8-4de5-b4b6-91982d748b34) between both groups if the `meeting` value is `false`.","type":"boolean","example":false}},"required":["meeting","screen_share","file_transfer","in_meeting_chat","complete_phone_calls","message_via_sms","im","recording"],"type":"object"},"status":{"description":"The Information Barriers policy's status. \n* `0` — Disabled. \n* `1` — Enabled.","enum":[0,1],"type":"integer","example":1},"to_group_id":{"description":"The assignee group's (Group 2) ID.","type":"string","example":"mjLMOSAERBaakF8kSDWB7g"},"type":{"default":0,"description":"The Information Barriers policy's type of `settings` restrictions. \n* `0` — A [hard or soft block](https://support.zoom.us/hc/en-us/articles/360040913711-Information-Barriers#h_a603c6f7-05c8-4de5-b4b6-91982d748b34) exists, but users in Group 1 and Group 2 can chat with each other. \n* `1` — A [hard or soft block](https://support.zoom.us/hc/en-us/articles/360040913711-Information-Barriers#h_a603c6f7-05c8-4de5-b4b6-91982d748b34) exists and only users in Group 1 can chat with users in Group 2. \n* `2` — No blocks exist, but only users in Group 1 can chat with users in Group 2. \n* `3` — No blocks exist and users in Group 1 and Group 2 can chat with each other. \n\nThis field only supports `0`.","enum":[0,1,2,3],"type":"integer","example":1}},"required":["id","assigned_group_id","to_group_id","policy_name","settings","type","status"],"type":"object"}}},"description":"**HTTP Status Code:** `201` <br> Information Barriers created."},"400":{"description":"**HTTP Status Code:** `400` <br> Bad request. \n\n**Error Code:** `300` <br> assigned_group_id and to_group_id are required fields and cannot be left empty or the same. \n\n**Error Code:** `300` <br> assigned_group_id and to_group_id are required fields and cannot be left empty or the same. \n\n**Error Code:** `7002` <br> Unable to add this policy, as it would create duplicate policies which is not permitted. assigned_group_id: {0}, to_group_id: {1}."}},"tags":["Information Barriers"],"description":"Create a new Information Barrier policy. [Information Barriers](https://support.zoom.us/hc/en-us/articles/360040913711-Information-Barriers) help customers control communication policies and meet regulatory requirements at scale. Use information barriers to prevent specific groups of users who possess sensitive information from communicating with others who should not know this information. \n\n **Scope:** `information_barriers:write:admin` <br> **[Rate Limit Label](https://developers.zoom.us/docs/api/rest/rate-limits/):** `Medium` \n\n**Prerequisites:** \n* [Contact Zoom Support](https://support.zoom.us/hc/en-us/articles/201362003) to enable Information Barriers for your account.","operationId":"InformationBarriersCreate","requestBody":{"content":{"application/json":{"schema":{"additionalProperties":false,"properties":{"assigned_group_id":{"description":"The assigner group's (Group 1) ID.","type":"string","example":"SsxAmMT7QPOH19Kf9ZHz6g"},"id":{"description":"The Information Barriers policy's ID.","type":"string","example":"ErxAmMT7QPOH19Kf9Z55ty"},"policy_name":{"description":"The Information Barriers policy's name.","type":"string","example":"test"},"settings":{"additionalProperties":false,"description":"The Information Barriers policy's settings. \n* If the `meeting` setting is `true`, then a [hard block](https://support.zoom.us/hc/en-us/articles/360040913711-Information-Barriers#h_a603c6f7-05c8-4de5-b4b6-91982d748b34) exists between both groups. \n* If the `meeting` setting is `false` but the `screen_share`, `file_transfer`, `in_meeting_chat`, `im`, and/or `recording` settings are `true`, then a [soft block](https://support.zoom.us/hc/en-us/articles/360040913711-Information-Barriers#h_a603c6f7-05c8-4de5-b4b6-91982d748b34) exists between both groups.","properties":{"complete_phone_calls":{"description":"If true, users between groups **cannot** call each other.","type":"boolean","example":false},"file_transfer":{"description":"If true, users between groups **cannot** transfer files in a meeting. This also creates a [soft block](https://support.zoom.us/hc/en-us/articles/360040913711-Information-Barriers#h_a603c6f7-05c8-4de5-b4b6-91982d748b34) between both groups if the `meeting` value is `false`.","type":"boolean","example":false},"im":{"description":"If true, users between groups **cannot** IM chat. This also creates a [soft block](https://support.zoom.us/hc/en-us/articles/360040913711-Information-Barriers#h_a603c6f7-05c8-4de5-b4b6-91982d748b34) between both groups if the `meeting` value is `false`.","type":"boolean","example":false},"in_meeting_chat":{"description":"If true, users between groups **cannot** use chat in a meeting. This also creates a [soft block](https://support.zoom.us/hc/en-us/articles/360040913711-Information-Barriers#h_a603c6f7-05c8-4de5-b4b6-91982d748b34) between both groups if the `meeting` value is `false`.","type":"boolean","example":false},"meeting":{"description":"If true, the users between groups **cannot** meet. This also creates a [hard block](https://support.zoom.us/hc/en-us/articles/360040913711-Information-Barriers#h_a603c6f7-05c8-4de5-b4b6-91982d748b34) between both groups.","type":"boolean","example":false},"message_via_sms":{"description":"If true, users between groups **cannot** user SMS.","type":"boolean","example":false},"recording":{"description":"If true, users between groups **cannot** record the meeting. This also creates a [soft block](https://support.zoom.us/hc/en-us/articles/360040913711-Information-Barriers#h_a603c6f7-05c8-4de5-b4b6-91982d748b34) between both groups if the `meeting` value is `false`. \n\nThis feature is only available for Zoom Client v5.6.0 and higher.","type":"boolean","example":false},"screen_share":{"description":"If true, users between groups **cannot** share screens in a meeting. This also creates a [soft block](https://support.zoom.us/hc/en-us/articles/360040913711-Information-Barriers#h_a603c6f7-05c8-4de5-b4b6-91982d748b34) between both groups if the `meeting` value is `false`.","type":"boolean","example":false}},"required":["meeting","screen_share","file_transfer","in_meeting_chat","complete_phone_calls","message_via_sms","im","recording"],"type":"object"},"status":{"description":"The Information Barriers policy's status. \n* `0` — Disabled. \n* `1` — Enabled.","enum":[0,1],"type":"integer","example":1},"to_group_id":{"description":"The assignee group's (Group 2) ID.","type":"string","example":"mjLMOSAERBaakF8kSDWB7g"},"type":{"default":0,"description":"The Information Barriers policy's type of `settings` restrictions. \n* `0` — A [hard or soft block](https://support.zoom.us/hc/en-us/articles/360040913711-Information-Barriers#h_a603c6f7-05c8-4de5-b4b6-91982d748b34) exists, but users in Group 1 and Group 2 can chat with each other. \n* `1` — A [hard or soft block](https://support.zoom.us/hc/en-us/articles/360040913711-Information-Barriers#h_a603c6f7-05c8-4de5-b4b6-91982d748b34) exists and only users in Group 1 can chat with users in Group 2. \n* `2` — No blocks exist, but only users in Group 1 can chat with users in Group 2. \n* `3` — No blocks exist and users in Group 1 and Group 2 can chat with each other. \n\nThis field only supports `0`.","enum":[0,1,2,3],"type":"integer","example":1}},"required":["id","assigned_group_id","to_group_id","policy_name","settings","type","status"],"type":"object"}}},"description":"Information Barriers object","required":true},"summary":"Create an Information Barrier policy"}},"/information_barriers/policies/{policyId}":{"delete":{"parameters":[{"description":"The Information Barriers policy's ID.","in":"path","name":"policyId","required":true,"schema":{"type":"string","example":"ErxAmMT7QPOH19Kf9Z55ty"}}],"responses":{"204":{"description":"**HTTP Status Code:** `204` <br> Information Barriers deleted."},"400":{"description":"**HTTP Status Code:** `400` <br> Bad request.\n\n**Error Code:** `7001` <br> Group policy not found: {0}."}},"tags":["Information Barriers"],"description":"Remove an [Information Barrier](https://support.zoom.us/hc/en-us/articles/360040913711-Information-Barriers) policy.\n\n **Scope:** `information_barriers:write:admin` <br> **[Rate Limit Label](https://developers.zoom.us/docs/api/rest/rate-limits/):** `Medium` \n\n**Prerequisites:** \n* [Contact Zoom Support](https://support.zoom.us/hc/en-us/articles/201362003) to enable Information Barriers for your account.","operationId":"InformationBarriersDelete","summary":"Remove an Information Barrier policy"},"get":{"parameters":[{"description":"The Information Barrier policy's ID.","in":"path","name":"policyId","required":true,"schema":{"type":"string","example":"ErxAmMT7QPOH19Kf9Z55ty"}}],"responses":{"200":{"content":{"application/json":{"schema":{"additionalProperties":false,"properties":{"assigned_group_id":{"description":"The assigner group's (Group 1) ID.","type":"string","example":"SsxAmMT7QPOH19Kf9ZHz6g"},"id":{"description":"The Information Barriers policy's ID.","type":"string","example":"ErxAmMT7QPOH19Kf9Z55ty"},"policy_name":{"description":"The Information Barriers policy's name.","type":"string","example":"test"},"settings":{"additionalProperties":false,"description":"The Information Barriers policy's settings. \n* If the `meeting` setting is `true`, then a [hard block](https://support.zoom.us/hc/en-us/articles/360040913711-Information-Barriers#h_a603c6f7-05c8-4de5-b4b6-91982d748b34) exists between both groups. \n* If the `meeting` setting is `false` but the `screen_share`, `file_transfer`, `in_meeting_chat`, `im`, and/or `recording` settings are `true`, then a [soft block](https://support.zoom.us/hc/en-us/articles/360040913711-Information-Barriers#h_a603c6f7-05c8-4de5-b4b6-91982d748b34) exists between both groups.","properties":{"complete_phone_calls":{"description":"If true, users between groups **cannot** call each other.","type":"boolean","example":false},"file_transfer":{"description":"If true, users between groups **cannot** transfer files in a meeting. This also creates a [soft block](https://support.zoom.us/hc/en-us/articles/360040913711-Information-Barriers#h_a603c6f7-05c8-4de5-b4b6-91982d748b34) between both groups if the `meeting` value is `false`.","type":"boolean","example":false},"im":{"description":"If true, users between groups **cannot** IM chat. This also creates a [soft block](https://support.zoom.us/hc/en-us/articles/360040913711-Information-Barriers#h_a603c6f7-05c8-4de5-b4b6-91982d748b34) between both groups if the `meeting` value is `false`.","type":"boolean","example":false},"in_meeting_chat":{"description":"If true, users between groups **cannot** use chat in a meeting. This also creates a [soft block](https://support.zoom.us/hc/en-us/articles/360040913711-Information-Barriers#h_a603c6f7-05c8-4de5-b4b6-91982d748b34) between both groups if the `meeting` value is `false`.","type":"boolean","example":false},"meeting":{"description":"If true, the users between groups **cannot** meet. This also creates a [hard block](https://support.zoom.us/hc/en-us/articles/360040913711-Information-Barriers#h_a603c6f7-05c8-4de5-b4b6-91982d748b34) between both groups.","type":"boolean","example":false},"message_via_sms":{"description":"If true, users between groups **cannot** user SMS.","type":"boolean","example":false},"recording":{"description":"If true, users between groups **cannot** record the meeting. This also creates a [soft block](https://support.zoom.us/hc/en-us/articles/360040913711-Information-Barriers#h_a603c6f7-05c8-4de5-b4b6-91982d748b34) between both groups if the `meeting` value is `false`. \n\nThis feature is only available for Zoom Client v5.6.0 and higher.","type":"boolean","example":false},"screen_share":{"description":"If true, users between groups **cannot** share screens in a meeting. This also creates a [soft block](https://support.zoom.us/hc/en-us/articles/360040913711-Information-Barriers#h_a603c6f7-05c8-4de5-b4b6-91982d748b34) between both groups if the `meeting` value is `false`.","type":"boolean","example":false}},"required":["meeting","screen_share","file_transfer","in_meeting_chat","complete_phone_calls","message_via_sms","im","recording"],"type":"object"},"status":{"description":"The Information Barriers policy's status. \n* `0` — Disabled. \n* `1` — Enabled.","enum":[0,1],"type":"integer","example":1},"to_group_id":{"description":"The assignee group's (Group 2) ID.","type":"string","example":"mjLMOSAERBaakF8kSDWB7g"},"type":{"default":0,"description":"The Information Barriers policy's type of `settings` restrictions. \n* `0` — A [hard or soft block](https://support.zoom.us/hc/en-us/articles/360040913711-Information-Barriers#h_a603c6f7-05c8-4de5-b4b6-91982d748b34) exists, but users in Group 1 and Group 2 can chat with each other. \n* `1` — A [hard or soft block](https://support.zoom.us/hc/en-us/articles/360040913711-Information-Barriers#h_a603c6f7-05c8-4de5-b4b6-91982d748b34) exists and only users in Group 1 can chat with users in Group 2. \n* `2` — No blocks exist, but only users in Group 1 can chat with users in Group 2. \n* `3` — No blocks exist and users in Group 1 and Group 2 can chat with each other. \n\nThis field only supports `0`.","enum":[0,1,2,3],"type":"integer","example":1}},"required":["id","assigned_group_id","to_group_id","policy_name","settings","type","status"],"type":"object"}}},"description":"**HTTP Status Code:** `200` <br> Information Barriers returned."}},"tags":["Information Barriers"],"description":"Return an [Information Barriers](https://support.zoom.us/hc/en-us/articles/360040913711-Information-Barriers) policy by its ID. \n\n **Scope:** `information_barriers:read:admin` <br> **[Rate Limit Label](https://developers.zoom.us/docs/api/rest/rate-limits/):** `Medium` \n\n**Prerequisites:** \n* [Contact Zoom Support](https://support.zoom.us/hc/en-us/articles/201362003) to enable Information Barriers for your account.","operationId":"InformationBarriersGet","summary":"Get an Information Barrier policy by ID"},"patch":{"parameters":[{"description":"The Information Barriers policy's ID.","in":"path","name":"policyId","required":true,"schema":{"type":"string","example":"ErxAmMT7QPOH19Kf9Z55ty"}}],"responses":{"200":{"description":"**HTTP Status Code:** `200` <br> Information Barriers updated."},"400":{"description":"**HTTP Status Code:** `400` <br> Bad request.\n\n**Error Code:** `7001` <br> Group policy not found: {0}."}},"tags":["Information Barriers"],"description":"Update an [Information Barriers](https://support.zoom.us/hc/en-us/articles/360040913711-Information-Barriers) policy.\n\n **Scope:** `information_barriers:write:admin` <br> **[Rate Limit Label](https://developers.zoom.us/docs/api/rest/rate-limits/):** `Medium` \n\n **Prerequisites:** \n* [Contact Zoom Support](https://support.zoom.us/hc/en-us/articles/201362003) to enable Information Barriers for your account.","operationId":"InformationBarriersUpdate","requestBody":{"content":{"application/json":{"schema":{"additionalProperties":false,"properties":{"assigned_group_id":{"description":"The assigner group's (Group 1) ID.","type":"string","example":"SsxAmMT7QPOH19Kf9ZHz6g"},"id":{"description":"The Information Barriers policy's ID.","type":"string","example":"ErxAmMT7QPOH19Kf9Z55ty"},"policy_name":{"description":"The Information Barriers policy's name.","type":"string","example":"test"},"settings":{"additionalProperties":false,"description":"The Information Barriers policy's settings. \n* If the `meeting` setting is `true`, then a [hard block](https://support.zoom.us/hc/en-us/articles/360040913711-Information-Barriers#h_a603c6f7-05c8-4de5-b4b6-91982d748b34) exists between both groups. \n* If the `meeting` setting is `false` but the `screen_share`, `file_transfer`, `in_meeting_chat`, `im`, and/or `recording` settings are `true`, then a [soft block](https://support.zoom.us/hc/en-us/articles/360040913711-Information-Barriers#h_a603c6f7-05c8-4de5-b4b6-91982d748b34) exists between both groups.","properties":{"complete_phone_calls":{"description":"If true, users between groups **cannot** call each other.","type":"boolean","example":false},"file_transfer":{"description":"If true, users between groups **cannot** transfer files in a meeting. This also creates a [soft block](https://support.zoom.us/hc/en-us/articles/360040913711-Information-Barriers#h_a603c6f7-05c8-4de5-b4b6-91982d748b34) between both groups if the `meeting` value is `false`.","type":"boolean","example":false},"im":{"description":"If true, users between groups **cannot** IM chat. This also creates a [soft block](https://support.zoom.us/hc/en-us/articles/360040913711-Information-Barriers#h_a603c6f7-05c8-4de5-b4b6-91982d748b34) between both groups if the `meeting` value is `false`.","type":"boolean","example":false},"in_meeting_chat":{"description":"If true, users between groups **cannot** use chat in a meeting. This also creates a [soft block](https://support.zoom.us/hc/en-us/articles/360040913711-Information-Barriers#h_a603c6f7-05c8-4de5-b4b6-91982d748b34) between both groups if the `meeting` value is `false`.","type":"boolean","example":false},"meeting":{"description":"If true, the users between groups **cannot** meet. This also creates a [hard block](https://support.zoom.us/hc/en-us/articles/360040913711-Information-Barriers#h_a603c6f7-05c8-4de5-b4b6-91982d748b34) between both groups.","type":"boolean","example":false},"message_via_sms":{"description":"If true, users between groups **cannot** user SMS.","type":"boolean","example":false},"recording":{"description":"If true, users between groups **cannot** record the meeting. This also creates a [soft block](https://support.zoom.us/hc/en-us/articles/360040913711-Information-Barriers#h_a603c6f7-05c8-4de5-b4b6-91982d748b34) between both groups if the `meeting` value is `false`. \n\nThis feature is only available for Zoom Client v5.6.0 and higher.","type":"boolean","example":false},"screen_share":{"description":"If true, users between groups **cannot** share screens in a meeting. This also creates a [soft block](https://support.zoom.us/hc/en-us/articles/360040913711-Information-Barriers#h_a603c6f7-05c8-4de5-b4b6-91982d748b34) between both groups if the `meeting` value is `false`.","type":"boolean","example":false}},"required":["meeting","screen_share","file_transfer","in_meeting_chat","complete_phone_calls","message_via_sms","im","recording"],"type":"object"},"status":{"description":"The Information Barriers policy's status. \n* `0` — Disabled. \n* `1` — Enabled.","enum":[0,1],"type":"integer","example":1},"to_group_id":{"description":"The assignee group's (Group 2) ID.","type":"string","example":"mjLMOSAERBaakF8kSDWB7g"},"type":{"default":0,"description":"The Information Barriers policy's type of `settings` restrictions. \n* `0` — A [hard or soft block](https://support.zoom.us/hc/en-us/articles/360040913711-Information-Barriers#h_a603c6f7-05c8-4de5-b4b6-91982d748b34) exists, but users in Group 1 and Group 2 can chat with each other. \n* `1` — A [hard or soft block](https://support.zoom.us/hc/en-us/articles/360040913711-Information-Barriers#h_a603c6f7-05c8-4de5-b4b6-91982d748b34) exists and only users in Group 1 can chat with users in Group 2. \n* `2` — No blocks exist, but only users in Group 1 can chat with users in Group 2. \n* `3` — No blocks exist and users in Group 1 and Group 2 can chat with each other. \n\nThis field only supports `0`.","enum":[0,1,2,3],"type":"integer","example":1}},"required":["id","assigned_group_id","to_group_id","policy_name","settings","type","status"],"type":"object"}}},"description":"Information about the updated Information Barriers policy.","required":true},"summary":"Update an Information Barriers policy"}},"/meetings/{meetingId}/invitation":{"get":{"parameters":[{"in":"path","name":"meetingId","required":true,"description":"The meeting's ID. \n\n When storing this value in your database, you must store it as a long format integer and **not** an integer. Meeting IDs can exceed 10 digits.","schema":{"format":"int64","type":"integer","example":85746065}}],"responses":{"200":{"content":{"application/json":{"schema":{"description":"Meeting invitation details.","properties":{"invitation":{"description":"Meeting invitation.","type":"string","example":"Jill Chill is inviting you to a scheduled Zoom meeting.\r\n\r\nTopic: My Meeting\r\nTime: Mar 25, 2022 03:32 PM America, Los_Angeles\r\n\r\nJoin Zoom Meeting\r\nhttps://zoom.us/j/55544443210?pwd=8pEkRweVXPV3Ob2KJYgFTRlDtl1gSn.1\r\n\r\nMeeting ID: 555 4444 3210\r\nPasscode: 123456\r\nOne tap mobile\r\n+5678901234,,55544443210#,,,,*123456# US (gg)\r\n\r\nDial by your location\r\n+1 15550100 US (gg)\r\nMeeting ID: 555 4444 3210\r\nPasscode: 123456\r\nFind your local number: https://zoom.us/u/ab12cdef34jh\r\n\r\nJoin by SIP\r\n5550100@zoomcrc.com\r\n\r\nJoin by H.323\r\n192.0.2.1 (US West)\r\nMeeting ID: 555 4444 3210\r\nPasscode: 123456\r\n\r\n"},"sip_links":{"type":"array","description":"A list of SIP phone addresses.","items":{"type":"string","example":"5550100@zoomcrc.com"}}},"title":"Meeting Invitation","type":"object"}}},"description":"**HTTP Status Code:** `200`<br>\nMeeting invitation returned."},"400":{"description":"**HTTP Status Code:** `400` <br>\n Bad Request \n\n **Error Code:** `3161` <br>\nMeeting hosting and scheduling capabilities are not allowed for your user account."}},"security":[{"OAuth":[]}],"tags":["Meetings"],"description":"Retrieve the meeting invite note that was sent for a specific meeting.<br><br>\n**Scopes:** `meeting:read:admin` `meeting:read`<br>\n\n **[Rate Limit Label](https://developers.zoom.us/docs/api/rest/rate-limits/):** `Light`\n\n","operationId":"meetingInvitation","summary":"Get meeting invitation"}},"/meetings/{meetingId}/registrants":{"get":{"parameters":[{"in":"path","name":"meetingId","required":true,"description":"The meeting's ID. \n\n When storing this value in your database, you must store it as a long format integer and **not** an integer. Meeting IDs can exceed 10 digits.","schema":{"format":"int64","type":"integer","example":85746065}},{"description":"The meeting or webinar occurrence ID.","in":"query","name":"occurrence_id","schema":{"type":"string","example":"1648194360000"}},{"description":"Query by the registrant's status: \n* `pending` — The registration is pending. \n* `approved` — The registrant is approved. \n* `denied` — The registration is denied.","in":"query","name":"status","schema":{"default":"approved","enum":["pending","approved","denied"],"type":"string","example":"pending"},"x-enum-descriptions":["Registration pending.","Registration approved.","Registration denied."]},{"description":"The number of records returned within a single API call.","in":"query","name":"page_size","schema":{"default":30,"maximum":300,"type":"integer","example":30}},{"deprecated":true,"description":"**Deprecated.** We will no longer support this field in a future release. Instead, use the `next_page_token` for pagination.","in":"query","name":"page_number","schema":{"default":1,"type":"integer","example":1}},{"description":"Use the next page token to paginate through large result sets. A next page token is returned whenever the set of available results exceeds the current page size. This token's expiration period is 15 minutes.","in":"query","name":"next_page_token","schema":{"type":"string","example":"IAfJX3jsOLW7w3dokmFl84zOa0MAVGyMEB2"}}],"responses":{"200":{"content":{"application/json":{"schema":{"description":"List of users.","properties":{"next_page_token":{"type":"string","description":"The next page token is used to paginate through large result sets. A next page token will be returned whenever the set of available results exceeds the current page size. The expiration period for this token is 15 minutes.","example":"w7587w4eiyfsudgf"},"page_count":{"type":"integer","description":"The number of pages returned for the request made.","example":1},"page_number":{"deprecated":true,"type":"integer","default":1,"description":"**Deprecated.** We will no longer support this field in a future release. Instead, use the `next_page_token` for pagination.","example":1},"page_size":{"type":"integer","maximum":300,"default":30,"description":"The number of records returned with a single API call.","example":30},"total_records":{"type":"integer","description":"The total number of all the records available across pages.","example":20},"registrants":{"description":"List of registrant objects.","items":{"properties":{"id":{"description":"Registrant ID.","type":"string","example":"9tboDiHUQAeOnbmudzWa5g"},"address":{"description":"The registrant's address.","type":"string","example":"1800 Amphibious Blvd."},"city":{"description":"The registrant's city.","type":"string","example":"Mountain View"},"comments":{"description":"The registrant's questions and comments.","type":"string","example":"Looking forward to the discussion."},"country":{"description":"The registrant's two-letter [country code](https://marketplace.zoom.us/docs/api-reference/other-references/abbreviation-lists#countries).","type":"string","example":"US"},"custom_questions":{"description":"Information about custom questions.","items":{"type":"object","description":"Information about custom questions.","properties":{"title":{"type":"string","description":"The title of the custom question.","example":"What do you hope to learn from this?"},"value":{"type":"string","maxLength":128,"description":"The custom question's response value. This has a limit of 128 characters.","example":"Look forward to learning how you come up with new recipes and what other services you offer."}}},"type":"array"},"email":{"description":"The registrant's email address. See [Email address display rules](https://marketplace.zoom.us/docs/api-reference/using-zoom-apis#email-address) for return value details.","format":"email","maxLength":128,"type":"string","example":"jchill@example.com"},"first_name":{"description":"The registrant's first name.","maxLength":64,"type":"string","example":"Jill"},"industry":{"description":"The registrant's industry.","type":"string","example":"Food"},"job_title":{"description":"The registrant's job title.","type":"string","example":"Chef"},"last_name":{"description":"The registrant's last name.","maxLength":64,"type":"string","example":"Chill"},"no_of_employees":{"description":"The registrant's number of employees: \n* `1-20` \n* `21-50` \n* `51-100` \n* `101-250` \n* `251-500` \n* `501-1,000` \n* `1,001-5,000` \n* `5,001-10,000` \n* `More than 10,000`","enum":["","1-20","21-50","51-100","101-250","251-500","501-1,000","1,001-5,000","5,001-10,000","More than 10,000"],"type":"string","example":"1-20"},"org":{"description":"The registrant's organization.","type":"string","example":"Cooking Org"},"phone":{"description":"The registrant's phone number.","type":"string","example":"5550100"},"purchasing_time_frame":{"description":"The registrant's purchasing time frame: \n* `Within a month` \n* `1-3 months` \n* `4-6 months` \n* `More than 6 months` \n* `No timeframe`","enum":["","Within a month","1-3 months","4-6 months","More than 6 months","No timeframe"],"type":"string","example":"1-3 months"},"role_in_purchase_process":{"description":"The registrant's role in the purchase process: \n* `Decision Maker` \n* `Evaluator/Recommender` \n* `Influencer` \n* `Not involved`","enum":["","Decision Maker","Evaluator/Recommender","Influencer","Not involved"],"type":"string","example":"Influencer"},"state":{"description":"The registrant's state or province.","type":"string","example":"CA"},"status":{"description":"The status of the registrant's registration. <br> `approved`: User has been successfully approved for the webinar.<br> `pending`:  The registration is still pending.<br> `denied`: User has been denied from joining the webinar.","enum":["approved","denied","pending"],"type":"string","example":"approved"},"zip":{"description":"The registrant's ZIP or postal code.","type":"string","example":"94045"},"create_time":{"description":"The time at which the registrant registered.","format":"date-time","type":"string","example":"2022-03-22T05:59:09Z"},"join_url":{"description":"The URL using which an approved registrant can join the meeting or webinar.","format":"string","type":"string","example":"https://example.com/j/11111"},"participant_pin_code":{"description":"The participant PIN code is used to authenticate audio participants before they join the meeting.","type":"integer","format":"int64","example":380303}},"type":"object","description":" Registrant.","required":["email","first_name"]},"type":"array"}},"type":"object","title":"Registration List"}}},"description":"**HTTP Status Code:** `200`<br>\nSuccessfully listed meeting registrants."},"300":{"description":"**Error Code:** `300`<br>\nMeeting {meetingId} is not found or has expired.<br>\nThis meeting has not set registration as required: {meetingId}.\n"},"400":{"description":"**HTTP Status Code:** `400`<br>\n**Error Code:** `1010`<br>\nUser does not belong to this account: {accountId}.<br>\n**Error Code:** `3003`<br>\nYou are not the meeting host.<br>\n**Error Code:** `3000`<br>\nCannot access meeting info. \n\n **Error Code:** `3161` <br>\nMeeting hosting and scheduling capabilities are not allowed for your user account."},"404":{"description":"**HTTP Status Code:** `404`<br>\nMeeting not found.<br>\n**Error Code:** `1001`<br>\nMeeting host does not exist: {userId}."}},"security":[{"OAuth":[]}],"tags":["Meetings"],"description":"A host or a user with admin permission can require [registration for a Zoom meeting](https://support.zoom.us/hc/en-us/articles/211579443-Registration-for-Meetings). List users that have registered for a meeting.<br><br>\n**Scopes**: `meeting:read:admin` `meeting:read`<br>\n\n **[Rate Limit Label](https://developers.zoom.us/docs/api/rest/rate-limits/):** `Medium`","operationId":"meetingRegistrants","summary":"List meeting registrants"},"post":{"summary":"Add a meeting registrant","description":"Create and submit a user's registration to a meeting. See [Customizing webinar registration](https://support.zoom.us/hc/en-us/articles/202835649-Customizing-webinar-registration) for details on how to set the requirements for these fields. Note that there is a maximum limit of 4,999 registrants per meeting and users will see an error if the meeting's capacity is reached. \n\n **Scopes:** `meeting:write:admin`, `meeting:write` <br> **[Rate Limit Label](https://developers.zoom.us/docs/api/rest/rate-limits/):** `Light` \n\n **Prerequisites:** \n* The host must be a **Licensed** user type.","operationId":"meetingRegistrantCreate","tags":["Meetings"],"parameters":[{"in":"path","name":"meetingId","required":true,"description":"The meeting's ID. \n\n When storing this value in your database, you must store it as a long format integer and **not** an integer. Meeting IDs can exceed 10 digits.","schema":{"format":"int64","type":"integer","example":85746065}},{"name":"occurrence_ids","in":"query","description":"A comma-separated list of meeting occurrence IDs. You can get this value with the [Get a meeting](/docs/api-reference/zoom-api/methods#operation/meeting) API.","schema":{"type":"string","example":"1648194360000,1648367160000"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","description":"Information about the meeting registrant.","properties":{"first_name":{"type":"string","maxLength":64,"description":"The registrant's first name.","example":"Jill"},"last_name":{"type":"string","maxLength":64,"description":"The registrant's last name.","example":"Chill"},"email":{"type":"string","format":"email","maxLength":128,"description":"The registrant's email address.","example":"jchill@example.com"},"address":{"type":"string","description":"The registrant's address.","example":"1800 Amphibious Blvd."},"city":{"type":"string","description":"The registrant's city.","example":"Mountain View"},"state":{"type":"string","description":"The registrant's state or province.","example":"CA"},"zip":{"type":"string","description":"The registrant's ZIP or postal code.","example":"94045"},"country":{"type":"string","description":"The registrant's two-letter [country code](https://marketplace.zoom.us/docs/api-reference/other-references/abbreviation-lists#countries).","example":"US"},"phone":{"type":"string","description":"The registrant's phone number.","example":"5550100"},"comments":{"type":"string","description":"The registrant's questions and comments.","example":"Looking forward to the discussion."},"custom_questions":{"type":"array","description":"Information about custom questions.","items":{"type":"object","description":"Information about custom questions.","properties":{"title":{"type":"string","description":"The title of the custom question.","example":"What do you hope to learn from this?"},"value":{"type":"string","maxLength":128,"description":"The custom question's response value. This has a limit of 128 characters.","example":"Look forward to learning how you come up with new recipes and what other services you offer."}}}},"industry":{"type":"string","description":"The registrant's industry.","example":"Food"},"job_title":{"type":"string","description":"The registrant's job title.","example":"Chef"},"no_of_employees":{"type":"string","description":"The registrant's number of employees: \n* `1-20` \n* `21-50` \n* `51-100` \n* `101-500` \n* `500-1,000` \n* `1,001-5,000` \n* `5,001-10,000` \n* `More than 10,000`","enum":["","1-20","21-50","51-100","101-500","500-1,000","1,001-5,000","5,001-10,000","More than 10,000"],"example":"1-20"},"org":{"type":"string","description":"The registrant's organization.","example":"Cooking Org"},"purchasing_time_frame":{"type":"string","description":"The registrant's purchasing time frame: \n* `Within a month` \n* `1-3 months` \n* `4-6 months` \n* `More than 6 months` \n* `No timeframe`","enum":["","Within a month","1-3 months","4-6 months","More than 6 months","No timeframe"],"example":"1-3 months"},"role_in_purchase_process":{"type":"string","description":"The registrant's role in the purchase process: \n* `Decision Maker` \n* `Evaluator/Recommender` \n* `Influencer` \n* `Not involved`","enum":["","Decision Maker","Evaluator/Recommender","Influencer","Not involved"],"example":"Influencer"},"language":{"type":"string","description":"The registrant's language preference for confirmation emails: \n* `en-US` — English (US) \n* `de-DE` — German (Germany) \n* `es-ES` — Spanish (Spain) \n* `fr-FR` — French (France) \n* `jp-JP` — Japanese \n* `pt-PT` — Portuguese (Portugal) \n* `ru-RU` — Russian \n* `zh-CN` — Chinese (PRC) \n* `zh-TW` — Chinese (Taiwan) \n* `ko-KO` — Korean \n* `it-IT` — Italian (Italy) \n* `vi-VN` — Vietnamese \n* `pl-PL` — Polish \n* `Tr-TR` — Turkish","enum":["en-US","de-DE","es-ES","fr-FR","jp-JP","pt-PT","ru-RU","zh-CN","zh-TW","ko-KO","it-IT","vi-VN","pl-PL","Tr-TR"],"example":"en-US"},"auto_approve":{"type":"boolean","description":"If a meeting was scheduled with the `approval_type` field value of `1` (manual approval) but you want to automatically approve meeting registrants, set the value of this field to `true`. \n\n**Note:** You cannot use this field to change approval setting for a meeting originally scheduled with the `approval_type` field value of `0` (automatic approval).","example":true}},"required":["email","first_name"]}}}},"responses":{"201":{"content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"integer","format":"int64","description":"The meeting ID.","example":85746065},"join_url":{"type":"string","description":"The URL the registrant can use to join the meeting. \n\nThe API will not return this field if the meeting was [created](/docs/api-reference/zoom-api/methods#operation/meetingCreate) with the `approval_type` field value of `1` (manual approval).","example":"https://example.com/j/11111"},"registrant_id":{"type":"string","description":"The registrant's ID.","example":"fdgsfh2ey82fuh"},"start_time":{"type":"string","format":"date-time","description":"The meeting's start time.","example":"2021-07-13T21:44:51Z"},"topic":{"type":"string","maxLength":200,"description":"The meeting's topic.","example":"My Meeting"},"occurrences":{"description":"Array of occurrence objects.","items":{"description":"Occurrence object. This object is only returned for Recurring Webinars.","properties":{"duration":{"description":"Duration.","type":"integer","example":60},"occurrence_id":{"description":"Occurrence ID: Unique Identifier that identifies an occurrence of a recurring webinar. [Recurring webinars](https://support.zoom.us/hc/en-us/articles/216354763-How-to-Schedule-A-Recurring-Webinar) can have a maximum of 50 occurrences.","type":"string","example":"1648194360000"},"start_time":{"description":"Start time.","format":"date-time","type":"string","example":"2022-03-25T07:46:00Z"},"status":{"description":"Occurrence status.","type":"string","example":"available"}},"type":"object"},"type":"array"},"participant_pin_code":{"description":"The participant PIN code is used to authenticate audio participants before they join the meeting.","type":"integer","format":"int64","example":380303}}}}},"description":"**HTTP Status Code:** `201` <br>\nMeeting registration created."},"300":{"description":"**Error Code:** `300` <br>\nMeeting \"{meetingId}\" not found or has expired."},"400":{"description":"**HTTP Status Code:** `400` <br>\n Bad Request \n\n**Error Code:** `1010` <br>\nUser does not belong to this account: {accountId} \n\n**Error Code:** `3003` <br>\nYou are not the meeting host. \n\n**Error Code:** `3043` <br>\nMeeting has reached maximum attendee capacity. \n\n**Error Code:** `3000` <br>\nCannot access meeting info. \n\n**Error Code:** `3161` <br>\nMeeting hosting and scheduling capabilities are not allowed for your user account."},"404":{"description":"**HTTP Status Code:** `404` \n* Meeting not found. \n*Registration has not been enabled for this meeting: {meetingId} \n\n**Error Code:** `1001` <br>\n Meeting host does not exist: {userId}"},"429":{"description":"**HTTP Status Code:** `429` <br>\n You have exceeded the daily rate limit of \"{0}\" for **Add meeting registrant** API requests for the registrant \"{1}\". You can resume these API requests at GMT 00:00:00."}},"security":[{"OAuth":[]}]}},"/meetings/{meetingId}/batch_registrants":{"post":{"parameters":[{"description":"Unique identifier of the meeting (Meeting Number).","in":"path","name":"meetingId","required":true,"schema":{"type":"string","example":"91498058927"}}],"responses":{"201":{"content":{"application/json":{"schema":{"properties":{"registrants":{"items":{"properties":{"email":{"description":"Email address of the registrant.","type":"string","example":"jchill@example.com"},"join_url":{"description":"Unique URL using which registrant can join the meeting.","type":"string","example":"https://example.com/j/11111"},"registrant_id":{"description":"Unique identifier of the registrant.","type":"string","example":"9tboDiHUQAeOnbmudzWa5g"},"participant_pin_code":{"description":"The participant PIN code is used to authenticate audio participants before they join the meeting.","type":"integer","format":"int64","example":380303}},"type":"object"},"type":"array"}},"type":"object"}}},"description":"**HTTP Status Code:** `200` **OK** <br>\nRegistrants added."},"400":{"description":"**HTTP Status Code:** `400` **Bad Request** <br>\n**Error Code:** `3038`<br>\nMeeting is over, you can not register now. If you have any questions, please contact the Meeting host.<br><br>\n**Error Code:** `303`<br> \nThis API can only be used for scheduled meeting(meeting type: 2). Batch registration is not supported for other meeting types. \n\n **Error Code:** `3161` <br>\nMeeting hosting and scheduling capabilities are not allowed for your user account."},"404":{"description":"**HTTP Status Code:** `404` **Not Found** <br>\n**Error Code:** `3001`<br>\nMeeting does not exist: {meetingId}.<br>\n**Error Code:** `3043`<br>\nMeeting has reached maximum attendee capacity.<br>\n**Error Code:** `404`<br>\nRegistration has not been enabled for this meeting: {meetingId}.\n\n\n\n"},"429":{"description":"**HTTP Status Code:** `429`<br>\nYou have exceeded the daily rate limit of \"{0}\" for meeting **Perform batch registration** API requests for the registrant \"{1}\". You can resume these API requests at GMT 00:00:00."}},"security":[{"OAuth":[]},{"Bearer":[]}],"tags":["Meetings"],"description":"Register up to 30 registrants at once for a meeting that requires [registration](https://support.zoom.us/hc/en-us/articles/211579443-Registration-for-Meetings). <br>\n\n**Prerequisites:**<br>\n* The meeting host must be a Licensed user.\n* The meeting must require registration and should be of type `2`, i.e., they should be scheduled meetings. Instant meetings and Recurring meetings are not supported by this API.<br><br>\n**Scope:** `meeting:write`, `meeting:write:admin`<br>\n**[Rate Limit Label](https://developers.zoom.us/docs/api/rest/rate-limits/):** `Heavy`<br>\n\n\n\n\n\n\n\n","operationId":"addBatchRegistrants","requestBody":{"content":{"application/json":{"schema":{"properties":{"auto_approve":{"description":"If a meeting was scheduled with approval_type `1` (manual approval), but you would like to automatically approve the registrants that are added via this API, you can set the value of this field to `true`. \n\nYou **cannot** use this field to change approval setting for a meeting  that was originally scheduled with approval_type `0` (automatic approval).","type":"boolean","example":true},"registrants_confirmation_email":{"description":"Send confirmation Email to Registrants","type":"boolean","example":true},"registrants":{"items":{"properties":{"email":{"description":"Email address of the registrant.","format":"email","type":"string","example":"jchill@example.com"},"first_name":{"description":"First name of the registrant.","type":"string","example":"Jill"},"last_name":{"description":"Last name of the registrant.","type":"string","example":"Chill"}},"required":["first_name","email"],"type":"object"},"type":"array"}},"type":"object"}}}},"summary":"Perform batch registration"}},"/meetings/{meetingId}/registrants/{registrantId}":{"get":{"parameters":[{"in":"path","name":"meetingId","required":true,"description":"The meeting's ID. \n\n When storing this value in your database, you must store it as a long format integer and **not** an integer. Meeting IDs can exceed 10 digits.","schema":{"format":"int64","type":"integer","example":85746065}},{"description":"The registrant ID.","in":"path","name":"registrantId","required":true,"schema":{"type":"string","example":"9tboDiHUQAeOnbmudzWa5g"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"id":{"type":"string","example":"9tboDiHUQAeOnbmudzWa5g"},"address":{"description":"The registrant's address.","type":"string","example":"1800 Amphibious Blvd."},"city":{"description":"The registrant's city.","type":"string","example":"Mountain View"},"comments":{"description":"The registrant's questions and comments.","type":"string","example":"Looking forward to the discussion."},"country":{"description":"The registrant's two-letter [country code](https://marketplace.zoom.us/docs/api-reference/other-references/abbreviation-lists#countries).","type":"string","example":"US"},"custom_questions":{"description":"Information about custom questions.","items":{"type":"object","description":"Information about custom questions.","properties":{"title":{"type":"string","description":"The title of the custom question.","example":"What do you hope to learn from this?"},"value":{"type":"string","maxLength":128,"description":"The custom question's response value. This has a limit of 128 characters.","example":"Look forward to learning how you come up with new recipes and what other services you offer."}}},"type":"array"},"email":{"description":"The registrant's email address. See [Email address display rules](https://marketplace.zoom.us/docs/api-reference/using-zoom-apis#email-address) for return value details.","format":"email","maxLength":128,"type":"string","example":"jchill@example.com"},"first_name":{"description":"The registrant's first name.","maxLength":64,"type":"string","example":"Jill"},"industry":{"description":"The registrant's industry.","type":"string","example":"Food"},"job_title":{"description":"The registrant's job title.","type":"string","example":"Chef"},"last_name":{"description":"The registrant's last name.","maxLength":64,"type":"string","example":"Chill"},"no_of_employees":{"description":"The registrant's number of employees: \n* `1-20` \n* `21-50` \n* `51-100` \n* `101-250` \n* `251-500` \n* `501-1,000` \n* `1,001-5,000` \n* `5,001-10,000` \n* `More than 10,000`","enum":["","1-20","21-50","51-100","101-250","251-500","501-1,000","1,001-5,000","5,001-10,000","More than 10,000"],"type":"string","example":"1-20"},"org":{"description":"The registrant's organization.","type":"string","example":"Cooking Org"},"phone":{"description":"The registrant's phone number.","type":"string","example":"5550100"},"purchasing_time_frame":{"description":"The registrant's purchasing time frame: \n* `Within a month` \n* `1-3 months` \n* `4-6 months` \n* `More than 6 months` \n* `No timeframe`","enum":["","Within a month","1-3 months","4-6 months","More than 6 months","No timeframe"],"type":"string","example":"1-3 months"},"role_in_purchase_process":{"description":"The registrant's role in the purchase process: \n* `Decision Maker` \n* `Evaluator/Recommender` \n* `Influencer` \n* `Not involved`","enum":["","Decision Maker","Evaluator/Recommender","Influencer","Not involved"],"type":"string","example":"Influencer"},"state":{"description":"The registrant's state or province.","type":"string","example":"CA"},"status":{"description":"The registrant's registration status:\n* `approved` — The registrant is approved to join the meeting. \n* `pending` — The registrant's registration is pending.\n* `denied` — The registrant was declined to join the meeting.","enum":["approved","denied","pending","approved","pending","denied"],"type":"string","example":"approved"},"zip":{"description":"The registrant's ZIP or postal code.","type":"string","example":"94045"},"create_time":{"description":"The registrant's registration date and time.","format":"date-time","type":"string","example":"2022-03-22T05:58:44Z"},"join_url":{"description":"The URL with which the approved registrant can join the meeting.","format":"url","type":"string","example":"https://example.com/j/11111"},"participant_pin_code":{"description":"The participant PIN code is used to authenticate audio participants before they join the meeting.","type":"integer","format":"int64","example":380303}},"type":"object","description":" Registrant.","required":["email","first_name"],"title":"Meeting Registrant"}}},"description":"Success."},"300":{"description":"**Error Code:** `300`<br>Meeting \"{meetingId}\" is not valid or has expired.\nThis meeting has not set required registration: \"{meetingId}\""},"400":{"description":"**HTTP Status Code:** `400`<br>**Error Code:** `1010`\nUser does not belong to this account: \"{accountId}\"<br>**Error Code:** `3003`\nYou are not the meeting host.<br>**Error Code:** `3000`>\nCannot access meeting info. \n\n **Error Code:** `3161` <br>\nMeeting hosting and scheduling capabilities are not allowed for your user account."},"404":{"description":"**HTTP Status Code:** `404`\nMeeting not found.<br>**Error Code:** `1001`<br>\nMeeting host does not exist: \"{userId}\""}},"security":[{"OAuth":[]}],"tags":["Meetings"],"description":"Retrieve details on a specific user who has registered for the meeting. A host or a user with administrative permissions can require [registration for Zoom meetings](https://support.zoom.us/hc/en-us/articles/211579443-Registration-for-Meetings).\n\n**Scopes:** `meeting:read:admin`, `meeting:read`<br>**[Rate Limit Label](https://developers.zoom.us/docs/api/rest/rate-limits/):** `Light`\n\n**Prerequisites:** \n* The account must have a Meeting plan","operationId":"meetingRegistrantGet","summary":"Get a meeting registrant"},"delete":{"parameters":[{"description":"The meeting occurrence ID.","in":"query","name":"occurrence_id","schema":{"type":"string","example":"approved"}},{"description":"The meeting ID.","in":"path","name":"meetingId","required":true,"schema":{"type":"integer","example":91498058927}},{"description":"The meeting registrant ID.","in":"path","name":"registrantId","required":true,"schema":{"type":"string","example":"9tboDiHUQAeOnbmudzWa5g"}}],"responses":{"204":{"description":"**HTTP status code:** `204` <br>\nOK"},"400":{"description":"**HTTP status code:** `400` <br>\nBad Request<br>\n\n**Error code:** `200`<br>\nOnly available for paid users: {0}.<br>\n\n**Error code:** `300`<br>\nThe value that you entered for the Registrant ID field is invalid. Enter a valid value and try again.<br>\n\n**Error code:** `404` <br>\nRegistration has not been enabled for this meeting: {0}.<br>\n\n**Error code:** `1001` <br>\nUser {userId} does not exist or does not belong to this account.<br>\n\n**Error code:** `3000` <br>\nCannot access webinar info. ***Note:** Zoom throws this error when the meetingId is a webinarId.*<br>\nRegistrant {0} was not found.\n\n**Error code:** `3001` <br>\nMeeting does not exist: {0}. \n\n **Error Code:** `3161` <br>\nMeeting hosting and scheduling capabilities are not allowed for your user account."}},"tags":["Meetings"],"description":"Delete a meeting registrant.<br><br>\n**Scopes**: `meeting:write:admin` `meeting:write`<br>\n <br>\n **[Rate Limit Label](https://developers.zoom.us/docs/api/rest/rate-limits/):** `Light`","operationId":"meetingregistrantdelete","summary":"Delete a meeting registrant"}},"/meetings/{meetingId}/registrants/status":{"put":{"parameters":[{"in":"path","name":"meetingId","required":true,"description":"The meeting's ID. \n\n When storing this value in your database, you must store it as a long format integer and **not** an integer. Meeting IDs can exceed 10 digits.","schema":{"format":"int64","type":"integer","example":85746065}},{"description":"The meeting or webinar occurrence ID.","in":"query","name":"occurrence_id","schema":{"type":"string","example":"1648194360000"}}],"responses":{"204":{"description":"**HTTP Status Code:** `204`<br>\nRegistrant status updated."},"300":{"description":"**Error Code:** `300`<br>\nThis meeting has not set registration as required:{meetingId}."},"400":{"description":"**HTTP Status Code:** `400`<br>\n**Error Code:** `1010`<br>\nUser does not belong to this account: {accountId}.<br>\n**Error Code:** `3000`<br>\nCannot access meeting information.<br>\n**Error Code:** `3003`<br>\nYou're not the meeting host. \n\n **Error Code:** `3161` <br>\nMeeting hosting and scheduling capabilities are not allowed for your user account."},"404":{"description":"**HTTP Status Code:** `404`<br>\nMeeting or registrant not found.\n**Error Code:** `1001`<br>\nUser does not exist: {userId}.<br>\n"},"429":{"description":"**HTTP Status Code:** `429`<br>\nYou have exceeded the daily rate limit of \"{0}\" for meeting **Update registrant's status** API requests for the registrant \"{1}\". You can resume these API requests at GMT 00:00:00."}},"security":[{"OAuth":[]}],"tags":["Meetings"],"description":"Update a meeting registrant's status by either approving, cancelling or denying a registrant from joining the meeting.<br><br>\n**Scopes:** `meeting:write:admin` `meeting:write`\n **[Rate Limit Label](https://developers.zoom.us/docs/api/rest/rate-limits/):** `Medium`","operationId":"meetingRegistrantStatus","requestBody":{"content":{"application/json":{"schema":{"properties":{"action":{"description":"Registrant Status:<br>`approve` - Approve registrant.<br>`cancel` - Cancel previously approved registrant's registration.<br>`deny` - Deny registrant.","enum":["approve","cancel","deny"],"type":"string","x-enum-descriptions":["Approve registrant","Cancel previously approved registrant","Deny registrant"],"example":"approve"},"registrants":{"description":"List of registrants.","items":{"properties":{"email":{"type":"string","example":"jchill@example.com"},"id":{"type":"string","example":"9tboDiHUQAeOnbmudzWa5g"}},"type":"object"},"maximum":30,"type":"array"}},"required":["action"],"type":"object"}}},"required":true},"summary":"Update registrant's status"}},"/meetings/{meetingId}/registrants/questions":{"get":{"parameters":[{"in":"path","name":"meetingId","required":true,"description":"The meeting's ID. \n\n When storing this value in your database, you must store it as a long format integer and **not** an integer. Meeting IDs can exceed 10 digits.","schema":{"format":"int64","type":"integer","example":85746065}}],"responses":{"200":{"content":{"application/json":{"schema":{"description":"Meeting Registrant Questions","properties":{"custom_questions":{"description":"Array of Registrant Custom Questions","items":{"properties":{"answers":{"description":"Answer choices for the question. Can not be used for `short` question type as this type of question requires registrants to type out the answer.","items":{"type":"string","example":"Good"},"type":"array"},"required":{"description":"Indicates whether or not the custom question is required to be answered by participants or not.","type":"boolean","example":true},"title":{"description":"Title of the custom question.","type":"string","example":"How are you?"},"type":{"description":"Type of the question being asked.","enum":["short","single"],"type":"string","x-enum-descriptions":["Short Answer","Single Answer"],"example":"short"}},"type":"object"},"type":"array"},"questions":{"description":"Array of Registrant Questions","items":{"properties":{"field_name":{"type":"string","description":"Field name of the question.","enum":["last_name","address","city","country","zip","state","phone","industry","org","job_title","purchasing_time_frame","role_in_purchase_process","no_of_employees","comments"],"example":"last_name"},"required":{"description":"Indicates whether or not the displayed fields are required to be filled out by registrants.","type":"boolean","example":true}},"type":"object"},"type":"array"}},"title":"Meeting Registrant Questions","type":"object"}}},"description":"**HTTP Status Code:** `200`<br>\nMeeting Registrant Question object returned"},"400":{"description":"**HTTP Status Code:** `400` <br>\n Bad Request \n\n **Error Code:** `3161` <br>\nMeeting hosting and scheduling capabilities are not allowed for your user account."},"404":{"description":"**HTTP Status Code:** `404`<br>\nMeeting not found"}},"security":[{"OAuth":[]}],"tags":["Meetings"],"description":"List registration questions that will be displayed to users while [registering for a meeting](https://support.zoom.us/hc/en-us/articles/211579443-Registration-for-Meetings).<br>\n\n**Scopes:** `meeting:read`, `meeting:read:admin`<br>\n\n **[Rate Limit Label](https://developers.zoom.us/docs/api/rest/rate-limits/):** `Light`\n\n","operationId":"meetingRegistrantsQuestionsGet","summary":"List registration questions "},"patch":{"parameters":[{"in":"path","name":"meetingId","required":true,"description":"The meeting's ID. \n\n When storing this value in your database, you must store it as a long format integer and **not** an integer. Meeting IDs can exceed 10 digits.","schema":{"format":"int64","type":"integer","example":85746065}}],"responses":{"204":{"description":"**HTTP Status Code:** `204`<br>\nMeeting Registrant Questions Updated"},"400":{"description":"**HTTP Status Code:** `400` <br>\n Bad Request \n\n **Error Code:** `3161` <br>\nMeeting hosting and scheduling capabilities are not allowed for your user account."},"404":{"description":"**HTTP Status Code:** `404`<br>\nMeeting not found."}},"security":[{"OAuth":[]}],"tags":["Meetings"],"description":"Update registration questions that will be displayed to users while [registering for a meeting](https://support.zoom.us/hc/en-us/articles/211579443-Registration-for-Meetings).<br><br>\n**Scopes:** `meeting:write`, `meeting:write:admin`<br>\n **[Rate Limit Label](https://developers.zoom.us/docs/api/rest/rate-limits/):** `Light`\n \n\n","operationId":"meetingRegistrantQuestionUpdate","requestBody":{"content":{"application/json":{"schema":{"description":"Meeting Registrant Questions","properties":{"custom_questions":{"description":"Array of Registrant Custom Questions","items":{"properties":{"answers":{"description":"Answer choices for the question. Can not be used for `short` question type as this type of question requires registrants to type out the answer.","items":{"type":"string","example":"Good"},"type":"array"},"required":{"description":"Indicates whether or not the custom question is required to be answered by participants or not.","type":"boolean","example":true},"title":{"description":"Title of the custom question.","type":"string","example":"How are you?"},"type":{"description":"Type of the question being asked.","enum":["short","single"],"type":"string","x-enum-descriptions":["Short Answer","Single Answer"],"example":"short"}},"type":"object"},"type":"array"},"questions":{"description":"Array of Registrant Questions","items":{"properties":{"field_name":{"type":"string","description":"Field name of the question.","enum":["last_name","address","city","country","zip","state","phone","industry","org","job_title","purchasing_time_frame","role_in_purchase_process","no_of_employees","comments"],"example":"last_name"},"required":{"description":"Indicates whether or not the displayed fields are required to be filled out by registrants.","type":"boolean","example":true}},"type":"object"},"type":"array"}},"title":"Meeting Registrant Questions","type":"object"}}},"description":"Meeting Registrant Questions","required":true},"summary":"Update registration questions"}},"/meetings/{meetingId}/polls":{"get":{"parameters":[{"in":"path","name":"meetingId","required":true,"description":"The meeting's ID. \n\n When storing this value in your database, you must store it as a long format integer and **not** an integer. Meeting IDs can exceed 10 digits.","schema":{"format":"int64","type":"integer","example":85746065}},{"description":"Whether to query for polls with the **Anonymous** option enabled: \n* `true` — Query for polls with the **Anonymous** option enabled. \n* `false` — Do not query for polls with the **Anonymous** option enabled.","in":"query","name":"anonymous","required":false,"schema":{"type":"boolean","example":true}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"polls":{"description":"Array of Polls","items":{"properties":{"id":{"description":"ID of Poll","type":"string","example":"QalIoKWLTJehBJ8e1xRrbQ"},"status":{"description":"Status of Poll:<br>`notstart` - Poll not started<br>`started` - Poll started<br>`ended` - Poll ended<br>`sharing` - Sharing poll results","enum":["notstart","started","ended","sharing"],"type":"string","x-enum-descriptions":["Poll not start","Poll started","Poll ended","Poll is sharing"],"example":"notstart"},"anonymous":{"default":false,"description":"Allow meeting participants to answer poll questions anonymously. \n\nThis value defaults to `false`.","type":"boolean","example":true},"poll_type":{"description":"The type of poll: \n* `1` — Poll. \n* `2` — Advanced Poll. This feature must be enabled in your Zoom account. \n* `3` — Quiz. This feature must be enabled in your Zoom account. \n\n This value defaults to `1`.","enum":[1,2,3],"type":"integer","example":2},"questions":{"description":"Information about the poll's questions.","items":{"properties":{"answer_max_character":{"description":"The allowed maximum number of characters. This field only applies to `short_answer` and `long_answer` polls: \n* For `short_answer` polls, a maximum of 500 characters. \n* For `long_answer` polls, a maximum of 2,000 characters.","type":"integer","example":200},"answer_min_character":{"description":"The allowed minimum number of characters. This field only applies to `short_answer` and `long_answer` polls. You must provide at least a **one** character minimum value.","minimum":1,"type":"integer","example":1},"answer_required":{"default":false,"description":"Whether participants must answer the question: \n* `true` — The participant must answer the question. \n* `false` — The participant does not need to answer the question. \n\n**Note:** \n* When the poll's `type` value is `1` (Poll), this value defaults to `true`. \n* When the poll's `type` value is the `2` (Advanced Poll) or `3` (Quiz) values, this value defaults to `false`.","type":"boolean","example":false},"answers":{"description":"The poll question's available answers. This field requires a **minimum** of two answers. \n\n* For `single` and `multiple` polls, you can only provide a maximum of 10 answers. \n* For `matching` polls, you can only provide a maximum of 16 answers. \n* For `rank_order` polls, you can only provide a maximum of seven answers.","items":{"type":"string","example":"Extremely useful"},"minItems":2,"type":"array"},"case_sensitive":{"default":false,"description":"Whether the correct answer is case sensitive. This field only applies to `fill_in_the_blank` polls: \n* `true` — The answer is case-sensitive. \n* `false` — The answer is not case-sensitive. \n\nThis value defaults to `false`.","type":"boolean","example":false},"name":{"description":"The poll question, up to 255 characters. \n\nFor `fill_in_the_blank` polls, this field is the poll's question. For each value that the user must fill in, ensure that there are the same number of `right_answers` values.","maxLength":255,"type":"string","example":"How useful was this meeting?"},"prompts":{"description":"Information about the prompt questions. This field only applies to `matching` and `rank_order` polls. You **must** provide a minimum of two prompts, up to a maximum of 10 prompts.","items":{"properties":{"prompt_question":{"description":"The question prompt's title.","type":"string","example":"How are you?"},"prompt_right_answers":{"description":"The question prompt's correct answers: \n* For `matching` polls, you must provide a minimum of two correct answers, up to a maximum of 10 correct answers. \n* For `rank_order` polls, you can only provide one correct answer.","items":{"type":"string","example":"Good"},"type":"array"}},"type":"object"},"type":"array"},"rating_max_label":{"description":"The high score label used for the `rating_max_value` field. \n\nThis field only applies to the `rating_scale` poll.","type":"string","example":"Extremely Likely"},"rating_max_value":{"description":"The rating scale's maximum value, up to a maximum value of 10. \n\nThis field only applies to the `rating_scale` poll.","maximum":10,"type":"integer","example":4},"rating_min_label":{"description":"The low score label used for the `rating_min_value` field. \n\nThis field only applies to the `rating_scale` poll.","type":"string","example":"Not likely"},"rating_min_value":{"description":"The rating scale's minimum value. This value cannot be less than zero. \n\nThis field only applies to the `rating_scale` poll.","minimum":0,"type":"integer","example":0},"right_answers":{"description":"The poll question's correct answer(s). This field is **required** if the poll's `type` value is `3` (Quiz). \n\n For `single` and `matching` polls, this field only accepts one answer.","items":{"type":"string","example":"Good"},"minItems":1,"type":"array"},"show_as_dropdown":{"default":false,"description":"Whether to display the radio selection as a drop-down box: \n* `true` — Show as a drop-down box. \n* `false` — Do not show as a drop-down box. \n\nThis value defaults to `false`.","type":"boolean","example":false},"type":{"description":"The poll's question and answer type: \n* `single` — Single choice. \n* `multiple` — Multiple choice. \n* `matching` — Matching. \n* `rank_order` — Rank order. \n* `short_answer` — Short answer. \n* `long_answer` — Long answer. \n* `fill_in_the_blank` — Fill in the blank. \n* `rating_scale` — Rating scale.","enum":["single","multiple","matching","rank_order","short_answer","long_answer","fill_in_the_blank","rating_scale"],"type":"string","x-enum-descriptions":["Single choice","Multiple choice","Matching","Rank order","Short answer","Long answer","Fill in the blank","Rating scale"],"example":"single"}},"type":"object"},"type":"array"},"title":{"description":"The poll's title, up to 64 characters.","maxLength":64,"type":"string","example":"Learn something new"}},"type":"object","description":"Information about meeting and webinar polling.","title":"Meeting and Webinar Polling Object"},"type":"array"},"total_records":{"description":"The number of all records available across pages","type":"integer","example":1}},"type":"object","description":"Poll List","title":"Poll List"}}},"description":"**HTTP Status Code:** <br>\nList polls of a Meeting  returned"},"400":{"description":"**HTTP Status Code:** `400` **Bad Request** <br>\n **Error Code:** `4400` <br> Meeting polls disabled. To enable this feature, enable the \"Meeting Polls/Quizzes\" setting in the Zoom web portal's \"Settings\" interface. \n\n **Error Code:** `3161` <br>\nMeeting hosting and scheduling capabilities are not allowed for your user account."},"404":{"description":"**Error Code:** `404`\nMeeting Poll not found"}},"security":[{"OAuth":[]}],"tags":["Meetings"],"description":"Polls allow the meeting host to survey attendees. List all [polls](https://support.zoom.us/hc/en-us/articles/213756303-Polling-for-Meetings) of a meeting.<br><br>\n\n**Scopes**: `meeting:read:admin` `meeting:read`<br>\n **[Rate Limit Label](https://developers.zoom.us/docs/api/rest/rate-limits/):** `Light`<br>\n**Prerequisites**:<br>\n* Host user type must be **Pro** or higher plan.\n* Meeting must be a scheduled meeting. Instant meetings do not have polling features enabled.","operationId":"meetingPolls","summary":"List meeting polls"},"post":{"parameters":[{"in":"path","name":"meetingId","required":true,"description":"The meeting's ID. \n\n When storing this value in your database, you must store it as a long format integer and **not** an integer. Meeting IDs can exceed 10 digits.","schema":{"format":"int64","type":"integer","example":85746065}}],"responses":{"201":{"content":{"application/json":{"schema":{"properties":{"id":{"description":"Meeting Poll ID","type":"string","example":"QalIoKWLTJehBJ8e1xRrbQ"},"status":{"description":"Status of the Meeting Poll:<br>`notstart` - Poll not started<br>`started` - Poll started<br>`ended` - Poll ended<br>`sharing` - Sharing poll results","enum":["notstart","started","ended","sharing"],"type":"string","x-enum-descriptions":["Poll not start","Poll started","Poll ended","Poll is sharing"],"example":"notstart"},"anonymous":{"default":false,"description":"Allow meeting participants to answer poll questions anonymously. \n\nThis value defaults to `false`.","type":"boolean","example":true},"poll_type":{"description":"The type of poll: \n* `1` — Poll. \n* `2` — Advanced Poll. This feature must be enabled in your Zoom account. \n* `3` — Quiz. This feature must be enabled in your Zoom account. \n\n This value defaults to `1`.","enum":[1,2,3],"type":"integer","example":2},"questions":{"description":"Information about the poll's questions.","items":{"properties":{"answer_max_character":{"description":"The allowed maximum number of characters. This field only applies to `short_answer` and `long_answer` polls: \n* For `short_answer` polls, a maximum of 500 characters. \n* For `long_answer` polls, a maximum of 2,000 characters.","type":"integer","example":200},"answer_min_character":{"description":"The allowed minimum number of characters. This field only applies to `short_answer` and `long_answer` polls. You must provide at least a **one** character minimum value.","minimum":1,"type":"integer","example":1},"answer_required":{"default":false,"description":"Whether participants must answer the question: \n* `true` — The participant must answer the question. \n* `false` — The participant does not need to answer the question. \n\n**Note:** \n* When the poll's `type` value is `1` (Poll), this value defaults to `true`. \n* When the poll's `type` value is the `2` (Advanced Poll) or `3` (Quiz) values, this value defaults to `false`.","type":"boolean","example":false},"answers":{"description":"The poll question's available answers. This field requires a **minimum** of two answers. \n\n* For `single` and `multiple` polls, you can only provide a maximum of 10 answers. \n* For `matching` polls, you can only provide a maximum of 16 answers. \n* For `rank_order` polls, you can only provide a maximum of seven answers.","items":{"type":"string","example":"Extremely useful"},"minItems":2,"type":"array"},"case_sensitive":{"default":false,"description":"Whether the correct answer is case sensitive. This field only applies to `fill_in_the_blank` polls: \n* `true` — The answer is case-sensitive. \n* `false` — The answer is not case-sensitive. \n\nThis value defaults to `false`.","type":"boolean","example":false},"name":{"description":"The poll question, up to 255 characters. \n\nFor `fill_in_the_blank` polls, this field is the poll's question. For each value that the user must fill in, ensure that there are the same number of `right_answers` values.","maxLength":255,"type":"string","example":"How useful was this meeting?"},"prompts":{"description":"Information about the prompt questions. This field only applies to `matching` and `rank_order` polls. You **must** provide a minimum of two prompts, up to a maximum of 10 prompts.","items":{"properties":{"prompt_question":{"description":"The question prompt's title.","type":"string","example":"How are you?"},"prompt_right_answers":{"description":"The question prompt's correct answers: \n* For `matching` polls, you must provide a minimum of two correct answers, up to a maximum of 10 correct answers. \n* For `rank_order` polls, you can only provide one correct answer.","items":{"type":"string","example":"Good"},"type":"array"}},"type":"object"},"type":"array"},"rating_max_label":{"description":"The high score label used for the `rating_max_value` field. \n\nThis field only applies to the `rating_scale` poll.","type":"string","example":"Extremely Likely"},"rating_max_value":{"description":"The rating scale's maximum value, up to a maximum value of 10. \n\nThis field only applies to the `rating_scale` poll.","maximum":10,"type":"integer","example":4},"rating_min_label":{"description":"The low score label used for the `rating_min_value` field. \n\nThis field only applies to the `rating_scale` poll.","type":"string","example":"Not likely"},"rating_min_value":{"description":"The rating scale's minimum value. This value cannot be less than zero. \n\nThis field only applies to the `rating_scale` poll.","minimum":0,"type":"integer","example":0},"right_answers":{"description":"The poll question's correct answer(s). This field is **required** if the poll's `type` value is `3` (Quiz). \n\n For `single` and `matching` polls, this field only accepts one answer.","items":{"type":"string","example":"Good"},"minItems":1,"type":"array"},"show_as_dropdown":{"default":false,"description":"Whether to display the radio selection as a drop-down box: \n* `true` — Show as a drop-down box. \n* `false` — Do not show as a drop-down box. \n\nThis value defaults to `false`.","type":"boolean","example":false},"type":{"description":"The poll's question and answer type: \n* `single` — Single choice. \n* `multiple` — Multiple choice. \n* `matching` — Matching. \n* `rank_order` — Rank order. \n* `short_answer` — Short answer. \n* `long_answer` — Long answer. \n* `fill_in_the_blank` — Fill in the blank. \n* `rating_scale` — Rating scale.","enum":["single","multiple","matching","rank_order","short_answer","long_answer","fill_in_the_blank","rating_scale"],"type":"string","x-enum-descriptions":["Single choice","Multiple choice","Matching","Rank order","Short answer","Long answer","Fill in the blank","Rating scale"],"example":"single"}},"type":"object"},"type":"array"},"title":{"description":"The poll's title, up to 64 characters.","maxLength":64,"type":"string","example":"Learn something new"}},"type":"object","description":"Information about meeting and webinar polling.","title":"Meeting and Webinar Polling Object"}}},"description":"**HTTP Status Code:** `201` <br>\nMeeting Poll Created"},"400":{"description":"**HTTP Status Code:** `400` **Bad Request** <br>\n **Error Code:** `4400` <br>\n* Meeting polls disabled. To enable this feature, enable the \"Meeting Polls/Quizzes\" setting in the Zoom web portal's \"Settings\" interface. \n* Advanced meeting polls disabled. To enable this feature, enable the \"Allow host to create advanced polls and quizzes\" setting in the Zoom web portal's \"Settings\" interface. \n\n **Error Code:** `3161` <br>\nMeeting hosting and scheduling capabilities are not allowed for your user account."},"404":{"description":"**Error Code:** `404` <br>\nMeeting not found"}},"security":[{"OAuth":[]}],"tags":["Meetings"],"description":"Polls allow the meeting host to survey attendees. Create a [poll](https://support.zoom.us/hc/en-us/articles/213756303-Polling-for-Meetings) for a meeting.<br><br>\n\n**Scopes**: `meeting:write:admin` `meeting:write`<br>\n **[Rate Limit Label](https://developers.zoom.us/docs/api/rest/rate-limits/):** `Light`<br>\n**Prerequisites**:<br>\n* Host user type must be **Pro** or higher plan.\n* Polling feature must be enabled in the host's account.\n* Meeting must be a scheduled meeting. Instant meetings do not have polling features enabled.","operationId":"meetingPollCreate","requestBody":{"content":{"application/json":{"schema":{"description":"Information about meeting and webinar polling.","properties":{"anonymous":{"default":false,"description":"Allow meeting participants to answer poll questions anonymously. \n\nThis value defaults to `false`.","type":"boolean","example":true},"poll_type":{"description":"The type of poll: \n* `1` — Poll. \n* `2` — Advanced Poll. This feature must be enabled in your Zoom account. \n* `3` — Quiz. This feature must be enabled in your Zoom account. \n\n This value defaults to `1`.","enum":[1,2,3],"type":"integer","example":2},"questions":{"description":"Information about the poll's questions.","items":{"properties":{"answer_max_character":{"description":"The allowed maximum number of characters. This field only applies to `short_answer` and `long_answer` polls: \n* For `short_answer` polls, a maximum of 500 characters. \n* For `long_answer` polls, a maximum of 2,000 characters.","type":"integer","example":200},"answer_min_character":{"description":"The allowed minimum number of characters. This field only applies to `short_answer` and `long_answer` polls. You must provide at least a **one** character minimum value.","minimum":1,"type":"integer","example":1},"answer_required":{"default":false,"description":"Whether participants must answer the question: \n* `true` — The participant must answer the question. \n* `false` — The participant does not need to answer the question. \n\n**Note:** \n* When the poll's `type` value is `1` (Poll), this value defaults to `true`. \n* When the poll's `type` value is the `2` (Advanced Poll) or `3` (Quiz) values, this value defaults to `false`.","type":"boolean","example":false},"answers":{"description":"The poll question's available answers. This field requires a **minimum** of two answers. \n\n* For `single` and `multiple` polls, you can only provide a maximum of 10 answers. \n* For `matching` polls, you can only provide a maximum of 16 answers. \n* For `rank_order` polls, you can only provide a maximum of seven answers.","items":{"type":"string","example":"Extremely useful"},"minItems":2,"type":"array"},"case_sensitive":{"default":false,"description":"Whether the correct answer is case sensitive. This field only applies to `fill_in_the_blank` polls: \n* `true` — The answer is case-sensitive. \n* `false` — The answer is not case-sensitive. \n\nThis value defaults to `false`.","type":"boolean","example":false},"name":{"description":"The poll question, up to 255 characters. \n\nFor `fill_in_the_blank` polls, this field is the poll's question. For each value that the user must fill in, ensure that there are the same number of `right_answers` values.","maxLength":255,"type":"string","example":"How useful was this meeting?"},"prompts":{"description":"Information about the prompt questions. This field only applies to `matching` and `rank_order` polls. You **must** provide a minimum of two prompts, up to a maximum of 10 prompts.","items":{"properties":{"prompt_question":{"description":"The question prompt's title.","type":"string","example":"How are you?"},"prompt_right_answers":{"description":"The question prompt's correct answers: \n* For `matching` polls, you must provide a minimum of two correct answers, up to a maximum of 10 correct answers. \n* For `rank_order` polls, you can only provide one correct answer.","items":{"type":"string","example":"Good"},"type":"array"}},"type":"object"},"type":"array"},"rating_max_label":{"description":"The high score label used for the `rating_max_value` field. \n\nThis field only applies to the `rating_scale` poll.","type":"string","example":"Extremely Likely"},"rating_max_value":{"description":"The rating scale's maximum value, up to a maximum value of 10. \n\nThis field only applies to the `rating_scale` poll.","maximum":10,"type":"integer","example":4},"rating_min_label":{"description":"The low score label used for the `rating_min_value` field. \n\nThis field only applies to the `rating_scale` poll.","type":"string","example":"Not likely"},"rating_min_value":{"description":"The rating scale's minimum value. This value cannot be less than zero. \n\nThis field only applies to the `rating_scale` poll.","minimum":0,"type":"integer","example":0},"right_answers":{"description":"The poll question's correct answer(s). This field is **required** if the poll's `type` value is `3` (Quiz). \n\n For `single` and `matching` polls, this field only accepts one answer.","items":{"type":"string","example":"Good"},"minItems":1,"type":"array"},"show_as_dropdown":{"default":false,"description":"Whether to display the radio selection as a drop-down box: \n* `true` — Show as a drop-down box. \n* `false` — Do not show as a drop-down box. \n\nThis value defaults to `false`.","type":"boolean","example":false},"type":{"description":"The poll's question and answer type: \n* `single` — Single choice. \n* `multiple` — Multiple choice. \n* `matching` — Matching. \n* `rank_order` — Rank order. \n* `short_answer` — Short answer. \n* `long_answer` — Long answer. \n* `fill_in_the_blank` — Fill in the blank. \n* `rating_scale` — Rating scale.","enum":["single","multiple","matching","rank_order","short_answer","long_answer","fill_in_the_blank","rating_scale"],"type":"string","x-enum-descriptions":["Single choice","Multiple choice","Matching","Rank order","Short answer","Long answer","Fill in the blank","Rating scale"],"example":"single"}},"type":"object"},"type":"array"},"title":{"description":"The poll's title, up to 64 characters.","maxLength":64,"type":"string","example":"Learn something new"}},"title":"Meeting and Webinar Polling Object","type":"object"}}},"description":"Meeting poll object","required":true},"summary":"Create a meeting poll"}},"/meetings/{meetingId}/batch_polls":{"post":{"parameters":[{"in":"path","name":"meetingId","required":true,"schema":{"type":"string","example":"93398114182"}}],"responses":{"201":{"content":{"application/json":{"schema":{"properties":{"polls":{"items":{"properties":{"anonymous":{"description":"Whether to allow meeting participants to answer poll questions anonymously: \n* `true` — Anonymous polls enabled. \n* `false` — Participants cannot answer poll questions anonymously.","type":"boolean","example":true},"id":{"description":"Meeting Poll ID","type":"string","example":"QalIoKWLTJehBJ8e1xRrbQ"},"poll_type":{"description":"The type of poll: \n* `1` — Poll. \n* `2` — Advanced Poll. This feature must be enabled in your Zoom account. \n* `3` — Quiz. This feature must be enabled in your Zoom account.","enum":[1,2,3],"type":"integer","example":2},"questions":{"description":"Information about the poll's questions.","items":{"properties":{"answer_max_character":{"description":"The allowed maximum number of characters. This field only returns for `short_answer` and `long_answer` polls.","type":"integer","example":200},"answer_min_character":{"description":"The allowed minimum number of characters. This field only returns for `short_answer` and `long_answer` polls.","type":"integer","example":1},"answer_required":{"description":"Whether participants must answer the question: \n* `true` — The participant must answer the question. \n* `false` — The participant does not need to answer the question.","type":"boolean","example":false},"answers":{"description":"The poll question's available answers.","items":{"type":"string","example":"Extremely useful"},"type":"array"},"case_sensitive":{"default":false,"description":"Whether the correct answer is case sensitive. This field only returns for `fill_in_the_blank` polls: \n* `true` — The answer is case-sensitive. \n* `false` — The answer is not case-sensitive.","type":"boolean","example":false},"name":{"description":"The poll question's title. For `fill_in_the_blank` polls, this field is the poll's question.","type":"string","example":"How useful was this meeting?"},"prompts":{"description":"Information about the prompt questions. This object only returns for `matching` and `rank_order` polls.","items":{"properties":{"prompt_question":{"description":"The question prompt's title.","type":"string","example":"How are you?"},"prompt_right_answers":{"description":"The question prompt's correct answers.","items":{"type":"string","example":"Good"},"type":"array"}},"type":"object"},"type":"array"},"rating_max_label":{"description":"The high score label used for the `rating_max_value` field. This field only returns for `rating_scale` polls.","type":"string","example":"Extremely Likely"},"rating_max_value":{"description":"The rating scale's maximum value. This field only returns for `rating_scale` polls.","maximum":10,"type":"integer","example":4},"rating_min_label":{"description":"The low score label used for the `rating_min_value` field. This field only returns for `rating_scale` polls.","type":"string","example":"Not likely"},"rating_min_value":{"description":"The rating scale's minimum value. This field only returns for `rating_scale` polls.","type":"integer","example":0},"right_answers":{"description":"The poll question's correct answer(s).","items":{"type":"string","example":"Good"},"type":"array"},"show_as_dropdown":{"description":"Whether to display the radio selection as a drop-down box: \n* `true` — Show as a drop-down box. \n* `false` — Do not show as a drop-down box.","type":"boolean","example":false},"type":{"description":"The poll's question and answer type: \n* `single` — Single choice. \n* `multiple` — Multiple choice. \n* `matching` — Matching. \n* `rank_order` — Rank order. \n* `short_answer` — Short answer. \n* `long_answer` — Long answer. \n* `fill_in_the_blank` — Fill in the blank. \n* `rating_scale` — Rating scale.","enum":["single","multiple","matching","rank_order","short_answer","long_answer","fill_in_the_blank","rating_scale"],"type":"string","x-enum-descriptions":["Single choice","Multiple choice","Matching","Rank order","Short answer","Long answer","Fill in the blank","Rating scale"],"example":"single"}},"type":"object"},"type":"array"},"status":{"description":"Status of the Meeting Poll:<br>`notstart` - Poll not started<br>`started` - Poll started<br>`ended` - Poll ended<br>`sharing` - Sharing poll results","enum":["notstart","started","ended","sharing"],"type":"string","x-enum-descriptions":["Poll not start","Poll started","Poll ended","Poll is sharing"],"example":"notstart"},"title":{"description":"Title for the Poll","type":"string","example":"Learn something new"}},"type":"object"},"type":"array"}},"type":"object"}}},"description":"**HTTP Status Code:** `201` <br>\nMeeting Poll Created"},"400":{"description":"**HTTP Status Code:** `404` **Not Found** <br>\n**Error Code:** `300` <br>\nInvalid Meeting ID.\n**Error Code:** `300` <br>\nMeeting id does not exist.\n**Error Code:** `3000` <br>\nCannot access meeting information.\n**Error Code:** `3001`<br>\nMeeting does not exist: {meetingId}.<br>\n**Error Code:** `4400` <br>\n* You can only add a maximum of 50 polls. \n* Meeting polls disabled. To enable this feature, enable the \"Meeting Polls/Quizzes\" setting in the Zoom web portal's \"Settings\" interface. \n* Advanced meeting polls disabled. To enable this feature, enable the \"Allow host to create advanced polls and quizzes\" setting in the Zoom web portal's \"Settings\" interface. \n\n **Error Code:** `3161` <br>\nMeeting hosting and scheduling capabilities are not allowed for your user account."}},"tags":["Meetings"],"description":"Polls allow the meeting host to survey attendees. Create batch [polls](https://support.zoom.us/hc/en-us/articles/213756303-Polling-for-Meetings) for a meeting.<br><br>\n\n**Scopes**: `meeting:write:admin` `meeting:write`<br>\n **[Rate Limit Label](https://developers.zoom.us/docs/api/rest/rate-limits/):** `Light`<br>\n**Prerequisites**:<br>\n* Host user type must be **Pro** or higher plan.\n* Polling feature must be enabled in the host's account.\n* Meeting must be a scheduled meeting. Instant meetings do not have polling features enabled.","operationId":"createBatchPolls","requestBody":{"content":{"application/json":{"schema":{"properties":{"polls":{"description":"Information about the meeting's polls.","items":{"properties":{"anonymous":{"default":false,"description":"Whether to allow meeting participants to answer poll questions anonymously: \n* `true` — Anonymous polls enabled. \n* `false` — Participants cannot answer poll questions anonymously. \n\nThis value defaults to `false`.","type":"boolean","example":false},"poll_type":{"default":1,"description":"The type of poll: \n* `1` — Poll. \n* `2` — Advanced Poll. This feature must be enabled in your Zoom account. \n* `3` — Quiz. This feature must be enabled in your Zoom account. \n\n This value defaults to `1`.","enum":[1,2,3],"type":"integer","example":2},"questions":{"description":"Information about the poll's questions.","items":{"properties":{"answer_max_character":{"description":"The allowed maximum number of characters. This field only applies to `short_answer` and `long_answer` polls: \n* For `short_answer` polls, a maximum of 500 characters. \n* For `long_answer` polls, a maximum of 2,000 characters.","type":"integer","example":200},"answer_min_character":{"description":"The allowed minimum number of characters. This field only applies to `short_answer` and `long_answer` polls. You must provide at least a **one** character minimum value.","minimum":1,"type":"integer","example":1},"answer_required":{"default":false,"description":"Whether participants must answer the question: \n* `true` — The participant must answer the question. \n* `false` — The participant does not need to answer the question. \n\n**Note:** \n* When the poll's `type` value is `1` (Poll), this value defaults to `true`. \n* When the poll's `type` value is the `2` (Advanced Poll) or `3` (Quiz) values, this value defaults to `false`.","type":"boolean","example":false},"answers":{"description":"The poll question's available answers. This field requires a **minimum** of two answers. \n\n* For `single` and `multiple` polls, you can only provide a maximum of 10 answers. \n* For `matching` polls, you can only provide a maximum of 16 answers. \n* For `rank_order` polls, you can only provide a maximum of seven answers.","items":{"type":"string","example":"Extremely useful"},"minItems":2,"type":"array"},"case_sensitive":{"default":false,"description":"Whether the correct answer is case sensitive. This field only applies to `fill_in_the_blank` polls: \n* `true` — The answer is case-sensitive. \n* `false` — The answer is not case-sensitive. \n\nThis value defaults to `false`.","type":"boolean","example":false},"name":{"description":"The poll question's title, up to 255 characters. \n\nFor `fill_in_the_blank` polls, this field is the poll's question. For each value that the user must fill in, ensure that there are the same number of `right_answers` values.","maxLength":255,"type":"string","example":"How useful was this meeting?"},"prompts":{"description":"Information about the prompt questions. This field only applies to `matching` and `rank_order` polls. You **must** provide a minimum of two prompts, up to a maximum of 10 prompts.","items":{"properties":{"prompt_question":{"description":"The question prompt's title.","type":"string","example":"How are you?"},"prompt_right_answers":{"description":"The question prompt's correct answers: \n* For `matching` polls, you must provide a minimum of two correct answers, up to a maximum of 10 correct answers. \n* For `rank_order` polls, you can only provide one correct answer.","items":{"type":"string","example":"Good"},"type":"array"}},"type":"object"},"type":"array"},"rating_max_label":{"description":"The high score label used for the `rating_max_value` field. \n\nThis field only applies to the `rating_scale` poll.","type":"string","example":"Extremely Likely"},"rating_max_value":{"description":"The rating scale's maximum value, up to a maximum value of 10. \n\nThis field only applies to the `rating_scale` poll.","maximum":10,"type":"integer","example":4},"rating_min_label":{"description":"The low score label used for the `rating_min_value` field. \n\nThis field only applies to the `rating_scale` poll.","type":"string","example":"Not likely"},"rating_min_value":{"description":"The rating scale's minimum value. This value cannot be less than zero. \n\nThis field only applies to the `rating_scale` poll.","minimum":1,"type":"integer","example":1},"right_answers":{"description":"The poll question's correct answer(s). This field is **required** if the poll's `type` value is `3` (Quiz). \n\n For `single` and `matching` polls, this field only accepts one answer.","items":{"type":"string","example":"Good"},"minItems":1,"type":"array"},"show_as_dropdown":{"default":false,"description":"Whether to display the radio selection as a drop-down box: \n* `true` — Show as a drop-down box. \n* `false` — Do not show as a drop-down box. \n\nThis value defaults to `false`.","type":"boolean","example":false},"type":{"description":"The poll's question and answer type: \n* `single` — Single choice. \n* `multiple` — Multiple choice. \n* `matching` — Matching. \n* `rank_order` — Rank order. \n* `short_answer` — Short answer. \n* `long_answer` — Long answer. \n* `fill_in_the_blank` — Fill in the blank. \n* `rating_scale` — Rating scale.","enum":["single","multiple","matching","rank_order","short_answer","long_answer","fill_in_the_blank","rating_scale"],"type":"string","x-enum-descriptions":["Single choice","Multiple choice","Matching","Rank order","Short answer","Long answer","Fill in the blank","Rating scale"],"example":"single"}},"type":"object"},"minLength":1,"required":["name","type"],"type":"array"},"title":{"description":"The poll's title, up to 64 characters.","maxLength":64,"type":"string","example":"Learn something new"}},"type":"object"},"maxItems":25,"minItems":1,"type":"array"}},"type":"object"}}},"description":"Batch Meeting poll object"},"summary":"Perform batch poll creation"}},"/meetings/{meetingId}/polls/{pollId}":{"get":{"parameters":[{"in":"path","name":"meetingId","required":true,"description":"The meeting's ID. \n\n When storing this value in your database, you must store it as a long format integer and **not** an integer. Meeting IDs can exceed 10 digits.","schema":{"format":"int64","type":"integer","example":85746065}},{"description":"The poll ID","in":"path","name":"pollId","required":true,"schema":{"type":"string","example":"QalIoKWLTJehBJ8e1xRrbQ"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"id":{"description":"Meeting Poll ID","type":"string","example":"QalIoKWLTJehBJ8e1xRrbQ"},"status":{"description":"Status of the Meeting Poll:<br>`notstart` - Poll not started<br>`started` - Poll started<br>`ended` - Poll ended<br>`sharing` - Sharing poll results","enum":["notstart","started","ended","sharing"],"type":"string","x-enum-descriptions":["Poll not start","Poll started","Poll ended","Poll is sharing"],"example":"notstart"},"anonymous":{"default":false,"description":"Allow meeting participants to answer poll questions anonymously. \n\nThis value defaults to `false`.","type":"boolean","example":true},"poll_type":{"description":"The type of poll: \n* `1` — Poll. \n* `2` — Advanced Poll. This feature must be enabled in your Zoom account. \n* `3` — Quiz. This feature must be enabled in your Zoom account. \n\n This value defaults to `1`.","enum":[1,2,3],"type":"integer","example":2},"questions":{"description":"Information about the poll's questions.","items":{"properties":{"answer_max_character":{"description":"The allowed maximum number of characters. This field only applies to `short_answer` and `long_answer` polls: \n* For `short_answer` polls, a maximum of 500 characters. \n* For `long_answer` polls, a maximum of 2,000 characters.","type":"integer","example":200},"answer_min_character":{"description":"The allowed minimum number of characters. This field only applies to `short_answer` and `long_answer` polls. You must provide at least a **one** character minimum value.","minimum":1,"type":"integer","example":1},"answer_required":{"default":false,"description":"Whether participants must answer the question: \n* `true` — The participant must answer the question. \n* `false` — The participant does not need to answer the question. \n\n**Note:** \n* When the poll's `type` value is `1` (Poll), this value defaults to `true`. \n* When the poll's `type` value is the `2` (Advanced Poll) or `3` (Quiz) values, this value defaults to `false`.","type":"boolean","example":false},"answers":{"description":"The poll question's available answers. This field requires a **minimum** of two answers. \n\n* For `single` and `multiple` polls, you can only provide a maximum of 10 answers. \n* For `matching` polls, you can only provide a maximum of 16 answers. \n* For `rank_order` polls, you can only provide a maximum of seven answers.","items":{"type":"string","example":"Extremely useful"},"minItems":2,"type":"array"},"case_sensitive":{"default":false,"description":"Whether the correct answer is case sensitive. This field only applies to `fill_in_the_blank` polls: \n* `true` — The answer is case-sensitive. \n* `false` — The answer is not case-sensitive. \n\nThis value defaults to `false`.","type":"boolean","example":false},"name":{"description":"The poll question, up to 255 characters. \n\nFor `fill_in_the_blank` polls, this field is the poll's question. For each value that the user must fill in, ensure that there are the same number of `right_answers` values.","maxLength":255,"type":"string","example":"How useful was this meeting?"},"prompts":{"description":"Information about the prompt questions. This field only applies to `matching` and `rank_order` polls. You **must** provide a minimum of two prompts, up to a maximum of 10 prompts.","items":{"properties":{"prompt_question":{"description":"The question prompt's title.","type":"string","example":"How are you?"},"prompt_right_answers":{"description":"The question prompt's correct answers: \n* For `matching` polls, you must provide a minimum of two correct answers, up to a maximum of 10 correct answers. \n* For `rank_order` polls, you can only provide one correct answer.","items":{"type":"string","example":"Good"},"type":"array"}},"type":"object"},"type":"array"},"rating_max_label":{"description":"The high score label used for the `rating_max_value` field. \n\nThis field only applies to the `rating_scale` poll.","type":"string","example":"Extremely Likely"},"rating_max_value":{"description":"The rating scale's maximum value, up to a maximum value of 10. \n\nThis field only applies to the `rating_scale` poll.","maximum":10,"type":"integer","example":4},"rating_min_label":{"description":"The low score label used for the `rating_min_value` field. \n\nThis field only applies to the `rating_scale` poll.","type":"string","example":"Not likely"},"rating_min_value":{"description":"The rating scale's minimum value. This value cannot be less than zero. \n\nThis field only applies to the `rating_scale` poll.","minimum":0,"type":"integer","example":0},"right_answers":{"description":"The poll question's correct answer(s). This field is **required** if the poll's `type` value is `3` (Quiz). \n\n For `single` and `matching` polls, this field only accepts one answer.","items":{"type":"string","example":"Good"},"minItems":1,"type":"array"},"show_as_dropdown":{"default":false,"description":"Whether to display the radio selection as a drop-down box: \n* `true` — Show as a drop-down box. \n* `false` — Do not show as a drop-down box. \n\nThis value defaults to `false`.","type":"boolean","example":false},"type":{"description":"The poll's question and answer type: \n* `single` — Single choice. \n* `multiple` — Multiple choice. \n* `matching` — Matching. \n* `rank_order` — Rank order. \n* `short_answer` — Short answer. \n* `long_answer` — Long answer. \n* `fill_in_the_blank` — Fill in the blank. \n* `rating_scale` — Rating scale.","enum":["single","multiple","matching","rank_order","short_answer","long_answer","fill_in_the_blank","rating_scale"],"type":"string","x-enum-descriptions":["Single choice","Multiple choice","Matching","Rank order","Short answer","Long answer","Fill in the blank","Rating scale"],"example":"single"}},"type":"object"},"type":"array"},"title":{"description":"The poll's title, up to 64 characters.","maxLength":64,"type":"string","example":"Learn something new"}},"type":"object","description":"Information about meeting and webinar polling.","title":"Meeting and Webinar Polling Object"}}},"description":"**HTTP Status Code:** `200` <br>\nMeeting Poll object returned"},"400":{"description":"**HTTP Status Code:** `400` **Bad Request** <br>\n **Error Code:** `4400` <br> Meeting polls disabled. To enable this feature, enable the \"Meeting Polls/Quizzes\" setting in the Zoom web portal's \"Settings\" interface. \n\n **Error Code:** `3161` <br>\nMeeting hosting and scheduling capabilities are not allowed for your user account."},"404":{"description":"**Error Code:** `404` <br>\nMeeting Poll not found."}},"security":[{"OAuth":[]}],"tags":["Meetings"],"description":"Polls allow the meeting host to survey attendees. Retrieve information about a specific meeting [poll](https://support.zoom.us/hc/en-us/articles/213756303-Polling-for-Meetings).<br><br>\n**Scopes**: `meeting:read:admin` `meeting:read`<br>\n\n **[Rate Limit Label](https://developers.zoom.us/docs/api/rest/rate-limits/):** `Light`\n\n\n","operationId":"meetingPollGet","summary":"Get a meeting poll"},"put":{"parameters":[{"in":"path","name":"meetingId","required":true,"description":"The meeting's ID. \n\n When storing this value in your database, you must store it as a long format integer and **not** an integer. Meeting IDs can exceed 10 digits.","schema":{"format":"int64","type":"integer","example":85746065}},{"description":"The poll ID","in":"path","name":"pollId","required":true,"schema":{"type":"string","example":"QalIoKWLTJehBJ8e1xRrbQ"}}],"responses":{"204":{"description":"**HTTP Status Code:** `204` <br>\nMeeting Poll Updated"},"400":{"description":"**HTTP Status Code:** `400` **Bad Request** <br>\n **Error Code:** `4400` <br>\n* Meeting polls disabled. To enable this feature, enable the \"Meeting Polls/Quizzes\" setting in the Zoom web portal's \"Settings\" interface. \n* Advanced meeting polls disabled. To enable this feature, enable the \"Allow host to create advanced polls and quizzes\" setting in the Zoom web portal's \"Settings\" interface. \n\n **Error Code:** `3161` <br>\nMeeting hosting and scheduling capabilities are not allowed for your user account."},"404":{"description":"**Error Code:** `404` <br>\nMeeting Poll not found"}},"security":[{"OAuth":[]}],"tags":["Meetings"],"description":"Polls allow the meeting host to survey attendees. Update information of a specific meeting [poll](https://support.zoom.us/hc/en-us/articles/213756303-Polling-for-Meetings)<br><br>\n**Scopes**: `meeting:write:admin` `meeting:write`\n\n **[Rate Limit Label](https://developers.zoom.us/docs/api/rest/rate-limits/):** `Light` \n\n","operationId":"meetingPollUpdate","requestBody":{"content":{"application/json":{"schema":{"description":"Information about meeting and webinar polling.","properties":{"anonymous":{"default":false,"description":"Allow meeting participants to answer poll questions anonymously. \n\nThis value defaults to `false`.","type":"boolean","example":true},"poll_type":{"description":"The type of poll: \n* `1` — Poll. \n* `2` — Advanced Poll. This feature must be enabled in your Zoom account. \n* `3` — Quiz. This feature must be enabled in your Zoom account. \n\n This value defaults to `1`.","enum":[1,2,3],"type":"integer","example":2},"questions":{"description":"Information about the poll's questions.","items":{"properties":{"answer_max_character":{"description":"The allowed maximum number of characters. This field only applies to `short_answer` and `long_answer` polls: \n* For `short_answer` polls, a maximum of 500 characters. \n* For `long_answer` polls, a maximum of 2,000 characters.","type":"integer","example":200},"answer_min_character":{"description":"The allowed minimum number of characters. This field only applies to `short_answer` and `long_answer` polls. You must provide at least a **one** character minimum value.","minimum":1,"type":"integer","example":1},"answer_required":{"default":false,"description":"Whether participants must answer the question: \n* `true` — The participant must answer the question. \n* `false` — The participant does not need to answer the question. \n\n**Note:** \n* When the poll's `type` value is `1` (Poll), this value defaults to `true`. \n* When the poll's `type` value is the `2` (Advanced Poll) or `3` (Quiz) values, this value defaults to `false`.","type":"boolean","example":false},"answers":{"description":"The poll question's available answers. This field requires a **minimum** of two answers. \n\n* For `single` and `multiple` polls, you can only provide a maximum of 10 answers. \n* For `matching` polls, you can only provide a maximum of 16 answers. \n* For `rank_order` polls, you can only provide a maximum of seven answers.","items":{"type":"string","example":"Extremely useful"},"minItems":2,"type":"array"},"case_sensitive":{"default":false,"description":"Whether the correct answer is case sensitive. This field only applies to `fill_in_the_blank` polls: \n* `true` — The answer is case-sensitive. \n* `false` — The answer is not case-sensitive. \n\nThis value defaults to `false`.","type":"boolean","example":false},"name":{"description":"The poll question, up to 255 characters. \n\nFor `fill_in_the_blank` polls, this field is the poll's question. For each value that the user must fill in, ensure that there are the same number of `right_answers` values.","maxLength":255,"type":"string","example":"How useful was this meeting?"},"prompts":{"description":"Information about the prompt questions. This field only applies to `matching` and `rank_order` polls. You **must** provide a minimum of two prompts, up to a maximum of 10 prompts.","items":{"properties":{"prompt_question":{"description":"The question prompt's title.","type":"string","example":"How are you?"},"prompt_right_answers":{"description":"The question prompt's correct answers: \n* For `matching` polls, you must provide a minimum of two correct answers, up to a maximum of 10 correct answers. \n* For `rank_order` polls, you can only provide one correct answer.","items":{"type":"string","example":"Good"},"type":"array"}},"type":"object"},"type":"array"},"rating_max_label":{"description":"The high score label used for the `rating_max_value` field. \n\nThis field only applies to the `rating_scale` poll.","type":"string","example":"Extremely Likely"},"rating_max_value":{"description":"The rating scale's maximum value, up to a maximum value of 10. \n\nThis field only applies to the `rating_scale` poll.","maximum":10,"type":"integer","example":4},"rating_min_label":{"description":"The low score label used for the `rating_min_value` field. \n\nThis field only applies to the `rating_scale` poll.","type":"string","example":"Not likely"},"rating_min_value":{"description":"The rating scale's minimum value. This value cannot be less than zero. \n\nThis field only applies to the `rating_scale` poll.","minimum":0,"type":"integer","example":0},"right_answers":{"description":"The poll question's correct answer(s). This field is **required** if the poll's `type` value is `3` (Quiz). \n\n For `single` and `matching` polls, this field only accepts one answer.","items":{"type":"string","example":"Good"},"minItems":1,"type":"array"},"show_as_dropdown":{"default":false,"description":"Whether to display the radio selection as a drop-down box: \n* `true` — Show as a drop-down box. \n* `false` — Do not show as a drop-down box. \n\nThis value defaults to `false`.","type":"boolean","example":false},"type":{"description":"The poll's question and answer type: \n* `single` — Single choice. \n* `multiple` — Multiple choice. \n* `matching` — Matching. \n* `rank_order` — Rank order. \n* `short_answer` — Short answer. \n* `long_answer` — Long answer. \n* `fill_in_the_blank` — Fill in the blank. \n* `rating_scale` — Rating scale.","enum":["single","multiple","matching","rank_order","short_answer","long_answer","fill_in_the_blank","rating_scale"],"type":"string","x-enum-descriptions":["Single choice","Multiple choice","Matching","Rank order","Short answer","Long answer","Fill in the blank","Rating scale"],"example":"single"}},"type":"object"},"type":"array"},"title":{"description":"The poll's title, up to 64 characters.","maxLength":64,"type":"string","example":"Learn something new"}},"title":"Meeting and Webinar Polling Object","type":"object"}}},"description":"Meeting Poll","required":true},"summary":"Update a meeting poll"},"delete":{"parameters":[{"in":"path","name":"meetingId","required":true,"description":"The meeting's ID. \n\n When storing this value in your database, you must store it as a long format integer and **not** an integer. Meeting IDs can exceed 10 digits.","schema":{"format":"int64","type":"integer","example":85746065}},{"description":"The poll ID","in":"path","name":"pollId","required":true,"schema":{"type":"string","example":"QalIoKWLTJehBJ8e1xRrbQ"}}],"responses":{"204":{"description":"**HTTP Status Code:** `204` <br>\nMeeting Poll deleted"},"400":{"description":"**HTTP Status Code:** `400` **Bad Request** <br>\n **Error Code:** `4400` <br> Meeting polls disabled. To enable this feature, enable the \"Meeting Polls/Quizzes\" setting in the Zoom web portal's \"Settings\" interface. \n\n **Error Code:** `3161` <br>\nMeeting hosting and scheduling capabilities are not allowed for your user account."},"404":{"description":"**Error Code:** `404`\nMeeting Poll not found"}},"security":[{"OAuth":[]}],"tags":["Meetings"],"description":"Polls allow the meeting host to survey attendees. Delete a meeting [poll](https://support.zoom.us/hc/en-us/articles/213756303-Polling-for-Meetings).<br>\n**Scopes**: `meeting:write:admin` `meeting:write`<br>\n **[Rate Limit Label](https://developers.zoom.us/docs/api/rest/rate-limits/):** `Light` <br>\n**Prerequisites**:<br>\n* Host user type must be **Pro**.\n* Polling feature should be enabled in the host's account.\n* Meeting must be a scheduled meeting. Instant meetings do not have polling features enabled.","operationId":"meetingPollDelete","summary":"Delete a meeting poll"}},"/meetings/{meetingId}/survey":{"get":{"parameters":[{"in":"path","name":"meetingId","required":true,"description":"The meeting's ID. \n\n When storing this value in your database, you must store it as a long format integer and **not** an integer. Meeting IDs can exceed 10 digits.","schema":{"format":"int64","type":"integer","example":85746065}}],"responses":{"200":{"content":{"application/json":{"schema":{"description":"Information about the meeting survey.","properties":{"custom_survey":{"description":"Information about the customized meeting survey.","properties":{"anonymous":{"default":false,"description":"Allow participants to anonymously answer survey questions. \n\n This value defaults to `true`.","type":"boolean","example":false},"questions":{"description":"Information about the meeting survey's questions.","items":{"properties":{"answer_max_character":{"description":"The allowed maximum number of characters. This field only applies to `long_answer` survey, a maximum of 2,000 characters.","type":"integer","example":200},"answer_min_character":{"description":"The allowed minimum number of characters. This field only applies to `long_answer` survey. You must provide at least a **one** character minimum value.","minimum":1,"type":"integer","example":1},"answer_required":{"default":false,"description":"Whether participants must answer the question: \n* `true` — The participant must answer the question. \n* `false` — The participant does not need to answer the question. \n\n This value defaults to `false`.","type":"boolean","example":false},"answers":{"description":"The survey question's available answers. This field requires a **minimum** of two answers. \n\n* For `single` and `multiple` polls, you can only provide a maximum of 10 answers. \n* For `matching` polls, you can only provide a maximum of 16 answers. \n* For `rank_order` polls, you can only provide a maximum of seven answers.","items":{"type":"string","example":"Extremely useful"},"minItems":2,"type":"array"},"name":{"description":"The survey question, up to 255 characters.","maxLength":255,"type":"string","example":"How useful was this meeting?"},"rating_max_label":{"description":"The high score label used for the `rating_max_value` field. \n\n This field only applies to the `rating_scale` survey.","type":"string","example":"Extremely Likely"},"rating_max_value":{"description":"The rating scale's maximum value, up to a maximum value of 10. \n\n This field only applies to the `rating_scale` survey.","maximum":10,"type":"integer","example":4},"rating_min_label":{"description":"The low score label used for the `rating_min_value` field. \n\nT his field only applies to the `rating_scale` survey.","type":"string","example":"Not likely"},"rating_min_value":{"description":"The rating scale's minimum value. This value cannot be less than zero. \n\n This field only applies to the `rating_scale` survey.","minimum":0,"type":"integer","example":1},"show_as_dropdown":{"default":false,"description":"Display the radio selection as a drop-down box: \n* `true` — Show as a drop-down box. \n* `false` — Do not show as a drop-down box. \n\n This value defaults to `false`.","type":"boolean","example":false},"type":{"description":"The survey's question and answer type: \n* `single` — Single choice. \n* `multiple` — Multiple choice. \n* `rating_scale` — Rating scale. \n* `long_answer` — Long answer.","enum":["single","multiple","rating_scale","long_answer"],"type":"string","x-enum-descriptions":["Single choice","Multiple choice","Rating scale","Long answer"],"example":"single"}},"type":"object"},"type":"array"}},"type":"object"},"show_in_the_browser":{"default":true,"description":"Whether the **Show in the browser when the meeting ends** option is enabled: \n* `true` — Enabled. \n* `false` — Disabled. \n\n This value defaults to `true`.","type":"boolean","example":true},"third_party_survey":{"description":"The link to the third party meeting survey.","maxLength":64,"type":"string","example":"https://example.com"}},"title":"Meeting Survey Object","type":"object"}}},"description":"**HTTP Status Code:** `200` <br>\n Meeting survey object returned."},"400":{"description":"**HTTP Status Code:** `400` <br> Bad Request \n\n **Error Code:** `300` <br>\n Invalid meeting ID. \n\n **Error Code:** `3000` <br>\n * Cannot access Webinar information. <br>\n * Meeting survey disabled. To enable this feature, enable the \"Meeting Survey\" setting in the Zoom web portal's \"Settings\" interface. \n\n **Error Code:** `3161` <br>\nMeeting hosting and scheduling capabilities are not allowed for your user account."},"404":{"description":"**HTTP Status Code:** `404` <br> Not Found \n\n **Error Code:** `300` <br>\n Meeting ID does not exist. \n\n **Error Code:** `3001` <br>\n Meeting does not exist: {meetingId}."}},"security":[{"OAuth":[]}],"tags":["Meetings"],"description":"Return information about a [meeting survey](https://support.zoom.us/hc/en-us/articles/4404969060621-Post-meeting-survey-and-reporting). \n\n **Scopes:** `meeting:read`, `meeting:read:admin` <br> **[Rate Limit Label](https://developers.zoom.us/docs/api/rest/rate-limits/):** `Light` \n\n **Prerequisites:** \n* The host must be a **Pro** user type. \n* The [**Meeting Survey**](https://support.zoom.us/hc/en-us/articles/4404939095053-Enabling-meeting-surveys) feature enabled in the host's account. \n* The meeting must be a scheduled meeting. Instant meetings do not have survey features enabled.","operationId":"meetingSurveyGet","summary":"Get a meeting survey"},"patch":{"parameters":[{"in":"path","name":"meetingId","required":true,"description":"The meeting's ID. \n\n When storing this value in your database, you must store it as a long format integer and **not** an integer. Meeting IDs can exceed 10 digits.","schema":{"format":"int64","type":"integer","example":85746065}}],"responses":{"204":{"description":"**HTTP Status Code:** `204` <br>\n Meeting survey updated."},"400":{"description":"**HTTP Status Code:** `400` <br> Bad Request \n\n **Error Code:** `300` <br>\n * Invalid meeting ID. <br>\n * Invalid third party survey: {third_party_survey}. \n\n **Error Code:** `3000` <br>\n * Cannot access Webinar information. <br>\n * Meeting survey disabled. To enable this feature, enable the \"Meeting Survey\" setting in the Zoom web portal's \"Settings\" interface. \n\n **Error Code:** `3161` <br>\nMeeting hosting and scheduling capabilities are not allowed for your user account."},"404":{"description":"**HTTP Status Code:** `404` <br> Not Found \n\n **Error Code:** `300` <br>\n Meeting ID does not exist. \n\n **Error Code:** `3001` <br>\n Meeting does not exist: {meetingId}."}},"security":[{"OAuth":[]}],"tags":["Meetings"],"description":"Update a [meeting survey](https://support.zoom.us/hc/en-us/articles/4404969060621-Post-meeting-survey-and-reporting). \n\n **Scopes:** `meeting:write`, `meeting:write:admin` <br> **[Rate Limit Label](https://developers.zoom.us/docs/api/rest/rate-limits/):** `Light` \n\n **Prerequisites:** \n* The host must be a **Pro** user type. \n* The [**Meeting Survey**](https://support.zoom.us/hc/en-us/articles/4404939095053-Enabling-meeting-surveys) feature enabled in the host's account. \n* The meeting must be a scheduled meeting. Instant meetings do not have survey features enabled.","operationId":"meetingSurveyUpdate","requestBody":{"content":{"application/json":{"schema":{"description":"Information about the meeting survey.","properties":{"custom_survey":{"description":"Information about the customized meeting survey.","properties":{"anonymous":{"default":false,"description":"Allow participants to anonymously answer survey questions. \n\n This value defaults to `true`.","type":"boolean","example":false},"questions":{"description":"Information about the meeting survey's questions.","items":{"properties":{"answer_max_character":{"description":"The allowed maximum number of characters. This field only applies to `long_answer` survey, a maximum of 2,000 characters.","type":"integer","example":200},"answer_min_character":{"description":"The allowed minimum number of characters. This field only applies to `long_answer` survey. You must provide at least a **one** character minimum value.","minimum":1,"type":"integer","example":1},"answer_required":{"default":false,"description":"Whether participants must answer the question: \n* `true` — The participant must answer the question. \n* `false` — The participant does not need to answer the question. \n\n This value defaults to `false`.","type":"boolean","example":false},"answers":{"description":"The survey question's available answers. This field requires a **minimum** of two answers. \n\n* For `single` and `multiple` polls, you can only provide a maximum of 10 answers. \n* For `matching` polls, you can only provide a maximum of 16 answers. \n* For `rank_order` polls, you can only provide a maximum of seven answers.","items":{"type":"string","example":"Extremely useful"},"minItems":2,"type":"array"},"name":{"description":"The survey question, up to 255 characters.","maxLength":255,"type":"string","example":"How useful was this meeting?"},"rating_max_label":{"description":"The high score label used for the `rating_max_value` field. \n\n This field only applies to the `rating_scale` survey.","type":"string","example":"Extremely Likely"},"rating_max_value":{"description":"The rating scale's maximum value, up to a maximum value of 10. \n\n This field only applies to the `rating_scale` survey.","maximum":10,"type":"integer","example":4},"rating_min_label":{"description":"The low score label used for the `rating_min_value` field. \n\nT his field only applies to the `rating_scale` survey.","type":"string","example":"Not likely"},"rating_min_value":{"description":"The rating scale's minimum value. This value cannot be less than zero. \n\n This field only applies to the `rating_scale` survey.","minimum":0,"type":"integer","example":1},"show_as_dropdown":{"default":false,"description":"Display the radio selection as a drop-down box: \n* `true` — Show as a drop-down box. \n* `false` — Do not show as a drop-down box. \n\n This value defaults to `false`.","type":"boolean","example":false},"type":{"description":"The survey's question and answer type: \n* `single` — Single choice. \n* `multiple` — Multiple choice. \n* `rating_scale` — Rating scale. \n* `long_answer` — Long answer.","enum":["single","multiple","rating_scale","long_answer"],"type":"string","x-enum-descriptions":["Single choice","Multiple choice","Rating scale","Long answer"],"example":"single"}},"type":"object"},"type":"array"}},"type":"object"},"show_in_the_browser":{"default":true,"description":"Whether the **Show in the browser when the meeting ends** option is enabled: \n* `true` — Enabled. \n* `false` — Disabled. \n\n This value defaults to `true`.","type":"boolean","example":true},"third_party_survey":{"description":"The link to the third party meeting survey.","maxLength":64,"type":"string","example":"https://example.com"}},"title":"Meeting Survey Object","type":"object"}}},"required":true},"summary":"Update a meeting survey"},"delete":{"parameters":[{"in":"path","name":"meetingId","required":true,"description":"The meeting's ID. \n\n When storing this value in your database, you must store it as a long format integer and **not** an integer. Meeting IDs can exceed 10 digits.","schema":{"format":"int64","type":"integer","example":85746065}}],"responses":{"204":{"description":"**HTTP Status Code:** `204` <br>\n Meeting survey deleted."},"400":{"description":"**HTTP Status Code:** `400` <br> Bad Request \n\n **Error Code:** `300` <br>\n Invalid meeting ID. \n\n **Error Code:** `3000` <br>\n * Cannot access Webinar information. <br>\n * Meeting survey disabled. To enable this feature, enable the \"Meeting Survey\" setting in the Zoom web portal's \"Settings\" interface. \n\n **Error Code:** `3161` <br>\nMeeting hosting and scheduling capabilities are not allowed for your user account."},"404":{"description":"**HTTP Status Code:** `404` <br> Not Found \n\n **Error Code:** `300` <br>\n Meeting ID does not exist. \n\n **Error Code:** `3001` <br>\n Meeting does not exist: {meetingId}."}},"security":[{"OAuth":[]}],"tags":["Meetings"],"description":"Delete a [meeting survey](https://support.zoom.us/hc/en-us/articles/4404969060621-Post-meeting-survey-and-reporting). \n\n **Scopes:** `meeting:write`, `meeting:write:admin` <br> **[Rate Limit Label](https://developers.zoom.us/docs/api/rest/rate-limits/):** `Light` \n\n **Prerequisites:** \n* The host must be a **Pro** user type. \n* The [**Meeting Survey**](https://support.zoom.us/hc/en-us/articles/4404939095053-Enabling-meeting-surveys) feature enabled in the host's account. \n* The meeting must be a scheduled meeting. Instant meetings do not have survey features enabled.","operationId":"meetingSurveyDelete","summary":"Delete a meeting survey"}},"/users/{userId}/meeting_templates":{"get":{"parameters":[{"description":"Unique identifier of the user. Retrieve the value of this field by calling the [**List users**](/docs/api-reference/zoom-api/methods#operation/users) API.","in":"path","name":"userId","required":true,"schema":{"type":"string","example":"30R7kT7bTIKSNUFEuH_Qlg"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"templates":{"items":{"properties":{"id":{"description":"The template ID.","type":"string","example":"AdxbhxCzKgSiWAw"},"name":{"description":"The template name.","type":"string","example":"My meeting template"},"type":{"description":"The template type: <br>\n`1`: Meeting template <br>\n`2`: Admin meeting template","type":"integer","example":1}},"type":"object"},"type":"array"},"total_records":{"description":"Total records found for this request.","type":"integer","example":1}},"type":"object"}}},"description":"**HTTP Status Code:** `200` **OK** <br>"},"400":{"description":"**HTTP Status Code:** `400` <br>\n Bad Request \n\n **Error Code:** `3161` <br>\nMeeting hosting and scheduling capabilities are not allowed for your user account."},"404":{"description":"**HTTP Status Code:** `404` **Not Found** <br>\n**Error Code:** `1001`<br> User not exist: {userId}.<br>\nUser {userId} does not exist or does not belong to this account."}},"tags":["Meetings"],"description":"List available [meeting templates](https://support.zoom.us/hc/en-us/articles/360036559151-Meeting-templates) for a user. For user-level apps, pass [the `me` value](https://marketplace.zoom.us/docs/api-reference/using-zoom-apis#mekeyword) instead of the `userId` parameter.\n\n**Scopes:** `meeting:read` or `meeting:read:admin`</br>**[Rate Limit Label](https://developers.zoom.us/docs/api/rest/rate-limits/):** `Medium`\n","operationId":"listMeetingTemplates","summary":"List meeting templates"},"post":{"parameters":[{"description":"The user ID retrievable from the [List users](/api-reference/zoom-api/methods#operation/users) API.","in":"path","name":"userId","required":true,"schema":{"type":"string","example":"30R7kT7bTIKSNUFEuH_Qlg"}}],"summary":"Create a meeting template from an existing meeting","description":"Create a meeting template from an existing meeting. \n\n**Scopes**: `meeting:write:admin`, `meeting:write`</br>**[Rate Limit Label](https://developers.zoom.us/docs/api/rest/rate-limits/):** `Medium`","operationId":"meetingTemplateCreate","tags":["Meetings"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"meeting_id":{"type":"integer","format":"int64","description":"The meeting ID aka the meeting number in long (int64) format.","example":96172769962},"name":{"type":"string","description":"The template name.","example":"My Meeting Template"},"save_recurrence":{"type":"boolean","description":"If the field is set to true, the recurrence meeting template will be saved as the scheduled meeting.","example":false,"default":false},"overwrite":{"type":"boolean","description":"Overwrite an existing meeting template if the template is created from same existing meeting.","default":false,"example":false}}}}}},"responses":{"201":{"content":{"application/json":{"schema":{"type":"object","properties":{"id":{"description":"The template ID.","type":"string","example":"AdxbhxCzKgSiWAw"},"name":{"description":"The template name.","type":"string","example":"My Meeting Template"}}}}},"description":"**HTTP Status Code:** `201`<br>\nMeeting template created."},"400":{"description":"**HTTP Status Code:** `400` <br>\nBad Request \n\n**Error Code:** `300` <br>\n* Meeting ID does not exist. \n* Invalid meeting ID. \n* You can only create up to 40 meeting templates. \n\n**Error Code:** `3000` <br>\n* Cannot access webinar information. \n* Meeting template name already exists: {templateName}. \n\n**Error Code:** `3001` <br>\nMeeting does not exist: {meetingId} \n\n **Error Code:** `3161` <br>\nMeeting hosting and scheduling capabilities are not allowed for your user account."},"404":{"description":"**HTTP Status Code:** `404` <br>\nNot Found \n\n**Error Code:** `1001` <br>\n* User not exist: {userId}. \n* User {userId} does not exist or does not belong to this account."}}}},"/meetings/{meetingId}/livestream":{"get":{"parameters":[{"description":"Unique identifier of the meeting.","in":"path","name":"meetingId","required":true,"schema":{"type":"string","example":"93398114182"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"page_url":{"description":"Live streaming page URL. This is the URL using which anyone can view the livestream of the meeting.","type":"string","example":"https://example.com/livestream/123"},"stream_key":{"description":"Stream Key.","type":"string","example":"contact-ic@example.com"},"stream_url":{"description":"Stream URL.","type":"string","example":"https://example.com/livestream"},"resolution":{"description":"The number of pixels in each dimension that the video camera can display.","type":"string","example":"720p"}},"type":"object"}}},"description":"**HTTP Status Code:** `200` **OK**<br>\nLive Stream details returned.\n\n"},"400":{"description":"**HTTP Status Code:** `400` **Bad Request**<br>\n**Error Code:** `300`<br>\nMissing meetingId<br>\nInvalid meetingId<br><br>\n**Error Code:** `1010`<br>\nUser does not belong to this account: {accountId} \n\n **Error Code:** `3161` <br>\nMeeting hosting and scheduling capabilities are not allowed for your user account."},"404":{"description":"**HTTP Status Code:** `404` **Not Found**<br>\n**Error Code:** `1001`<br>\nUser {userId} does not exist.\n\n"}},"tags":["Meetings"],"description":"Zoom allows users to [livestream a meeting](https://support.zoom.us/hc/en-us/articles/115001777826-Live-Streaming-Meetings-or-Webinars-Using-a-Custom-Service) to a custom platform. Get a meeting's livestream configuration details such as Stream URL, Stream Key and Page URL.<br><br>\n**Prerequisites:**<br>\n* Meeting host must be a licensed user with a Pro or higher plan.<br>\n* Live streaming details must have been [configured](https://support.zoom.us/hc/en-us/articles/115001777826-Live-Streaming-Meetings-or-Webinars-Using-a-Custom-Service#h_01589a6f-a40a-4e18-a448-cb746e52ebc5) for the meeting.<br><br>\n**Scopes:** `meeting:read:admin` `meeting:read`<br>\n **[Rate Limit Label](https://developers.zoom.us/docs/api/rest/rate-limits/):** `Light`\n\n\n\n","operationId":"getMeetingLiveStreamDetails","summary":"Get livestream details"},"patch":{"parameters":[{"in":"path","name":"meetingId","required":true,"description":"The meeting's ID. \n\n When storing this value in your database, you must store it as a long format integer and **not** an integer. Meeting IDs can exceed 10 digits.","schema":{"format":"int64","type":"integer","example":85746065}}],"responses":{"204":{"description":"**HTTP Status Code:** `204`<br>\nMeeting livestream updated."},"300":{"description":"**Error Code:** `300` <br>Missing meetingId <br> Invalid meetingId."},"400":{"description":"**HTTP Status Code:** `400`<br>**Error Code:** `1010` <br>\n User does not belong to this account: {accountId}.<br>\n **Error Code:** `3000` Cannot access webinar info. \n\n **Error Code:** `3161` <br>\nMeeting hosting and scheduling capabilities are not allowed for your user account."},"404":{"description":"**HTTP Status Code:** `404`<br>**Error Code:** `1001` <br>User {userId} does not exist.\n"}},"security":[{"OAuth":[]}],"tags":["Meetings"],"description":"Update a meeting's livestream information. Zoom allows users to [livestream a meeting](https://support.zoom.us/hc/en-us/articles/115001777826-Live-Streaming-Meetings-or-Webinars-Using-a-Custom-Service) to a custom platform.\n\n**Scopes:** `meeting:write:admin`, `meeting:write`<br>**[Rate Limit Label](https://developers.zoom.us/docs/api/rest/rate-limits/):** `Light`\n\n**Prerequisites:** \n* Meeting host must have a Pro license.","operationId":"meetingLiveStreamUpdate","requestBody":{"content":{"application/json":{"schema":{"description":"Meeting live stream.","properties":{"page_url":{"description":"The live stream page URL.","format":"uri","maxLength":1024,"type":"string","example":"https://example.com/livestream/123"},"stream_key":{"description":"Stream name and key.","maxLength":512,"type":"string","example":"contact-it@example.com"},"stream_url":{"description":"Streaming URL.","maxLength":1024,"type":"string","example":"https://example.com/livestream"},"resolution":{"description":"The number of pixels in each dimension that the video camera can display, required when a user enables 1080p. Use a value of `720p` or `1080p`","type":"string","example":"720p"}},"required":["stream_url","stream_key","page_url"],"type":"object"}}},"description":"Meeting","required":true},"summary":"Update a livestream"}},"/meetings/{meetingId}/livestream/status":{"patch":{"parameters":[{"in":"path","name":"meetingId","required":true,"description":"The meeting's ID. \n\n When storing this value in your database, you must store it as a long format integer and **not** an integer. Meeting IDs can exceed 10 digits.","schema":{"format":"int64","type":"integer","example":85746065}}],"responses":{"204":{"description":"**HTTP Status Code:** `204` <br>\nMeeting livestream updated.\n\n"},"300":{"description":"**Error Code:** `300` <br>\nMissing meetingId.<br>\nInvalid meetingId"},"400":{"description":"**HTTP Status Code:** `400` <br>\n**Error Code:**`3000`<br>\nCannot access webinar info.<br>\n**Error Code:**`1010`<br>User does not belong to this account: {accountId}. \n\n **Error Code:** `3161` <br>\nMeeting hosting and scheduling capabilities are not allowed for your user account."},"404":{"description":"**HTTP Status Code:** `404` <br>\n**Error Code:**`1001`<br>\nUser {userId} does not exist.<br>\n"},"429":{"description":"**HTTP Status Code:** `429`<br>Too many requests submitted to start the livestream of this meeting: {meetingId}. If the livestream has not already started, retry making a new request after 30 seconds."}},"security":[{"OAuth":[]}],"tags":["Meetings"],"description":"Zoom allows users to [livestream a meeting](https://support.zoom.us/hc/en-us/articles/115001777826-Live-Streaming-Meetings-or-Webinars-Using-a-Custom-Service) to a custom platform. Update the status of a meeting's livestream.<br><br>\n**Prerequisites:**<br>\n* Meeting host must have a Pro license.<br>\n**Scopes:** `meeting:write:admin` `meeting:write`<br>\n **[Rate Limit Label](https://developers.zoom.us/docs/api/rest/rate-limits/):** `Light` \n\n","operationId":"meetingLiveStreamStatusUpdate","requestBody":{"content":{"application/json":{"schema":{"description":"Meeting live stream status.","properties":{"action":{"description":"Update the status of a live stream.\n\nThe value can be one of the following:<br>\n`start`: Start a live stream. <br>\n`stop`: Stop an ongoing live stream.","enum":["start","stop"],"type":"string","x-enum-descriptions":["Start a meeting live stream.","Stop a meeting live stream."],"example":"start"},"settings":{"description":"Update the settings of a live streaming session. The settings can only be updated for a live stream that has been stopped. You can not update the settings of an ongoing live stream.","properties":{"active_speaker_name":{"description":"Display the name of the active speaker during a live stream.","type":"boolean","example":true},"display_name":{"description":"Display name of the live stream.","maxLength":50,"minLength":1,"type":"string","example":"Jill Chill"}},"type":"object"}},"type":"object"}}},"description":"Meeting","required":true},"summary":"Update Live Stream Status"}},"/past_meetings/{meetingId}/instances":{"get":{"parameters":[{"description":"The past meeting's ID.","in":"path","name":"meetingId","required":true,"schema":{"format":"int64","type":"integer","example":93398114182}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"meetings":{"description":"List of ended meeting instances.","items":{"properties":{"start_time":{"description":"Start time","format":"date-time","type":"string","example":"2022-03-26T05:37:59Z"},"uuid":{"description":"Meeting UUID. Unique meeting ID. Each meeting instance will generate its own Meeting UUID (i.e., after a meeting ends, a new UUID will be generated for the next instance of the meeting). [Double encode](https://marketplace.zoom.us/docs/api-reference/using-zoom-apis/#meeting-id-and-uuid) your UUID when using it for API calls if the UUID begins with a '/'or contains '//' in it.\n\n","type":"string","example":"Vg8IdgluR5WDeWIkpJlElQ=="}},"type":"object"},"type":"array"}},"type":"object","description":"List of Meetings","title":"Meeting instances"}}},"description":"**HTTP Status Code:** `200` <br>\n List of ended meeting instances returned."},"404":{"description":"**HTTP Status Code:** `404` <br>\n Meeting not found."}},"security":[{"OAuth":[]}],"tags":["Meetings"],"description":"Return a list of past meeting instances. \n\n **Scopes:** `meeting:read:admin`, `meeting:read` <br> **[Rate Limit Label](https://developers.zoom.us/docs/api/rest/rate-limits/):** `Medium`","operationId":"pastMeetings","summary":"List past meeting instances"}},"/past_meetings/{meetingId}/polls":{"get":{"parameters":[{"description":"The meeting's ID or universally unique ID (UUID). \n* If you provide a meeting ID, the API will return a response for the latest meeting instance. \n* If you provide a meeting UUID that begins with a `/` character or contains the `//` characters, you **must** [double encode](https://marketplace.zoom.us/docs/api-reference/using-zoom-apis/#meeting-id-and-uuid) the meeting UUID before making an API request.","in":"path","name":"meetingId","required":true,"schema":{"oneOf":[{"type":"integer","example":5638296721},{"type":"string","example":"4444AAAiAAAAAiAiAiiAii=="}]}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"id":{"description":"[Meeting ID](https://support.zoom.us/hc/en-us/articles/201362373-What-is-a-Meeting-ID-): Unique identifier of the meeting in \"**long**\" format(represented as int64 data type in JSON), also known as the meeting number.","format":"int64","type":"integer","example":93398114182},"questions":{"items":{"properties":{"email":{"description":"Email address of the user who submitted answers to the poll. If the user is **not** part of the host's account, this returns an empty string value, with some exceptions. See [Email address display rules](https://marketplace.zoom.us/docs/api-reference/using-zoom-apis#email-address) for details.","type":"string","example":"jchill@example.com"},"name":{"description":"Name of the user who submitted answers to the poll. If \"anonymous\" option is enabled for a poll, the participant's polling information will be kept anonymous and the value of `name` field will be \"Anonymous Attendee\".","type":"string","example":"Jill Chill"},"question_details":{"items":{"properties":{"answer":{"description":"Answer submitted by the user.","type":"string","example":"Good"},"date_time":{"description":"Date and time at which the answer to the poll was submitted.","format":"date-time","type":"string","example":"2022-03-26T05:37:59Z"},"polling_id":{"description":"Unique identifier of the poll.","type":"string","example":"QalIoKWLTJehBJ8e1xRrbQ"},"question":{"description":"Question asked during the poll.","type":"string","example":"How are you?"}},"type":"object"},"type":"array"}},"type":"object"},"type":"array"},"start_time":{"description":"The start time of the meeting.","format":"date-time","type":"string","example":"2022-03-26T05:37:59Z"},"uuid":{"description":"Meeting UUID.","type":"string","example":"Vg8IdgluR5WDeWIkpJlElQ=="}},"type":"object"}}},"description":"**HTTP Status Code:** `200` **OK**<br>\nPolls returned successfully."},"400":{"description":"**Error Code:** `12702`<br>\nCan not access a meeting a year ago."}},"security":[{"OAuth":[]}],"tags":["Meetings"],"description":"[Polls](https://support.zoom.us/hc/en-us/articles/213756303-Polling-for-Meetings) allow the meeting host to survey attendees. List poll results of a meeting.<br><br>\n\n**Scopes**: `meeting:read:admin`, `meeting:read`<br>\n **[Rate Limit Label](https://developers.zoom.us/docs/api/rest/rate-limits/):** `Medium` <br>\n**Prerequisites**:<br>\n* Host user type must be **Pro**.\n* Meeting must be a scheduled meeting. Instant meetings do not have polling features enabled.","operationId":"listPastMeetingPolls","summary":"List past meeting's poll results"}},"/past_meetings/{meetingId}":{"get":{"summary":"Get past meeting details","description":"Get information about a past meeting. \n\n **Scopes:** `meeting:read:admin`, `meeting:read` <br> **[Rate Limit Label](https://developers.zoom.us/docs/api/rest/rate-limits/):** `Light`","operationId":"pastMeetingDetails","tags":["Meetings"],"parameters":[{"description":"The meeting's ID or universally unique ID (UUID). \n* If you provide a meeting ID, the API will return a response for the latest meeting instance. \n* If you provide a meeting UUID that begins with a `/` character or contains the `//` characters, you **must** [double encode](https://marketplace.zoom.us/docs/api-reference/using-zoom-apis/#meeting-id-and-uuid) the meeting UUID before making an API request.","in":"path","name":"meetingId","required":true,"schema":{"oneOf":[{"type":"integer","example":5638296721},{"type":"string","example":"4444AAAiAAAAAiAiAiiAii=="}]}}],"responses":{"200":{"content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"integer","format":"int64","description":"The [meeting ID](https://support.zoom.us/hc/en-us/articles/201362373-What-is-a-Meeting-ID).","example":5638296721},"uuid":{"type":"string","description":"The meeting's UUID. You **must** [double encode](https://marketplace.zoom.us/docs/api-reference/using-zoom-apis/#meeting-id-and-uuid) this value if the meeting UUID begins with a `/` character or contains the `//` character.","example":"4444AAAiAAAAAiAiAiiAii=="},"duration":{"type":"integer","description":"The meeting's duration, in minutes.","example":60},"start_time":{"type":"string","format":"date-time","description":"The meeting's start date and time.","example":"2021-07-13T21:44:51Z"},"end_time":{"type":"string","format":"date-time","description":"The meeting's end date and time.","example":"2021-07-13T23:00:51Z"},"host_id":{"type":"string","description":"The host's ID.","example":"x1yCzABCDEfg23HiJKl4mN"},"dept":{"type":"string","description":"The meeting host's department.","example":"Developers"},"participants_count":{"type":"integer","description":"The number of meeting participants.","example":2},"source":{"type":"string","description":"Whether the meeting was created directly through Zoom or via an API request: \n* If the meeting was created via an OAuth app, this field returns the OAuth app's name. \n* If the meeting was created via JWT or the Zoom Web Portal, this returns the `Zoom` value.","example":"Zoom"},"topic":{"type":"string","description":"The meeting's topic.","example":"My Meeting"},"total_minutes":{"type":"integer","description":"The total number of minutes attended by the meeting's host and participants.","example":55},"type":{"type":"integer","description":"The meeting type: \n* `0` — A prescheduled meeting. \n* `1` — An instant meeting. \n* `2` — A scheduled meeting. \n* `3` — A recurring meeting with no fixed time. \n* `4` — A [personal meeting room](https://support.zoom.us/hc/en-us/articles/201362843). \n* `7` — A [PAC (Personal Audio Conference)](https://support.zoom.us/hc/en-us/articles/205172455-Hosting-a-Personal-Audio-Conference-PAC-meeting) meeting. \n* `8` — A recurring meeting with a fixed time.","enum":[0,1,2,3,4,7,8],"example":1},"user_email":{"type":"string","format":"email","description":"The user's email address.","example":"jchill@example.com"},"user_name":{"type":"string","description":"The user's display name.","example":"Jill Chill"}}}}},"description":"**HTTP Status Code:** `200` <br>\nMeeting information returned."},"400":{"description":"**HTTP Status Code:** `400` <br>\nMeeting not found. \n\n**Error Code:** `1010` \n* User does not exist: {userId} \n* User \"{userId}\" does not exist or does not belong to this account. \n\n**Error Code:** `300` <br>\nCannot access meeting information. \n\n**Error Code:** `200` <br>\nOnly available for paid account: {accountId} \n\n**Error Code:** `12702` <br>\nCan not access a meeting a year ago."},"404":{"description":"**HTTP Status Code:** `404` <br>\nMeeting not found. \n\n**Error Code:** `3001` \n* This meeting is not available or the meeting ID is invalid. \n* The meeting ID is invalid or the meeting has not ended."}},"security":[{"OAuth":[]}]}},"/past_meetings/{meetingId}/participants":{"get":{"parameters":[{"description":"The meeting's ID or universally unique ID (UUID). \n* If you provide a meeting ID, the API will return a response for the latest meeting instance. \n* If you provide a meeting UUID that begins with a `/` character or contains the `//` characters, you **must** [double encode](https://marketplace.zoom.us/docs/api-reference/using-zoom-apis/#meeting-id-and-uuid) the meeting UUID before making an API request.","in":"path","name":"meetingId","required":true,"schema":{"oneOf":[{"type":"integer","example":5638296721},{"type":"string","example":"4444AAAiAAAAAiAiAiiAii=="}]}},{"description":"The number of records returned within a single API call.","in":"query","name":"page_size","schema":{"default":30,"maximum":300,"type":"integer","example":30}},{"description":"Use the next page token to paginate through large result sets. A next page token is returned whenever the set of available results exceeds the current page size. This token's expiration period is 15 minutes.","in":"query","name":"next_page_token","schema":{"type":"string","example":"IAfJX3jsOLW7w3dokmFl84zOa0MAVGyMEB2"}}],"responses":{"200":{"content":{"application/json":{"schema":{"description":"Pagination object.","properties":{"next_page_token":{"description":"The next page token is used to paginate through large result sets. A next page token will be returned whenever the set of available results exceeds the current page size. The expiration period for this token is 15 minutes.","type":"string","example":"Tva2CuIdTgsv8wAnhyAdU3m06Y2HuLQtlh3"},"page_count":{"description":"The number of pages returned for the request made.","type":"integer","example":1},"page_size":{"default":30,"description":"The number of records returned within a single API call.","maximum":300,"type":"integer","example":30},"total_records":{"description":"The number of all records available across pages.","type":"integer","example":1},"participants":{"description":"The Array of meeting participant objects.","items":{"properties":{"id":{"description":"Universal unique identifier of the participant. It is the same as the User ID of the participant if the participant joins the meeting by logging into Zoom. If the participant joins the meeting without logging in, the value of this field will be blank.","type":"string","example":"30R7kT7bTIKSNUFEuH_Qlg"},"name":{"description":"The participant's display name.","type":"string","example":"Jill Chill"},"user_id":{"description":"The participant's ID. This is a unique ID assigned to the participant joining a meeting and is valid for that meeting only.","type":"string","example":"27423744"},"registrant_id":{"description":"The participant's unique registrant ID. This field only returns if you pass the `registrant_id` value for the `include_fields` query parameter. \n\nThis field does not return if the `type` query parameter is the `live` value.","type":"string","example":"_f08HhPJS82MIVLuuFaJPg"},"user_email":{"description":"The email address of the user. If the participant is **not** part of the host's account, this returns an empty string value, with some exceptions. See [Email address display rules](https://marketplace.zoom.us/docs/api-reference/using-zoom-apis#email-address) for details.","type":"string","example":"jchill@example.com"},"join_time":{"description":"The participant's join time.","format":"date-time","type":"string","example":"2022-03-23T06:58:09Z"},"leave_time":{"description":"The participant's leave time.","format":"date-time","type":"string","example":"2022-03-23T07:02:28Z"},"duration":{"description":"The participant's duration.","type":"integer","example":259},"failover":{"description":"Indicates if failover happened during the meeting.","type":"boolean","example":"false"},"status":{"description":"The participant's status. \n* `in_meeting` — In a meeting. \n* `in_waiting_room` — In a waiting room.","enum":["in_meeting","in_waiting_room"],"type":"string","example":"in_meeting"}},"type":"object"},"type":"array"}},"type":"object"}}},"description":"**HTTP Status Code:** `200`<br>\nMeeting participants' report returned."},"400":{"description":"**HTTP Status Code:** `400`<br>\n**Error Code:** `1010`<br>\nUser {userId} not exist or not belong to this account.<br><br>\n**Error Code:** `300`<br>\nCannot access meeting information.<br><br>\n**Error Code:** `200`<br>\nOnly available for paid account: {accountId}\n\n**Error Code:** `12702` <br>\nCan not access a meeting a year ago."},"404":{"description":"**HTTP Status Code:** `404`<br>\nMeeting not found<br>\n**Error Code:** `1001`<br>\nUser {userId} not exist or not belong to this account.<br>\nUser not exist: {userId}<br><br>\n**Error Code:** `3001`<br>\nThis meeting is not available or ID is not valid.<br>\nMeeting ID is invalid or not end."}},"security":[{"OAuth":[]}],"tags":["Meetings"],"description":"Retrieve information on participants from a past meeting. Note the API doesn't return results if there's only one participant in a meeting.<br><br>\n**Scopes:** `meeting:read:admin` `meeting:read`\n\n **[Rate Limit Label](https://developers.zoom.us/docs/api/rest/rate-limits/):** `Medium`\n**Prerequisites:**<br>\n* Paid account on a Pro or higher plan.\n\n<br> <br>  **Note**: [Double encode](https://marketplace.zoom.us/docs/api-reference/using-zoom-apis/#meeting-id-and-uuid) your UUID when using this API if the UUID begins with a '/'or contains '//' in it.\n","operationId":"pastMeetingParticipants","summary":"Get past meeting participants"}},"/live_meetings/{meetingId}/events":{"patch":{"parameters":[{"description":"The live meeting's ID.","in":"path","name":"meetingId","required":true,"schema":{"type":"string","example":"93398114182"}}],"responses":{"202":{"description":"**HTTP Status:** `202` **Accepted**\nRequest processed successfully."},"400":{"description":"**HTTP Status:** `400` **Bad Request** <br><br>\n**Error Code:** `300`<br>\n* Meeting ID does not exist.<br>\n* Invalid meeting id.<br>\n* Meeting does not exist.<br>\n* No permission.<br>\n* This API is not available for this account, please contact Zoom support. \n\n**Error Code:** `3309`<br>\nNot enough cloud storage available. Either purchase additional storage or delete cloud recordings to free up storage.\n"},"404":{"description":"**HTTP Status Code:** `404`<br>\n**Error Code:** `3001` <br> Meeting {meetingId} is not found or has expired."},"429":{"description":"**HTTP Status Code:** `429` <br>\n* You have exceeded the rate limit \"{0}\" of requests for this meeting. You can resume these API requests after 5 seconds.<br>\n* You have exceeded the rate limit \"{0}\" of requests for this meeting and this phone number. You may resume these requests after 5 seconds.\n"}},"tags":["Meetings"],"description":"Control [in-meeting](https://support.zoom.us/hc/en-us/articles/360021921032-In-Meeting-Controls) features. In-meeting controls include starting and stopping a recording, pausing and resuming a recording, and inviting participants. \n\n**Note:** This API's recording control only works for cloud recordings. It does **not** work for local recordings. \n\n**Scopes:** `meeting:write`, `meeting:write:admin`, `meeting:master` \n\n**Prerequisites:**\n* The meeting **must** be a live meeting **except** inviting participants to the meeting through [call out (phone)/(room system)]. \n* Recording control: [Cloud recording](https://support.zoom.us/hc/en-us/articles/360060231472-Enabling-cloud-recording) must be enabled on the account. \n* The user calling this API must be the host or an alternative meeting host.\n\n **[Rate Limit Label](https://developers.zoom.us/docs/api/rest/rate-limits/):** `Medium`","operationId":"inMeetingControl","requestBody":{"content":{"application/json":{"schema":{"properties":{"method":{"description":"The in-meeting method to control: \n* `recording.start` — Start the recording. \n* `recording.stop` — Stop the recording. \n* `recording.pause` — Pause the recording. \n* `recording.resume` — Resume a paused recording. \n* `participant.invite` — Invite a participant to the meeting. \n* `participant.invite.callout` — Invite a participant to the meeting through [call out (phone)](https://support.zoom.us/hc/en-us/articles/4404535651085-Inviting-others-by-phone-call-out). \n* `participant.invite.room_system_callout` — Invite a participant to the meeting through [call out (room system)].","type":"string","example":"recording.start"},"params":{"description":"The in-meeting parameters.","properties":{"contacts":{"description":"The user's email address or the user ID, up to a maximum of 10 contacts. The account must be a part of the meeting host's account.","items":{"properties":{"email":{"description":"The user's email address. Use this value if you do not have the user's ID. \n\nIf you pass the `id` value, the API ignores this query parameter.","type":"string","example":"jchill@example.com"},"id":{"description":"The user's ID.","type":"string","example":"30R7kT7bTIKSNUFEuH_Qlg"}},"type":"object"},"maximum":10,"type":"array"},"invitee_name":{"type":"string","description":"The user's name to display in the meeting. Use this field if you pass the `participant.invite.callout` value for the `method` field.","example":"Jill Chill"},"phone_number":{"type":"string","description":"The user's phone number. Use this field if you pass the `participant.invite.callout` value for the `method` field.","example":"5550100"},"invite_options":{"type":"object","description":"Information about the `participant.invite.callout` settings.","properties":{"require_greeting":{"type":"boolean","default":true,"description":"Whether to require a greeting before being connected. Use this field if you pass the `participant.invite.callout` value for the `method` field.","example":true},"require_pressing_one":{"type":"boolean","default":true,"description":"Whether to require pressing 1 before being connected. Use this field if you pass the `participant.invite.callout` value for the `method` field.","example":true}}},"call_type":{"type":"string","description":"The type of call out. Use a value of `h323` or `sip`. Use this field if you pass the `participant.invite.room_system_callout` value for the `method` field.","example":"h323"},"device_ip":{"type":"string","description":"The user's device IP address or URI. Use this field if you pass the `participant.invite.room_system_callout` value for the `method` field.","example":"10.100.111.237"},"h323_headers":{"type":"object","description":"Enable customers to leverage services that require customization of the FROM header to identify the caller. Use this field if you pass the `participant.invite.room_system_callout` value for the `method` field and the `h323` value for the `call_type` field.","properties":{"from_display_name":{"type":"string","description":"Custom name that will be used within the h323 Header.","example":"display name","maxLength":64},"to_display_name":{"type":"string","description":"Custom remote name that will be used within the meeting.","example":"display name","maxLength":64}}},"sip_headers":{"type":"object","description":"Enable customers to leverage services that require customization of the FROM header to identify the caller. Use this field if you pass the `participant.invite.room_system_callout` value for the `method` field and the `sip` value for the `call_type` field.","properties":{"from_display_name":{"type":"string","description":"Custom name that will be used within the SIP Header.","example":"display name","maxLength":64},"to_display_name":{"type":"string","description":"Custom remote name that will be used within the meeting.","example":"display name","maxLength":64},"from_uri":{"type":"string","description":"Custom URI that will be used within the SIP Header. The URI must start with 'sip:' or 'sips:' as a valid URI based on parameters defined by the platform.","example":"sip:username@domain.company.org","maxLength":256},"additional_headers":{"description":"Ability to add 1 to 10 custom headers, each of which has a maximum length of 256 bytes to comply with SIP standards.  Custom headers would leverage header names starting with 'X-' per SIP guidelines.","items":{"properties":{"key":{"description":"Additional custom SIP header's key.","type":"string","example":"X-Header1","maxLength":32},"value":{"description":"Additional custom SIP header's value.","type":"string","example":"X-body1","maxLength":256}},"type":"object"},"type":"array","maximum":10}}}},"type":"object"}},"type":"object"}}}},"summary":"Use in-meeting controls"}},"/live_meetings/{meetingId}/chat/messages/{messageId}":{"delete":{"summary":"Delete a live meeting message","description":"Deletes a message in a live meeting based on ID. \n\n**Scopes:** `meeting:write` `meeting:write:admin` <br> **[Rate Limit Label](https://developers.zoom.us/docs/api/rest/rate-limits/):** `Medium`\n\n**Prerequisites:** \n* Have Zoom enable the DLP for in-meeting chat feature to use this API.","operationId":"deleteMeetingChatMessageById","tags":["Meetings"],"parameters":[{"in":"path","name":"meetingId","required":true,"description":"The meeting's ID. \n\n When storing this value in your database, you must store it as a long format integer and **not** an integer. Meeting IDs can exceed 10 digits.","schema":{"format":"int64","type":"integer","example":85746065}},{"description":"The live meeting chat message's unique identifier (UUID), in base64-encoded format.","in":"path","name":"messageId","required":true,"schema":{"type":"string","example":"MS17MDQ5NjE4QjYtRjk4Ny00REEwLUFBQUItMTg3QTY0RjU2MzhFfQ=="}}],"responses":{"204":{"description":"**HTTP Status Code:** `204` <br>\nMeeting chat message deleted."},"400":{"description":"**HTTP Status Code:** `200` <br>\nBad Request \n\n**Error Code:** `200` \n* Only available for Paid accounts. \n* DLP is not enabled."},"404":{"description":"**HTTP Status Code:** `404` <br>\nNot Found \n\n**Error Code:** `3001` <br>\nMeeting does not exist: {meetingId}"}},"security":[{"OAuth":[]}]}},"/meetings/{meetingId}/token":{"get":{"summary":"Get meeting's token","description":"Get a meeting's [closed caption token (caption URL)](https://support.zoom.us/hc/en-us/articles/115002212983-Using-a-third-party-closed-captioning-service). This token lets you use a third-party service to stream text to their closed captioning software to the Zoom meeting. \n\n**Scopes:** `meeting:read`, `meeting:read:admin` <br> **[Rate Limit Label](https://developers.zoom.us/docs/api/rest/rate-limits/):** `Light` \n\n**Prerequisites:** \n* The **Closed captioning** setting enabled in the Zoom web portal. \n* The **Allow use of caption API Token to integrate with 3rd-party Closed Captioning services** setting enabled.","tags":["Meetings"],"operationId":"meetingToken","parameters":[{"in":"path","name":"meetingId","required":true,"description":"The meeting's ID. \n\n When storing this value in your database, you must store it as a long format integer and **not** an integer. Meeting IDs can exceed 10 digits.","schema":{"format":"int64","type":"integer","example":85746065}},{"in":"query","name":"type","description":"The meeting token type: \n* `closed_caption_token` — The third-party closed caption API token. \n\nThis defaults to `closed_caption_token`.","schema":{"type":"string","default":"closed_caption_token","enum":["closed_caption_token"],"example":"closed_caption_token"}}],"responses":{"200":{"description":"**HTTP Status Code:** `200` <br>\nMeeting token returned.","content":{"application/json":{"schema":{"type":"object","description":"Information about the meeting token.","properties":{"token":{"type":"string","description":"The generated meeting token.","example":"https://example.com/closedcaption?id=200610693&ns=GZHkEA==&expire=86400&spparams=id%2Cns%2Cexpire&signature=nYtXJqRKCW"}}}}}},"400":{"description":"**HTTP Status Code:** `400` <br>\nBad Request \n\n**Error Code:** `300` <br>\nInvalid meeting ID. \n\n**Error Code:** `3000` <br>\n* Cannot access Webinar information. <br>\n* Meeting survey disabled. To enable this feature, enable the \"Meeting Survey\" setting in the Zoom web portal's \"Settings\" interface. \n\n**Error Code:** `3161` <br>\nMeeting hosting and scheduling capabilities are not allowed for your user account."},"404":{"description":"**HTTP Status Code:** `404` <br>\nNot Found \n\n**Error Code:** `300` <br>\nMeeting ID does not exist. \n\n**Error Code:** `3001` <br>\nMeeting does not exist: {meetingId}"}},"security":[{"OAuth":[]}]}},"/meetings/{meetingId}/recordings/analytics_summary":{"get":{"summary":"Get Meeting Recording's Analytics Summary","description":"Use this API to return a meeting recording's [analytics summary](https://support.zoom.us/hc/en-us/articles/205347605-Managing-cloud-recordings#h_0b665029-ce74-4849-9794-d1aa0320d163). **Maximum duration: 1 Month**. To access a password-protected cloud recording, send the user's [OAuth access token](https://developers.zoom.us/docs/integrations/oauth/) as a Bearer token in the Authorization header. For example, \n\n `curl -H \"Authorization: Bearer <ACCESS_TOKEN>\" https://{{base-domain}}/rec/archive/download/xyz` \n\n **Scopes:** `recording:read:admin`, `recording:read` <br> **[Rate Limit Label](https://developers.zoom.us/docs/api/rest/rate-limits/):** `Medium`","operationId":"analytics_summary","tags":["Cloud Recording"],"parameters":[{"description":"To get Cloud Recordings of a meeting, provide the meeting ID or meeting UUID. If the meeting ID is provided instead of UUID,the response will be for the latest meeting instance. \n\nTo get Cloud Recordings of a webinar, provide the webinar ID or the webinar UUID. If the webinar ID is provided instead of UUID,the response will be for the latest webinar instance. \n\nIf a UUID starts with \"/\" or contains \"//\" (example: \"/ajXp112QmuoKj4854875==\"), you must **[double encode](https://marketplace.zoom.us/docs/api-reference/using-zoom-apis/#meeting-id-and-uuid)** the UUID before making an API request. ","in":"path","name":"meetingId","required":true,"schema":{"type":"string","example":"atsXxhSEQWit9t+U02HXNQ=="}},{"name":"from","in":"query","description":"The start date for the monthly range to query. The maximum range can be a month. If you do not provide this value, this defaults to the current date.","schema":{"type":"string","format":"date","example":"2020-06-30"}},{"name":"to","in":"query","description":"The end date for the monthly range to query. The maximum range can be a month.","schema":{"type":"string","format":"date","example":"2020-07-30"}}],"responses":{"200":{"description":"**HTTP Status Code:** `200` <br>\nAnalytics Summary listed successfully.","content":{"application/json":{"schema":{"type":"object","properties":{"from":{"type":"string","format":"date","description":"The queried start date","example":"2020-07-30"},"to":{"type":"string","format":"date","description":"The queried end date.","example":"2020-07-30"},"analytics_summary":{"type":"array","description":"Analytics Summary.","items":{"properties":{"date":{"type":"string","description":"Date of viewing or downloading the recording.","example":"2022-07-06"},"views_total_count":{"type":"integer","description":"The number of people who have watched this Meeting Recording.","example":2},"downloads_total_count":{"type":"integer","description":"The number of people who downloaded this Meeting Recording.","example":2}}}}}}}}},"400":{"description":"**HTTP Status Code:** `400` <br>\nBad Request \n\n**Error Code:** `1010` <br>\nUser not found on this account: {accountId}"},"404":{"description":"**HTTP Status Code:** `404` <br>\nMeeting recording not found. \n\n**Error Code:** `1001` <br>\nUser \"{userId}\" does not exist or does not belong to this account. \n\n**Error Code:** `3301` <br>\nThere is no recording for this meeting."}}}},"/meetings/{meetingId}/recordings/analytics_details":{"get":{"summary":"Get Meeting Recording's Analytics Details","description":"Use this API to return a meeting recording's [analytics details](https://support.zoom.us/hc/en-us/articles/205347605-Managing-cloud-recordings#h_0b665029-ce74-4849-9794-d1aa0320d163). **Maximum duration: 1 Month**. To access a password-protected cloud recording, send the user's [OAuth access token](https://developers.zoom.us/docs/integrations/oauth/) as a Bearer token in the Authorization header. For example, \n\n `curl -H \"Authorization: Bearer <ACCESS_TOKEN>\" https://{{base-domain}}/rec/archive/download/xyz` \n\n **Scopes:** `recording:read:admin`, `recording:read` <br> **[Rate Limit Label](https://developers.zoom.us/docs/api/rest/rate-limits/):** `Medium`","operationId":"analytics_details","tags":["Cloud Recording"],"parameters":[{"description":"To get Cloud Recordings of a meeting, provide the meeting ID or meeting UUID. If the meeting ID is provided instead of UUID,the response will be for the latest meeting instance. \n\nTo get Cloud Recordings of a webinar, provide the webinar ID or the webinar UUID. If the webinar ID is provided instead of UUID,the response will be for the latest webinar instance. \n\nIf a UUID starts with \"/\" or contains \"//\" (example: \"/ajXp112QmuoKj4854875==\"), you must **[double encode](https://marketplace.zoom.us/docs/api-reference/using-zoom-apis/#meeting-id-and-uuid)** the UUID before making an API request. ","in":"path","name":"meetingId","required":true,"schema":{"type":"string","example":"atsXxhSEQWit9t+U02HXNQ=="}},{"description":"The number of records returned within a single API call.","in":"query","name":"page_size","schema":{"default":30,"maximum":300,"type":"integer","example":30}},{"description":"Use the next page token to paginate through large result sets. A next page token is returned whenever the set of available results exceeds the current page size. This token's expiration period is 15 minutes.","in":"query","name":"next_page_token","schema":{"type":"string","example":"IAfJX3jsOLW7w3dokmFl84zOa0MAVGyMEB2"}},{"name":"from","in":"query","description":"The start date for the monthly range to query. The maximum range can be a month. If you do not provide this value, this defaults to the current date.","schema":{"type":"string","format":"date","example":"2020-06-30"}},{"name":"to","in":"query","description":"The end date for the monthly range to query. The maximum range can be a month.","schema":{"type":"string","format":"date","example":"2020-07-30"}},{"name":"type","in":"query","description":"The type of analytics details: \n* `by_view` — by_view. \n* `by_download` — by_download.","schema":{"type":"string","enum":["by_view","by_download"],"example":"by_view"}}],"responses":{"200":{"description":"**HTTP Status Code:** `200` <br>\nAnalytics Detail listed successfully.","content":{"application/json":{"schema":{"type":"object","properties":{"from":{"type":"string","format":"date","description":"The queried start date","example":"2020-07-30"},"to":{"type":"string","format":"date","description":"The queried end date.","example":"2020-07-30"},"next_page_token":{"type":"string","description":"The next page token is used to paginate through large result sets. A next page token will be returned whenever the set of available results exceeds the current page size. The expiration period for this token is 15 minutes.","example":"R4aF9Oj0fVM2hhezJTEmSKaBSkfesDwGy42"},"page_size":{"type":"integer","maximum":300,"description":"The number of records returned within a single API call.","example":30},"total_records":{"type":"integer","description":"The total number of all the records available across pages.","example":5},"analytics_details":{"type":"array","description":"Analytics Detail.","items":{"properties":{"date_time":{"type":"string","format":"date-time","description":"Explicit time to watch or download the recording.","example":"2021-07-04T22:14:57Z"},"name":{"type":"string","description":"The user's name who watched or downloaded.","example":2},"email":{"type":"string","description":"The user's email who downloaded this Meeting Recording.","example":2},"duration":{"type":"integer","description":"When the query type is `by_view`, this field indicates the viewing time, unit: seconds","example":60}}}}}}}}},"400":{"description":"**HTTP Status Code:** `400` <br>\nBad Request \n\n**Error Code:** `1010` <br>\nUser not found on this account: {accountId}"},"404":{"description":"**HTTP Status Code:** `404` <br>\nMeeting recording not found. \n\n**Error Code:** `1001` <br>\nUser \"{userId}\" does not exist or does not belong to this account. \n\n**Error Code:** `3301` <br>\nThere is no recording for this meeting."}}}},"/meetings/{meetingId}/recordings":{"delete":{"parameters":[{"description":"To get Cloud Recordings of a meeting, provide the meeting ID or meeting UUID. If the meeting ID is provided instead of UUID,the response will be for the latest meeting instance. \n\nTo get Cloud Recordings of a webinar, provide the webinar ID or the webinar UUID. If the webinar ID is provided instead of UUID,the response will be for the latest webinar instance. \n\nIf a UUID starts with \"/\" or contains \"//\" (example: \"/ajXp112QmuoKj4854875==\"), you must **[double encode](https://marketplace.zoom.us/docs/api-reference/using-zoom-apis/#meeting-id-and-uuid)** the UUID before making an API request. ","in":"path","name":"meetingId","required":true,"schema":{"type":"string","example":"atsXxhSEQWit9t+U02HXNQ=="}},{"description":"The recording delete actions:<br>`trash` - Move recording to trash.<br>`delete` - Delete recording permanently.","in":"query","name":"action","schema":{"default":"trash","enum":["trash","delete"],"type":"string","example":"trash"},"x-enum-descriptions":["move recording to trash","delete recording permanently"]}],"responses":{"200":{"description":"**HTTP Status Code:** `200` <br>\nRecordings deleted. \n\n**Error Code:** `200` <br>\nYou do not have the right permission."},"204":{"description":"**HTTP Status Code:** `204` <br>\nMeeting recording deleted."},"400":{"description":"**HTTP Status Code:** `400`<br>\n**Error Code:** `1010`<br>\nUser does not belong to this account: {accountId}. <br/>\n**Error Code:** `3332` <br>\nThis recording was selected for a simulive webinar. You cannot delete or trash it."},"404":{"description":"**HTTP Status Code:** `404` <br>\nMeeting recording not found\n**Error Code:** `1001` <br> User {userId} does not exist or does not belong to this account.<br>\n**Error Code:** `3301`<br>There is no recording for this meeting.\n"}},"security":[{"OAuth":[]}],"tags":["Cloud Recording"],"description":"Delete all recording files of a meeting.<br><br>\n\n**Scopes:** `recording:write:admin` `recording:write`<br> \n **[Rate Limit Label](https://developers.zoom.us/docs/api/rest/rate-limits/):** `Light`<br>\n**Prerequisites**:\n* Cloud Recording should be enabled on the user's account.<br>\n","operationId":"recordingDelete","summary":"Delete meeting recordings"},"get":{"summary":"Get meeting recordings","description":"Use this API to return all of a meeting's [recordings](https://support.zoom.us/hc/en-us/articles/203741855-Cloud-Recording#h_7420acb5-1897-4061-87b4-5b76e99c03b4). Use the `download_url` property listed in the response to download the recording files. \n\n To access a password-protected cloud recording, send the user's [OAuth access token](https://developers.zoom.us/docs/integrations/oauth/) as a Bearer token in the Authorization header. For example, \n\n `curl -H \"Authorization: Bearer <ACCESS_TOKEN>\" https://{{base-domain}}/rec/archive/download/xyz` \n\n **Scopes:** `recording:read:admin`, `recording:read` <br> **[Rate Limit Label](https://developers.zoom.us/docs/api/rest/rate-limits/):** `Light`","operationId":"recordingGet","tags":["Cloud Recording"],"parameters":[{"description":"To get Cloud Recordings of a meeting, provide the meeting ID or meeting UUID. If the meeting ID is provided instead of UUID,the response will be for the latest meeting instance. \n\nTo get Cloud Recordings of a webinar, provide the webinar ID or the webinar UUID. If the webinar ID is provided instead of UUID,the response will be for the latest webinar instance. \n\nIf a UUID starts with \"/\" or contains \"//\" (example: \"/ajXp112QmuoKj4854875==\"), you must **[double encode](https://marketplace.zoom.us/docs/api-reference/using-zoom-apis/#meeting-id-and-uuid)** the UUID before making an API request. ","in":"path","name":"meetingId","required":true,"schema":{"type":"string","example":"atsXxhSEQWit9t+U02HXNQ=="}},{"name":"include_fields","in":"query","description":"The `download_access_token` value for downloading the meeting's recordings.","schema":{"type":"string","example":"a2f19f96-9294-4f51-8134-6f0eea108eb2"}},{"name":"ttl","in":"query","description":"The `download_access_token` Time to Live (TTL) value. This parameter is only valid if the `include_fields` query parameter contains the `download_access_token` value.","schema":{"type":"integer","minimum":0,"maximum":604800,"example":1}}],"responses":{"200":{"description":"**HTTP Status Code:** `200` <br>\nRecording object returned. \n\n**Error Code:** `200` <br>\nYou do not have the right permissions.","content":{"application/json":{"schema":{"properties":{"account_id":{"description":"Unique Identifier of the user account.","type":"string","example":"Cx3wERazSgup7ZWRHQM8-w"},"duration":{"description":"Meeting duration.","type":"integer","example":20},"host_id":{"description":"ID of the user set as host of meeting.","type":"string","example":"_0ctZtY0REqWalTmwvrdIw"},"id":{"description":"Meeting ID - also known as the meeting number.","type":"integer","example":6840331990},"recording_count":{"description":"Number of recording files returned in the response of this API call. This includes the `recording_files` and  `participant_audio_files` files.","type":"integer","example":22},"start_time":{"description":"The time at which the meeting started.","format":"date-time","type":"string","example":"2021-03-18T05:41:36Z"},"topic":{"description":"Meeting topic.","type":"string","example":"My Personal Meeting"},"total_size":{"description":"The total file size of the recording. This includes the `recording_files` and `participant_audio_files` files.","format":"int64","type":"integer","example":22},"type":{"description":"The recording's associated type of meeting or webinar: \n\nIf the recording is of a meeting: \n* `1` — Instant meeting. \n* `2` — Scheduled meeting. \n* `3` — A recurring meeting with no fixed time. \n* `4` — A meeting created via PMI (Personal Meeting ID). \n* `7` — A [Personal Audio Conference](https://support.zoom.us/hc/en-us/articles/204517069-Getting-Started-with-Personal-Audio-Conference) (PAC). \n* `8` - Recurring meeting with a fixed time. \n\nIf the recording is of a webinar: \n* `5` — A webinar. \n* `6` — A recurring webinar without a fixed time \n* `9` — A recurring webinar with a fixed time.\n\nIf the recording is **not** from a meeting or webinar: \n\n* `99` — A recording uploaded via the [**Recordings**](https://zoom.us/recording) interface on the Zoom Web Portal.","enum":[1,2,3,4,5,6,7,8,9,99],"type":"string","x-enum-descriptions":["Instant Meeting","Scheduled Meeting","Recurring Meeting with no fixed time","Meeting created using a Personal Meeting ID","A webinar","Recurring webinar without a fixed time","Personal Audio Conference","Recurring meeting with a fixed time","Recurring webinar with a fixed time","A recording uploaded"],"example":"1"},"uuid":{"description":"Unique Meeting Identifier. Each instance of the meeting will have its own UUID.","type":"string","example":"BOKXuumlTAGXuqwr3bLyuQ=="},"recording_play_passcode":{"type":"string","description":"The cloud recording's password to be used in the URL. This recording's password can be directly spliced in `play_url` or `share_url` with `?pwd=` to access and play. For example, 'https://zoom.us/rec/share/**************?pwd=yNYIS408EJygs7rE5vVsJwXIz4-VW7MH'. If you want to use this field, please contact Zoom support.","example":"yNYIS408EJygs7rE5vVsJwXIz4-VW7MH"},"recording_files":{"description":"List of recording file.","items":{"description":"Recording file object.","properties":{"deleted_time":{"description":"The time at which recording was deleted. Returned in the response only for trash query.","type":"string","example":"2021-03-18T05:41:36Z"},"download_url":{"description":"The URL at which to download the the recording. \n\n**JWT apps** \n\nTo access a private or password-protected cloud recording of a user in your account, use a [Zoom JWT app](https://marketplace.zoom.us/docs/guides/getting-started/app-types/create-jwt-app). Use the generated JWT token as the value of the `access_token` query parameter and include this query parameter at the end of the URL. For example: \n\n`https://{{base-domain}}/rec/download/{{path-to-file-download}}?access_token={{JWT-token}}` \n\n**OAuth apps** \n\nIf a user has authorized and installed your OAuth app that contains recording scopes, use the user's [OAuth access token](https://developers.zoom.us/docs/integrations/oauth/) to download the file. For example: \n\n`https://{{base-domain}}/rec/archive/download/xxx?access_token={{OAuth-access-token}}` \n\n**Note:** This field does **not** return for [Zoom On-Premise accounts](https://support.zoom.us/hc/en-us/articles/360034064852-Zoom-On-Premise-Deployment). Instead, this API will return the `file_path` field. \n\n**Note:** We recommend that you send the access_token as a Bearer token in the Authorization header, for example: \"Authorization\": \"Bearer <ACCESS_TOKEN>”.","type":"string","example":"https://example.com/rec/download/Qg75t7xZBtEbAkjdlgbfdngBBBB"},"file_path":{"description":"The file path to the On-Premise account recording. \n\n**Note:** This API only returns this field for [Zoom On-Premise accounts](https://support.zoom.us/hc/en-us/articles/360034064852-Zoom-On-Premise-Deployment). It does **not** return the `download_url` field.","type":"string","example":"/9090876528/path01/demo.mp4"},"file_size":{"description":"The recording file size.","type":"number","example":"7220"},"file_type":{"description":"The recording file type. The value of this field could be one of the following:<br>\n`MP4`: Video file of the recording.<br>`M4A` Audio-only file of the recording.<br>`TIMELINE`: Timestamp file of the recording in JSON file format. To get a timeline file, the \"Add a timestamp to the recording\" setting must be enabled in the [recording settings](https://support.zoom.us/hc/en-us/articles/203741855-Cloud-recording#h_3f14c3a4-d16b-4a3c-bbe5-ef7d24500048). The time will display in the host's timezone, set on their Zoom profile.\n<br> `TRANSCRIPT`: Transcription file of the recording in VTT format.<br> `CHAT`: A TXT file containing in-meeting chat messages that were sent during the meeting.<br>`CC`: File containing closed captions of the recording in VTT file format.<br>`CSV`: File containing polling data in csv format.\n\n<br>\n\nA recording file object with file type of either `CC` or `TIMELINE` **does not have** the following properties:<br>\n\t`id`, `status`, `file_size`, `recording_type`, and `play_url`.<br>`SUMMARY`: Summary file of the recording in JSON file format.","type":"string","example":"MP4","enum":["MP4","M4A","CHAT","TRANSCRIPT","CSV","TB","CC","CHAT_MESSAGE","SUMMARY"]},"file_extension":{"type":"string","description":"The file extension type of the recording file.","enum":["MP4","M4A","TXT","VTT","CSV","JSON","JPG"],"example":"M4A"},"id":{"description":"The recording file ID. Included in the response of general query.","type":"string","example":"72576a1f-4e66-4a77-87c4-f13f9808bd76"},"meeting_id":{"description":"The meeting ID. ","type":"string","example":"L0AGOEPVR9m5WSOOs/d+FQ=="},"play_url":{"description":"The URL using which a recording file can be played.","type":"string","example":"https://example.com/rec/play/Qg75t7xZBtEbAkjdlgbfdngBBBB"},"recording_end":{"description":"The recording end time. Response in general query.","type":"string","example":"2021-03-18T05:41:36Z"},"recording_start":{"description":"The recording start time.","type":"string","example":"2021-03-18T05:41:36Z"},"recording_type":{"description":"The recording type.<br>`shared_screen_with_speaker_view(CC)`<br>`shared_screen_with_speaker_view`<br>`shared_screen_with_gallery_view`<br>`speaker_view`<br>`gallery_view`<br>`shared_screen`<br>`audio_only`<br>`audio_transcript`<br>`chat_file`<br>`active_speaker`<br>`poll`<br>`timeline`<br>`closed_caption`<br>`audio_interpretation`<br>`summary`<br>`summary_next_steps`<br>`summary_smart_chapters`<br>`sign_interpretation`","type":"string","enum":["shared_screen_with_speaker_view(CC)","shared_screen_with_speaker_view","shared_screen_with_gallery_view","active_speaker","gallery_view","shared_screen","audio_only","audio_transcript","chat_file","poll","host_video","closed_caption","timeline","thumbnail","audio_interpretation","summary","summary_next_steps","summary_smart_chapters","sign_interpretation"],"example":"shared_screen_with_speaker_view"},"status":{"description":"The recording status.","enum":["completed"],"type":"string","example":"completed"}},"type":"object"},"title":"Recording file List","type":"array"},"download_access_token":{"type":"string","description":"The JWT token to download the meeting's recording. This response only returns if the `download_access_token` is included in the `include_fields` query parameter.","example":"abJhbGciOiJIUzUxMiJ9.eyJpc3MiOiJodHRwczovL2V2ZW50Lnpvb20udXMiLCJhY2NvdW50SWQiOiJNdDZzdjR1MFRBeVBrd2dzTDJseGlBIiwiYXVkIjoiaHR0cHM6Ly9vYXV0aC56b29tLnVzIiwibWlkIjoieFp3SEc0c3BRU2VuekdZWG16dnpiUT09IiwiZXhwIjoxNjI2MTM5NTA3LCJ1c2VySWQiOiJEWUhyZHBqclMzdWFPZjdkUGtrZzh3In0.a6KetiC6BlkDhf1dP4KBGUE1bb2brMeraoD45yhFx0eSSSTFdkHQnsKmlJQ-hdo9Zy-4vQw3rOxlyoHv583JyZ"},"password":{"type":"string","description":"The cloud recording's password.","example":"981651"},"participant_audio_files":{"description":"A list of recording files. The API only returns this response when the **Record a separate audio file of each participant** setting is enabled.","items":{"description":"The recording file object.","properties":{"download_url":{"description":"The URL at which to download the the recording. If a user has authorized and installed your OAuth app that contains recording scopes, use the user's [OAuth access token](https://developers.zoom.us/docs/integrations/oauth/) to download the file. Send the `access_token` as a Bearer token in the Authorization header. For example: \n\n`curl -H \"Authorization: Bearer <ACCESS_TOKEN>\" https://{{base-domain}}/rec/archive/download/xyz` \n\n**Note:** This field does **not** return for [Zoom On-Premise accounts](https://support.zoom.us/hc/en-us/articles/360034064852-Zoom-On-Premise-Deployment). Instead, this API will return the `file_path` field.","type":"string","example":"https://example.com/rec/download/Qg75t7xZBtEbAkjdlgbfdngBBBB"},"file_name":{"description":"The recording file's name.","type":"string","example":"test.json"},"file_path":{"description":"The file path to the On-Premise account recording. \n\n**Note:** This API only returns this field for [Zoom On-Premise accounts](https://support.zoom.us/hc/en-us/articles/360034064852-Zoom-On-Premise-Deployment). It does **not** return the `download_url` field.","type":"string","example":"/9090876528/path01/demo.mp4"},"file_size":{"description":"The recording file's size, in bytes.","type":"number","example":65536},"file_type":{"description":"The recording file's format. One of:\n\n* `MP4` — Video file.\n* `M4A` — Audio-only file.\n* `TIMELINE` — Timestamp file of the recording, in JSON file format. To get a timeline file, the **Add a timestamp to the recording** setting **must** be enabled in the [recording settings](https://support.zoom.us/hc/en-us/articles/203741855-Cloud-recording#h_3f14c3a4-d16b-4a3c-bbe5-ef7d24500048). The time will display in the host's timezone.\n* `TRANSCRIPT` — A transcript of the recording, in VTT format.\n* `CHAT` — A text file containing chat messages sent during the meeting.\n* `CC` — A file containing the closed captions of the recording, in VTT file format.\n* `CSV` — A file containing polling data, in CSV format.\n\nA recording file object with file the `CC` or `TIMELINE` value **does not** have the `id`, `status`, `file_size`, `recording_type`, and `play_url` properties.","type":"string","example":"M4A"},"id":{"description":"The recording file's unique ID. This is included in the general query response.","type":"string","example":"a2f19f96-9294-4f51-8134-6f0eea108eb2"},"play_url":{"description":"The URL at which the recording file can be opened and played.","type":"string","example":"https://example.com/rec/play/Qg75t7xZBtEbAkjdlgbfdngBBBB"},"recording_end":{"description":"The recording file's end time. This is included in the general query response.","format":"date-time","type":"string","example":"2021-06-30T22:14:57Z"},"recording_start":{"description":"The recording file's start time.","format":"date-time","type":"string","example":"2021-06-30T22:14:57Z"},"status":{"description":"The recording file's status.","enum":["completed"],"type":"string","example":"completed"}},"type":"object"},"title":"The list of recording files for each participant.","type":"array"}},"type":"object","description":"Return a list of recording files for each participant. The API only returns this response when the **Record a separate audio file of each participant** setting is enabled.","title":"List recording files for each participant."}}}},"400":{"description":"**HTTP Status Code:** `400` <br>\nBad Request \n\n**Error Code:** `1010` <br>\nUser not found on this account: {accountId}"},"404":{"description":"**HTTP Status Code:** `404` <br>\nMeeting recording not found. \n\n**Error Code:** `1001` <br>\nUser \"{userId}\" does not exist or does not belong to this account. \n\n**Error Code:** `3301` <br>\nThere is no recording for this meeting."}},"security":[{"OAuth":[]}]}},"/meetings/{meetingId}/recordings/registrants":{"get":{"parameters":[{"in":"path","name":"meetingId","required":true,"description":"The meeting's ID. \n\n When storing this value in your database, you must store it as a long format integer and **not** an integer. Meeting IDs can exceed 10 digits.","schema":{"format":"int64","type":"integer","example":85746065}},{"description":"Query by the registrant's status: \n* `pending` — The registration is pending. \n* `approved` — The registrant is approved. \n* `denied` — The registration is denied.","in":"query","name":"status","schema":{"default":"approved","enum":["pending","approved","denied"],"type":"string","example":"pending"},"x-enum-descriptions":["Registration pending.","Registration approved.","Registration denied."]},{"description":"The number of records returned within a single API call.","in":"query","name":"page_size","schema":{"default":30,"maximum":300,"type":"integer","example":30}},{"deprecated":true,"description":"**Deprecated.** We will no longer support this field in a future release. Instead, use the `next_page_token` for pagination.","in":"query","name":"page_number","schema":{"default":1,"type":"integer","example":1}},{"description":"Use the next page token to paginate through large result sets. A next page token is returned whenever the set of available results exceeds the current page size. This token's expiration period is 15 minutes.","in":"query","name":"next_page_token","schema":{"type":"string","example":"IAfJX3jsOLW7w3dokmFl84zOa0MAVGyMEB2"}}],"responses":{"200":{"content":{"application/json":{"schema":{"description":"Information about the meeting cloud recording registrant.","properties":{"next_page_token":{"type":"string","description":"The next page token is used to paginate through large result sets. A next page token will be returned whenever the set of available results exceeds the current page size. The expiration period for this token is 15 minutes.","example":"w7587w4eiyfsudgf"},"page_count":{"type":"integer","description":"The number of pages returned for the request made.","example":1},"page_number":{"deprecated":true,"type":"integer","default":1,"description":"**Deprecated.** We will no longer support this field in a future release. Instead, use the `next_page_token` for pagination.","example":1},"page_size":{"type":"integer","maximum":300,"default":30,"description":"The number of records returned with a single API call.","example":30},"total_records":{"type":"integer","description":"The total number of all the records available across pages.","example":20},"registrants":{"description":"Information about the cloud recording registrants.","items":{"properties":{"id":{"description":"The registrant's ID.","type":"string","example":"3Z7sEm0TQQieLav3c3OD_g"},"address":{"description":"The registrant's address.","type":"string","example":"1800 Amphibious Blvd."},"city":{"description":"The registrant's city.","type":"string","example":"Mountain View"},"comments":{"description":"The registrant's questions and comments.","type":"string","example":"Looking forward to the discussion."},"country":{"description":"The registrant's two-letter [country code](https://marketplace.zoom.us/docs/api-reference/other-references/abbreviation-lists#countries).","type":"string","example":"US"},"custom_questions":{"description":"Information about custom questions.","items":{"type":"object","description":"Information about custom questions.","properties":{"title":{"type":"string","description":"The title of the custom question.","example":"What do you hope to learn from this?"},"value":{"type":"string","maxLength":128,"description":"The custom question's response value. This has a limit of 128 characters.","example":"Look forward to learning how you come up with new recipes and what other services you offer."}}},"type":"array"},"email":{"description":"The registrant's email address. See [Email address display rules](https://marketplace.zoom.us/docs/api-reference/using-zoom-apis#email-address) for return value details.","format":"email","maxLength":128,"type":"string","example":"jchill@example.com"},"first_name":{"description":"The registrant's first name.","maxLength":64,"type":"string","example":"Jill"},"industry":{"description":"The registrant's industry.","type":"string","example":"Food"},"job_title":{"description":"The registrant's job title.","type":"string","example":"Chef"},"last_name":{"description":"The registrant's last name.","maxLength":64,"type":"string","example":"Chill"},"no_of_employees":{"description":"The registrant's number of employees: \n* `1-20` \n* `21-50` \n* `51-100` \n* `101-250` \n* `251-500` \n* `501-1,000` \n* `1,001-5,000` \n* `5,001-10,000` \n* `More than 10,000`","enum":["","1-20","21-50","51-100","101-250","251-500","501-1,000","1,001-5,000","5,001-10,000","More than 10,000"],"type":"string","example":"1-20"},"org":{"description":"The registrant's organization.","type":"string","example":"Cooking Org"},"phone":{"description":"The registrant's phone number.","type":"string","example":"5550100"},"purchasing_time_frame":{"description":"The registrant's purchasing time frame: \n* `Within a month` \n* `1-3 months` \n* `4-6 months` \n* `More than 6 months` \n* `No timeframe`","enum":["","Within a month","1-3 months","4-6 months","More than 6 months","No timeframe"],"type":"string","example":"1-3 months"},"role_in_purchase_process":{"description":"The registrant's role in the purchase process: \n* `Decision Maker` \n* `Evaluator/Recommender` \n* `Influencer` \n* `Not involved`","enum":["","Decision Maker","Evaluator/Recommender","Influencer","Not involved"],"type":"string","example":"Influencer"},"state":{"description":"The registrant's state or province.","type":"string","example":"CA"},"status":{"description":"The registrant's status: \n* `approved` — Registrant is approved. \n* `denied` — Registrant is denied. \n* `pending` — Registrant is waiting for approval.","enum":["approved","denied","pending"],"type":"string","example":"approved"},"zip":{"description":"The registrant's ZIP or postal code.","type":"string","example":"94045"}},"type":"object","description":" Registrant.","required":["email","first_name"]},"type":"array"}},"type":"object","title":"Meeting Cloud Recording Registration"}}},"description":"**HTTP Status Code:** `200` <br>\n Registrants returned."},"404":{"description":"**HTTP Status Code:** `404` <br>\n Meeting recording not found."}},"security":[{"OAuth":[]}],"tags":["Cloud Recording"],"description":"Use this API to list registrants of a past meeting's [on-demand cloud recordings](https://support.zoom.us/hc/en-us/articles/360000488283-On-demand-recordings). Users must [register](/docs/api-reference/zoom-api/methods#operation/meetingRecordingRegistrantCreate) to view the recordings. \n\n **Scopes:** `recording:read:admin`, `recording:read` <br> **[Rate Limit Label](https://developers.zoom.us/docs/api/rest/rate-limits/):** `Medium`","operationId":"meetingRecordingRegistrants","summary":"List recording registrants"},"post":{"parameters":[{"in":"path","name":"meetingId","required":true,"description":"The meeting's ID. \n\n When storing this value in your database, you must store it as a long format integer and **not** an integer. Meeting IDs can exceed 10 digits.","schema":{"format":"int64","type":"integer","example":85746065}}],"responses":{"201":{"content":{"application/json":{"schema":{"properties":{"id":{"description":"[Meeting ID](https://support.zoom.us/hc/en-us/articles/201362373-What-is-a-Meeting-ID-): Unique identifier of the meeting in \"**long**\" format(represented as int64 data type in JSON), also known as the meeting number.","format":"int64","type":"integer","example":6840331990},"registrant_id":{"description":"Registrant ID","type":"string","example":"3Z7sEm0TQQieLav3c3OD_g"},"share_url":{"description":"Share URL for the on-demand recording. This includes the “tk” token for the registrant. This is similar to the token that Zoom returns in the URL response to join a registered meeting, for example: `url?tk=xxxx`. Except while the meeting registration token can be used to join the meeting, this token can only be used to watch the recording.","type":"string","example":"https://example.com/rec/share/Qg75t7xZBtEbAkjdlgbfdngBBBB"},"topic":{"description":"Meeting Topic","type":"string","example":"My Personal Meeting Room"}},"type":"object"}}},"description":"**HTTP Status Code:** `201` <br>\nRegistration submitted."},"404":{"description":"**HTTP Status Code:** `404` <br>\nMeeting recording not found"}},"security":[{"OAuth":[]}],"tags":["Cloud Recording"],"description":"Cloud Recordings of past Zoom Meetings can be made [on-demand](https://support.zoom.us/hc/en-us/articles/360000488283-On-demand-Recordings). Users should be [registered](/docs/api-reference/zoom-api/methods#operation/meetingRecordingRegistrantCreate) to view these recordings.\n\nUse this API to register a user to gain access to **On-demand Cloud Recordings** of a past meeting.<br>\n**Scopes:** `recording:write:admin`, `recording:write`.<br>\n \n **[Rate Limit Label](https://developers.zoom.us/docs/api/rest/rate-limits/):** `Light`\n\n","operationId":"meetingRecordingRegistrantCreate","requestBody":{"content":{"application/json":{"schema":{"description":" Registrant.","properties":{"address":{"description":"The registrant's address.","type":"string","example":"1800 Amphibious Blvd."},"city":{"description":"The registrant's city.","type":"string","example":"Mountain View"},"comments":{"description":"The registrant's questions and comments.","type":"string","example":"Looking forward to the discussion."},"country":{"description":"The registrant's two-letter [country code](https://marketplace.zoom.us/docs/api-reference/other-references/abbreviation-lists#countries).","type":"string","example":"US"},"custom_questions":{"description":"Information about custom questions.","items":{"type":"object","description":"Information about custom questions.","properties":{"title":{"type":"string","description":"The title of the custom question.","example":"What do you hope to learn from this?"},"value":{"type":"string","maxLength":128,"description":"The custom question's response value. This has a limit of 128 characters.","example":"Look forward to learning how you come up with new recipes and what other services you offer."}}},"type":"array"},"email":{"description":"The registrant's email address. See [Email address display rules](https://marketplace.zoom.us/docs/api-reference/using-zoom-apis#email-address) for return value details.","format":"email","maxLength":128,"type":"string","example":"jchill@example.com"},"first_name":{"description":"The registrant's first name.","maxLength":64,"type":"string","example":"Jill"},"industry":{"description":"The registrant's industry.","type":"string","example":"Food"},"job_title":{"description":"The registrant's job title.","type":"string","example":"Chef"},"last_name":{"description":"The registrant's last name.","maxLength":64,"type":"string","example":"Chill"},"no_of_employees":{"description":"The registrant's number of employees: \n* `1-20` \n* `21-50` \n* `51-100` \n* `101-250` \n* `251-500` \n* `501-1,000` \n* `1,001-5,000` \n* `5,001-10,000` \n* `More than 10,000`","enum":["","1-20","21-50","51-100","101-250","251-500","501-1,000","1,001-5,000","5,001-10,000","More than 10,000"],"type":"string","example":"1-20"},"org":{"description":"The registrant's organization.","type":"string","example":"Cooking Org"},"phone":{"description":"The registrant's phone number.","type":"string","example":"5550100"},"purchasing_time_frame":{"description":"The registrant's purchasing time frame: \n* `Within a month` \n* `1-3 months` \n* `4-6 months` \n* `More than 6 months` \n* `No timeframe`","enum":["","Within a month","1-3 months","4-6 months","More than 6 months","No timeframe"],"type":"string","example":"1-3 months"},"role_in_purchase_process":{"description":"The registrant's role in the purchase process: \n* `Decision Maker` \n* `Evaluator/Recommender` \n* `Influencer` \n* `Not involved`","enum":["","Decision Maker","Evaluator/Recommender","Influencer","Not involved"],"type":"string","example":"Influencer"},"state":{"description":"The registrant's state or province.","type":"string","example":"CA"},"status":{"description":"The registrant's status: \n* `approved` — Registrant is approved. \n* `denied` — Registrant is denied. \n* `pending` — Registrant is waiting for approval.","enum":["approved","denied","pending"],"type":"string","example":"approved"},"zip":{"description":"The registrant's ZIP or postal code.","type":"string","example":"94045"}},"required":["email","first_name"],"type":"object"}}},"required":true},"summary":"Create a recording registrant"}},"/meetings/{meetingId}/recordings/registrants/questions":{"get":{"parameters":[{"description":"To get Cloud Recordings of a meeting, provide the meeting ID or meeting UUID. If the meeting ID is provided instead of UUID,the response will be for the latest meeting instance. \n\nTo get Cloud Recordings of a webinar, provide the webinar ID or the webinar UUID. If the webinar ID is provided instead of UUID,the response will be for the latest webinar instance. \n\nIf a UUID starts with \"/\" or contains \"//\" (example: \"/ajXp112QmuoKj4854875==\"), you must **[double encode](https://marketplace.zoom.us/docs/api-reference/using-zoom-apis/#meeting-id-and-uuid)** the UUID before making an API request. ","in":"path","name":"meetingId","required":true,"schema":{"type":"string","example":"atsXxhSEQWit9t+U02HXNQ=="}}],"responses":{"200":{"content":{"application/json":{"schema":{"description":"Recording Registrant Questions","properties":{"custom_questions":{"description":"Array of Registrant Custom Questions","items":{"properties":{"answers":{"description":"Answer choices for the question. Can not be used with Short answer type.","items":{"type":"string","example":"Yes"},"type":"array"},"required":{"description":"State whether registrants are required to answer custom questions or not.","type":"boolean","example":true},"title":{"description":"Title of the question.","type":"string","example":"What's your name?"},"type":{"description":"The type of registration question and answers.","enum":["short","single","multiple"],"type":"string","x-enum-descriptions":["Short Answer","Single Answer","Multiple Answer"],"example":"short"}},"type":"object"},"type":"array"},"questions":{"description":"Array of Registrant Questions","items":{"properties":{"field_name":{"description":"Field name.","enum":["last_name","address","city","country","zip","state","phone","industry","org","job_title","purchasing_time_frame","role_in_purchase_process","no_of_employees","comments"],"type":"string","x-enum-descriptions":["Last Name","Address","City","Country/Region","Zip/Postal Code","State/Province","Phone","Industry","Organization","Job Title","Purchasing Time Frame","Role in Purchase Process","Number of Employees","Questions & Comments"],"example":"last_name"},"required":{"description":"State whether the field is required to be answered by the registrant or not.","type":"boolean","example":true}},"type":"object"},"type":"array"}},"title":"Recording Registrant Questions","type":"object"}}},"description":"**HTTP Status Code:** `200`<br>\nRecording Registrant Question object returned."},"404":{"description":"**HTTP Status Code:** `404`<br>\nMeeting recording or registrant not found."}},"security":[{"OAuth":[]}],"tags":["Cloud Recording"],"description":"For [on-demand](https://support.zoom.us/hc/en-us/articles/360000488283-On-demand-Recordings) meeting recordings, you can include fields with questions that will be shown to registrants when they register to view the recording.\n\nUse this API to retrieve a list of questions that are displayed for users to complete when registering to view the recording of a specific meeting.<br>\n**Scopes:** `recording:read:admin`, `recording:read`<br>\n\n **[Rate Limit Label](https://developers.zoom.us/docs/api/rest/rate-limits/):** `Light`\n","operationId":"recordingRegistrantsQuestionsGet","summary":"Get registration questions"},"patch":{"parameters":[{"description":"To get Cloud Recordings of a meeting, provide the meeting ID or meeting UUID. If the meeting ID is provided instead of UUID,the response will be for the latest meeting instance. \n\nTo get Cloud Recordings of a webinar, provide the webinar ID or the webinar UUID. If the webinar ID is provided instead of UUID,the response will be for the latest webinar instance. \n\nIf a UUID starts with \"/\" or contains \"//\" (example: \"/ajXp112QmuoKj4854875==\"), you must **[double encode](https://marketplace.zoom.us/docs/api-reference/using-zoom-apis/#meeting-id-and-uuid)** the UUID before making an API request. ","in":"path","name":"meetingId","required":true,"schema":{"type":"string","example":"atsXxhSEQWit9t+U02HXNQ=="}}],"responses":{"204":{"description":"**HTTP Status Code:** `200`<br>\nRecording Registrant Questions Updated"},"404":{"description":"**HTTP Status Code:** `404`<br>\nMeeting recording or Registrant not found"}},"security":[{"OAuth":[]}],"tags":["Cloud Recording"],"description":"For [on-demand](https://support.zoom.us/hc/en-us/articles/360000488283-On-demand-Recordings) meeting recordings, you can include fields with questions that will be shown to registrants when they register to view the recording.\n\nUse this API to update registration questions that are to be answered by users while registering to view a recording.<br>\n**Scopes:** `recording:write:admin`, `recording:write`<br> \n **[Rate Limit Label](https://developers.zoom.us/docs/api/rest/rate-limits/):** `Light`<br>\n","operationId":"recordingRegistrantQuestionUpdate","requestBody":{"content":{"application/json":{"schema":{"description":"Recording Registrant Questions","properties":{"custom_questions":{"description":"Array of Registrant Custom Questions","items":{"properties":{"answers":{"description":"Answer choices for the question. Can not be used with Short answer type.","items":{"type":"string","example":"Yes"},"type":"array"},"required":{"description":"State whether registrants are required to answer custom questions or not.","type":"boolean","example":true},"title":{"description":"Title of the question.","type":"string","example":"What's your name?"},"type":{"description":"The type of registration question and answers.","enum":["short","single","multiple"],"type":"string","x-enum-descriptions":["Short Answer","Single Answer","Multiple Answer"],"example":"short"}},"type":"object"},"type":"array"},"questions":{"description":"Array of Registrant Questions","items":{"properties":{"field_name":{"description":"Field name.","enum":["last_name","address","city","country","zip","state","phone","industry","org","job_title","purchasing_time_frame","role_in_purchase_process","no_of_employees","comments"],"type":"string","x-enum-descriptions":["Last Name","Address","City","Country/Region","Zip/Postal Code","State/Province","Phone","Industry","Organization","Job Title","Purchasing Time Frame","Role in Purchase Process","Number of Employees","Questions & Comments"],"example":"last_name"},"required":{"description":"State whether the field is required to be answered by the registrant or not.","type":"boolean","example":true}},"type":"object"},"type":"array"}},"title":"Recording Registrant Questions","type":"object"}}},"description":"Recording Registrant Questions","required":true},"summary":"Update registration questions"}},"/meetings/{meetingId}/recordings/registrants/status":{"put":{"parameters":[{"in":"path","name":"meetingId","required":true,"description":"The meeting's ID. \n\n When storing this value in your database, you must store it as a long format integer and **not** an integer. Meeting IDs can exceed 10 digits.","schema":{"format":"int64","type":"integer","example":85746065}}],"responses":{"204":{"description":"**HTTP Status Code:** `204`<br>\nRegistrant status updated."},"404":{"description":"**HTTP Status Code:** `404`<br>\nMeeting recording or Registrant not found"},"429":{"description":"**HTTP Status Code:** `429` <br> You have exceeded the daily rate limit of \"{0}\" for cloud recording **Update registrant's status** API requests for the registrant \"{1}\". You can resume these API requests at GMT 00:00:00."}},"security":[{"OAuth":[]}],"tags":["Cloud Recording"],"description":"A registrant can either be approved or denied from viewing the [on-demand](https://support.zoom.us/hc/en-us/articles/360000488283-On-demand-Recordings) recording. \nUse this API to update a registrant's status.\n\n**Scopes:** `recording:write:admin`, `recording:write`<br>\n\n **[Rate Limit Label](https://developers.zoom.us/docs/api/rest/rate-limits/):** `Medium`\n","operationId":"meetingRecordingRegistrantStatus","requestBody":{"content":{"application/json":{"schema":{"description":"Registrant Status","properties":{"action":{"enum":["approve","deny"],"type":"string","x-enum-descriptions":["Approve registrant","Deny registrant"],"example":"approve"},"registrants":{"description":"List of registrants","items":{"properties":{"id":{"type":"string","example":"3Z7sEm0TQQieLav3c3OD_g"}},"type":"object"},"maximum":30,"type":"array"}},"required":["action"],"type":"object"}}},"required":true},"summary":"Update registrant's status"}},"/meetings/{meetingId}/recordings/settings":{"get":{"parameters":[{"description":"To get Cloud Recordings of a meeting, provide the meeting ID or meeting UUID. If the meeting ID is provided instead of UUID,the response will be for the latest meeting instance. \n\nTo get Cloud Recordings of a webinar, provide the webinar ID or the webinar UUID. If the webinar ID is provided instead of UUID,the response will be for the latest webinar instance. \n\nIf a UUID starts with \"/\" or contains \"//\" (example: \"/ajXp112QmuoKj4854875==\"), you must **[double encode](https://marketplace.zoom.us/docs/api-reference/using-zoom-apis/#meeting-id-and-uuid)** the UUID before making an API request. ","in":"path","name":"meetingId","required":true,"schema":{"type":"string","example":"atsXxhSEQWit9t+U02HXNQ=="}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"approval_type":{"description":"Approval type for the registration.<br>\n`0`- Automatically approve the registration when a user registers.<br>\n`1` - Manually approve or deny the registration of a user.<br>\n`2` - No registration required to view the recording.","enum":[0,1,2],"type":"integer","x-enum-descriptions":["Registrants can watch the recording directly after registration","Registrants will receive emails then watch the recording after you approve the registration","Disabled"],"example":1},"authentication_domains":{"description":"Authentication domains.","type":"string","example":"test.com"},"authentication_option":{"description":"Authentication Options.","type":"string","example":"auth_option"},"on_demand":{"description":"Determine whether registration is required to view the recording.","type":"boolean","example":true},"password":{"description":"Enable password protection for the recording by setting a password. The password must have a minimum of **eight** characters with a mix of numbers, letters and special characters.<br><br>\n**Note:** If the account owner or the admin has set minimum password strength requirements for recordings via Account Settings, the password value provided here must meet those requirements. <br><br>If the requirements are enabled, you can view those requirements by calling either the [**Get user settings**](/docs/api-reference/zoom-api/methods#operation/userSettings) API or the [**Get account settings**](/docs/api-reference/zoom-api/ma#operation/accountSettings) API.","maxLength":10,"minLength":8,"type":"string","example":"975193018"},"recording_authentication":{"description":"Only authenticated users can view.","type":"boolean","example":true},"send_email_to_host":{"description":"Send an email to host when someone registers to view the recording. This applies for On-demand recordings only.","type":"boolean","example":true},"share_recording":{"description":"Determine how the meeting recording is shared.","enum":["publicly","internally","none"],"type":"string","x-enum-descriptions":["Publicly","Internally(account members only)","None"],"example":"publicly"},"show_social_share_buttons":{"description":"Show social share buttons on registration page. This applies for On-demand recordings only.","type":"boolean","example":true},"topic":{"description":"Name of the recording.","type":"string","example":"My Personal Meeting Room"},"viewer_download":{"description":"Determine whether a viewer can download the recording file or not.","type":"boolean","example":true}},"title":"Recording settings","type":"object"}}},"description":"**HTTP Status Code:** `200` <br>\nMeeting recording settings returned"},"404":{"description":"**HTTP Status Code:** `404` <br>\nMeeting recording not found."}},"security":[{"OAuth":[]}],"tags":["Cloud Recording"],"description":"Retrieve settings applied to a meeting's [Cloud Recording](https://support.zoom.us/hc/en-us/articles/203741855-Cloud-Recording).<br><br>\n**Scopes**: `recording:read:admin` `recording:read`<br>\n\n **[Rate Limit Label](https://developers.zoom.us/docs/api/rest/rate-limits/):** `Light` <br>","operationId":"recordingSettingUpdate","summary":"Get meeting recording settings"},"patch":{"parameters":[{"description":"To get Cloud Recordings of a meeting, provide the meeting ID or meeting UUID. If the meeting ID is provided instead of UUID,the response will be for the latest meeting instance. \n\nTo get Cloud Recordings of a webinar, provide the webinar ID or the webinar UUID. If the webinar ID is provided instead of UUID,the response will be for the latest webinar instance. \n\nIf a UUID starts with \"/\" or contains \"//\" (example: \"/ajXp112QmuoKj4854875==\"), you must **[double encode](https://marketplace.zoom.us/docs/api-reference/using-zoom-apis/#meeting-id-and-uuid)** the UUID before making an API request. ","in":"path","name":"meetingId","required":true,"schema":{"type":"string","example":"atsXxhSEQWit9t+U02HXNQ=="}}],"responses":{"204":{"description":"**HTTP Status Code:** `204` <br>\nMeeting recording setting's updated"},"404":{"description":"**HTTP Status Code:** `404` <br>\nMeeting recording not found. "}},"security":[{"OAuth":[]}],"tags":["Cloud Recording"],"description":"Update settings applied to a meeting's [Cloud Recording](https://support.zoom.us/hc/en-us/articles/203741855-Cloud-Recording)<br><br>\n**Scopes**: `recording:write:admin` `recording:write`<br>\n\n **[Rate Limit Label](https://developers.zoom.us/docs/api/rest/rate-limits/):** `Light` <br>","operationId":"recordingSettingsUpdate","requestBody":{"content":{"application/json":{"schema":{"properties":{"approval_type":{"description":"Approval type for the registration.<br>\n`0`- Automatically approve the registration when a user registers.<br>\n`1` - Manually approve or deny the registration of a user.<br>\n`2` - No registration required to view the recording.","enum":[0,1,2],"type":"integer","x-enum-descriptions":["Registrants can watch the recording directly after registration","Registrants will receive emails then watch the recording after you approve the registration","Disabled"],"example":1},"authentication_domains":{"description":"Authentication domains.","type":"string","example":"test.com"},"authentication_option":{"description":"Authentication Options.","type":"string","example":"auth_option"},"on_demand":{"description":"Determine whether registration is required to view the recording.","type":"boolean","example":true},"password":{"description":"Enable password protection for the recording by setting a password. The password must have a minimum of **eight** characters with a mix of numbers, letters and special characters.<br><br>\n**Note:** If the account owner or the admin has set minimum password strength requirements for recordings via Account Settings, the password value provided here must meet those requirements. <br><br>If the requirements are enabled, you can view those requirements by calling either the [**Get user settings**](/docs/api-reference/zoom-api/methods#operation/userSettings) API or the [**Get account settings**](/docs/api-reference/zoom-api/ma#operation/accountSettings) API.","maxLength":10,"minLength":8,"type":"string","example":"975193018"},"recording_authentication":{"description":"Only authenticated users can view.","type":"boolean","example":true},"send_email_to_host":{"description":"Send an email to host when someone registers to view the recording. This applies for On-demand recordings only.","type":"boolean","example":true},"share_recording":{"description":"Determine how the meeting recording is shared.","enum":["publicly","internally","none"],"type":"string","x-enum-descriptions":["Publicly","Internally(account members only)","None"],"example":"publicly"},"show_social_share_buttons":{"description":"Show social share buttons on registration page. This applies for On-demand recordings only.","type":"boolean","example":true},"topic":{"description":"Name of the recording.","type":"string","example":"My Personal Meeting Room"},"viewer_download":{"description":"Determine whether a viewer can download the recording file or not.","type":"boolean","example":true}},"title":"Recording settings","type":"object"}}},"required":true},"summary":"Update meeting recording settings"}},"/meetings/{meetingUUID}/recordings/status":{"put":{"parameters":[{"description":"The meeting's universally unique identifier (UUID). Each meeting instance generates a UUID. For example, after a meeting ends, a new UUID is generated for the next meeting instance.\n\nIf the meeting UUID begins with a `/` character or contains a `//` character, you **must** [double encode](https://marketplace.zoom.us/docs/api-reference/using-zoom-apis/#meeting-id-and-uuid) the meeting UUID when using the meeting UUID for other API calls.","in":"path","name":"meetingUUID","required":true,"schema":{"type":"string","example":"4444AAAiAAAAAiAiAiiAii=="}}],"responses":{"200":{"description":"**HTTP Status Code:** `200` <br>\nRecordings recovered. \n\n**Error Code:** `200`<br>\nYou do not have the right permissions."},"204":{"description":"**HTTP Status Code:** `204` <br>\nDeleted recordings of the meeting recovered."},"400":{"description":"**HTTP Status Code:** `400` <br>\n**Error Code:** `1010`<br>\nUser does not belong to this account: {accountId}.\n**Error Code:** `3309`<br>\nNot enough cloud storage available. Either purchase additional storage or delete cloud recordings to free up storage."},"404":{"description":"**HTTP Status Code:** `404` <br>\nMeeting recording not found.<br> **Error Code:** `1001`<br>  User does not exist: {userId}.<br>\n**Error Code:** `3301`<br>There is no recording for this meeting.\n\n\n\n"}},"security":[{"OAuth":[]}],"tags":["Cloud Recording"],"description":"Zoom allows users to recover recordings from trash for up to 30 days from the deletion date. Use this API to recover all deleted [Cloud Recordings](https://support.zoom.us/hc/en-us/articles/203741855-Cloud-Recording) of a specific meeting.<br><br>\n**Scopes**: `recording:write:admin` `recording:write`<br>\n \n **[Rate Limit Label](https://developers.zoom.us/docs/api/rest/rate-limits/):** `Light`<br>\n**Prerequisites**:<br>\n* A Pro user with Cloud Recording enabled.","operationId":"recordingStatusUpdate","requestBody":{"content":{"application/json":{"schema":{"properties":{"action":{"enum":["recover"],"type":"string","x-enum-descriptions":["recover meeting recording"],"example":"recover"}},"type":"object"}}},"required":true},"summary":"Recover meeting recordings"}},"/meetings/{meetingId}/recordings/{recordingId}":{"delete":{"parameters":[{"description":"To get Cloud Recordings of a meeting, provide the meeting ID or meeting UUID. If the meeting ID is provided instead of UUID,the response will be for the latest meeting instance. \n\nTo get Cloud Recordings of a webinar, provide the webinar ID or the webinar UUID. If the webinar ID is provided instead of UUID,the response will be for the latest webinar instance. \n\nIf a UUID starts with \"/\" or contains \"//\" (example: \"/ajXp112QmuoKj4854875==\"), you must **[double encode](https://marketplace.zoom.us/docs/api-reference/using-zoom-apis/#meeting-id-and-uuid)** the UUID before making an API request. ","in":"path","name":"meetingId","required":true,"schema":{"type":"string","example":"atsXxhSEQWit9t+U02HXNQ=="}},{"description":"The recording ID.","in":"path","name":"recordingId","required":true,"schema":{"type":"string","example":"a2f19f96-9294-4f51-8134-6f0eea108eb2"}},{"description":"The recording delete actions:<br>`trash` - Move recording to trash.<br>`delete` - Delete recording permanently.","in":"query","name":"action","schema":{"default":"trash","enum":["trash","delete"],"type":"string","example":"trash"},"x-enum-descriptions":["move recording to trash","delete recording permanently"]}],"responses":{"200":{"description":"**HTTP Status Code:** `200` <br>\nRecording deleted. \n\n**Error Code:** `200`<br>\nYou do not have the right permissions."},"204":{"description":"**HTTP Status Code:** `204` <br>\nMeeting recording file deleted."},"400":{"description":"**HTTP Status Code:** `400` <br> **Error Code:** `1010` <br>\nUser does not belong to this account: {accountId}.<br> \n**Error Code:** `3303` <br>\nYou can not delete an uncompleted meeting. <br/>\n**Error Code:** `3332` <br>\nThis recording was selected for a simulive webinar. You cannot delete or trash it. <br>\n**Error Code:** `3332` <br>\nUnable to delete this file because this recording is being used for Zoom IQ for Sales."},"404":{"description":"**HTTP Status Code:** `404` <br>\nMeeting recording file not found<br>\n**Error Code:** `1001` <br>\nUser {userId} does not exist or does not belong to this account.<br>\n**Error Code:** `3301` <br> There is no recording for this meeting.\n"}},"security":[{"OAuth":[]}],"tags":["Cloud Recording"],"description":"Delete a specific recording file from a meeting.<p style=\"background-color:#e1f5fe; color:#01579b; padding:8px\"> <b>Note:</b> To use this API, you must enable the <b>The host can delete cloud recordings</b> setting. You can find this setting in the <b>Recording</b> tab of the <b>Settings</b> interface in the [Zoom web portal](https://zoom.us/).</p>\n\n**Scopes**: `recording:write:admin`, `recording:write`<br>**[Rate Limit Label](https://developers.zoom.us/docs/api/rest/rate-limits/):** `Light`","operationId":"recordingDeleteOne","summary":"Delete a meeting recording file"}},"/meetings/{meetingId}/recordings/{recordingId}/status":{"put":{"parameters":[{"description":"To get Cloud Recordings of a meeting, provide the meeting ID or meeting UUID. If the meeting ID is provided instead of UUID,the response will be for the latest meeting instance. \n\nTo get Cloud Recordings of a webinar, provide the webinar ID or the webinar UUID. If the webinar ID is provided instead of UUID,the response will be for the latest webinar instance. \n\nIf a UUID starts with \"/\" or contains \"//\" (example: \"/ajXp112QmuoKj4854875==\"), you must **[double encode](https://marketplace.zoom.us/docs/api-reference/using-zoom-apis/#meeting-id-and-uuid)** the UUID before making an API request. ","in":"path","name":"meetingId","required":true,"schema":{"type":"string","example":"atsXxhSEQWit9t+U02HXNQ=="}},{"description":"The recording ID.","in":"path","name":"recordingId","required":true,"schema":{"type":"string","example":"a2f19f96-9294-4f51-8134-6f0eea108eb2"}}],"responses":{"204":{"description":"**HTTP Status Code:** `204` <br> Meeting recording recovered.\n\n"},"400":{"description":"**HTTP Status Code:** `400` <br>\n**Error Code:** `1010` <br>\nUser does not belong to this account: {accountId}.\n**Error Code:** `3309`<br>\nNot enough cloud storage available. Either purchase additional storage or delete cloud recordings to free up storage."},"404":{"description":"**HTTP Status Code:** `404` <br>Meeting recording not found.<br>\n**Error Code:** `1001` <br> User {userId} does not exist or does not belong to this account.<br>\n**Error Code:** `3301`There is no recording for this meeting."}},"security":[{"OAuth":[]}],"tags":["Cloud Recording"],"description":"Zoom allows users to recover recordings from trash for up to 30 days from the deletion date. Use this API to recover a single recording file from the meeting.<br>\n**Scopes:** `recording:write:admin` `recording:write`<br>\n \n **[Rate Limit Label](https://developers.zoom.us/docs/api/rest/rate-limits/):** `Light`<br>\n","operationId":"recordingStatusUpdateOne","requestBody":{"content":{"application/json":{"schema":{"properties":{"action":{"enum":["recover"],"type":"string","x-enum-descriptions":["recover meeting recording"],"example":"recover"}},"type":"object"}}},"required":true},"summary":"Recover a single recording"}},"/meetings/{meetingId}/jointoken/local_recording":{"get":{"summary":"Get a meeting's join token for local recording","description":"Get a meeting's join token to allow for local recording. The join token lets a recording bot implemented using Zoom Meeting SDK to connect to a Zoom meeting. The recording bot can then automatically start locally recording. This supports both regular and raw local recording types. \n\n**Scopes:** `meeting_token:read:admin:local_recording`, `meeting_token:read:local_recording` <br> **[Rate Limit Label](https://developers.zoom.us/docs/api/rest/rate-limits/):** `Light` \n\n**Prerequisites:** \n* The **Local recording** user setting enabled in the Zoom web portal.","tags":["Meetings"],"operationId":"meetingLocalRecordingJoinToken","parameters":[{"in":"path","name":"meetingId","required":true,"description":"The meeting's ID. \n\n When storing this value in your database, you must store it as a long format integer and **not** an integer. Meeting IDs can exceed 10 digits.","schema":{"format":"int64","type":"integer","example":85746065}}],"responses":{"200":{"description":"**HTTP Status Code:** `200` <br>\nMeeting local recording token returned.","content":{"application/json":{"schema":{"description":"Information about the meeting's local recorder join token.","type":"object","properties":{"expire_in":{"type":"integer","format":"int64","description":"The number of seconds the join token is valid for before it expires. This value always returns `120`.","enum":[120],"example":120},"token":{"description":"The join token.","type":"string","example":"2njt50mj"}}}}}},"400":{"description":"**HTTP Status Code:** `400` <br>\nBad Request \n\n**Error Code:** `300` <br>\nInvalid meeting ID. \n\n**Error Code:** `3000` <br>\nCannot access Webinar information. \n\n**Error Code:** `124` <br>\nThis API only supports OAuth2 authorization. \n\n**Error Code:** `3000` <br>\nNot allowed to start local recording. To use this feature, enable the \"Local Recording\" setting in the \"Settings\" page of the Zoom web portal. \n\n**Error Code:** `3161` <br>\nMeeting hosting and scheduling capabilities are not allowed for your user account."},"404":{"description":"**HTTP Status Code:** `404` <br>\nNot Found \n\n**Error Code:** `300` <br>\nMeeting ID does not exist. \n\n**Error Code:** `3001` Meeting does not exist: {meetingId}"}},"security":[{"OAuth":[]}]}},"/meetings/{meetingId}/jointoken/local_archiving":{"get":{"summary":"Get a meeting's archive token for local archiving","description":"Get a meeting's archive token to allow local archiving. The archive token allows a meeting SDK app or bot to get archive permission to access the meeting's raw audio and video media stream in real-time. \n\n**Scopes:** `meeting_token:read:admin:local_archiving` <br> **[Rate Limit Label](https://developers.zoom.us/docs/api/rest/rate-limits/):** `Light` \n\n**Prerequisites:** \n* A Pro or higher plan for the meeting host. \n* The **Archive meetings and webinars** account setting enabled in the Zoom web portal.","tags":["Meetings"],"operationId":"meetingLocalArchivingArchiveToken","parameters":[{"in":"path","name":"meetingId","required":true,"description":"The meeting's ID. \n\n When storing this value in your database, you must store it as a long format integer and **not** an integer. Meeting IDs can exceed 10 digits.","schema":{"format":"int64","type":"integer","example":85746065}}],"responses":{"200":{"description":"**HTTP Status Code:** `200` <br>\nMeeting local archiving token returned.","content":{"application/json":{"schema":{"description":"Information about the meeting's local archive token.","type":"object","properties":{"expire_in":{"type":"integer","format":"int64","description":"The number of seconds the archive token is valid for before it expires. This value always returns `120`.","enum":[120],"example":120},"token":{"description":"The archive token.","type":"string","example":"2njt50mj"}}}}}},"400":{"description":"**HTTP Status Code:** `400` <br>\nBad Request \n\n**Error Code:** `300` <br>\nInvalid meeting ID. \n\n**Error Code:** `3000` <br>\nCannot access Webinar information. \n\n**Error Code:** `124` <br>\nThis API only supports OAuth2 authorization. \n\n**Error Code:** `3000` <br>\nNot allowed to start local archiving. To use this feature, enable the \"Archive meetings and webinars\" setting in the \"Settings\" page of the Zoom web portal. \n\n**Error Code:** `3161` <br>\nMeeting hosting and scheduling capabilities are not allowed for your user account."},"404":{"description":"**HTTP Status Code:** `404` <br>\nNot Found \n\n**Error Code:** `300` <br>\nMeeting ID does not exist. \n\n**Error Code:** `3001` Meeting does not exist: {meetingId}"}},"security":[{"OAuth":[]}]}},"/meetings/{meetingId}/jointoken/live_streaming":{"get":{"summary":"Get a meeting's join token for live streaming","description":"Get a meeting's join token to allow live streaming. The join token allows a recording bot implemented using Zoom meeting SDK to connect to a Zoom meeting \"hosted by the issuer of the token\", and can call the streaming method automatically. It supports both regular live streaming, and raw streaming. \n\n**Scopes:** `meeting_token:read:admin:live_streaming`, `meeting_token:read:live_streaming` <br> **[Rate Limit Label](https://developers.zoom.us/docs/api/rest/rate-limits/):** `Light` \n\n**Prerequisites:** \n* A Pro or higher plan for the meeting host. \n* The **Allow livestreaming of meetings** user setting enabled in the Zoom web portal.","tags":["Meetings"],"operationId":"meetingLiveStreamingJoinToken","parameters":[{"in":"path","name":"meetingId","required":true,"description":"The meeting's ID. \n\n When storing this value in your database, you must store it as a long format integer and **not** an integer. Meeting IDs can exceed 10 digits.","schema":{"format":"int64","type":"integer","example":85746065}}],"responses":{"200":{"description":"**HTTP Status Code:** `200` <br>\nMeeting live streaming token returned.","content":{"application/json":{"schema":{"description":"Information about the meeting's join token.","type":"object","properties":{"expire_in":{"type":"integer","format":"int64","description":"The number of seconds the join token is valid for before it expires. This value always returns `120`.","enum":[120],"example":120},"token":{"description":"The join token.","type":"string","example":"2njt50mj"}}}}}},"400":{"description":"**HTTP Status Code:** `400` <br>\nBad Request \n\n**Error Code:** `300` <br>\nInvalid meeting ID. \n\n**Error Code:** `3000` <br>\nCannot access Webinar information. \n\n**Error Code:** `124` <br>\nThis API only supports OAuth2 authorization. \n\n**Error Code:** `3000` <br>\nNot allowed to start live streaming. To use this feature, enable the \"Allow livestreaming of meetings\" setting in the \"Settings\" page of the Zoom web portal. \n\n**Error Code:** `3161` <br>\nMeeting hosting and scheduling capabilities are not allowed for your user account."},"404":{"description":"**HTTP Status Code:** `404` <br>\nNot Found \n\n**Error Code:** `300` <br>\nMeeting ID does not exist. \n\n**Error Code:** `3001` Meeting does not exist: {meetingId}"}},"security":[{"OAuth":[]}]}},"/metrics/chat":{"get":{"parameters":[{"description":"Start date in 'yyyy-mm-dd' format. The date range defined by the \"from\" and \"to\" parameters should only be one month as the report includes only one month worth of data at once.","in":"query","name":"from","required":true,"schema":{"format":"date","type":"string","example":"2022-01-01"}},{"description":"End date.","in":"query","name":"to","required":true,"schema":{"format":"date","type":"string","example":"2022-01-28"}},{"description":"The number of records returned within a single API call.","in":"query","name":"page_size","schema":{"default":30,"maximum":300,"type":"integer","example":30}},{"description":"Use the next page token to paginate through large result sets. A next page token is returned whenever the set of available results exceeds the current page size. This token's expiration period is 15 minutes.","in":"query","name":"next_page_token","schema":{"type":"string","example":"IAfJX3jsOLW7w3dokmFl84zOa0MAVGyMEB2"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"from":{"description":"The report's start date.","format":"date","type":"string","example":"2022-04-06"},"next_page_token":{"description":"The report's [`next_page_token` value](https://marketplace.zoom.us/docs/api-reference/pagination#next-page-token). The API returns this value when the set of available results exceeds the current page size. This token expires after 15 minutes.","type":"string","example":"LkbB9n92siRxgYkffZ8KhApZCQMZpNrN0d2"},"page_size":{"default":30,"description":"The number of records to return within a single API call.","maximum":300,"type":"integer","example":30},"to":{"description":"The report's end date.","format":"date","type":"string","example":"2022-04-07"},"users":{"items":{"properties":{"audio_sent":{"description":"The user's total number of audio files sent.","type":"integer","example":0},"code_sippet_sent":{"description":"The user's total number of code snippets sent.","type":"integer","example":0},"email":{"description":"The user's email address.","format":"email","type":"string","example":"user@example.com"},"files_sent":{"description":"The user's total number of files sent.","type":"integer","example":0},"giphys_sent":{"description":"The user's total number of [GIPHY](https://giphy.com/) images sent.","type":"integer","example":0},"group_sent":{"description":"The user's total number of messages sent in Zoom Chat channels.","type":"integer","example":0},"images_sent":{"description":"The user's total number of images sent.","type":"integer","example":0},"p2p_sent":{"description":"The user's total number of peer-to-peer (P2P) chat messages sent.","type":"integer","example":0},"text_sent":{"description":"The user's total number of text messages sent.","type":"integer","example":0},"total_sent":{"description":"The user's total number of messages sent.","type":"integer","example":0},"user_id":{"description":"The user's ID.","type":"string","example":"-0hwjTHMR9uteSRrygQXMA"},"user_name":{"description":"The user's display name.","type":"string","example":"jchill"},"video_sent":{"description":"The user's total number of video files sent.","type":"integer","example":0}},"type":"object"},"type":"array"}},"type":"object"}}},"description":"**HTTP Status Code:** `200`<br>\nChat details returned.<br>\nOnly available for paid accounts that have enabled the dashboard feature."}},"security":[{"OAuth":[]}],"tags":["Dashboards"],"description":"Get [metrics](https://support.zoom.us/hc/en-us/articles/204654719-Dashboard#h_cc7e9749-1c70-4afb-a9a2-9680654821e4) for how users are utilizing Zoom Chat to send messages.\n\nUse the `from` and `to` query parameters to specify a monthly date range for the dashboard data. The monthly date range must be within the last six months.\n\n> **Note:** To query chat metrics from July 1, 2021 and later, use this endpoint instead of the [**Get IM metrics**](/docs/api-reference/zoom-api/methods#operation/dashboardIM) API.\n\n**Scope:** `dashboard_im:read:admin`</br>**[Rate Limit Label](https://developers.zoom.us/docs/api/rest/rate-limits/):** `Resource-intensive`\n\n**Prerequisites:**\n\n* Business or a higher plan","operationId":"dashboardChat","summary":"Get chat metrics"}},"/metrics/client/feedback":{"get":{"parameters":[{"description":"Start date in 'yyyy-mm-dd' format. The date range defined by the \"from\" and \"to\" parameters should only be one month as the report includes only one month worth of data at once.","in":"query","name":"from","required":true,"schema":{"format":"date","type":"string","example":"2022-01-01"}},{"description":"End date.","in":"query","name":"to","required":true,"schema":{"format":"date","type":"string","example":"2022-01-28"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"client_feedbacks":{"items":{"properties":{"feedback_id":{"description":"Feedback Id","type":"string","example":"1"},"feedback_name":{"description":"Feedback Name","type":"string","example":"Others"},"participants_count":{"description":"The number of participants that upvoted the feedback.","type":"integer","example":0}},"type":"object"},"type":"array"},"from":{"description":"Start date for this report","format":"date","type":"string","example":"2022-01-01"},"to":{"description":"End date for this report","format":"date","type":"string","example":"2022-01-30"},"total_records":{"description":"The number of all records available across pages","type":"integer","example":10}},"type":"object"}}},"description":"**HTTP Status Code:** `200`<br>\nClient Feedback details returned."}},"security":[{"OAuth":[]}],"tags":["Dashboards"],"description":"Use this API to return [Zoom meetings client feedback](https://support.zoom.us/hc/en-us/articles/115005855266-End-of-Meeting-Feedback-Survey#h_e30d552b-6d8e-4e0a-a588-9ca8180c4dbf) survey results. You can specify a monthly date range for the Dashboard data using the `from` and `to` query parameters. The month should fall within the last six months. \n\n**Scopes:** `dashboard_home:read:admin` <br> **[Rate Limit Label](https://developers.zoom.us/docs/api/rest/rate-limits/):** `Heavy` \n\n**Prerequisites:** \n* A Business or higher account. \n* The \"[**Feedback to Zoom**](https://support.zoom.us/hc/en-us/articles/115005838023)\" option enabled.","operationId":"dashboardClientFeedback","summary":"List Zoom meetings client feedback"}},"/metrics/client/feedback/{feedbackId}":{"get":{"parameters":[{"description":"Feedback Detail Id","in":"path","name":"feedbackId","required":true,"schema":{"type":"string","example":"1"}},{"in":"query","name":"from","schema":{"format":"date","type":"string","example":"2022-01-01"}},{"in":"query","name":"to","schema":{"format":"date","type":"string","example":"2022-01-30"}},{"in":"query","name":"page_size","schema":{"default":30,"type":"integer","example":30}},{"in":"query","name":"next_page_token","schema":{"type":"string","example":"uBTK3NzNksdkuCUAQaFVFd86kyOr59zg4U2"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"from":{"description":"Start date for this report","format":"date","type":"string","example":"2022-01-01"},"to":{"description":"End date for this report","format":"date","type":"string","example":"2022-01-30"},"next_page_token":{"description":"The next page token is used to paginate through large result sets. A next page token will be returned whenever the set of the available result list exceeds the page size. The expiration period is 15 minutes.","type":"string","example":"uBTK3NzNksdkuCUAQaFVFd86kyOr59zg4U2"},"page_size":{"default":30,"description":"The amount of records returns within a single API call. ","maximum":300,"type":"integer","example":30},"client_feedback_details":{"items":{"properties":{"email":{"description":"Email address of the participant. If the participant is **not** part of the host's account, this returns an empty string value, with some exceptions. See [Email address display rules](https://marketplace.zoom.us/docs/api-reference/using-zoom-apis#email-address) for details.","type":"string","example":"user@example.com"},"meeting_id":{"description":"Meeting ID","type":"string","example":"99525891193"},"participant_name":{"description":"Participant Name","type":"string","example":"jchill"},"time":{"description":"Time at which the feedback was submitted by the participant.","format":"date-time","type":"string","example":"2022-01-19T07:34:09Z"}},"type":"object"},"type":"array"}},"type":"object","description":"Pagination object."}}},"description":"**HTTP Status Code:** `200`<br>\nClient Feedback details returned"}},"security":[{"OAuth":[]}],"tags":["Dashboards"],"description":"Retrieve detailed information on a [Zoom meetings client feedback](https://support.zoom.us/hc/en-us/articles/115005855266-End-of-Meeting-Feedback-Survey#h_e30d552b-6d8e-4e0a-a588-9ca8180c4dbf). <br> You can specify a monthly date range for the dashboard data using the `from` and `to` query parameters. The month should fall within the last six months.\n\n**Prerequisites:**\n* Business or higher account\n* [Feedback to Zoom](https://support.zoom.us/hc/en-us/articles/115005838023) enabled.\n\n**Scope:** `dashboard_home:read:admin`<br>\n **[Rate Limit Label](https://developers.zoom.us/docs/api/rest/rate-limits/):** `Heavy`\n\n`","operationId":"dashboardClientFeedbackDetail","summary":"Get zoom meetings client feedback"}},"/metrics/client/satisfaction":{"get":{"parameters":[{"description":"The start date for the query in “yyyy-mm-dd” format. ","in":"query","name":"from","schema":{"format":"date","type":"string","example":"2022-01-01"}},{"description":"The end date for the query in “yyyy-mm-dd” format. ","in":"query","name":"to","schema":{"format":"date","type":"string","example":"2022-01-30"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"client_satisfaction":{"items":{"properties":{"date":{"description":"Date of the report.","format":"date","type":"string","example":"2022-01-01"},"good_count":{"description":"The total number of \"thumbs up\" received for this meeting.","type":"integer","example":0},"none_count":{"description":"The total number of attendees who didn't submit any response (neither thumbs up nor thumbs down).","type":"integer","example":0},"not_good_count":{"description":"The total number of \"thumbs down\" received for this meeting.","type":"integer","example":0},"satisfaction_percent":{"description":"Satisfaction Percentage.\nThe satisfaction percentage is calculated as `(good_count + none_count)` / `total_count`.","format":"double","type":"number","example":100}},"type":"object"},"type":"array"},"from":{"description":"Start date for this report in 'yyyy-mm-dd' format.","format":"date","type":"string","example":"2022-01-01"},"to":{"description":"End date for this report in 'yyyy-mm-dd' format.","format":"date","type":"string","example":"2022-01-30"},"total_records":{"description":"The total number of records available across all pages.","type":"integer","example":30}},"type":"object"}}},"description":"**HTTP Status Code:** `200`<br>\nClient satisfaction data returned. "}},"security":[{"OAuth":[]}],"tags":["Dashboards"],"description":"If the [End of Meeting Feedback Survey](https://support.zoom.us/hc/en-us/articles/115005855266) option is enabled, attendees will be prompted with a survey window where they can tap either the **Thumbs Up** or **Thumbs Down** button that indicates their Zoom meeting experience. With this API, you can get information on the attendees' meeting satisfaction. Specify a monthly date range for the query using the from and to query parameters. The month should fall within the last six months.\n\nTo get information on the survey results with negative experiences (indicated by **Thumbs Down**), use the [**Get Zoom meetings client feedback**](/docs/api-reference/zoom-api/methods#operation/dashboardClientFeedbackDetail) API.<br>\n**Scopes:** `dashboard:read:admin`<br>\n **[Rate Limit Label](https://developers.zoom.us/docs/api/rest/rate-limits/):** `Heavy`","operationId":"listMeetingSatisfaction","summary":"List client meeting satisfaction"}},"/metrics/crc":{"get":{"parameters":[{"description":"Start date in 'yyyy-mm-dd' format. The date range defined by the \"from\" and \"to\" parameters should only be one month as the report includes only one month worth of data at once.","in":"query","name":"from","required":true,"schema":{"format":"date","type":"string","example":"2022-01-01"}},{"description":"End date.","in":"query","name":"to","required":true,"schema":{"format":"date","type":"string","example":"2022-01-28"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"from":{"description":"Start date for this report.","format":"date","type":"string","example":"2022-03-01"},"to":{"description":"End date for this report.","format":"date","type":"string","example":"2022-03-30"},"crc_ports_usage":{"items":{"properties":{"crc_ports_hour_usage":{"items":{"properties":{"hour":{"description":"Hour in the day, during which the CRC was used. For example if the CRC was used at 11 pm, the value of this field will be 23.","type":"string","example":"00"},"max_usage":{"description":"The maximum number of concurrent ports that are being used in that hour.","type":"integer","example":0},"total_usage":{"description":"The total number of H.323/SIP connections in that hour.","type":"integer","example":0}},"type":"object"},"type":"array"},"date_time":{"description":"The date and time of the port usage.","format":"date","type":"string","example":"2022-03-01"}},"type":"object"},"type":"array"}},"type":"object"}}},"description":"**HTTP Status Code:** `200`<br>\nCRC usage returned.<br>\nOnly available for paid accounts that have enabled the Dashboard feature."}},"security":[{"OAuth":[]}],"tags":["Dashboards"],"description":"A Cloud Room Connector allows H.323/SIP endpoints to connect to a Zoom meeting. \n\nUse this API to get the hour by hour CRC Port usage for a specified period of time. <aside class='notice'>We will provide the report for a maximum of one month. For example, if \"from\" is set to \"2017-08-05\" and \"to\" is set to \"2017-10-10\", we will adjust \"from\" to \"2017-09-10\".</aside><br><br>\n**Prerequisites:**<br>\n* Business, Education or API Plan.\n* Room Connector must be enabled on the account.<br><br>\n**Scopes:** `dashboard_crc:read:admin`<br>\n **[Rate Limit Label](https://developers.zoom.us/docs/api/rest/rate-limits/):** `Heavy` ","operationId":"dashboardCRC","summary":"Get CRC port usage"}},"/metrics/im":{"get":{"parameters":[{"description":"Start date in 'yyyy-mm-dd' format. The date range defined by the \"from\" and \"to\" parameters should only be one month as the report includes only one month worth of data at once.","in":"query","name":"from","required":true,"schema":{"format":"date","type":"string","example":"2022-01-01"}},{"description":"End date.","in":"query","name":"to","required":true,"schema":{"format":"date","type":"string","example":"2022-01-28"}},{"description":"The number of records returned within a single API call.","in":"query","name":"page_size","schema":{"default":30,"maximum":300,"type":"integer","example":30}},{"description":"Use the next page token to paginate through large result sets. A next page token is returned whenever the set of available results exceeds the current page size. This token's expiration period is 15 minutes.","in":"query","name":"next_page_token","schema":{"type":"string","example":"IAfJX3jsOLW7w3dokmFl84zOa0MAVGyMEB2"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"from":{"description":"Start date for this report.","format":"date","type":"string","example":"2022-04-06"},"to":{"description":"End date for this report.","format":"date","type":"string","example":"2022-04-07"},"next_page_token":{"description":"The next page token is used to paginate through large result sets. A next page token will be returned whenever the set of available results exceeds the current page size. The expiration period for this token is 15 minutes.","type":"string","example":"Tva2CuIdTgsv8wAnhyAdU3m06Y2HuLQtlh3"},"page_count":{"description":"The number of pages returned for the request made.","type":"integer","example":1},"page_size":{"default":30,"description":"The number of records returned within a single API call.","maximum":300,"type":"integer","example":30},"total_records":{"description":"The number of all records available across pages.","type":"integer","example":1},"users":{"items":{"properties":{"calls_receive":{"description":"Total number of instant meeting calls received by the user.","type":"integer","example":0},"calls_send":{"description":"Total number of instant meeting calls made by the user.","type":"integer","example":0},"email":{"description":"User email.","format":"email","type":"string","example":"user@example.com"},"emoji_receive":{"description":"Total number of emojis received by the user.","type":"integer","example":0},"emoji_send":{"description":"Total number of emojis sent by the user.","type":"integer","example":0},"files_receive":{"description":"Total number of files received by the user.","type":"integer","example":0},"files_send":{"description":"Total number of files sent by the user.","type":"integer","example":0},"group_receive":{"description":"Total number of messages received by the user in channels.","type":"integer","example":0},"group_send":{"description":"Total number of messages sent by the user in channels.","type":"integer","example":0},"images_receive":{"description":"Total number of images received by the user.","type":"integer","example":0},"images_send":{"description":"Total number of images sent by the user.","type":"integer","example":0},"total_receive":{"description":"Total number of messages received by the user.","type":"integer","example":0},"total_send":{"description":"Total number of messages sent by the user.","type":"integer","example":0},"user_id":{"description":"User ID.","type":"string","example":"-tbjQOvySz6EGd8DPQYvhw"},"user_name":{"description":"User display name.","type":"string","example":"jchill"},"videos_receive":{"description":"Total number of video files received by the user. ","type":"integer","example":0},"videos_send":{"description":"Total number of video files sent by the user.","type":"integer","example":0},"voice_receive":{"description":"Total number of voice files received by the user.","type":"integer","example":0},"voice_send":{"description":"Total number of voice files sent by the user.","type":"integer","example":0}},"type":"object"},"type":"array"}},"type":"object","description":"Pagination object."}}},"description":"**HTTP Status Code:** `200`<br>\nIM details returned.<br>\nOnly available for paid accounts that have enabled the dashboard feature."}},"security":[{"OAuth":[]}],"tags":["Dashboards"],"deprecated":true,"description":"Get [metrics](https://support.zoom.us/hc/en-us/articles/204654719-Dashboard#h_cc7e9749-1c70-4afb-a9a2-9680654821e4) on how users are utilizing the Zoom Chat client.\n\nYou can specify a monthly date range for the dashboard data using the `from` and `to` query parameters. The month should fall within the last six months.<p style=\"background-color:#e1f5fe; color:#000000; padding:8px\"><b>Deprecated:</b> We will completely deprecate this endpoint in a future release. You can continue using this endpoint to query data for messages sent <b>before</b> July 1, 2021.</br></br>To get metrics on chat messages sent <b>on and after</b> July 1, 2021, use the [**Get chat metrics**](/docs/api-reference/zoom-api/methods#operation/dashboardChat) API.</p>\n\n**Scopes:** `dashboard_im:read:admin`<br>**[Rate Limit Label](https://developers.zoom.us/docs/api/rest/rate-limits/):** `Resource-intensive`\n\n**Prerequisites:**\n\n* Business or a higher plan.","operationId":"dashboardIM","summary":"Get IM metrics"}},"/metrics/issues/zoomrooms":{"get":{"parameters":[{"description":"Start date in 'yyyy-mm-dd' format. The date range defined by the \"from\" and \"to\" parameters should only be one month as the report includes only one month worth of data at once.","in":"query","name":"from","required":true,"schema":{"format":"date","type":"string","example":"2022-01-01"}},{"description":"End date.","in":"query","name":"to","required":true,"schema":{"format":"date","type":"string","example":"2022-01-28"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"from":{"description":"Start date for this report","format":"date","type":"string","example":"2022-01-01"},"to":{"description":"End date for this report","format":"date","type":"string","example":"2022-01-30"},"total_records":{"description":"The number of all records available across pages","type":"integer","example":30},"zoom_rooms":{"items":{"properties":{"id":{"description":"Zoom Room ID","type":"string","example":"NHwIXQQ2Ro-fJ13cxj_fuQ"},"issues_count":{"description":"Issue Count of Zoom Room","type":"integer","example":12},"room_name":{"description":"Zoom Room Name","type":"string","example":"jchill room"}},"type":"object"},"type":"array"}},"type":"object"}}},"description":"**HTTP Status Code:** `200`<br>\nZoom Room with issue details returned"}},"security":[{"OAuth":[]}],"tags":["Dashboards"],"description":"Get information on top 25 Zoom Rooms with issues in a month. The month specified with the \"from\" and \"to\" range should fall within the last six months.<br>\n**Scope:** `dashboard_home:read:admin`<br>\n **[Rate Limit Label](https://developers.zoom.us/docs/api/rest/rate-limits/):** `Heavy`<br>\n**Prerequisites:**<br>\n* Business or a higher plan.\n* Zoom Room must be enabled in the account.","operationId":"dashboardIssueZoomRoom","summary":"Get top 25 Zoom Rooms with issues"}},"/metrics/issues/zoomrooms/{zoomroomId}":{"get":{"parameters":[{"description":"The Zoom room ID.","in":"path","name":"zoomroomId","required":true,"schema":{"type":"string","example":"azGzXIVUTWOdEQB79aNHkA"}},{"description":"Start date in 'yyyy-mm-dd' format. The date range defined by the \"from\" and \"to\" parameters should only be one month as the report includes only one month worth of data at once.","in":"query","name":"from","required":true,"schema":{"format":"date","type":"string","example":"2022-01-01"}},{"description":"End date.","in":"query","name":"to","required":true,"schema":{"format":"date","type":"string","example":"2022-01-28"}},{"description":"The number of records returned within a single API call.","in":"query","name":"page_size","schema":{"default":30,"maximum":300,"type":"integer","example":30}},{"description":"Use the next page token to paginate through large result sets. A next page token is returned whenever the set of available results exceeds the current page size. This token's expiration period is 15 minutes.","in":"query","name":"next_page_token","schema":{"type":"string","example":"IAfJX3jsOLW7w3dokmFl84zOa0MAVGyMEB2"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"from":{"description":"Start date for this report","format":"date","type":"string","example":"2022-02-01"},"to":{"description":"End date for this report","format":"date","type":"string","example":"2022-02-28"},"next_page_token":{"description":"The next page token is used to paginate through large result sets. A next page token will be returned whenever the set of available results exceeds the current page size. The expiration period for this token is 15 minutes.","type":"string","example":"Tva2CuIdTgsv8wAnhyAdU3m06Y2HuLQtlh3"},"page_count":{"description":"The number of pages returned for the request made.","type":"integer","example":1},"page_size":{"default":30,"description":"The number of records returned within a single API call.","maximum":300,"type":"integer","example":30},"total_records":{"description":"The number of all records available across pages.","type":"integer","example":1},"issue_details":{"items":{"properties":{"issue":{"description":"Zoom Room Issue Detail.<br> The value of the this field could be one of the following:<br>\n* `Room Controller disconnected`<br>\n* `Room Controller connected`\n* `Selected camera has disconnected`\n* `Selected camera is reconnected`\n* `Selected microphone has disconnected`\n* `Selected microphone is reconnected`\n* `Selected speaker has disconnected`\n* `Selected speaker is reconnected`\n* `Zoom room is offline`\n* `Zoom room is onlin