{"openapi":"3.0.0","info":{"title":"Accounts Master API","description":"The Zoom Account APIs allow developers to programatically access data related to accounts, dashboards, information barriers, and roles.","termsOfService":"https://zoom.us/docs/en-us/zoom_api_license_and_tou.html","contact":{"name":"Zoom Developers","url":"https://developer.zoom.us/"},"version":"2"},"externalDocs":{"description":"Find out more about Swagger","url":"https://swagger.io"},"servers":[{"url":"https://api.zoom.us/v2"}],"paths":{"/accounts":{"get":{"tags":["Accounts"],"summary":"List sub accounts","description":"List all subaccounts created by a master account.\n\n Zoom allows only [approved partners](https://developers.zoom.us/docs/api/rest/master-account-apis/) to use master APIs and manage subaccounts. Email the partner programs team at **partner-success@zoom.us** for more details.\n\n  \n **Prerequisites:**  \n \n* Pro or a higher paid account with master account option enabled.   \n \n\n\n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `account:master`\n\n**[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `account:read:list_sub_accounts:master`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`","operationId":"accounts","parameters":[{"name":"page_size","in":"query","description":"The number of records returned within a single API call.","required":false,"schema":{"maximum":300,"type":"integer","example":30,"default":30}},{"name":"page_number","in":"query","description":"**Deprecated** We will no longer support this field in a future release. Instead, use the `next_page_token` for pagination.","required":false,"schema":{"type":"integer","example":1,"default":1}},{"name":"next_page_token","in":"query","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.","required":false,"schema":{"type":"string","example":"IAfJX3jsOLW7w3dokmFl84zOa0MAVGyMEB2"}},{"name":"sub_reseller_id","in":"query","description":"The sub-reseller's ID. \n\n If you use this query parameter, the API returns all the subaccounts created by the sub-reseller account.","required":false,"schema":{"type":"string","example":"q6gBJVO5TzexKYTb_I2rpg"}},{"name":"phone_number","in":"query","description":"The account owner's first phone number displayed on account profile. It should be translated to Encode URI. It also support an entire ZP number.","required":false,"schema":{"type":"string","example":"+86 15172535548"}},{"name":"email","in":"query","description":"The account owner's email address. It should be translated to Encode URI.","required":false,"schema":{"type":"string","example":"jerry.jia@zoom.us"}},{"name":"zoom_account_number","in":"query","description":"The Zoom account number.","required":false,"schema":{"type":"number","example":123456}}],"responses":{"200":{"description":"Account list returned.","content":{"application/json":{"schema":{"allOf":[{"type":"object","properties":{"next_page_token":{"type":"string","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.","example":"w7587w4eiyfsudgf"},"page_count":{"type":"integer","description":"The number of pages returned for the request made.","example":1},"page_number":{"type":"integer","description":"**Deprecated** We will no longer support this field in a future release. Instead, use the `next_page_token` for pagination.","example":1,"deprecated":true,"default":1},"page_size":{"maximum":300,"type":"integer","description":"The number of records returned with a single API call.","example":30,"default":30},"total_records":{"type":"integer","description":"The total number of all the records available across pages.","example":20}},"description":"Pagination object."},{"type":"object","properties":{"accounts":{"type":"array","description":"List of account objects.","items":{"type":"object","properties":{"account_name":{"type":"string","description":"Account name.","example":"jchill"},"account_number":{"type":"number","description":"The account's account number.","example":10010370036},"account_type":{"type":"string","description":"Account type.","example":"Free"},"created_at":{"type":"string","description":"Account creation date and time.","format":"date-time","example":"2022-03-24T17:46:53Z"},"id":{"type":"string","description":"Account ID.","example":"q6gBJVO5TzexKYTb_I2rpg"},"owner_email":{"type":"string","description":"Account owner email.","example":"john.doe@zoom.us"},"seats":{"type":"integer","description":"Account seats.","example":0},"subscription_end_time":{"type":"string","description":"Account subscription end date and time.","format":"date-time","example":"2022-03-24T17:46:53Z"},"subscription_start_time":{"type":"string","description":"Account subscription start date and time.","format":"date-time","example":"2022-03-24T17:46:53Z"},"reseller":{"type":"boolean","description":"Indicates whether or not the account is a sub-reseller.","example":true},"bulk_license":{"type":"boolean","description":"Indicates whether or not the account has bulk license.","example":true}}}}},"description":"Account object in the account list."}]}}}},"429":{"description":"**HTTP Status Code:** `429` <br>\n Too Many Requests. For more information, see [rate limits](https://developers.zoom.us/docs/api/rest/rate-limits/). \n\n "}},"security":[{"openapi_authorization":[]}],"x-extensions":{"x-permissions":["SubAccount:Edit","SubAccount:Read"],"x-macro-scopes":["account:master"],"x-granular-scopes":["account:read:list_sub_accounts:master"]}},"post":{"tags":["Accounts"],"summary":"Create a sub account","description":"Create a subaccount under a master account. The new subaccount will receive a confirmation email. \n\n Zoom only allows only approved partners to use [master account APIs](https://marketplace.zoom.us/docs/api-reference/master-account-apis) and manage subaccounts. For more information, contact the [Zoom Partners team](https://partner.zoom.us/) at [partner-success@zoom.us](mailto:partner-success@zoom.us). \n\n **Prerequisites:** \n* A Pro or a higher paid account with master account option enabled.\n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `account:master`\n\n**[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `account:write:sub_account:master`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`","operationId":"accountCreate","requestBody":{"content":{"application/json":{"schema":{"required":["email","first_name","last_name","password"],"type":"object","properties":{"account_name":{"maxLength":64,"type":"string","description":"The subaccount's name. If you do not pass this value, the account name will be a concatenation of the `first_name` and `last_name` parameters.","example":"jchill"},"email":{"maxLength":128,"type":"string","description":"The user's email address.","example":"jchill@example.com"},"first_name":{"maxLength":64,"type":"string","description":"The user's first name.","example":"Jill"},"last_name":{"maxLength":64,"type":"string","description":"The user's last name.","example":"Chill"},"options":{"type":"object","properties":{"billing_auto_renew":{"type":"boolean","description":"Whether to enable automatic billing renewal.","example":false,"deprecated":true},"meeting_connector_list":{"type":"array","description":"A comma-separated list of Meeting Connector IP addresses shared with the subaccount. If you do not provide a value for this field, all the master account's Meeting Connectors will be shared with the subaccount. \n\n **Note:** You can only use this field if `share_mc` value is `true`.","items":{"type":"string","example":"203.0.113.1"}},"resource_meeting_hybrid_list":{"maxItems":999,"type":"array","description":"A comma-separated list of Meeting Hybrid zone name shared with the subaccount. If you do not provide a value for this field, all the master account's Meeting Connectors will be shared with the subaccount. \n\n.","items":{"type":"string","example":"meeting_hybrid_resouceA"}},"resource_meeting_connector_list":{"maxItems":999,"type":"array","description":"A comma-separated list of Meeting Connector resource name shared with the subaccount. If you do not provide a value for this field, all of the master account's meeting connector will be shared with the subaccount. \n\n","items":{"type":"string","example":"meeting_connector_resourceA"}},"resource_share_mc":{"type":"boolean","description":"Whether to enable the option for a subaccount to use the master account's shared resource Meeting Connectors.Meeting Connectors are only available for On-Premise accounts. \n\n This value defaults to `false`.","example":false,"default":false},"resource_share_mh":{"type":"boolean","description":"Whether to enable the option for a subaccount to use the master account's shared resource Meeting Hybrid. Meeting Hybrid are only available for On-premise accounts. \n\n This value defaults to `false`.","example":false,"default":false},"pay_mode":{"type":"string","description":"The account's payee. \n* `master` - The master account holder pays. \n* `sub` - The subaccount holder pays. \n\n This value defaults to `master`.","example":"master","default":"master","enum":["master","sub"]},"room_connector_list":{"type":"array","description":"A comma-separated list of VRC IP addresses shared with the subaccount. If you do not provide a value for this field, all of the master account's VRCs will be shared with the subaccount. \n\n **Note:** You can only use this field if `share_rc` value is `true`.","items":{"type":"string","example":"[\"192.0.2.1\",\"198.51.100.1\"]"}},"share_mc":{"type":"boolean","description":"Whether to enable the option for a subaccount to use the master account's shared [Meeting Connectors](https://support.zoom.us/hc/en-us/articles/201363093). Meeting Connectors are only available for On-Premise accounts. \n\n This value defaults to `false`.","example":false,"default":false},"share_rc":{"type":"boolean","description":"Whether to enable the option for a subaccount to use the master account's shared [Virtual Room Connectors (VRC)](https://support.zoom.us/hc/en-us/articles/202134758-Deploying-the-Virtual-Room-Connector). VRCs are only available for On-premise accounts. \n\n This value defaults to `false`.","example":false,"default":false}},"description":"Information about the account's options."},"password":{"minimum":8,"type":"string","description":"The subaccount's password. \n\n**Note:** If the account owner or admin has enabled [enhanced password requirements](https://support.zoom.us/hc/en-us/articles/360034675592-Advanced-security-settings#h_fa9186e4-6818-4f7a-915c-2e25c19f0acd), the value provided in this field must meet those requirements. You can get these requirements via the [**Get account settings**](/docs/api-reference/zoom-api/ma#operation/accountSettings) API. Reference the `password_requirement` object in the `security` object of the API response.","example":"if42!LfH@"},"sub_reseller_id":{"type":"string","description":"The sub-reseller's ID. To create a [third-tier subaccount](https://marketplace.zoom.us/docs/api-reference/master-account-apis/), pass the second-level master account's ID. \n\nIf you do not provide this field, a new subaccount will be created for the account that calls the API.","example":"ABCDEF12345"},"transfer_code":{"maxLength":512,"type":"string","description":"Account transfer code to transfer account to current parenter","example":"AIr7emjkNxUD4O5Q73H-Jr8ZmVGHMOsSAOps9B6-bB4.AG.hCTluR6maAXj8CZ9Bs7xm1eDfqT5Lct4WczDkqIahVK7BdMfR8Ps7_JDRtfZr-6Hci7IOyDVCc_5xTkdVrdl50NNgfZcl4NflffxgoYNMQ34Sr_vKYGvJ3eNmnv2i-qp7c24c1b6lU3APJqtxwKkm8CKmc7iyu6WlcLLILSgAlDifo4SjBVfiSC-.z_WNrlV6aXoeWpc7pKJnfA.50Jl_yAYazRkzoVR"}},"description":"The new subaccount's information. The subaccount's owner is the user who created the subaccount or had an account created for them. For more information about Zoom's account structure, read our [Zoom Account Structures](https://medium.com/zoom-developer-blog/a-brief-look-at-zoom-account-structures-1d19c745bf8a) documentation."}}}},"responses":{"201":{"description":"Account successfully created.","content":{"application/json":{"schema":{"type":"object","properties":{"created_at":{"type":"string","description":"The subaccount's creation date and time.","format":"date-time","example":"2021-07-21T17:32:28Z"},"id":{"type":"string","description":"The subaccount's ID.","example":"NfIX2NPgQ-mLjHOybvftuv"},"owner_email":{"type":"string","description":"The subaccount owner's email address.","format":"email","example":"admin@example.com"},"owner_id":{"type":"string","description":"The account owner's ID.","example":"tsmith@example.com"}},"description":"Information about the created subaccount."}}}},"400":{"description":"**HTTP Status Code:** `400` <br>\n Bad Request  \n\n **Error Code:** `300` <br>\n * Your request could not be completed because the name contains an invalid word: {name} \n* Your request was not accepted because \"{field}\" contains special character(s). <br>\n**Error Code:** `1107` <br>\n Email domain is blocked. <br>\n**Error Code:** `1111` <br>\n * Password should not contain repeated characters such as \"aaaaaa\". \n* Password should not contain consecutive characters such as \"abc\" or \"123\". <br>\n**Error Code:** `11101` <br>\n Account transfer disabled. Please remove the transfer token and try again. <br>\n**Error Code:** `11102` <br>\n Invalid account transfer token. <br>\n**Error Code:** `11103` <br>\n User email does not exist. <br>\n**Error Code:** `11104` <br>\n Account transfer email and request body email do not match. Please try again. <br>\n**Error Code:** `11105` <br>\n Account transfer token expired. <br>\n**Error Code:** `11106` <br>\n Account transfer token and master Zoom account number do not match. <br>\n**Error Code:** `11107` <br>\n Account transfer token already used. <br>\n**Error Code:** `11108` <br>\n Account transfer is only available for free users. <br>\n**Error Code:** `11109` <br>\n Account transfer is still processing in the backend. Please try again later. <br>\n**Error Code:** `11110` <br>\n Account already exists. <br>\n**Error Code:** `11111` <br>\n Account transfer does not support subaccounts. <br>\n**Error Code:** `11112` <br>\n Account transfer only supports free accounts. <br>\n"},"409":{"description":"**HTTP Status Code:** `409` <br>\n Conflict  \n\n **Error Code:** `1005` <br>\n Email \"$email\" has already been used. <br>\n"},"429":{"description":"**HTTP Status Code:** `429` <br>\n Too Many Requests. For more information, see [rate limits](https://developers.zoom.us/docs/api/rest/rate-limits/). \n\n "}},"security":[{"openapi_authorization":[]}],"x-extensions":{"x-permissions":["SubAccount:Edit","SubAccount:Read"],"x-macro-scopes":["account:master"],"x-granular-scopes":["account:write:sub_account:master"]}}},"/accounts/{accountId}":{"get":{"tags":["Accounts"],"summary":"Get sub account details","description":"Retrieve information about a master account's sub account. \n\n Zoom only allows approved partners to use [master account APIs](https://developers.zoom.us/docs/api/rest/master-account-apis/) and create sub accounts. For information about partner programs, email the partners team at [partner-success@zoom.us](mailto:partner-success@zoom.us).\n* To get a master account's details, use the account:read:sub_account:admin scope. Enter me as the value of the accountId path parameter.\n* To get a subaccount's details, use use the account:read:sub_account:master scope. Enter the subaccount's actual account ID as the value of the accountId path parameter.\n\n **Prerequisites** \n* A Pro or a higher paid account with the Master account option enabled.\n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `account:master`\n\n**[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `account:read:sub_account:master`,`account:read:sub_account:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`","operationId":"GetSubAccountDetails","parameters":[{"name":"accountId","in":"path","description":"The account's ID.","required":true,"schema":{"type":"string","example":"ABCDEF123456"}}],"responses":{"200":{"description":"**HTTP Status Code**: `200`  \n \n Account object returned.","content":{"application/json":{"schema":{"type":"object","properties":{"account_name":{"type":"string","description":"The account's name.","example":"Account1"},"account_number":{"type":"integer","description":"The account's account number.","example":123456789},"account_type":{"type":"string","description":"The account type. \n* `Free` \n* `Pro` \n* `Enterprise` \n* `API Partner` \n* `Education` \n* `Business` \n* `Free Trial` \n* `Bulk License` \n* `Zoom Rooms` \n* `Zoom Video SDK` \n* `Zoom Phone`","example":"Pro","enum":["Free","Pro","Enterprise","API Partner","Education","Business","Free Trial","Bulk License","Zoom Rooms","Zoom Video SDK","Zoom Phone"]},"created_at":{"type":"string","description":"The account's creation date and time.","format":"date-time","example":"2021-07-21T17:32:28Z"},"id":{"type":"string","description":"The account ID.","example":"ABCDEF123456"},"options":{"type":"object","properties":{"billing_auto_renew":{"type":"boolean","description":"Whether to enable automatic billing renewal.","example":false},"meeting_connector_list":{"type":"array","description":"A comma-separated list of Meeting Connector IP addresses shared with the sub account. If you do not provide a value for this field, all of the master account's meeting connectors will be shared with the sub account. \n\n **Note:** You can only use this field if `share_mc` value is `true`.","items":{"type":"string","example":"203.0.113.1"}},"pay_mode":{"type":"string","description":"The account's payee. \n* `master` - The Master account holder pays. \n* `sub` - The sub account holder pays. \n\n This value defaults to `master`.","example":"master","default":"master","enum":["master","sub"]},"room_connector_list":{"type":"array","description":"A comma-separated list of VRC IP addresses shared with the sub account. If you do not provide a value for this field, all of the master account's VRCs will be shared with the sub account. \n\n **Note:** You can only use this field if `share_rc` value is `true`.","items":{"type":"string","example":"[\"192.0.2.1\",\"198.51.100.1\"]"}},"share_mc":{"type":"boolean","description":"Whether to enable the option for a sub account to use the master account's shared [Meeting Connectors](https://support.zoom.us/hc/en-us/articles/201363093). Meeting Connectors are only available for On-Premise accounts. \n\n This value defaults to `false`.","example":false,"default":false},"share_rc":{"type":"boolean","description":"Whether to enable the option for a sub account to use the master account's shared [Virtual Room Connectors (VRC)](https://support.zoom.us/hc/en-us/articles/202134758-Deploying-the-Virtual-Room-Connector). VRCs are only available for On-premise accounts. \n\n This value defaults to `false`.","example":false,"default":false},"resource_meeting_hybrid_list":{"maxItems":999,"type":"array","description":"A comma-separated list of Meeting Hybrid zone name shared with the subaccount. If you do not provide a value for this field, all the master account's Meeting Connectors will be shared with the subaccount. \n\n.","items":{"type":"string","example":"meeting_hybrid_resouceA"}},"resource_meeting_connector_list":{"maxItems":999,"type":"array","description":"A comma-separated list of Meeting Connector resourece name shared with the subaccount. If you do not provide a value for this field, all of the master account's meeting connector will be shared with the subaccount. \n\n","items":{"type":"string","example":"meeting_connector_resourceA"}},"resource_share_mc":{"type":"boolean","description":"Whether to enable the option for a sub account to use the master account's shared resource Meeting Connectors. Meeting Connectors are only available for On-Premise accounts. \n\n This value defaults to `false`.","example":false,"default":false},"resource_share_mh":{"type":"boolean","description":"Whether to enable the option for a sub account to use the master account's shared resource Meeting Hybrid. Meeting Hybrid are only available for On-premise accounts. \n\n This value defaults to `false`.","example":false,"default":false}},"description":"Information about the account's options."},"owner_email":{"type":"string","description":"The account owner's email address.","format":"email","example":"jchill@example.com"},"owner_id":{"type":"string","description":"The account owner ID.","example":"654321FEDCBA"},"seats":{"type":"integer","description":"The account's maximum number of paid seats.","example":1},"subscription_end_time":{"type":"string","description":"The account's subscription end date and time. This field only returns if there is a subscription end date and time.","format":"date-time","example":"2022-07-21T17:32:28Z"},"subscription_start_time":{"type":"string","description":"The account's subscription start date and time. If there is no subscription start date and time, this returns an empty string value.","format":"date-time","example":"2021-07-21T17:32:28Z"},"vanity_url":{"type":"string","description":"The account's [vanity URL](https://support.zoom.us/hc/en-us/articles/201363233-Customizing-branding-for-your-vanity-URL).","format":"url","example":"https://vanity.example.com"},"reseller":{"type":"boolean","description":"The account is reseller or not.","example":false}}}}}},"404":{"description":"**HTTP Status Code:** `404` <br>\n Not Found  \n\n **Error Code:** `2001` <br>\n Account does not exist: $subAccountId <br>\n"},"429":{"description":"**HTTP Status Code:** `429` <br>\n Too Many Requests. For more information, see [rate limits](https://developers.zoom.us/docs/api/rest/rate-limits/). \n\n "}},"security":[{"openapi_authorization":[]}],"x-extensions":{"x-permissions":["SubAccount:Edit","SubAccount:Read"],"x-macro-scopes":["account:master"],"x-granular-scopes":["account:read:sub_account:master","account:read:sub_account:admin"]}},"delete":{"tags":["Accounts"],"summary":"Disassociate a sub account","description":"Disassociate a sub account from its master account. This leaves the sub account intact, but it will no longer be associated with the master account.\n\n\n**Prerequisites**\n* Pro or a higher paid account with master account option enabled.   \n\n* The account making this API request must be a [master account](https://developers.zoom.us/docs/api/rest/master-account-apis/).\n\n\n\n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `account:master`,`account:write:master`\n\n**[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `account:delete:sub_account:master`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`","operationId":"DisassociateASubAccount","parameters":[{"name":"accountId","in":"path","required":false,"schema":{"type":"string"}}],"responses":{"204":{"description":"**HTTP Status Code**: `204`  \n Account deleted."},"404":{"description":"**HTTP Status Code:** `404` <br>\n Not Found \n\n **Error Code:** `2000` <br>\n You cannot disassociate a paid account. <br> <br>\n**Error Code:** `2001` <br>\n Account does not exist: $subAccountId. <br>\n"},"429":{"description":"**HTTP Status Code:** `429` <br>\n Too Many Requests. For more information, see [rate limits](https://developers.zoom.us/docs/api/rest/rate-limits/). \n\n "}},"security":[{"openapi_authorization":[]}],"x-extensions":{"x-permissions":["SubAccount:Edit","SubAccount:Read"],"x-macro-scopes":["account:master","account:write:master"],"x-granular-scopes":["account:delete:sub_account:master"]}}},"/accounts/{accountId}/lock_settings":{"get":{"tags":["Accounts"],"summary":"Get locked settings","description":"Retrieves an account's locked settings. \n\n Account admins and account owners can use [Account Locked Settings](https://support.zoom.us/hc/en-us/articles/115005269866) to toggle settings on or off for all users in their account. \n\n\n**Note:** You can use Account Locked Settings with accounts that have master and sub accounts enabled.   \n   \n \n**Prerequisites:**\n* Pro or a higher paid account.   \n \n\n\n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `account:read:admin`,`account:write:admin`\n\n**[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `account:read:lock_settings:master`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`","operationId":"getAccountLockSettings","parameters":[{"name":"accountId","in":"path","required":true,"schema":{"type":"string"}},{"name":"option","in":"query","description":"Optional query parameters: \n* `meeting_security` &mdash; Use this query parameter to view the meeting security settings applied to the user's account.","required":false,"schema":{"type":"string","example":"meeting_security"}},{"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 &quot;host_video&quot; as the value of this field, you will get a response similar to the following:  \n \n{\n    &quot;schedule_meeting&quot;: {\n        &quot;host_video&quot;: false\n    }\n}\n  \n You can provide multiple values by separating them with commas(example: &quot;host_video,participant_video&rdquo;).","required":false,"schema":{"type":"string","example":"in_meeting"}}],"responses":{"200":{"description":"**Error Code:** `200`  \n \nOnly available for paid account:$accountId.\n\n**HTTP Status Code:** `200`  \n \nLocked settings for the Account returned.\n\n","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"audio_conferencing":{"type":"object","properties":{"toll_free_and_fee_based_toll_call":{"type":"boolean","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.","example":true},"toll_call":{"type":"boolean","description":"Whether the account has the [**Toll Call**](https://support.zoom.com/hc/en/article?id=zm_kb&sysparm_article=KB0066909#h_01F51680NJ7YHZDXGJNSKDGM2P) setting enabled.","example":true},"call_me_and_invite_by_phone":{"type":"boolean","description":"Whether the account has the [**Call Me and Invite by Phone**](https://support.zoom.com/hc/en/article?id=zm_kb&sysparm_article=KB0067414#h_01F53VFZMDP4EJAF772N7NG2KY) setting enabled.","example":true},"personal_audio_conference":{"type":"boolean","description":"Whether the account has the [**Personal Audio Conference**](https://support.zoom.com/hc/en/article?id=zm_kb&sysparm_article=KB0060449#h_01F5BPMEB7GK6XXPKHDBHYFF27) setting enabled.","example":true},"participant_phone_masking":{"type":"boolean","description":"Whether the account has the [**Mask phone number in the participant list**](https://support.zoom.com/hc/en/article?id=zm_kb&sysparm_article=KB0067881#h_01F5K5GT9P563K751K3JNAYE6E) setting enabled.","example":true}},"description":"Account Audio Conference Settings"},"chat":{"type":"object","properties":{"share_files":{"type":"boolean","description":"Users can share files in chats and channels.","example":true},"chat_emojis":{"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 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.","example":true},"record_voice_messages":{"type":"boolean","description":"Allow users to record voice messages that can be sent in direct messages or group conversations.","example":true},"record_video_messages":{"type":"boolean","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.","example":true},"screen_capture":{"type":"boolean","description":"Allow users to take and send screenshots in direct messages or group conversations.","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":{"type":"boolean","description":"Whether to allow users to add contacts.","example":true},"allow_users_to_chat_with_others":{"type":"boolean","description":"Whether to Allow users to chat with others.","example":true},"chat_etiquette_tool":{"type":"boolean","description":"Whether to enable the **Chat Etiquette Tool**.","example":true},"send_data_to_third_party_archiving_service":{"type":"boolean","description":"Whether to send data to third-party archiving service.","example":true},"translate_messages":{"type":"boolean","description":"Allow users to translate team chat messages. [Learn more].(https://support.zoom.us/hc/en-us/articles/12998089084685)","example":true},"search_and_send_animated_gif_images":{"type":"boolean","description":"Whether to allow users to search GIF images from GIPHY when they compose messages.","example":true},"shared_spaces":{"type":"boolean","description":"Whether to allow users to create Shared Spaces.","example":true},"allow_create_channels_and_group_chats":{"type":"boolean","description":"Whether to allow users to create channels and group chats.","example":true},"allow_huddles_from_channels":{"type":"boolean","description":"Whether to allow huddles from channels.","example":true},"download_file":{"type":"boolean","description":"Whether to allow users to downloading files.","example":true},"share_screen_in_chat":{"type":"boolean","description":"Whether to allow users to share screen in chat.","example":true},"chat_email_address":{"type":"boolean","description":"Chat email address.","example":true},"read_receipts":{"type":"boolean","description":"Whether to enable read receipts.","example":true},"allow_delete_message":{"type":"boolean","description":"Whether to allow users to delete messages.","example":true},"allow_edit_message":{"type":"boolean","description":"Whether to allow users to edit messages.","example":true},"presence_on_meeting":{"type":"boolean","description":"Change my presence status when I am in a meeting or call.","example":true},"presence_away_when_screen_saver":{"type":"boolean","description":"Change my status to away when screen saver begins.","example":true},"ai_summary":{"type":"boolean","description":"The field has been moved from the `chat` object to the `ai` object and renamed to `chat_summary` to better reflect its functionality.\n\nSummarize with AI Companion.","example":true,"deprecated":true},"ai_compose":{"type":"boolean","description":"The field has been moved from the `chat` object to the `ai` object and renamed to `chat_compose` to better reflect its functionality.\n\nCompose with AI Companion.","example":true,"deprecated":true},"ai_recommend":{"type":"boolean","description":"**Zoom no longer supports this feature.**\n\nChat Recommendation with Zoom AI Companion.","example":true,"deprecated":true},"ai_reply":{"type":"boolean","description":"**Zoom no longer supports this feature.**\n\nQuick reply with AI Companion.","example":true,"deprecated":true},"ai_sentence_completion":{"type":"boolean","description":"**Zoom no longer supports this feature.**\n\nSentence completion with AI Companion.","example":true,"deprecated":true},"ai_quick_schedule":{"type":"boolean","description":"Quick schedule with AI Companion.","example":true},"survey_poll":{"type":"boolean","description":"Allow users to launch a poll in chats and channels.","example":true}}},"email_notification":{"type":"object","properties":{"alternative_host_reminder":{"type":"boolean","description":"Notify the alternative host who is set or removed.","example":true},"cancel_meeting_reminder":{"type":"boolean","description":"Notify host and participants when the meeting is cancelled.","example":true},"cloud_recording_available_reminder":{"type":"boolean","description":"Whether to notify the host when a cloud recording is available.","example":true},"jbh_reminder":{"type":"boolean","description":"Notify host when participants join the meeting before them.","example":true},"schedule_for_reminder":{"type":"boolean","description":"Notify the host there is a meeting is scheduled, rescheduled, or cancelled.","example":true}}},"in_meeting":{"type":"object","properties":{"alert_guest_join":{"type":"boolean","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.","example":true},"allow_users_to_delete_messages_in_meeting_chat":{"type":"boolean","description":"If the value of this field is set to `true`,  allow users to delete messages in the in-meeting chat.\n","example":true},"allow_live_streaming":{"type":"boolean","description":"Whether to allow livestreaming.","example":true},"allow_show_zoom_windows":{"type":"boolean","description":"Show Zoom windows during screen share.","example":true},"annotation":{"type":"boolean","description":"Allow participants to use annotation tools to add information to shared screens.","example":true},"anonymous_question_answer":{"type":"boolean","example":true},"attendee_on_hold":{"type":"boolean","description":"Allow host to put attendee on hold.\n\n**This field has been deprecated and is no longer supported.**","example":true,"deprecated":true,"default":false},"attention_mode_focus_mode":{"type":"boolean","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`.","example":true,"default":false},"auto_answer":{"type":"boolean","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.","example":true},"auto_generated_captions":{"type":"boolean","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).","example":true},"auto_saving_chat":{"type":"boolean","description":"Automatically save all in-meeting chats.","example":true},"breakout_room":{"type":"boolean","description":"Allow host to split meeting participants into separate, smaller rooms.","example":true},"chat":{"type":"boolean","description":"Allow meeting participants to send chat message visible to all participants.","example":true},"meeting_question_answer":{"type":"boolean","description":"Allow participants to ask questions for the host and participants to answer.","example":true},"closed_caption":{"type":"boolean","description":"Allow host to type closed captions or assign a participant/third party device to add closed captions.","example":true},"co_host":{"type":"boolean","description":"Allow the host to add co-hosts. Co-hosts have the same in-meeting controls as the host.","example":true},"custom_data_center_regions":{"type":"boolean","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.","example":true},"disable_screen_sharing_for_host_meetings":{"type":"boolean","description":"Whether to enable the **Disable desktop screen sharing for meetings you host** setting.","example":true},"disable_screen_sharing_for_in_meeting_guests":{"type":"boolean","description":"Whether to enable the **Disable screen sharing when guests are in the meeting** setting.","example":true},"dscp_marking":{"type":"boolean","description":"Enable DSCP marking for signaling and media packets. (Default is 56 for audio, 40 for video, and 40 for signaling.) ","example":true},"e2e_encryption":{"type":"boolean","description":"Require that all meetings are encrypted using AES.","example":true},"entry_exit_chime":{"type":"string","description":"Play sound when participants join or leave.","example":"none"},"far_end_camera_control":{"type":"boolean","description":"Allow another user to take control of the camera during a meeting.","example":true},"feedback":{"type":"boolean","description":"Enable users to provide feedback to Zoom at the end of the meeting.","example":true},"file_transfer":{"type":"boolean","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.","example":true},"full_transcript":{"type":"boolean","description":"Whether full transcripts are available for viewing in the in-meeting side panel.","example":true},"group_hd":{"type":"boolean","description":"Enable higher quality video for host and participants in Meeting. This will require more bandwidth.","example":true},"webinar_group_hd":{"type":"boolean","description":"Enable higher quality video for host and participants in Webinar. This will require more bandwidth.","example":true},"language_interpretation":{"type":"boolean","description":"Whether hosts can assign participants as interpreters to interpret one language into another in real-time.","example":true},"sign_language_interpretation":{"type":"boolean","description":"Allow hosts to assign participants as sign language interpreters who can interpret one language into sign language in real-time. Hosts can assign interpreters when scheduling, or during the meeting itself. This feature is only available with version 5.11.3 or later.","example":true},"manual_captions":{"type":"boolean","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.","example":true},"meeting_reactions":{"type":"boolean","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.","example":true},"webinar_reactions":{"type":"boolean","description":"Set this field to true to use [webinar reactions](https://support.zoom.us/hc/en-us/articles/4803536268429).","example":true},"meeting_survey":{"type":"boolean","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.","example":true},"original_audio":{"type":"boolean","description":"Allow users to select original sound during a meeting.","example":true},"polling":{"type":"boolean","description":"Add 'Polls' to the meeting controls. This allows the host to survey the attendees.","example":true},"post_meeting_feedback":{"type":"boolean","description":"Display end-of-meeting experience feedback survey.","example":true},"private_chat":{"type":"boolean","description":"Allow meeting participants to send a private 1:1 message to another participant.","example":true},"remote_control":{"type":"boolean","description":"During screen sharing, allow the person who is sharing to let others control the shared content.","example":true},"non_verbal_feedback":{"type":"boolean","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`.","example":true,"default":false},"remote_support":{"type":"boolean","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`.","example":true,"default":false},"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":{"type":"boolean","description":"Whether participants can save closed captions or transcripts.","example":true},"save_captions":{"type":"boolean","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.","example":true},"screen_sharing":{"type":"boolean","description":"Allow host and participants to share their screen or content during meetings.","example":true},"sending_default_email_invites":{"type":"boolean","description":"Allow users to invite participants by email only by default.","example":true},"show_meeting_control_toolbar":{"type":"boolean","description":"Always show meeting controls during a meeting.","example":true},"slide_control":{"type":"boolean","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.","example":true},"stereo_audio":{"type":"boolean","description":"Allow users to select stereo audio during a meeting.","example":true},"use_html_format_email":{"type":"boolean","description":"Allow  HTML formatting instead of plain text for meeting invitations scheduled with the Outlook plugin.","example":true},"virtual_background":{"type":"boolean","description":"Enable virtual background.","example":true},"webinar_chat":{"type":"boolean","description":"Whether to allow webinar participants to send chat messages.","example":true},"webinar_live_streaming":{"type":"boolean","description":"Whether to enable webinar livestreaming.","example":true},"webinar_polling":{"type":"boolean","description":"Whether the host can add polls before or during a webinar.","example":true},"webinar_question_answer":{"type":"boolean","description":"Whether attendees can ask the host and panelists questions in the webinar.","example":true},"webinar_survey":{"type":"boolean","description":"Whether the host can present surveys to attendees once a webinar has ended.","example":true},"whiteboard":{"type":"boolean","description":"Allow participants to share a whiteboard that includes annotation tools.","example":true},"meeting_summary_with_ai_companion":{"type":"object","properties":{"locked":{"type":"boolean","description":"Whether to lock the setting that allows hosts to generate a summary.","example":true},"auto_enable_locked":{"type":"boolean","description":"Whether to lock the setting that automatically turns on meeting summary when meetings start.","example":true},"who_will_receive_summary_locked":{"type":"boolean","description":"Whether to lock the setting that defines who will receive a summary after the meeting.","example":true},"summary_template_locked":{"type":"boolean","description":"Whether to lock the setting that allows users to select a meeting summary template for their meetings.","example":true}},"description":"Whether a host can generate a meeting summary with AI Companion. Summaries are sent after the meeting ends based on the share options."},"ai_companion_questions":{"type":"object","properties":{"locked":{"type":"boolean","description":"Whether to lock the setting that allows hosts and invited participants to ask questions to AI Companion during a meeting.","example":true},"auto_enable_locked":{"type":"boolean","description":"Whether to lock the setting that automatically allows access when the meeting starts.","example":true},"who_can_ask_questions_locked":{"type":"boolean","description":"Whether to lock the setting that defines who can ask questions about the meeting's transcript.","example":true}},"description":"Whether to allow hosts and invited participants to ask questions to AI Companion during a meeting. Questions are answered based on the conversation transcript."}}},"other_options":{"type":"object","properties":{"blur_snapshot":{"type":"boolean","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.","example":true},"webinar_registration_options":{"type":"boolean","description":"Webinar registration options.","example":true}}},"recording":{"type":"object","properties":{"account_user_access_recording":{"type":"boolean","description":"Make cloud recordings accessible to account members only.","example":true},"auto_delete_cmr":{"type":"boolean","description":"Allow Zoom to automatically delete recordings permanently after a specified number of days.","example":true},"auto_recording":{"type":"boolean","description":"Record meetings automatically as they start.","example":true},"cloud_recording":{"type":"boolean","description":"Allow hosts to record and save the meeting / webinar in the cloud.","example":true},"cloud_recording_download":{"type":"boolean","description":"Allow anyone with a link to the cloud recording to download.","example":true},"host_delete_cloud_recording":{"type":"boolean","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.","example":true},"ip_address_access_control":{"type":"boolean","description":"Setting to allow cloud recording access only from specific IP address ranges.\n","example":true},"local_recording":{"type":"boolean","description":"Allow hosts and participants to record the meeting to a local file.","example":true},"prevent_host_access_recording":{"type":"boolean","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","example":true},"recording_authentication":{"type":"boolean","description":"Only authenticated users can view cloud recordings","example":true},"archive":{"type":"boolean","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.","example":true}}},"schedule_meeting":{"type":"object","properties":{"audio_type":{"type":"boolean","description":"Determine how participants can join the audio portion of the meeting.","example":true},"embed_password_in_join_link":{"type":"boolean","description":"If the value is set to `true`, the meeting passcode will be encrypted and included in the join meeting link to allow participants to join with just one click without having to enter the passcode.\n ","example":true},"enforce_login":{"type":"boolean","description":"Allow only signed-in users to join meetings.\n","example":true},"enforce_login_domains":{"type":"string","description":"Specify the domains from which users can join a meeting.\n","example":"example.com"},"enforce_login_with_domains":{"type":"boolean","description":"Allow only signed-in users with specified domains to join meetings.\n","example":true},"host_video":{"type":"boolean","description":"Start meetings with host video on.","example":true},"join_before_host":{"type":"boolean","description":"Allow participants to join the meeting before the host arrives","example":true},"meeting_authentication":{"type":"boolean","description":"Only authenticated users can join meetings","example":true},"not_store_meeting_topic":{"type":"boolean","description":"Whether to enable the [**Always display &quot;Zoom Meeting&quot; as the meeting topic**](https://support.zoom.us/hc/en-us/articles/201363253-Changing-account-settings#h_01EG9BJ646V2WJK1S3H2MP6YV6) setting.","example":true},"always_display_zoom_webinar_as_topic":{"type":"boolean","description":"Whether to enable the [**Always show &quot;Zoom Webinar&quot; as the webinar topic**](https://support.zoom.us/hc/en-us/articles/201363253-Changing-account-settings#h_01EG9BJ646V2WJK1S3H2MP6YV6) setting.","example":false},"participant_video":{"type":"boolean","description":"Start meetings with participant video on.","example":true},"require_password_for_instant_meetings":{"type":"boolean","description":"Require passcode 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.","example":true},"require_password_for_pmi_meetings":{"type":"boolean","description":"Require participants to enter passcode 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.","example":true},"require_password_for_scheduling_new_meetings":{"type":"boolean","description":"This setting applies for regular meetings that do not use a PMI. If enabled, a passcode will be generated while a host schedules a new meeting and participants will be required to enter the passcode 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.","example":true},"use_pmi_for_instant_meetings":{"type":"boolean","description":"Use a Personal Meeting ID (PMI) when starting an instant meeting.","example":true},"use_pmi_for_scheduled_meetings":{"type":"boolean","description":"Use a Personal Meeting ID (PMI) when scheduling a meeting.","example":true},"continuous_meeting_chat":{"type":"boolean","description":"Whether to enable the [**Enable continuous meeting chat**] setting.","example":true}}},"telephony":{"type":"object","properties":{"telephony_regions":{"type":"boolean","description":"Indicates where most of the participants call into or call from during a meeting.","example":true},"third_party_audio":{"type":"boolean","description":"Allow users to join the meeting using the existing 3rd party audio configuration.","example":true}},"description":"Account Settings: Telephony."},"tsp":{"type":"object","properties":{"call_out":{"type":"boolean","description":"Call Out","example":true},"show_international_numbers_link":{"type":"boolean","description":"Show international numbers link on the invitation email","example":true},"display_toll_free_numbers":{"type":"boolean","description":"Display toll-free numbers","example":true}},"description":"Account Settings: TSP."},"ai":{"type":"object","properties":{"screen_share_ocr":{"type":"boolean","description":"Whether the screen_share_ocr setting is locked.","example":true},"meeting_chat_messages":{"type":"boolean","description":"Whether the meeting_chat_messages setting is locked.","example":true},"full_display_names_in_ai_assets":{"type":"boolean","description":"Whether the full_display_names_in_ai_assets setting is locked.","example":true},"ai_generated_virtual_backgrounds":{"type":"boolean","description":"Whether the ai_generated_virtual_backgrounds setting is locked.","example":true},"meeting_agenda":{"type":"boolean","description":"Whether the meeting_agenda setting is locked.","example":true},"meeting_summary_docs":{"type":"object","properties":{"enable":{"type":"boolean","description":"Whether automatic Zoom Doc creation is locked.","example":true},"share_with_summary_recipients":{"type":"boolean","description":"Whether sharing generated Zoom Docs with meeting summary recipients is locked.","example":false}},"description":"Lock settings for meeting summary Docs."},"phone_user_ai_notices":{"type":"object","properties":{"enable":{"type":"boolean","description":"Whether phone user AI notices are locked.","example":true}},"description":"Lock settings for phone user AI notices."},"meeting_summary_retention":{"type":"object","properties":{"enable":{"type":"boolean","description":"Whether automatic meeting summary deletion is locked.","example":true}},"description":"Lock settings for meeting summary retention."},"meeting_coach":{"type":"object","properties":{"enable":{"type":"boolean","description":"Whether Meeting Coach with AI is locked.","example":true}},"description":"Lock settings for Meeting Coach with AI."},"third_party_meeting_join":{"type":"object","properties":{"enable":{"type":"boolean","description":"Whether third-party meeting join with AI is locked.","example":true},"allow_recording":{"type":"boolean","description":"Whether recording for joined third-party meetings is locked.","example":true},"calendar":{"type":"object","properties":{"enable":{"type":"boolean","description":"Whether calendar-based third-party meeting join is locked.","example":true}},"description":"Lock settings for calendar-based third-party meeting join."},"pre_meeting_email_notification":{"type":"object","properties":{"enable":{"type":"boolean","description":"Whether pre-meeting email notification is locked.","example":true}},"description":"Lock settings for pre-meeting email notification."}},"description":"Lock settings for third-party meeting join with AI."},"whiteboard_content_generation":{"type":"boolean","description":"Whether Whiteboard content generation with AI is enabled.","example":true},"smart_recording":{"type":"object","properties":{"enable":{"type":"boolean","description":"Whether the Smart Recording is locked.","example":true}},"description":"Lock settings for Smart Recording."},"clips_summarization_generation":{"type":"object","properties":{"enable":{"type":"boolean","description":"Whether the clips summarization generation is locked.","example":true}},"description":"Lock settings for clips summarization generation."},"clips_create_video_with_aic":{"type":"object","properties":{"enable":{"type":"boolean","description":"Whether the clips create video with aic is locked.","example":true}},"description":"Lock settings for clips create video with aic."},"allow_user_create_customize_avatar":{"type":"object","properties":{"enable":{"type":"boolean","description":"Whether the clips allow user create customize avatar is locked.","example":true}},"description":"Lock settings for clips allow user create customize avatar."},"task_creation_and_management":{"type":"object","properties":{"enable":{"type":"boolean","description":"Whether task creation and management with AI is locked.","example":true}},"description":"Lock settings for task creation and management with AI."},"show_conversational_ai_companion":{"type":"object","properties":{"enabled":{"type":"boolean","description":"Whether conversational AI is locked.","example":true},"enable_zoom_mate":{"type":"boolean","description":"Whether ZoomMate availability is locked.","example":true},"delete_ai_conversation":{"type":"boolean","description":"Whether automatic AI conversation deletion is locked.","example":true},"delete_ai_conversation_time":{"type":"boolean","description":"Whether the AI conversation retention period is locked.","example":true}},"description":"Lock settings for the conversational AI companion."},"ai_panel_in_workplace":{"type":"object","properties":{"enabled":{"type":"boolean","description":"Whether the AI panel in Zoom Workplace is locked.","example":true},"delete_ai_conversation":{"type":"boolean","description":"Whether automatic AI conversation deletion in the AI panel is locked.","example":true},"delete_ai_conversation_time":{"type":"boolean","description":"Whether the AI panel conversation retention period is locked.","example":true}},"description":"Lock settings for the AI panel in Zoom Workplace."},"enable_ai_on_web":{"type":"boolean","description":"Whether Zoom AI on the web is locked.","example":true},"enable_email_compose_with_ai":{"type":"boolean","description":"Whether Zoom Mail AI compose is locked.","example":true},"microsoft_365":{"type":"object","properties":{"enable":{"type":"boolean","description":"Whether Microsoft 365 data sources are locked.","example":true}},"description":"Lock settings for Microsoft 365 data sources."},"google":{"type":"object","properties":{"enable":{"type":"boolean","description":"Whether Google data sources are locked.","example":true}},"description":"Lock settings for Google data sources."},"web_content":{"type":"boolean","description":"Whether Web content as an AI data source is locked.","example":true},"local_file_uploads":{"type":"boolean","description":"Whether Local file uploads as an AI data source are locked.","example":true},"organization_custom_dictionaries":{"type":"boolean","description":"Whether allowing AI to consume the organization's custom dictionaries is locked.","example":true},"third_party_app_tasks":{"type":"boolean","description":"Whether allowing AI to perform tasks in third-party apps is locked.","example":true},"workspace_reservation_recommendations_with_ai":{"type":"object","properties":{"enabled":{"type":"boolean","description":"Whether Workspace Reservation recommendations with AI are locked.","example":true}},"description":"Lock settings for Workspace Reservation recommendations with AI."},"participant_can_request_aic_in_meeting":{"type":"boolean","description":"Participants can request the host to start in-meeting AI features. The Boolean indicates whether this setting is locked.","example":false},"restrict_aic_when_external_user_join_meeting":{"type":"boolean","description":"Automatically restrict Zoom AI and transcription features when external users or groups join a meeting. The Boolean indicates whether this setting is locked.","example":false},"restrict_aic_when_restrict_user_join":{"type":"boolean","description":"When members of this group join a meeting, Zoom AI features will not be permitted for that session. This will only impact meetings within this organization. The Boolean indicates whether this setting is locked.","example":false},"restrict_users_from_joining_ai_enabled_meetings":{"type":"object","properties":{"enable":{"type":"boolean","description":"Whether users are restricted from joining meetings in which AI meeting processing (meeting questions and summary) is allowed. The Boolean indicates whether this setting is locked.","example":false}},"description":"Users would be restricted from joining meetings in which AI meeting processing (meeting questions and summary) is allowed. The nested Boolean properties indicate whether the corresponding setting is locked."},"meeting_questions":{"type":"object","properties":{"enable":{"type":"boolean","description":"Whether to allow hosts and invited participants to ask questions to AI Companion during a meeting. The Boolean indicates whether this setting is locked.","example":false},"auto_enable":{"type":"boolean","description":"Whether to automatically allow access when the meeting starts. The Boolean indicates whether this setting is locked.","example":false},"who_can_ask_questions":{"type":"boolean","description":"Defines who can ask questions about this meeting's transcript. The corresponding setting values are `from_entire_meeting` (all participants and invitees), `from_join_meeting` (all participants only from when they join), `host` (only the meeting host), `org` (participants and invitees in the organization), and `org_from_join_meeting` (participants in the organization only from when they join). The Boolean indicates whether this setting is locked.","example":false}},"description":"Zoom AI answers the meeting questions based on what is said in the meeting. If a transcript is retained, participants with access will be able to ask questions after the meeting based on that transcript. The nested Boolean properties indicate whether the corresponding setting is locked."},"meeting_summary":{"type":"object","properties":{"enable":{"type":"boolean","description":"Whether to allow hosts to generate a summary. The Boolean indicates whether this setting is locked.","example":false},"auto_enable":{"type":"boolean","description":"Whether to turn on meeting summary automatically when meetings start. The Boolean indicates whether this setting is locked.","example":false},"who_will_receive_summary":{"type":"boolean","description":"Automatically share summary with. The corresponding setting values are `host` (only meeting host), `alt_host` (only meeting host, co-hosts, and alternative hosts), `organization` (only meeting host and meeting invitees in our organization), and `all` (all meeting invitees including those outside of our organization). The Boolean indicates whether this setting is locked.","example":false}},"description":"Allow hosts to generate a summary. Summaries are sent based on sharing permissions after the meeting has ended. The nested Boolean properties indicate whether the corresponding setting is locked."},"meeting_summary_template":{"type":"object","properties":{"enable":{"type":"boolean","description":"Whether users can select a meeting summary template for their meetings. After the meeting, the summary will be generated into the new template. The Boolean indicates whether this setting is locked.","example":false}},"description":"Allow users to select a meeting summary template for their meetings. After the meeting, the summary will be generated into the new template. The nested Boolean properties indicate whether the corresponding setting is locked."},"meeting_summary_default_language":{"type":"object","properties":{"enable":{"type":"boolean","description":"When this feature is enabled, all meeting summaries will automatically use the language you choose. The Boolean indicates whether this setting is locked.","example":false}},"description":"When this feature is enabled, all meeting summaries will automatically use the language you choose. The nested Boolean properties indicate whether the corresponding setting is locked."},"meeting_summary_ip_access":{"type":"object","properties":{"enable":{"type":"boolean","description":"Whether meeting summary access is restricted to specific IP address ranges. The Boolean indicates whether this setting is locked.","example":false}},"description":"Allow meeting summary access only from specific IP address ranges. The nested Boolean properties indicate whether the corresponding setting is locked."},"remind_me_turn_on_aic":{"type":"boolean","description":"If you don't set AI features to auto-start in your meetings, you will be reminded to turn on AI at the beginning of each meeting you host. The Boolean indicates whether this setting is locked.","example":false},"remind_me_turn_on_catch_me_up":{"type":"boolean","description":"When you join a meeting late, you'll get a prompt for AI to summarize what's been discussed so far. The Boolean indicates whether this setting is locked.","example":false},"meeting_summary_email_only_mode":{"type":"boolean","description":"When this setting is enabled, summaries will only be shared to users by email. Users will not be able to view or edit summaries on the Zoom client or web portal, as the meeting summary will not be retained. The Boolean indicates whether this setting is locked.","example":false},"restrict_users_from_deleting_ai_companion_assets":{"type":"boolean","description":"When enabled, users cannot delete AI assets. Only admins can delete them. The Boolean indicates whether this setting is locked.","example":false},"restrict_users_from_editing_ai_companion_assets":{"type":"boolean","description":"When enabled, users cannot edit AI assets. Only admins can edit them. The Boolean indicates whether this setting is locked.","example":false},"webinar_summary_follow_up_email":{"type":"boolean","description":"Whether webinar summaries are included in webinar follow-up email. Deprecated. Use `include_webinar_summary_follow_up_email`. The Boolean indicates whether this setting is locked.","example":true,"deprecated":true},"webinar_summary_ocr":{"type":"boolean","description":"Whether using screen share content with OCR for webinar summaries is locked.","example":false},"zoom_events_chat_panel":{"type":"boolean","description":"Whether the AI chat panel in Zoom Events is locked.","example":false},"zoom_events_session_summary":{"type":"object","properties":{"enable":{"type":"boolean","description":"Whether Zoom Events session summaries are locked.","example":false},"auto_start":{"type":"boolean","description":"Whether automatically turning on session summary when sessions start is locked.","example":false}},"description":"Lock settings for Zoom Events session summary."},"chat_summary":{"type":"boolean","description":"Summarize with AI Companion.","example":true},"chat_compose":{"type":"boolean","description":"Compose with AI Companion.","example":true},"hub_ai_question_and_file_creation":{"type":"boolean","description":"Whether the Hub AI search and file creation setting is locked.","example":true},"canvas_ai_content_generation":{"type":"boolean","description":"Whether the Canvas AI content generation and revision setting is locked.","example":true},"canvas_ai_sentence_completion":{"type":"boolean","description":"Whether the Canvas AI sentence completion setting is locked.","example":true},"canvas_ai_post_meeting_writing_tasks":{"type":"boolean","description":"Whether the Canvas post-meeting writing task setting is locked.","example":true},"paper_ai_content_generation":{"type":"boolean","description":"Whether the Zoom Paper AI content generation and revision setting is locked.","example":true},"sheets_ai_content_generation":{"type":"boolean","description":"Whether the Zoom Sheets AI content generation and revision setting is locked.","example":true},"sheets_ai_formula":{"type":"boolean","description":"Whether the Zoom Sheets AI Formula setting is locked.","example":true},"sheets_ai_function":{"type":"boolean","description":"Whether the Zoom Sheets AI Function setting is locked.","example":true},"sheets_ai_resources":{"type":"boolean","description":"Whether the Zoom Sheets AI Resources setting is locked.","example":true},"slides_ai_content_generation":{"type":"boolean","description":"Whether the Zoom Slides AI content generation and revision setting is locked.","example":true},"my_notes_meeting_transcription":{"type":"boolean","description":"Whether the My Notes meeting transcription setting is locked.","example":true},"my_notes_ai_content_generation":{"type":"boolean","description":"Whether the My Notes AI content generation setting is locked.","example":true},"include_webinar_summary_follow_up_email":{"type":"object","properties":{"enable":{"type":"boolean","description":"Whether including the webinar summary in follow-up email is locked.","example":false}},"description":"Lock settings for including the webinar summary in follow-up email."},"webinar_summary":{"type":"object","properties":{"enable":{"type":"boolean","description":"Whether allowing hosts to generate a summary is locked.","example":false},"auto_enable":{"type":"boolean","description":"Whether automatically turning on webinar summary when the webinar starts is locked.","example":false},"email_notification":{"type":"boolean","description":"Whether sending an email notification when sharing to participants is locked.","example":false},"restrict_share_to_outside_of_organization":{"type":"boolean","description":"Whether restricting users from sharing summaries to those outside of the organization is locked.","example":false},"who_will_receive_summary":{"type":"boolean","description":"Who will automatically receive the summary. The supported values are `host` (only webinar host), `host_and_panelist_in_organization` (only webinar host, co-hosts, and panelists in the organization), and `host_and_panelist_not_in_organization` (webinar host, co-hosts, and all panelists, including those outside the organization). The Boolean indicates whether this setting is locked.","example":false}},"description":"Allow hosts to generate a summary. Summaries are sent after the webinar ends based on sharing permissions. The nested Boolean properties indicate whether the corresponding settings are locked."},"webinar_questions":{"type":"object","properties":{"enable":{"type":"boolean","description":"Whether allowing users to ask webinar questions with AI is locked.","example":false},"auto_enable":{"type":"boolean","description":"Whether automatically allowing access when the webinar starts is locked.","example":false},"who_can_ask_questions":{"type":"boolean","description":"Who can ask questions about the webinar. The supported values are `panelist_all` (hosts and all panelists), `panelist_org` (hosts and all panelists in the organization), `host` (only webinar host, co-hosts, and alternative hosts), and `all_participants` (all participants). The Boolean indicates whether this setting is locked.","example":false}},"description":"During the webinar, answers are based on speech-to-text data. If a transcript is retained, participants with access can ask questions after the webinar based on that transcript. The nested Boolean properties indicate whether the corresponding settings are locked."}},"description":"Lock settings for Workspace Reservation recommendations with AI."}}},{"title":"Meeting or Webinar Security Account Locked Settings","type":"object","properties":{"meeting_security":{"type":"object","properties":{"approved_or_denied_countries_or_regions":{"type":"boolean","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.","example":true},"auto_security":{"type":"boolean","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.","example":true},"block_user_domain":{"type":"boolean","description":"Whether users in specific domains are blocked from joining meetings and webinars.","example":true},"chat_etiquette_tool":{"type":"boolean","description":"Whether to enable the **Chat Etiquette Tool**.","example":true},"embed_password_in_join_link":{"type":"boolean","description":"Whether the meeting passcode is encrypted and included in the invitation link. The provided link will allow participants to join the meeting without having to enter the passcode.","example":true},"encryption_type":{"type":"boolean","description":"Whether use encryption to start a meeting.","example":true},"end_to_end_encrypted_meetings":{"type":"boolean","description":"Whether to enable end-to-end encryption for meetings.","example":true},"meeting_password":{"type":"boolean","description":"Whether all instant and scheduled meetings that users can join via client or Zoom Rooms systems are passcode-protected. [Personal Meeting ID (PMI)](https://support.zoom.us/hc/en-us/articles/203276937) meetings are **not** included in this setting.","example":true},"only_authenticated_can_join_from_webclient":{"type":"boolean","description":"Whether to specify that only authenticated users can join the meeting from the web client.","example":true},"phone_password":{"type":"boolean","description":"Whether passcodes are required for participants joining by phone. \n\n If enabled and the meeting is passcode-protected, a numeric passcode is required for participants to join by phone. For meetings with alphanumeric passcodes, a numeric passcode will be generated.","example":true},"pmi_password":{"type":"boolean","description":"Whether all Personal Meeting ID (PMI) meetings that users can join via client or Zoom Rooms systems are passcode-protected.","example":true},"waiting_room":{"type":"boolean","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.","example":true},"webinar_password":{"type":"boolean","description":"Whether to generate a passcode when scheduling webinars. Participants must use the generated passcode to join the scheduled webinar.","example":true}}}},"description":"The account's locked meeting and webinar security settings."}]}}}},"400":{"description":"**HTTP Status Code:** `400` <br>\n Bad Request  \n\n **Error Code:** `2001` <br>\n Account does not exist: $subAccountId. <br>\n"},"429":{"description":"**HTTP Status Code:** `429` <br>\n Too Many Requests. For more information, see [rate limits](https://developers.zoom.us/docs/api/rest/rate-limits/). \n\n "}},"security":[{"openapi_authorization":[]}],"x-extensions":{"x-permissions":["SubAccount:Edit","SubAccount:Read"],"x-macro-scopes":["account:read:admin","account:write:admin"],"x-granular-scopes":["account:read:lock_settings:master"]}},"patch":{"tags":["Accounts"],"summary":"Update locked settings","description":"Updates an account's locked settings.\n\n[Account Locked Settings](https://support.zoom.us/hc/en-us/articles/115005269866) allows account admins and account owners to toggle settings on or off for all users in your account.  \n\n**Note:** Yout must have a Pro or a higher plan and enabled master and sub accounts options.  \n   \n \n**Prerequisites:**  \n \n* Pro or a higher paid account.   \n \n\n\n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `account:write:admin`\n\n**[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `account:update:lock_settings:master`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`","operationId":"UpdateLockedSettings","parameters":[{"name":"accountId","in":"path","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"audio_conferencing":{"type":"object","properties":{"toll_free_and_fee_based_toll_call":{"type":"boolean","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.","example":true},"toll_call":{"type":"boolean","description":"Whether the account has the [**Toll Call**](https://support.zoom.com/hc/en/article?id=zm_kb&sysparm_article=KB0066909#h_01F51680NJ7YHZDXGJNSKDGM2P) setting enabled.","example":true},"call_me_and_invite_by_phone":{"type":"boolean","description":"Whether the account has the [**Call Me and Invite by Phone**](https://support.zoom.com/hc/en/article?id=zm_kb&sysparm_article=KB0067414#h_01F53VFZMDP4EJAF772N7NG2KY) setting enabled.","example":true},"personal_audio_conference":{"type":"boolean","description":"Whether the account has the [**Personal Audio Conference**](https://support.zoom.com/hc/en/article?id=zm_kb&sysparm_article=KB0060449#h_01F5BPMEB7GK6XXPKHDBHYFF27) setting enabled.","example":true},"participant_phone_masking":{"type":"boolean","description":"Whether the account has the [**Mask phone number in the participant list**](https://support.zoom.com/hc/en/article?id=zm_kb&sysparm_article=KB0067881#h_01F5K5GT9P563K751K3JNAYE6E) setting enabled.","example":true}}},"chat":{"type":"object","properties":{"share_files":{"type":"boolean","description":"Users can share files in chats and channels.","example":true},"chat_emojis":{"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 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**.","example":true},"record_voice_messages":{"type":"boolean","description":"Allow users to record voice messages that can be sent in direct messages or group conversations.","example":true},"record_video_messages":{"type":"boolean","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.","example":true},"screen_capture":{"type":"boolean","description":"Allow users to take and send screenshots in direct messages or group conversations.","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":{"type":"boolean","description":"Whether to allow users to add contacts.","example":true},"allow_users_to_chat_with_others":{"type":"boolean","description":"Whether to allow users to chat with others.","example":true},"chat_etiquette_tool":{"type":"boolean","description":"Whether to enable the **Chat Etiquette Tool**.","example":true},"send_data_to_third_party_archiving_service":{"type":"boolean","description":"Whether to send data to third-party archiving service.","example":true},"translate_messages":{"type":"boolean","description":"Allow users to translate team chat messages. [Learn more].(https://support.zoom.us/hc/en-us/articles/12998089084685)","example":true},"search_and_send_animated_gif_images":{"type":"boolean","description":"Whether to allow users to search GIF images from GIPHY when they compose messages.","example":true},"shared_spaces":{"type":"boolean","description":"Whether to allow users to create Shared Spaces.","example":true},"allow_create_channels_and_group_chats":{"type":"boolean","description":"Whether to allow users to create channels and group chats.","example":true},"allow_huddles_from_channels":{"type":"boolean","description":"Whether to allow huddles from channels.","example":true},"download_file":{"type":"boolean","description":"Whether to allow users to download files.","example":true},"share_screen_in_chat":{"type":"boolean","description":"Whether to allow users to share screen in chat.","example":true},"chat_email_address":{"type":"boolean","description":"Chat email address.","example":true},"read_receipts":{"type":"boolean","description":"Whether to enable read receipts.","example":true},"allow_delete_message":{"type":"boolean","description":"Whether to allow users to delete messages.","example":true},"allow_edit_message":{"type":"boolean","description":"Whether to allow users to edit messages.","example":true},"presence_on_meeting":{"type":"boolean","description":"Change my presence status when I am in a meeting or call.","example":true},"presence_away_when_screen_saver":{"type":"boolean","description":"Change my status to away when screen saver begins.","example":true},"ai_summary":{"type":"boolean","description":"The field has been moved from the `chat` object to the `ai` object and renamed to `chat_summary` to better reflect its functionality.\nSummarize with AI Companion.","example":true,"deprecated":true},"ai_compose":{"type":"boolean","description":"The field has been moved from the `chat` object to the `ai` object and renamed to `chat_compose` to better reflect its functionality.\nCompose with AI Companion.","example":true,"deprecated":true},"ai_recommend":{"type":"boolean","description":"**Zoom no longer supports this feature.**\nChat Recommendation with Zoom AI Companion.","example":true,"deprecated":true},"ai_reply":{"type":"boolean","description":"**Zoom no longer supports this feature.**\nQuick reply with AI Companion.","example":true,"deprecated":true},"ai_sentence_completion":{"type":"boolean","description":"**Zoom no longer supports this feature.**\nSentence completion with AI Companion.","example":true,"deprecated":true},"ai_quick_schedule":{"type":"boolean","description":"**Zoom no longer supports this feature.**\nQuick schedule with AI Companion.","example":true,"deprecated":true},"survey_poll":{"type":"boolean","description":"Allow users to launch a poll in chats and channels.","example":true}}},"email_notification":{"type":"object","properties":{"alternative_host_reminder":{"type":"boolean","description":"Notify the alternative host who is set or removed.","example":true},"cancel_meeting_reminder":{"type":"boolean","description":"Notify host and participants when the meeting is cancelled.","example":true},"cloud_recording_available_reminder":{"type":"boolean","description":"Whether to notify the host when a cloud recording is available.","example":true},"jbh_reminder":{"type":"boolean","description":"Notify host when participants join the meeting before them.","example":true},"schedule_for_reminder":{"type":"boolean","description":"Notify the host there is a meeting is scheduled, rescheduled, or cancelled.","example":true}}},"in_meeting":{"type":"object","properties":{"alert_guest_join":{"type":"boolean","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.","example":true},"allow_users_to_delete_messages_in_meeting_chat":{"type":"boolean","description":"If the value of this field is set to `true`,  allow users to delete messages in the in-meeting chat.\n","example":true},"allow_live_streaming":{"type":"boolean","description":"Whether to allow livestreaming.","example":true},"allow_show_zoom_windows":{"type":"boolean","description":"Show Zoom windows during screen share.","example":true},"annotation":{"type":"boolean","description":"Allow participants to use annotation tools to add information to shared screens.","example":true},"anonymous_question_answer":{"type":"boolean","example":true},"attendee_on_hold":{"type":"boolean","description":"Allow host to put attendee on hold.\n\n**This field has been deprecated and is no longer supported.**","example":true,"deprecated":true,"default":false},"attention_mode_focus_mode":{"type":"boolean","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.","example":true},"auto_answer":{"type":"boolean","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.","example":true},"auto_generated_captions":{"type":"boolean","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).","example":true},"auto_saving_chat":{"type":"boolean","description":"Automatically save all in-meeting chats.","example":true},"breakout_room":{"type":"boolean","description":"Allow host to split meeting participants into separate, smaller rooms.","example":true},"chat":{"type":"boolean","description":"Allow meeting participants to send chat message visible to all participants.","example":true},"meeting_question_answer":{"type":"boolean","description":"Allow participants to ask questions for the host and participants to answer.","example":true},"closed_caption":{"type":"boolean","description":"Allow host to type closed captions or assign a participant/third party device to add closed captions.","example":true},"co_host":{"type":"boolean","description":"Allow the host to add co-hosts. Co-hosts have the same in-meeting controls as the host.","example":true},"custom_data_center_regions":{"type":"boolean","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.","example":true},"disable_screen_sharing_for_host_meetings":{"type":"boolean","description":"Whether to enable the **Disable desktop screen sharing for meetings you host** setting.","example":true},"disable_screen_sharing_for_in_meeting_guests":{"type":"boolean","description":"Whether to enable the **Disable screen sharing when guests are in the meeting** setting.","example":true},"dscp_marking":{"type":"boolean","description":"Allow users to select stereo audio during a meeting.","example":true},"e2e_encryption":{"type":"boolean","description":"Require that all meetings are encrypted using AES.","example":true},"entry_exit_chime":{"type":"string","description":"Play sound when participants join or leave.","example":"none"},"far_end_camera_control":{"type":"boolean","description":"Allow another user to take control of the camera during a meeting.","example":true},"feedback":{"type":"boolean","description":"Enable users to provide feedback to Zoom at the end of the meeting.","example":true},"file_transfer":{"type":"boolean","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.","example":true},"full_transcript":{"type":"boolean","description":"Whether to enable the viewing of full transcripts in the in-meeting side panel.","example":true},"group_hd":{"type":"boolean","description":"Enable higher quality video for host and participants in Meeting. This will require more bandwidth.","example":true},"webinar_group_hd":{"type":"boolean","description":"Enable higher quality video for host and participants in Webinar. This will require more bandwidth.","example":true},"language_interpretation":{"type":"boolean","description":"Whether to allow hosts to assign participants as interpreters who can interpret one language into another in real-time.","example":true},"sign_language_interpretation":{"type":"boolean","description":"Allow hosts to assign participants as sign language interpreters who can interpret one language into sign language in real-time. Hosts can assign interpreters when scheduling, or during the meeting itself. This feature is only available with version 5.11.3 or later.","example":true},"webinar_reactions":{"type":"boolean","description":"Set this field to true to use [webinar reactions](https://support.zoom.us/hc/en-us/articles/4803536268429).","example":true},"meeting_survey":{"type":"boolean","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.","example":true},"original_audio":{"type":"boolean","description":"Allow users to select original sound during a meeting.","example":true},"polling":{"type":"boolean","description":"Add 'Polls' to the meeting controls. This allows the host to survey the attendees.","example":true},"post_meeting_feedback":{"type":"boolean","description":"Display end-of-meeting experience feedback survey.","example":true},"private_chat":{"type":"boolean","description":"Allow meeting participants to send a private 1:1 message to another participant.","example":true},"remote_control":{"type":"boolean","description":"During screen sharing, allow the person who is sharing to let others control the shared content.","example":true},"non_verbal_feedback":{"type":"boolean","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`.","example":true,"default":false},"remote_support":{"type":"boolean","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`.","example":true,"default":false},"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":{"type":"boolean","description":"Whether to allow participants to save closed captions or transcripts.","example":true},"save_captions":{"type":"boolean","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.","example":true},"screen_sharing":{"type":"boolean","description":"Allow host and participants to share their screen or content during meetings.","example":true},"sending_default_email_invites":{"type":"boolean","description":"Allow users to invite participants by email only by default.","example":true},"show_meeting_control_toolbar":{"type":"boolean","description":"Always show meeting controls during a meeting.","example":true},"slide_control":{"type":"boolean","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.","example":true},"stereo_audio":{"type":"boolean","description":"Allow users to select stereo audio during a meeting.","example":true},"use_html_format_email":{"type":"boolean","description":"Allow  HTML formatting instead of plain text for meeting invitations scheduled with the Outlook plugin.","example":true},"virtual_background":{"type":"boolean","description":"Enable virtual background.","example":true},"webinar_chat":{"type":"boolean","description":"Whether to allow webinar participants to send chat messages.","example":true},"webinar_live_streaming":{"type":"boolean","description":"Whether to enable webinar livestreaming.","example":true},"webinar_polling":{"type":"boolean","description":"Whether to allow the host to add polls before or during a webinar.","example":true},"webinar_question_answer":{"type":"boolean","description":"Whether attendees can ask the host and panelists questions in the webinar.","example":true},"webinar_survey":{"type":"boolean","description":"Whether to allow the host to present surveys to attendees once a webinar has ended.","example":true},"whiteboard":{"type":"boolean","description":"Allow participants to share a whiteboard that includes annotation tools.","example":true}}},"other_options":{"type":"object","properties":{"blur_snapshot":{"type":"boolean","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.","example":true},"webinar_registration_options":{"type":"boolean","description":"Webinar registration options.","example":true}}},"recording":{"type":"object","properties":{"account_user_access_recording":{"type":"boolean","description":"Make cloud recordings accessible to account members only.","example":true},"auto_delete_cmr":{"type":"boolean","description":"Allow Zoom to automatically delete recordings permanently after a specified number of days.","example":true},"auto_recording":{"type":"boolean","description":"Record meetings automatically as they start.","example":true},"cloud_recording":{"type":"boolean","description":"Allow hosts to record and save the meeting / webinar in the cloud.","example":true},"cloud_recording_download":{"type":"boolean","description":"Allow anyone with a link to the cloud recording to download.","example":true},"host_delete_cloud_recording":{"type":"boolean","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.","example":true},"ip_address_access_control":{"type":"boolean","description":"Setting to allow cloud recording access only from specific IP address ranges.\n","example":true},"local_recording":{"type":"boolean","description":"Allow hosts and participants to record the meeting to a local file.","example":true},"prevent_host_access_recording":{"type":"boolean","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","example":true},"recording_authentication":{"type":"boolean","example":true},"archive":{"type":"boolean","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.","example":true}}},"schedule_meeting":{"type":"object","properties":{"audio_type":{"type":"boolean","description":"Determine how participants can join the audio portion of the meeting.","example":true},"embed_password_in_join_link":{"type":"boolean","description":"If the value is set to `true`, the meeting passcode will be encrypted and included in the join meeting link to allow participants to join with just one click without having to enter the passcode.\n ","example":true},"enforce_login":{"type":"boolean","description":"Participants must always sign in before joining the scheduled meeting.","example":true},"enforce_login_domains":{"type":"string","description":"Specify the domains from which users can join a meeting.\n","example":"example.com"},"enforce_login_with_domains":{"type":"boolean","description":"Allow only signed-in users with specified domains to join meetings.\n","example":true},"host_video":{"type":"boolean","description":"Start meetings with host video on.","example":true},"join_before_host":{"type":"boolean","description":"Allow participants to join the meeting before the host arrives","example":true},"meeting_authentication":{"type":"boolean","example":true},"not_store_meeting_topic":{"type":"boolean","description":"Whether to enable the [**Always display &quot;Zoom Meeting&quot; as the meeting topic**](https://support.zoom.us/hc/en-us/articles/201363253-Changing-account-settings#h_01EG9BJ646V2WJK1S3H2MP6YV6) setting.","example":true},"always_display_zoom_webinar_as_topic":{"type":"boolean","description":"Whether to enable the [**Always show &quot;Zoom Webinar&quot; as the webinar topic**](https://support.zoom.us/hc/en-us/articles/201363253-Changing-account-settings#h_01EG9BJ646V2WJK1S3H2MP6YV6) setting.","example":false},"participant_video":{"type":"boolean","description":"Start meetings with participant video on.","example":true},"personal_meeting":{"type":"boolean","description":"Turn the lock setting on or off for the **Enable Personal Meeting ID** setting for an entire account.  \n   \n \n`true`: Turn the **&quot;Enable Personal Meeting ID&quot;** setting **on** for all users in the account. Users can choose to use personal meeting ID for their meetings.   \n   \n \n`false`: Turn **off** the **&quot;Enable Personal Meeting ID&quot;** 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.**  \n   \n \nFor Zoom Phone only: If a user has been assigned a desk phone, **&quot;Elevate to Zoom Meeting&quot;** on desk phone will be disabled.\n\n\n","example":true},"require_password_for_instant_meetings":{"type":"boolean","description":"Require passcode 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.","example":true},"require_password_for_pmi_meetings":{"type":"boolean","description":"Require participants to enter passcode 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.","example":true},"require_password_for_scheduling_new_meetings":{"type":"boolean","description":"This setting applies for regular meetings that do not use a PMI. If enabled, a passcode will be generated while a host schedules a new meeting and participants will be required to enter the passcode 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.","example":true},"use_pmi_for_instant_meetings":{"type":"boolean","description":"Use a Personal Meeting ID (PMI) when starting an instant meeting.","example":true},"use_pmi_for_scheduled_meetings":{"type":"boolean","description":"Use a Personal Meeting ID (PMI) when scheduling a meeting.","example":true},"continuous_meeting_chat":{"type":"boolean","description":"Whether to enable the [**Enable continuous meeting chat**] setting.","example":true}}},"telephony":{"type":"object","properties":{"telephony_regions":{"type":"boolean","example":true},"third_party_audio":{"type":"boolean","description":"Allow users to join the meeting using the existing 3rd party audio configuration.","example":true}}},"tsp":{"type":"object","properties":{"call_out":{"type":"boolean","description":"Call Out","example":true},"show_international_numbers_link":{"type":"boolean","description":"Show international numbers link on the invitation email","example":true}}},"ai":{"type":"object","properties":{"screen_share_ocr":{"type":"boolean","description":"Whether the screen_share_ocr setting is locked.","example":true},"meeting_chat_messages":{"type":"boolean","description":"Whether the meeting_chat_messages setting is locked.","example":true},"full_display_names_in_ai_assets":{"type":"boolean","description":"Whether the full_display_names_in_ai_assets setting is locked.","example":true},"ai_generated_virtual_backgrounds":{"type":"boolean","description":"Whether the ai_generated_virtual_backgrounds setting is locked.","example":true},"meeting_agenda":{"type":"boolean","description":"Whether the meeting_agenda setting is locked.","example":true},"meeting_summary_docs":{"type":"object","properties":{"enable":{"type":"boolean","description":"Whether automatic Zoom Doc creation is locked.","example":true},"share_with_summary_recipients":{"type":"boolean","description":"Whether sharing generated Zoom Docs with meeting summary recipients is locked.","example":false}},"description":"Lock settings for meeting summary Docs."},"phone_user_ai_notices":{"type":"object","properties":{"enable":{"type":"boolean","description":"Whether phone user AI notices are locked.","example":true}},"description":"Lock settings for phone user AI notices."},"meeting_summary_retention":{"type":"object","properties":{"enable":{"type":"boolean","description":"Whether automatic meeting summary deletion is locked.","example":true}},"description":"Lock settings for meeting summary retention."},"meeting_coach":{"type":"object","properties":{"enable":{"type":"boolean","description":"Whether Meeting Coach with AI is locked.","example":true}},"description":"Lock settings for Meeting Coach with AI."},"third_party_meeting_join":{"type":"object","properties":{"enable":{"type":"boolean","description":"Whether third-party meeting join with AI is locked.","example":true},"allow_recording":{"type":"boolean","description":"Whether recording for joined third-party meetings is locked.","example":true},"calendar":{"type":"object","properties":{"enable":{"type":"boolean","description":"Whether calendar-based third-party meeting join is locked.","example":true}},"description":"Lock settings for calendar-based third-party meeting join."},"pre_meeting_email_notification":{"type":"object","properties":{"enable":{"type":"boolean","description":"Whether pre-meeting email notification is locked.","example":true}},"description":"Lock settings for pre-meeting email notification."}},"description":"Lock settings for third-party meeting join with AI."},"whiteboard_content_generation":{"type":"boolean","description":"Whether Whiteboard content generation with AI is enabled.","example":true},"smart_recording":{"type":"object","properties":{"enable":{"type":"boolean","description":"Whether the Smart Recording is locked.","example":true}},"description":"Lock settings for Smart Recording."},"clips_summarization_generation":{"type":"object","properties":{"enable":{"type":"boolean","description":"Whether the clips summarization generation is locked.","example":true}},"description":"Lock settings for clips summarization generation."},"clips_create_video_with_aic":{"type":"object","properties":{"enable":{"type":"boolean","description":"Whether the clips create video with aic is locked.","example":true}},"description":"Lock settings for clips create video with aic."},"allow_user_create_customize_avatar":{"type":"object","properties":{"enable":{"type":"boolean","description":"Whether the clips allow user create customize avatar is locked.","example":true}},"description":"Lock settings for clips allow user create customize avatar."},"task_creation_and_management":{"type":"object","properties":{"enable":{"type":"boolean","description":"Whether task creation and management with AI is locked.","example":true}},"description":"Lock settings for task creation and management with AI."},"show_conversational_ai_companion":{"type":"object","properties":{"enabled":{"type":"boolean","description":"Whether conversational AI is locked.","example":true},"enable_zoom_mate":{"type":"boolean","description":"Whether ZoomMate availability is locked.","example":true},"delete_ai_conversation":{"type":"boolean","description":"Whether automatic AI conversation deletion is locked.","example":true},"delete_ai_conversation_time":{"type":"boolean","description":"Whether the AI conversation retention period is locked.","example":true}},"description":"Lock settings for the conversational AI companion."},"ai_panel_in_workplace":{"type":"object","properties":{"enabled":{"type":"boolean","description":"Whether the AI panel in Zoom Workplace is locked.","example":true},"delete_ai_conversation":{"type":"boolean","description":"Whether automatic AI conversation deletion in the AI panel is locked.","example":true},"delete_ai_conversation_time":{"type":"boolean","description":"Whether the AI panel conversation retention period is locked.","example":true}},"description":"Lock settings for the AI panel in Zoom Workplace."},"enable_ai_on_web":{"type":"boolean","description":"Whether Zoom AI on the web is locked.","example":true},"enable_email_compose_with_ai":{"type":"boolean","description":"Whether Zoom Mail AI compose is locked.","example":true},"microsoft_365":{"type":"object","properties":{"enable":{"type":"boolean","description":"Whether Microsoft 365 data sources are locked.","example":true}},"description":"Lock settings for Microsoft 365 data sources."},"google":{"type":"object","properties":{"enable":{"type":"boolean","description":"Whether Google data sources are locked.","example":true}},"description":"Lock settings for Google data sources."},"web_content":{"type":"boolean","description":"Whether Web content as an AI data source is locked.","example":true},"local_file_uploads":{"type":"boolean","description":"Whether Local file uploads as an AI data source are locked.","example":true},"organization_custom_dictionaries":{"type":"boolean","description":"Whether allowing AI to consume the organization's custom dictionaries is locked.","example":true},"third_party_app_tasks":{"type":"boolean","description":"Whether allowing AI to perform tasks in third-party apps is locked.","example":true},"workspace_reservation_recommendations_with_ai":{"type":"object","properties":{"enabled":{"type":"boolean","description":"Whether Workspace Reservation recommendations with AI are locked.","example":true}},"description":"Lock settings for Workspace Reservation recommendations with AI."},"participant_can_request_aic_in_meeting":{"type":"boolean","description":"Participants can request the host to start in-meeting AI features. The Boolean indicates whether this setting is locked.","example":false},"restrict_aic_when_external_user_join_meeting":{"type":"boolean","description":"Automatically restrict Zoom AI and transcription features when external users or groups join a meeting. The Boolean indicates whether this setting is locked.","example":false},"restrict_aic_when_restrict_user_join":{"type":"boolean","description":"When members of this group join a meeting, Zoom AI features will not be permitted for that session. This will only impact meetings within this organization. The Boolean indicates whether this setting is locked.","example":false},"restrict_users_from_joining_ai_enabled_meetings":{"type":"object","properties":{"enable":{"type":"boolean","description":"Whether users are restricted from joining meetings in which AI meeting processing (meeting questions and summary) is allowed. The Boolean indicates whether this setting is locked.","example":false}},"description":"Users would be restricted from joining meetings in which AI meeting processing (meeting questions and summary) is allowed. The nested Boolean properties indicate whether the corresponding setting is locked."},"meeting_questions":{"type":"object","properties":{"enable":{"type":"boolean","description":"Whether to allow hosts and invited participants to ask questions to AI Companion during a meeting. The Boolean indicates whether this setting is locked.","example":false},"auto_enable":{"type":"boolean","description":"Whether to automatically allow access when the meeting starts. The Boolean indicates whether this setting is locked.","example":false},"who_can_ask_questions":{"type":"boolean","description":"Defines who can ask questions about this meeting's transcript. The corresponding setting values are `from_entire_meeting` (all participants and invitees), `from_join_meeting` (all participants only from when they join), `host` (only the meeting host), `org` (participants and invitees in the organization), and `org_from_join_meeting` (participants in the organization only from when they join). The Boolean indicates whether this setting is locked.","example":false}},"description":"Zoom AI answers the meeting questions based on what is said in the meeting. If a transcript is retained, participants with access will be able to ask questions after the meeting based on that transcript. The nested Boolean properties indicate whether the corresponding setting is locked."},"meeting_summary":{"type":"object","properties":{"enable":{"type":"boolean","description":"Whether to allow hosts to generate a summary. The Boolean indicates whether this setting is locked.","example":false},"auto_enable":{"type":"boolean","description":"Whether to turn on meeting summary automatically when meetings start. The Boolean indicates whether this setting is locked.","example":false},"who_will_receive_summary":{"type":"boolean","description":"Automatically share summary with. The corresponding setting values are `host` (only meeting host), `alt_host` (only meeting host, co-hosts, and alternative hosts), `organization` (only meeting host and meeting invitees in our organization), and `all` (all meeting invitees including those outside of our organization). The Boolean indicates whether this setting is locked.","example":false}},"description":"Allow hosts to generate a summary. Summaries are sent based on sharing permissions after the meeting has ended. The nested Boolean properties indicate whether the corresponding setting is locked."},"meeting_summary_template":{"type":"object","properties":{"enable":{"type":"boolean","description":"Whether users can select a meeting summary template for their meetings. After the meeting, the summary will be generated into the new template. The Boolean indicates whether this setting is locked.","example":false}},"description":"Allow users to select a meeting summary template for their meetings. After the meeting, the summary will be generated into the new template. The nested Boolean properties indicate whether the corresponding setting is locked."},"meeting_summary_default_language":{"type":"object","properties":{"enable":{"type":"boolean","description":"When this feature is enabled, all meeting summaries will automatically use the language you choose. The Boolean indicates whether this setting is locked.","example":false}},"description":"When this feature is enabled, all meeting summaries will automatically use the language you choose. The nested Boolean properties indicate whether the corresponding setting is locked."},"meeting_summary_ip_access":{"type":"object","properties":{"enable":{"type":"boolean","description":"Whether meeting summary access is restricted to specific IP address ranges. The Boolean indicates whether this setting is locked.","example":false}},"description":"Allow meeting summary access only from specific IP address ranges. The nested Boolean properties indicate whether the corresponding setting is locked."},"remind_me_turn_on_aic":{"type":"boolean","description":"If you don't set AI features to auto-start in your meetings, you will be reminded to turn on AI at the beginning of each meeting you host. The Boolean indicates whether this setting is locked.","example":false},"remind_me_turn_on_catch_me_up":{"type":"boolean","description":"When you join a meeting late, you'll get a prompt for AI to summarize what's been discussed so far. The Boolean indicates whether this setting is locked.","example":false},"meeting_summary_email_only_mode":{"type":"boolean","description":"When this setting is enabled, summaries will only be shared to users by email. Users will not be able to view or edit summaries on the Zoom client or web portal, as the meeting summary will not be retained. The Boolean indicates whether this setting is locked.","example":false},"restrict_users_from_deleting_ai_companion_assets":{"type":"boolean","description":"When enabled, users cannot delete AI assets. Only admins can delete them. The Boolean indicates whether this setting is locked.","example":false},"restrict_users_from_editing_ai_companion_assets":{"type":"boolean","description":"When enabled, users cannot edit AI assets. Only admins can edit them. The Boolean indicates whether this setting is locked.","example":false},"webinar_summary_follow_up_email":{"type":"boolean","description":"Whether webinar summaries are included in webinar follow-up email. Deprecated. Use `include_webinar_summary_follow_up_email`. The Boolean indicates whether this setting is locked.","example":true,"deprecated":true},"webinar_summary_ocr":{"type":"boolean","description":"Whether using screen share content with OCR for webinar summaries is locked.","example":false},"zoom_events_chat_panel":{"type":"boolean","description":"Whether the AI chat panel in Zoom Events is locked.","example":false},"zoom_events_session_summary":{"type":"object","properties":{"enable":{"type":"boolean","description":"Whether Zoom Events session summaries are locked.","example":false},"auto_start":{"type":"boolean","description":"Whether turning on session summary automatically when sessions start is locked.","example":false}},"description":"Lock settings for Zoom Events session summary."},"chat_summary":{"type":"boolean","description":"Summarize with AI Companion.","example":true},"chat_compose":{"type":"boolean","description":"Compose with AI Companion.","example":true},"hub_ai_question_and_file_creation":{"type":"boolean","description":"Whether the Hub AI search and file creation setting is locked.","example":true},"canvas_ai_content_generation":{"type":"boolean","description":"Whether the Canvas AI content generation and revision setting is locked.","example":true},"canvas_ai_sentence_completion":{"type":"boolean","description":"Whether the Canvas AI sentence completion setting is locked.","example":true},"canvas_ai_post_meeting_writing_tasks":{"type":"boolean","description":"Whether the Canvas post-meeting writing task setting is locked.","example":true},"paper_ai_content_generation":{"type":"boolean","description":"Whether the Zoom Paper AI content generation and revision setting is locked.","example":true},"sheets_ai_content_generation":{"type":"boolean","description":"Whether the Zoom Sheets AI content generation and revision setting is locked.","example":true},"sheets_ai_formula":{"type":"boolean","description":"Whether the Zoom Sheets AI Formula setting is locked.","example":true},"sheets_ai_function":{"type":"boolean","description":"Whether the Zoom Sheets AI Function setting is locked.","example":true},"sheets_ai_resources":{"type":"boolean","description":"Whether the Zoom Sheets AI Resources setting is locked.","example":true},"slides_ai_content_generation":{"type":"boolean","description":"Whether the Zoom Slides AI content generation and revision setting is locked.","example":true},"my_notes_meeting_transcription":{"type":"boolean","description":"Whether the My Notes meeting transcription setting is locked.","example":true},"my_notes_ai_content_generation":{"type":"boolean","description":"Whether the My Notes AI content generation setting is locked.","example":true},"webinar_questions":{"type":"object","properties":{"enable":{"type":"boolean","description":"Whether allowing users to ask webinar questions with AI is locked.","example":false},"auto_enable":{"type":"boolean","description":"Whether automatically allowing access when the webinar starts is locked.","example":false},"who_can_ask_questions":{"type":"boolean","description":"Who can ask questions about the webinar. The corresponding setting values are `panelist_all` (hosts and all panelists), `panelist_org` (hosts and all panelists in the organization), `host` (only webinar host, co-hosts, and alternative hosts), and `all_participants` (all participants). The Boolean indicates whether this setting is locked.","example":false}},"description":"During the webinar, answers are based on speech-to-text data. If a transcript is retained, participants with access can ask questions after the webinar based on that transcript. The nested Boolean properties indicate whether the corresponding settings are locked."},"webinar_summary":{"type":"object","properties":{"enable":{"type":"boolean","description":"Whether allowing hosts to generate a summary is locked.","example":false},"auto_enable":{"type":"boolean","description":"Whether turning on webinar summary automatically when the webinar starts is locked.","example":false},"email_notification":{"type":"boolean","description":"Whether sending an email notification when sharing to participants is locked.","example":false},"restrict_share_to_outside_of_organization":{"type":"boolean","description":"Whether restricting users from sharing summaries to those outside the organization is locked.","example":false},"who_will_receive_summary":{"type":"boolean","description":"Who will automatically receive the summary. The corresponding setting values are `host` (only webinar host), `host_and_panelist_in_organization` (only webinar host, co-hosts, and panelists in the organization), and `host_and_panelist_not_in_organization` (webinar host, co-hosts, and all panelists, including those outside the organization). The Boolean indicates whether this setting is locked.","example":false}},"description":"Allow hosts to generate a summary. Summaries are sent after the webinar ends based on sharing permissions. The nested Boolean properties indicate whether the corresponding settings are locked."},"include_webinar_summary_follow_up_email":{"type":"object","properties":{"enable":{"type":"boolean","description":"Whether including the webinar summary in follow-up email is locked.","example":false}},"description":"Lock settings for including the webinar summary in follow-up email."}},"description":"Lock settings for Workspace Reservation recommendations with AI."}}},{"title":"Meeting or Webinar Security Account Locked Settings","type":"object","properties":{"meeting_security":{"type":"object","properties":{"approved_or_denied_countries_or_regions":{"type":"boolean","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.","example":true},"auto_security":{"type":"boolean","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.","example":true},"block_user_domain":{"type":"boolean","description":"Whether to block users in specific domains from joining meetings and webinars.","example":true},"chat_etiquette_tool":{"type":"boolean","description":"Whether to enable the **Chat Etiquette Tool**.","example":true},"embed_password_in_join_link":{"type":"boolean","description":"Whether the meeting passcode will be encrypted and included in the invitation link. The provided link will allow participants to join the meeting without having to enter the passcode.","example":true},"encryption_type":{"type":"string","description":"The type of encryption to use when starting a meeting: \n* `enhanced_encryption` &mdash; Use enhanced encryption. Encryption data is stored in the cloud. \n* `e2ee` &mdash; 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.","example":"e2ee","enum":["enhanced_encryption","e2ee"]},"end_to_end_encrypted_meetings":{"type":"boolean","description":"Whether to enable end-to-end encryption for meetings. If enabled, you can specify the type of encryption in the `encryption_type` field.","example":true},"meeting_password":{"type":"boolean","description":"Whether all instant and scheduled meetings that users can join via client or Zoom Rooms systems are passcode-protected. [Personal Meeting ID (PMI)](https://support.zoom.us/hc/en-us/articles/203276937) meetings are **not** included in this setting.","example":true},"only_authenticated_can_join_from_webclient":{"type":"boolean","description":"Whether to specify that only authenticated users can join the meeting from the web client.","example":true},"phone_password":{"type":"boolean","description":"Whether to require a passcode for participants joining by phone. \n\n If enabled and the meeting is passcode-protected, a numeric passcode is required for participants to join by phone. For meetings with alphanumeric passcodes, a numeric passcode will be generated.","example":true},"pmi_password":{"type":"boolean","description":"Whether all Personal Meeting ID (PMI) meetings that users can join via client or Zoom Rooms systems are passcode-protected.","example":true},"waiting_room":{"type":"boolean","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.","example":true},"webinar_password":{"type":"boolean","description":"Whether to generate a passcode when scheduling webinars. Participants must use the generated passcode to join the scheduled webinar.","example":true}}}},"description":"The account's updated locked meeting and webinar security settings."}]}}}},"responses":{"200":{"description":"**Error Code:** `200`  \n \nOnly available for Paid account: $accountId.\n"},"404":{"description":"**HTTP Status Code:** `404` <br>\n Not Found  \n\n **Error Code:** `2001` <br>\n TAccount does not exist: $subAccountId. <br>\n"},"429":{"description":"**HTTP Status Code:** `429` <br>\n Too Many Requests. For more information, see [rate limits](https://developers.zoom.us/docs/api/rest/rate-limits/). \n\n "}},"security":[{"openapi_authorization":[]}],"x-extensions":{"x-permissions":["SubAccount:Edit","SubAccount:Read"],"x-macro-scopes":["account:write:admin"],"x-granular-scopes":["account:update:lock_settings:master"]}}},"/accounts/{accountId}/managed_domains":{"get":{"tags":["Accounts"],"summary":"Get account's managed domains","description":"Retrieve a list of 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 **Prerequisites:** \n* A Pro or a higher paid account with the Master account option enabled.\n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `account:master`,`account:write:master`,`account:read:master`\n\n**[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `account:read:managed_domains:master`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`","operationId":"accountManagedDomain","parameters":[{"name":"accountId","in":"path","description":"The account's ID. For master accounts, pass the `me` value for this parameter.","required":true,"schema":{"type":"string","example":"q6gBJVO5TzexKYTb_I2rpg"}}],"responses":{"200":{"description":"**HTTP Status Code:** `200`   \n \n Account's managed domains returned. \n\n **Error Code:** `200`   \n \n Only available for Paid or ZMP account: {accountId}.","content":{"application/json":{"schema":{"type":"object","properties":{"domains":{"type":"array","description":"Information about the managed domains.","items":{"allOf":[{"type":"object","properties":{"domain":{"type":"string","description":"The domain's name.","example":"example.com"},"status":{"type":"string","description":"The domain's status.","example":"verified"}}}]}},"total_records":{"type":"integer","description":"The total number of records returned.","example":1}}}}}},"404":{"description":"**HTTP Status Code:** `404` <br>\n Not Found \n\n **Error Code:** `2001` <br>\n Account does not exist: $accountId <br>\n"},"429":{"description":"**HTTP Status Code:** `429` <br>\n Too Many Requests. For more information, see [rate limits](https://developers.zoom.us/docs/api/rest/rate-limits/). \n\n "}},"security":[{"openapi_authorization":[]}],"x-extensions":{"x-permissions":["SubAccount:Edit","SubAccount:Read"],"x-macro-scopes":["account:master","account:write:master","account:read:master"],"x-granular-scopes":["account:read:managed_domains:master"]}}},"/accounts/{accountId}/owner":{"put":{"tags":["Accounts"],"summary":"Update the account owner","description":"Changes an account's owner.\n\nAn account's current owner can [change the account's owner](https://support.zoom.us/hc/en-us/articles/115005686983-Change-Account-Owner) to another user on the same account.\n\n**Prerequisites:** \n* An account owner or admin permissions of an account \n* The account making this API request must be on a Pro or a higher account plan with [Master account](https://developers.zoom.us/docs/api/rest/master-account-apis/) privileges\n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `account:master`\n\n**[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `account:update:owner:master`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `HEAVY`","operationId":"UpdateTheAccountOwner","parameters":[{"name":"accountId","in":"path","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"required":["email"],"type":"object","properties":{"email":{"type":"string","description":"The email address of the account's new owner.","format":"email","example":"admin@example.com"}}}}}},"responses":{"204":{"description":"**HTTP Status Code:** `204`  \n \nAccount owner updated."},"400":{"description":"**HTTP Status Code:** `400` <br>\n Bad Request  \n\n **Error Code:** `200` <br>\n User is not an admin or is an API user or doesn't belong to this account: {accountId}.<br>\nCannot make a user outside of your account an owner.<br>\nCannot update the role of an account owner. <br>\n"},"404":{"description":"**HTTP Status Code:** `404` <br>\n Not Found  \n\n **Error Code:** `2001` <br>\n Account does not exist: $subAccountId.<br> <br>\n**Error Code:** `3201` <br>\n Cannot find a billing account for this: $accountId.<br> <br>\n**Error Code:** `3211` <br>\n Cannot find a billing contact for this: $accountId. <br>\n"},"429":{"description":"**HTTP Status Code:** `429` <br>\n Too Many Requests. For more information, see [rate limits](https://developers.zoom.us/docs/api/rest/rate-limits/). \n\n "}},"security":[{"openapi_authorization":[]}],"x-extensions":{"x-permissions":["SubAccount:Edit","SubAccount:Read"],"x-macro-scopes":["account:master"],"x-granular-scopes":["account:update:owner:master"]}}},"/accounts/{accountId}/settings":{"get":{"tags":["Accounts"],"summary":"Get account settings","description":"Returns an account's settings. \n\nTo get settings for a master account, use the `me` value for the `accountId` path parameter. \n\n **Prerequisites:** \n* The account must be a paid account.\n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `account:read:admin`,`account:write:admin`\n\n**[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `account:read:settings:master`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`","operationId":"accountSettings","parameters":[{"name":"accountId","in":"path","required":true,"schema":{"type":"string"}},{"name":"option","in":"query","description":"Optional query parameters. \n* `meeting_authentication` - 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` - 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` - View the account's security settings. For example, passcode requirements for user login or two-factor authentication. \n* `meeting_security` - View the meeting security settings applied to the user's account.","required":false,"schema":{"type":"string","example":"meeting_security","enum":["meeting_authentication","recording_authentication","security","meeting_security"]}},{"name":"custom_query_fields","in":"query","description":"The name of the field to use to filter the response. For example, if you provide the `host_video` value for this field, you will get a response similar to. \n\n `{ schedule_meeting: { host_video: false } }` \n\n To use multiple values, comma-separate each value, like `host_video,participant_video`.","required":false,"schema":{"type":"string","example":"in_meeting"}}],"responses":{"200":{"description":"**HTTP Status Code:** `200`   \n \n Account settings returned. \n\n **Error Code:** `200`   \n \n Only available for paid accounts.","content":{"application/json":{"schema":{"oneOf":[{"title":"Account settings","type":"object","properties":{"security":{"type":"object","properties":{"admin_change_name_pic":{"type":"boolean","description":"Whether to only allow account administrators to change a user's picture.","example":true,"deprecated":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","example":"[\"name\",\"host_key\",\"sign_in_email\"]","enum":["name","profile_picture","sign_in_email","host_key"]}},"signin_with_sso":{"type":"object","properties":{"enable":{"type":"boolean","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.","example":true},"require_sso_for_domains":{"type":"boolean","description":"Whether to require users to sign in with single sign-on (SSO) if their e-mail address belongs to one of the `domains`.","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":{"type":"string","description":"The user id.","example":"21212_aefwef32233"},"email":{"type":"string","description":"The user email.","example":"123@test.com"}}}}},"description":"Allow users to sign in with single sign-on (SSO). "},"hide_billing_info":{"type":"boolean","description":"Hide billing information.","example":true},"import_photos_from_devices":{"type":"boolean","description":"Allow users to import photos from a photo library on a  device.","example":true},"password_requirement":{"type":"object","properties":{"consecutive_characters_length":{"type":"integer","description":"\nSpecify the max length of consecutive characters(abcde...) that can be used in a passcode.\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 passcode.\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 passcode(example: abc1x@8fdh).","example":8},"have_special_character":{"type":"boolean","description":"If the value of this field is set to `true`, the passcode must have at least one special character(!, @, #...).","example":true},"minimum_password_length":{"maximum":14,"minimum":8,"type":"integer","description":"Specify a minimum length for the passcode. The passcode 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 passcode length requirement (minimum of 8 characters) will be applied for the requirement.","example":8},"weak_enhance_detection":{"type":"boolean","description":"If the value of this field is set to `true`, user passcodes will have to pass detection through a weak passcode dictionary in case hackers use simple passcodes to sign in to your users' accounts.","example":false},"first_login_rule":{"type":"boolean","description":"Whether new users must change their passwords upon first sign-in.","example":true},"former_rule":{"type":"integer","description":"The number of previous passwords that users cannot reuse. A value of `0` removes this rule.","example":5,"enum":[0,3,4,5,6,7,8,9,10,11,12]},"change_rule":{"type":"integer","description":"The maximum number of password changes allowed within 24 hours. A value of `0` removes this rule.","example":3,"enum":[0,1,2,3,4,5,6,7,8]},"expired_rule":{"type":"integer","description":"The number of days after which a password expires automatically. A value of `0` removes this rule.","example":90,"enum":[0,30,60,90,120]}},"description":"This object refers to the [enhanced passcode 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 passcode."},"sign_again_period_for_inactivity_on_client":{"type":"integer","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.   \n \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. \n \n\n`5` - 5 minutes.  \n \n`10` - 10 minutes.  \n \n`15` - 15 minutes.  \n \n`30` - 30 minutes.  \n \n`45` - 45 minutes.  \n \n`60` - 60 .  \n \n`90` - 90 minutes.  \n \n`120` - 120 minutes.\n","example":5},"sign_again_period_for_inactivity_on_web":{"type":"integer","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.   \n \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. \n \n\n`5` - 5 minutes.  \n \n`10` - 10 minutes.  \n \n`15` - 15 minutes.  \n \n`30` - 30 minutes.  \n \n`60` - 60 minutes.  \n \n`120` - 120 minutes.\n\n\n\n","example":10},"sign_in_with_two_factor_auth":{"type":"string","description":"Settings for 2FA( [two factor authentication](https://support.zoom.us/hc/en-us/articles/360038247071) ).\n`all` - Two factor authentication will be enabled for all users in the account.  \n \n`none` - Two factor authentication is disabled.  \n \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.  \n \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","example":"none","enum":["all","group","role","none"]},"sign_in_with_two_factor_auth_groups":{"type":"array","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"}},"sign_in_with_two_factor_auth_roles":{"type":"array","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"}},"sign_in_with_google":{"type":"object","properties":{"enable_sign_in_with_google":{"type":"boolean","description":"Whether to allow users to sign in with Google.","example":true},"force_google_login":{"type":"boolean","description":"Whether to require users from configured domains to sign in with Google.","example":true},"google_login_domains":{"type":"array","description":"Approved account domains assigned to Google force redirect.","example":["example.com"],"items":{"type":"string","example":"example.com"}}},"description":"Google sign-in settings."},"otp_auth":{"type":"boolean","description":"Whether OTP authentication is enabled.","example":true},"enforce_logout_bypass_management":{"type":"object","properties":{"allow_zr_stay_signed_in":{"type":"boolean","description":"Whether Zoom Rooms can stay signed in.","example":true},"allow_zpa_stay_signed_in":{"type":"boolean","description":"Whether Zoom Phone Appliance devices can stay signed in.","example":false}},"description":"Settings that allow selected applications to bypass enforced logout."},"hide_push_notification_content":{"type":"boolean","description":"Whether push notification content is hidden.","example":true},"support_clock_out":{"type":"boolean","description":"Whether the clock-out security feature is enabled.","example":true},"require_biometric_auth":{"type":"boolean","description":"Whether biometric authentication is required.","example":true},"block_screenshots":{"type":"boolean","description":"Whether screenshots are blocked.","example":true},"sign_in_with_work_email":{"type":"boolean","description":"Whether users can sign in with a work email address.","example":true},"sign_in_with_fb":{"type":"boolean","description":"Whether users can sign in with Facebook.","example":false},"sign_in_with_apple":{"type":"boolean","description":"Whether users can sign in with Apple.","example":true},"sign_in_with_microsoft":{"type":"boolean","description":"Whether users can sign in with Microsoft.","example":true},"sign_in_with_phone_number":{"type":"object","properties":{"enable_sign_in_with_phone_number":{"type":"boolean","description":"Whether users can sign in with a phone number.","example":true},"sign_in_with_sms_code":{"type":"boolean","description":"Whether users can sign in with an SMS verification code.","example":true}},"description":"Phone number sign-in settings."},"sign_in_with_passkey":{"type":"boolean","description":"Whether users can sign in with a passkey.","example":true},"sign_in_with_outlook":{"type":"object","properties":{"enable_sign_in_with_outlook":{"type":"boolean","description":"Whether users can sign in with Outlook.","example":true},"zm_official_nested_app_auth":{"type":"boolean","description":"Whether official nested application authorization is enabled.","example":true},"enable_custom_nested_app_auth":{"type":"boolean","description":"Whether custom nested application authorization is enabled.","example":false},"custom_nested_app_id":{"type":"string","description":"The custom nested application ID.","example":"00000000-0000-0000-0000-000000000000"}},"description":"Outlook sign-in settings."},"only_mdm_mobile_can_sign_in":{"type":"object","properties":{"enable_only_mdm_mobile_sign_in":{"type":"boolean","description":"Whether the MDM-managed device sign-in parent restriction is enabled. Does not encode Mobile vs PC.","example":true},"only_mdm_mobile_can_sign_in_tag":{"type":"string","description":"The MDM management tag required when the parent restriction is enabled.","example":"corporate"}},"description":"Deprecated. Parent on/off and MDM tag only; does not encode Mobile vs PC. Use `only_mdm_managed_devices_can_sign_in` instead.","deprecated":true},"only_zoom_for_intune_app_can_sign_in":{"type":"boolean","description":"Whether users can sign in only through the Zoom for Intune application.","example":true},"trusted_microsoft_tenant":{"type":"string","description":"A JSON-encoded array of trusted Microsoft tenant IDs. Each tenant ID must be a UUID.","example":"[\"123e4567-e89b-12d3-a456-426614174000\"]"},"multiple_resource_login":{"type":"object","properties":{"enable_multiple_resource_login":{"type":"boolean","description":"Whether multiple resource login is enabled.","example":true},"multiple_resource_login_limit":{"type":"integer","description":"The maximum number of concurrent resource logins.","example":3}},"description":"Multiple resource login settings."},"automatic_sign_out":{"type":"object","properties":{"enable_separated_sign_out_settings":{"type":"boolean","description":"Whether each login method can use different sign-out durations for different platforms.","example":true},"email_or_phone":{"type":"object","properties":{"desktop_client":{"type":"integer","description":"Automatic sign-out duration in seconds. `-1` disables automatic sign-out for this platform.","example":5184000,"enum":[-1,3600,10800,21600,43200,86400,259200,604800,1296000,2592000,5184000,7776000,10368000,15552000]},"mobile_client":{"type":"integer","description":"Automatic sign-out duration in seconds. `-1` disables automatic sign-out for this platform.","example":5184000,"enum":[-1,3600,10800,21600,43200,86400,259200,604800,1296000,2592000,5184000,7776000,10368000,15552000]},"web_browser":{"type":"integer","description":"Automatic sign-out duration in seconds. `-1` disables automatic sign-out for this platform.","example":5184000,"enum":[-1,3600,10800,21600,43200,86400,259200,604800,1296000,2592000,5184000,7776000,10368000,15552000]},"zoom_scheduling_integration":{"type":"integer","description":"Automatic sign-out duration in seconds. `-1` disables automatic sign-out for this platform.","example":7776000,"enum":[-1,3600,10800,21600,43200,86400,259200,604800,1296000,2592000,5184000,7776000,10368000,15552000]}},"description":"Automatic sign-out settings for email or phone number login."},"sso":{"type":"object","properties":{"desktop_client":{"type":"integer","example":2592000,"enum":[-1,900,1800,3600,10800,21600,43200,86400,259200,604800,1296000,2592000,5184000,7776000,10368000,15552000]},"mobile_client":{"type":"integer","example":2592000,"enum":[-1,900,1800,3600,10800,21600,43200,86400,259200,604800,1296000,2592000,5184000,7776000,10368000,15552000]},"web_browser":{"type":"integer","example":2592000,"enum":[-1,900,1800,3600,10800,21600,43200,86400,259200,604800,1296000,2592000,5184000,7776000,10368000,15552000]},"zoom_scheduling_integration":{"type":"integer","example":2592000,"enum":[-1,900,1800,3600,10800,21600,43200,86400,259200,604800,1296000,2592000,5184000,7776000,10368000,15552000]}},"description":"Automatic sign-out settings for SSO login. SSO additionally supports 900 and 1800 seconds."},"social_oauth":{"type":"object","properties":{"desktop_client":{"type":"integer","example":-1,"enum":[-1]},"mobile_client":{"type":"integer","example":-1,"enum":[-1]},"web_browser":{"type":"integer","example":2592000,"enum":[-1,3600,10800,21600,43200,86400,259200,604800,1296000,2592000,5184000,7776000,10368000,15552000]},"zoom_scheduling_integration":{"type":"integer","example":-1,"enum":[-1]}},"description":"Automatic sign-out settings for social OAuth login. Only `web_browser` is supported. Other platform values are always `-1`."}},"description":"Automatically sign users out after a specified period."},"only_mdm_managed_devices_can_sign_in":{"type":"object","properties":{"enable":{"type":"boolean","description":"Whether to enable the MDM-managed device sign-in restriction.","example":true},"only_mdm_managed_mobile_can_sign_in":{"type":"boolean","description":"Whether to restrict MDM tag checks to mobile Zoom clients when the parent restriction is enabled.","example":true},"only_mdm_managed_pc_can_sign_in":{"type":"boolean","description":"Whether to restrict MDM tag checks to Windows, Mac, and Linux Zoom clients when the parent restriction is enabled.","example":false},"only_mdm_managed_devices_can_sign_in_tag":{"maxLength":4000,"type":"string","description":"The MDM management tag required when the parent restriction is enabled. Maximum 4,000 characters.","example":"corporate"}},"description":"Restricts Zoom client sign-in to MDM-managed mobile and/or PC devices, including the required management tag."}},"description":"[Security settings](https://support.zoom.us/hc/en-us/articles/360034675592-Advanced-security-settings#h_bf8a25f6-9a66-447a-befd-f02ed3404f89) of an Account."},"audio_conferencing":{"type":"object","properties":{"toll_free_and_fee_based_toll_call":{"type":"object","properties":{"allow_webinar_attendees_dial":{"type":"boolean","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 with version 5.2.2 or later.","example":true},"enable":{"type":"boolean","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.","example":true},"numbers":{"type":"array","description":"The account's **Toll-free and Fee-based Toll Call** phone number information.","items":{"type":"object","properties":{"code":{"type":"string","description":"The phone number's [E.164 country calling code](https://en.wikipedia.org/wiki/List_of_country_calling_codes).","example":"86"},"country_code":{"type":"string","description":"The phone number's two letter [country code](https://developers.zoom.us/docs/api/rest/other-references/abbreviation-lists/#countries).","example":"CN"},"country_name":{"type":"string","description":"The country name.","example":"China"},"display_number":{"maxLength":30,"type":"string","description":"The phone number's display number.","example":"+86 777 777 77"},"number":{"maxLength":30,"type":"string","description":"The phone number.","example":"777 777 77"}}}}},"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."},"toll_call":{"type":"object","properties":{"enable":{"type":"boolean","description":"Whether the account has the [**Toll Call**](https://support.zoom.com/hc/en/article?id=zm_kb&sysparm_article=KB0066909#h_01F51680NJ7YHZDXGJNSKDGM2P) setting enabled.","example":true},"numbers":{"type":"array","description":"The account's **Toll Call** phone number information.","items":{"type":"object","properties":{"code":{"type":"string","description":"The phone number's [E.164 country calling code](https://en.wikipedia.org/wiki/List_of_country_calling_codes).","example":"86"},"country_code":{"type":"string","description":"The phone number's two letter [country code](https://developers.zoom.us/docs/api/rest/other-references/abbreviation-lists/#countries).","example":"CN"},"country_name":{"type":"string","description":"The country name.","example":"China"},"display_number":{"maxLength":30,"type":"string","description":"The phone number's display number.","example":"+86 777 777 77"},"number":{"maxLength":30,"type":"string","description":"The phone number.","example":"777 777 77"}}}}},"description":"The account's [**Toll Call**](https://support.zoom.com/hc/en/article?id=zm_kb&sysparm_article=KB0066909#h_01F51680NJ7YHZDXGJNSKDGM2P) settings."},"call_me_and_invite_by_phone":{"type":"object","properties":{"enable":{"type":"boolean","description":"Whether the account has the [**Call Me and Invite by Phone**](https://support.zoom.com/hc/en/article?id=zm_kb&sysparm_article=KB0067414#h_01F53VFZMDP4EJAF772N7NG2KY) setting enabled.","example":true},"require_press_1_for_call_me":{"type":"string","description":"Require Call Me users to press 1 before being connected to the meeting. \n* `auto` - Automatically determine whether to require pressing 1 before connecting to the meeting. \n* `always` - Always require Call Me users to press 1 before connecting to the meeting. \n* `never` - Never require Call Me users to press 1 before connecting to the meeting.","example":"auto","enum":["auto","always","never"],"x-enum-descriptions":["Automatically determine whether to require pressing 1 before connecting to the meeting.","Always require Call Me users to press 1 before connecting to the meeting.","Never require Call Me users to press 1 before connecting to the meeting."]},"allow_webinar_attendees_call_me":{"type":"boolean","description":"Whether webinar attendees can use Call Me to connect audio. This feature is only available in version 5.2.2 and higher.","example":true},"call_out_countries":{"type":"object","properties":{"allowed_countries":{"type":"array","description":"The list of all available countries/regions that can be enabled for call out.","items":{"type":"object","properties":{"code":{"type":"string","description":"The [code](https://developers.zoom.us/docs/api/rest/other-references/abbreviation-lists/#countries) of the country or region.","example":"CN"},"name":{"type":"string","description":"The name of the country or region.","example":"China"}}}},"selected_countries":{"type":"array","description":"The list of countries/regions that users can call out to.","items":{"type":"object","properties":{"code":{"type":"string","description":"The [code](https://developers.zoom.us/docs/api/rest/other-references/abbreviation-lists/#countries) of the country or region.","example":"CN"},"name":{"type":"string","description":"The name of the country or region.","example":"China"}}}}},"description":"The account's call out countries/regions settings."}},"description":"The account's [**Call Me and Invite by Phone**](https://support.zoom.com/hc/en/article?id=zm_kb&sysparm_article=KB0067414#h_01F53VFZMDP4EJAF772N7NG2KY) settings."},"personal_audio_conference":{"type":"boolean","description":"Whether the account has the [**Personal Audio Conference**](https://support.zoom.com/hc/en/article?id=zm_kb&sysparm_article=KB0060449#h_01F5BPMEB7GK6XXPKHDBHYFF27) setting enabled.","example":true},"participant_phone_masking":{"type":"object","properties":{"enable":{"type":"boolean","description":"Whether the account has the [**Mask phone number in the participant list**](https://support.zoom.com/hc/en/article?id=zm_kb&sysparm_article=KB0067881#h_01F5K5GT9P563K751K3JNAYE6E) setting enabled.","example":true},"masking_type":{"type":"string","description":"The type of phone number masking pattern to apply. \n* `mask_default` - Default masking pattern (Example: 888****666). \n* `mask_first_5` - Mask first five digits (Example: *****66666). \n* `mask_except_last_4` - Mask everything except last four digits (Example: *****6666).","example":"mask_default","enum":["mask_default","mask_first_5","mask_except_last_4"],"x-enum-descriptions":["Default masking pattern (Example: 888****666).","Mask first five digits (Example: *****66666).","Mask everything except last four digits (Example: *****6666)."]}},"description":"The account's [**Mask phone number in the participant list**](https://support.zoom.com/hc/en/article?id=zm_kb&sysparm_article=KB0067881#h_01F5K5GT9P563K751K3JNAYE6E) settings."},"global_dial_in_countries":{"type":"object","properties":{"allowed_countries":{"type":"array","description":"The list of all available countries/regions that can be selected for displaying dial-in numbers in the meeting invitation.","items":{"type":"object","properties":{"code":{"type":"string","description":"The [code](https://developers.zoom.us/docs/api/rest/other-references/abbreviation-lists/#countries) of the country or region.","example":"CN"},"name":{"type":"string","description":"The name of the country or region.","example":"China"}}}},"selected_countries":{"type":"array","description":"The list of selected countries/regions whose dial-in numbers will be listed in the email invitation.","items":{"type":"object","properties":{"code":{"type":"string","description":"The [code](https://developers.zoom.us/docs/api/rest/other-references/abbreviation-lists/#countries) of the country or region.","example":"CN"},"name":{"type":"string","description":"The name of the country or region.","example":"China"}}}},"include_toll_free":{"type":"boolean","description":"Whether to include toll-free numbers in the email invitation for the selected countries/regions.","example":true}},"description":"The account's [**Global Dial-in Countries/Regions**](https://support.zoom.com/hc/en/article?id=zm_kb&sysparm_article=KB0068094#h_01F5KK9J31ZXNW10BRH86NHX4G) settings."}},"description":"Account Audio Conference Settings"},"chat":{"type":"object","properties":{"allow_bots_chat":{"type":"boolean","description":"Whether chatbots added to chats and channels can read and write messages.","example":true},"share_files":{"type":"object","properties":{"enable":{"type":"boolean","description":"Allow users to view, share, and forward files in chats and channels. When disabled, users can still take, share, and forward screenshots; record and forward voice and video messages; send and forward GIF images; and send and forward code snippets if those specific settings are enabled.","example":true},"share_option":{"type":"string","description":"Allow users of this account to send files in chats and channels.","example":"account","enum":["disable","anyone","account","organization"],"x-enum-descriptions":["Disabled sharing","Anyone (internal and external contacts)","In the same account","In the same organization"]},"view_option":{"type":"string","description":"Allow users of this account to view files in chats and channels.","example":"anyone","enum":["anyone","account","organization"],"x-enum-descriptions":["Anyone (internal and external contacts)","In the same account","In the same organization"]},"restrictions":{"type":"object","properties":{"only_allow_specific_file_types":{"type":"boolean","description":"Only allow specified file types.","example":true},"file_type_restrictions":{"type":"array","description":"Specified file type.","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","description":"Specified file type.","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]},"file_restrictions_apply_to":{"type":"string","description":"Apply restrictions to both sharing and viewing, or only apply to sharing","example":"sharing_and_viewing","enum":["sharing_and_viewing","sharing"],"x-enum-descriptions":["Sharing and viewing","Sharing only"]}},"description":"User restrictions for sharing and viewing files in chats and channels."}},"description":"Users can share and view files in chats and channels."},"chat_emojis":{"type":"object","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","description":"All emojis / selected emojis","example":"all","enum":["all","selected"],"x-enum-descriptions":["All emojis","Selected emojis"]}},"description":"Chat emojis."},"record_voice_messages":{"type":"boolean","description":"Allow users to record voice messages that can be sent in direct messages or group conversations.","example":true},"record_video_messages":{"type":"boolean","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.","example":true},"screen_capture":{"type":"boolean","description":"Allow users to take and send screenshots in direct messages or group conversations.","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},"create_group_chat":{"type":"boolean","description":"Allow users to create group chats.","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","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"}},"description":"Set retention period for messages and files in Zoom's cloud."},"set_retention_period_in_local":{"type":"object","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"}},"description":"Store messages on local devices, excluding personal channel messages."},"allow_users_to_add_contacts":{"type":"object","properties":{"enable":{"type":"boolean","description":"By disabling this setting, users will not be able to add contacts.","example":true},"selected_option":{"type":"integer","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.","example":4,"enum":[1,2,3,4]},"user_email_addresses":{"type":"string","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.","example":"123@test.com"}},"description":"Allow users to add contacts."},"allow_users_to_chat_with_others":{"type":"object","properties":{"enable":{"type":"boolean","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.","example":true},"selected_option":{"type":"integer","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.","example":4,"enum":[1,2,3,4]},"user_email_addresses":{"type":"string","description":"The domains or emails, internal or external. \n* When the `selected_option` field value is `3`, the value is internal or external domains. Separate multiple domains with a comma. 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.","example":"123@test.com"}},"description":"Allow users to chat with others."},"chat_etiquette_tool":{"type":"object","properties":{"enable":{"type":"boolean","description":"Whether to enable the **Chat Etiquette Tool**.","example":true},"policies":{"type":"array","description":"Information about the defined **Chat Etiquette Tool** policies.","items":{"type":"object","properties":{"description":{"type":"string","description":"The policy's description.","example":"The policy's description"},"id":{"type":"string","description":"The policy ID.","example":"afwef342tr2qfwrg"},"is_locked":{"type":"boolean","description":"Whether the policy is locked by an account-level user. When it is locked, users cannot update the policy.","example":true},"keywords":{"type":"array","description":"A list of defined rule keywords.","items":{"type":"string","example":"test"}},"name":{"type":"string","description":"The policy name.","example":"The policy name"},"regular_expression":{"type":"string","description":"The regular expression to match to the content of chat messages.","example":"^test"},"status":{"type":"string","description":"The policy's current status. \n* `activated` - Activated. \n* `deactivated` - Deactivated.","example":"activated","enum":["activated","deactivated"],"x-enum-descriptions":["Activated.","Deactivated."]},"trigger_action":{"type":"integer","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.","example":1,"enum":[1,2],"x-enum-descriptions":["Ask the user to confirm before they send the message.","Block the user's message."]}}}},"policy_max_count":{"type":"integer","description":"The read-only maximum number of **Chat Etiquette Tool** policies.","example":50}},"description":"Information about the **Chat Etiquette Tool**."},"send_data_to_third_party_archiving_service":{"type":"object","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.","example":"global_relay","enum":["global_relay","smarsh"],"x-enum-descriptions":["Global Relay","Smarsh"]},"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"}},"description":"Send data to third-party archiving service."},"apply_local_storage_to_personal_channel":{"type":"object","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"}},"description":"Store personal channel messages on local devices."},"translate_messages":{"type":"boolean","description":"Allow users to translate team chat messages. [Learn more].(https://support.zoom.us/hc/en-us/articles/12998089084685)","example":true},"search_and_send_animated_gif_images":{"type":"object","properties":{"enable":{"type":"boolean","description":"Whether to allow users to search GIF images from GIPHY when they compose messages.","example":true},"giphy_content_rating":{"type":"integer","description":"Set the GIPHY content rating. This feature is only available for Zoom Client v5.11.0 or later.","example":1,"enum":[1,2,3,4],"x-enum-descriptions":["G - Level 1","PG - Level 2","PG-13 - Level 13","R - Level 4"]}},"description":"Allow users to search GIF images from GIPHY when they compose messages. See GIPHY's website for more information about content ratings."},"external_collab_restrict":{"type":"object","properties":{"enable":{"type":"boolean","description":"Restrict external collaboration in group chats and channels for a select group","example":true},"external_chat":{"type":"string","description":"The type of restrict external collaboration in group chats and channels for a select group\n*  - Allowed user group\n*  - Not allowed user group","example":"allowed","enum":["allowed","not_allowed"]},"group_id":{"type":"string","description":"The group Id","example":"QSuHwTcvQoWPoG0ennkRug"}},"description":"Restrict external collaboration in group chats and channels for a select group"},"external_user_control":{"type":"object","properties":{"enable":{"type":"boolean","description":"Allow to add external users into group chats and channels","example":true},"selected_option":{"type":"integer","description":"The type of allowing external user control \n* 1 - Everyone\n* 2 - Only members in your organization, plus specified external accounts\n* 3 - Only the account owner and admins","example":1,"enum":[1,2,3]},"external_account":{"type":"boolean","description":"Allow this setting to be edited for specified accounts","example":true}},"description":"Add external users into group chats and channels"},"external_invite_approve":{"type":"object","properties":{"enable":{"type":"boolean","description":"Require admin approval for adding external users in group chats and channels","example":true},"selected_option":{"type":"integer","description":"The type of requiring admin approval for adding external users in group chats and channels* 1 - Send requests directly to all approvers* 2 - Send requests to a specific channel","example":1,"enum":[1,2]},"channel_id":{"type":"string","description":"The channel Id","example":"5fedbc697f8545aca465b5b114ad4275"},"external_account":{"type":"boolean","description":" Allow this setting to be edited for specified accounts","example":true}},"description":"Require admin approval for adding external users in group chats and channels"},"external_member_join":{"type":"object","properties":{"enable":{"type":"boolean","description":"Allow members of your organization to join external group chats and channels","example":true},"external_account":{"type":"boolean","description":"Allow this setting to be edited for specified accounts","example":true}},"description":"Allow members of your organization to join external group chats and channels"},"external_join_approve":{"type":"object","properties":{"enable":{"type":"boolean","description":"Require admin approval for joining external group chats and channels","example":true},"selected_option":{"type":"integer","description":"The type of requiring admin approval for joining external group chats and channels\n* 1 - Send requests directly to all approvers\n* 2 - Send requests to a specific channel","example":1,"enum":[1,2]},"channel_id":{"type":"string","description":"The channel Id","example":"5fedbc697f8545aca465b5b114ad4275"},"external_account":{"type":"boolean","description":"Allow this setting to be edited for specified accounts","example":true}},"description":"Require admin approval for joining external group chats and channels"},"download_file":{"type":"boolean","description":"Downloading files","example":true},"share_screen_in_chat":{"type":"boolean","description":"Share screen in chat","example":true},"code_snippet":{"type":"boolean","description":"Send code snippet","example":true},"personal_channel":{"type":"boolean","description":"Enable Personal Chat","example":true},"store_revise_chat":{"type":"boolean","description":"Store edited and deleted message revisions","example":false},"set_chat_as_default_tab":{"type":"boolean","description":"Set Team Chat as a default tab for first-time users","example":false},"hyper_link":{"type":"boolean","description":"Allow hyperlinks in Team Chat","example":true},"suppress_removal_notification":{"type":"boolean","description":"Suppress deleted, deactivated, and reactivated user notice in group chats and channels","example":true},"suppress_user_group_notification":{"type":"boolean","description":"Suppress add and remove user notice in channels","example":false},"allow_remove_msg_by_owner_and_admins":{"type":"boolean","description":"Allow channel owner and admin(s) to remove messages of other members","example":true},"allow_huddles_from_channels":{"type":"boolean","description":"Allow huddles from channels","example":true},"shared_spaces":{"type":"boolean","description":"Allow users to create Shared Spaces","example":true},"chat_email_address":{"type":"object","properties":{"enable":{"type":"boolean","description":"Chat email address","example":true},"only_allow_specific_domains":{"type":"boolean","description":"Only allow emails from specified domains","example":false},"specific_domains":{"type":"array","description":"Specified domains.","items":{"type":"string","description":"Specified domains.","example":"[\"example.com\"]"}}},"description":"Allow users to create email addresses for chats and channels. Email sent to a created address will also be posted in respective chat or channel."},"read_receipts":{"type":"object","properties":{"enable":{"type":"boolean","description":"Enable read receipts","example":false},"allow_users_opt_out":{"type":"boolean","description":"Allow users to opt out","example":false}},"description":"Indicate when messages have been seen by recipients, for chats and channels with less than 20 members."},"allow_delete_message":{"type":"object","properties":{"enable":{"type":"boolean","description":"Allow users to delete messages","example":true},"time":{"type":"integer","description":"Within how many minitues of posting","example":5,"enum":[0,5,30,60,1440,10080]}},"description":"When this setting is enabled, users can delete their own messages in Team Chat. If the user is the channel owner or admin and this setting is disabled, the user will also not be able to remove messages of other members in that channel even if other settings allow this. Time frame is configurable even when account setting is OFF and unlocked."},"allow_edit_message":{"type":"object","properties":{"enable":{"type":"boolean","description":"Allow users to edit messages","example":true},"time":{"type":"integer","description":"Within how many minitues of posting","example":5,"enum":[0,5,30,60,1440,10080]}},"description":"When this setting is enabled, users can edit their own messages in Team Chat. Time frame is configurable even when account setting is OFF and unlocked."},"show_status_to_internal_contact":{"type":"boolean","description":"Show status to internal contacts","example":true},"presence_on_meeting":{"type":"boolean","description":"Change my presence status when I am in a meeting or call","example":true},"presence_away_when_screen_saver":{"type":"boolean","description":"Change my status to away when screen saver begins","example":false},"show_h323_contact_tab":{"type":"boolean","description":"Show H.323 contacts","example":false},"ai_summary":{"type":"object","properties":{"enable":{"type":"boolean","description":"Summarize with AI Companion","example":false},"shown_in_team_chat":{"type":"boolean","description":"Show in Team Chat","example":true}},"description":"The field has been moved from the `chat` object to the `ai` object and renamed to `chat_summary` to better reflect its functionality.\n\nAllow users to summarize chats, channels, and shared documents.","deprecated":true},"ai_compose":{"type":"object","properties":{"enable":{"type":"boolean","description":"Compose with AI Companion","example":false},"shown_in_team_chat":{"type":"boolean","description":"Show in Team Chat","example":true}},"description":"The field has been moved from the `chat` object to the `ai` object and renamed to `chat_compose` to better reflect its functionality.\nAllow users to summarize chats, channels, and shared documents.","deprecated":true},"ai_recommend":{"type":"boolean","description":"**Zoom no longer supports this feature.**\nChat Recommendation with Zoom AI Companion","example":false,"deprecated":true},"ai_quick_reply":{"type":"boolean","description":"**Zoom no longer supports this feature.**\n\nQuick reply with AI Companion.","example":false,"deprecated":true},"ai_sentence_completion":{"type":"boolean","description":"**Zoom no longer supports this feature.**\n\nSentence completion with AI Companion","example":false,"deprecated":true},"ai_quick_schedule":{"type":"boolean","description":"**Zoom no longer supports this feature.**\n\nQuick schedule with AI Companion","example":false,"deprecated":true},"survey_poll":{"type":"boolean","description":"Allow users to launch a poll in chats and channels","example":true}},"description":"The account's chat settings."},"email_notification":{"type":"object","properties":{"alternative_host_reminder":{"type":"boolean","description":"Notify when an alternative host is set or removed from a meeting.","example":true},"cancel_meeting_reminder":{"type":"boolean","description":"Notify the host and participants when a meeting is cancelled.","example":true},"cloud_recording_available_reminder":{"type":"boolean","description":"Whether to notify the host when a cloud recording is available.","example":true},"jbh_reminder":{"type":"boolean","description":"Notify the host when participants join the meeting before them.","example":true},"low_host_count_reminder":{"type":"boolean","description":"Notify user when host licenses are running low.","example":true},"recording_available_reminder_alternative_hosts":{"type":"boolean","description":"Whether to notify any alternative hosts when a cloud recording is available.","example":true},"recording_available_reminder_schedulers":{"type":"boolean","description":"Whether to notify the person who scheduled the meeting or webinar for the host when a cloud recording is available.","example":true},"schedule_for_reminder":{"type":"boolean","description":"Notify the host there is a meeting is scheduled, rescheduled, or cancelled.","example":true}},"description":"Account Settings: Notification."},"feature":{"type":"object","properties":{"meeting_capacity":{"type":"integer","description":"Set the maximum number of participants a host can have in a single meeting.","example":100}},"description":"Account Settings: Feature."},"in_meeting":{"type":"object","properties":{"auto_generated_translation":{"type":"object","properties":{"language_item_pairList":{"type":"object","properties":{"trans_lang_config":{"type":"array","description":"The speaking language and caption language list.","items":{"type":"object","properties":{"speak_language":{"type":"object","properties":{"name":{"type":"string","description":"The input speaking language.","example":"Chinese (Simplified)","enum":["Chinese (Simplified)","Dutch","English","French","German","Italian","Japanese","Korean","Portuguese","Russian","Spanish","Ukrainian"]},"code":{"type":"string","description":"The input speaking language [code](https://marketplace.zoom.us/docs/api-reference/other-references/abbreviation-lists/#languages). ","example":"zh","enum":["zh","nl","en","fr","de","it","ja","ko","pt","ru","es","uk"]}},"description":"The input speaking language in meetings."},"translate_to":{"type":"object","properties":{"all":{"type":"boolean","description":"The option to select all translated output caption languages.","example":true},"language_config":{"type":"array","description":"The translated output caption language list.","items":{"type":"object","properties":{"name":{"type":"string","description":"The  translated output caption language name.","example":"English","enum":["English"]},"code":{"type":"string","description":"The translated output caption language [code](https://marketplace.zoom.us/docs/api-reference/other-references/abbreviation-lists/#languages).","example":"en","enum":["en"]}},"description":"The translated output caption language."}}},"description":"The translated output caption language."}},"description":"The speaking language and translated caption in meetings."}},"all":{"type":"boolean","description":"The option to select all language pairs.","example":true}},"description":"The input speaking language and output caption language pair list."},"enable":{"type":"boolean","description":"The option for participants to enable the automated translation captions in meetings.","example":true}},"description":"The [translated captions](https://support.zoom.us/hc/en-us/articles/6643133682957-Enabling-and-configuring-translated-captions) setting in meetings."},"alert_guest_join":{"type":"boolean","description":"Identify guest participants in a meeting or webinar.","example":true},"allow_host_to_enable_focus_mode":{"type":"boolean","description":"Whether the host can enable [**Focus Mode**](https://support.zoom.us/hc/en-us/articles/360061113751-Using-focus-mode) when scheduling a meeting.","example":true},"allow_live_streaming":{"type":"boolean","description":"Whether to allow livestreaming.","example":true},"allow_participants_chat_with":{"type":"integer","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.","example":4,"enum":[1,2,3,4],"x-enum-descriptions":["No one","Host and co-hosts","Everyone","Everyone and anyone directly"]},"allow_participants_to_rename":{"type":"boolean","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","example":true},"allow_show_zoom_windows":{"type":"boolean","description":"Show the Zoom desktop application when sharing screens. ","example":true},"allow_users_save_chats":{"type":"integer","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.","example":2,"enum":[1,2,3],"x-enum-descriptions":["Not allow","Host and co-hosts","Everyone"]},"annotation":{"type":"boolean","description":"Allow participants to use annotation tools to add information to shared screens.","example":true},"anonymous_question_answer":{"type":"boolean","description":"Allow an anonymous Q&amp;A in a webinar.","example":true},"attendee_on_hold":{"type":"boolean","description":"Allow host to put attendee on hold.\n\n**This field has been deprecated and is no longer supported.**","example":true,"deprecated":true,"default":false},"attention_mode_focus_mode":{"type":"boolean","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`.","example":true,"default":false},"auto_answer":{"type":"boolean","description":"Enable users to see and add contacts to the `auto-answer group` in the chat contact list. Any call from members of this group will automatically be answered.","example":true},"auto_saving_chat":{"type":"boolean","description":"Automatically save all in-meeting chats so that the host does not need to manually save the chat transcript after the meeting starts.","example":true},"breakout_room":{"type":"boolean","description":"Allow host to split meeting participants into separate, smaller rooms.","example":true},"breakout_room_schedule":{"type":"boolean","description":"Whether the host can assign participants to breakout rooms when scheduling. This feature is **only** available in version 4.5.0 or higher.","example":true},"chat":{"type":"boolean","description":"Allow meeting participants to send a message that is visible to all participants.","example":true},"meeting_question_answer":{"type":"boolean","description":"Allow participants to ask questions for the host and participants to answer.","example":true},"closed_caption":{"type":"boolean","description":"Allow a host to type closed captions. Enable a host to assign a participant or third party device to add closed captions. ","example":true},"closed_captioning":{"type":"object","properties":{"auto_transcribing":{"type":"boolean","description":"Whether to allow a live transcription service to transcribe meetings.","example":true},"enable":{"type":"boolean","description":"Whether to allow the host to type closed captions or assign a participant or 3rd-party service to provide closed captioning.","example":true},"save_caption":{"type":"boolean","description":"Whether to allow participants to save closed captions or transcripts.","example":true},"third_party_captioning_service":{"type":"boolean","description":"Whether to allow the use of an API token to integrate with 3rd-party closed captioning services.","example":true},"view_full_transcript":{"type":"boolean","description":"Whether to allow the viewing of full transcripts in the in-meeting side panel.","example":true}},"description":"Information about the account's closed captioning settings."},"co_host":{"type":"boolean","description":"Allow the host to add co-hosts.","example":true},"custom_data_center_regions":{"type":"boolean","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.","example":true},"custom_live_streaming_service":{"type":"boolean","description":"Whether to allow custom livestreaming.","example":true},"custom_service_instructions":{"type":"string","description":"The specific instructions to configure a custom livestream.","example":"1234"},"meeting_data_transit_and_residency_method":{"type":"string","description":"Select meeting data transit and residency method for meeting hosts and participants.  \n `cloud` - Zoom Cloud.  \n `On-Prem` - On-Prem (Zoom Meeting Connector, only applicable for licensed users).","example":"On-Prem","enum":["cloud","On-Prem"],"x-enum-descriptions":["Zoom Cloud","On-Prem (Zoom Meeting Connector, only applicable for licensed users)"]},"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.","example":["AU","LA","CA","CN","DE","HK","IN","IE","TY","MX","NL","SG","US"],"items":{"type":"string","example":"AU","enum":["AU","LA","CA","CN","DE","HK","IN","IE","TY","MX","NL","SG","US"]}},"disable_screen_sharing_for_host_meetings":{"type":"boolean","description":"Whether to enable the **Disable desktop screen sharing for meetings you host** setting.","example":true},"disable_screen_sharing_for_in_meeting_guests":{"type":"boolean","description":"Whether to enable the **Disable screen sharing when guests are in the meeting** setting.","example":true},"dscp_audio":{"maximum":63,"minimum":1,"type":"integer","description":"DSCP audio.","example":1},"dscp_marking":{"type":"boolean","description":"DSCP marking.","example":true},"dscp_video":{"maximum":63,"minimum":1,"type":"integer","description":"DSCP video.","example":63},"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":{"type":"boolean","description":"Zoom requires encryption for all data between the Zoom cloud, Zoom client, and Zoom Room. Require encryption for 3rd party endpoints (H323/SIP).","example":true},"entry_exit_chime":{"type":"string","description":"Play sound when participants join or leave.  \n `host` - Heard by host only.  \n `all` - Heard by host and all attendees.  \n `none` - Disable.","example":"none","enum":["host","all","none"],"x-enum-descriptions":["Heard by host only","Heard by host and all attendees","Disable"]},"far_end_camera_control":{"type":"boolean","description":"Allow another user to take control of your camera during a meeting.","example":true},"feedback":{"type":"boolean","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.","example":true},"file_transfer":{"type":"boolean","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.","example":true},"group_hd":{"type":"boolean","description":"Activate higher quality video for host and participants in Meeting.\nPlease note: This will use more bandwidth.","example":true},"webinar_group_hd":{"type":"boolean","description":"Activate higher quality video for host and participants in Webinar.\nPlease note: This will use more bandwidth.","example":true},"join_from_desktop":{"type":"boolean","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.","example":true},"join_from_mobile":{"type":"boolean","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.","example":true},"language_interpretation":{"type":"object","properties":{"custom_languages":{"type":"array","description":"A list of user-defined supported languages.","example":["English"],"items":{"type":"string","example":"English"}},"enable":{"type":"boolean","description":"Whether to allow hosts to assign participants as interpreters who can interpret one language into another in real-time.","example":true},"enable_language_interpretation_by_default":{"type":"boolean","description":"Whether to enable language interpretation by default.","example":true},"allow_participants_to_speak_in_listening_channel":{"type":"boolean","description":"Whether to allow participants to speak in the listening channel.","example":true},"allow_up_to_25_custom_languages_when_scheduling_meetings":{"type":"boolean","description":"Whether to allow up to 25 custom languages when scheduling meetings.","example":true},"languages":{"type":"array","description":"A list of system-supported languages.","example":["English","Chinese","Japanese","German","French","Russian","Portuguese","Spanish","Korean"],"items":{"type":"string","example":"English","enum":["English","Chinese","Japanese","German","French","Russian","Portuguese","Spanish","Korean"]}}},"description":"Information about the [language interpretation](https://support.zoom.us/hc/en-us/articles/360034919791-Using-Language-Interpretation-in-your-meeting-or-webinar) settings."},"sign_language_interpretation":{"type":"object","properties":{"enable":{"type":"boolean","description":"Whether to allow hosts to assign participants as sign language interpreters who can interpret one language into another in real-time.","example":true},"enable_sign_language_interpretation_by_default":{"type":"boolean","description":"Whether to enable sign language interpretation view by default in scheduler.","example":true},"languages":{"type":"array","description":"A list of system-supported languages.","items":{"type":"string","example":"American","enum":["American","Chinese","French","German","Japanese","Russian","Brazilian","Spanish","Mexican","British"]}},"custom_languages":{"type":"array","description":"A list of user-defined supported languages.","items":{"type":"string","example":"Language1"}}},"description":"Allow hosts to assign participants as sign language interpreters who can interpret one language into sign language in real-time. Hosts can assign interpreters when scheduling, or during the meeting itself. This feature is only available with version 5.11.3 or later."},"live_streaming_facebook":{"type":"boolean","description":"Whether to allow Facebook livestreaming.","example":true},"live_streaming_youtube":{"type":"boolean","description":"Whether to allow YouTube livestreaming.","example":true},"manual_captioning":{"type":"object","properties":{"allow_to_type":{"type":"boolean","description":"Whether to allow the host to manually caption or let the host assign a participant to provide manual captioning.","example":true},"auto_generated_captions":{"type":"boolean","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).","example":true},"full_transcript":{"type":"boolean","description":"Whether to enable the viewing of full transcripts in the in-meeting side panel.","example":true},"manual_captions":{"type":"boolean","description":"Whether to [enable manual closed captioning](https://support.zoom.us/hc/en-us/articles/207279736-Managing-closed-captioning-and-live-transcription).","example":true},"save_captions":{"type":"boolean","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.","example":true},"third_party_captioning_service":{"type":"boolean","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.","example":true}},"description":"Information about manual captioning settings."},"meeting_polling":{"type":"object","properties":{"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},"allow_alternative_host_to_add_edit":{"type":"boolean","description":"Whether to allow the alternative host to add or edit polls and quizzes.","example":true},"manage_saved_polls_and_quizzes":{"type":"boolean","description":"Whether to allow users to manage saved polls and quizzes from Meetings","example":true},"allow_host_to_upload_image":{"type":"boolean","description":"Whether to allow host to upload an image for each question.","example":true},"require_answers_to_be_anonymous":{"type":"boolean","description":"Whether to require answers to be anonymous.","example":true},"enable":{"type":"boolean","description":"Whether to allow the host to add polls before or during a meeting.","example":true}},"description":"Information about the account's meeting polling settings."},"meeting_reactions":{"type":"boolean","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.","example":true},"meeting_reactions_emojis":{"type":"string","description":"Choose from these 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).","example":"all","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) ."]},"allow_host_panelists_to_use_audible_clap":{"type":"boolean","description":"Whether to allow host and panelist to use audible clap.","example":true},"webinar_reactions":{"type":"boolean","description":"Set this field to true to use [webinar reactions](https://support.zoom.us/hc/en-us/articles/4803536268429).","example":true},"meeting_survey":{"type":"boolean","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.","example":true},"original_audio":{"type":"boolean","description":"Allow users to select original sound in their client settings.","example":true},"p2p_connetion":{"type":"boolean","description":"Peer to peer connection while only two people are in a meeting.","example":true},"p2p_ports":{"type":"boolean","description":"Peer to peer listening ports range.","example":true},"polling":{"type":"boolean","description":"Add **Polls** to the meeting controls.","example":true},"ports_range":{"type":"string","description":"The listening ports range, separated by a comma, such as `55,56`. The ports range must be between 1 to 65535.","example":"1;65535","default":""},"post_meeting_feedback":{"type":"boolean","description":"Display a thumbs up or down survey at the end of each meeting.","example":true},"private_chat":{"type":"boolean","description":"Allow a meeting participant to send a private message to another participant.","example":true},"record_play_own_voice":{"type":"boolean","description":"Record and play their own voice.","example":true},"remote_control":{"type":"boolean","description":"Allow users to request remote control.","example":true},"non_verbal_feedback":{"type":"boolean","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`.","example":true,"default":false},"remote_support":{"type":"boolean","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`.","example":true,"default":false},"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":{"type":"boolean","description":"Allow screen sharing.","example":true},"sending_default_email_invites":{"type":"boolean","description":"Only show the default email when sending email invites.","example":true},"show_a_join_from_your_browser_link":{"type":"boolean","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.","example":true},"show_meeting_control_toolbar":{"type":"boolean","description":"Always show the meeting control toolbar.","example":true},"slide_control":{"type":"boolean","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.","example":true},"stereo_audio":{"type":"boolean","description":"Allow users to select stereo audio in their client settings.","example":true},"unchecked_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 **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.","example":["EU","HK","AU","IN","TY","CN","US","CA","DE","NL","LA"],"items":{"type":"string","example":"EU","enum":["EU","HK","AU","IN","TY","CN","US","CA","DE","NL","LA"]}},"use_html_format_email":{"type":"boolean","description":"Use HTML formatted email for the Outlook plugin.","example":true},"virtual_background":{"type":"boolean","description":"Allow users to replace their background with any selected image. Choose or upload an image in the Zoom desktop application settings.","example":true},"virtual_background_settings":{"type":"object","properties":{"allow_upload_custom":{"type":"boolean","description":"Allow users to upload custom backgrounds.","example":true},"allow_videos":{"type":"boolean","description":"Allow use of videos for virtual backgrounds.","example":true},"enable":{"type":"boolean","description":"Enable virtual background.","example":true},"files":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"The file's unique identifier.","example":"ra3NawGWScGhY1hqfY2MJw"},"is_default":{"type":"boolean","description":"Indicates whether or not this file is the default virtual background file.","example":true},"name":{"type":"string","description":"test.png","example":"file name"},"size":{"type":"integer","description":"File size.","example":41519},"type":{"type":"string","description":"File type.","example":"image"}}}}},"description":"Settings to manage virtual background."},"watermark":{"type":"boolean","description":"Add a watermark when viewing a shared screen.","example":true},"webinar_chat":{"type":"object","properties":{"allow_attendees_chat_with":{"type":"integer","description":"Designate who webinar attendees can chat with in the meeting.\n* `1` - No one.\n* `2` - Host and all panelists.\n* `3` - Everyone.","example":2,"enum":[1,2,3]},"allow_auto_save_local_chat_file":{"type":"boolean","description":"Whether to automatically save chat messages to a local file on the host's computer when the webinar ends.","example":true},"allow_panelists_chat_with":{"type":"integer","description":"Designate which other participants users can chat with in the meeting.\n* `1` - Host and all panelists.\n* `2` - Everyone.","example":1,"enum":[1,2]},"allow_panelists_send_direct_message":{"type":"boolean","description":"Whether to allow webinar panelists to send direct messages to other panelists.","example":true},"allow_users_save_chats":{"type":"integer","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.","example":0,"enum":[0,1,2]},"allow_users_to_delete_messages_in_meeting_chat":{"type":"boolean","description":"If the value of this field is set to `true`,  allow users to delete messages in the in-meeting chat.\n","example":true},"default_attendees_chat_with":{"type":"integer","description":"By default, allow webinar attendees to chat with:\n* `1` - Host and all panelists.\n* `2` - Everyone.","example":1,"enum":[1,2]},"enable":{"type":"boolean","description":"Whether to allow webinar participants to send chat messages.","example":true}}},"webinar_live_streaming":{"type":"object","properties":{"custom_service_instructions":{"type":"string","description":"The specific instructions to allow your account's meeting hosts to configure a custom livestream.","example":"The specific instructions"},"enable":{"type":"boolean","description":"Whether to enable webinar livestreaming.","example":true},"live_streaming_reminder":{"type":"boolean","description":"Whether to notify users to watch the livestream. This does not apply to custom RTMP (real-time messaging protocol).","example":true},"live_streaming_service":{"type":"array","description":"The available livestreaming services:\n* `facebook`\n* `workplace_by_facebook`\n* `youtube`\n* `custom_live_streaming_service`","items":{"type":"string","example":"facebook","enum":["facebook","workplace_by_facebook","youtube","custom_live_streaming_service"],"x-enum-descriptions":["Facebook","Workplace by Facebook","YouTube","Custom Live Streaming Service"]}}}},"webinar_polling":{"type":"object","properties":{"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},"allow_alternative_host_to_add_edit":{"type":"boolean","description":"Whether to allow the alternative host to add or edit polls and quizzes.","example":true},"require_answers_to_be_anonymous":{"type":"boolean","description":"Whether to require answers to be anonymous.","example":true},"manage_saved_polls_and_quizzes":{"type":"boolean","description":"Whether to allow users to manage saved polls and quizzes from Webinars","example":true},"allow_host_to_upload_image":{"type":"boolean","description":"Whether to allow host to upload an image for each question.","example":true},"enable":{"type":"boolean","description":"Whether to allow the host to add polls before or during a webinar.","example":true}},"description":"Information about the account's webinar polling settings."},"webinar_question_answer":{"type":"boolean","description":"Whether attendees can ask the host and panelists questions in the webinar.","example":true},"webinar_survey":{"type":"boolean","description":"Whether to allow the host to present surveys to attendees once a webinar has ended.","example":true},"whiteboard":{"type":"boolean","description":"Allow participants to share a whiteboard that includes annotation tools.","example":true},"who_can_share_screen":{"type":"string","description":"Indicates who can share their screen or content during meetings. The value can be one of the following:   \n \n`host`: Only host can share the screen.  \n \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","example":"all","enum":["host","all"]},"who_can_share_screen_when_someone_is_sharing":{"type":"string","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:  \n \n`host`: Only a host can share the screen when someone else is sharing.  \n \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","example":"all","enum":["host","all"]},"participants_share_simultaneously":{"type":"string","description":"Indicates how many participants can share at the same time. The value can be one of the following:  \n \n`one`: Only one participant can share at a time\n.  \n \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","example":"multiple","enum":["multiple","one"]},"workplace_by_facebook":{"type":"boolean","description":"Whether to allow Workplace by Facebook livestreaming.","example":true},"transfer_meetings_between_devices":{"type":"boolean","description":"Users can move to a new device without leaving the meeting they're in.","example":true},"meeting_summary_with_ai_companion":{"type":"object","properties":{"enable":{"type":"boolean","description":"Whether to allow hosts to generate a summary.","example":true},"auto_enable":{"type":"boolean","description":"Whether to turn on meeting summary automatically when meetings start","example":true},"who_will_receive_summary":{"type":"integer","description":"Defines who will receive a summary after this meeting. \n* `1` - Only meeting host.\n* `2` - Only meeting host, co-hosts, and alternative hosts. \n* `3` - Only meeting host and meeting invitees in our organization.  \n* `4` - All meeting invitees including those outside of our organization.","example":1,"enum":[1,2,3,4]},"enable_summary_template":{"type":"boolean","description":"Whether to allow users to select a meeting summary template for their meetings. After the meeting, the summary will be generated using the selected template.","example":true},"summary_template_id":{"type":"string","description":"The default summary template ID. The meeting summary template list can be found in the [List meeting summary templates] API.","example":"1e1356ad"}},"description":"As a host, you can generate a summary. Summaries are sent after the meeting has ended based on the share options."},"webinar_summary_with_ai_companion":{"type":"object","properties":{"enable":{"type":"boolean","description":"Whether to allow webinar hosts to generate a summary.","example":true},"auto_enable":{"type":"boolean","description":"Whether to automatically turn on webinar summary when webinars start.","example":true},"who_will_receive_summary":{"type":"integer","description":"Defines who will receive a summary after the webinar. \n* `1` - Only the webinar host.\n* `2` - Only the webinar host, co-hosts, and panelists in your organization.\n* `3` - The webinar host, co-hosts, and all panelists, including those outside your organization.","example":1,"enum":[1,2,3]}},"description":"As a webinar host, you can generate a summary. Summaries are sent after the webinar ends based on the share options."},"ai_companion_questions":{"type":"object","properties":{"enable":{"type":"boolean","description":"Whether to allow hosts and invited participants to ask questions to AI Companion during a meeting.","example":true},"auto_enable":{"type":"boolean","description":"Whether to automatically allow access when the meeting starts","example":true},"who_can_ask_questions":{"type":"integer","description":"Defines who can ask questions about this meeting's transcript. \n* `1` - All participants and invitees.  \n* `2` - All participants only from when they join.  \n* `3` - Only meeting host.  \n* `4` - Participants and invitees in our organization.  \n* `5` - Participants in our organization only from when they join.","example":1,"enum":[1,2,3,4,5]}},"description":"Allow hosts and invited participants to ask questions to AI Companion during a meeting. Questions are answered based on the conversation transcript."},"webinar_ai_companion_questions":{"type":"object","properties":{"enable":{"type":"boolean","description":"Whether to allow webinar hosts and panelists to ask questions to AI Companion during a webinar.","example":true},"auto_enable":{"type":"boolean","description":"Whether to automatically allow access when the webinar starts.","example":true},"who_can_ask_questions":{"type":"integer","description":"Defines who can ask questions about the webinar's transcript. \n* `0` - Hosts and all panelists.  \n* `1` - Hosts and all panelists in your organization.  \n* `2` - Only the webinar host, co-hosts, and alternative hosts.  \n* `3` - All participants.","example":1,"enum":[0,1,2,3]}},"description":"Allow webinar hosts and panelists to ask questions to AI Companion during a webinar. Questions are answered based on the conversation transcript."}},"description":"The in-meeting account setting."},"integration":{"type":"object","properties":{"box":{"type":"boolean","description":"Whether to allow users who join a meeting from their mobile device to share content from their Box account.","example":true},"dropbox":{"type":"boolean","description":"Whether to allow users who join a meeting from their mobile device to share content from their Dropbox account.","example":true},"google_calendar":{"type":"boolean","description":"Whether to enable the scheduling of meetings using Google Calendar.","example":true},"google_drive":{"type":"boolean","description":"Whether to allow users who join a meeting from their mobile device to share content from their Google Drive.","example":true},"kubi":{"type":"boolean","description":"Whether to allow users to control a connected Kubi device from within a Zoom meeting.","example":true},"microsoft_one_drive":{"type":"boolean","description":"Whether to allow users who join a meeting from their mobile device to share content from their Microsoft OneDrive account.","example":true}},"description":"Account Integration Settings"},"other_options":{"type":"object","properties":{"allow_auto_active_users":{"type":"boolean","description":"If true, administrators can activate users with a single default passcode when adding users. This activates added users immediately without waiting for them to set their own passcode.","example":true},"allow_users_contact_support_via_chat":{"type":"boolean","description":"If true, displays the Zoom Help badge on the bottom-right of the page.","example":true},"allow_users_enter_and_share_pronouns":{"type":"boolean","description":"If true, users can add pronouns to their profile cards and share them during meetings and webinars.","example":true},"blur_snapshot":{"type":"boolean","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.","example":true},"display_meetings_scheduled_for_others":{"type":"boolean","description":"If true, a user with [scheduling privileges](https://support.zoom.us/hc/en-us/articles/201362803-Scheduling-privilege) can view other users' meetings.","example":true},"meeting_qos_and_mos":{"type":"integer","description":"The dashboard meeting [quality scores and network alerts](https://support.zoom.us/hc/en-us/articles/360061244651) setting. \n* `0` 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` - Display the meeting quality score and network alerts on the dashboard and use custom thresholds for quality scores and network alerts.","example":0,"enum":[0,1,2,3],"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."]},"show_one_user_meeting_on_dashboard":{"type":"boolean","description":"If true, meetings with only one person will display on the dashboard and in reports.","example":true},"use_cdn":{"type":"string","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.","example":"none","enum":["none","default","wangsu"],"x-enum-descriptions":["Do not 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 will use the Wangsu CDN (China)."]},"webinar_registration_options":{"type":"object","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}},"description":"Webinar registration options."},"email_in_attendee_report_for_meeting":{"type":"boolean","description":"If true, include authenticated guests' email addresses in attendee reports for meetings.","example":true}}},"profile":{"type":"object","properties":{"recording_storage_location":{"type":"object","properties":{"allowed_values":{"type":"array","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.","example":["US","AU","CA","DE","JP","BR","SG","IN"],"items":{"type":"string","example":"US"}},"value":{"type":"string","description":"Abbreviated country code.","example":"US"}}}}},"recording":{"type":"object","properties":{"account_user_access_recording":{"type":"boolean","description":"Cloud recordings are only accessible to account members. People outside of your organization cannot open links that provide access to cloud recordings.","example":true},"allow_recovery_deleted_cloud_recordings":{"type":"boolean","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. ","example":true},"archive":{"type":"object","properties":{"enable":{"type":"boolean","description":"Enable the archiving feature.","example":true},"settings":{"type":"object","properties":{"audio_file":{"type":"boolean","description":"Include in-meeting and/or in-webinar audio in the archive.","example":true},"cc_transcript_file":{"type":"boolean","description":"Include closed caption or transcript in the archive.","example":true},"chat_file":{"type":"boolean","description":"Include in-meeting chat in the archive.","example":true},"chat_with_sender_email":{"type":"boolean","description":"Include user email in in-meeting chat file.","example":true},"video_file":{"type":"boolean","description":"Include in-meeting and/or in-webinar video in the archive.","example":true},"chat_with_direct_message":{"type":"boolean","description":"Include direct message in in-meeting chat file.","example":true},"archive_retention":{"type":"integer","description":"The retention period for archiving content, in days.","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":{"type":"integer","description":"Perform the action when meetings or webinars cannot be archived.  \n `1` - Participants can stay in the meeting and will receive a notification.  \n `2` - Nobody can join or stay in the meeting.","example":1,"enum":[1,2]},"notification_when_archiving_starts":{"type":"string","description":"Show notification when video or audio archiving starts.  \n `1` - Participants can stay in the meeting and will receive a notification.  \n `2` - Nobody can join or stay in the meeting.","example":"participants","enum":["participants","guest"]},"play_voice_prompt_when_archiving_starts":{"type":"string","description":"Play voice prompt when video or audio archiving starts.  \n `1` - Participants can stay in the meeting and will receive a notification.  \n `2` - Nobody can join or stay in the meeting.","example":"guest","enum":["participants","guest","none"]}}},"type":{"type":"integer","description":"Archive types.\n\n* `1` - Only meetings are archived. \n\n* `2` - Only webinars are archived. \n\n* `3` - Both meetings and webinars are archived.","example":2,"enum":[1,2,3]}},"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."},"auto_delete_cmr":{"type":"boolean","description":"Allow Zoom to permanently delete recordings automatically after a specified number of days.","example":true},"auto_delete_cmr_days":{"type":"integer","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.","example":90,"enum":[30,60,90,120],"x-enum-descriptions":["30 days.","60 days.","90 days.","120 days."]},"auto_recording":{"type":"string","description":"Automatic recording:  \n `local` - Record on local.  \n `cloud` -  Record on cloud.  \n `none` - Disabled.","example":"cloud","enum":["local","cloud","none"],"x-enum-descriptions":["Record on local","Record on cloud","Disabled"]},"cloud_recording":{"type":"boolean","description":"Allow hosts to record and save the meeting in the cloud.","example":true},"cloud_recording_download":{"type":"boolean","description":"Cloud recording downloads.","example":true},"cloud_recording_download_host":{"type":"boolean","description":"Only the host can download cloud recordings.","example":true},"display_participant_name":{"type":"boolean","description":"Whether to display participants' names in the recording.","example":true},"host_delete_cloud_recording":{"type":"boolean","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","example":true},"ip_address_access_control":{"type":"object","properties":{"enable":{"type":"boolean","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","example":true},"ip_addresses_or_ranges":{"type":"string","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","example":"46.33.24.184"}},"description":"Setting to allow cloud recording access only from specific IP address ranges.\n"},"local_recording":{"type":"boolean","description":"Allow hosts and participants to record the meeting using a local file.","example":true},"local_recording_options":{"type":"object","properties":{"internal_meeting_participants":{"type":"boolean","description":"Internal meeting participants","example":true},"internal_auto_approve_requests":{"type":"boolean","description":"Auto approve their permission requests","example":true},"external_meeting_participants":{"type":"boolean","description":"External meeting participants","example":true},"external_auto_approve_requests":{"type":"boolean","description":"Auto approve their permission requests","example":true},"participants_with_specified_domains":{"type":"boolean","description":"Meeting participants with specified domains","example":true},"participants_with_specified_domains_content":{"type":"string","description":"Enter the domain information","example":"zoom.us"},"participants_specified_domains_auto_approve_requests":{"type":"boolean","description":"Auto approve their permission requests","example":true},"save_chat_messages":{"type":"boolean","description":"Save chat messages from the meeting / webinar","example":true},"save_closed_caption":{"type":"boolean","description":"Save closed caption as a VTT file","example":true}},"description":"all sub-options for local recording"},"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},"prevent_host_access_recording":{"type":"boolean","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","example":true},"record_audio_file":{"type":"boolean","description":"Whether to record one audio file for all participants.","example":true},"record_audio_file_each_participant":{"type":"boolean","description":"Whether to record a separate audio file for each participant. This only supports a maximum of 200 participants' audio files.","example":true},"record_files_separately":{"type":"object","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}},"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."},"record_gallery_view":{"type":"boolean","description":"Record the gallery view with a shared screen.","example":true},"record_speaker_view":{"type":"boolean","description":"Record the active speaker with a shared screen.","example":true},"recording_audio_transcript":{"type":"boolean","description":"Automatically transcribe the audio of the meeting or webinar to the cloud.","example":true},"recording_disclaimer":{"type":"boolean","description":"Show a disclaimer to participants before a recording starts\nThis field has been deprecated. The replacement field is recording_notification_for_zoom_client","example":true,"deprecated":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},"smart_recording":{"type":"object","properties":{"create_recording_highlights":{"type":"boolean","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.","example":true},"create_smart_chapters":{"type":"boolean","description":"By selecting this option, your recording will have chapters with overview. Hosts can edit the chapters.","example":true},"create_next_steps":{"type":"boolean","description":"By selecting this option, there will be a summary of actions to take after the recorded meeting.","example":true}},"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."},"recording_password_requirement":{"type":"object","properties":{"have_letter":{"type":"boolean","description":"Indicates whether or not passcode must contain at least one alphabetical letter (a, b, c..).","example":true},"have_number":{"type":"boolean","description":"Indicates whether or not passcode must contain at least one number(1, 2, 3..).","example":true},"have_special_character":{"type":"boolean","description":"Indicates whether or not passcode must contain at least one special character(!, @, #..).","example":true},"length":{"maximum":10,"type":"integer","description":"Minimum required length for the passcode.","example":10},"only_allow_numeric":{"type":"boolean","description":"Indicates whether or not passcode must contain only numeric characters.","example":true}},"description":"This object represents the minimum passcode requirements set for recordings via Account Recording Settings."},"recording_thumbnails":{"type":"boolean","description":"Whether to record thumbnails of the presenter when they are sharing their screen.","example":true},"required_password_for_existing_cloud_recordings":{"type":"boolean","description":"Require a passcode to access existing cloud recordings.","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":{"type":"boolean","description":"Save the chat text from the meeting.","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},"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},"show_timestamp":{"type":"boolean","description":"Add a timestamp to the recording.","example":true},"recording_notification_for_zoom_client":{"type":"object","properties":{"disclaimer_to_participants":{"type":"string","description":"Child setting name is [Show a disclaimer to participants when a recording starts], the value is option name you selected.","example":"All participants or Guest only"},"play_voice_prompt":{"type":"string","description":"Child setting name is [Play voice prompt for], the value is option name you selected.","example":" All participants or Guest only or  No one"},"ask_host_to_confirm":{"type":"boolean","description":"Child setting name is [Ask host to confirm before starting a recording], the value is option name you selected","example":true}},"description":"setting name: Recording notifications - Zoom clients"},"viewer_see_transcript":{"type":"boolean","description":"Viewers can see the transcript","example":true},"viewer_see_chat":{"type":"boolean","description":"Viewers see chat","example":true},"allow_cmr_3rd_party_bot":{"type":"boolean","description":"Allow 3rd-party recording","example":true},"upload_custom_caption":{"type":"boolean","description":"Allow host to upload custom caption","example":true},"upload_recording":{"type":"boolean","description":"Upload recording to the cloud","example":true},"water_marker_recording":{"type":"boolean","description":"add water marker for recording","example":true},"durable_meeting_transcript":{"type":"object","properties":{"durable_meeting_transcript":{"type":"boolean","description":"Main setting value","example":true},"allow_host_access_meeting_transcript":{"type":"boolean","description":"Allow hosts to access and manage transcripts","example":true}},"description":"Allow users to retain, access,and manage transcripts generated by AI Companion features for use by other AI Companion services."},"allow_share":{"type":"boolean","description":"Allow cloud recording sharing","example":true},"authenticated_view_cloud_recoding":{"type":"object","properties":{"authenticated_can_view_cloud_recordings":{"type":"boolean","description":"Main setting value","example":true},"default_authenticate_content":{"type":"string","description":"Default authentication option","example":"Signed-in users in my account","enum":["Signed-in users in my account","Sign in to Zoom","Sign in to Zoom with specified domains","Sign in to external Single Sign-On (SSO)","Only people with access"]}},"description":"Require users to authenticate before viewing cloud recordings"},"embed_passcode_in_shareable_link":{"type":"boolean","description":"Embed passcode in the shareable link for one-click access","example":true},"allow_invitees_access_recordings_without_passcode":{"type":"boolean","description":"Allow invitees to access recordings without the passcode","example":true},"recording_as_on_demand":{"type":"boolean","description":"Set recording as on-demand by default","example":true},"notification_subscription_url_when_recording_available":{"type":"boolean","description":"Push notification to subscription URL when a cloud recording is available","example":true},"recording_notifications_phone_users":{"type":"object","properties":{"require_press_one_consent_to_record":{"type":"boolean","description":"Require phone-only users to press 1 to consent to being recorded","example":true},"multiple_notifications_phone_users":{"type":"boolean","description":"Multiple notifications for phone users","example":true}},"description":"Recording notifications - Phone users"},"cloud_recording_permanently_deleted":{"type":"object","properties":{"cloud_recording_permanently_deleted_from_trash":{"type":"boolean","description":"Main setting value","example":true},"email_reminder_type":{"type":"string","description":"Selected email reminder","example":"Weekly digest on Monday","enum":["7 days before deletion","Weekly digest on Monday"]}},"description":"When the cloud recording is going to be permanently deleted from trash"},"recording_storage_email_notifications":{"type":"boolean","description":"Recording storage email notifications","example":true},"allow_add_cloud_recordings_to_zoom_clips":{"type":"boolean","description":"Allow users to add cloud recordings to Zoom Clips","example":true},"allow_revenue_accelerator_manage_recording_separate_auto_delete":{"type":"boolean","description":"Allow Zoom Revenue Accelerator to manage recording files with separate auto-delete settings","example":true}},"description":"Account Settings: Recording."},"schedule_meeting":{"type":"object","properties":{"audio_type":{"type":"string","description":"Determine how participants can join the audio portion of the meeting.  \n `both` - Telephony and VoIP.  \n `telephony` - Audio PSTN telephony only.  \n `voip` - VoIP only.  \n `thirdParty` - 3rd party audio conference.","example":"both","default":"both","enum":["both","telephony","voip","thirdParty"],"x-enum-descriptions":["Telephony and VoIP","Audio PSTN telephony only","VoIP only","3rd party audio conference"]},"enforce_login":{"type":"boolean","description":"Only Zoom users who are signed in can join meetings.","example":true},"enforce_login_domains":{"type":"string","description":"Only signed in users with a specified domain can join the meeting. ","example":"example.com"},"enforce_login_with_domains":{"type":"boolean","description":"Only signed in users with a specific domain can join meetings.","example":true},"force_pmi_jbh_password":{"type":"boolean","description":"Require a passcode for Personal Meetings if attendees can join before host.","example":true},"host_video":{"type":"boolean","description":"Start meetings with the host video on.","example":true},"enable_dedicated_group_chat":{"type":"boolean","description":"Enable dedicated group chats for meeting conversations.","example":true},"jbh_time":{"type":"integer","description":"If the value of `join_before_host` field is set to `true`, this field can be used to indicate time limits when a participant may join a meeting before a host.\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.","example":10,"enum":[0,5,10,15]},"join_before_host":{"type":"boolean","description":"Allow participants to join the meeting before the host arrives.","example":true},"meeting_password_requirement":{"type":"object","properties":{"consecutive_characters_length":{"type":"integer","description":"\nSpecify the max length of consecutive characters(abcde...) that can be used in a passcode.\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 passcode.\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 passcode(example: abc1x@8fdh).","example":5,"enum":[0,4,5,6,7,8]},"have_letter":{"type":"boolean","description":"If set to `true`, the passcode must contain at least 1 letter (such as a,b,c...).\n","example":true},"have_number":{"type":"boolean","description":"If set to `true`, the passcode must contain at least 1 number (such as 1,2,3...).","example":true},"have_special_character":{"type":"boolean","description":"If set to `true`, the passcode must have at least 1 special character (!,@,#...).","example":true},"have_upper_and_lower_characters":{"type":"boolean","description":"If set to `true`, the passcode must include both uppercase and lowercase characters.","example":true},"length":{"type":"integer","description":"The minimum length that the meeting or webinar passcode must have.","example":10},"only_allow_numeric":{"type":"boolean","description":"If set to `true`, the passcode must only contain numbers and no other characters.","example":true},"weak_enhance_detection":{"type":"boolean","description":"If set to `true`, users will be informed if the provided passcode is weak.","example":true}},"description":"Account wide meeting or webinar [passcode requirements](https://support.zoom.us/hc/en-us/articles/360033559832-Meeting-and-webinar-passwords#h_a427384b-e383-4f80-864d-794bf0a37604)."},"not_store_meeting_topic":{"type":"boolean","description":"Always display **Zoom Meeting** as the meeting topic.","example":true},"participant_video":{"type":"boolean","description":"Start meetings with the participant video on. Participants can change this setting during the meeting.","example":true},"allow_host_to_disable_participant_video":{"type":"boolean","description":"Allow host to disable participant video when scheduling a meeting.","example":true},"personal_meeting":{"type":"boolean","description":"Personal meeting setting.\n\n\n`true` - Indicates that the **Enable Personal Meeting ID** setting is turned on. Users can choose to use personal meeting ID for their meetings.\n\n\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","example":true},"require_password_for_instant_meetings":{"type":"boolean","description":"Require a passcode 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","example":true},"require_password_for_pmi_meetings":{"type":"string","description":"Require a passcode 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","example":"none","enum":["jbh_only","all","none"],"x-enum-descriptions":["Only meetings with Join Before Host enabled","All meetings using a PMI","Disabled"]},"require_password_for_scheduled_meetings":{"type":"boolean","description":"Require a passcode for meetings which have already been scheduled.\n","example":true},"require_password_for_scheduling_new_meetings":{"type":"boolean","description":"Require a passcode when scheduling new meetings. This setting applies for regular meetings that do not use a PMI. If enabled, a passcode will be generated while a host schedules a new meeting and participants will be required to enter the passcode 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.","example":true},"use_pmi_for_instant_meetings":{"type":"boolean","description":"Use a Personal Meeting ID (PMI) when starting an instant meeting.","example":true},"use_pmi_for_scheduled_meetings":{"type":"boolean","description":"Use a Personal Meeting ID (PMI) when scheduling a meeting.","example":true},"always_display_zoom_meeting_as_topic":{"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}},"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."},"hide_meeting_description":{"type":"object","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}},"description":"Information about the **Hide meeting description** feature."},"always_display_zoom_webinar_as_topic":{"type":"object","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}},"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."},"hide_webinar_description":{"type":"object","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}},"description":"Information about the **Hide webinar description** feature."},"meeting_template":{"type":"object","properties":{"enable":{"type":"boolean","description":"Whether to enable the **Meeting Templates** setting.","example":true},"templates":{"type":"array","description":"Information about the defined **Meeting Templates** policies.","items":{"type":"object","properties":{"id":{"type":"string","description":"The meeting template ID.","example":"ydCUQzzVT6WZ_r_K_2iFzg"},"name":{"type":"string","description":"The meeting template name.","example":"meeting_template_name"},"enable":{"type":"boolean","description":"Whether to enable the meeting template.\n* `true` - Enable. \n* `false` - Disable.","example":true}},"example":{"id":"ydCUQzzVT6WZ_r_K_2iFzg","name":"meeting_template_name","enable":true}}}},"description":"Information about the **Meeting Templates** feature."},"continuous_meeting_chat":{"type":"object","properties":{"enable":{"type":"boolean","description":"Whether to enable the **Enable continuous meeting chat** setting.","example":true},"can_add_external_users":{"type":"boolean","description":"Whether to enable the **External users can be added** setting.","example":true,"deprecated":true},"auto_add_invited_external_users":{"type":"boolean","description":"Whether to enable the **Automatically add invited external users** setting.","example":true,"deprecated":true}},"description":"Information about the **Enable continuous meeting chat** feature."}},"description":"Account Settings: Schedule Meeting."},"telephony":{"type":"object","properties":{"audio_conference_info":{"type":"string","description":"Third party audio conference info.","example":"test"},"telephony_regions":{"type":"object","properties":{"allowed_values":{"type":"array","description":"Telephony region options provided by Zoom to select from.","example":["CNTB","USTB"],"items":{"type":"string","example":"CNTB"}},"selection_values":{"type":"string","description":"The account's selected telephony regions that indicate where most participants call into or call from during a meeting.","example":"USTB"}},"description":"Indicates where most of the participants call into or call from during a meeting."},"third_party_audio":{"type":"boolean","description":"Users can join the meeting using the existing third party audio configuration.","example":false}},"description":"Account Settings: Telephony."},"tsp":{"type":"object","properties":{"call_out":{"type":"boolean","description":"Call Out","example":true},"call_out_countries":{"type":"array","description":"Call Out Countries/Regions","example":["us"],"items":{"type":"string","example":"us"}},"allow_webinar_attendees_call_me":{"type":"boolean","description":"Whether webinar attendees can use Call Me to connect audio. This feature is only available in version 5.2.2 and higher.","example":true},"display_toll_free_numbers":{"type":"boolean","description":"Display toll-free numbers","example":true},"allow_webinar_attendees_toll_free_dial":{"type":"boolean","description":"Whether webinar attendees can dial in through the account's **Toll-free** phone numbers. This feature is only available with version 5.2.2 or later.","example":true},"show_international_numbers_link":{"type":"boolean","description":"Show international numbers link on the invitation email","example":true},"global_dial_in_countries":{"type":"object","properties":{"allowed_countries":{"type":"array","description":"The list of all available countries/regions that can be selected for displaying dial-in numbers in the meeting invitation.","items":{"type":"object","properties":{"code":{"type":"string","description":"The code of the country or region.","example":"CN"},"name":{"type":"string","description":"The name of the country or region.","example":"China"}}}},"selected_countries":{"type":"array","description":"The list of selected countries/regions whose dial-in numbers will be listed in the email invitation. You can adjust the order that the dial-in numbers appear in the email invitation.","items":{"type":"object","properties":{"code":{"type":"string","description":"The code of the country or region.","example":"CN"},"name":{"type":"string","description":"The name of the country or region.","example":"China"}}}}},"description":"The account's **Global Dial-in Countries/Regions** settings."}},"description":"Account Settings: TSP."},"zoom_rooms":{"type":"object","properties":{"auto_start_stop_scheduled_meetings":{"type":"boolean","description":"Automatic start and stop for scheduled meetings.","example":true},"cmr_for_instant_meeting":{"type":"boolean","description":"Cloud recording for instant meetings.","example":true},"force_private_meeting":{"type":"boolean","description":"Shift all meetings to private.","example":true},"hide_host_information":{"type":"boolean","description":"Hide host and meeting ID from private meetings.","example":true},"list_meetings_with_calendar":{"type":"boolean","description":"Display meeting list with calendar integration.","example":true},"start_airplay_manually":{"type":"boolean","description":"Start AirPlay service manually.","example":true},"ultrasonic":{"type":"boolean","description":"Automatic direct sharing using an ultrasonic proximity signal.","example":true},"upcoming_meeting_alert":{"type":"boolean","description":"Upcoming meeting alert.","example":true},"weekly_system_restart":{"type":"boolean","description":"Weekly system restart.","example":true},"zr_post_meeting_feedback":{"type":"boolean","description":"Zoom Room post meeting feedback.","example":true}},"description":"Account Settings: Zoom Rooms."},"smart_recognition":{"type":"object","properties":{"personalized_audio_isolation":{"type":"boolean","description":"Allow users to enable personalized audio isolation in the Zoom Workplace app to differentiate their voice and suppress background noise.","example":true},"zoom_rooms":{"type":"object","properties":{"video_name_tags":{"type":"object","properties":{"enabled":{"type":"boolean","description":"Allow users to enroll in automatic smart name tags for video in Zoom Rooms. When enabled, enrolled users’ reference images are used to recognize them in the Zoom Room.","example":true},"allow_user_photos":{"type":"boolean","description":"Allow users to use their own profile photos as the reference image for video smart name tags.","example":true},"allow_enrollment_email":{"type":"boolean","description":"Allow Zoom to send an enrollment email to users in your account to help them set up automatic smart name tags for video.","example":true},"allow_external_identification":{"type":"boolean","description":"Allow external Zoom Rooms to identify users in your account using their enrolled video name tags.","example":true}},"description":"Zoom Rooms: Video Name Tags"},"voice_name_tags":{"type":"object","properties":{"enabled":{"type":"boolean","description":"Allow users to enroll in automatic smart name tags for voice in Zoom Rooms. When enabled, enrolled users’ uploaded voice recordings are used to recognize them as speakers.","example":true},"allow_enrollment_email":{"type":"boolean","description":"Allow Zoom to send an enrollment email to users in your account to help them set up automatic smart name tags for voice.","example":true},"allow_external_identification":{"type":"boolean","description":"Allow external Zoom Rooms to identify users in your account using their enrolled voice name tags.","example":true}},"description":"Zoom Rooms: Voice Name Tags"}},"description":"Zoom Rooms automatic smart name tags"},"workplace_app":{"type":"object","properties":{"voice_name_tags":{"type":"object","properties":{"enabled":{"type":"boolean","description":"Allow users to enroll in automatic smart name tags for voice from their profile in the Zoom Workplace app.","example":true},"allow_enrollment_email":{"type":"boolean","description":"Allow Zoom to send an enrollment email to users in your account to help them set up Workplace app voice name tags.","example":true}},"description":"Workplace App: Voice Name Tags"}},"description":"Zoom Workplace app automatic smart name tags"}},"description":"Account Settings: Smart Recognition."},"mail_calendar":{"type":"object","properties":{"email_calendar_management":{"type":"boolean","description":"Allow the Zoom client to manage both emails and calendar events for the user.","example":true},"email_management":{"type":"boolean","description":"Allow the Zoom client to manage user emails.","example":true},"zoom_email_provider":{"type":"boolean","description":"Allow users to select Zoom as their email service provider.","example":true}},"description":"Email and calendar related settings."},"general_setting":{"title":"General settings.","type":"object","properties":{"auto_zoom_room_proximity_connect":{"type":"boolean","description":"Allow automatic direct sharing and connecting to Zoom Rooms using ultrasonic proximity signal.","example":true},"show_zoom_room_feature":{"type":"boolean","description":"Show \"Zoom Room\" feature in the Zoom Workplace app.","example":true}},"description":"General settings."},"ai":{"type":"object","properties":{"screen_share_ocr":{"type":"boolean","description":"Whether screen share content is used with OCR.","example":true},"meeting_chat_messages":{"type":"boolean","description":"Whether meeting chat messages are used to enhance transcripts.","example":true},"full_display_names_in_ai_assets":{"type":"boolean","description":"Whether AI-generated meeting assets use full display names.","example":true},"ai_generated_virtual_backgrounds":{"type":"boolean","description":"Whether AI-generated virtual backgrounds are enabled.","example":true},"meeting_agenda":{"type":"boolean","description":"Whether Meeting Agenda with AI is enabled.","example":true},"meeting_summary_docs":{"type":"object","properties":{"enable":{"type":"boolean","description":"Whether automatic Zoom Doc creation is enabled.","example":true},"share_with_summary_recipients":{"type":"boolean","description":"Whether generated Zoom Docs are shared with meeting summary recipients.","example":true}},"description":"Automatic Zoom Doc creation from meeting summary."},"phone_user_ai_notices":{"type":"object","properties":{"enable":{"type":"boolean","description":"Whether phone user AI notices are enabled.","example":true},"require_press_1_consent":{"type":"boolean","description":"Whether callers must press 1 to consent.","example":true},"multiple_notifications":{"type":"boolean","description":"Whether multiple notifications are allowed.","example":true}},"description":"Phone user AI notices."},"meeting_summary_retention":{"type":"object","properties":{"enable":{"type":"boolean","description":"Whether automatic meeting summary deletion is enabled.","example":true},"retention_days":{"maximum":9999,"minimum":1,"type":"integer","description":"Number of days to retain meeting summaries before deletion.","example":30}},"description":"Automatic meeting summary deletion."},"meeting_summary_personal_data_redaction":{"type":"object","properties":{"enable":{"type":"boolean","description":"Whether personal data redaction is enabled.","example":true},"personal_data_types":{"type":"array","description":"Personal data types to redact.","example":["NAME","EMAIL"],"items":{"type":"string","enum":["ADDRESS","AGE","CREDIT_DEBIT_CVV","CREDIT_DEBIT_EXPIRY","CREDIT_DEBIT_NUMBER","DATE_TIME","DRIVER_ID","EMAIL","INTERNATIONAL_BANK_ACCOUNT_NUMBER","IP_ADDRESS","LICENSE_PLATE","MAC_ADDRESS","NAME","PASSWORD","PHONE","PIN","SWIFT_CODE","URL","USERNAME","VEHICLE_IDENTIFICATION_NUMBER","BANK_ACCOUNT_NUMBER","BANK_ROUTING","PASSPORT_NUMBER","US_INDIVIDUAL_TAX_IDENTIFICATION_NUMBER","SSN"]}}},"description":"Personal data redaction for meeting summaries."},"meeting_summary_sensitive_data_filter":{"type":"object","properties":{"enable":{"type":"boolean","description":"Whether the sensitive data filter is enabled.","example":true},"rules":{"type":"array","description":"Sensitive data filter rules.","items":{"type":"object","properties":{"name":{"type":"string","description":"Rule display name.","example":"Employee ID"},"regular_expression":{"type":"string","description":"RE2J regular expression.","example":"[0-9]{6}"}}}}},"description":"Sensitive data filter for meeting summaries."},"meeting_coach":{"type":"object","properties":{"enable":{"type":"boolean","description":"Whether Meeting Coach with AI is enabled.","example":true},"participant_scope":{"type":"string","description":"Which participants Meeting Coach applies to.","example":"participants_and_invitees_in_our_organization","enum":["all_participants_and_invitees","participants_and_invitees_in_our_organization"]}},"description":"Meeting Coach with AI."},"third_party_meeting_join":{"type":"object","properties":{"enable":{"type":"boolean","description":"Whether third-party meeting join with AI is enabled.","example":true},"allow_recording":{"type":"boolean","description":"Whether recording is enabled for joined third-party meetings.","example":true},"calendar":{"type":"object","properties":{"enable":{"type":"boolean","description":"Whether calendar-based third-party meeting join is enabled.","example":true},"join_scope":{"type":"string","description":"Which calendar events third-party meeting join applies to.","example":"all_events_with_video_conference_links","enum":["all_events_with_video_conference_links","meetings_where_i_am_the_host","meetings_where_i_am_a_participant"]}},"description":"Calendar-based third-party meeting join."},"pre_meeting_email_notification":{"type":"object","properties":{"enable":{"type":"boolean","description":"Whether pre-meeting email notification is enabled.","example":true},"recipients":{"type":"string","description":"Who receives the pre-meeting email notification.","example":"all_invitees","enum":["all_invitees","only_meeting_host"]}},"description":"Pre-meeting email notification."}},"description":"Third-party meeting join with AI."},"whiteboard_content_generation":{"type":"boolean","description":"Whether Whiteboard content generation with AI is enabled.","example":true},"smart_recording":{"type":"object","properties":{"create_recording_highlights":{"type":"boolean","description":"Recording highlights","example":true},"create_smart_chapters":{"type":"boolean","description":"Summary and smart chapters","example":true},"create_next_steps":{"type":"boolean","description":"Next steps","example":true}},"description":"Smart Recording"},"clips_summarization_generation":{"type":"object","properties":{"enable":{"type":"boolean","description":"Whether summarization generation is enabled.","example":true},"general_summary":{"type":"boolean","description":"Whether summary generation is enabled.","example":true},"generation_chapter":{"type":"boolean","description":"Whether chapter generation is enabled.","example":true}},"description":"setting for clip summarization generation"},"clips_create_video_with_aic":{"type":"object","properties":{"enable":{"type":"boolean","description":"Whether clips create video with aic is enabled.","example":true},"show_clips_with_avatar":{"type":"boolean","description":"Whether show clips with avatar","example":true}},"description":"setting for clip create video with aic"},"allow_user_create_customize_avatar":{"type":"object","properties":{"enable":{"type":"boolean","description":"Whether clips allow user create customize avatar is enabled.","example":true},"clips_custom_avatar_delegation":{"type":"boolean","description":"Whether custom avatar delegation is enabled","example":true}},"description":"setting for clip allow user create customize avatar"},"task_creation_and_management":{"type":"object","properties":{"enable":{"type":"boolean","description":"Whether AI-powered task creation and management is enabled.","example":false},"auto_generate_details":{"type":"boolean","description":"Whether to automatically generate task details.","example":false},"auto_generate_action":{"type":"boolean","description":"Whether to automatically generate action items from tasks.","example":true},"generate_from_transcripts":{"type":"object","properties":{"enable":{"type":"boolean","description":"Whether to allow generating tasks from meeting transcripts.","example":false},"auto_share_with":{"type":"string","description":"Defines who tasks are automatically shared with when generated from transcripts.","example":"internal_participants","enum":["host_only","internal_participants","internal_assigned_participants"],"x-enum-descriptions":["Share tasks with meeting host only","Share tasks with all internal meeting participants","Share tasks with internal participants who are assigned"]},"auto_assign_to_collaborator":{"type":"boolean","description":"Whether to automatically assign tasks to collaborators.","example":true}},"description":"Settings for generating tasks from meeting transcripts."},"generate_from_phone_call":{"type":"object","properties":{"enable":{"type":"boolean","description":"Whether to allow generating tasks from phone calls.","example":false},"auto_add_participant_as_collaborator":{"type":"boolean","description":"Whether to automatically add phone call participants as task collaborators.","example":true},"auto_assign_to_collaborator":{"type":"boolean","description":"Whether to automatically assign phone call tasks to collaborators.","example":true}},"description":"Settings for generating tasks from phone calls."},"generate_from_voicemail":{"type":"boolean","description":"Whether to allow generating tasks from voicemail.","example":false}},"description":"AI-powered task creation and management with AI Companion."},"show_conversational_ai_companion":{"type":"object","properties":{"enabled":{"type":"boolean","description":"Whether conversational AI is enabled.","example":true},"enable_zoom_mate":{"type":"boolean","description":"Whether ZoomMate is available in the web navigation and Zoom Workplace app navigation bar.","example":true},"delete_ai_conversation":{"type":"boolean","description":"Whether to automatically delete AI conversation history.","example":true},"delete_ai_conversation_time":{"type":"integer","description":"The number of days after which AI conversation history is automatically deleted. Supported values are 30, 60, 90, and 120.","nullable":true,"example":30,"enum":[30,60,90,120]}},"description":"Show conversational AI companion settings."},"ai_panel_in_workplace":{"type":"object","properties":{"enabled":{"type":"boolean","description":"Whether the AI panel in Zoom Workplace is enabled.","example":true},"delete_ai_conversation":{"type":"boolean","description":"Whether to automatically delete AI conversation history in the AI panel.","example":true},"delete_ai_conversation_time":{"type":"integer","description":"The number of days after which AI conversation history in the AI panel is automatically deleted. Supported values are 30, 60, 90, and 120.","nullable":true,"example":30,"enum":[30,60,90,120]}},"description":"AI panel in Zoom Workplace settings."},"enable_ai_on_web":{"type":"boolean","description":"Whether Zoom AI on the web is enabled.","example":true},"enable_email_compose_with_ai":{"type":"boolean","description":"Whether users can use AI to compose or wordsmith email responses in Zoom Mail.","example":true},"microsoft_365":{"type":"object","properties":{"enable":{"type":"boolean","description":"Whether Microsoft 365 data sources can be used as data sources for AI.","example":true},"calendar_events":{"type":"boolean","description":"Whether Microsoft Outlook calendar events accessible to the user can be used as a data source for AI.","example":true},"emails":{"type":"boolean","description":"Whether Microsoft Outlook emails accessible to the user can be used as a data source for AI.","example":true},"documents":{"type":"boolean","description":"Whether Office 365 documents accessible to the user can be used as a data source for AI.","example":true}},"description":"Settings for Microsoft 365 data sources."},"google":{"type":"object","properties":{"enable":{"type":"boolean","description":"Whether Google data sources can be used as data sources for AI.","example":true},"calendar_events":{"type":"boolean","description":"Whether Google Calendar events accessible to the user can be used as a data source for AI.","example":true},"emails":{"type":"boolean","description":"Whether Gmail emails accessible to the user can be used as a data source for AI.","example":true},"documents":{"type":"boolean","description":"Whether Google Drive documents accessible to the user can be used as a data source for AI.","example":true}},"description":"Settings for Google data sources."},"web_content":{"type":"boolean","description":"Whether public web content can be used as a data source for AI.","example":true},"local_file_uploads":{"type":"boolean","description":"Whether files uploaded by users can be used as a data source for AI by the users who uploaded them.","example":true},"organization_custom_dictionaries":{"type":"boolean","description":"Whether AI can consume the organization's custom dictionaries.","example":true},"third_party_app_tasks":{"type":"boolean","description":"Whether AI can perform tasks on the user's behalf in third-party apps configured within AI Studio.","example":true},"workspace_reservation_recommendations_with_ai":{"type":"object","properties":{"enabled":{"type":"boolean","description":"Whether Workspace Reservation recommendations with AI are enabled.","example":true},"day_recommendation":{"type":"boolean","description":"Whether day recommendations are enabled.","example":true},"desk_recommendation":{"type":"boolean","description":"Whether desk recommendations are enabled.","example":true},"custom_workspaces_recommendation":{"type":"boolean","description":"Whether custom workspace recommendations are enabled.","example":true},"room_recommendation":{"type":"boolean","description":"Whether room recommendations are enabled.","example":true},"proactive_room_recommendation":{"type":"boolean","description":"Whether proactive room recommendations are enabled.","example":true}},"description":"Workspace Reservation recommendations with AI."},"participant_can_request_aic_in_meeting":{"type":"boolean","description":"Participants can request the host to start in-meeting AI features.","example":true},"restrict_aic_when_external_user_join_meeting":{"type":"boolean","description":"Automatically restrict Zoom AI and transcription features when external users or groups join a meeting.","example":true},"restrict_users_from_joining_ai_enabled_meetings":{"type":"object","properties":{"enable":{"type":"boolean","description":"Whether users are restricted from joining meetings in which AI meeting processing (meeting questions and summary) is allowed.","example":true},"join_notify":{"type":"string","description":"Action to take when a restricted user tries to join an AI-enabled meeting. Valid values: `out_of_compliance` (notify users that they are out of compliance), `notify_and_remove` (notify and remove users from the meeting).","example":"notify_and_remove","enum":["out_of_compliance","notify_and_remove"]},"apply_scope":{"type":"string","description":"Apply this setting to. Valid values: `internal_only` (internal meetings only), `external_only` (external meetings only), `internal_and_external` (internal and external meetings).","example":"internal_and_external","enum":["internal_only","external_only","internal_and_external"]}},"description":"Users would be restricted from joining meetings in which AI meeting processing (meeting questions and summary) is allowed."},"meeting_questions":{"type":"object","properties":{"enable":{"type":"boolean","description":"Whether to allow hosts and invited participants to ask questions to AI Companion during a meeting.","example":true},"auto_enable":{"type":"boolean","description":"Whether to automatically allow access when the meeting starts.","example":false},"who_can_ask_questions":{"type":"string","description":"Defines who can ask questions about this meeting's transcript. Valid values: `from_entire_meeting` (all participants and invitees), `from_join_meeting` (all participants only from when they join), `host` (only the meeting host), `org` (participants and invitees in the organization), `org_from_join_meeting` (participants in the organization only from when they join).","example":"org_from_join_meeting","enum":["from_entire_meeting","from_join_meeting","host","org","org_from_join_meeting"]}},"description":"Zoom AI answers the meeting questions based on what is said in the meeting. If a transcript is retained, participants with access will be able to ask questions after the meeting based on that transcript."},"meeting_summary":{"type":"object","properties":{"enable":{"type":"boolean","description":"Whether to allow hosts to generate a summary.","example":true},"auto_enable":{"type":"boolean","description":"Whether to turn on meeting summary automatically when meetings start.","example":false},"email_notification":{"type":"boolean","description":"Send an email notification when sharing with participants.","example":true},"whether_include_full_text_in_email":{"type":"string","description":"Whether to include summary text in the email. Valid values: `include_full_text_in_email` (include summary text in the email), `not_include_full_text_in_email` (do not include summary text in the email).","example":"include_full_text_in_email","enum":["include_full_text_in_email","not_include_full_text_in_email"]},"restrict_share_to_outside_of_organization":{"type":"boolean","description":"Restrict users from sharing summaries to those outside of our organization.","example":true},"restrict_summary_share":{"type":"string","description":"Restrict users from sharing summaries. Valid values: `external_users` (to those outside of our organization), `all_users` (to all users), `all_users_except_delegate` (to all users except delegates).","example":"external_users","enum":["external_users","all_users","all_users_except_delegate"]},"who_will_receive_summary":{"type":"string","description":"Automatically share summary with. Valid values: `host` (only meeting host), `alt_host` (only meeting host, co-hosts, and alternative hosts), `organization` (only meeting host and meeting invitees in our organization), `all` (all meeting invitees including those outside of our organization).","example":"alt_host","enum":["host","alt_host","organization","all"]}},"description":"Allow hosts to generate a summary. Summaries are sent based on sharing permissions after the meeting has ended."},"meeting_summary_template":{"type":"object","properties":{"enable":{"type":"boolean","description":"Whether users can select a meeting summary template for their meetings. After the meeting, the summary will be generated into the new template.","example":true},"summary_template_id":{"type":"string","description":"Default summary template.","example":"template_123"}},"description":"Allow users to select a meeting summary template for their meetings. After the meeting, the summary will be generated into the new template."},"meeting_summary_default_language":{"type":"object","properties":{"enable":{"type":"boolean","description":"When this feature is enabled, all meeting summaries will automatically use the language you choose.","example":true},"language":{"type":"string","description":"Set default meeting summary language. Supported values: `ar` (Arabic), `bn` (Bengali), `zh` (Chinese (Simplified)), `zh-hant` (Chinese (Traditional)), `cs` (Czech), `da` (Danish), `nl` (Dutch), `en` (English), `et` (Estonian), `fi` (Finnish), `fr` (French), `de` (German), `hi` (Hindi), `hu` (Hungarian), `id` (Indonesian), `it` (Italian), `ja` (Japanese), `ko` (Korean), `ms` (Malay), `fa` (Persian), `pl` (Polish), `pt` (Portuguese), `ro` (Romanian), `ru` (Russian), `es` (Spanish), `sv` (Swedish), `tl` (Tagalog), `ta` (Tamil), `te` (Telugu), `th` (Thai), `tr` (Turkish), `uk` (Ukrainian), `vi` (Vietnamese).","example":"en","enum":["ar","bn","zh","zh-hant","cs","da","nl","en","et","fi","fr","de","hi","hu","id","it","ja","ko","ms","fa","pl","pt","ro","ru","es","sv","tl","ta","te","th","tr","uk","vi"]}},"description":"When this feature is enabled, all meeting summaries will automatically use the language you choose."},"meeting_summary_ip_access":{"type":"object","properties":{"enable":{"type":"boolean","description":"Whether meeting summary access is restricted to specific IP address ranges.","example":true},"ip_addresses_or_ranges":{"type":"string","description":"IP addresses or ranges from which meeting summaries can be accessed.","example":"192.0.2.0/24"}},"description":"Allow meeting summary access only from specific IP address ranges."},"remind_me_turn_on_aic":{"type":"boolean","description":"If you don't set AI features to auto-start in your meetings, you will be reminded to turn on AI at the beginning of each meeting you host.","example":true},"remind_me_turn_on_catch_me_up":{"type":"boolean","description":"When you join a meeting late, you'll get a prompt for AI to summarize what's been discussed so far.","example":true},"meeting_summary_email_only_mode":{"type":"boolean","description":"When this setting is enabled, summaries will only be shared to users by email. Users will not be able to view or edit summaries on the Zoom client or web portal, as the meeting summary will not be retained.","example":false},"restrict_users_from_deleting_ai_companion_assets":{"type":"boolean","description":"When enabled, users cannot delete AI assets. Only admins can delete them.","example":true},"restrict_users_from_editing_ai_companion_assets":{"type":"boolean","description":"When enabled, users cannot edit AI assets. Only admins can edit them.","example":true},"webinar_summary_follow_up_email":{"type":"boolean","description":"Whether webinar summaries are included in webinar follow-up email. Deprecated. Use `include_webinar_summary_follow_up_email`.","example":true,"deprecated":true},"webinar_summary_ocr":{"type":"boolean","description":"Whether screen share content is used with OCR for webinar summaries. Optical Character Recognition (OCR) converts images of text screen shared during a webinar into machine-readable text to generate more accurate and relevant AI results.","example":true},"zoom_events_chat_panel":{"type":"boolean","description":"Whether the AI chat panel is enabled in Zoom Events. AI chat appears in Zoom Events setup surfaces and can be opened with the floating AI sparkle icon. You can ask AI chat about event performance and get insights and recommendations, including analytics for a specific event and across events in a Zoom Events hub.","example":true},"zoom_events_session_summary":{"type":"object","properties":{"enable":{"type":"boolean","description":"Whether Zoom Events session summaries are enabled.","example":true},"auto_start":{"type":"boolean","description":"Whether to turn on session summary automatically when sessions start.","example":true}},"description":"Session summary. Allows hosts to generate a summary. Summaries are sent after the session has ended based on the in-session access options."},"zoom_events_analytics":{"type":"boolean","description":"Whether Zoom Events AI Analytics is enabled. AI can analyze event engagement and uncover key moments, topics of interest, and actionable insights.","example":true},"zoom_events_chat_compose":{"type":"boolean","description":"Whether Zoom Events Chat Compose is enabled. AI helps users compose a response from scratch or wordsmith their chat messages.","example":true},"zoom_events_email_compose":{"type":"boolean","description":"Whether Zoom Events Email Compose with AI is enabled. AI can compose emails and subject lines for events in the Email Builder.","example":true},"zoom_events_smart_compose":{"type":"boolean","description":"Whether Zoom Events Smart Compose with AI is enabled. AI can write event content when setting up an event, including event descriptions, session descriptions, speaker bios, and lobby announcements.","example":true},"zoom_events_image_generation":{"type":"boolean","description":"Whether the Zoom Events image generator is enabled. AI can create images for use in an event.","example":true},"zoom_events_smart_upload":{"type":"boolean","description":"Whether Zoom Events Smart Upload is enabled. AI can ingest files to quickly create event content such as speaker biographies.","example":true},"zoom_events_content_generation":{"type":"boolean","description":"Whether Zoom Events Content Generation with AI is enabled. AI content generation helps users create blogs, ebooks, whitepapers, emails, highlights, and sales briefs.","example":true},"chat_summary":{"type":"object","properties":{"enable":{"type":"boolean","description":"Summarize with AI Companion","example":false},"shown_in_team_chat":{"type":"boolean","description":"Show in Team Chat","example":true}},"description":"Allow users to summarize chats, channels, and shared documents."},"chat_compose":{"type":"object","properties":{"enable":{"type":"boolean","description":"Compose with AI Companion","example":false},"shown_in_team_chat":{"type":"boolean","description":"Show in Team Chat","example":true}},"description":"Allow users to use AI to help them compose a response from scratch or wordsmith their chat messages."},"hub_ai_question_and_file_creation":{"type":"boolean","description":"Whether users can ask AI questions about file content and create new files, such as Canvas, Slides, Sheets, Paper, or data tables, from the Hub Home page. Creating files requires AI to be enabled in each product's settings.","example":true},"canvas_ai_content_generation":{"type":"boolean","description":"Whether users can use AI to generate and revise content in Canvas. Meeting transcripts from meeting summaries will be shown to hosts and can be used to create document content.","example":true},"canvas_ai_sentence_completion":{"type":"boolean","description":"Whether users can receive predictive writing suggestions while writing in Canvas.","example":true},"canvas_ai_post_meeting_writing_tasks":{"type":"boolean","description":"Whether AI can identify post-meeting writing tasks from meeting context and generate drafts that users can review and use.","example":true},"paper_ai_content_generation":{"type":"boolean","description":"Whether users can use AI to generate and revise content in Zoom Paper. Meeting transcripts from meeting summaries will be shown to hosts and can be used to create documents.","example":true},"sheets_ai_content_generation":{"type":"boolean","description":"Whether users can use AI to generate and revise content in Zoom Sheets. Meeting transcripts from meeting summaries will be shown to hosts and can be used to create sheet content.","example":true},"sheets_ai_formula":{"type":"boolean","description":"Whether AI can generate, explain, and apply spreadsheet formulas from natural-language input in Zoom Sheets.","example":true},"sheets_ai_function":{"type":"boolean","description":"Whether users can use the =AI() function in Zoom Sheets to generate, summarize, categorize, and analyze data.","example":true},"sheets_ai_resources":{"type":"boolean","description":"Whether users can add resources, such as meetings, docs, and data tables, to a spreadsheet and have AI suggest updates when they change.","example":true},"slides_ai_content_generation":{"type":"boolean","description":"Whether users can use AI to generate and revise content in Zoom Slides. Meeting transcripts from meeting summaries will be shown to hosts and can be used to create presentation content.","example":true},"my_notes_meeting_transcription":{"type":"boolean","description":"Whether users can transcribe their meetings with My Notes.","example":true},"my_notes_ai_content_generation":{"type":"object","properties":{"enable":{"type":"boolean","description":"Whether users can use AI to generate content in My Notes and enrich their writing with the meeting transcript.","example":true},"auto_generate_summary":{"type":"boolean","description":"Whether My Notes automatically generates a summary when a note is completed.","example":true},"auto_send_summary_email":{"type":"boolean","description":"Whether My Notes automatically sends a summary email when a note summary is generated.","example":true}},"description":"My Notes AI content generation settings."},"include_webinar_summary_follow_up_email":{"type":"object","properties":{"enable":{"type":"boolean","description":"Whether the host can include the webinar summary in follow-up email.","example":true},"attendee_follow_up_email":{"type":"boolean","description":"Whether the webinar summary is included in the attendee follow-up email.","example":true},"absentee_follow_up_email":{"type":"boolean","description":"Whether the webinar summary is included in the absentee follow-up email.","example":true}},"description":"Webinar follow-up email. When enabled, the host can include the webinar summary in follow-up emails."},"zoom_events_content_studio":{"type":"boolean","description":"Whether Content Studio is enabled. Content Studio can turn recordings into high-quality content such as video clips, emails, and blog posts.","example":true},"webinar_summary":{"type":"object","properties":{"enable":{"type":"boolean","description":"Whether to allow hosts to generate a summary.","example":true},"auto_enable":{"type":"boolean","description":"Whether to turn on webinar summary automatically when the webinar starts.","example":false},"email_notification":{"type":"boolean","description":"Whether to send an email notification when sharing to participants.","example":true},"whether_include_full_text_in_email":{"type":"string","description":"Whether to include summary text in the email. Valid values: `include_full_text_in_email` (Include summary text in the email), `not_include_full_text_in_email` (Don't include summary text in the email).","example":"include_full_text_in_email","enum":["include_full_text_in_email","not_include_full_text_in_email"]},"restrict_share_to_outside_of_organization":{"type":"boolean","description":"Whether to restrict users from sharing summaries to those outside of the organization.","example":true},"restrict_summary_share":{"type":"string","description":"Restrict users from sharing summaries. Valid values: `external_users` (To those outside of the organization), `all_users` (To all users), `all_users_except_delegate` (To all users except delegates).","example":"external_users","enum":["external_users","all_users","all_users_except_delegate"]},"who_will_receive_summary":{"type":"string","description":"Who to automatically share the summary with. Valid values: `host` (Only webinar host), `host_and_panelist_in_organization` (Only webinar host, co-hosts, and panelists in the organization), `host_and_panelist_not_in_organization` (Webinar host, co-hosts, and all panelists, including those outside the organization).","example":"host_and_panelist_in_organization","enum":["host","host_and_panelist_in_organization","host_and_panelist_not_in_organization"]}},"description":"Allows hosts to generate a summary. Summaries are sent after the webinar has ended based on sharing permissions."},"webinar_questions":{"type":"object","properties":{"enable":{"type":"boolean","description":"Whether to allow users to ask webinar questions with AI.","example":true},"auto_enable":{"type":"boolean","description":"Whether to automatically allow access when the webinar starts.","example":false},"who_can_ask_questions":{"type":"string","description":"Who can ask questions about the webinar. Valid values: `panelist_all` (Hosts and all panelists), `panelist_org` (Hosts and all panelists in the organization), `host` (Only webinar host, co-hosts, and alternative hosts), `all_participants` (All participants).","example":"panelist_org","enum":["panelist_all","panelist_org","host","all_participants"]}},"description":"During the webinar, answers are based on speech-to-text data. If a transcript is retained, participants with access can ask questions after the webinar based on that transcript."}},"description":"Workspace Reservation recommendations with AI."}}},{"title":"Account Authentication Settings","oneOf":[{"title":"index0","type":"object","properties":{"allow_authentication_exception":{"type":"boolean","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.","example":true},"authentication_options":{"type":"array","description":"The account's [**Meeting Authentication Options**](https://support.zoom.us/hc/en-us/articles/360060549492-Allowing-only-authenticated-users-in-meetings#h_01F51KGPWJNQBDMFSJ3ZJQ4AA2) settings.","items":{"type":"object","properties":{"default_option":{"type":"boolean","description":"Whether the authentication option is the default authentication option.","example":true},"domains":{"type":"string","description":"A comma-separated list of approved authentication domains.","example":"www.a-b-c.com"},"id":{"type":"string","description":"The authentication option's ID.","example":"mtg_enforce_domain_Cx3wERazSgup7ZWRHQM8-w"},"name":{"type":"string","description":"The authentication option's name.","example":"Sign in to Zoom with specified domain"},"type":{"type":"string","description":"The authentication type. \n* `enforce_login` - Only users logged in to Zoom can join meetings. \n* `enforce_login_with_domains` - Only users from specific domains can join meetings. The list of domains is defined in the `domains` field. \n* `enforce_login_with_same_account` - Only the Zoom account's users can join meetings.","example":"enforce_login_with_domains","enum":["enforce_login","enforce_login_with_same_account","enforce_login_with_domains"]},"visible":{"type":"boolean","description":"Whether the authentication option is visible.","example":false}}}},"meeting_authentication":{"type":"boolean","description":"Whether to only allow authenticated users to join meetings.","example":true}}},{"title":"index1","type":"object","properties":{"authentication_options":{"type":"array","items":{"type":"object","properties":{"default_option":{"type":"boolean","description":"Authentication default option","example":true},"domains":{"type":"string","description":"Authentication domains.","example":"www.a-b-c.com"},"id":{"type":"string","description":"Authentication id","example":"MialYiatQVa8WwEEB5UiXw"},"name":{"type":"string","description":"Authentication name","example":"test"},"type":{"type":"string","description":"Authentication type","example":"enforce_login_with_domains","enum":["internally","enforce_login","enforce_login_with_domains"]},"visible":{"type":"boolean","description":"Authentication visible","example":false}}}},"recording_authentication":{"type":"boolean","description":"Only authenticated users can view cloud recordings","example":true}}}]},{"title":"Meeting or Webinar Security Account Settings","type":"object","properties":{"meeting_security":{"type":"object","properties":{"auto_security":{"type":"boolean","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.","example":true},"block_user_domain":{"type":"boolean","description":"Whether users in specific domains are blocked from joining meetings and webinars.","example":true},"block_user_domain_list":{"type":"array","description":"The blocked domains.","example":["aa.test.com"],"items":{"maxLength":30,"minLength":5,"type":"string","example":"aa.test.com"}},"chat_etiquette_tool":{"type":"object","properties":{"enable":{"type":"boolean","description":"Whether to enable the **Chat Etiquette Tool**.","example":true},"policies":{"type":"array","description":"Information about the defined **Chat Etiquette Tool** policies.","items":{"type":"object","properties":{"description":{"type":"string","description":"The policy's description.","example":"policy description"},"id":{"type":"string","description":"The policy ID.","example":"1eqdqef42r4wfg3g43w"},"is_locked":{"type":"boolean","description":"Whether the policy is locked by an account-level user. When it is locked, users cannot update the policy.","example":true},"keywords":{"type":"array","description":"A list of defined rule keywords.","items":{"type":"string","example":"test"}},"name":{"type":"string","description":"The policy name.","example":"policy name"},"regular_expression":{"type":"string","description":"The regular expression to match to the content of chat messages.","example":"^test"},"status":{"type":"string","description":"The policy's current status. \n* `activated` - Activated. \n* `deactivated` - Deactivated.","example":"activated","enum":["activated","deactivated"],"x-enum-descriptions":["Activated.","Deactivated."]},"trigger_action":{"type":"integer","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.","example":2,"enum":[1,2],"x-enum-descriptions":["Ask the user to confirm before they send the message.","Block the user's message."]}}}},"policy_max_count":{"type":"integer","description":"The read-only maximum number of **Chat Etiquette Tool** policies.","example":14}},"description":"Information about the **Chat Etiquette Tool**."},"embed_password_in_join_link":{"type":"boolean","description":"Whether the meeting passcode is encrypted and included in the invitation link. The provided link will allow participants to join the meeting without having to enter the passcode.","example":true},"encryption_type":{"type":"string","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.","example":"e2ee","enum":["enhanced_encryption","e2ee"]},"end_to_end_encrypted_meetings":{"type":"boolean","description":"Whether to enable end-to-end encryption for meetings.","example":true},"meeting_password":{"type":"boolean","description":"Whether all instant and scheduled meetings that users can join via client or Zoom Rooms systems are passcode-protected. [Personal meeting ID (PMI)](https://support.zoom.us/hc/en-us/articles/203276937) meetings are **not** included in this setting.","example":true},"meeting_password_requirement":{"type":"object","properties":{"consecutive_characters_length":{"type":"integer","description":"The maximum length of consecutive characters (for example, `abcdef`) allowed in a passcode. \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 passcode, such as `abc1x@8fdh`. \n* `0` - No consecutive character restriction.","example":8,"enum":[0,4,5,6,7,8]},"have_letter":{"type":"boolean","description":"Whether passcodes must contain at least one letter character.","example":true},"have_number":{"type":"boolean","description":"Whether passcodes must contain at least one numeric character.","example":true},"have_special_character":{"type":"boolean","description":"Whether passcodes must contain at least one special character. For example, `!`, `@`, and/or `#` characters.","example":true},"have_upper_and_lower_characters":{"type":"boolean","description":"Whether passcodes must include uppercase and lowercase characters.","example":true},"length":{"type":"integer","description":"The minimum passcode length.","example":8},"only_allow_numeric":{"type":"boolean","description":"Whether passcodes must contain **only** numeric characters.","example":true},"weak_enhance_detection":{"type":"boolean","description":"Whether users are informed when the provided passcode is weak.","example":true}},"description":"Information about the meeting and webinar [passcode requirements](https://support.zoom.us/hc/en-us/articles/360033559832-Meeting-and-webinar-passwords#h_a427384b-e383-4f80-864d-794bf0a37604)."},"only_authenticated_can_join_from_webclient":{"type":"boolean","description":"Whether to specify that only authenticated users can join the meeting from the web client.","example":true},"phone_password":{"type":"boolean","description":"Whether passcodes are required for participants joining by phone. \n\n If enabled and the meeting is passcode-protected, a numeric passcode is required for participants to join by phone. For meetings with alphanumeric passcodes, a numeric passcode will be generated.","example":true},"pmi_password":{"type":"boolean","description":"Whether all Personal Meeting ID (PMI) meetings that users can join via client or Zoom Rooms systems are passcode-protected.","example":true},"require_password_for_scheduled_meeting":{"type":"boolean","description":"Whether passcodes are required for meetings that have already been scheduled.","example":true},"require_password_for_scheduled_webinar":{"type":"boolean","description":"Whether passcodes are required for webinars that have already been scheduled.","example":true},"waiting_room":{"type":"boolean","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.","example":true},"waiting_room_settings":{"type":"object","properties":{"participants_to_place_in_waiting_room":{"type":"integer","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).","example":2,"enum":[0,1,2]},"users_who_can_admit_participants_from_waiting_room":{"type":"integer","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.","example":0,"enum":[0,1]},"whitelisted_domains_for_waiting_room":{"type":"string","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`).","example":"example.com"}},"description":"Information about the Waiting Room settings."},"webinar_password":{"type":"boolean","description":"Whether to generate a passcode when scheduling webinars. Participants must use the generated passcode to join the scheduled webinar.","example":true},"waiting_room_options":{"type":"object","properties":{"enable":{"type":"boolean","description":"Whether to enable the waiting room.","example":true},"locked":{"type":"boolean","description":"Whether to enable the option to lock after selecting  `How are participants admitted from the waiting room`.","example":false},"admit_type":{"type":"integer","description":"The type of admission for participants from the waiting room. \n* `1` - Everyone is automatically admitted. \n* `2` - Participants are manually admitted. \n* `3` - External users are manually admitted. Internal users are automatically admitted10 minutes before start time. \n* `4` - External users and users without approved domains are manually admitted. Internal users are automatically admitted.","example":1,"enum":[1,2,3,4],"x-enum-descriptions":["Everyone is automatically admitted","Participants are manually admitted","External users are manually admitted. Internal users are automatically admitted10 minutes before start time","External users and users without approved domains are manually admitted. Internal users are automatically admitted"]},"internal_user_auto_admit":{"type":"integer","description":"If the `admit_type` in (`1`,`3`,`4`), the time when the internal user can join a meeting before the host. \n* `1` - when the host joins. \n* `2` - anytime. \n* `3` - 5 minutes before start time. \n* `4` - 10 minutes before start time.  \n* `5` - 15 minutes before start time. \n If the `admit_type` equal `1`, this field value can not be `2`. ","example":1,"enum":[1,2,3,4,5],"x-enum-descriptions":["When the host joins","Anytime","5 minutes before start time","10 minutes before start time","15 minutes before start time"]},"admit_domain_allowlist":{"type":"string","description":"If the `admit_type` field is `4`, a comma-separated list of the domains that can bypass the waiting room (`example.com,example2.com`).","example":"example.com"},"who_can_admit_participants":{"type":"integer","description":"The type of 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 (only if host and co-hosts are not present).","example":1,"enum":[0,1],"x-enum-descriptions":["Host and co-hosts only","Host, co-hosts, and anyone who bypassed the waiting room (only if host and co-hosts are not present)"]},"sort_order_of_people":{"type":"integer","description":"The type of sort order of people in the waiting room in the participants panel. \n* `0` - Join order. \n* `1` - Alphabetical. \n This feature is only available with version 5.10.3 or later.","example":1,"enum":[0,1],"x-enum-descriptions":["Join order","Alphabetical"]},"more_options":{"type":"object","properties":{"user_invited_by_host_can_bypass_waiting_room":{"type":"boolean","description":"Users invited during the meeting by the host or co-hosts will bypass the waiting room. \n This feature is only available with version 5.4.0 or later.","example":true},"move_participants_to_waiting_room_when_host_dropped":{"type":"boolean","description":"Move participants to the waiting room if the host dropped unexpectedly. By enabling this option, the waiting room setting will be enabled and locked, and participants will not be allowed to join before the host.","example":true},"allow_participants_to_reply_to_host":{"type":"boolean","description":"Allow participants in the waiting room to reply to host and co-hosts. \n This feature is only available with version 5.8.0 or later.","example":true}},"description":"More Options."}},"description":"Define how participants are admitted into a meeting, including if they can join before the host. Customize the waiting room design."}}}},"description":"The account's meeting and webinar security settings."},{"title":"Video SDK Account Settings","type":"object","properties":{"in_meeting":{"type":"object","properties":{"custom_data_center_regions":{"type":"boolean","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.","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","example":"AU","enum":["AU","LA","CA","CN","DE","HK","IN","IE","TY","MX","NL","SG","US"]}},"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":{"type":"string","example":"EU","enum":["EU","HK","AU","IN","TY","CN","US","CA","DE","NL","LA"]}}},"deprecated":true},"in_session":{"type":"object","properties":{"custom_data_center_regions":{"type":"boolean","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.","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","example":"AU","enum":["AU","LA","CA","CN","DE","HK","IN","IE","TY","MX","NL","SG","US"]}},"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":{"type":"string","example":"EU","enum":["EU","HK","AU","IN","TY","CN","US","CA","DE","NL","LA"]}},"p2p_connetion":{"type":"boolean","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.","example":true},"p2p_ports":{"type":"boolean","description":"Whether to enable the **Listening ports range** setting.","example":true},"ports_range":{"type":"string","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.","example":"1;65535","default":""},"dscp_audio":{"maximum":63,"minimum":1,"type":"integer","description":"The DSCP audio marking value. This value defaults to `56`.","example":56,"default":56},"dscp_marking":{"type":"boolean","description":"Whether to enable [differentiated services code point (DSCP)](https://en.wikipedia.org/wiki/Differentiated_services) marking.","example":true},"dscp_video":{"maximum":63,"minimum":1,"type":"integer","description":"The DSCP video marking value. This value defaults to `40`.","example":40,"default":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":{"type":"boolean","description":"Allow host to split meeting participants into separate, smaller rooms.","example":true}}},"session_security":{"type":"object","properties":{"approved_or_denied_countries_or_regions":{"type":"object","properties":{"approved_list":{"type":"array","description":"List of countries/regions from where participants can join this meeting. ","items":{"type":"string","example":"CX"}},"denied_list":{"type":"array","description":"List of countries/regions from where participants can not join this meeting. ","items":{"type":"string","example":"CA"}},"enable":{"type":"boolean","description":"`true`: Setting enabled to either allow or block users from specific regions from joining your meetings.   \n \n\n`false`: Setting disabled.","example":true},"method":{"type":"string","description":"Specify whether to allow users from specific regions to join this meeting, or block users from specific regions from joining this meeting.   \n   \n \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`.  \n   \n \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`","example":"approve","enum":["approve","deny"]}},"description":"Approve or block users from specific regions or countries from joining this meeting. \n"}}},"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.","example":30,"enum":[30,60,90,120]}}}}}]}}}},"404":{"description":"**HTTP Status Code:** `404` <br>\n Not Found  \n\n **Error Code:** `2001` <br>\n Account does not exist: $accountId <br>\n"},"429":{"description":"**HTTP Status Code:** `429` <br>\n Too Many Requests. For more information, see [rate limits](https://developers.zoom.us/docs/api/rest/rate-limits/). \n\n "}},"security":[{"openapi_authorization":[]}],"x-extensions":{"x-permissions":["SubAccount:Edit","SubAccount:Read"],"x-macro-scopes":["account:read:admin","account:write:admin"],"x-granular-scopes":["account:read:settings:master"]}},"patch":{"tags":["Accounts"],"summary":"Update account settings","description":"Update an account's settings. \nTo update the settings for a master account, pass the `me` value for the `accountId` path parameter. \n\n **Prerequisites:** \n* The account must be a paid account.\n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `account:write:admin`\n\n**[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `account:update:settings:master`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`","operationId":"accountSettingsUpdate","parameters":[{"name":"accountId","in":"path","required":true,"schema":{"type":"string"}},{"name":"option","in":"query","description":"Optional query parameters. \n* `meeting_authentication` - 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` - 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` - View the account's security settings. For example, passcode requirements for user login or two-factor authentication. \n* `meeting_security` - View the meeting security settings applied to the user's account.","required":false,"schema":{"type":"string","example":"meeting_security","enum":["meeting_authentication","recording_authentication","security","meeting_security"]}}],"requestBody":{"content":{"application/json":{"schema":{"oneOf":[{"title":"Information about the account's updated settings.","type":"object","properties":{"security":{"type":"object","properties":{"admin_change_name_pic":{"type":"boolean","description":"Whether to only allow account administrators to change a user's picture.","example":true,"deprecated":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","example":"[\"name\",\"host_key\",\"sign_in_email\"]","enum":["name","profile_picture","sign_in_email","host_key"]}},"signin_with_sso":{"type":"object","properties":{"enable":{"type":"boolean","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.","example":true},"require_sso_for_domains":{"type":"boolean","description":"Whether to require users to sign in with single sign-on (SSO) if their e-mail address belongs to one of the `domains`.","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"}},"operation":{"type":"string","description":"The policy operation to perform for the update sso_bypass_user_ids. **If the value does not exist, it means overwrite users from sso_bypass_user_ids.**  \n* `add` - Add some users from sso_bypass_user_ids.  \n* `remove` - Remove users from sso_bypass_user_ids.","example":"add","enum":["add","remove"]}},"description":"Allow users to sign in with single sign-on (SSO). "},"hide_billing_info":{"type":"boolean","description":"Hide billing information.","example":true},"import_photos_from_devices":{"type":"boolean","description":"Allow users to import photos from a photo library on a  device.","example":true},"password_requirement":{"type":"object","properties":{"consecutive_characters_length":{"type":"integer","description":"\nSpecify the max length of consecutive characters(abcde...) that can be used in a passcode.\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 passcode.\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 passcode(example: abc1x@8fdh).","example":8},"have_special_character":{"type":"boolean","description":"If the value of this field is set to `true`, the passcode must have at least one special character(!, @, #...).","example":true},"minimum_password_length":{"maximum":14,"minimum":8,"type":"integer","description":"Specify a minimum length for the passcode. The passcode length can be between 9 and 14 characters. If the value of this field is `0`, this field is disabled and the basic passcode length (minimum of 8 characters) is required.","example":8},"weak_enhance_detection":{"type":"boolean","description":"If the value of this field is set to `true`, user passcodes will have to pass detection through a weak passcode dictionary in case hackers use simple passcodes to sign in to your users' accounts.","example":false},"first_login_rule":{"type":"boolean","description":"Whether new users need to change their passwords upon first sign-in.","example":true},"former_rule":{"type":"integer","description":"The number of previous passwords that users cannot reuse. Set this value to `0` to remove the rule.","example":5,"enum":[0,3,4,5,6,7,8,9,10,11,12]},"change_rule":{"type":"integer","description":"The maximum number of times users can change their passwords within 24 hours. Set this value to `0` to remove the rule.","example":3,"enum":[0,1,2,3,4,5,6,7,8]},"expired_rule":{"type":"integer","description":"The number of days after which a password expires automatically. Set this value to `0` to remove the rule.","example":90,"enum":[0,30,60,90,120]}},"description":"This object refers to the [enhanced passcode 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 passcode."},"sign_again_period_for_inactivity_on_client":{"type":"integer","description":"Settings for user sign-in interval requirements after a period of inactivity. If enabled, this setting forces automatic logout of Zoom client app users after a set amount of time.   \n \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 inactivity-period value can be one of these options.  \n \n\n`5`: 5 minutes  \n \n`10`: 10 minutes  \n \n`15`: 15 minutes  \n \n`30`: 30 minutes  \n \n`45`: 45 minutes  \n \n`60`: 60 minutes  \n \n`90`: 90 minutes  \n \n`120`: 120 minutes\n","example":5},"sign_again_period_for_inactivity_on_web":{"type":"integer","description":"Settings for user sign-in interval requirements after a period of inactivity. If enabled, this setting forces automatic logout of Zoom web portal users after a set amount of time.   \n \n\nIf this setting is disabled, the value of this field is `0`. If the setting is enabled, the value of this field indicates the **period of inactivity** in minutes, after which an inactive user will be automatically logged out of the Zoom web portal. The inactivity-period value can be one of these options.  \n \n\n`5`: 5 minutes  \n \n`10`: 10 minutes  \n \n`15`: 15 minutes  \n \n`30`: 30 minutes  \n \n`60`: 60 minutes  \n \n`120`: 120 minutes\n\n    \n\n","example":10},"sign_in_with_two_factor_auth":{"type":"string","description":"Settings for 2FA( [two factor authentication](https://support.zoom.us/hc/en-us/articles/360038247071) ).\n`all`: Two factor authentication will be enabled for all users in the account.  \n \n`none`: Two factor authentication is disabled.  \n \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.  \n \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","example":"none","enum":["all","group","role","none"]},"sign_in_with_two_factor_auth_groups":{"type":"array","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"}},"sign_in_with_two_factor_auth_roles":{"type":"array","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"}},"sign_in_with_google":{"type":"object","properties":{"enable_sign_in_with_google":{"type":"boolean","description":"Whether to enable sign-in with Google.","example":true},"force_google_login":{"type":"boolean","description":"Whether to require users from configured domains to sign in with Google.","example":true},"google_login_domains":{"type":"array","description":"Approved account domains assigned to Google force redirect.","example":["example.com"],"items":{"type":"string","example":"example.com"}}},"description":"Configure sign-in with Google and Google force-redirect domains."},"otp_auth":{"type":"boolean","description":"Whether OTP authentication is enabled.","example":true},"enforce_logout_bypass_management":{"type":"object","properties":{"allow_zr_stay_signed_in":{"type":"boolean","description":"Whether Zoom Rooms can stay signed in.","example":true},"allow_zpa_stay_signed_in":{"type":"boolean","description":"Whether Zoom Phone Appliance devices can stay signed in.","example":false}},"description":"Configure applications that can bypass enforced logout."},"hide_push_notification_content":{"type":"boolean","description":"Whether push notification content is hidden.","example":true},"support_clock_out":{"type":"boolean","description":"Whether the clock-out security feature is enabled.","example":true},"require_biometric_auth":{"type":"boolean","description":"Whether biometric authentication is required.","example":true},"block_screenshots":{"type":"boolean","description":"Whether screenshots are blocked.","example":true},"sign_in_with_work_email":{"type":"boolean","description":"Whether users can sign in with a work email address.","example":true},"sign_in_with_fb":{"type":"boolean","description":"Whether users can sign in with Facebook.","example":false},"sign_in_with_apple":{"type":"boolean","description":"Whether users can sign in with Apple.","example":true},"sign_in_with_microsoft":{"type":"boolean","description":"Whether users can sign in with Microsoft.","example":true},"sign_in_with_phone_number":{"type":"object","properties":{"enable_sign_in_with_phone_number":{"type":"boolean","description":"Whether users can sign in with a phone number.","example":true},"sign_in_with_sms_code":{"type":"boolean","description":"Whether users can sign in with an SMS verification code.","example":true}},"description":"Configure phone number sign-in."},"sign_in_with_passkey":{"type":"boolean","description":"Whether users can sign in with a passkey.","example":true},"sign_in_with_outlook":{"type":"object","properties":{"enable_sign_in_with_outlook":{"type":"boolean","description":"Whether users can sign in with Outlook.","example":true},"zm_official_nested_app_auth":{"type":"boolean","description":"Whether official nested application authorization is enabled.","example":true},"enable_custom_nested_app_auth":{"type":"boolean","description":"Whether custom nested application authorization is enabled.","example":false},"custom_nested_app_id":{"type":"string","description":"The custom nested application ID.","example":"00000000-0000-0000-0000-000000000000"}},"description":"Configure Outlook sign-in."},"only_mdm_mobile_can_sign_in":{"type":"object","properties":{"enable_only_mdm_mobile_sign_in":{"type":"boolean","description":"Whether the MDM-managed device sign-in parent restriction is enabled. Does not encode Mobile vs PC.","example":true},"only_mdm_mobile_can_sign_in_tag":{"type":"string","description":"The MDM management tag required when the parent restriction is enabled.","example":"corporate"}},"description":"Deprecated. Parent on/off and MDM tag only; does not encode Mobile vs PC. Use `only_mdm_managed_devices_can_sign_in` instead.","deprecated":true},"only_zoom_for_intune_app_can_sign_in":{"type":"boolean","description":"Whether users can only sign in through the Zoom for Intune application.","example":true},"trusted_microsoft_tenant":{"type":"string","description":"A JSON-encoded array of trusted Microsoft tenant IDs. Each tenant ID must be a UUID.","example":"[\"123e4567-e89b-12d3-a456-426614174000\"]"},"multiple_resource_login":{"type":"object","properties":{"enable_multiple_resource_login":{"type":"boolean","description":"Whether multiple resource login is enabled.","example":true},"multiple_resource_login_limit":{"type":"integer","description":"The maximum number of concurrent resource logins.","example":3}},"description":"Configure multiple resource login."},"automatic_sign_out":{"type":"object","properties":{"enable_separated_sign_out_settings":{"type":"boolean","description":"Whether different platforms can use different automatic sign-out durations.","example":true},"email_or_phone":{"type":"object","properties":{"desktop_client":{"type":"integer","description":"Automatic sign-out duration in seconds. `-1` disables automatic sign-out for this platform.","example":5184000,"enum":[-1,3600,10800,21600,43200,86400,259200,604800,1296000,2592000,5184000,7776000,10368000,15552000]},"mobile_client":{"type":"integer","description":"Automatic sign-out duration in seconds. `-1` disables automatic sign-out for this platform.","example":5184000,"enum":[-1,3600,10800,21600,43200,86400,259200,604800,1296000,2592000,5184000,7776000,10368000,15552000]},"web_browser":{"type":"integer","description":"Automatic sign-out duration in seconds. `-1` disables automatic sign-out for this platform.","example":5184000,"enum":[-1,3600,10800,21600,43200,86400,259200,604800,1296000,2592000,5184000,7776000,10368000,15552000]},"zoom_scheduling_integration":{"type":"integer","description":"Automatic sign-out duration in seconds. `-1` disables automatic sign-out for this platform.","example":7776000,"enum":[-1,3600,10800,21600,43200,86400,259200,604800,1296000,2592000,5184000,7776000,10368000,15552000]}},"description":"Automatic sign-out settings for email or phone number login."},"sso":{"type":"object","properties":{"desktop_client":{"type":"integer","description":"Automatic sign-out duration in seconds. SSO additionally supports 900 and 1800 seconds.","example":2592000,"enum":[-1,900,1800,3600,10800,21600,43200,86400,259200,604800,1296000,2592000,5184000,7776000,10368000,15552000]},"mobile_client":{"type":"integer","example":2592000,"enum":[-1,900,1800,3600,10800,21600,43200,86400,259200,604800,1296000,2592000,5184000,7776000,10368000,15552000]},"web_browser":{"type":"integer","example":2592000,"enum":[-1,900,1800,3600,10800,21600,43200,86400,259200,604800,1296000,2592000,5184000,7776000,10368000,15552000]},"zoom_scheduling_integration":{"type":"integer","example":2592000,"enum":[-1,900,1800,3600,10800,21600,43200,86400,259200,604800,1296000,2592000,5184000,7776000,10368000,15552000]}},"description":"Automatic sign-out settings for SSO login. SSO additionally supports 900 and 1800 seconds."},"social_oauth":{"type":"object","properties":{"desktop_client":{"type":"integer","example":-1,"enum":[-1]},"mobile_client":{"type":"integer","example":-1,"enum":[-1]},"web_browser":{"type":"integer","description":"Automatic sign-out duration in seconds for social OAuth web browser sessions.","example":2592000,"enum":[-1,3600,10800,21600,43200,86400,259200,604800,1296000,2592000,5184000,7776000,10368000,15552000]},"zoom_scheduling_integration":{"type":"integer","example":-1,"enum":[-1]}},"description":"Automatic sign-out settings for social OAuth login. Only `web_browser` is supported. Other platforms are always `-1`."}},"description":"Automatically sign users out after a specified period."},"only_mdm_managed_devices_can_sign_in":{"type":"object","properties":{"enable":{"type":"boolean","description":"Whether to enable the MDM-managed device sign-in restriction.","example":true},"only_mdm_managed_mobile_can_sign_in":{"type":"boolean","description":"Whether to restrict MDM tag checks to mobile Zoom clients when the parent restriction is enabled.","example":true},"only_mdm_managed_pc_can_sign_in":{"type":"boolean","description":"Whether to restrict MDM tag checks to Windows, Mac, or Linux Zoom clients when the parent restriction is enabled.","example":false},"only_mdm_managed_devices_can_sign_in_tag":{"maxLength":4000,"type":"string","description":"The MDM management tag required when the parent restriction is enabled. Maximum 4,000 characters.","example":"corporate"}},"description":"Restricts Zoom client sign-in to MDM-managed mobile and/or PC devices, including the required management tag."}},"description":"[Security settings](https://support.zoom.us/hc/en-us/articles/360034675592-Advanced-security-settings#h_bf8a25f6-9a66-447a-befd-f02ed3404f89) of an Account."},"audio_conferencing":{"type":"object","properties":{"toll_free_and_fee_based_toll_call":{"type":"object","properties":{"allow_webinar_attendees_dial":{"type":"boolean","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 with version 5.2.2 or later.","example":true},"enable":{"type":"boolean","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.","example":true},"numbers":{"maxItems":100,"type":"array","description":"The account's **Toll-free and Fee-based Toll Call** phone number information.","items":{"type":"object","properties":{"code":{"type":"string","description":"The phone number's [E.164 country calling code](https://en.wikipedia.org/wiki/List_of_country_calling_codes).","example":"86"},"country_code":{"type":"string","description":"The phone number's two-letter [country code](https://developers.zoom.us/docs/api/rest/other-references/abbreviation-lists/#countries).","example":"CN"},"country_name":{"type":"string","description":"The country name.","example":"China"},"display_number":{"maxLength":30,"type":"string","description":"The phone number's display number.","example":"+86 777 777 77"},"number":{"maxLength":30,"type":"string","description":"The phone number.","example":"777 777 77"}}}}},"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."},"toll_call":{"type":"object","properties":{"enable":{"type":"boolean","description":"Whether the account has the [**Toll Call**](https://support.zoom.com/hc/en/article?id=zm_kb&sysparm_article=KB0066909#h_01F51680NJ7YHZDXGJNSKDGM2P) setting enabled.","example":true},"numbers":{"maxItems":100,"type":"array","description":"The account's **Toll Call** phone number information.","items":{"type":"object","properties":{"code":{"type":"string","description":"The phone number's [E.164 country calling code](https://en.wikipedia.org/wiki/List_of_country_calling_codes).","example":"86"},"number":{"maxLength":30,"type":"string","description":"The phone number.","example":"777 777 77"}}}}},"description":"The account's [**Toll Call**](https://support.zoom.com/hc/en/article?id=zm_kb&sysparm_article=KB0066909#h_01F51680NJ7YHZDXGJNSKDGM2P) settings."},"call_me_and_invite_by_phone":{"type":"object","properties":{"enable":{"type":"boolean","description":"Whether the account has the [**Call Me and Invite by Phone**](https://support.zoom.com/hc/en/article?id=zm_kb&sysparm_article=KB0067414#h_01F53VFZMDP4EJAF772N7NG2KY) setting enabled.","example":true},"require_press_1_for_call_me":{"type":"string","description":"Require Call Me users to press 1 before being connected to the meeting. \n* `auto` - Automatically determine whether to require pressing 1 before connecting to the meeting. \n* `always` - Always require Call Me users to press 1 before connecting to the meeting. \n* `never` - Never require Call Me users to press 1 before connecting to the meeting.","example":"auto","enum":["auto","always","never"],"x-enum-descriptions":["Automatically determine whether to require pressing 1 before connecting to the meeting.","Always require Call Me users to press 1 before connecting to the meeting.","Never require Call Me users to press 1 before connecting to the meeting."]},"call_out_countries":{"type":"object","properties":{"selected_countries":{"type":"array","description":"The list of countries/regions that users can call out to.","items":{"type":"object","properties":{"code":{"type":"string","description":"The [code](https://developers.zoom.us/docs/api/rest/other-references/abbreviation-lists/#countries) of the country or region.","example":"CN"}}}}},"description":"The account's call out countries/regions settings."},"allow_webinar_attendees_call_me":{"type":"boolean","description":"Whether webinar attendees can use Call Me to connect audio. This feature is only available in version 5.2.2 and higher.","example":true}},"description":"The account's [**Call Me and Invite by Phone**](https://support.zoom.com/hc/en/article?id=zm_kb&sysparm_article=KB0067414#h_01F53VFZMDP4EJAF772N7NG2KY) settings."},"personal_audio_conference":{"type":"boolean","description":"Whether the account has the [**Personal Audio Conference**](https://support.zoom.com/hc/en/article?id=zm_kb&sysparm_article=KB0060449#h_01F5BPMEB7GK6XXPKHDBHYFF27) setting enabled.","example":true},"participant_phone_masking":{"type":"object","properties":{"enable":{"type":"boolean","description":"Whether the account has the [**Mask phone number in the participant list**](https://support.zoom.com/hc/en/article?id=zm_kb&sysparm_article=KB0067881#h_01F5K5GT9P563K751K3JNAYE6E) setting enabled.","example":true},"masking_type":{"type":"string","description":"The type of phone number masking pattern to apply. \n* `mask_default` - Default masking pattern (Example: 888****666). \n* `mask_first_5` - Mask first five digits (Example: *****66666). \n* `mask_except_last_4` - Mask everything except last four digits (Example: *****6666).","example":"mask_default","enum":["mask_default","mask_first_5","mask_except_last_4"],"x-enum-descriptions":["Default masking pattern (Example: 888****666).","Mask first five digits (Example: *****66666).","Mask everything except last four digits (Example: *****6666)."]}},"description":"The account's [**Mask phone number in the participant list**](https://support.zoom.com/hc/en/article?id=zm_kb&sysparm_article=KB0067881#h_01F5K5GT9P563K751K3JNAYE6E) settings."},"global_dial_in_countries":{"type":"object","properties":{"selected_countries":{"type":"array","description":"The list of selected countries/regions whose dial-in numbers will be listed in the email invitation.","items":{"type":"object","properties":{"code":{"type":"string","description":"The [code](https://developers.zoom.us/docs/api/rest/other-references/abbreviation-lists/#countries) of the country or region.","example":"CN"}}}},"include_toll_free":{"type":"boolean","description":"Whether to include toll-free numbers in the email invitation for the selected countries/regions.","example":true}},"description":"The account's [**Global Dial-in Countries/Regions**](https://support.zoom.com/hc/en/article?id=zm_kb&sysparm_article=KB0068094#h_01F5KK9J31ZXNW10BRH86NHX4G) settings."}},"description":"Account Audio Conference Settings"},"chat":{"type":"object","properties":{"allow_bots_chat":{"type":"boolean","description":"Whether chatbots added to chats and channels can read and write messages.","example":true},"share_files":{"type":"object","properties":{"enable":{"type":"boolean","description":"Allow users to view, share, and forward files in chats and channels. When disabled, users can still take, share, and forward screenshots; record and forward voice and video messages; send and forward GIF images; and send and forward code snippets if those specific settings are enabled.","example":true},"share_option":{"type":"string","description":"Allow users of this account to send files in chats and channels.","example":"account","enum":["disable","anyone","account","organization"],"x-enum-descriptions":["Disabled sharing","Anyone (internal and external contacts)","In the same account","In the same organization"]},"view_option":{"type":"string","description":"Allow users of this account to view files in chats and channels.","example":"anyone","enum":["anyone","account","organization"],"x-enum-descriptions":["Anyone (internal and external contacts)","In the same account","In the same organization"]},"restrictions":{"type":"object","properties":{"only_allow_specific_file_types":{"type":"boolean","description":"Only allow specified file types.","example":true},"file_type_restrictions":{"type":"array","description":"Specified file types for all users.","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","description":"Specified file types for external users.","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]},"file_restrictions_apply_to":{"type":"string","description":"Apply restrictions to both sharing and viewing, or only apply to sharing","example":"sharing_and_viewing","enum":["sharing_and_viewing","sharing"]}},"description":"User restrictions for sharing and viewing files in chats and channels."}},"description":"Users can share and view files in chats and channels."},"chat_emojis":{"type":"object","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","description":"All emojis / selected emojis","example":"all","enum":["all","selected"],"x-enum-descriptions":["All emojis","Selected emojis"]}},"description":"Chat emojis."},"record_voice_messages":{"type":"boolean","description":"Allow users to record voice messages that can be sent in direct messages or group conversations.","example":true},"record_video_messages":{"type":"boolean","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.","example":true},"screen_capture":{"type":"boolean","description":"Allow users to take and send screenshots in direct messages or group conversations.","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},"create_group_chat":{"type":"boolean","description":"Allow users to create group chats.","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","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"}},"description":"Set retention period for messages and files in Zoom's cloud."},"set_retention_period_in_local":{"type":"object","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"}},"description":"Store messages on local devices, excluding personal channel messages."},"allow_users_to_add_contacts":{"type":"object","properties":{"enable":{"type":"boolean","description":"By disabling this setting, users will not be able to add contacts.","example":true},"selected_option":{"type":"integer","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.","example":4,"enum":[1,2,3,4]},"user_email_addresses":{"type":"string","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.","example":"123@test.com"}},"description":"Allow users to add contacts."},"allow_users_to_chat_with_others":{"type":"object","properties":{"enable":{"type":"boolean","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.","example":true},"selected_option":{"type":"integer","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.","example":4,"enum":[1,2,3,4]},"user_email_addresses":{"type":"string","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.","example":"123@test.com"}},"description":"Allow users to chat with others."},"chat_etiquette_tool":{"type":"object","properties":{"enable":{"type":"boolean","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.","example":true,"default":false},"operate":{"type":"string","description":"The policy operation to perform for the update. \n* `create` - Create policies. \n* `update` - Update policies. \n* `delete` - Delete policies.","example":"update","enum":["create","update","delete"],"x-enum-descriptions":["Add new policies.","Update policies.","Delete policies."]},"policies":{"type":"array","description":"Information about the defined **Chat Etiquette Tool** policies.","items":{"type":"object","properties":{"description":{"type":"string","description":"The policy's description.","example":"The policy's description"},"id":{"type":"string","description":"The policy ID.","example":"afwefwef243fwef132f2g43g43g44br"},"is_locked":{"type":"boolean","description":"Whether to lock the policy. When it is locked, users cannot update the policy. This value defaults to `false`.","example":true,"default":false},"keywords":{"type":"array","description":"A list of defined rule keywords.","items":{"type":"string","example":"test"}},"name":{"type":"string","description":"The policy name.","example":"the policy name"},"regular_expression":{"type":"string","description":"The regular expression to match to the content of chat messages.","example":"^test"},"status":{"type":"string","description":"The policy's current status. \n* `activated` - Activated. \n* `deactivated` - Deactivated.","example":"activated","enum":["activated","deactivated"],"x-enum-descriptions":["Activated.","Deactivated."]},"trigger_action":{"type":"integer","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.","example":1,"enum":[1,2],"x-enum-descriptions":["Ask the user to confirm before they send the message.","Block the user's message."]}}}}},"description":"Information about the **Chat Etiquette** tool."},"send_data_to_third_party_archiving_service":{"type":"object","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.","example":"global_relay","enum":["global_relay","smarsh"],"x-enum-descriptions":["Global Relay","Smarsh"]},"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"}},"description":"Send data to third-party archiving service."},"apply_local_storage_to_personal_channel":{"type":"object","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"}},"description":"Store personal channel messages on local devices."},"translate_messages":{"type":"boolean","description":"Allow users to translate team chat messages. [Learn more].(https://support.zoom.us/hc/en-us/articles/12998089084685)","example":true},"search_and_send_animated_gif_images":{"type":"object","properties":{"enable":{"type":"boolean","description":"Whether to allow users to search GIF images from GIPHY when they compose messages.","example":true},"giphy_content_rating":{"type":"integer","description":"Set the GIPHY content rating. This feature is only available for Zoom Client v5.11.0 or later.","example":1,"enum":[1,2,3,4],"x-enum-descriptions":["G - Level 1","PG - Level 2","PG-13 - Level 13","R - Level 4"]}},"description":"Allow users to search GIF images from GIPHY when they compose messages. See GIPHY's website for more information about content ratings."},"external_collab_restrict":{"type":"object","properties":{"enable":{"type":"boolean","description":"Restrict external collaboration in group chats and channels for a select group","example":true},"external_chat":{"type":"string","description":"The type of restrict external collaboration in group chats and channels for a select group\n*  - Allowed user group\n*  - Not allowed user group","example":"allowed","enum":["allowed","not_allowed"]},"group_id":{"type":"string","description":"The group Id","example":"QSuHwTcvQoWPoG0ennkRug"}},"description":"Restrict external collaboration in group chats and channels for a select group"},"external_user_control":{"type":"object","properties":{"enable":{"type":"boolean","description":"Allow to add external users into group chats and channels","example":true},"selected_option":{"type":"integer","description":"The type of allowing external user control \n* 1 - Everyone\n* 2 - Only members in your organization, plus specified external accounts\n* 3 - Only the account owner and admins","example":1,"enum":[1,2,3]},"external_account":{"type":"boolean","description":"Allow this setting to be edited for specified accounts","example":true}},"description":"Add external users into group chats and channels"},"external_invite_approve":{"type":"object","properties":{"enable":{"type":"boolean","description":"Require admin approval for adding external users in group chats and channels","example":true},"selected_option":{"type":"integer","description":"The type of requiring admin approval for adding external users in group chats and channels* 1 - Send requests directly to all approvers* 2 - Send requests to a specific channel","example":1,"enum":[1,2]},"channel_id":{"type":"string","description":"The channel Id","example":"5fedbc697f8545aca465b5b114ad4275"},"external_account":{"type":"boolean","description":" Allow this setting to be edited for specified accounts","example":true}},"description":"Require admin approval for adding external users in group chats and channels"},"external_member_join":{"type":"object","properties":{"enable":{"type":"boolean","description":"Allow members of your organization to join external group chats and channels","example":true},"external_account":{"type":"boolean","description":"Allow this setting to be edited for specified accounts","example":true}},"description":"Allow members of your organization to join external group chats and channels"},"external_join_approve":{"type":"object","properties":{"enable":{"type":"boolean","description":"Require admin approval for joining external group chats and channels","example":true},"selected_option":{"type":"integer","description":"The type of requiring admin approval for joining external group chats and channels\n* 1 - Send requests directly to all approvers\n* 2 - Send requests to a specific channel","example":1,"enum":[1,2]},"channel_id":{"type":"string","description":"The channel Id","example":"5fedbc697f8545aca465b5b114ad4275"},"external_account":{"type":"boolean","description":"Allow this setting to be edited for specified accounts","example":true}},"description":"Require admin approval for joining external group chats and channels"},"download_file":{"type":"boolean","description":"Downloading files","example":true},"share_screen_in_chat":{"type":"boolean","description":"Share screen in chat","example":true},"code_snippet":{"type":"boolean","description":"Send code snippet","example":true},"personal_channel":{"type":"boolean","description":"Enable Personal Chat","example":true},"store_revise_chat":{"type":"boolean","description":"Store edited and deleted message revisions","example":false},"set_chat_as_default_tab":{"type":"boolean","description":"Set Team Chat as a default tab for first-time users","example":false},"hyper_link":{"type":"boolean","description":"Allow hyperlinks in Team Chat","example":true},"suppress_removal_notification":{"type":"boolean","description":"Suppress deleted, deactivated, and reactivated user notice in group chats and channels","example":true},"suppress_user_group_notification":{"type":"boolean","description":"Suppress add and remove user notice in channels","example":false},"allow_remove_msg_by_owner_and_admins":{"type":"boolean","description":"Allow channel owner and admin(s) to remove messages of other members","example":true},"allow_huddles_from_channels":{"type":"boolean","description":"Allow huddles from channels","example":true},"shared_spaces":{"type":"boolean","description":"Allow users to create Shared Spaces","example":true},"chat_email_address":{"type":"object","properties":{"enable":{"type":"boolean","description":"Chat email address","example":true},"only_allow_specific_domains":{"type":"boolean","description":"Only allow emails from specified domains","example":false},"specific_domains":{"type":"array","description":"Specified domains.","items":{"type":"string","description":"Specified domains.","example":"[\"example.com\"]"}}},"description":"Allow users to create email addresses for chats and channels. Email sent to a created address will also be posted in respective chat or channel."},"read_receipts":{"type":"object","properties":{"enable":{"type":"boolean","description":"Enable read receipts","example":false},"allow_users_opt_out":{"type":"boolean","description":"Allow users to opt out","example":false}},"description":"Indicate when messages have been seen by recipients, for chats and channels with less than 20 members."},"allow_delete_message":{"type":"object","properties":{"enable":{"type":"boolean","description":"Allow users to delete messages","example":true},"time":{"type":"integer","description":"Within how many minitues of posting","example":5,"enum":[0,5,30,60,1440,10080]}},"description":"When this setting is enabled, users can delete their own messages in Team Chat. If the user is the channel owner or admin and this setting is disabled, the user will also not be able to remove messages of other members in that channel even if other settings allow this. Time frame is configurable even when account setting is OFF and unlocked."},"allow_edit_message":{"type":"object","properties":{"enable":{"type":"boolean","description":"Allow users to edit messages","example":true},"time":{"type":"integer","description":"Within how many minitues of posting","example":5,"enum":[0,5,30,60,1440,10080]}},"description":"When this setting is enabled, users can edit their own messages in Team Chat. Time frame is configurable even when account setting is OFF and unlocked."},"show_status_to_internal_contact":{"type":"boolean","description":"Show status to internal contacts","example":true},"presence_on_meeting":{"type":"boolean","description":"Change my presence status when I am in a meeting or call","example":true},"presence_away_when_screen_saver":{"type":"boolean","description":"Change my status to away when screen saver begins","example":false},"show_h323_contact_tab":{"type":"boolean","description":"Show H.323 contacts","example":false},"ai_summary":{"type":"object","properties":{"enable":{"type":"boolean","description":"Summarize with AI Companion","example":false},"shown_in_team_chat":{"type":"boolean","description":"Show in Team Chat","example":true}},"description":"The field has been moved from the `chat` object to the `ai` object and renamed to `chat_summary` to better reflect its functionality.\n\nAllow users to summarize chats, channels, and shared documents.","deprecated":true},"ai_compose":{"type":"object","properties":{"enable":{"type":"boolean","description":"Compose with AI Companion","example":false},"shown_in_team_chat":{"type":"boolean","description":"Show in Team Chat","example":true}},"description":"The field has been moved from the `chat` object to the `ai` object and renamed to `chat_compose` to better reflect its functionality.\n\nAllow users to summarize chats, channels, and shared documents.","deprecated":true},"ai_recommend":{"type":"boolean","description":"**Zoom no longer supports this feature.**\nChat Recommendation with Zoom AI Companion","example":false,"deprecated":true},"ai_quick_reply":{"type":"boolean","description":"**Zoom no longer supports this feature.**\nQuick reply with AI Companion","example":false,"deprecated":true},"ai_sentence_completion":{"type":"boolean","description":"**Zoom no longer supports this feature.**\nSentence completion with AI Companion","example":false,"deprecated":true},"ai_quick_schedule":{"type":"boolean","description":"**Zoom no longer supports this feature.**\nQuick schedule with AI Companion","example":false,"deprecated":true},"survey_poll":{"type":"boolean","description":"Allow users to launch a poll in chats and channels","example":true}},"description":"The account's chat settings."},"email_notification":{"type":"object","properties":{"alternative_host_reminder":{"type":"boolean","description":"Notify when an alternative host is set or removed from a meeting.","example":true},"cancel_meeting_reminder":{"type":"boolean","description":"Notify the host and participants when a meeting is cancelled.","example":true},"cloud_recording_available_reminder":{"type":"boolean","description":"Whether to notify the host when a cloud recording is available.","example":true},"jbh_reminder":{"type":"boolean","description":"Notify the host when participants join the meeting before them.","example":true},"low_host_count_reminder":{"type":"boolean","description":"Notify user when host licenses are running low.","example":true},"recording_available_reminder_alternative_hosts":{"type":"boolean","description":"Whether to notify any alternative hosts when a cloud recording is available.","example":true},"recording_available_reminder_schedulers":{"type":"boolean","description":"Whether to notify the person who scheduled the meeting or webinar for the host when a cloud recording is available.","example":true},"schedule_for_reminder":{"type":"boolean","description":"Notify the host there is a meeting is scheduled, rescheduled, or cancelled.","example":true}},"description":"Account Settings: Notification."},"feature":{"type":"object","properties":{"meeting_capacity":{"type":"integer","description":"Set the maximum number of participants a host can have in a single meeting.","example":100}},"description":"Account Settings: Feature."},"in_meeting":{"type":"object","properties":{"alert_guest_join":{"type":"boolean","description":"Whether to enable [guest participant](https://support.zoom.us/hc/en-us/articles/115004791123-Identifying-guests-in-the-meeting-webinar) alerts.","example":true},"allow_host_to_enable_focus_mode":{"type":"boolean","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`.","example":true},"allow_live_streaming":{"type":"boolean","description":"Whether to allow livestreaming.","example":true},"allow_users_to_delete_messages_in_meeting_chat":{"type":"boolean","description":"If the value of this field is set to `true`,  allow users to delete messages in the in-meeting chat.\n","example":true},"allow_participants_chat_with":{"type":"integer","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.","example":2,"enum":[1,2,3,4]},"allow_participants_to_rename":{"type":"boolean","description":"Whether to allow meeting participants to rename themselves during a meeting.","example":true},"allow_show_zoom_windows":{"type":"boolean","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.","example":true},"allow_users_save_chats":{"type":"integer","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.","example":2,"enum":[1,2,3]},"annotation":{"type":"boolean","description":"Whether to allow meeting participants to use the [annotation tools](https://support.zoom.us/hc/en-us/articles/115005706806).","example":true},"anonymous_question_answer":{"type":"boolean","description":"Whether to enable anonymous Q&amp;A.","example":true},"attendee_on_hold":{"type":"boolean","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.**","example":true,"deprecated":true,"default":false},"attention_mode_focus_mode":{"type":"boolean","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`.","example":true,"default":false},"auto_answer":{"type":"boolean","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.","example":true},"auto_saving_chat":{"type":"boolean","description":"Whether to automatically save all in-meeting chats.","example":true},"breakout_room":{"type":"boolean","description":"Whether to allow the meeting host to split meeting participants into separate breakout rooms.","example":true},"breakout_room_schedule":{"type":"boolean","description":"Whether the host can assign participants to breakout rooms when scheduling. This feature is **only** available in version 4.5.0 or higher.","example":true},"chat":{"type":"boolean","description":"Whether to enable chat during meeting for all participants.","example":true},"meeting_question_answer":{"type":"boolean","description":"Allow participants to ask questions for the host and participants to answer.","example":true},"closed_caption":{"type":"boolean","description":"Whether to enable closed captions.","example":true},"closed_captioning":{"type":"object","properties":{"auto_transcribing":{"type":"boolean","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).","example":true},"enable":{"type":"boolean","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).","example":true},"save_caption":{"type":"boolean","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.","example":true},"third_party_captioning_service":{"type":"boolean","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.","example":true},"view_full_transcript":{"type":"boolean","description":"Whether to enable the viewing of full transcripts in the in-meeting side panel.","example":true}},"description":"Information about the account's closed captioning settings."},"co_host":{"type":"boolean","description":"Whether to allow the host to add co-hosts.","example":true},"custom_data_center_regions":{"type":"boolean","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.","example":true},"custom_live_streaming_service":{"type":"boolean","description":"Whether to allow custom livestreaming.","example":true},"custom_service_instructions":{"type":"string","description":"The specific instructions to configure a custom livestream.","example":"The specific instructions"},"meeting_data_transit_and_residency_method":{"type":"string","description":"Select meeting data transit and residency method for meeting hosts and participants.  \n `cloud` - Zoom Cloud.  \n `On-Prem` - On-Prem (Zoom Meeting Connector, only applicable for licensed users).","example":"On-Prem","enum":["cloud","On-Prem"],"x-enum-descriptions":["Zoom Cloud","On-Prem (Zoom Meeting Connector, only applicable for licensed users)"]},"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","example":"AU","enum":["AU","LA","CA","CN","DE","HK","IN","IE","TY","MX","NL","SG","US"]}},"disable_screen_sharing_for_host_meetings":{"type":"boolean","description":"Whether to enable the **Disable desktop screen sharing for meetings you host** setting.","example":true},"disable_screen_sharing_for_in_meeting_guests":{"type":"boolean","description":"Whether to enable the **Disable screen sharing when guests are in the meeting** setting.","example":true},"dscp_audio":{"maximum":63,"minimum":1,"type":"integer","description":"The DSCP audio marking value. This value defaults to `56`.","example":56,"default":56},"dscp_marking":{"type":"boolean","description":"Whether to enable [differentiated services code point (DSCP)](https://en.wikipedia.org/wiki/Differentiated_services) marking.","example":true},"dscp_video":{"maximum":63,"minimum":1,"type":"integer","description":"The DSCP video marking value. This value defaults to `40`.","example":40,"default":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":{"type":"boolean","description":"Whether to require [AES encryption](https://en.wikipedia.org/wiki/Advanced_Encryption_Standard) for meetings.","example":true},"entry_exit_chime":{"type":"string","description":"When to play the meeting entry or 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.","example":"all","enum":["host","all","none"]},"far_end_camera_control":{"type":"boolean","description":"Whether to allow another user to take control of the user's camera.","example":true},"feedback":{"type":"boolean","description":"Whether to enable the [**Feedback to Zoom**](https://support.zoom.us/hc/en-us/articles/115005838023-Feedback-to-Zoom) setting.","example":true},"file_transfer":{"type":"boolean","description":"Whether to enable the [**Send files via meeting chat**](https://support.zoom.us/hc/en-us/articles/209605493-In-meeting-file-transfer) setting.","example":true},"group_hd":{"type":"boolean","description":"Whether to enable group HD video in Meeting.","example":true},"webinar_group_hd":{"type":"boolean","description":"Whether to enable group HD video in Webinar.","example":true},"join_from_desktop":{"type":"boolean","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.","example":true},"join_from_mobile":{"type":"boolean","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.","example":true},"auto_generated_translation":{"type":"object","properties":{"language_item_pairList":{"type":"object","properties":{"trans_lang_config":{"type":"array","description":"The speaking language and caption language list.","items":{"type":"object","properties":{"speak_language":{"type":"object","properties":{"name":{"type":"string","description":"The input speaking language.","example":"Chinese (Simplified)","enum":["Chinese (Simplified)","Dutch","English","French","German","Italian","Japanese","Korean","Portuguese","Russian","Spanish","Ukrainian"]},"code":{"type":"string","description":"The input speaking language [code](https://developers.zoom.us/docs/api/rest/other-references/abbreviation-lists/#languages). ","example":"zh","enum":["zh","nl","en","fr","de","it","ja","ko","pt","ru","es","uk"]}},"description":"The input speaking language in meetings."},"translate_to":{"type":"object","properties":{"all":{"type":"boolean","description":"The option to select all translated output caption languages.","example":true},"language_config":{"type":"array","description":"The translated output caption language list.","items":{"type":"object","properties":{"name":{"type":"string","description":"The  translated output caption language name.","example":"English","enum":["English"]},"code":{"type":"string","description":"The translated output caption [language code](https://developers.zoom.us/docs/api/rest/other-references/abbreviation-lists/#languages).","example":"en","enum":["en"]}},"description":"The translated output caption language."}}},"description":"The translated output caption language."}},"description":"The speaking language and translated caption in meetings."}},"all":{"type":"boolean","description":"The option to select all language pairs.","example":true}},"description":"The input speaking language and output caption language pair list."},"enable":{"type":"boolean","description":"The option for participants to enable the automated translation captions in meetings.","example":true}},"description":"The [translated captions](https://support.zoom.us/hc/en-us/articles/6643133682957-Enabling-and-configuring-translated-captions) setting in meetings."},"language_interpretation":{"type":"object","properties":{"custom_languages":{"type":"array","description":"A list of user-defined supported languages.","items":{"type":"string","example":"En"}},"enable_language_interpretation_by_default":{"type":"boolean","description":"Whether to enable language interpretation by default.","example":true},"allow_participants_to_speak_in_listening_channel":{"type":"boolean","description":"Whether to allow participants to speak in the listening channel.","example":true},"allow_up_to_25_custom_languages_when_scheduling_meetings":{"type":"boolean","description":"Whether to allow up to 25 custom languages when scheduling meetings.","example":true},"enable":{"type":"boolean","description":"Whether to allow hosts to assign participants as interpreters who can interpret one language into another in real-time.","example":true}},"description":"Information about the [language interpretation](https://support.zoom.us/hc/en-us/articles/360034919791-Using-Language-Interpretation-in-your-meeting-or-webinar) settings."},"sign_language_interpretation":{"type":"object","properties":{"enable":{"type":"boolean","description":"Whether to allow hosts to assign participants as sign language interpreters who can interpret one language into another in real-time.","example":true},"enable_sign_language_interpretation_by_default":{"type":"boolean","description":"Whether to enable sign language interpretation view by default in scheduler.","example":true},"custom_languages":{"type":"array","description":"A list of user-defined supported languages.","items":{"type":"string","example":"Language1"}}},"description":"Allow hosts to assign participants as sign language interpreters who can interpret one language into sign language in real-time. Hosts can assign interpreters when scheduling, or during the meeting itself. This feature is only available with version 5.11.3 or later."},"live_streaming_facebook":{"type":"boolean","description":"Whether to allow Facebook livestreaming.","example":true},"live_streaming_youtube":{"type":"boolean","description":"Whether to allow YouTube livestreaming.","example":true},"manual_captioning":{"type":"object","properties":{"allow_to_type":{"type":"boolean","description":"Whether to allow the host to manually caption or let the host assign a participant to provide manual captioning.","example":true},"auto_generated_captions":{"type":"boolean","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).","example":true},"full_transcript":{"type":"boolean","description":"Whether to enable the viewing of full transcripts in the in-meeting side panel.","example":true},"manual_captions":{"type":"boolean","description":"Whether to [enable manual closed captioning](https://support.zoom.us/hc/en-us/articles/207279736-Managing-closed-captioning-and-live-transcription).","example":true},"save_captions":{"type":"boolean","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.","example":true},"third_party_captioning_service":{"type":"boolean","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.","example":true}},"description":"Information about manual captioning settings."},"meeting_polling":{"type":"object","properties":{"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},"allow_alternative_host_to_add_edit":{"type":"boolean","description":"Whether to allow the alternative host to add or edit polls and quizzes.","example":true},"require_answers_to_be_anonymous":{"type":"boolean","description":"Whether to require answers to be anonymous.","example":true},"manage_saved_polls_and_quizzes":{"type":"boolean","description":"Whether to allow users to manage saved polls and quizzes from meetings.","example":true},"allow_host_to_upload_image":{"type":"boolean","description":"Whether to allow host to upload an image for each question.","example":true},"enable":{"type":"boolean","description":"Whether to allow the host to add polls before or during a meeting.","example":true}},"description":"Information about the account's meeting polling settings."},"meeting_reactions":{"type":"boolean","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.","example":true},"meeting_reactions_emojis":{"type":"string","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) ","example":"all","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)."]},"allow_host_panelists_to_use_audible_clap":{"type":"boolean","description":"Whether to allow host and panelist to use audible clap.","example":true},"webinar_reactions":{"type":"boolean","description":"Set this field to true to use [webinar reactions](https://support.zoom.us/hc/en-us/articles/4803536268429).","example":true},"meeting_survey":{"type":"boolean","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.","example":true},"original_audio":{"type":"boolean","description":"Whether to allow users to select original sound in their client settings.","example":true},"p2p_connetion":{"type":"boolean","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.","example":true},"p2p_ports":{"type":"boolean","description":"Whether to enable the **Listening ports range** setting.","example":true},"polling":{"type":"boolean","description":"Whether to add polls to the meeting controls.","example":true},"ports_range":{"type":"string","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.","example":"1;65535","default":""},"post_meeting_feedback":{"type":"boolean","description":"Whether to display a thumbs up or thumbs down feedback survey at the end of each meeting.","example":true},"private_chat":{"type":"boolean","description":"Whether to [enable private chat](https://support.zoom.us/hc/en-us/articles/360060835932-Enabling-and-disabling-private-chat) between participants during meetings.","example":true},"record_play_own_voice":{"type":"boolean","description":"Whether to let the user record and play their own voice.","example":true},"remote_control":{"type":"boolean","description":"Whether to enable the [**Remote control**](https://support.zoom.us/hc/en-us/articles/201362673-Requesting-or-giving-remote-control) setting.","example":true},"non_verbal_feedback":{"type":"boolean","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`.","example":true,"default":false},"remote_support":{"type":"boolean","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`.","example":true,"default":false},"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":{"type":"boolean","description":"Whether to allow hosts and participants to share their screen or content during meetings.","example":true},"sending_default_email_invites":{"type":"boolean","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.","example":true},"show_a_join_from_your_browser_link":{"type":"boolean","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.","example":true},"show_meeting_control_toolbar":{"type":"boolean","description":"Whether to display the in-meeting control toolbar.","example":true},"slide_control":{"type":"boolean","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.","example":true},"stereo_audio":{"type":"boolean","description":"Whether to allow users to select stereo audio in their client settings.","example":true},"use_html_format_email":{"type":"boolean","description":"Whether to enable the use of HTML-formatted emails for the Outlook plugin.","example":true},"virtual_background":{"type":"boolean","description":"Whether to enable Virtual Backgrounds.","example":true},"virtual_background_settings":{"type":"object","properties":{"allow_upload_custom":{"type":"boolean","description":"Whether to allow user to upload custom Virtual Backgrounds.","example":true},"allow_videos":{"type":"boolean","description":"Whether to allow the use of videos for Virtual Backgrounds.","example":true},"enable":{"type":"boolean","description":"Whether to enable Virtual Backgrounds.","example":true},"files":{"type":"array","description":"Information about the Virtual Background files.","items":{"type":"object","properties":{"id":{"type":"string","description":"The Virtual Background file's ID.","example":"JCvkdgDeTwCOf82SjI8QZw"},"is_default":{"type":"boolean","description":"Whether the file is the default Virtual Background file.","example":true},"name":{"type":"string","description":"The Virtual Background file's name.","example":"test.png"},"size":{"type":"integer","description":"The Virtual Background file's size, in bytes.","example":41519},"type":{"type":"string","description":"The Virtual Background file's type.","example":"image"}}}}},"description":"The account's Virtual Background settings."},"watermark":{"type":"boolean","description":"Whether to include a [watermark](https://support.zoom.us/hc/en-us/articles/209605273-Adding-an-image-watermark) when viewing a shared screen.","example":true},"webinar_chat":{"type":"object","properties":{"allow_attendees_chat_with":{"type":"integer","description":"Who to let webinar attendees chat with. \n* `1` - No one. \n* `2` - Host and all panelists. \n* `3` - Everyone.","example":2,"enum":[1,2,3]},"allow_auto_save_local_chat_file":{"type":"boolean","description":"Whether to automatically save chat messages to a local file on the host's computer when the webinar ends.","example":true},"allow_panelists_chat_with":{"type":"integer","description":"Who to let webinar panelists chat with. \n* `1` - Host and all panelists. \n* `2` - Everyone.","example":2,"enum":[1,2]},"allow_panelists_send_direct_message":{"type":"boolean","description":"Whether to allow webinar panelists to send direct messages to other panelists.","example":true},"allow_users_save_chats":{"type":"integer","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.","example":2,"enum":[0,1,2]},"default_attendees_chat_with":{"type":"integer","description":"By default, allow webinar attendees to chat with: \n* `1` - Host and all panelists. \n* `2` - Everyone.","example":1,"enum":[1,2]},"enable":{"type":"boolean","description":"Whether to allow webinar participants to send chat messages.","example":true}},"description":"Information about the account's webinar chat settings."},"webinar_live_streaming":{"type":"object","properties":{"custom_service_instructions":{"type":"string","description":"The specific instructions to allow the account's meeting hosts to configure a custom livestream.","example":"The specific instructions"},"enable":{"type":"boolean","description":"Whether to enable webinar livestreaming.","example":true},"live_streaming_reminder":{"type":"boolean","description":"Whether to notify users to watch the livestream. This does not apply to custom RTMP (real-time messaging protocol).","example":true},"live_streaming_service":{"type":"array","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":{"type":"string","example":"facebook","enum":["facebook","workplace_by_facebook","youtube","custom_live_streaming_service"]}}}},"webinar_polling":{"type":"object","properties":{"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},"allow_alternative_host_to_add_edit":{"type":"boolean","description":"Whether to allow the alternative host to add or edit polls and quizzes.","example":true},"require_answers_to_be_anonymous":{"type":"boolean","description":"Whether to require answers to be anonymous.","example":true},"manage_saved_polls_and_quizzes":{"type":"boolean","description":"Whether to allow users to manage saved polls and quizzes from Webinars","example":true},"allow_host_to_upload_image":{"type":"boolean","description":"Whether to allow host to upload an image for each question.","example":true},"enable":{"type":"boolean","description":"Whether to allow the host to add polls before or during a webinar.","example":true}},"description":"Information about the account's webinar polling settings."},"webinar_question_answer":{"type":"boolean","description":"Whether attendees can ask the host and panelists questions in the webinar.","example":true},"webinar_survey":{"type":"boolean","description":"Whether to allow the host to present surveys to attendees once a webinar has ended.","example":true},"whiteboard":{"type":"boolean","description":"Whether to enable the [**Zoom Whiteboard**](https://support.zoom.us/hc/en-us/articles/4410916881421) feature.","example":true},"who_can_share_screen":{"type":"string","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.","example":"all","enum":["host","all"]},"who_can_share_screen_when_someone_is_sharing":{"type":"string","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.","example":"host","enum":["host","all"]},"participants_share_simultaneously":{"type":"string","description":"Indicates how many participants can share at the same time. The value can be one of the following:  \n \n`one`: Only one participant can share at a time\n.  \n \n`multiple`: Multiple participants can share simultaneously (dual monitors recommended).","example":"multiple","enum":["multiple","one"]},"workplace_by_facebook":{"type":"boolean","description":"Whether to allow Workplace by Facebook livestreaming.","example":true},"transfer_meetings_between_devices":{"type":"boolean","description":"Users can move to a new device without leaving the meeting they're in.","example":true}},"description":"In Meeting Account Settings"},"integration":{"type":"object","properties":{"box":{"type":"boolean","description":"Whether to allow users who join a meeting from their mobile device to share content from their Box account.","example":true},"dropbox":{"type":"boolean","description":"Whether to allow users who join a meeting from their mobile device to share content from their Dropbox account.","example":true},"google_calendar":{"type":"boolean","description":"Whether to enable the scheduling of meetings using Google Calendar.","example":true},"google_drive":{"type":"boolean","description":"Whether to allow users who join a meeting from their mobile device to share content from their Google Drive.","example":true},"kubi":{"type":"boolean","description":"Whether to allow users to control a connected Kubi device from within a Zoom meeting.","example":true},"microsoft_one_drive":{"type":"boolean","description":"Whether to allow users who join a meeting from their mobile device to share content from their Microsoft OneDrive account.","example":true}},"description":"Account Integration Settings"},"other_options":{"type":"object","properties":{"allow_auto_active_users":{"type":"boolean","description":"If true, administrators can activate users with a single default passcode when adding users. This activates added users immediately without waiting for them to set their own passcode.","example":true},"allow_users_contact_support_via_chat":{"type":"boolean","description":"If true, displays the Zoom Help badge on the bottom-right of the page.","example":true},"allow_users_enter_and_share_pronouns":{"type":"boolean","description":"If true, users can add pronouns to their profile cards and share them during meetings and webinars.","example":true},"blur_snapshot":{"type":"boolean","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.","example":true},"display_meetings_scheduled_for_others":{"type":"boolean","description":"If true, a user with [scheduling privileges](https://support.zoom.us/hc/en-us/articles/201362803-Scheduling-privilege) can view other users' meetings.","example":true},"meeting_qos_and_mos":{"type":"integer","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` - Display the meeting quality score and network alerts on the dashboard and use custom thresholds for quality scores and network alerts.","example":0,"enum":[0,1,2,3],"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."]},"show_one_user_meeting_on_dashboard":{"type":"boolean","description":"If true, meetings with only one person will display on the dashboard and in reports.","example":true},"use_cdn":{"type":"string","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.","example":"none","enum":["none","default","wangsu"],"x-enum-descriptions":["Do not 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 will use the Wangsu CDN (China)."]},"webinar_registration_options":{"type":"object","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}},"description":"Webinar registration options."},"email_in_attendee_report_for_meeting":{"type":"boolean","description":"If true, include authenticated guests' email addresses in attendee reports for meetings.","example":true}}},"profile":{"title":"Profile","type":"object","properties":{"recording_storage_location":{"type":"object","properties":{"allowed_values":{"type":"array","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://developers.zoom.us/docs/api/rest/other-references/abbreviation-lists/#countries) for details.","example":["US","AU","CA","DE","JP","BR","SG","IN"],"items":{"type":"string","example":"US"}},"value":{"type":"string","description":"Abbreviated country code.","example":"US"}}}}},"recording":{"type":"object","properties":{"account_user_access_recording":{"type":"boolean","description":"Cloud recordings are only accessible to account members. People outside of your organization cannot open links that provide access to cloud recordings.","example":true},"allow_recovery_deleted_cloud_recordings":{"type":"boolean","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. ","example":true},"archive":{"type":"object","properties":{"enable":{"type":"boolean","description":"Enable the archiving feature.","example":true},"settings":{"type":"object","properties":{"audio_file":{"type":"boolean","description":"Include in-meeting and/or in-webinar audio in the archive.","example":true},"cc_transcript_file":{"type":"boolean","description":"Include closed caption or transcript in the archive.","example":true},"chat_file":{"type":"boolean","description":"Include in-meeting chat in the archive.","example":true},"chat_with_sender_email":{"type":"boolean","description":"Include user email in in-meeting chat file.","example":true},"video_file":{"type":"boolean","description":"Include in-meeting and/or in-webinar video in the archive.","example":true},"chat_with_direct_message":{"type":"boolean","description":"Include direct message in in-meeting chat file.","example":true},"archive_retention":{"type":"integer","description":"The retention period for archiving content, in days.","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":{"type":"integer","description":"Perform the action when meetings or webinars cannot be archived.  \n `1` - Participants can stay in the meeting and will receive a notification.  \n `2` - Nobody can join or stay in the meeting.","example":1,"enum":[1,2]},"notification_when_archiving_starts":{"type":"string","description":"Show notification when video or audio archiving starts.  \n `1` - Participants can stay in the meeting and will receive a notification.  \n `2` - Nobody can join or stay in the meeting.","example":"participants","enum":["participants","guest"]},"play_voice_prompt_when_archiving_starts":{"type":"string","description":"Play voice prompt when video or audio archiving starts.  \n `1` - Participants can stay in the meeting and will receive a notification.  \n `2` - Nobody can join or stay in the meeting.","example":"guest","enum":["participants","guest","none"]}}},"type":{"type":"integer","description":"Archive types.\n\n* `1`: Only meetings are archived.  \n \n* `2`: Only webinars are archived.  \n \n* `3`: Both meetings and webinars are archived.","example":2,"enum":[1,2,3]}},"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."},"auto_delete_cmr":{"type":"boolean","description":"Allow Zoom to permanently delete recordings automatically after a specified number of days.","example":true},"auto_delete_cmr_days":{"type":"integer","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.","example":90,"enum":[30,60,90,120],"x-enum-descriptions":["30 days.","60 days.","90 days.","120 days."]},"auto_recording":{"type":"string","description":"Automatic recording:  \n `local` - Record on local.  \n `cloud` -  Record on cloud.  \n `none` - Disabled.","example":"cloud","enum":["local","cloud","none"],"x-enum-descriptions":["Record on local","Record on cloud","Disabled"]},"cloud_recording":{"type":"boolean","description":"Allow hosts to record and save the meeting in the cloud.","example":true},"cloud_recording_download":{"type":"boolean","description":"Cloud recording downloads.","example":true},"cloud_recording_download_host":{"type":"boolean","description":"Only the host can download cloud recordings.","example":true},"display_participant_name":{"type":"boolean","description":"Whether to display participants' names in the recording.","example":true},"host_delete_cloud_recording":{"type":"boolean","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","example":true},"ip_address_access_control":{"type":"object","properties":{"enable":{"type":"boolean","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","example":true},"ip_addresses_or_ranges":{"type":"string","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","example":"46.33.24.184"}},"description":"Setting to allow cloud recording access only from specific IP address ranges.\n"},"local_recording":{"type":"boolean","description":"Allow hosts and participants to record the meeting using a local file.","example":true},"local_recording_options":{"type":"object","properties":{"internal_meeting_participants":{"type":"boolean","description":"Internal meeting participants","example":true},"internal_auto_approve_requests":{"type":"boolean","description":"Auto approve their permission requests","example":true},"external_meeting_participants":{"type":"boolean","description":"External meeting participants","example":true},"external_auto_approve_requests":{"type":"boolean","description":"Auto approve their permission requests","example":true},"participants_with_specified_domains":{"type":"boolean","description":" Meeting participants with specified domains","example":true},"participants_specified_domains_auto_approve_requests":{"type":"string","description":"Participants matching this option will take the precedence regardless the above two options.","example":"zoom.us"},"save_chat_messages":{"type":"boolean","description":"Save chat messages from the meeting / webinar","example":true},"save_closed_caption":{"type":"boolean","description":"Save closed caption as a VTT file","example":true}},"description":"local recording child options"},"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},"prevent_host_access_recording":{"type":"boolean","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","example":true},"record_audio_file":{"type":"boolean","description":"Whether to record one audio file for all participants.","example":true},"record_audio_file_each_participant":{"type":"boolean","description":"Whether to record a separate audio file for each participant. This only supports a maximum of 200 participants' audio files.","example":true},"record_files_separately":{"type":"object","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}},"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."},"record_gallery_view":{"type":"boolean","description":"Record the gallery view with a shared screen.","example":true},"record_speaker_view":{"type":"boolean","description":"Record the active speaker with a shared screen.","example":true},"recording_audio_transcript":{"type":"boolean","description":"Automatically transcribe the audio of the meeting or webinar to the cloud.","example":true},"recording_disclaimer":{"type":"boolean","description":"Show a disclaimer to participants before a recording starts\nThis field has been deprecated. The replacement field is recording_notification_for_zoom_client","example":true,"deprecated":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},"smart_recording":{"type":"object","properties":{"create_recording_highlights":{"type":"boolean","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.","example":true},"create_smart_chapters":{"type":"boolean","description":"By selecting this option, your recording will have chapters with overview. Hosts can edit the chapters.","example":true},"create_next_steps":{"type":"boolean","description":"By selecting this option, there will be a summary of actions to take after the recorded meeting.","example":true}},"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."},"recording_password_requirement":{"type":"object","properties":{"have_letter":{"type":"boolean","description":"Indicates whether or not passcode must contain at least one alphabetical letter (a, b, c..).","example":true},"have_number":{"type":"boolean","description":"Indicates whether or not passcode must contain at least one number(1, 2, 3..).","example":true},"have_special_character":{"type":"boolean","description":"Indicates whether or not passcode must contain at least one special character(!, @, #..).","example":true},"length":{"maximum":10,"type":"integer","description":"Minimum required length for the passcode.","example":10},"only_allow_numeric":{"type":"boolean","description":"Indicates whether or not passcode must contain only numeric characters.","example":true}},"description":"This object represents the minimum passcode requirements set for recordings via Account Recording Settings."},"recording_thumbnails":{"type":"boolean","description":"Whether to record thumbnails of the presenter when they are sharing their screen.","example":true},"required_password_for_existing_cloud_recordings":{"type":"boolean","description":"Require a passcode to access existing cloud recordings.","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":{"type":"boolean","description":"Save the chat text from the meeting.","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},"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},"show_timestamp":{"type":"boolean","description":"Add a timestamp to the recording.","example":true},"recording_notification_for_zoom_client":{"type":"object","properties":{"disclaimer_to_participants":{"type":"string","description":"Update child setting name is [Show a disclaimer to participants when a recording starts]. The value is feature name, its includes \"All participants\" or \"Guest only\".","example":"All participants","enum":["All participants","Guest only"]},"play_voice_prompt":{"type":"string","description":"Update child setting name is [Play voice prompt for]. The value is feature name, its includes \"All participants\" or \"Guest only\" or \"No one\"","example":"All participants","enum":["All participants","Guest only","No one"]},"ask_host_to_confirm":{"type":"boolean","description":"Update Child setting name is [Ask host to confirm before starting a recording], true: enable, false: disable","example":true}},"description":"Setting name: Recording notifications - Zoom clients"},"viewer_see_transcript":{"type":"boolean","description":"Viewers can see the transcript","example":true},"viewer_see_chat":{"type":"boolean","description":"Viewers see chat","example":true},"allow_cmr_3rd_party_bot":{"type":"boolean","description":"Allow 3rd-party recording","example":true},"upload_custom_caption":{"type":"boolean","description":"Allow host to upload custom caption","example":true},"upload_recording":{"type":"boolean","description":"Upload recording to the cloud","example":true},"water_marker_recording":{"type":"boolean","description":"add water marker for recording","example":true},"durable_meeting_transcript":{"type":"object","properties":{"durable_meeting_transcript":{"type":"boolean","description":"Main setting value","example":true},"allow_host_access_meeting_transcript":{"type":"boolean","description":"Allow hosts to access and manage transcripts","example":true}},"description":"Allow users to retain, access,and manage transcripts generated by AI Companion features for use by other AI Companion services."},"allow_share":{"type":"boolean","description":"Allow cloud recording sharing","example":true},"authenticated_view_cloud_recoding":{"type":"object","properties":{"authenticated_can_view_cloud_recordings":{"type":"boolean","description":"Main setting value","example":true},"default_authenticate_content":{"type":"string","description":"Default authentication option","example":"Signed-in users in my account","enum":["Signed-in users in my account","Sign in to Zoom","Sign in to Zoom with specified domains","Sign in to external Single Sign-On (SSO)","Only people with access"]}},"description":"Require users to authenticate before viewing cloud recordings"},"embed_passcode_in_shareable_link":{"type":"boolean","description":"Embed passcode in the shareable link for one-click access","example":true},"allow_invitees_access_recordings_without_passcode":{"type":"boolean","description":"Allow invitees to access recordings without the passcode","example":true},"recording_as_on_demand":{"type":"boolean","description":"Set recording as on-demand by default","example":true},"notification_subscription_url_when_recording_available":{"type":"boolean","description":"Push notification to subscription URL when a cloud recording is available","example":true},"recording_notifications_phone_users":{"type":"object","properties":{"require_press_one_consent_to_record":{"type":"boolean","description":"Require phone-only users to press 1 to consent to being recorded","example":true},"multiple_notifications_phone_users":{"type":"boolean","description":"Multiple notifications for phone users","example":true}},"description":"Recording notifications - Phone users"},"cloud_recording_permanently_deleted":{"type":"object","properties":{"cloud_recording_permanently_deleted_from_trash":{"type":"boolean","description":"Main setting value","example":true},"email_reminder_type":{"type":"string","description":"Selected email reminder","example":"Weekly digest on Monday","enum":["7 days before deletion","Weekly digest on Monday"]}},"description":"When the cloud recording is going to be permanently deleted from trash"},"recording_storage_email_notifications":{"type":"boolean","description":"Recording storage email notifications","example":true},"allow_add_cloud_recordings_to_zoom_clips":{"type":"boolean","description":"Allow users to add cloud recordings to Zoom Clips","example":true},"allow_revenue_accelerator_manage_recording_separate_auto_delete":{"type":"boolean","description":"Allow Zoom Revenue Accelerator to manage recording files with separate auto-delete settings","example":true}},"description":"Account Settings: Recording."},"schedule_meeting":{"type":"object","properties":{"audio_type":{"type":"string","description":"Determine how participants can join the audio portion of the meeting.  \n `both` - Telephony and VoIP.  \n `telephony` - Audio PSTN telephony only.  \n `voip` - VoIP only.  \n `thirdParty` - 3rd party audio conference.","example":"both","default":"both","enum":["both","telephony","voip","thirdParty"],"x-enum-descriptions":["Telephony and VoIP","Audio PSTN telephony only","VoIP only","3rd party audio conference"]},"enforce_login":{"type":"boolean","description":"Only Zoom users who are signed in can join meetings.","example":true},"enforce_login_domains":{"type":"string","description":"Only signed in users with a specified domain can join the meeting. ","example":"example.com"},"enforce_login_with_domains":{"type":"boolean","description":"Only signed in users with a specific domain can join meetings.","example":true},"force_pmi_jbh_password":{"type":"boolean","description":"Require a passcode for Personal Meetings if attendees can join before host.","example":true},"host_video":{"type":"boolean","description":"Start meetings with the host video on.","example":true},"enable_dedicated_group_chat":{"type":"boolean","description":"Enable dedicated group chats for meeting conversations.","example":true},"jbh_time":{"type":"integer","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.\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.","example":10,"enum":[0,5,10,15]},"join_before_host":{"type":"boolean","description":"Allow participants to join the meeting before the host arrives.","example":true},"meeting_password_requirement":{"type":"object","properties":{"consecutive_characters_length":{"type":"integer","description":"\nSpecify the max length of consecutive characters(abcde...) that can be used in a passcode.\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 passcode.\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 passcode(example: abc1x@8fdh).","example":5,"enum":[0,4,5,6,7,8]},"have_letter":{"type":"boolean","description":"If set to `true`, the passcode must contain at least 1 letter (such as a,b,c...).\n","example":true},"have_number":{"type":"boolean","description":"If set to `true`, the passcode must contain at least 1 number (such as 1,2,3...).","example":true},"have_special_character":{"type":"boolean","description":"If set to `true`, the passcode must have at least 1 special character (!,@,#...).","example":true},"have_upper_and_lower_characters":{"type":"boolean","description":"If set to `true`, the passcode must include both uppercase and lowercase characters.","example":true},"length":{"type":"integer","description":"The minimum length that the meeting or webinar passcode must have.","example":10},"only_allow_numeric":{"type":"boolean","description":"If set to `true`, the passcode must only contain numbers and no other characters.","example":true},"weak_enhance_detection":{"type":"boolean","description":"If set to `true`, users will be informed if the provided passcode is weak.","example":true}},"description":"Account wide meeting or webinar [passcode requirements](https://support.zoom.us/hc/en-us/articles/360033559832-Meeting-and-webinar-passwords#h_a427384b-e383-4f80-864d-794bf0a37604)."},"not_store_meeting_topic":{"type":"boolean","description":"Always display **Zoom Meeting** as the meeting topic.","example":true},"participant_video":{"type":"boolean","description":"Start meetings with the participant video on. Participants can change this setting during the meeting.","example":true},"allow_host_to_disable_participant_video":{"type":"boolean","description":"Allow host to disable participant video when scheduling a meeting.","example":true},"personal_meeting":{"type":"boolean","description":"Personal meeting setting.  \n\n\n`true`: Indicates that the **Enable Personal Meeting ID** setting is turned on. Users can choose to use personal meeting ID for their meetings.   \n   \n \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","example":true},"require_password_for_instant_meetings":{"type":"boolean","description":"Require a passcode 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","example":true},"require_password_for_pmi_meetings":{"type":"string","description":"Require a passcode 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","example":"none","enum":["jbh_only","all","none"],"x-enum-descriptions":["Only meetings with Join Before Host enabled","All meetings using a PMI","Disabled"]},"require_password_for_scheduled_meetings":{"type":"boolean","description":"Require a passcode for meetings which have already been scheduled.\n","example":true},"require_password_for_scheduling_new_meetings":{"type":"boolean","description":"Require a passcode when scheduling new meetings. This setting applies for regular meetings that do not use a PMI. If enabled, a passcode will be generated while a host schedules a new meeting and participants will be required to enter the passcode 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.","example":true},"use_pmi_for_instant_meetings":{"type":"boolean","description":"Use a Personal Meeting ID (PMI) when starting an instant meeting.","example":true},"use_pmi_for_scheduled_meetings":{"type":"boolean","description":"Use a Personal Meeting ID (PMI) when scheduling a meeting.","example":true},"always_display_zoom_meeting_as_topic":{"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}},"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."},"hide_meeting_description":{"type":"object","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}},"description":"Information about the **Hide meeting description** feature."},"always_display_zoom_webinar_as_topic":{"type":"object","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}},"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."},"hide_webinar_description":{"type":"object","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}},"description":"Information about the **Hide webinar description** feature."},"meeting_template":{"type":"object","properties":{"enable":{"type":"boolean","description":"Whether to enable the **Meeting Templates** setting.","example":true},"action":{"type":"string","description":"Specify the action that you would like to take via this API request:  \n * `update`: Choose this value if you are updating an existing meeting template enable.\n* `delete`: Choose this value if you are deleting an existing meeting template.","example":"delete"},"templates":{"type":"array","description":"Information about the defined **Meeting Templates** policies.","items":{"type":"object","properties":{"id":{"type":"string","description":"The meeting template ID.","example":"ydCUQzzVT6WZ_r_K_2iFzg"},"enable":{"type":"boolean","description":"Whether to enable the meeting template.","example":true}},"example":{"id":"ydCUQzzVT6WZ_r_K_2iFzg","enable":true}}}},"description":"Information about the **Meeting Templates** feature."},"continuous_meeting_chat":{"type":"object","properties":{"enable":{"type":"boolean","description":"Whether to enable the **Enable continuous meeting chat** setting.","example":true},"can_add_external_users":{"type":"boolean","description":"Whether to enable the **External users can be added** setting.","example":true},"auto_add_invited_external_users":{"type":"boolean","description":"Whether to enable the **Automatically add invited external users** setting.","example":true}},"description":"Information about the **Enable continuous meeting chat** feature."}},"description":"Account Settings: Schedule Meeting."},"telephony":{"type":"object","properties":{"audio_conference_info":{"type":"string","description":"Third party audio conference info.","example":"test"},"telephony_regions":{"type":"object","properties":{"selection_values":{"type":"string","description":"The account's selected telephony regions that indicate where most participants call into or call from during a meeting.","example":"USTB"}},"description":"Indicates where most of the participants call into or call from during a meeting.","example":["CNTB","USTB"]},"third_party_audio":{"type":"boolean","description":"Users can join the meeting using the existing third party audio configuration.","example":true}},"description":"Account Settings Update: Telephony."},"tsp":{"type":"object","properties":{"call_out":{"type":"boolean","description":"Call Out","example":true},"call_out_countries":{"type":"array","description":"Call Out Countries/Regions","example":["us"],"items":{"type":"string","example":"us"}},"allow_webinar_attendees_call_me":{"type":"boolean","description":"Whether webinar attendees can use Call Me to connect audio. This feature is only available in version 5.2.2 and higher.","example":true},"display_toll_free_numbers":{"type":"boolean","description":"Display toll-free numbers","example":true},"allow_webinar_attendees_toll_free_dial":{"type":"boolean","description":"Whether webinar attendees can dial in through the account's **Toll-free** phone numbers. This feature is only available with version 5.2.2 or later.","example":true},"show_international_numbers_link":{"type":"boolean","description":"Show international numbers link on the invitation email","example":true},"global_dial_in_countries":{"type":"object","properties":{"selected_countries":{"type":"array","description":"The list of selected countries/regions whose dial-in numbers will be listed in the email invitation. You can adjust the order that the dial-in numbers appear in the email invitation.","items":{"type":"object","properties":{"code":{"type":"string","description":"The code of the country or region.","example":"CN"}}}}},"description":"The account's **Global Dial-in Countries/Regions** settings."}},"description":"Account Settings: TSP."},"zoom_rooms":{"type":"object","properties":{"auto_start_stop_scheduled_meetings":{"type":"boolean","description":"Automatic start and stop for scheduled meetings.","example":true},"cmr_for_instant_meeting":{"type":"boolean","description":"Cloud recording for instant meetings.","example":true},"force_private_meeting":{"type":"boolean","description":"Shift all meetings to private.","example":true},"hide_host_information":{"type":"boolean","description":"Hide host and meeting ID from private meetings.","example":true},"list_meetings_with_calendar":{"type":"boolean","description":"Display meeting list with calendar integration.","example":true},"start_airplay_manually":{"type":"boolean","description":"Start AirPlay service manually.","example":true},"ultrasonic":{"type":"boolean","description":"Automatic direct sharing using an ultrasonic proximity signal.","example":true},"upcoming_meeting_alert":{"type":"boolean","description":"Upcoming meeting alert.","example":true},"weekly_system_restart":{"type":"boolean","description":"Weekly system restart.","example":true},"zr_post_meeting_feedback":{"type":"boolean","description":"Zoom Room post meeting feedback.","example":true}},"description":"Account Settings: Zoom Rooms."},"general_setting":{"title":"General settings.","type":"object","properties":{"auto_zoom_room_proximity_connect":{"type":"boolean","description":"Allow automatic direct sharing and connecting to Zoom Rooms using ultrasonic proximity signal.","example":true},"show_zoom_room_feature":{"type":"boolean","description":"Show \"Zoom Room\" feature in the Zoom Workplace app.","example":true}},"description":"General settings."},"mail_calendar":{"type":"object","properties":{"email_calendar_management":{"type":"boolean","description":"Allow the Zoom client to manage both emails and calendar events for the user.","example":true},"email_management":{"type":"boolean","description":"Allow the Zoom client to manage user emails.","example":true},"zoom_email_provider":{"type":"boolean","description":"Allow users to select Zoom as their email service provider.","example":true}},"description":"Email and calendar related settings."},"ai":{"type":"object","properties":{"screen_share_ocr":{"type":"boolean","description":"Whether screen share content is used with OCR.","example":true},"meeting_chat_messages":{"type":"boolean","description":"Whether meeting chat messages are used to enhance transcripts.","example":true},"full_display_names_in_ai_assets":{"type":"boolean","description":"Whether AI-generated meeting assets use full display names.","example":true},"ai_generated_virtual_backgrounds":{"type":"boolean","description":"Whether AI-generated virtual backgrounds are enabled.","example":true},"meeting_agenda":{"type":"boolean","description":"Whether Meeting Agenda with AI is enabled.","example":true},"meeting_summary_docs":{"type":"object","properties":{"enable":{"type":"boolean","description":"Whether automatic Zoom Doc creation is enabled.","example":true},"share_with_summary_recipients":{"type":"boolean","description":"Whether generated Zoom Docs are shared with meeting summary recipients.","example":true}},"description":"Automatic Zoom Doc creation from meeting summary."},"phone_user_ai_notices":{"type":"object","properties":{"enable":{"type":"boolean","description":"Whether phone user AI notices are enabled.","example":true},"require_press_1_consent":{"type":"boolean","description":"Whether callers must press 1 to consent.","example":true},"multiple_notifications":{"type":"boolean","description":"Whether multiple notifications are allowed.","example":true}},"description":"Phone user AI notices."},"meeting_summary_retention":{"type":"object","properties":{"enable":{"type":"boolean","description":"Whether automatic meeting summary deletion is enabled.","example":true},"retention_days":{"maximum":9999,"minimum":1,"type":"integer","description":"Number of days to retain meeting summaries before deletion.","example":30}},"description":"Automatic meeting summary deletion."},"meeting_summary_personal_data_redaction":{"type":"object","properties":{"enable":{"type":"boolean","description":"Whether personal data redaction is enabled.","example":true},"personal_data_types":{"type":"array","description":"Personal data types to redact.","example":["NAME","EMAIL"],"items":{"type":"string","enum":["ADDRESS","AGE","CREDIT_DEBIT_CVV","CREDIT_DEBIT_EXPIRY","CREDIT_DEBIT_NUMBER","DATE_TIME","DRIVER_ID","EMAIL","INTERNATIONAL_BANK_ACCOUNT_NUMBER","IP_ADDRESS","LICENSE_PLATE","MAC_ADDRESS","NAME","PASSWORD","PHONE","PIN","SWIFT_CODE","URL","USERNAME","VEHICLE_IDENTIFICATION_NUMBER","BANK_ACCOUNT_NUMBER","BANK_ROUTING","PASSPORT_NUMBER","US_INDIVIDUAL_TAX_IDENTIFICATION_NUMBER","SSN"]}}},"description":"Personal data redaction for meeting summaries."},"meeting_summary_sensitive_data_filter":{"type":"object","properties":{"enable":{"type":"boolean","description":"Whether the sensitive data filter is enabled.","example":true},"rules":{"type":"array","description":"Sensitive data filter rules.","items":{"type":"object","properties":{"name":{"type":"string","description":"Rule display name.","example":"Employee ID"},"regular_expression":{"type":"string","description":"RE2J regular expression.","example":"[0-9]{6}"}}}}},"description":"Sensitive data filter for meeting summaries."},"meeting_coach":{"type":"object","properties":{"enable":{"type":"boolean","description":"Whether Meeting Coach with AI is enabled.","example":true},"participant_scope":{"type":"string","description":"Which participants Meeting Coach applies to.","example":"participants_and_invitees_in_our_organization","enum":["all_participants_and_invitees","participants_and_invitees_in_our_organization"]}},"description":"Meeting Coach with AI."},"third_party_meeting_join":{"type":"object","properties":{"enable":{"type":"boolean","description":"Whether third-party meeting join with AI is enabled.","example":true},"allow_recording":{"type":"boolean","description":"Whether recording is enabled for joined third-party meetings.","example":true},"calendar":{"type":"object","properties":{"enable":{"type":"boolean","description":"Whether calendar-based third-party meeting join is enabled.","example":true},"join_scope":{"type":"string","description":"Which calendar events third-party meeting join applies to.","example":"all_events_with_video_conference_links","enum":["all_events_with_video_conference_links","meetings_where_i_am_the_host","meetings_where_i_am_a_participant"]}},"description":"Calendar-based third-party meeting join."},"pre_meeting_email_notification":{"type":"object","properties":{"enable":{"type":"boolean","description":"Whether pre-meeting email notification is enabled.","example":true},"recipients":{"type":"string","description":"Who receives the pre-meeting email notification.","example":"all_invitees","enum":["all_invitees","only_meeting_host"]}},"description":"Pre-meeting email notification."}},"description":"Third-party meeting join with AI."},"whiteboard_content_generation":{"type":"boolean","description":"Whether Whiteboard content generation with AI is enabled.","example":true},"smart_recording":{"type":"object","properties":{"create_recording_highlights":{"type":"boolean","description":"Recording highlights","example":true},"create_smart_chapters":{"type":"boolean","description":"Summary and smart chapters","example":true},"create_next_steps":{"type":"boolean","description":"Next steps","example":true}},"description":"Smart Recording"},"clips_summarization_generation":{"type":"object","properties":{"enable":{"type":"boolean","description":"Whether summarization generation is enabled.","example":true},"general_summary":{"type":"boolean","description":"Whether summary generation is enabled.","example":true},"generation_chapter":{"type":"boolean","description":"Whether chapter generation is enabled.","example":true}},"description":"setting for clip summarization generation"},"clips_create_video_with_aic":{"type":"object","properties":{"enable":{"type":"boolean","description":"Whether clips create video with aic is enabled.","example":true},"show_clips_with_avatar":{"type":"boolean","description":"Whether show clips with avatar","example":true}},"description":"setting for clip create video with aic"},"allow_user_create_customize_avatar":{"type":"object","properties":{"enable":{"type":"boolean","description":"Whether clips allow user create customize avatar is enabled.","example":true},"clips_custom_avatar_delegation":{"type":"boolean","description":"Whether custom avatar delegation is enabled","example":true}},"description":"setting for clip allow user create customize avatar"},"task_creation_and_management":{"type":"object","properties":{"enable":{"type":"boolean","description":"Whether AI-powered task creation and management is enabled.","example":false},"auto_generate_details":{"type":"boolean","description":"Whether to automatically generate task details.","example":false},"auto_generate_action":{"type":"boolean","description":"Whether to automatically generate action items from tasks.","example":true},"generate_from_transcripts":{"type":"object","properties":{"enable":{"type":"boolean","description":"Whether to allow generating tasks from meeting transcripts.","example":false},"auto_share_with":{"type":"string","description":"Defines who tasks are automatically shared with when generated from transcripts.","example":"internal_participants","enum":["host_only","internal_participants","internal_assigned_participants"],"x-enum-descriptions":["Share tasks with meeting host only","Share tasks with all internal meeting participants","Share tasks with internal participants who are assigned"]},"auto_assign_to_collaborator":{"type":"boolean","description":"Whether to automatically assign tasks to collaborators.","example":true}},"description":"Settings for generating tasks from meeting transcripts."},"generate_from_phone_call":{"type":"object","properties":{"enable":{"type":"boolean","description":"Whether to allow generating tasks from phone calls.","example":false},"auto_add_participant_as_collaborator":{"type":"boolean","description":"Whether to automatically add phone call participants as task collaborators.","example":true},"auto_assign_to_collaborator":{"type":"boolean","description":"Whether to automatically assign phone call tasks to collaborators.","example":true}},"description":"Settings for generating tasks from phone calls."},"generate_from_voicemail":{"type":"boolean","description":"Whether to allow generating tasks from voicemail.","example":false}},"description":"AI-powered task creation and management with AI Companion."},"show_conversational_ai_companion":{"type":"object","properties":{"enabled":{"type":"boolean","description":"Whether conversational AI is enabled.","example":true},"enable_zoom_mate":{"type":"boolean","description":"Whether ZoomMate is available in the web navigation and Zoom Workplace app navigation bar.","example":true},"delete_ai_conversation":{"type":"boolean","description":"Whether to automatically delete AI conversation history.","example":true},"delete_ai_conversation_time":{"type":"integer","description":"The number of days after which AI conversation history is automatically deleted. Supported values are 30, 60, 90, and 120.","nullable":true,"example":30,"enum":[30,60,90,120]}},"description":"Show conversational AI companion settings."},"ai_panel_in_workplace":{"type":"object","properties":{"enabled":{"type":"boolean","description":"Whether the AI panel in Zoom Workplace is enabled.","example":true},"delete_ai_conversation":{"type":"boolean","description":"Whether to automatically delete AI conversation history in the AI panel.","example":true},"delete_ai_conversation_time":{"type":"integer","description":"The number of days after which AI conversation history in the AI panel is automatically deleted. Supported values are 30, 60, 90, and 120.","nullable":true,"example":30,"enum":[30,60,90,120]}},"description":"AI panel in Zoom Workplace settings."},"enable_ai_on_web":{"type":"boolean","description":"Whether Zoom AI on the web is enabled.","example":true},"enable_email_compose_with_ai":{"type":"boolean","description":"Whether users can use AI to compose or wordsmith email responses in Zoom Mail.","example":true},"microsoft_365":{"type":"object","properties":{"enable":{"type":"boolean","description":"Whether Microsoft 365 data sources can be used as data sources for AI.","example":true},"calendar_events":{"type":"boolean","description":"Whether Microsoft Outlook calendar events accessible to the user can be used as a data source for AI.","example":true},"emails":{"type":"boolean","description":"Whether Microsoft Outlook emails accessible to the user can be used as a data source for AI.","example":true},"documents":{"type":"boolean","description":"Whether Office 365 documents accessible to the user can be used as a data source for AI.","example":true}},"description":"Settings for Microsoft 365 data sources."},"google":{"type":"object","properties":{"enable":{"type":"boolean","description":"Whether Google data sources can be used as data sources for AI.","example":true},"calendar_events":{"type":"boolean","description":"Whether Google Calendar events accessible to the user can be used as a data source for AI.","example":true},"emails":{"type":"boolean","description":"Whether Gmail emails accessible to the user can be used as a data source for AI.","example":true},"documents":{"type":"boolean","description":"Whether Google Drive documents accessible to the user can be used as a data source for AI.","example":true}},"description":"Settings for Google data sources."},"web_content":{"type":"boolean","description":"Whether public web content can be used as a data source for AI.","example":true},"local_file_uploads":{"type":"boolean","description":"Whether files uploaded by users can be used as a data source for AI by the users who uploaded them.","example":true},"organization_custom_dictionaries":{"type":"boolean","description":"Whether AI can consume the organization's custom dictionaries.","example":true},"third_party_app_tasks":{"type":"boolean","description":"Whether AI can perform tasks on the user's behalf in third-party apps configured within AI Studio.","example":true},"workspace_reservation_recommendations_with_ai":{"type":"object","properties":{"enabled":{"type":"boolean","description":"Whether Workspace Reservation recommendations with AI are enabled.","example":true},"day_recommendation":{"type":"boolean","description":"Whether day recommendations are enabled.","example":true},"desk_recommendation":{"type":"boolean","description":"Whether desk recommendations are enabled.","example":true},"custom_workspaces_recommendation":{"type":"boolean","description":"Whether custom workspace recommendations are enabled.","example":true},"room_recommendation":{"type":"boolean","description":"Whether room recommendations are enabled.","example":true},"proactive_room_recommendation":{"type":"boolean","description":"Whether proactive room recommendations are enabled.","example":true}},"description":"Workspace Reservation recommendations with AI."},"participant_can_request_aic_in_meeting":{"type":"boolean","description":"Participants can request the host to start in-meeting AI features.","example":true},"restrict_aic_when_external_user_join_meeting":{"type":"boolean","description":"Automatically restrict Zoom AI and transcription features when external users or groups join a meeting.","example":true},"restrict_users_from_joining_ai_enabled_meetings":{"type":"object","properties":{"enable":{"type":"boolean","description":"Whether users are restricted from joining meetings in which AI meeting processing (meeting questions and summary) is allowed.","example":true},"join_notify":{"type":"string","description":"Action to take when a restricted user tries to join an AI-enabled meeting. Valid values: `out_of_compliance` (notify users that they are out of compliance), `notify_and_remove` (notify and remove users from the meeting).","example":"notify_and_remove","enum":["out_of_compliance","notify_and_remove"]},"apply_scope":{"type":"string","description":"Apply this setting to. Valid values: `internal_only` (internal meetings only), `external_only` (external meetings only), `internal_and_external` (internal and external meetings).","example":"internal_and_external","enum":["internal_only","external_only","internal_and_external"]}},"description":"Users would be restricted from joining meetings in which AI meeting processing (meeting questions and summary) is allowed."},"meeting_questions":{"type":"object","properties":{"enable":{"type":"boolean","description":"Whether to allow hosts and invited participants to ask questions to AI Companion during a meeting.","example":true},"auto_enable":{"type":"boolean","description":"Whether to automatically allow access when the meeting starts.","example":false},"who_can_ask_questions":{"type":"string","description":"Defines who can ask questions about this meeting's transcript. Valid values: `from_entire_meeting` (all participants and invitees), `from_join_meeting` (all participants only from when they join), `host` (only the meeting host), `org` (participants and invitees in the organization), `org_from_join_meeting` (participants in the organization only from when they join).","example":"org_from_join_meeting","enum":["from_entire_meeting","from_join_meeting","host","org","org_from_join_meeting"]}},"description":"Zoom AI answers the meeting questions based on what is said in the meeting. If a transcript is retained, participants with access will be able to ask questions after the meeting based on that transcript."},"meeting_summary":{"type":"object","properties":{"enable":{"type":"boolean","description":"Whether to allow hosts to generate a summary.","example":true},"auto_enable":{"type":"boolean","description":"Whether to turn on meeting summary automatically when meetings start.","example":false},"email_notification":{"type":"boolean","description":"Send an email notification when sharing with participants.","example":true},"whether_include_full_text_in_email":{"type":"string","description":"Whether to include summary text in the email. Valid values: `include_full_text_in_email` (include summary text in the email), `not_include_full_text_in_email` (do not include summary text in the email).","example":"include_full_text_in_email","enum":["include_full_text_in_email","not_include_full_text_in_email"]},"restrict_share_to_outside_of_organization":{"type":"boolean","description":"Restrict users from sharing summaries to those outside of our organization.","example":true},"restrict_summary_share":{"type":"string","description":"Restrict users from sharing summaries. Valid values: `external_users` (to those outside of our organization), `all_users` (to all users), `all_users_except_delegate` (to all users except delegates).","example":"external_users","enum":["external_users","all_users","all_users_except_delegate"]},"who_will_receive_summary":{"type":"string","description":"Automatically share summary with. Valid values: `host` (only meeting host), `alt_host` (only meeting host, co-hosts, and alternative hosts), `organization` (only meeting host and meeting invitees in our organization), `all` (all meeting invitees including those outside of our organization).","example":"alt_host","enum":["host","alt_host","organization","all"]}},"description":"Allow hosts to generate a summary. Summaries are sent based on sharing permissions after the meeting has ended."},"meeting_summary_template":{"type":"object","properties":{"enable":{"type":"boolean","description":"Whether users can select a meeting summary template for their meetings. After the meeting, the summary will be generated into the new template.","example":true},"summary_template_id":{"type":"string","description":"Default summary template.","example":"template_123"}},"description":"Allow users to select a meeting summary template for their meetings. After the meeting, the summary will be generated into the new template."},"meeting_summary_default_language":{"type":"object","properties":{"enable":{"type":"boolean","description":"When this feature is enabled, all meeting summaries will automatically use the language you choose.","example":true},"language":{"type":"string","description":"Set default meeting summary language. Supported values: `ar` (Arabic), `bn` (Bengali), `zh` (Chinese (Simplified)), `zh-hant` (Chinese (Traditional)), `cs` (Czech), `da` (Danish), `nl` (Dutch), `en` (English), `et` (Estonian), `fi` (Finnish), `fr` (French), `de` (German), `hi` (Hindi), `hu` (Hungarian), `id` (Indonesian), `it` (Italian), `ja` (Japanese), `ko` (Korean), `ms` (Malay), `fa` (Persian), `pl` (Polish), `pt` (Portuguese), `ro` (Romanian), `ru` (Russian), `es` (Spanish), `sv` (Swedish), `tl` (Tagalog), `ta` (Tamil), `te` (Telugu), `th` (Thai), `tr` (Turkish), `uk` (Ukrainian), `vi` (Vietnamese).","example":"en","enum":["ar","bn","zh","zh-hant","cs","da","nl","en","et","fi","fr","de","hi","hu","id","it","ja","ko","ms","fa","pl","pt","ro","ru","es","sv","tl","ta","te","th","tr","uk","vi"]}},"description":"When this feature is enabled, all meeting summaries will automatically use the language you choose."},"meeting_summary_ip_access":{"type":"object","properties":{"enable":{"type":"boolean","description":"Whether meeting summary access is restricted to specific IP address ranges.","example":true},"ip_addresses_or_ranges":{"type":"string","description":"IP addresses or ranges from which meeting summaries can be accessed.","example":"192.0.2.0/24"}},"description":"Allow meeting summary access only from specific IP address ranges."},"remind_me_turn_on_aic":{"type":"boolean","description":"If you don't set AI features to auto-start in your meetings, you will be reminded to turn on AI at the beginning of each meeting you host.","example":true},"remind_me_turn_on_catch_me_up":{"type":"boolean","description":"When you join a meeting late, you'll get a prompt for AI to summarize what's been discussed so far.","example":true},"meeting_summary_email_only_mode":{"type":"boolean","description":"When this setting is enabled, summaries will only be shared to users by email. Users will not be able to view or edit summaries on the Zoom client or web portal, as the meeting summary will not be retained.","example":false},"restrict_users_from_deleting_ai_companion_assets":{"type":"boolean","description":"When enabled, users cannot delete AI assets. Only admins can delete them.","example":true},"restrict_users_from_editing_ai_companion_assets":{"type":"boolean","description":"When enabled, users cannot edit AI assets. Only admins can edit them.","example":true},"webinar_summary_follow_up_email":{"type":"boolean","description":"Whether webinar summaries are included in webinar follow-up email. Deprecated. Use `include_webinar_summary_follow_up_email`.","example":true,"deprecated":true},"webinar_summary_ocr":{"type":"boolean","description":"Whether screen share content is used with OCR for webinar summaries. Optical Character Recognition (OCR) converts images of text screen shared during a webinar into machine-readable text to generate more accurate and relevant AI results.","example":true},"zoom_events_chat_panel":{"type":"boolean","description":"Whether the AI chat panel is enabled in Zoom Events. AI chat appears in Zoom Events setup surfaces and can be opened with the floating AI sparkle icon. You can ask AI chat about event performance and get insights and recommendations, including analytics for a specific event and across events in a Zoom Events hub.","example":true},"zoom_events_session_summary":{"type":"object","properties":{"enable":{"type":"boolean","description":"Whether Zoom Events session summaries are enabled.","example":true},"auto_start":{"type":"boolean","description":"Whether to turn on session summary automatically when sessions start.","example":true}},"description":"Session summary. Allows hosts to generate a summary. Summaries are sent after the session has ended based on the in-session access options."},"zoom_events_analytics":{"type":"boolean","description":"Whether Zoom Events AI Analytics is enabled. AI can analyze event engagement and uncover key moments, topics of interest, and actionable insights.","example":true},"zoom_events_chat_compose":{"type":"boolean","description":"Whether Zoom Events Chat Compose is enabled. AI helps users compose a response from scratch or wordsmith their chat messages.","example":true},"zoom_events_email_compose":{"type":"boolean","description":"Whether Zoom Events Email Compose with AI is enabled. AI can compose emails and subject lines for events in the Email Builder.","example":true},"zoom_events_smart_compose":{"type":"boolean","description":"Whether Zoom Events Smart Compose with AI is enabled. AI can write event content when setting up an event, including event descriptions, session descriptions, speaker bios, and lobby announcements.","example":true},"zoom_events_image_generation":{"type":"boolean","description":"Whether the Zoom Events image generator is enabled. AI can create images for use in an event.","example":true},"zoom_events_smart_upload":{"type":"boolean","description":"Whether Zoom Events Smart Upload is enabled. AI can ingest files to quickly create event content such as speaker biographies.","example":true},"zoom_events_content_generation":{"type":"boolean","description":"Whether Zoom Events Content Generation with AI is enabled. AI content generation helps users create blogs, ebooks, whitepapers, emails, highlights, and sales briefs.","example":true},"chat_summary":{"type":"object","properties":{"enable":{"type":"boolean","description":"Summarize with AI Companion","example":false},"shown_in_team_chat":{"type":"boolean","description":"Show in Team Chat","example":true}},"description":"Allow users to summarize chats, channels, and shared documents."},"chat_compose":{"type":"object","properties":{"enable":{"type":"boolean","description":"Compose with AI Companion","example":false},"shown_in_team_chat":{"type":"boolean","description":"Show in Team Chat","example":true}},"description":"Allow users to use AI to help them compose a response from scratch or wordsmith their chat messages."},"hub_ai_question_and_file_creation":{"type":"boolean","description":"Whether users can ask AI questions about file content and create new files, such as Canvas, Slides, Sheets, Paper, or data tables, from the Hub Home page. Creating files requires AI to be enabled in each product's settings.","example":true},"canvas_ai_content_generation":{"type":"boolean","description":"Whether users can use AI to generate and revise content in Canvas. Meeting transcripts from meeting summaries will be shown to hosts and can be used to create document content.","example":true},"canvas_ai_sentence_completion":{"type":"boolean","description":"Whether users can receive predictive writing suggestions while writing in Canvas.","example":true},"canvas_ai_post_meeting_writing_tasks":{"type":"boolean","description":"Whether AI can identify post-meeting writing tasks from meeting context and generate drafts that users can review and use.","example":true},"paper_ai_content_generation":{"type":"boolean","description":"Whether users can use AI to generate and revise content in Zoom Paper. Meeting transcripts from meeting summaries will be shown to hosts and can be used to create documents.","example":true},"sheets_ai_content_generation":{"type":"boolean","description":"Whether users can use AI to generate and revise content in Zoom Sheets. Meeting transcripts from meeting summaries will be shown to hosts and can be used to create sheet content.","example":true},"sheets_ai_formula":{"type":"boolean","description":"Whether AI can generate, explain, and apply spreadsheet formulas from natural-language input in Zoom Sheets.","example":true},"sheets_ai_function":{"type":"boolean","description":"Whether users can use the =AI() function in Zoom Sheets to generate, summarize, categorize, and analyze data.","example":true},"sheets_ai_resources":{"type":"boolean","description":"Whether users can add resources, such as meetings, docs, and data tables, to a spreadsheet and have AI suggest updates when they change.","example":true},"slides_ai_content_generation":{"type":"boolean","description":"Whether users can use AI to generate and revise content in Zoom Slides. Meeting transcripts from meeting summaries will be shown to hosts and can be used to create presentation content.","example":true},"my_notes_meeting_transcription":{"type":"boolean","description":"Whether users can transcribe their meetings with My Notes.","example":true},"my_notes_ai_content_generation":{"type":"object","properties":{"enable":{"type":"boolean","description":"Whether users can use AI to generate content in My Notes and enrich their writing with the meeting transcript.","example":true},"auto_generate_summary":{"type":"boolean","description":"Whether My Notes automatically generates a summary when a note is completed.","example":true},"auto_send_summary_email":{"type":"boolean","description":"Whether My Notes automatically sends a summary email when a note summary is generated.","example":true}},"description":"My Notes AI content generation settings."},"include_webinar_summary_follow_up_email":{"type":"object","properties":{"enable":{"type":"boolean","description":"Whether the host can include the webinar summary in follow-up email.","example":true},"attendee_follow_up_email":{"type":"boolean","description":"Whether the webinar summary is included in the attendee follow-up email.","example":true},"absentee_follow_up_email":{"type":"boolean","description":"Whether the webinar summary is included in the absentee follow-up email.","example":true}},"description":"Webinar follow-up email. When enabled, the host can include the webinar summary in follow-up emails."},"zoom_events_content_studio":{"type":"boolean","description":"Whether Content Studio is enabled. Content Studio can turn recordings into high-quality content such as video clips, emails, and blog posts.","example":true},"webinar_summary":{"type":"object","properties":{"enable":{"type":"boolean","description":"Whether to allow hosts to generate a summary.","example":true},"auto_enable":{"type":"boolean","description":"Whether to turn on webinar summary automatically when the webinar starts.","example":false},"email_notification":{"type":"boolean","description":"Whether to send an email notification when sharing to participants.","example":true},"whether_include_full_text_in_email":{"type":"string","description":"Whether to include summary text in the email. Valid values: `include_full_text_in_email` (Include summary text in the email), `not_include_full_text_in_email` (Don't include summary text in the email).","example":"include_full_text_in_email","enum":["include_full_text_in_email","not_include_full_text_in_email"]},"restrict_share_to_outside_of_organization":{"type":"boolean","description":"Whether to restrict users from sharing summaries to those outside of the organization.","example":true},"restrict_summary_share":{"type":"string","description":"Restrict users from sharing summaries. Valid values: `external_users` (To those outside of the organization), `all_users` (To all users), `all_users_except_delegate` (To all users except delegates).","example":"external_users","enum":["external_users","all_users","all_users_except_delegate"]},"who_will_receive_summary":{"type":"string","description":"Who to automatically share the summary with. Valid values: `host` (Only webinar host), `host_and_panelist_in_organization` (Only webinar host, co-hosts, and panelists in the organization), `host_and_panelist_not_in_organization` (Webinar host, co-hosts, and all panelists, including those outside the organization).","example":"host_and_panelist_in_organization","enum":["host","host_and_panelist_in_organization","host_and_panelist_not_in_organization"]}},"description":"Allows hosts to generate a summary. Summaries are sent after the webinar has ended based on sharing permissions."},"webinar_questions":{"type":"object","properties":{"enable":{"type":"boolean","description":"Whether to allow users to ask webinar questions with AI.","example":true},"auto_enable":{"type":"boolean","description":"Whether to automatically allow access when the webinar starts.","example":false},"who_can_ask_questions":{"type":"string","description":"Who can ask questions about the webinar. Valid values: `panelist_all` (Hosts and all panelists), `panelist_org` (Hosts and all panelists in the organization), `host` (Only webinar host, co-hosts, and alternative hosts), `all_participants` (All participants).","example":"panelist_org","enum":["panelist_all","panelist_org","host","all_participants"]}},"description":"During the webinar, answers are based on speech-to-text data. If a transcript is retained, participants with access can ask questions after the webinar based on that transcript."}},"description":"Workspace Reservation recommendations with AI."}}},{"title":"AccountSettingsAuthenticationUpdate","type":"object","oneOf":[{"type":"object","properties":{"allow_authentication_exception":{"type":"boolean","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.","example":true},"authentication_option":{"type":"object","properties":{"action":{"type":"string","description":"Specify the action that you would like to take via this API request:  \n \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.","example":"update","enum":["update","delete","add"]},"default_option":{"type":"boolean","description":"Specify whether you would like to set this authentication option as the default option or not.","example":true},"domains":{"type":"string","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. ","example":"l.test.com"},"id":{"type":"string","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.  \n   \n \n Use this field or the `name` field to identify the associated authentication option that you would like to update or delete.","example":"F1wSw9paTiCIdvz0AEG-sg"},"name":{"type":"string","description":"Unique name for the authentication option.","example":"test"},"type":{"type":"string","description":" Authentication type. Specify one of the following authentication types for the authentication profile:  \n \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.  \n \n * `enforce_login_with_same_account`: This option allows users to join the meeting or webinar with the same Zoom account.","example":"enforce_login_with_domains","enum":["enforce_login","enforce_login_with_same_account","enforce_login_with_domains"]}},"description":"Meeting Authentication Options"},"meeting_authentication":{"type":"boolean","description":"If set to `true`, only authenticated users can join meetings. The method for authentication can be defined in the `authentication_option`. ","example":true}},"description":"Set/ update [authentication profile](https://support.zoom.us/hc/en-us/articles/360037117472-Authentication-Profiles-for-Meetings-and-Webinars).  \n   \n  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)."},{"type":"object","properties":{"authentication_option":{"type":"object","properties":{"action":{"type":"string","description":"Specify the action that you would like to take via this API request.  \n \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.","example":"update","enum":["update","delete","add"]},"default_option":{"type":"boolean","description":"Specify whether you would like to set this authentication option as the default option or not.","example":true},"domains":{"type":"string","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. ","example":"l.test.com"},"id":{"type":"string","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.  \n   \n \nUse this field or the `name` field to identify the associated authentication option that you would like to update or delete.","example":"F1wSw9paTiCIdvz0AEG-sg"},"name":{"type":"string","description":"Unique name for the authentication option.","example":"test"},"type":{"type":"string","description":"Specify one authentication type that is to be associated with this authentication configuration:  \n \n* `internally`: This option allows you specify a rule that only signed in users within your account can view the recording.  \n \n * `enforce_login`: This option allows any users to view the recording, as long as they are signed into their Zoom account.  \n \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","example":"enforce_login_with_domains","enum":["internally","enforce_login","enforce_login_with_domains"]}},"description":"Specify the authentication options for this account."},"recording_authentication":{"type":"boolean","description":"If set to `true`, only authenticated users can view the cloud recordings.  \n   \n \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).","example":true}},"description":"Set/Update [authentication profile for Cloud Recordings](https://support.zoom.us/hc/en-us/articles/360037756671-Authentication-Profiles-for-Cloud-Recordings)."}]},{"title":"Meeting or Webinar Security Account Settings","type":"object","properties":{"meeting_security":{"type":"object","properties":{"auto_security":{"type":"boolean","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.","example":true},"block_user_domain":{"type":"boolean","description":"Whether to block users in specific domains from joining meetings and webinars.","example":true},"block_user_domain_list":{"maxItems":20,"type":"array","description":"The domain to block, up to 20 domains. For example, the `*.example.com` domain.","example":["*.example.com","*.test.com"],"items":{"maxLength":30,"minLength":5,"type":"string","example":"a.example.com"}},"chat_etiquette_tool":{"type":"object","properties":{"enable":{"type":"boolean","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.","example":true,"default":false},"operate":{"type":"string","description":"The policy operation to perform for the update. \n* `create` - Create policies. \n* `update` - Update policies. \n* `delete` - Delete policies.","example":"update","enum":["create","update","delete"],"x-enum-descriptions":["Add new policies.","Update policies.","Delete policies."]},"policies":{"type":"array","description":"Information about the defined **Chat Etiquette Tool** policies.","items":{"type":"object","properties":{"description":{"type":"string","description":"The policy's description.","example":"policy's description"},"id":{"type":"string","description":"The policy ID.","example":"23ffefr4343fwg53t23reve"},"is_locked":{"type":"boolean","description":"Whether to lock the policy. When it is locked, users cannot update the policy. This value defaults to `false`.","example":true,"default":false},"keywords":{"type":"array","description":"A list of defined rule keywords.","items":{"type":"string","example":"test"}},"name":{"type":"string","description":"The policy name.","example":"policy name"},"regular_expression":{"type":"string","description":"The regular expression to match to the content of chat messages.","example":"^test"},"status":{"type":"string","description":"The policy's current status. \n* `activated` - Activated. \n* `deactivated` - Deactivated.","example":"activated","enum":["activated","deactivated"],"x-enum-descriptions":["Activated.","Deactivated."]},"trigger_action":{"type":"integer","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.","example":2,"enum":[1,2],"x-enum-descriptions":["Ask the user to confirm before they send the message.","Block the user's message."]}}}}},"description":"Information about the **Chat Etiquette** tool."},"embed_password_in_join_link":{"type":"boolean","description":"Whether the meeting passcode will be encrypted and included in the invitation link. The provided link will allow participants to join the meeting without having to enter the passcode.","example":true},"encryption_type":{"type":"string","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.","example":"e2ee","enum":["enhanced_encryption","e2ee"]},"end_to_end_encrypted_meetings":{"type":"boolean","description":"Whether to enable end-to-end encryption for meetings. If enabled, you can specify the type of encryption in the `encryption_type` field.","example":true},"meeting_password":{"type":"boolean","description":"Whether all instant and scheduled meetings that users can join via client or Zoom Rooms systems are passcode-protected. [Personal Meeting ID (PMI)](https://support.zoom.us/hc/en-us/articles/203276937) meetings are **not** included in this setting.","example":true},"meeting_password_requirement":{"type":"object","properties":{"consecutive_characters_length":{"type":"integer","description":"The maximum length of consecutive characters (for example, `abcdef`) allowed in a passcode. \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 passcode, like `abc1x@8fdh`. \n* `0` - Do not apply a consecutive character restriction.","example":8,"enum":[0,4,5,6,7,8]},"have_letter":{"type":"boolean","description":"Whether the passcode must contain at least one letter character.","example":true},"have_number":{"type":"boolean","description":"Whether the passcode must contain at least one numeric character.","example":true},"have_special_character":{"type":"boolean","description":"Whether the passcode must contain at least one special character. For example, `!`, `@`, and/or `#` characters.","example":true},"have_upper_and_lower_characters":{"type":"boolean","description":"Whether the passcode must include uppercase and lowercase characters.","example":true},"length":{"type":"integer","description":"The passcode's minimum length.","example":8},"only_allow_numeric":{"type":"boolean","description":"Whether the passcode must contain **only** numeric characters.","example":true},"weak_enhance_detection":{"type":"boolean","description":"Whether users will be informed when the provided passcode is weak.","example":true}},"description":"Information about the meeting and webinar [passcode requirements](https://support.zoom.us/hc/en-us/articles/360033559832-Meeting-and-webinar-passwords#h_a427384b-e383-4f80-864d-794bf0a37604)."},"only_authenticated_can_join_from_webclient":{"type":"boolean","description":"Whether to specify that only authenticated users can join the meeting from the web client.","example":true},"phone_password":{"type":"boolean","description":"Whether to require a passcode for participants joining by phone. \n\n If enabled and the meeting is passcode-protected, a numeric passcode is required for participants to join by phone. For meetings with alphanumeric passcodes, a numeric passcode will be generated.","example":true},"pmi_password":{"type":"boolean","description":"Whether all Personal Meeting ID (PMI) meetings that users can join via client or Zoom Rooms systems are passcode-protected.","example":true},"require_password_for_scheduled_meeting":{"type":"boolean","description":"Whether to require a passcode for meetings that have already been scheduled.","example":true},"require_password_for_scheduled_webinar":{"type":"boolean","description":"Whether to require a passcode for webinars that have already been scheduled.","example":true},"waiting_room":{"type":"boolean","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.","example":true},"waiting_room_settings":{"type":"object","properties":{"participants_to_place_in_waiting_room":{"type":"integer","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).","example":1,"enum":[0,1,2]},"users_who_can_admit_participants_from_waiting_room":{"type":"integer","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.","example":1,"enum":[0,1]},"whitelisted_domains_for_waiting_room":{"type":"string","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`).","example":"example2.com"}},"description":"Information about the Waiting Room settings."},"webinar_password":{"type":"boolean","description":"Whether to generate a passcode when scheduling webinars. Participants must use the generated passcode to join the scheduled webinar.","example":true},"waiting_room_options":{"type":"object","properties":{"enable":{"type":"boolean","description":"Whether to enable the waiting room.","example":true},"locked":{"type":"boolean","description":"Whether to enable the option to lock after selecting  `How are participants admitted from the waiting room`.","example":false},"admit_type":{"type":"integer","description":"The type of admission for participants from the waiting room. \n* `1` - Everyone is automatically admitted. \n* `2` - Participants are manually admitted. \n* `3` - External users are manually admitted. Internal users are automatically admitted10 minutes before start time. \n* `4` - External users and users without approved domains are manually admitted. Internal users are automatically admitted.","example":1,"enum":[1,2,3,4],"x-enum-descriptions":["Everyone is automatically admitted","Participants are manually admitted","External users are manually admitted. Internal users are automatically admitted10 minutes before start time","External users and users without approved domains are manually admitted. Internal users are automatically admitted"]},"internal_user_auto_admit":{"type":"integer","description":"If the `admit_type` in (`1`,`3`,`4`), the time when the internal user can join a meeting before the host. \n* `1` - when the host joins. \n* `2` - anytime. \n* `3` - 5 minutes before start time. \n* `4` - 10 minutes before start time.  \n* `5` - 15 minutes before start time. \n If the `admit_type` equal `1`, this field value can not be `2`. ","example":1,"enum":[1,2,3,4,5],"x-enum-descriptions":["When the host joins","Anytime","5 minutes before start time","10 minutes before start time","15 minutes before start time"]},"admit_domain_allowlist":{"type":"string","description":"If the `admit_type` field is `4`, a comma-separated list of the domains that can bypass the waiting room (`example.com,example2.com`).","example":"example.com"},"who_can_admit_participants":{"type":"integer","description":"The type of 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 (only if host and co-hosts are not present).","example":1,"enum":[0,1],"x-enum-descriptions":["Host and co-hosts only","Host, co-hosts, and anyone who bypassed the waiting room (only if host and co-hosts are not present)"]},"sort_order_of_people":{"type":"integer","description":"The type of sort order of people in the waiting room in the participants panel. \n* `0` - Join order. \n* `1` - Alphabetical. \n This feature is only available with version 5.10.3 or later.","example":1,"enum":[0,1],"x-enum-descriptions":["Join order","Alphabetical"]},"more_options":{"type":"object","properties":{"user_invited_by_host_can_bypass_waiting_room":{"type":"boolean","description":"Users invited during the meeting by the host or co-hosts will bypass the waiting room. \n This feature is only available with version 5.4.0 or later.","example":true},"move_participants_to_waiting_room_when_host_dropped":{"type":"boolean","description":"Move participants to the waiting room if the host drops unexpectedly. By enabling this option, the waiting room setting is enabled and locked, and participants are not allowed to join before the host.","example":true},"allow_participants_to_reply_to_host":{"type":"boolean","description":"Allow participants in the waiting room to reply to host and co-hosts. \n This feature is only available with version 5.8.0 or later.","example":true}},"description":"More Options."}},"description":"Define how participants are admitted into a meeting, including if they can join before the host. Customize the waiting room design."}}}},"description":"The account's updated meeting and webinar security settings."},{"title":"Update Video SDK Account Settings","type":"object","properties":{"in_meeting":{"type":"object","properties":{"custom_data_center_regions":{"type":"boolean","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.","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","example":"AU","enum":["AU","LA","CA","CN","DE","HK","IN","IE","TY","MX","NL","SG","US"]}}},"deprecated":true},"in_session":{"type":"object","properties":{"custom_data_center_regions":{"type":"boolean","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.","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","example":"US","enum":["AU","LA","CA","CN","DE","HK","IN","IE","TY","MX","NL","SG","US"]}},"p2p_connetion":{"type":"boolean","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.","example":true},"p2p_ports":{"type":"boolean","description":"Whether to enable the **Listening ports range** setting.","example":true},"ports_range":{"type":"string","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.","example":"1;65535","default":""},"dscp_audio":{"maximum":63,"minimum":1,"type":"integer","description":"The DSCP audio marking value. This value defaults to `56`.","example":56,"default":56},"dscp_marking":{"type":"boolean","description":"Whether to enable [differentiated services code point (DSCP)](https://en.wikipedia.org/wiki/Differentiated_services) marking.","example":true},"dscp_video":{"maximum":63,"minimum":1,"type":"integer","description":"The DSCP video marking value. This value defaults to `40`.","example":40,"default":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":{"type":"boolean","description":"Allow host to split meeting participants into separate, smaller rooms.","example":true}}},"session_security":{"type":"object","properties":{"approved_or_denied_countries_or_regions":{"type":"object","properties":{"approved_list":{"type":"array","description":"List of countries/regions from where participants can join this meeting. ","items":{"type":"string","example":"CX"}},"denied_list":{"type":"array","description":"List of countries/regions from where participants can not join this meeting. ","items":{"type":"string","example":"CA"}},"enable":{"type":"boolean","description":"`true`: Setting enabled to either allow or block users from specific regions from joining your meetings.   \n \n\n`false`: Setting disabled.","example":true},"method":{"type":"string","description":"Specify whether to allow users from specific regions to join this meeting, or block users from specific regions from joining this meeting.   \n   \n \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`.  \n   \n \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`","example":"approve","enum":["approve","deny"]}},"description":"Approve or block users from specific regions or countries from joining this meeting. \n"}}},"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.","example":30,"enum":[30,60,90,120]}}}}}]}}}},"responses":{"204":{"description":"**HTTP Status Code:** `204`   \n \nAccount settings updated."},"400":{"description":"**HTTP Status Code:** `400` <br>\n Bad Request  \n\n **Error Code:** `200` <br>\n Only available for paid accounts. <br>\n"},"404":{"description":"**HTTP Status Code:** `404` <br>\n Not Found  \n\n **Error Code:** `2001` <br>\n Account does not exist: $accountId <br>\n"},"429":{"description":"**HTTP Status Code:** `429` <br>\n Too Many Requests. For more information, see [rate limits](https://developers.zoom.us/docs/api/rest/rate-limits/). \n\n "}},"security":[{"openapi_authorization":[]}],"x-extensions":{"x-permissions":["SubAccount:Edit","SubAccount:Read"],"x-macro-scopes":["account:write:admin"],"x-granular-scopes":["account:update:settings:master"]}}},"/accounts/{accountId}/settings/meeting_waiting_room_branding":{"post":{"tags":["Accounts"],"summary":"Update meeting Waiting Room branding","description":"Sets the meeting Waiting Room branding (logo, background image, video, welcome title/description, and layout) for the account. To update the settings for a master account, pass the `me` value for the `accountId` path parameter.\n\n**Prerequisites:**\n* The account must be a paid account.\n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `account:write:admin`,`account:master`\n\n**[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `account:write:waiting_room_branding:master`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`","operationId":"accountMeetingWaitingRoomBrandingUpdate","parameters":[{"name":"accountId","in":"path","description":"The account ID.","required":true,"schema":{"type":"string","example":"me"}}],"requestBody":{"content":{"multipart/form-data":{"schema":{"type":"object","properties":{"logo":{"type":"string","description":"The Waiting Room logo. Up to 1 MB of JPG, PNG, or GIF files. A minimum width or height of 60px (cannot exceed 400px).","format":"binary","example":"logo.png"},"image":{"type":"string","description":"The Waiting Room background image shown to participants when the layout is set to an image. Up to 1 MB of JPG, PNG, or GIF files. A minimum width of 400px and height of 200px (a ratio of width to height of 2:1 is suggested).","format":"binary","example":"background.png"},"video":{"type":"string","description":"The Waiting Room background video shown to participants when the layout is set to a video. Up to 30 MB of MP4, MOV, or M4V files.","format":"binary","example":"welcome.mp4"},"title":{"type":"string","description":"The Waiting Room title. Up to 64 characters.","example":"Please wait, the host will let you in soon."},"description":{"type":"string","description":"The Waiting Room description, shown together with the logo when the layout is set to a logo and description. Up to 400 characters.","example":"Thank you for joining. The host will start the meeting shortly."},"participant_will_see":{"type":"string","description":"What participants in the Waiting Room will see. Allowed: `image` (An image), `logo_and_description` (A logo and description), `video` (A video).","example":"image","enum":["image","logo_and_description","video"]},"default_image":{"type":"string","description":"The default Waiting Room screen used when the layout is set to an image. Allowed: `ai` (Allow AI on this account), `workplace` (Workplace), `customize` (Upload my own image).","example":"customize","enum":["ai","workplace","customize"]}}}}}},"responses":{"200":{"description":"**HTTP Status Code:** `200`\n\nOK","content":{"application/json":{"schema":{"type":"object","properties":{"logo":{"type":"object","properties":{"file_id":{"type":"string","description":"The Waiting Room logo file ID.","example":"8oGZC9WeQzC4wLKz5Yy8Bw"},"file_name":{"type":"string","description":"The Waiting Room logo file name.","example":"logo.png"},"description":{"type":"string","description":"The Waiting Room description shown together with the logo.","example":"Thank you for joining. The host will start the meeting shortly."}}},"image":{"type":"object","properties":{"file_id":{"type":"string","description":"The Waiting Room background image file ID.","example":"3nR7pQ1sT9uVxYzAaBbCcD"},"file_name":{"type":"string","description":"The Waiting Room background image file name.","example":"background.png"}}},"video":{"type":"object","properties":{"file_id":{"type":"string","description":"The Waiting Room background video file ID.","example":"7hJ2kL4mN6oP8qR0sT2uVw"},"file_name":{"type":"string","description":"The Waiting Room background video file name.","example":"welcome.mp4"}}},"title":{"type":"string","description":"The Waiting Room title.","example":"Please wait, the host will let you in soon."},"participant_will_see":{"type":"string","description":"What participants in the Waiting Room will see. Allowed: `image` (An image), `logo_and_description` (A logo and description), `video` (A video).","example":"image","enum":["image","logo_and_description","video"]},"default_image":{"type":"string","description":"The default Waiting Room screen used when the layout is set to an image. Allowed: `ai` (Allow AI on this account), `workplace` (Workplace), `customize` (Upload my own image).","example":"customize","enum":["ai","workplace","customize"]}}}}}},"400":{"description":"**HTTP Status Code:** `400` <br>\n Bad Request  Invalid meeting Waiting Room image. \n\n "},"401":{"description":"**HTTP Status Code:** `401` <br>\n Unauthorized  \n\n "},"403":{"description":"**HTTP Status Code:** `403` <br>\n Forbidden  \n\n "},"404":{"description":"**HTTP Status Code:** `404` <br>\n Not Found  \n\n "},"415":{"description":"**HTTP Status Code:** `415` <br>\n Unsupported Media Type  \n\n "},"429":{"description":"**HTTP Status Code:** `429` <br>\n Too Many Requests. For more information, see [rate limits](https://developers.zoom.us/docs/api/rate-limits/). \n\n "},"500":{"description":"**HTTP Status Code:** `500` <br>\n Internal Server Error  Waiting Room branding upload is unavailable. \n\n "}},"security":[{"openapi_authorization":[]}],"x-extensions":{"x-permissions":["SubAccount:Edit","SubAccount:Read"],"x-macro-scopes":["account:write:admin","account:master"],"x-granular-scopes":["account:write:waiting_room_branding:master"]}}},"/accounts/{accountId}/settings/registration":{"get":{"tags":["Accounts"],"summary":"Get an account's webinar registration settings","description":"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**Prerequisites:** \n* The account must be a paid account.\n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `account:read:admin`,`account:write:admin`,`account:read:master`,`account:write:master`\n\n**[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `account:read:registration_settings:master`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`","operationId":"accountSettingsRegistration","parameters":[{"name":"accountId","in":"path","description":"The account's ID. For master accounts, pass the `me` value for this parameter.","required":true,"schema":{"type":"string","example":"me"}},{"name":"type","in":"query","description":"The registration's type.\n* `webinar` &mdash; webinar.","required":false,"schema":{"type":"string","example":"webinar","enum":["webinar"]}}],"responses":{"200":{"description":"**HTTP Status Code:** `200`   \n \nAccount settings registration information returned.","content":{"application/json":{"schema":{"type":"object","properties":{"options":{"type":"object","properties":{"host_email_notification":{"type":"boolean","description":"Send an email to host when someone registers.","example":true},"close_registration":{"type":"boolean","description":"Close registration after event date.","example":true},"allow_participants_to_join_from_multiple_devices":{"type":"boolean","description":"Allow participants to join from multiple devices","example":true},"show_social_share_buttons":{"type":"boolean","description":"Show social share buttons on registration page","example":true}},"description":"When participants submit registration, do something."},"questions":{"type":"array","description":"Array of Registrant Questions.","items":{"type":"object","properties":{"field_name":{"type":"string","description":"Field name of the question.","example":"last_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"],"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"]},"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.","example":0,"enum":[0,1],"x-enum-descriptions":["Automatically approve .","Manually approve"]},"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.","example":"single_dropdown","enum":["short","single_dropdown","single_radio","multiple"],"x-enum-descriptions":["Short Text","Single Choice Dropdown","Single Choice Radio","Multiple Choice"]},"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"}}}}}}}}}},"404":{"description":"**HTTP Status Code:** `404` <br>\n Not Found \n\n **Error Code:** `2001` <br>\n Account does not exist: $accountId <br>\n"},"429":{"description":"**HTTP Status Code:** `429` <br>\n Too Many Requests. For more information, see [rate limits](https://developers.zoom.us/docs/api/rest/rate-limits/). \n\n "}},"security":[{"openapi_authorization":[]}],"x-extensions":{"x-permissions":["SubAccount:Edit","SubAccount:Read"],"x-macro-scopes":["account:read:admin","account:write:admin","account:read:master","account:write:master"],"x-granular-scopes":["account:read:registration_settings:master"]}},"patch":{"tags":["Accounts"],"summary":"Update an account's webinar registration settings","description":"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 **Prerequisites:** \n* The account must be a paid account.\n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `account:write:admin`,`account:write:master`\n\n**[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `account:update:registration_settings:master`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`","operationId":"accountSettingsRegistrationUpdate","parameters":[{"name":"accountId","in":"path","description":"The account's ID. For master accounts, pass the `me` value for this parameter.","required":true,"schema":{"type":"string","example":"me"}},{"name":"type","in":"query","description":"The registration's type.\n* `webinar` &mdash; webinar.","required":false,"schema":{"type":"string","example":"webinar","enum":["webinar"],"x-enum-descriptions":["webinar"]}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"options":{"type":"object","properties":{"host_email_notification":{"type":"boolean","description":"Send an email to host when someone registers.","example":true},"close_registration":{"type":"boolean","description":"Close registration after event date.","example":true},"allow_participants_to_join_from_multiple_devices":{"type":"boolean","description":"Allow participants to join from multiple devices","example":true},"show_social_share_buttons":{"type":"boolean","description":"Show social share buttons on registration page","example":true}},"description":"When participants submit registration, do something."},"questions":{"type":"array","description":"Array of Registrant Questions.","items":{"type":"object","properties":{"field_name":{"type":"string","description":"Field name of the question.","example":"last_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"],"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"]},"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.","example":0,"enum":[0,1],"x-enum-descriptions":["Automatically approve .","Manually approve"]},"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.","example":"single_dropdown","enum":["short","single_dropdown","single_radio","multiple"],"x-enum-descriptions":["Short Text","Single Choice Dropdown","Single Choice Radio","Multiple Choice"]},"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"}}}}}}}}}},"responses":{"204":{"description":"**HTTP Status Code:** `204`   \n \nAccount settings updated."},"400":{"description":"**HTTP Status Code:** `400` <br>\n Bad Request \n\n **Error Code:** `200` <br>\n Only available for paid accounts. <br>\n"},"404":{"description":"**HTTP Status Code:** `404` <br>\n Not Found \n\n **Error Code:** `2001` <br>\n Account does not exist: $accountId <br>\n"},"429":{"description":"**HTTP Status Code:** `429` <br>\n Too Many Requests. For more information, see [rate limits](https://developers.zoom.us/docs/api/rest/rate-limits/). \n\n "}},"security":[{"openapi_authorization":[]}],"x-extensions":{"x-permissions":["SubAccount:Edit","SubAccount:Read"],"x-macro-scopes":["account:write:admin","account:write:master"],"x-granular-scopes":["account:update:registration_settings:master"]}}},"/accounts/{accountId}/settings/virtual_backgrounds":{"post":{"tags":["Accounts"],"summary":"Upload virtual background files","description":"[Uploads virtual background files](https://support.zoom.us/hc/en-us/articles/210707503-Virtual-Background#h_01EJF3YFEWGT8YA0ZJ079JEDQE) for all users on the account to use. \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.\n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `account:write:admin`,`account:master`\n\n**[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `account:write:virtual_background_files:master`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`","operationId":"uploadVB","parameters":[{"name":"accountId","in":"path","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"multipart/form-data":{"schema":{"type":"object","properties":{"file":{"type":"string","description":"The virtual background file's path.","example":"profile.png"}}}}}},"responses":{"201":{"description":"**HTTP Status Code:** `201`   \n \n Created","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","description":"The file's ID.","example":"_l0MP1U7Qn2JgJ4oEJbVZQ"},"is_default":{"type":"boolean","description":"Whether the file is the default virtual background file.","example":false},"name":{"type":"string","description":"The file's name.","example":"profile.PNG"},"size":{"type":"integer","description":"The file's size, in bytes.","example":7221},"type":{"type":"string","description":"The file type.","example":"image"}}}}}},"400":{"description":"**HTTP Status Code:** `400` <br>\n Bad Request  \n\n **Error Code:** `120` <br>\n * No file uploaded. Verify that a file has been uploaded. \n* File size cannot exceed 15M. \n* A maximum of 10 files are allowed for a user. \n* File uploads must be in \"jpg/jpeg\", \"gif\", or \"png\" file format. \n* Failed to upload file. <br>\n"},"404":{"description":"**HTTP Status Code:** `404` <br>\n Not Found  \n\n **Error Code:** `2001` <br>\n This account does not exist or does not belong to you: {accountId} <br>\n"},"429":{"description":"**HTTP Status Code:** `429` <br>\n Too Many Requests. For more information, see [rate limits](https://developers.zoom.us/docs/api/rest/rate-limits/). \n\n "}},"security":[{"openapi_authorization":[]}],"x-extensions":{"x-permissions":["SubAccount:Edit","SubAccount:Read"],"x-macro-scopes":["account:write:admin","account:master"],"x-granular-scopes":["account:write:virtual_background_files:master"]}},"delete":{"tags":["Accounts"],"summary":"Delete virtual background files","description":"Deletes an account's existing virtual background files. \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.\n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `account:write:admin`,`account:master`\n\n**[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `account:delete:virtual_background_files:master`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`","operationId":"delVB","parameters":[{"name":"accountId","in":"path","required":true,"schema":{"type":"string"}},{"name":"file_ids","in":"query","description":"A comma-separated list of file IDs to delete.","required":false,"schema":{"type":"string","example":"_l0MP1U7Qn2JgJ4oEJbVZQ"}}],"responses":{"204":{"description":"**HTTP Status Code:** `204`   \n \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 <br>\n"},"404":{"description":"**HTTP Status Code:** `404` <br>\n Not Found  \n\n **Error Code:** `2001` <br>\n This account does not exist or does not belong to you: {accountId} <br>\n"},"429":{"description":"**HTTP Status Code:** `429` <br>\n Too Many Requests. For more information, see [rate limits](https://developers.zoom.us/docs/api/rest/rate-limits/). \n\n "}},"security":[{"openapi_authorization":[]}],"x-extensions":{"x-permissions":["SubAccount:Edit","SubAccount:Read"],"x-macro-scopes":["account:write:admin","account:master"],"x-granular-scopes":["account:delete:virtual_background_files:master"]}}},"/accounts/{accountId}/settings/webinar_waiting_room_branding":{"post":{"tags":["Accounts"],"summary":"Update webinar Waiting Room branding","description":"Sets webinar Waiting Room branding (logo, background image, video, welcome title/description, and layout) for the account. To update the settings for a master account, pass the `me` value for the `accountId` path parameter.\n\n**Prerequisites:**\n* The account must be a paid account.\n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `account:write:admin`\n\n**[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `account:write:waiting_room_branding:master`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`","operationId":"UpdatewebinarWaitingRoombranding","parameters":[{"name":"accountId","in":"path","description":"The account ID.","required":true,"schema":{"type":"string","example":"me"}}],"requestBody":{"content":{"multipart/form-data":{"schema":{"type":"object","properties":{"logo":{"type":"string","description":"The Waiting Room logo, shown together with the description. Up to 5 MB of JPG, JPEG, or PNG files. A minimum width or height of 60 px (cannot exceed 400 px).","format":"binary","example":"logo.png"},"image":{"type":"string","description":"The Waiting Room background image shown to participants when the layout is set to an image. Up to 5 MB of JPG, JPEG, or PNG files. A minimum width of 400 px and height of 200 px (the suggested ratio of width to height is 2:1).","format":"binary","example":"background.png"},"video":{"type":"string","description":"The Waiting Room background video shown to participants when the layout is set to a video. Up to 30 MB of MP4, MOV, or M4V files.","format":"binary","example":"welcome.mp4"},"title":{"type":"string","description":"The Waiting Room host message. Up to 64 characters.","example":"Please wait, the host will let you in soon."},"description":{"type":"string","description":"The Waiting Room description, shown together with the logo when the layout is set to a logo and description. Up to 400 characters.","example":"Thank you for joining. The host will start the meeting shortly."},"participant_will_see":{"type":"string","description":"What participants in the Waiting Room will see. Allowed: `image` (An image), `logo_and_description` (A logo with description), `video` (A video).","example":"image","enum":["image","logo_and_description","video"]},"default_image":{"type":"string","description":"The default Waiting Room image used when the layout is set to an image. Allowed: `professional` (Professional), `fun` (Fun), `inspirational` (Inspirational), `customize` (Upload my own image).","example":"customize","enum":["professional","fun","inspirational","customize"]},"default_video":{"type":"string","description":"The default Waiting Room video used when the layout is set to a video. Allowed: `professionalVideos` (Professional), `funVideos` (Fun), `inspirationalVideos` (Inspirational), `customizeVideos` (Upload my own video).","example":"customizeVideos","enum":["professionalVideos","funVideos","inspirationalVideos","customizeVideos"]}}}}}},"responses":{"200":{"description":"**HTTP Status Code:** `200`\n\nOK","content":{"application/json":{"schema":{"type":"object","properties":{"logo":{"type":"object","properties":{"file_id":{"type":"string","description":"The Waiting Room logo file ID.","example":"8oGZC9WeQzC4wLKz5Yy8Bw"},"file_name":{"type":"string","description":"The Waiting Room logo file name.","example":"logo.png"},"description":{"type":"string","description":"The Waiting Room description shown together with the logo.","example":"Thank you for joining. The host will start the meeting shortly."}}},"image":{"type":"object","properties":{"file_id":{"type":"string","description":"The Waiting Room background image file ID.","example":"3nR7pQ1sT9uVxYzAaBbCcD"},"file_name":{"type":"string","description":"The Waiting Room background image file name.","example":"background.png"}}},"video":{"type":"object","properties":{"file_id":{"type":"string","description":"The Waiting Room background video file ID.","example":"7hJ2kL4mN6oP8qR0sT2uVw"},"file_name":{"type":"string","description":"The Waiting Room background video file name.","example":"welcome.mp4"}}},"title":{"type":"string","description":"The Waiting Room host message.","example":"Please wait, the host will let you in soon."},"participant_will_see":{"type":"string","description":"What participants in the Waiting Room will see. Allowed: `image` (An image), `logo_and_description` (A logo with description), `video` (A video).","example":"image","enum":["image","logo_and_description","video"]},"default_image":{"type":"string","description":"The default Waiting Room image used when the layout is set to an image. Allowed: `professional` (Professional), `fun` (Fun), `inspirational` (Inspirational), `customize` (Upload my own image).","example":"customize","enum":["professional","fun","inspirational","customize"]},"default_video":{"type":"string","description":"The default Waiting Room video used when the layout is set to a video. Allowed: `professionalVideos` (Professional), `funVideos` (Fun), `inspirationalVideos` (Inspirational), `customizeVideos` (Upload my own video).","example":"customizeVideos","enum":["professionalVideos","funVideos","inspirationalVideos","customizeVideos"]}}}}}},"400":{"description":"**HTTP Status Code:** `400` <br>\n Bad Request  Invalid webinar Waiting Room image. \n\n "},"401":{"description":"**HTTP Status Code:** `401` <br>\n Unauthorized  \n\n "},"403":{"description":"**HTTP Status Code:** `403` <br>\n Forbidden  \n\n "},"404":{"description":"**HTTP Status Code:** `404` <br>\n Not Found  \n\n "},"415":{"description":"**HTTP Status Code:** `415` <br>\n Unsupported Media Type  \n\n "},"429":{"description":"**HTTP Status Code:** `429` <br>\n Too Many Requests. For more information, see [rate limits](https://developers.zoom.us/docs/api/rate-limits/). \n\n "},"500":{"description":"**HTTP Status Code:** `500` <br>\n Internal Server Error  Waiting Room branding upload is unavailable. \n\n "}},"security":[{"openapi_authorization":[]}],"x-extensions":{"x-permissions":["AccountSetting:Edit","AccountProfile:Edit"],"x-macro-scopes":["account:write:admin"],"x-granular-scopes":["account:write:waiting_room_branding:master"]}}},"/accounts/{accountId}/trusted_domains":{"get":{"tags":["Accounts"],"summary":"Get account's trusted domains","description":"Retrieve 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 **Prerequisites:** \n* The account must be a paid account.\n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `account:master`,`account:write:master`,`account:read:master`\n\n**[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `account:read:trusted_domains:master`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`","operationId":"accountTrustedDomain","parameters":[{"name":"accountId","in":"path","description":"The account's ID. For master accounts, pass the `me` value for this parameter.","required":true,"schema":{"type":"string","example":"q6gBJVO5TzexKYTb_I2rpg"}}],"responses":{"200":{"description":"**HTTP Status Code:** `200`   \n \n Account's trusted domains returned. \n\n **Error Code:** `2001`   \n \n Account does not exist: $accountId","content":{"application/json":{"schema":{"type":"object","properties":{"trusted_domains":{"type":"array","description":"A list of the account's trusted domains.","items":{"type":"string","example":"example.com"}}}}}}},"404":{"description":"**HTTP Status Code:** `404` <br>\n Not Found \n\n **Error Code:** `2001` <br>\n Account does not exist: $accountId <br>\n"},"429":{"description":"**HTTP Status Code:** `429` <br>\n Too Many Requests. For more information, see [rate limits](https://developers.zoom.us/docs/api/rest/rate-limits/). \n\n "}},"security":[{"openapi_authorization":[]}],"x-extensions":{"x-permissions":["SubAccount:Edit","SubAccount:Read"],"x-macro-scopes":["account:master","account:write:master","account:read:master"],"x-granular-scopes":["account:read:trusted_domains:master"]}}},"/accounts/{accountId}/options":{"patch":{"tags":["Accounts"],"summary":"Update options","description":"Update a sub account's options under the master account.  \n  Your account must be a master account in order to update the options for sub accounts. Zoom only assigns this privilege to trusted partners.\n\n**Prerequisites**\n* Pro or a higher paid account with master account option enabled.\n* The account making this API request must be a [master account](https://developers.zoom.us/docs/api/rest/master-account-apis/).\n\n\n\n\n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `account:master`\n\n**[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `account:update:options:master`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`","operationId":"UpdateOptions","parameters":[{"name":"accountId","in":"path","description":"Unique identifier of the account.","required":true,"schema":{"type":"string","example":"TQTvjT52Tmi_wrhASNNOEw"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"billing_auto_renew":{"type":"boolean","description":"Whether to enable automatic billing renewal.","example":false},"meeting_connector_list":{"type":"array","description":"A comma-separated list of meeting connector IP addresses shared with the sub account. If you do not provide a value for this field, all the Master account's meeting connectors will be shared with the sub account. \n\n **Note** You can only use this field if `share_mc` value is `true`.","items":{"type":"string","example":"203.0.113.1"}},"pay_mode":{"type":"string","description":"The account's payee. \n* `master` - The Master account holder pays. \n* `sub` - The sub account holder pays. \n\n This value defaults to `master`.","example":"master","default":"master","enum":["master","sub"]},"room_connector_list":{"type":"array","description":"A comma-separated list of VRC IP addresses shared with the sub account. If you do not provide a value for this field, all of the Master account's VRCs will be shared with the sub account. \n\n **Note:** You can only use this field if `share_rc` value is `true`.","items":{"type":"string","example":"[\"192.0.2.1\",\"198.51.100.1\"]"}},"share_mc":{"type":"boolean","description":"Whether to enable the option for a sub account to use the Master account's shared [Meeting Connectors](https://support.zoom.us/hc/en-us/articles/201363093). Meeting Connectors are only available for On-Premise accounts. \n\n This value defaults to `false`.","example":false,"default":false},"share_rc":{"type":"boolean","description":"Whether to enable the option for a sub account to use the Master account's shared [Virtual Room Connectors (VRC)](https://support.zoom.us/hc/en-us/articles/202134758-Deploying-the-Virtual-Room-Connector). VRCs are only available for On-premise accounts. \n\n This value defaults to `false`.","example":false,"default":false},"resource_meeting_hybrid_list":{"maxItems":999,"type":"array","description":"A comma-separated list of Meeting Hybrid zone name shared with the subaccount. If you do not provide a value for this field, all the master account's Meeting Connectors will be shared with the subaccount. \n\n.","items":{"type":"string","example":"meeting_hybrid_resouceA"}},"resource_meeting_connector_list":{"maxItems":999,"type":"array","description":"A comma-separated list of Meeting Connector resourece name shared with the subaccount. If you do not provide a value for this field, all of the master account's meeting connector will be shared with the subaccount. \n\n","items":{"type":"string","example":"meeting_connector_resourceA"}},"resource_share_mc":{"type":"boolean","description":"Whether to enable the option for a sub account to use the master account's shared resource Meeting Connectors. Meeting Connectors are only available for On-Premise accounts. \n\n This value defaults to `false`.","example":false,"default":false},"resource_share_mh":{"type":"boolean","description":"Whether to enable the option for a sub account to use the master account's shared resource Meeting Hybrid. Meeting Hybrid are only available for On-premise accounts. \n\n This value defaults to `false`.","example":false,"default":false}},"description":"Information about the account's options."}}}},"responses":{"200":{"description":"**Error Code:** `200`  \n \nThe pay mode cannot be updated for a sub account which already has an existing plan."},"400":{"description":"**HTTP Status Code:** `400` <br>\n Bad Request  \n\n **Error Code:** `2100` <br>\n The collection method cannot be changed after the purchase is complete.<br> <br>\n**Error Code:** `2115` <br>\n Some meeting connectors you provided cannot be found. <br>\n"},"404":{"description":"**HTTP Status Code:** `404` <br>\n Not Found  \n\n **Error Code:** `2001` <br>\n Account does not exist: $subAccountId. <br>\n"},"429":{"description":"**HTTP Status Code:** `429` <br>\n Too Many Requests. For more information, see [rate limits](https://developers.zoom.us/docs/api/rest/rate-limits/). \n\n "}},"security":[{"openapi_authorization":[]}],"x-extensions":{"x-permissions":["SubAccount:Edit","SubAccount:Read"],"x-macro-scopes":["account:master"],"x-granular-scopes":["account:update:options:master"]}}},"/accounts/{accountId}/metrics/ai/adoption":{"get":{"tags":["Dashboards"],"summary":"Get AI adoption","description":"Get the AI adoption summary.\n\n**Prerequisites**\n* Business or a higher plan.\n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `dashboard:master`\n\n**[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `dashboard:read:ai_adoption:master`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `HEAVY`","operationId":"GetAIAdoption","parameters":[{"name":"accountId","in":"path","description":"Unique identifier of the account.","required":true,"schema":{"type":"string","example":"TQTvjT52Tmi_wrhASNNOEw"}}],"responses":{"200":{"description":"**HTTP Status Code:** `200`  \n\nAI adoption summary returned successfully.","content":{"application/json":{"schema":{"type":"object","properties":{"summaries":{"type":"array","description":"All summaries.","items":{"required":["feature"],"type":"object","properties":{"feature":{"type":"string","description":"The summary feature.\n\n`ai_chat_panel` - AI chat panel\n`ai_in_meetings` - AI in Meetings\n`meeting_summary` - Meeting summary\n`meeting_questions` - Meeting questions\n`smart_recording` - Smart recording\n`ai_in_phone` - AI in Phone\n`call_summary` - Call summary\n`voicemail_tasks` - Voicemail tasks\n`voicemail_Prioritization` - Voicemail prioritization\n`team_sms_thread_summary` - Team SMS thread summary\n`ai_in_chat` - AI in Chat\n`chat_thread_summary` - Chat thread summary\n`chat_compose` - Chat compose\n`ai_in_whiteboard` - AI in Whiteboard\n`ai_in_clips` - AI in Clips\n`custom_ai` - Custom AI","example":"ai_chat_panel"},"licensed_count":{"type":"number","description":"The number of users with the feature license.","example":60},"active_count":{"type":"number","description":"The number of users who used the feature.","example":40}}}}}}}}},"400":{"description":"**HTTP Status Code:** `400` <br>\n Bad Request  \n\n **Error Code:** `400` <br>\n This API is only available for ZMP and Business or higher accounts that have enabled the Dashboard feature. <br>\n"},"401":{"description":"**HTTP Status Code:** `401` <br>\n Unauthorized  \n\n "},"403":{"description":"**HTTP Status Code:** `403` <br>\n Forbidden  \n\n "},"429":{"description":"**HTTP Status Code:** `429` <br>\n Too Many Requests. For more information, see [rate limits](https://developers.zoom.us/docs/api/rate-limits/). \n\n "}},"security":[{"openapi_authorization":[]}],"x-extensions":{"x-permissions":["DashboardAIC:Read"],"x-macro-scopes":["dashboard:master"],"x-granular-scopes":["dashboard:read:ai_adoption:master"]}}},"/accounts/{accountId}/metrics/ai/kpis":{"get":{"tags":["Dashboards"],"summary":"Get AI KPIs","description":"Get AI key performance indicators.\n\n**Prerequisites**\n* Business or a higher plan.\n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `dashboard:master`\n\n**[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `dashboard:read:ai_kpi:master`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `HEAVY`","operationId":"GetAIROIKPIs","parameters":[{"name":"group_id","in":"query","description":"The group ID. To get a group ID, use the [**List groups**](https://developers.zoom.us/docs/api/rest/reference/scim-api/methods/#operation/groupSCIM2List) API. Users are filtered according to their primary group.\n\n**Note:** You can search multiple groups. When searching multiple items, separate them with commas. The maximum number of group IDs is 7.","required":false,"schema":{"type":"string","example":"TaVA8QKik_1233,TaVA8QKik_1234,TaVA8QKik_1235"}},{"name":"dept","in":"query","description":"The department of the user.","required":false,"schema":{"type":"string","example":"HR"}},{"name":"range_type","in":"query","description":"The date range type.","required":false,"schema":{"type":"string","example":"weekly","default":"weekly","enum":["daily","weekly","monthly"]}},{"name":"accountId","in":"path","description":"Unique identifier of the account.","required":true,"schema":{"type":"string","example":"TQTvjT52Tmi_wrhASNNOEw"}}],"responses":{"200":{"description":"**HTTP Status Code:** `200`  \n\nAI key performance indicators returned successfully.","content":{"application/json":{"schema":{"type":"object","properties":{"kpis":{"type":"array","description":"All KPIs.","items":{"required":["kpi","pop_value","value"],"type":"object","properties":{"kpi":{"type":"string","description":"Unique identifier for the KPI.\n\n`AI_chat_panel_users` - AI chat panel active users.\n`AI_chat_panel_queries` - AI chat panel queries.\n`meeting_summary_hosts` - Meeting summary hosts.\n`meetings_with_summaries` - Meetings with summaries.\n`meeting_questions_users` - Meeting questions active users.\n`meetings_with_questions` - Meetings with questions.\n`smart_recording_users` - Smart recording active users.\n`smart_recording_generated` - Smart recordings generated.\n`chat_compose_users` - Chat compose active users.\n`chat_compose_assisted_actions` - Chat compose assisted actions.\n`chat_thread_summary_users` - Chat thread summary active users.\n`chat_thread_summaries_generated` - Chat thread summaries generated.\n`call_summary_users` - Call summary active users.\n`calls_with_call_summary_on` - Calls with call summary on.\n`voicemail_prioritization_users` - Voicemail prioritization active users.\n`voicemail_prioritization_generated` - Voicemail prioritization generated.\n`voicemail_tasks_users` - Voicemail tasks active users.\n`voicemail_tasks_generated` - Voicemail tasks generated.\n`team_SMS_thread_summary_users` - Team SMS thread summary active users.\n`team_SMS_thread_summary_generated` - Team SMS thread summary generated.\n`whiteboard_users` - Whiteboard active users.\n`whiteboard_content_generated` - Whiteboard content generated.\n`whiteboard_content_refined` - Whiteboard content refined.\n`clips_users` - Clips active users.\n`auto-generated_clip_metadata` - Auto-generated clip metadata.\n`template_avatars_used` - Template avatars used.\n`custom_avatars_used` - Custom avatars used.\n`custom_avatars_generated` - Custom avatars generated.\n\n`custom_AI_users` - Custom AI active users.\n`custom_AI_assisted_actions` - Custom AI assisted actions.\n`custom_AI_actions_using_knowledge` - Custom AI actions using knowledge.\n`custom_AI_actions_using_BYOI` - Custom AI actions using BYOI.\n`custom_AI_actions_using_3p_app` - Custom AI actions using 3rd-party app.\n\n`total_custom_agents` - Total custom agents.","example":"meeting_summary_hosts"},"value":{"type":"number","description":"The main numerical value.","example":582},"pop_value":{"type":"number","description":"The period-over-period change percentage. A positive value indicates an increase and a negative value indicates a decrease.","example":-55.1}}}}}}}}},"400":{"description":"**HTTP Status Code:** `400` <br>\n Bad Request  \n\n **Error Code:** `400` <br>\n This API is only available for ZMP and Business or higher accounts that have enabled the Dashboard feature. <br>\n"},"401":{"description":"**HTTP Status Code:** `401` <br>\n Unauthorized  \n\n "},"403":{"description":"**HTTP Status Code:** `403` <br>\n Forbidden  \n\n "},"404":{"description":"**HTTP Status Code:** `404` <br>\n Not Found  \n\n **Error Code:** `3001` <br>\n Range type is invalid. <br>\n"},"429":{"description":"**HTTP Status Code:** `429` <br>\n Too Many Requests. For more information, see [rate limits](https://developers.zoom.us/docs/api/rate-limits/). \n\n "}},"security":[{"openapi_authorization":[]}],"x-extensions":{"x-permissions":["DashboardAIC:Read"],"x-macro-scopes":["dashboard:master"],"x-granular-scopes":["dashboard:read:ai_kpi:master"]}}},"/accounts/{accountId}/metrics/ai/usage/details":{"get":{"tags":["Dashboards"],"summary":"Get AI usage details","description":"Get AI usage and engagement details.\n\n**Prerequisites**\n* Business or a higher plan.\n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `dashboard:master`\n\n**[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `dashboard:read:ai_usage_details:master`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `HEAVY`","operationId":"GetAIDetails","parameters":[{"name":"from","in":"query","description":"The start date in `yyyy-MM-dd HH:mm:ss` or `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's worth of data at a time.","required":false,"schema":{"type":"string","format":"date","example":"2026-04-20"}},{"name":"to","in":"query","description":"The end date in `yyyy-MM-dd HH:mm:ss` or `yyyy-MM-dd` format.","required":false,"schema":{"type":"string","format":"date","example":"2026-04-27"}},{"name":"group_id","in":"query","description":"The group ID. To get a group ID, use the [**List groups**](https://developers.zoom.us/docs/api/rest/reference/scim-api/methods/#operation/groupSCIM2List) API. Users are filtered according to their primary group.\n\n**Note:** You can search multiple groups. When searching for multiple items, separate them with commas. The maximum number of group IDs is 7.","required":false,"schema":{"type":"string","example":"TaVA8QKik_1233,TaVA8QKik_1234,TaVA8QKik_1235"}},{"name":"dept","in":"query","description":"The department of the user.","required":false,"schema":{"type":"string","example":"HR"}},{"name":"page_size","in":"query","description":"The number of records returned within a single API call.","required":false,"schema":{"type":"integer","example":30}},{"name":"next_page_token","in":"query","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.","required":false,"schema":{"type":"string","example":"IAfJX3jsOLW7w3dokmFl84zOa0MAVGyMEB2"}},{"name":"order_by","in":"query","description":"Use this field to determine the sort order.\n\n`ai_chat_panel` - AI chat panel\n`ai_in_meetings` - AI in Meetings\n`meeting_summary` - Meeting summary\n`meeting_questions` - Meeting questions\n`smart_recording` - Smart recording\n`ai_in_phone` - AI in Phone\n`call_summary` - Call summary\n`voicemail_tasks` - Voicemail tasks\n`voicemail_prioritization` - Voicemail prioritization\n`team_SMS_thread_summary` - Team SMS thread summary\n`ai_in_chat` - AI in Chat\n`chat_thread_summary` - Chat thread summary\n`chat_compose` - Chat compose\n`ai_in_whiteboard` - AI in Whiteboard\n`ai_in_clips` - AI in Clips\n`custom_ai` - Custom AI","required":false,"schema":{"type":"string","example":"meeting_summary","default":"ai_in_meetings"}},{"name":"accountId","in":"path","description":"Unique identifier of the account.","required":true,"schema":{"type":"string","example":"TQTvjT52Tmi_wrhASNNOEw"}}],"responses":{"200":{"description":"**HTTP Status Code:** `200`  \n\nAI usage and engagement details returned successfully.","content":{"application/json":{"schema":{"type":"object","properties":{"from":{"type":"string","description":"The inputted `from` parameter value, in `yyyy-MM-dd HH:mm:ss` or `yyyy-MM-dd` format.","format":"date","example":"2026-05-11"},"to":{"type":"string","description":"The inputted `to` parameter value, in `yyyy-MM-dd HH:mm:ss` or `yyyy-MM-dd` format.","format":"date","example":"2026-05-27"},"next_page_token":{"type":"string","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.","example":"Tva2CuIdTgsv8wAnhyAdU3m06Y2HuLQtlh3"},"page_size":{"type":"integer","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":79},"details":{"type":"array","description":"An array of AI usage and engagement details.","items":{"required":["action","display_name","email","features_used"],"type":"object","properties":{"display_name":{"type":"string","description":"The user's display name.","example":"Jacky"},"email":{"type":"string","description":"The user's email address.","example":"abc@test.com"},"action":{"type":"integer","description":"The action count for this user.","example":20},"features_used":{"type":"array","description":"All of the AI features used by this user.\n\n`ai_chat_panel` - AI chat panel\n`meeting_summary` - Meeting summary\n`meeting_questions` - Meeting questions\n`smart_recording` - Smart recording\n`call_summary` - Call summary\n`voicemail_tasks` - Voicemail tasks\n`voicemail_prioritization` - Voicemail prioritization\n`team_SMS_thread_summary` - Team SMS thread summary\n`chat_thread_summary` - Chat thread summary\n`chat_compose` - Chat compose\n`ai_in_whiteboard` - AI in Whiteboard\n`ai_in_clips` - AI in Clips\n`custom_ai` - Custom AI","items":{"type":"string","example":"meetings_total"}},"dept":{"type":"string","description":"The user's department.","example":"HR"}}}}}}}}},"400":{"description":"**HTTP Status Code:** `400` <br>\n Bad Request\n\n**Error Code:** `400` <br>\n Bad request.\n"},"401":{"description":"**HTTP Status Code:** `401` <br>\n Unauthorized\n\n"},"403":{"description":"**HTTP Status Code:** `403` <br>\n Forbidden\n\n"},"404":{"description":"**HTTP Status Code:** `404` <br>\n Not Found\n\n**Error Code:** `3001` <br>\n Order type is invalid.\n"},"429":{"description":"**HTTP Status Code:** `429` <br>\n Too Many Requests. For more information, see [rate limits](https://developers.zoom.us/docs/api/rate-limits/). \n\n "}},"security":[{"openapi_authorization":[]}],"x-extensions":{"x-permissions":["DashboardAIC:Read"],"x-macro-scopes":["dashboard:master"],"x-granular-scopes":["dashboard:read:ai_usage_details:master"]}}},"/accounts/{accountId}/metrics/ai/usage/trend":{"get":{"tags":["Dashboards"],"summary":"Get AI usage trend","description":"Get the AI usage and engagement trend.\n\n**Prerequisites**\n* Business or a higher plan.\n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `dashboard:master`\n\n**[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `dashboard:read:ai_usage_trend:master`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `HEAVY`","operationId":"GetAItrends","parameters":[{"name":"from","in":"query","description":"The start date in `yyyy-MM-dd HH:mm:ss` or `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's worth of data at a time.","required":false,"schema":{"type":"string","format":"date","example":"2026-04-20"}},{"name":"to","in":"query","description":"The end date in `yyyy-MM-dd HH:mm:ss` or `yyyy-MM-dd` format.","required":false,"schema":{"type":"string","format":"date","example":"2026-04-27"}},{"name":"group_id","in":"query","description":"The group ID. To get a group ID, use the [**List groups**](https://developers.zoom.us/docs/api/rest/reference/scim-api/methods/#operation/groupSCIM2List) API. Users are filtered according to their primary group.\n\n**Note:** You can search multiple groups. When searching for multiple items, separate them with commas. The maximum number of group IDs is 7.","required":false,"schema":{"type":"string","example":"TaVA8QKik_1233,TaVA8QKik_1234,TaVA8QKik_1235"}},{"name":"dept","in":"query","description":"The department of the user.","required":false,"schema":{"type":"string","example":"HR"}},{"name":"feature","in":"query","description":"Optional filter to return data for a specific feature only. If omitted, all features will be returned.\n\n`meeting_summary_users` - Meeting summary users.\n`meeting_summary_actions` - Meeting summary actions.\n`meeting_questions_users` - Meeting questions users.\n`meeting_questions_actions` - Meeting questions actions.\n`smart_recording_users` - Smart recording users.\n`smart_recording_actions` - Smart recording actions.\n`chat_compose_users` - Chat compose users.\n`chat_compose_actions` - Chat compose actions.\n`chat_thread_summary_users` - Chat thread summary users.\n`chat_thread_summary_actions` - Chat thread summary actions.\n`call_summary_users` - Call summary users.\n`call_summary_actions` - Call summary actions.\n`voicemail_prioritization_users` - Voicemail prioritization users.\n`voicemail_prioritization_actions` - Voicemail prioritization actions.\n`voicemail_tasks_users` - Voicemail tasks users.\n`voicemail_tasks_actions` - Voicemail tasks actions.\n`team_SMS_thread_summary_users` - Team SMS thread summary users.\n`team_SMS_thread_summary_actions` - Team SMS thread summary actions.\n`ai_in_Whiteboard_users` - AI in Whiteboard users.\n`ai_in_Whiteboard_actions` - AI in Whiteboard actions.\n`ai_in_Clips_users` - AI in Clips users.\n`ai_in_Clips_actions` - AI in Clips actions.\n\n`custom_AI_users` - Custom AI users.\n`custom_AI_actions` - Custom AI actions.\n`custom_ai_knowledge_actions` - Custom AI knowledge actions.\n`custom_ai_BYOI_actions` - Custom AI BYOI actions.\n`custom_ai_3p_app_actions` - Custom AI 3rd-party app actions.\n`custom_ai_3p_app_usage_users` - Custom AI 3rd-party app usage users.\n`custom_ai_3p_app_usage_actions` - Custom AI 3rd-party app usage actions.","required":false,"schema":{"type":"string","example":"meeting_questions"}},{"name":"accountId","in":"path","description":"Unique identifier of the account.","required":true,"schema":{"type":"string","example":"TQTvjT52Tmi_wrhASNNOEw"}}],"responses":{"200":{"description":"**HTTP Status Code:** `200`  \n\nAI usage and engagement trend returned successfully.","content":{"application/json":{"schema":{"type":"object","properties":{"from":{"type":"string","description":"The inputted `from` parameter value, in `yyyy-MM-dd HH:mm:ss` or `yyyy-MM-dd` format.","format":"date","example":"2026-05-21"},"to":{"type":"string","description":"The inputted `to` parameter value, in `yyyy-MM-dd HH:mm:ss` or `yyyy-MM-dd` format.","format":"date","example":"2026-05-27"},"trend":{"type":"array","description":"The trend data.","items":{"required":["date"],"type":"object","properties":{"date":{"type":"string","description":"The date of the data point.","format":"date","example":"2026-05-21"},"metrics":{"type":"array","description":"The metrics for the date.","items":{"required":["count","feature"],"type":"object","properties":{"feature":{"type":"string","description":"The metric feature.\n\n`meeting_summary_users` - Meeting summary users.\n`meeting_summary_actions` - Meeting summary actions.\n`meeting_questions_users` - Meeting questions users.\n`meeting_questions_actions` - Meeting questions actions.\n`smart_recording_users` - Smart recording users.\n`smart_recording_actions` - Smart recording actions.\n`chat_compose_users` - Chat compose users.\n`chat_compose_actions` - Chat compose actions.\n`chat_thread_summary_users` - Chat thread summary users.\n`chat_thread_summary_actions` - Chat thread summary actions.\n`call_summary_users` - Call summary users.\n`call_summary_actions` - Call summary actions.\n`voicemail_prioritization_users` - Voicemail prioritization users.\n`voicemail_prioritization_actions` - Voicemail prioritization actions.\n`voicemail_tasks_users` - Voicemail tasks users.\n`voicemail_tasks_actions` - Voicemail tasks actions.\n`team_SMS_thread_summary_users` - Team SMS thread summary users.\n`team_SMS_thread_summary_actions` - Team SMS thread summary actions.\n`ai_in_Whiteboard_users` - AI in Whiteboard users.\n`ai_in_Whiteboard_actions` - AI in Whiteboard actions.\n`ai_in_Clips_users` - AI in Clips users.\n`ai_in_Clips_actions` - AI in Clips actions.\n\n`custom_AI_users` - Custom AI users.\n`custom_AI_actions` - Custom AI actions.\n`custom_ai_knowledge_actions` - Custom AI knowledge actions.\n`custom_ai_BYOI_actions` - Custom AI BYOI actions.\n`custom_ai_3p_app_actions` - Custom AI 3rd-party app actions.\n`custom_ai_3p_app_usage_users` - Custom AI 3rd-party app usage users.\n`custom_ai_3p_app_usage_actions` - Custom AI 3rd-party app usage actions.","example":"meeting_questions"},"category":{"type":"string","description":"The metric category. Only returned when the feature is `custom_ai_3p_app_usage_users` or `custom_ai_3p_app_usage_actions`.","example":"Jira"},"count":{"type":"number","description":"The metric count.","example":10}}}}}}}}}}}},"400":{"description":"**HTTP Status Code:** `400` <br>\n Bad Request  \n\n **Error Code:** `400` <br>\n This API is only available for ZMP and Business or higher accounts that have enabled the Dashboard feature. <br>\n"},"401":{"description":"**HTTP Status Code:** `401` <br>\n Unauthorized  \n\n "},"403":{"description":"**HTTP Status Code:** `403` <br>\n Forbidden  \n\n "},"404":{"description":"**HTTP Status Code:** `404` <br>\n Not Found  \n\n **Error Code:** `3001` <br>\n Feature is invalid. <br>\n"},"429":{"description":"**HTTP Status Code:** `429` <br>\n Too Many Requests. For more information, see [rate limits](https://developers.zoom.us/docs/api/rate-limits/). \n\n "}},"security":[{"openapi_authorization":[]}],"x-extensions":{"x-permissions":["DashboardAIC:Read"],"x-macro-scopes":["dashboard:master"],"x-granular-scopes":["dashboard:read:ai_usage_trend:master"]}}},"/accounts/{accountId}/metrics/aic/roi/kpis":{"get":{"tags":["Dashboards"],"summary":"Get AIC ROI KPIs","description":"Get AIC ROI KPI data. 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 a higher plan.\n\n\n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `dashboard:master`\n\n**[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `dashboard:read:aic_roi_kpi:master`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `HEAVY`","operationId":"getDashboardKpis","parameters":[{"name":"group_id","in":"query","description":"The group ID. To get a group ID, use the [**List groups**](https://developers.zoom.us/docs/api/rest/reference/scim-api/methods/#operation/groupSCIM2List) API. Participants are filtered according to their primary group.\n\n**Note:** You can search multiple groups. When searching multiple items, separate them with commas. The maximum number of group IDs is 7.","required":false,"schema":{"type":"string","example":"TaVA8QKik_1233,TaVA8QKik_1234,TaVA8QKik_1235"}},{"name":"dept","in":"query","description":"The department of the host.","required":false,"schema":{"type":"string","example":"HR"}},{"name":"range_type","in":"query","description":"The date range type.","required":false,"schema":{"type":"string","example":"monthly","default":"monthly","enum":["daily","weekly","monthly"]}},{"name":"host_saving_factor","in":"query","description":"The average number of seconds the meeting host saves per meeting minute by using AI Companion summaries.","required":false,"schema":{"type":"number","example":60.1}},{"name":"participant_saving_factor","in":"query","description":"The average number of seconds participants save per meeting minute by using AI Companion notes.","required":false,"schema":{"type":"number","example":60}},{"name":"benefiting_meetings_percent","in":"query","description":"The percentage of total meetings that benefit from AI Companion summaries.","required":false,"schema":{"type":"number","example":80.1}},{"name":"accountId","in":"path","description":"Unique identifier of the account.","required":true,"schema":{"type":"string","example":"TQTvjT52Tmi_wrhASNNOEw"}}],"responses":{"200":{"description":"**HTTP Status Code:** `200` \n \nAIC ROI KPI data returned successfully.","content":{"application/json":{"schema":{"type":"object","properties":{"total_minutes_saved":{"description":"The total minutes saved.","allOf":[{"type":"object","properties":{"value":{"type":"number","description":"The main numerical value.","example":582},"pop_value":{"type":"number","description":"The period-over-period change percentage. A positive value indicates an increase and a negative value indicates a decrease.","example":-55.1}},"description":"The ROI KPI period-over-period metric."}]},"host_minutes_saved":{"description":"The host minutes saved.","allOf":[{"type":"object","properties":{"value":{"type":"number","description":"The main numerical value.","example":582},"pop_value":{"type":"number","description":"The period-over-period change percentage. A positive value indicates an increase and a negative value indicates a decrease.","example":-55.1}},"description":"The ROI KPI period-over-period metric."}]},"participant_minutes_saved":{"description":"The participant minutes saved.","allOf":[{"type":"object","properties":{"value":{"type":"number","description":"The main numerical value.","example":582},"pop_value":{"type":"number","description":"The period-over-period change percentage. A positive value indicates an increase and a negative value indicates a decrease.","example":-55.1}},"description":"The ROI KPI period-over-period metric."}]},"unrealized_host_minutes":{"description":"The unrealized host minutes.","allOf":[{"type":"object","properties":{"value":{"type":"number","description":"The main numerical value.","example":582},"pop_value":{"type":"number","description":"The period-over-period change percentage. A positive value indicates an increase and a negative value indicates a decrease.","example":-55.1}},"description":"The ROI KPI period-over-period metric."}]},"unrealized_participant_minutes":{"description":"The unrealized participant minutes.","allOf":[{"type":"object","properties":{"value":{"type":"number","description":"The main numerical value.","example":582},"pop_value":{"type":"number","description":"The period-over-period change percentage. A positive value indicates an increase and a negative value indicates a decrease.","example":-55.1}},"description":"The ROI KPI period-over-period metric."}]},"avg_views_per_shared_summary":{"description":"The average number of views per shared meeting summary.","allOf":[{"type":"object","properties":{"value":{"type":"number","description":"The main numerical value.","example":582},"pop_value":{"type":"number","description":"The period-over-period change percentage. A positive value indicates an increase and a negative value indicates a decrease.","example":-55.1}},"description":"The ROI KPI period-over-period metric."}]}}}}}},"400":{"description":"**HTTP Status Code:** `400` <br>\n Bad Request \n\n **Error Code:** `400` <br>\n This API is only available for ZMP and Business or higher accounts that have enabled the Dashboard feature. <br>\n"},"401":{"description":"**HTTP Status Code:** `401` <br>\n Unauthorized \n\n "},"403":{"description":"**HTTP Status Code:** `403` <br>\n Forbidden \n\n "},"404":{"description":"**HTTP Status Code:** `404` <br>\n Not Found \n\n **Error Code:** `3001` <br>\n Range type is invalid. <br>\n"},"429":{"description":"**HTTP Status Code:** `429` <br>\n Too Many Requests. For more information, see [rate limits](https://developers.zoom.us/docs/api/rate-limits/). \n\n "}},"security":[{"openapi_authorization":[]}],"x-extensions":{"x-permissions":["DashboardAIC:Read"],"x-macro-scopes":["dashboard:master"],"x-granular-scopes":["dashboard:read:aic_roi_kpi:master"]}}},"/accounts/{accountId}/metrics/aic/roi/meeting_summary_usage":{"get":{"tags":["Dashboards"],"summary":"Get AIC ROI meeting summary usage","description":"Get AIC ROI meeting summary usage data. 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  * A Business plan or higher.\n\n\n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `dashboard:master`\n\n**[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `dashboard:read:aic_roi_meeting_summary_usage:master`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `HEAVY`","operationId":"dashboardMeetingSummaryUsage","parameters":[{"name":"group_id","in":"query","description":"The group ID. To get a group ID, use the [**List groups**](https://developers.zoom.us/docs/api/rest/reference/scim-api/methods/#operation/groupSCIM2List) API. Participants are filtered according to their primary group.\n\n**Note:** You can search multiple groups. When searching for multiple items, separate them with commas. The maximum number of group IDs is 7.","required":false,"schema":{"type":"string","example":"TaVA8QKik_1233,TaVA8QKik_1234,TaVA8QKik_1235"}},{"name":"dept","in":"query","description":"The department of the host.","required":false,"schema":{"type":"string","example":"HR"}},{"name":"host_saving_factor","in":"query","description":"The average number of seconds the meeting host saves per meeting minute by using AI Companion summaries.","required":false,"schema":{"type":"number","example":60.1}},{"name":"participant_saving_factor","in":"query","description":"The average number of seconds participants save per meeting minute by using AI Companion notes.","required":false,"schema":{"type":"number","example":60}},{"name":"benefiting_meetings_percent","in":"query","description":"The percentage of total meetings that benefit from AI Companion summaries.","required":false,"schema":{"type":"number","example":80.1}},{"name":"from","in":"query","description":"The start date in `yyyy-MM-dd HH:mm:ss` or `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's worth of data at a time.","required":true,"schema":{"type":"string","format":"date","example":"2026-04-20"}},{"name":"to","in":"query","description":"The end date in `yyyy-MM-dd HH:mm:ss` or `yyyy-MM-dd` format.","required":true,"schema":{"type":"string","format":"date","example":"2026-04-27"}},{"name":"page_size","in":"query","description":"The number of records returned within a single API call.","required":false,"schema":{"maximum":300,"type":"integer","example":30,"default":30}},{"name":"next_page_token","in":"query","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.","required":false,"schema":{"type":"string","example":"IAfJX3jsOLW7w3dokmFl84zOa0MAVGyMEB2"}},{"name":"accountId","in":"path","description":"Unique identifier of the account.","required":true,"schema":{"type":"string","example":"TQTvjT52Tmi_wrhASNNOEw"}}],"responses":{"200":{"description":"**HTTP Status Code:** `200`  \n \nMeeting summary usage returned.","content":{"application/json":{"schema":{"type":"object","properties":{"from":{"type":"string","description":"The inputted `from` parameter value, in `yyyy-MM-dd HH:mm:ss` or `yyyy-MM-dd` format.","format":"date","example":"2026-04-20"},"to":{"type":"string","description":"The inputted `to` parameter value, in `yyyy-MM-dd HH:mm:ss` or `yyyy-MM-dd` format.","format":"date","example":"2026-04-27"},"next_page_token":{"type":"string","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.","example":"Tva2CuIdTgsv8wAnhyAdU3m06Y2HuLQtlh3"},"page_size":{"type":"integer","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":79},"meeting_summary_usage":{"type":"array","description":"An array of meeting summary usage objects.","items":{"type":"object","properties":{"id":{"type":"integer","description":"The [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","example":92065052482},"meeting_minutes":{"type":"integer","description":"The total minutes of the meeting.","example":1},"participants":{"type":"integer","description":"The number of meeting participants.","example":1},"is_summary_created":{"type":"boolean","description":"Whether a meeting summary was created.","example":true},"is_summary_shared":{"type":"boolean","description":"Whether the summary was shared with participants.","example":true},"host_savings_minutes":{"type":"integer","description":"The number of minutes saved by the host.","example":1},"participant_savings_minutes":{"type":"integer","description":"The number of minutes saved by the participants.","example":0},"unrealized_host_minutes":{"type":"integer","description":"The number of unrealized minutes for the host.","example":0},"unrealized_participant_minutes":{"type":"integer","description":"The number of unrealized minutes for the participants.","example":0},"unique_summary_viewers":{"type":"integer","description":"The number of unique viewers who accessed the summary.","example":0}}}}}}}}},"400":{"description":"**HTTP Status Code:** `400` <br>\n Bad Request  \n\n **Error Code:** `400` <br>\n This API is only available for ZMP and Business or higher accounts that have enabled the Dashboard feature. <br>\n"},"401":{"description":"**HTTP Status Code:** `401` <br>\n Unauthorized  \n\n "},"403":{"description":"**HTTP Status Code:** `403` <br>\n Forbidden  \n\n "},"429":{"description":"**HTTP Status Code:** `429` <br>\n Too Many Requests. For more information, see [rate limits](https://developers.zoom.us/docs/api/rate-limits/). \n\n "}},"security":[{"openapi_authorization":[]}],"x-extensions":{"x-permissions":["DashboardAIC:Read"],"x-macro-scopes":["dashboard:master"],"x-granular-scopes":["dashboard:read:aic_roi_meeting_summary_usage:master"]}}},"/accounts/{accountId}/metrics/chat":{"get":{"tags":["Dashboards"],"summary":"Get chat metrics","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&gt; **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**Prerequisites:**\n\n* Business or a higher plan\n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `dashboard_im:read:master`,`dashboard:master`\n\n**[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `dashboard:read:chat:master`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Resource-intensive`","operationId":"dashboardChat","parameters":[{"name":"from","in":"query","description":"Start date in 'yyyy-mm-dd' format. The date range defined by the &quot;from&quot; and &quot;to&quot; parameters should only be one month as the report includes only one month worth of data at once.","required":true,"schema":{"type":"string","format":"date","example":"2022-01-01"}},{"name":"to","in":"query","description":"End date.","required":true,"schema":{"type":"string","format":"date","example":"2022-01-28"}},{"name":"page_size","in":"query","description":"The number of records returned within a single API call.","required":false,"schema":{"maximum":300,"type":"integer","example":30,"default":30}},{"name":"next_page_token","in":"query","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.","required":false,"schema":{"type":"string","example":"IAfJX3jsOLW7w3dokmFl84zOa0MAVGyMEB2"}},{"name":"accountId","in":"path","description":"Unique identifier of the account.","required":true,"schema":{"type":"string","example":"TQTvjT52Tmi_wrhASNNOEw"}}],"responses":{"200":{"description":"**HTTP Status Code:** `200`  \n \nChat details returned.  \n \nOnly available for paid accounts that have enabled the dashboard feature.","content":{"application/json":{"schema":{"allOf":[{"type":"object","properties":{"from":{"type":"string","description":"The report's start date.","format":"date","example":"2022-04-06"},"next_page_token":{"type":"string","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.","example":"LkbB9n92siRxgYkffZ8KhApZCQMZpNrN0d2"},"page_size":{"maximum":300,"type":"integer","description":"The number of records to return within a single API call.","example":30,"default":30},"to":{"type":"string","description":"The report's end date.","format":"date","example":"2022-04-07"}}},{"type":"object","properties":{"users":{"type":"array","items":{"type":"object","properties":{"audio_sent":{"type":"integer","description":"The user's total number of audio files sent.","example":0},"code_sippet_sent":{"type":"integer","description":"The user's total number of code snippets sent.","example":0},"email":{"type":"string","description":"The user's email address.","format":"email","example":"user@example.com"},"files_sent":{"type":"integer","description":"The user's total number of files sent.","example":0},"giphys_sent":{"type":"integer","description":"The user's total number of [GIPHY](https://giphy.com/) images sent.","example":0},"group_sent":{"type":"integer","description":"The user's total number of messages sent in Zoom Chat channels.","example":0},"images_sent":{"type":"integer","description":"The user's total number of images sent.","example":0},"p2p_sent":{"type":"integer","description":"The user's total number of peer-to-peer (P2P) chat messages sent.","example":0},"text_sent":{"type":"integer","description":"The user's total number of text messages sent.","example":0},"total_sent":{"type":"integer","description":"The user's total number of messages sent.","example":0},"user_id":{"type":"string","description":"The user's ID.","example":"-0hwjTHMR9uteSRrygQXMA"},"user_name":{"type":"string","description":"The user's display name.","example":"jchill"},"video_sent":{"type":"integer","description":"The user's total number of video files sent.","example":0}}}}}}]}}}},"429":{"description":"**HTTP Status Code:** `429` <br>\n Too Many Requests. For more information, see [rate limits](https://developers.zoom.us/docs/api/rest/rate-limits/). \n\n "}},"security":[{"openapi_authorization":[]}],"x-extensions":{"x-permissions":["DashboardIM:Read"],"x-macro-scopes":["dashboard_im:read:master","dashboard:master"],"x-granular-scopes":["dashboard:read:chat:master"]}}},"/accounts/{accountId}/metrics/client/feedback":{"get":{"tags":["Dashboards"],"summary":"List Zoom meetings client feedback","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**Prerequisites:** \n* A Business or higher account. \n* The &quot;[**Feedback to Zoom**](https://support.zoom.us/hc/en-us/articles/115005838023)&quot; option enabled.\n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `dashboard:read:master`,`dashboard:master`\n\n**[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `dashboard:read:list_meetings_feedback:master`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Heavy`","operationId":"dashboardClientFeedback","parameters":[{"name":"from","in":"query","description":"Start date in 'yyyy-mm-dd' format. The date range defined by the &quot;from&quot; and &quot;to&quot; parameters should only be one month as the report includes only one month worth of data at once.","required":true,"schema":{"type":"string","format":"date","example":"2022-01-01"}},{"name":"to","in":"query","description":"End date.","required":true,"schema":{"type":"string","format":"date","example":"2022-01-28"}},{"name":"accountId","in":"path","description":"Unique identifier of the account.","required":true,"schema":{"type":"string","example":"TQTvjT52Tmi_wrhASNNOEw"}}],"responses":{"200":{"description":"**HTTP Status Code:** `200`  \n \nClient Feedback details returned.","content":{"application/json":{"schema":{"type":"object","properties":{"client_feedbacks":{"type":"array","items":{"type":"object","properties":{"feedback_id":{"type":"string","description":"Feedback Id","example":"1"},"feedback_name":{"type":"string","description":"Feedback Name","example":"Others"},"participants_count":{"type":"integer","description":"The number of participants that upvoted the feedback.","example":0}}}},"from":{"type":"string","description":"Start date for this report","format":"date","example":"2022-01-01"},"to":{"type":"string","description":"End date for this report","format":"date","example":"2022-01-30"},"total_records":{"type":"integer","description":"The number of all records available across pages","example":10}}}}}},"429":{"description":"**HTTP Status Code:** `429` <br>\n Too Many Requests. For more information, see [rate limits](https://developers.zoom.us/docs/api/rest/rate-limits/). \n\n "}},"security":[{"openapi_authorization":[]}],"x-extensions":{"x-permissions":["DashboardHome:Read"],"x-macro-scopes":["dashboard:read:master","dashboard:master"],"x-granular-scopes":["dashboard:read:list_meetings_feedback:master"]}}},"/accounts/{accountId}/metrics/client/feedback/{feedbackId}":{"get":{"tags":["Dashboards"],"summary":"Get zoom meetings client feedback","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).   \n  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\n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `dashboard:read:master`,`dashboard:master`\n\n**[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `dashboard:read:meeting_feedback:master`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Heavy`","operationId":"dashboardClientFeedbackDetail","parameters":[{"name":"feedbackId","in":"path","description":"Feedback Detail Id","required":true,"schema":{"type":"string","example":"1"}},{"name":"from","in":"query","required":false,"schema":{"type":"string","format":"date","example":"2022-01-01"}},{"name":"to","in":"query","required":false,"schema":{"type":"string","format":"date","example":"2022-01-30"}},{"name":"page_size","in":"query","required":false,"schema":{"type":"integer","example":30,"default":30}},{"name":"next_page_token","in":"query","required":false,"schema":{"type":"string","example":"uBTK3NzNksdkuCUAQaFVFd86kyOr59zg4U2"}},{"name":"accountId","in":"path","description":"Unique identifier of the account.","required":true,"schema":{"type":"string","example":"TQTvjT52Tmi_wrhASNNOEw"}}],"responses":{"200":{"description":"**HTTP Status Code:** `200`  \n \nClient Feedback details returned","content":{"application/json":{"schema":{"allOf":[{"type":"object","properties":{"from":{"type":"string","description":"Start date for this report","format":"date","example":"2022-01-01"},"to":{"type":"string","description":"End date for this report","format":"date","example":"2022-01-30"}}},{"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 the available result list exceeds the page size. The expiration period is 15 minutes.","example":"uBTK3NzNksdkuCUAQaFVFd86kyOr59zg4U2"},"page_size":{"maximum":300,"type":"integer","description":"The amount of records returns within a single API call. ","example":30,"default":30}},"description":"Pagination object."},{"type":"object","properties":{"client_feedback_details":{"type":"array","items":{"type":"object","properties":{"email":{"type":"string","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.","example":"user@example.com"},"meeting_id":{"type":"string","description":"Meeting ID","example":"99525891193"},"participant_name":{"type":"string","description":"Participant Name","example":"jchill"},"time":{"type":"string","description":"Time at which the feedback was submitted by the participant.","format":"date-time","example":"2022-01-19T07:34:09Z"}}}}}}]}}}},"429":{"description":"**HTTP Status Code:** `429` <br>\n Too Many Requests. For more information, see [rate limits](https://developers.zoom.us/docs/api/rest/rate-limits/). \n\n "}},"security":[{"openapi_authorization":[]}],"x-extensions":{"x-permissions":["DashboardHome:Read"],"x-macro-scopes":["dashboard:read:master","dashboard:master"],"x-granular-scopes":["dashboard:read:meeting_feedback:master"]}}},"/accounts/{accountId}/metrics/client/satisfaction":{"get":{"tags":["Dashboards"],"summary":"List client meeting satisfaction","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.  \n \n\n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `dashboard:read:master`,`dashboard:master`\n\n**[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `dashboard:read:meeting_survey:master`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Heavy`","operationId":"listMeetingSatisfaction","parameters":[{"name":"from","in":"query","description":"The start date for the query in &ldquo;yyyy-mm-dd&rdquo; format. ","required":false,"schema":{"type":"string","format":"date","example":"2022-01-01"}},{"name":"to","in":"query","description":"The end date for the query in &ldquo;yyyy-mm-dd&rdquo; format. ","required":false,"schema":{"type":"string","format":"date","example":"2022-01-30"}},{"name":"accountId","in":"path","description":"Unique identifier of the account.","required":true,"schema":{"type":"string","example":"TQTvjT52Tmi_wrhASNNOEw"}}],"responses":{"200":{"description":"**HTTP Status Code:** `200`  \n \nClient satisfaction data returned. ","content":{"application/json":{"schema":{"type":"object","properties":{"client_satisfaction":{"type":"array","items":{"type":"object","properties":{"date":{"type":"string","description":"Date of the report.","format":"date","example":"2022-01-01"},"good_count":{"type":"integer","description":"The total number of &quot;thumbs up&quot; received for this meeting.","example":0},"none_count":{"type":"integer","description":"The total number of attendees who didn't submit any response (neither thumbs up nor thumbs down).","example":0},"not_good_count":{"type":"integer","description":"The total number of &quot;thumbs down&quot; received for this meeting.","example":0},"satisfaction_percent":{"type":"number","description":"Satisfaction Percentage.\nThe satisfaction percentage is calculated as `(good_count + none_count)` / `total_count`.","format":"double","example":100}}}},"from":{"type":"string","description":"Start date for this report in 'yyyy-mm-dd' format.","format":"date","example":"2022-01-01"},"to":{"type":"string","description":"End date for this report in 'yyyy-mm-dd' format.","format":"date","example":"2022-01-30"},"total_records":{"type":"integer","description":"The total number of records available across all pages.","example":30}}}}}},"429":{"description":"**HTTP Status Code:** `429` <br>\n Too Many Requests. For more information, see [rate limits](https://developers.zoom.us/docs/api/rest/rate-limits/). \n\n "}},"security":[{"openapi_authorization":[]}],"x-extensions":{"x-permissions":[],"x-macro-scopes":["dashboard:read:master","dashboard:master"],"x-granular-scopes":["dashboard:read:meeting_survey:master"]}}},"/accounts/{accountId}/metrics/client_versions":{"get":{"tags":["Dashboards"],"summary":"List the client versions","description":"Use this API to list all the client versions and its count. \n\n **Prerequisites:** \n* A Business or a higher plan.\n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `dashboard:read:master`,`dashboard:master`\n\n**[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `dashboard:read:client_versions:master`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Heavy`","operationId":"getClientVersions","parameters":[{"name":"accountId","in":"path","description":"Unique identifier of the account.","required":true,"schema":{"type":"string","example":"TQTvjT52Tmi_wrhASNNOEw"}}],"responses":{"200":{"description":"**HTTP Status Code:** `200`   \n \nThe client versions returned successfully.  \n \nOnly available for paid accounts that have enabled the Dashboard feature.","content":{"application/json":{"schema":{"type":"object","properties":{"client_versions":{"type":"array","description":"List of the client versions.","items":{"type":"object","properties":{"client_version":{"type":"string","description":"The client version","example":"win_5.1.1697.0821"},"total_count":{"type":"integer","description":"The total count of the client version","example":10}}}}}}}}},"429":{"description":"**HTTP Status Code:** `429` <br>\n Too Many Requests. For more information, see [rate limits](https://developers.zoom.us/docs/api/rest/rate-limits/). \n\n "}},"security":[{"openapi_authorization":[]}],"x-extensions":{"x-permissions":[],"x-macro-scopes":["dashboard:read:master","dashboard:master"],"x-granular-scopes":["dashboard:read:client_versions:master"]}}},"/accounts/{accountId}/metrics/crc":{"get":{"tags":["Dashboards"],"summary":"Get CRC port usage","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. &lt;aside class='notice'&gt;We will provide the report for a maximum of one month. For example, if &quot;from&quot; is set to &quot;2017-08-05&quot; and &quot;to&quot; is set to &quot;2017-10-10&quot;, we will adjust &quot;from&quot; to &quot;2017-09-10&quot;.&lt;/aside&gt;  \n   \n \n**Prerequisites:**  \n \n* Business, Education or API Plan.\n* Room Connector must be enabled on the account.  \n   \n \n\n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `dashboard_crc:read:master`,`dashboard:master`\n\n**[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `dashboard:read:crc_port_usage:master`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Heavy`","operationId":"dashboardCRC","parameters":[{"name":"from","in":"query","description":"Start date in 'yyyy-mm-dd' format. The date range defined by the &quot;from&quot; and &quot;to&quot; parameters should only be one month as the report includes only one month worth of data at once.","required":true,"schema":{"type":"string","format":"date","example":"2022-01-01"}},{"name":"to","in":"query","description":"End date.","required":true,"schema":{"type":"string","format":"date","example":"2022-01-28"}},{"name":"accountId","in":"path","description":"Unique identifier of the account.","required":true,"schema":{"type":"string","example":"TQTvjT52Tmi_wrhASNNOEw"}}],"responses":{"200":{"description":"**HTTP Status Code:** `200`  \n \nCRC usage returned.  \n \nOnly available for paid accounts that have enabled the Dashboard feature.","content":{"application/json":{"schema":{"type":"object","allOf":[{"type":"object","properties":{"from":{"type":"string","description":"Start date for this report.","format":"date","example":"2022-03-01"},"to":{"type":"string","description":"End date for this report.","format":"date","example":"2022-03-30"}}},{"type":"object","properties":{"crc_ports_usage":{"type":"array","items":{"type":"object","properties":{"crc_ports_hour_usage":{"type":"array","items":{"type":"object","properties":{"hour":{"type":"string","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.","example":"00"},"max_usage":{"type":"integer","description":"The maximum number of concurrent ports that are being used in that hour.","example":0},"total_usage":{"type":"integer","description":"The total number of H.323/SIP connections in that hour.","example":0}}}},"date_time":{"type":"string","description":"The date and time of the port usage.","format":"date","example":"2022-03-01"}}}}}}]}}}},"429":{"description":"**HTTP Status Code:** `429` <br>\n Too Many Requests. For more information, see [rate limits](https://developers.zoom.us/docs/api/rest/rate-limits/). \n\n "}},"security":[{"openapi_authorization":[]}],"x-extensions":{"x-permissions":["DashboardCRC:Read"],"x-macro-scopes":["dashboard_crc:read:master","dashboard:master"],"x-granular-scopes":["dashboard:read:crc_port_usage:master"]}}},"/accounts/{accountId}/metrics/issues/zoomrooms":{"get":{"tags":["Dashboards"],"summary":"Get top 25 Zoom Rooms with issues","description":"Get information on top 25 Zoom Rooms with issues in a month. The month specified with the &quot;from&quot; and &quot;to&quot; range should fall within the last six months.  \n \n**Prerequisites:**  \n \n* Business or a higher plan.\n* Zoom Room must be enabled in the account.\n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `dashboard:read:master`,`dashboard:master`\n\n**[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `dashboard:read:list_zoomrooms:master`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Heavy`","operationId":"dashboardIssueZoomRoom","parameters":[{"name":"from","in":"query","description":"Start date in 'yyyy-mm-dd' format. The date range defined by the &quot;from&quot; and &quot;to&quot; parameters should only be one month as the report includes only one month worth of data at once.","required":true,"schema":{"type":"string","format":"date","example":"2022-01-01"}},{"name":"to","in":"query","description":"End date.","required":true,"schema":{"type":"string","format":"date","example":"2022-01-28"}},{"name":"accountId","in":"path","description":"Unique identifier of the account.","required":true,"schema":{"type":"string","example":"TQTvjT52Tmi_wrhASNNOEw"}}],"responses":{"200":{"description":"**HTTP Status Code:** `200`  \n \nZoom Room with issue details returned","content":{"application/json":{"schema":{"allOf":[{"type":"object","properties":{"from":{"type":"string","description":"Start date for this report","format":"date","example":"2022-01-01"},"to":{"type":"string","description":"End date for this report","format":"date","example":"2022-01-30"},"total_records":{"type":"integer","description":"The number of all records available across pages","example":30}}},{"type":"object","properties":{"zoom_rooms":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"Zoom Room ID","example":"NHwIXQQ2Ro-fJ13cxj_fuQ"},"issues_count":{"type":"integer","description":"Issue Count of Zoom Room","example":12},"room_name":{"type":"string","description":"Zoom Room Name","example":"jchill room"}}}}}}]}}}},"429":{"description":"**HTTP Status Code:** `429` <br>\n Too Many Requests. For more information, see [rate limits](https://developers.zoom.us/docs/api/rest/rate-limits/). \n\n "}},"security":[{"openapi_authorization":[]}],"x-extensions":{"x-permissions":["DashboardHome:Read"],"x-macro-scopes":["dashboard:read:master","dashboard:master"],"x-granular-scopes":["dashboard:read:list_zoomrooms:master"]}}},"/accounts/{accountId}/metrics/issues/zoomrooms/{zoomroomId}":{"get":{"tags":["Dashboards"],"summary":"Get issues of Zoom Rooms","description":"Use this API to return information about the Zoom Rooms in an account with issues, such as disconnected hardware or bandwidth issues. 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* A Business or a higher plan. \n* A Zoom Room must be enabled in the account.\n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `dashboard:read:master`,`dashboard:master`\n\n**[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `dashboard:read:issues_zoomroom:master`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Heavy`","operationId":"dashboardIssueDetailZoomRoom","parameters":[{"name":"zoomroomId","in":"path","description":"The Zoom room ID.","required":true,"schema":{"type":"string","example":"azGzXIVUTWOdEQB79aNHkA"}},{"name":"from","in":"query","description":"Start date in 'yyyy-mm-dd' format. The date range defined by the &quot;from&quot; and &quot;to&quot; parameters should only be one month as the report includes only one month worth of data at once.","required":true,"schema":{"type":"string","format":"date","example":"2022-01-01"}},{"name":"to","in":"query","description":"End date.","required":true,"schema":{"type":"string","format":"date","example":"2022-01-28"}},{"name":"page_size","in":"query","description":"The number of records returned within a single API call.","required":false,"schema":{"maximum":300,"type":"integer","example":30,"default":30}},{"name":"next_page_token","in":"query","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.","required":false,"schema":{"type":"string","example":"IAfJX3jsOLW7w3dokmFl84zOa0MAVGyMEB2"}},{"name":"accountId","in":"path","description":"Unique identifier of the account.","required":true,"schema":{"type":"string","example":"TQTvjT52Tmi_wrhASNNOEw"}}],"responses":{"200":{"description":"**HTTP Status Code:** `200`  \n \nZoom Room with issue details returned","content":{"application/json":{"schema":{"allOf":[{"type":"object","properties":{"from":{"type":"string","description":"Start date for this report","format":"date","example":"2022-02-01"},"to":{"type":"string","description":"End date for this report","format":"date","example":"2022-02-28"}}},{"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":"Tva2CuIdTgsv8wAnhyAdU3m06Y2HuLQtlh3"},"page_count":{"type":"integer","description":"The number of pages returned for the request made.","example":1},"page_size":{"maximum":300,"type":"integer","description":"The number of records returned within a single API call.","example":30,"default":30},"total_records":{"type":"integer","description":"The number of all records available across pages.","example":1}},"description":"Pagination object."},{"type":"object","properties":{"issue_details":{"type":"array","items":{"type":"object","properties":{"issue":{"type":"string","description":"Zoom Room Issue Detail.  \n  The value of the this field could be one of the following:  \n \n* `Room Controller disconnected`  \n \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 online`\n* `High CPU usage is detected`\n* `Low bandwidth network is detected`\n* `{name} battery is low`\n* `{name} battery is normal`\n* `{name} disconnected`\n* `{name} connected`\n* `{name} is not charging`\n\nPossible values for {name}:   \n \n* Zoom Rooms Computer \n* Controller\n* Scheduling Display","example":"Untrusted certificate is detected"},"time":{"type":"string","description":"Time at which the issue was encountered.","format":"date-time","example":"2022-02-27T08:37:05Z"}}}}}}]}}}},"429":{"description":"**HTTP Status Code:** `429` <br>\n Too Many Requests. For more information, see [rate limits](https://developers.zoom.us/docs/api/rest/rate-limits/). \n\n "}},"security":[{"openapi_authorization":[]}],"x-extensions":{"x-permissions":["DashboardHome:Read"],"x-macro-scopes":["dashboard:read:master","dashboard:master"],"x-granular-scopes":["dashboard:read:issues_zoomroom:master"]}}},"/accounts/{accountId}/metrics/meetings":{"get":{"tags":["Dashboards"],"summary":"List meetings","description":"Lists the total live or past meetings that occurred during a specified period of time. \n\nThis overview shows if features such as audio, video, screen sharing, and recording were being used in the meeting. \n\nYou can also see the license types of each user on your account. 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 a higher plan.\n\n**[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `dashboard:read:list_meetings:master`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `RESOURCE-INTENSIVE`","operationId":"dashboardMeetings","parameters":[{"name":"type","in":"query","description":"A value to get the response for the corresponding meeting type.  \n \n `past` - Meetings that already occurred in the specified date range.  \n `pastOne` - Past meetings that were attended by only one user.   \n `live` - Live meetings.  \n   \n \n\nIf you do not provide this field, the default value will be `live` and the API will only query responses for live meetings.","required":false,"schema":{"type":"string","example":"past","default":"live","enum":["past","pastOne","live"]}},{"name":"from","in":"query","description":"The start date in 'yyyy-MM-dd HH:mm:ss' or '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.","required":true,"schema":{"type":"string","example":"2023-06-01 01:00:00"}},{"name":"to","in":"query","description":"The end date 'yyyy-MM-dd HH:mm:ss' or 'yyyy-MM-dd' format.","required":true,"schema":{"type":"string","example":"2023-06-06 06:00:00"}},{"name":"page_size","in":"query","description":"The number of records returned within a single API call.","required":false,"schema":{"maximum":300,"type":"integer","example":30,"default":30}},{"name":"next_page_token","in":"query","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.","required":false,"schema":{"type":"string","example":"IAfJX3jsOLW7w3dokmFl84zOa0MAVGyMEB2"}},{"name":"group_id","in":"query","description":"The group ID. To get a group ID, use the [**List groups**](https://developers.zoom.us/docs/api/rest/reference/scim-api/methods/#operation/groupSCIM2List) API.  Participants would be filtered according to their primary group. \n\n **Note:** The API response will only contain meetings where the host is a member of the queried group ID if the &quot;group_include_participant&quot; is false. \nAllow to search multiple groups, when searching multiple items, separate them with commas.\nThe maximum size of groupids is 7","required":false,"schema":{"type":"string","example":"TaVA8QKik_1233,TaVA8QKik_1234,TaVA8QKik_1235"}},{"name":"group_include_participant","in":"query","description":"Whether the response will contain meetings where the participant is a member of the queried group ID.","required":false,"schema":{"type":"boolean","example":true}},{"name":"include_fields","in":"query","description":"Sets the value of this field to `tracking_fields` if you want to include tracking fields of each meeting in the response.","required":false,"schema":{"type":"string","example":"tracking_fields","enum":["tracking_fields"]}},{"name":"query_date_type","in":"query","description":"The type of date to query. This field is only supported when `type` is `past`. \n* `start_time` - Query by call start time. \n* `end_time` - Query by call end time. \n\nThis value defaults to `start_time`.","required":false,"schema":{"type":"string","example":"end_time","enum":["start_time","end_time"]}},{"name":"accountId","in":"path","description":"Unique identifier of the account.","required":true,"schema":{"type":"string","example":"TQTvjT52Tmi_wrhASNNOEw"}}],"responses":{"200":{"description":"**HTTP Status Code:** `200`  \n \nMeetings returned.  \n \nThis API is only available for ZMP and Business or higher accounts that have enabled the Dashboard feature.","content":{"application/json":{"schema":{"allOf":[{"type":"object","properties":{"from":{"type":"string","description":"The inputted 'from' parameter format, in 'yyyy-MM-dd HH:mm:ss' or 'yyyy-MM-dd' format.","format":"date","example":"2022-04-01"},"to":{"type":"string","description":"The inputted 'to' parameter format, in 'yyyy-MM-dd HH:mm:ss' or 'yyyy-MM-dd' format.","format":"date","example":"2022-04-07"}}},{"type":"object","properties":{"next_page_token":{"type":"string","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.","example":"Tva2CuIdTgsv8wAnhyAdU3m06Y2HuLQtlh3"},"page_count":{"type":"integer","description":"The number of pages returned for the request made.","example":1},"page_size":{"maximum":300,"type":"integer","description":"The number of records returned within a single API call.","example":30,"default":30},"total_records":{"type":"integer","description":"The number of all records available across pages.","example":1}},"description":"The pagination object."},{"type":"object","properties":{"meetings":{"type":"array","description":"An array of meeting objects.","items":{"type":"object","properties":{"host":{"type":"string","description":"The host's display name.","example":"Jill Chill"},"audio_quality":{"type":"string","description":"The meeting's [audio quality score](https://support.zoom.us/hc/en-us/articles/360061244651-Using-meeting-quality-scores-and-network-alerts). \n* `good` &mdash; The audio is almost flawless and the quality is excellent. \n* `fair` - The audio occasionally has distortion, noise, and other problems, but the content is basically continuous. Participants can communicate normally. \n* `poor` - The audio often has distortion, noise, and other problems, but the content is basically continuous. Participants can communicate normally. \n* `bad` - The sound quality is extremely poor and the audio content is almost inaudible.","example":"good","enum":["good","fair","poor","bad"]},"custom_keys":{"type":"array","description":"The custom keys and values assigned to the meeting.","items":{"type":"object","properties":{"key":{"maxLength":64,"type":"string","description":"The custom key associated with the meeting.","example":"Host Nation"},"value":{"maxLength":256,"type":"string","description":"The value of the custom key associated with the meeting.","example":"US"}}}},"dept":{"type":"string","description":"The host's department.","example":"Developers"},"duration":{"type":"string","description":"The meeting duration, formatted as `hh:mm:ss`. Example: `16:08` for 16 minutes and 8 seconds.","example":"00:56"},"email":{"type":"string","description":"The host's email address.","example":"jchill@example.com"},"end_time":{"type":"string","description":"The meeting's end time.","format":"date-time","nullable":true,"example":"2022-01-04T07:50:47Z"},"has_3rd_party_audio":{"type":"boolean","description":"Whether or not [third party audio](https://support.zoom.us/hc/en-us/articles/202470795-3rd-Party-Audio-Conference) was used in the meeting.","example":true},"has_archiving":{"type":"boolean","description":"Whether the archiving feature was used in the meeting.","example":true},"has_pstn":{"type":"boolean","description":"Whether or not the PSTN was used in the meeting.","example":true},"has_recording":{"type":"boolean","description":"Whether or not the recording feature was used in the meeting. ","example":true},"has_screen_share":{"type":"boolean","description":"Whether or not screenshare feature was used in the meeting.","example":true},"has_sip":{"type":"boolean","description":"Whether or not someone joined the meeting using SIP.","example":true},"has_video":{"type":"boolean","description":"Whether or not video was used in the meeting.","example":true},"has_voip":{"type":"boolean","description":"Whether or not VoIP was used in the meeting.","example":true},"has_manual_captions":{"type":"boolean","description":"Whether a manual caption was enabled in the meeting.","example":true},"has_automated_captions":{"type":"boolean","description":"Whether an automated caption was enabled in the meeting.","example":true},"id":{"type":"integer","description":"The [meeting ID](https://support.zoom.us/hc/en-us/articles/201362373-What-is-a-Meeting-ID-): Unique identifier of the meeting in &quot;**long**&quot; format(represented as int64 data type in JSON), also known as the meeting number.","format":"int64","example":93201235621},"participants":{"type":"integer","description":"The meeting participant count.","example":2},"screen_share_quality":{"type":"string","description":"The meeting's [screen share quality score](https://support.zoom.us/hc/en-us/articles/360061244651-Using-meeting-quality-scores-and-network-alerts). \n* `good` - The video is almost flawless and the quality is excellent. \n* `fair` - The video definition is high, occasionally gets stuck, fast or slow, or other problems, but the frequency is very low and the video quality is good. \n* `poor` - The video definition is not high, but not many problems exist. The video quality is mediocre. \n* `bad` - The picture is very blurred and often gets stuck.","example":"good","enum":["good","fair","poor","bad"]},"session_key":{"type":"string","description":"The Video SDK custom session ID.","example":"ABC36jaBI145"},"start_time":{"type":"string","description":"The meeting start time.","format":"date-time","example":"2022-01-04T08:04:27Z"},"topic":{"type":"string","description":"The meeting topic.","example":"Share Now"},"tracking_fields":{"type":"array","description":"The tracking fields and values assigned to the meeting.","items":{"type":"object","properties":{"field":{"maxLength":64,"type":"string","description":"The label of the tracking field.","example":"Meeting purpose."},"value":{"maxLength":256,"type":"string","description":"The value of the tracking field.","example":"Support"}}}},"user_type":{"type":"string","description":"The user's license type.","example":"Licensed"},"uuid":{"type":"string","description":"The meeting unique universal identifier (UUID). Double encode your UUID when using it for API calls if the UUID begins with a '/'or contains '//' in it.","example":"gm8s9L+PTEC+FG3sFbd1Cw=="},"video_quality":{"type":"string","description":"The meeting's [video quality score](https://support.zoom.us/hc/en-us/articles/360061244651-Using-meeting-quality-scores-and-network-alerts). \n* `good` - The video is almost flawless and the quality is excellent. \n* `fair` - The video definition is high, occasionally gets stuck, fast or slow, or other problems, but the frequency is very low and the video quality is good. \n* `poor` - The video definition is not high, but not many problems exist. The video quality is mediocre. \n* `bad` - The picture is very blurred and often gets stuck.","example":"good","enum":["good","fair","poor","bad"]},"has_poll":{"type":"boolean","description":"Whether or not poll was used in the meeting.","example":false},"has_qa":{"type":"boolean","description":"Whether or not qa was used in the meeting.","example":false},"has_survey":{"type":"boolean","description":"Whether or not survey was used in the meeting.","example":false},"avg_jointime_cost":{"type":"number","description":"the average join meeting time of all participants, the unit is seconds.","example":4.55},"has_external_participant":{"type":"boolean","description":"Whether the meeting has an external participant.","example":true}},"description":"The meeting's metric details."}}}}]}}}},"400":{"description":"**HTTP Status Code:** `400` <br>\n Bad Request  \n\n **Error Code:** `12700` <br>\n This account cannot query meetings by `end_time`. <br>\n**Error Code:** `400` <br>\n This API is only available for ZMP and Business or higher accounts that have enabled the Dashboard feature. <br>\n"},"429":{"description":"**HTTP Status Code:** `429` <br>\n Too Many Requests. For more information, see [rate limits](https://developers.zoom.us/docs/api/rest/rate-limits/). \n\n "}},"security":[{"openapi_authorization":[]}],"x-extensions":{"x-permissions":["DashboardMeetings:Read"],"x-granular-scopes":["dashboard:read:list_meetings:master"]}}},"/accounts/{accountId}/metrics/meetings/{meetingId}":{"get":{"tags":["Dashboards"],"summary":"Get meeting details","description":"Get details on live or past meetings. This overview shows if features such as audio, video, screen sharing, and recording were being used in the meeting. You can also see the license types of each user on your account.  \n 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\n* Business or a higher plan.\n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `dashboard:master`\n\n**[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `dashboard:read:meeting:master`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `HEAVY`","operationId":"dashboardMeetingDetail","parameters":[{"name":"meetingId","in":"path","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](/docs/api/rest/using-zoom-apis/#meeting-id-and-uuid) the meeting UUID before making an API request.","required":true,"schema":{"type":"string","example":"0Uepd5uFQAuAqc9SOtE1zA=="}},{"name":"type","in":"query","description":"The type of meeting to query. \n* `past` &mdash; All past meetings. \n* `pastOne` &mdash; All past one-user meetings. \n* `live` - All live meetings. \n\nThis value defaults to `live`.","required":false,"schema":{"type":"string","example":"past","default":"live","enum":["past","pastOne","live"]}},{"name":"accountId","in":"path","description":"Unique identifier of the account.","required":true,"schema":{"type":"string","example":"TQTvjT52Tmi_wrhASNNOEw"}}],"responses":{"200":{"description":"**HTTP Status Code:** `200`  \n \nMeeting returned.  \n \nOnly available for paid accounts that have enabled the dashboard feature.","content":{"application/json":{"schema":{"title":"Meeting Metrics","type":"object","properties":{"host":{"type":"string","description":"Host display name.","example":"API"},"custom_keys":{"maxItems":10,"type":"array","description":"Custom keys and values assigned to the meeting.","items":{"type":"object","properties":{"key":{"maxLength":64,"type":"string","description":"Custom key associated with the meeting.","example":"Host Nation"},"value":{"maxLength":256,"type":"string","description":"Value of the custom key associated with the meeting.","example":"US"}}}},"dept":{"type":"string","description":"The host's department.","example":"Developers"},"duration":{"type":"string","description":"Meeting duration.","example":"02:21"},"email":{"type":"string","description":"The host's email address.","example":"user@example.com"},"end_time":{"type":"string","description":"Meeting end time.","format":"date-time","example":"2022-03-01T10:17:35Z"},"has_3rd_party_audio":{"type":"boolean","description":"Whether or not [third party audio](https://support.zoom.us/hc/en-us/articles/202470795-3rd-Party-Audio-Conference) was used in the meeting.","example":true},"has_archiving":{"type":"boolean","description":"Whether the archiving feature was used in the meeting.","example":true},"has_pstn":{"type":"boolean","description":"Whether or not the PSTN was used in the meeting.","example":true},"has_recording":{"type":"boolean","description":"Whether or not the recording feature was used in the meeting. ","example":true},"has_screen_share":{"type":"boolean","description":"Whether or not screenshare feature was used in the meeting.","example":true},"has_sip":{"type":"boolean","description":"Whether or not someone joined the meeting using SIP.","example":true},"has_video":{"type":"boolean","description":"Whether or not video was used in the meeting.","example":true},"has_voip":{"type":"boolean","description":"Whether or not VoIP was used in the meeting.","example":true},"has_manual_captions":{"type":"boolean","description":"Whether a manual caption was enabled in the meeting.","example":true},"has_automated_captions":{"type":"boolean","description":"Whether an automated caption was enabled in the meeting.","example":true},"id":{"type":"integer","description":"[Meeting ID](https://support.zoom.us/hc/en-us/articles/201362373-What-is-a-Meeting-ID-): Unique identifier of the meeting in &quot;**long**&quot; format(represented as int64 data type in JSON), also known as the meeting number.","format":"int64","example":575734086},"in_room_participants":{"type":"integer","description":"The number of Zoom Room participants in the meeting.","example":2},"participants":{"type":"integer","description":"Meeting participant count.","example":2},"start_time":{"type":"string","description":"Meeting start time.","format":"date-time","example":"2022-03-01T10:15:14Z"},"topic":{"type":"string","description":"Meeting topic.","example":"API Meeting"},"user_type":{"type":"string","description":"The user's license type.","example":"Licensed"},"uuid":{"type":"string","description":"Meeting UUID. [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.","example":"gaqOKVN9RAaDHKYWEcASXg=="},"has_meeting_summary":{"type":"boolean","description":"Whether the summary feature was used in the meeting.","example":true},"has_aic_conversation":{"type":"boolean","description":"Whether the aic conversation feature was used in the meeting.","example":true},"has_poll":{"type":"boolean","description":"Whether a poll was used in the meeting.","example":true},"has_qa":{"type":"boolean","description":"Whether Q&A was used in the meeting.","example":true},"has_survey":{"type":"boolean","description":"Whether a survey was used in the meeting.","example":false},"avg_jointime_cost":{"type":"number","description":"the average join meeting time of all participants, the unit is seconds.","example":3.98},"has_external_participant":{"type":"boolean","description":"Whether the meeting has an external participant.","example":true}},"description":"Meeting metric details."}}}},"400":{"description":"**HTTP Status Code:** `400` <br>\n Bad Request  \n\n **Error Code:** `12702` <br>\n Cannot access meetings from over one year ago. <br>\n"},"404":{"description":"**HTTP Status Code:** `404` <br>\n Not Found  \n\n **Error Code:** `3001` <br>\n Meeting ID is invalid or the meeting has not ended yet.<br>\nThis meeting's details are not available. <br>\n"},"429":{"description":"**HTTP Status Code:** `429` <br>\n Too Many Requests. For more information, see [rate limits](https://developers.zoom.us/docs/api/rate-limits/). \n\n "}},"security":[{"openapi_authorization":[]}],"x-extensions":{"x-permissions":[],"x-macro-scopes":["dashboard:master"],"x-granular-scopes":["dashboard:read:meeting:master"]}}},"/accounts/{accountId}/metrics/meetings/{meetingId}/participants":{"get":{"tags":["Dashboards"],"summary":"List meeting participants","description":"Return a list of participants from live or past meetings. \n\n If you don't provide the `type` query parameter, the default value is set to the `live` value. This API only returns metrics for participants in a live meeting, if any exist. 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**Note:** \n\nThis API may return empty values for participants' `user_name`, `ip_address`, `location`, and `email` responses when the account calling this API: \n* Is a [**legacy** HIPAA BAA account](https://developers.zoom.us/docs/api/references/legacy-business-associate-agreements/). \n* Displays data for any users who are **not** part of the host's account (external users) unless they meet certain conditions. See [Email address display rules](https://developers.zoom.us/docs/api/using-zoom-apis/#email-address-display-rules) for details. \n\n**Prerequisites:** \n* A Business or higher plan.\n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `dashboard:master`\n\n**[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `dashboard:read:list_meeting_participants:master`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `HEAVY`","operationId":"dashboardMeetingParticipants","parameters":[{"name":"meetingId","in":"path","description":"The meeting's ID or universally unique ID (UUID). \n* If you provide a meeting ID, the API returns 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 the meeting UUID before making an API request.","required":true,"schema":{"type":"string","example":"w7fUhDMLSo25Lfvu/3I+cw=="}},{"name":"type","in":"query","description":"The type of meeting to query. \n* `past` - All past meetings. \n* `pastOne` - All past one-user meetings. \n* `live` - All live meetings. \n\nThis value defaults to `live`.","required":false,"schema":{"type":"string","example":"past","default":"live","enum":["past","pastOne","live"]}},{"name":"page_size","in":"query","description":"The number of records returned within a single API call.","required":false,"schema":{"maximum":300,"type":"integer","example":30,"default":30}},{"name":"next_page_token","in":"query","description":"Use the next page token to paginate through a large set of results. A next page token returns whenever the set of available results exceeds the current page size. The expiration period for this token is 15 minutes.","required":false,"schema":{"type":"string","example":"IAfJX3jsOLW7w3dokmFl84zOa0MAVGyMEB2"}},{"name":"include_fields","in":"query","description":"This field provides `registrant_id` as the value for this field if you would like to see the registrant ID attribute in the response of this API call. \n\nA registrant ID is a unique identifier of a [meeting registrant](/docs/api-reference/zoom-api/methods#operation/meetingRegistrants), which is not supported for `live` meeting types.","required":false,"schema":{"type":"string","example":"registrant_id","enum":["registrant_id"]}},{"name":"accountId","in":"path","description":"Unique identifier of the account.","required":true,"schema":{"type":"string","example":"TQTvjT52Tmi_wrhASNNOEw"}}],"responses":{"200":{"description":"**HTTP Status Code:** `200`  \n \nMeeting participants returned.  \n \nThis API is only available for ZMP and Business or higher accounts that have enabled the Dashboard feature.","content":{"application/json":{"schema":{"allOf":[{"type":"object","properties":{"next_page_token":{"type":"string","description":"Use the next page token to paginate through a large set of results. A next page token returns whenever the set of available results exceeds the current page size. The expiration period for this token is 15 minutes.","example":"Tva2CuIdTgsv8wAnhyAdU3m06Y2HuLQtlh3"},"page_count":{"type":"integer","description":"The number of pages returned for the request made.","example":1},"page_size":{"maximum":300,"type":"integer","description":"The number of records returned within a single API call.","example":30,"default":30},"total_records":{"type":"integer","description":"The number of all records available across pages.","example":1},"meeting_number":{"type":"string","description":"Unique identifier of the meeting in \"long\" format(represented as int64 data type in JSON)","example":"93201235621"}},"description":"Pagination object."},{"type":"object","properties":{"participants":{"type":"array","description":"The information about the meeting participants. If a participant left a meeting and rejoined the same meeting, their information appears as many times as they joined the meeting.","items":{"type":"object","properties":{"audio_quality":{"type":"string","description":"The participant's [audio quality score](https://support.zoom.us/hc/en-us/articles/360061244651-Using-meeting-quality-scores-and-network-alerts). The API only returns this value when the **Meeting quality scores and network alerts on Dashboard** setting is enabled in the Zoom Web Portal and the **Show meeting quality score and network alerts on Dashboard** option is selected in [**Account Settings**](https://zoom.us/account/setting). \n* `good` - The audio is almost flawless and the quality is excellent. \n* `fair` - The audio occasionally has distortion, noise, and other problems, but the content is basically continuous. Participants can communicate normally. \n* `poor` - The audio often has distortion, noise, and other problems, but the content is basically continuous. Participants can communicate normally. \n* `bad` - The sound quality is extremely poor and the audio content is almost inaudible.","example":"good","enum":["","good","fair","poor","bad"]},"camera":{"type":"string","description":"The type of camera that the participant used during the meeting. \n\n**Note:** This response returns an empty string (``) value for any users who are **not** a part of the host's account (external users).","example":"FaceTime HD Camera"},"connection_type":{"type":"string","description":"The participant's connection type.","example":"UDP","enum":["P2P","TCP","UDP","Reliable UDP","SSL","HTTP","TCP+Proxy","UDP+Proxy","Reliable+Proxy","SSL+Proxy","HTTP+Proxy"]},"video_connection_type":{"type":"string","description":"The participant's video connection type.","example":"UDP","enum":["P2P","TCP","UDP","Reliable UDP","SSL","HTTP","TCP+Proxy","UDP+Proxy","Reliable+Proxy","SSL+Proxy","HTTP+Proxy"]},"as_connection_type":{"type":"string","description":"The participant's screen share connection type.","example":"UDP","enum":["P2P","TCP","UDP","Reliable UDP","SSL","HTTP","TCP+Proxy","UDP+Proxy","Reliable+Proxy","SSL+Proxy","HTTP+Proxy"]},"customer_key":{"maxLength":35,"type":"string","description":"The participant's SDK identifier. This value can be alphanumeric, up to a maximum length of 35 characters.","example":"349589LkJyeW"},"data_center":{"type":"string","description":"The data center that the participant is leveraging to join the meeting.","example":"United States (SC Top)"},"device":{"type":"string","description":"The type of device the participant used to join the meeting. \n* `Phone` - The participant joined via PSTN. \n* `H.323/SIP` - The participant joined via an H.323 or SIP device. \n* `Windows` - The participant joined via VoIP using a Windows device. \n* `Mac` - The participant joined via VoIP using a Mac device. \n* `iOS` - The participant joined via VoIP using an iOS device. \n* `Android` - The participant joined via VoIP using an Android device. \n\n**Note:** This response returns an empty string (``) value for any users who are **not** a part of the host's account (external users).","example":"Phone","enum":["Phone","H.323/SIP","Windows","Mac","iOS","Android"]},"domain":{"type":"string","description":"The participant's PC domain. \n\n**Note** This response returns an empty string (``) value for any users who are **not** a part of the host's account (external users).","example":"example.com"},"email":{"type":"string","description":"The participant's email address. 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](/docs/api-reference/using-zoom-apis#email-address) for details.","format":"email","example":"jchill@example.com"},"from_sip_uri":{"type":"string","description":"The meeting participant's SIP From header URI. The API only returns this response when the participant joins a meeting via SIP.","example":"example.com"},"full_data_center":{"type":"string","description":"The data center where participant's meeting data is stored. This field includes a semicolon-separated list of HTTP Tunnel (HT), Cloud Room Connector (CRC), and Real-Time Web Gateway (RWG) location information.","example":"United States (SC Top);"},"harddisk_id":{"type":"string","description":"The participant's hard disk ID. \n\n**Note** This response returns an empty string (``) value for any users who are **not** a part of the host's account (external users).","example":"Disk01"},"id":{"type":"string","description":"The participant's universally unique ID (UUID).\n* If the participant joins the meeting by logging into Zoom, this value is the `id` value in the [**Get a user**](/docs/api-reference/zoom-api/methods#operation/user) API response. \n* If the participant joins the meeting **without** logging into Zoom, this returns an empty string value. \n\n**Note:** Use the `participant_user_id` value instead of this value. We will remove this response in a future release.","example":"zJKyaiAyTNC-MWjiWC18KQ"},"in_room_participants":{"type":"integer","description":"The number of participants that joined via Zoom Room.","example":2},"internal_ip_addresses":{"type":"array","description":"The participant's internal IP addresses. This field will not return under these specific conditions. \n* The account calling this API is a **legacy** [business associate agreement (BAA) under HIPAA](https://www.ecfr.gov/cgi-bin/retrieveECFR?gp=1&amp;n=se45.1.160_1103&amp;r=SECTION&amp;ty=HTML). \n* The account calling this API is a BAA under HIPAA **without** a signed BAA data processing addendum.","items":{"type":"string","example":"192.0.2.1"}},"ip_address":{"type":"string","description":"The participant's IP address.","example":"192.0.2.1"},"join_time":{"type":"string","description":"The time when a participant joined the meeting.","format":"date-time","example":"2022-03-01T10:15:14Z"},"leave_reason":{"type":"string","description":"The reason why the participant left the meeting, where `$name` is the participant's username: \n* `$name left the meeting.` \n* `$name got disconnected from the meeting.` \n* `Host ended the meeting.` \n* `Host closed the meeting.` \n* `Host started a new meeting.` \n* `Network connection error.` \n* `Host did not join.` \n* `Exceeded free meeting minutes limit.` \n* `Removed by host.` \n* `Unknown reason.` \n* `Leave waiting room.` \n* `Removed by host from waiting room.`","example":"Host ended the meeting.","enum":["$name left the meeting.","$name got disconnected from the meeting.","Host ended the meeting.","Host closed the meeting.","Host started a new meeting.","Network connection error.","Host did not join.","Exceeded free meeting minutes limit.","Removed by host.","Unknown reason.","Leave waiting room.","Removed by host from waiting room."]},"leave_time":{"type":"string","description":"The time when a participant left the meeting. For live meetings, this field only returns if a participant has left the ongoing meeting.","format":"date-time","example":"2022-03-01T10:17:35Z"},"location":{"type":"string","description":"The participant's location.","example":"United States"},"mac_addr":{"type":"string","description":"The participant's MAC address. \n\n**Note** This response returns an empty string (``) value for any users who are **not** a part of the host's account (external users).","example":"f85e-a012-92d8"},"microphone":{"type":"string","description":"The type of microphone that the participant used during the meeting. \n\n**Note:** This response returns an empty string (``) value for any users who are **not** a part of the host's account (external users).","example":"Microphone (2- High Definition Audio Device)"},"network_type":{"type":"string","description":"The participant's network type. \n\n* `Wired` \n* `Wifi` \n* `PPP` - Point-to-Point. \n* `Cellular` - 3G, 4G, and 5G cellular. \n* `Others` - An unknown device.","example":"Wired","enum":["Wired","Wifi","PPP","Cellular","Others"]},"participant_user_id":{"type":"string","description":"The participant's universally unique ID (UUID). \n* If the participant joins the meeting by logging into Zoom, this value is the `id` value in the [**Get a user**](/docs/api-reference/zoom-api/methods#operation/user) API response. \n* If the participant joins the meeting **without** logging into Zoom, this returns an empty string value.","example":"DYHrdpjrS3uaOf7dPkkg8w"},"pc_name":{"type":"string","description":"The participant's PC name.","example":"HW0010449"},"recording":{"type":"boolean","description":"Whether the recording feature was used during the meeting.","example":false},"registrant_id":{"type":"string","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.","example":"fdgsfh2ey82fuh"},"role":{"type":"string","description":"The participant's role. \n* `host` - Host. \n* `attendee` - Attendee.","example":"host","enum":["host","attendee"]},"screen_share_quality":{"type":"string","description":"The participant's [screen share quality score](https://support.zoom.us/hc/en-us/articles/360061244651-Using-meeting-quality-scores-and-network-alerts). The API only returns this value when the **Meeting quality scores and network alerts on Dashboard** setting is enabled in the Zoom Web Portal and the **Show meeting quality score and network alerts on Dashboard** option is selected in [**Account Settings**](https://zoom.us/account/setting). \n* `good` - The video is almost flawless and the quality is excellent. \n* `fair` - The video definition is high, occasionally gets stuck, fast or slow, or other problems, but the frequency is very low and the video quality is good. \n* `poor` - The video definition is not high, but not many problems exist. The video quality is mediocre. \n* `bad` - The picture is very blurred and often gets stuck.","example":"good","enum":["","good","fair","poor","bad"]},"share_application":{"type":"boolean","description":"Whether the participant chose to share an iPhone or iPad app during the screenshare.","example":true},"share_desktop":{"type":"boolean","description":"Whether the participant chose to share their desktop during the screenshare.","example":true},"share_whiteboard":{"type":"boolean","description":"Whether the participant chose to share their whiteboard during the screenshare.","example":true},"sip_uri":{"type":"string","description":"The meeting participant's SIP (Session Initiation Protocol) Contact header URI. The API only returns this response when the participant joins a meeting via SIP.","example":"example.com"},"speaker":{"type":"string","description":"The type of speaker that the participant used during the meeting. \n\n**Note:** This response returns an empty string (``) value for any users who are **not** a part of the host's account (external users).","example":"speaker (2- High Definition Audio Device)"},"status":{"type":"string","description":"The participant's status. \n* `in_meeting` - In a meeting. \n* `in_waiting_room` - In a waiting room.","example":"in_meeting","enum":["in_meeting","in_waiting_room"]},"user_id":{"type":"string","description":"The participant's ID. This value assigned to a participant upon joining a meeting and is only valid for the meeting's duration.","example":"20162560"},"participant_uuid":{"type":"string","description":"The participant's UUID. This value assigned to a participant upon joining a meeting and is only valid for the meeting's duration.","example":"D444CD06-2ABB-2FCC-019B-39E41D8DADF7"},"user_name":{"type":"string","description":"The participant's display name.","example":"jchill"},"version":{"type":"string","description":"The participant's Zoom client version.","example":"5.9.1.2581"},"video_quality":{"type":"string","description":"The participant's video quality. The API only returns this value when the **Meeting quality scores and network alerts on Dashboard** setting is enabled in the Zoom Web Portal and the **Show meeting quality score and network alerts on Dashboard** option is selected in [**Account Settings**](https://zoom.us/account/setting). \n* `good` - The video is almost flawless and the quality is excellent. \n* `fair` - The video definition is high, occasionally gets stuck, fast or slow, or other problems, but the frequency is very low and the video quality is good. \n* `poor` - The video definition is not high, but not many problems exist. The video quality is mediocre. \n* `bad` - The picture is very blurred and often gets stuck.","example":"good","enum":["","good","fair","poor","bad"]},"bo_mtg_id":{"type":"string","description":"The [breakout room](https://support.zoom.us/hc/en-us/articles/206476313-Managing-breakout-rooms) ID. Each breakout room is assigned a unique ID.","example":"Dkgwu8nm/ExG1vM+GhLRhA=="},"audio_call":{"type":"array","description":"Information about the meeting participant's audio call. Some participants may join the meeting through the phone call or are bound to the audio.","items":{"type":"object","properties":{"call_number":{"type":"string","description":"The caller's number.","example":"4131"},"call_type":{"type":"string","description":"The call type.","example":"call-in","enum":["call-in","call-out"]},"zoom_number":{"type":"string","description":"The toll-free telephone number.","example":"18773690926"}}}},"os":{"type":"string","description":"The device operation system.","example":"iOS"},"os_version":{"type":"string","description":"The device operation system version.","example":"16.5"},"browser_name":{"type":"string","description":"Webclient operation browser.","example":"Firefox"},"browser_version":{"type":"string","description":"Webclient operation browser version.","example":"133"},"device_name":{"type":"string","description":"The device's name.","example":"iPhone 7 Global"},"groupId":{"type":"string","description":"the attendee's group ID.","example":"TcjqVCTzRy6hLa0d8WpAIg"},"has_archiving":{"type":"boolean","description":"The status of the archiving feature for the meeting.","example":false},"optional_archiving":{"type":"string","description":"This is shown only for internal participants who have archiving enabled.","example":"no optional archiving","enum":["no optional archiving","join without archiving","join with archiving"]},"client":{"type":"string","description":"Client software version or SDK version.","example":"Web Meeting SDK 2.18"},"total_jointime_cost":{"type":"number","description":"The participant join meeting time cost, in seconds.","example":3.98},"aic_disclaimer":{"type":"string","description":"The participant's AI Companion disclaimer status.","example":"leave meeting","enum":["no disclaimer","agree","leave meeting","Request to stop"]},"zoom_thin_client_plugin_version":{"type":"string","description":"VDI thin client version","example":"6.5.11.26770"},"vdi_plugin_info_status":{"type":"string","description":"The participant's VDI plugin connection status.","example":"Local","enum":["Optimized","UnOptimized","Local"]},"vdi_plugin_info_fb_code_reason":{"type":"string","description":"The participant's VDI plugin fallback reason.","example":"None (no error)"}}}}}}]}}}},"400":{"description":"**HTTP Status Code:** `400` <br>\n Bad Request  \n\n **Error Code:** `12702` <br>\n Can not access a meeting a year ago. <br>\n"},"401":{"description":"**HTTP Status Code:** `401` <br>\n Unauthorized  \n\n "},"403":{"description":"**HTTP Status Code:** `403` <br>\n Forbidden  \n\n "},"404":{"description":"**HTTP Status Code:** `404` <br>\n Not Found  \n\n **Error Code:** `3001` <br>\n Meeting ID is invalid or has not ended. <br>\n"},"429":{"description":"**HTTP Status Code:** `429` <br>\n Too Many Requests. For more information, see [rate limits](https://developers.zoom.us/docs/api/rate-limits/). \n\n "}},"security":[{"openapi_authorization":[]}],"x-extensions":{"x-permissions":[],"x-macro-scopes":["dashboard:master"],"x-granular-scopes":["dashboard:read:list_meeting_participants:master"]}}},"/accounts/{accountId}/metrics/meetings/{meetingId}/participants/qos":{"get":{"tags":["Dashboards"],"summary":"List meeting participants QoS","description":"Show a list of meeting participants from live or past meetings, and their quality of service received during the meeting. The data returned indicates the connection quality for sending or receiving video, audio, and shared content. \n\n**Note:** \n\nThis API may return empty values for participants' `user_name`, `ip_address`, `location`, and `email` responses when the account calling this API. \n* Does **not** have a signed HIPAA business associate agreement (BAA). \n* Is a [**legacy** HIPAA BAA account](https://developers.zoom.us/docs/api/rest/other-references/legacy-business-associate-agreements/). \n* Displays data for any users who are **not** part of the host's account (external users) unless they meet certain conditions. See [Email address display rules](https://developers.zoom.us/docs/api/rest/using-zoom-apis/#email-address-display-rules) for details. \n\n**Prerequisites:** \n* A Business or a higher plan.\n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `dashboard:master`\n\n**[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `dashboard:read:list_meeting_participants_qos:master`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `HEAVY`","operationId":"dashboardMeetingParticipantsQOS","parameters":[{"name":"meetingId","in":"path","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 the meeting UUID before making an API request.","required":true,"schema":{"type":"string","example":"w7fUhDMLSo25Lfvu/3I+cw=="}},{"name":"type","in":"query","description":"The type of meeting to query. \n* `past` - All past meetings. \n* `live` - All live meetings. \n\nThis value defaults to `live`.","required":false,"schema":{"type":"string","example":"past","default":"live","enum":["past","live"]}},{"name":"page_size","in":"query","description":"The number of items returned per page.","required":false,"schema":{"maximum":10,"type":"integer","example":10,"default":1}},{"name":"next_page_token","in":"query","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.","required":false,"schema":{"type":"string","example":"IAfJX3jsOLW7w3dokmFl84zOa0MAVGyMEB2"}},{"name":"accountId","in":"path","description":"Unique identifier of the account.","required":true,"schema":{"type":"string","example":"TQTvjT52Tmi_wrhASNNOEw"}}],"responses":{"200":{"description":"**HTTP Status Code:** `200`  \n \nMeeting participants returned.  \n \nThis API is only available for ZMP and Business or higher accounts that have enabled the Dashboard feature.","content":{"application/json":{"schema":{"title":"Participant QOS List","description":"Information about the participants and their quality of service (QoS).","allOf":[{"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 exceed the current page size. The expiration period for this token is 15 minutes.","example":"y20RGLOiO2jTy3CMfnNRORmB51kAuhMy0e2"},"page_count":{"type":"integer","description":"The number of pages returned for the request made.","format":"int64","example":2},"page_size":{"maximum":10,"type":"integer","description":"The number of items per page.","example":10,"default":1},"total_records":{"type":"integer","description":"The number of all records available across pages.","format":"int64","example":2},"meeting_number":{"type":"string","description":"Unique identifier of the meeting in \"long\" format(represented as int64 data type in JSON)","example":"93201235621"}},"description":"Pagination object."},{"type":"object","properties":{"participants":{"type":"array","description":"Information about the participant.","items":{"title":"Participant QOS","type":"object","properties":{"id":{"type":"string","description":"The participant's universally unique ID. This value is the same as the participant's user ID if the participant joins the webinar by logging into Zoom. If the participant joins the webinar without logging into Zoom, this returns an empty value.","example":"_f08HhPJS82MIVLuuFaJPg"},"device":{"type":"string","description":"The type of device the participant used to join the meeting. \n* `Phone` - The participant joined via PSTN. \n* `H.323/SIP` - The participant joined via an H.323 or SIP device. \n* `Windows` - The participant joined via VoIP using a Windows device. \n* `Mac` - The participant joined via VoIP using a Mac device. \n* `iOS` - The participant joined via VoIP using an iOS device. \n* `Android` - The participant joined via VoIP using an Android device. \n\n**Note:** This response returns an empty string (`&ldquo;&ldquo;`) value for any users who are **not** a part of the host's account (external users).","example":"Phone","enum":["Phone","H.323/SIP","Windows","Mac","iOS","Android"]},"client":{"type":"string","description":"Client software or SDK version.","example":"Web Meeting SDK 2.18"},"domain":{"type":"string","description":"The participant's PC domain. \n\n**Note:** This response returns an empty string (`&ldquo;&ldquo;`) value for any users who are **not** a part of the host's account (external users).","example":"example.com"},"harddisk_id":{"type":"string","description":"The participant's hard disk ID. \n\n**Note:** This response returns an empty string (`&ldquo;&ldquo;`) value for any users who are **not** a part of the host's account (external users).","example":"Disk01"},"internal_ip_addresses":{"type":"array","description":"The participant's internal IP addresses. This field will not return under these conditions: \n* The account calling this API is a **legacy** [business associate agreement (BAA) under HIPAA](https://www.ecfr.gov/cgi-bin/retrieveECFR?gp=1&amp;n=se45.1.160_1103&amp;r=SECTION&amp;ty=HTML). \n* The account calling this API is a BAA under HIPAA **without** a signed BAA data processing addendum.","items":{"type":"string","example":"192.0.2.1"}},"ip_address":{"type":"string","description":"The participant's IP address.","example":"192.0.2.1"},"join_time":{"type":"string","description":"The time when the participant joined the meeting.","format":"date-time","example":"2022-03-01T10:15:14Z"},"leave_time":{"type":"string","description":"The time when the participant left the meeting.","format":"date-time","example":"2022-03-01T10:15:14Z"},"location":{"type":"string","description":"The participant's location.","example":"United States"},"mac_addr":{"type":"string","description":"The participant's MAC address. \n\n**Note:** This response returns an empty string (`&ldquo;&ldquo;`) value for any users who are **not** a part of the host's account (external users).","example":"f85e-a012-92d8"},"pc_name":{"type":"string","description":"The participant's PC name.","example":"HW0010449"},"user_id":{"type":"string","description":"The participant's ID. This value is assigned to a participant upon joining a meeting and is only valid for the meeting's duration.","example":"20161536"},"user_name":{"type":"string","description":"The participant's display name.","example":"jchill"},"user_qos":{"type":"array","description":"The participant's quality of service information.","items":{"type":"object","properties":{"as_device_from_crc":{"type":"object","properties":{"avg_loss":{"type":"string","description":"The average amount of packet loss, such as the percentage of packets that failed to arrive at their destination.","example":"0.03%"},"bitrate":{"type":"string","description":"The bits per second transmitted along a digital network, in kbps.","example":"27.15 kbps"},"jitter":{"type":"string","description":"The variation in the delay of received packets, in milliseconds.","example":"0 ms"},"latency":{"type":"string","description":"The time it took a packet to travel from one point to another, in milliseconds.","example":"126 ms"},"max_loss":{"type":"string","description":"The maximum amount of packet loss, such as the maximum percentage of packets that failed to arrive at their destination.","example":"0.4%"},"frame_rate":{"type":"string","description":"The rate where the video camera can produce unique images (frames). Zoom supports a frame rate of up to 30 fps.","example":"12 fps"},"resolution":{"type":"string","description":"The number of pixels in each dimension that the video camera can display.","example":"1280*720"}},"description":"The QoS metrics for screen sharing by a participant who joined the meeting via CRC."},"as_device_to_crc":{"type":"object","properties":{"avg_loss":{"type":"string","description":"The average amount of packet loss, such as the percentage of packets that failed to arrive at their destination.","example":"0.03%"},"bitrate":{"type":"string","description":"The bits per second transmitted along a digital network, in kbps.","example":"27.15 kbps"},"jitter":{"type":"string","description":"The variation in the delay of received packets, in milliseconds.","example":"0 ms"},"latency":{"type":"string","description":"The time it took a packet to travel from one point to another, in milliseconds.","example":"126 ms"},"max_loss":{"type":"string","description":"The maximum amount of packet loss, such as the maximum percentage of packets that failed to arrive at their destination.","example":"0.4%"},"frame_rate":{"type":"string","description":"The rate where the video camera can produce unique images (frames). Zoom supports a frame rate of up to 30 fps.","example":"12 fps"},"resolution":{"type":"string","description":"The number of pixels in each dimension that the video camera can display.","example":"1280*720"}},"description":"The QoS metrics for screen sharing output received by a participant who joined the meeting via CRC."},"as_input":{"title":"Screen Share QoS Object","type":"object","description":"The QoS metrics for screen sharing by a participant who joined the meeting","allOf":[{"title":"Audio QoS Object","type":"object","properties":{"avg_loss":{"type":"string","description":"The average amount of packet loss, such as the percentage of packets that failed to arrive at their destination.","example":"0.03%"},"bitrate":{"type":"string","description":"The bits per second transmitted along a digital network, in kbps.","example":"27.15 kbps"},"jitter":{"type":"string","description":"The variation in the delay of received packets, in milliseconds.","example":"0 ms"},"latency":{"type":"string","description":"The time it took a packet to travel from one point to another, in milliseconds.","example":"126 ms"},"max_loss":{"type":"string","description":"The maximum amount of packet loss, such as the maximum percentage of packets that failed to arrive at their destination.","example":"0.4%"}}},{"type":"object","properties":{"frame_rate":{"type":"string","description":"The rate where the video camera can produce unique images (frames). Zoom supports a frame rate of up to 30 fps.","example":"12 fps"},"resolution":{"type":"string","description":"The number of pixels in each dimension that the video camera can display.","example":"1280*720"}}}]},"as_output":{"title":"Screen Share QoS Object","type":"object","description":"The QoS metrics for screen sharing output received by a participant who joined the meeting","allOf":[{"title":"Audio QoS Object","type":"object","properties":{"avg_loss":{"type":"string","description":"The average amount of packet loss, such as the percentage of packets that failed to arrive at their destination.","example":"0.03%"},"bitrate":{"type":"string","description":"The bits per second transmitted along a digital network, in kbps.","example":"27.15 kbps"},"jitter":{"type":"string","description":"The variation in the delay of received packets, in milliseconds.","example":"0 ms"},"latency":{"type":"string","description":"The time it took a packet to travel from one point to another, in milliseconds.","example":"126 ms"},"max_loss":{"type":"string","description":"The maximum amount of packet loss, such as the maximum percentage of packets that failed to arrive at their destination.","example":"0.4%"}}},{"type":"object","properties":{"frame_rate":{"type":"string","description":"The rate where the video camera can produce unique images (frames). Zoom supports a frame rate of up to 30 fps.","example":"12 fps"},"resolution":{"type":"string","description":"The number of pixels in each dimension that the video camera can display.","example":"1280*720"}}}]},"audio_device_from_crc":{"type":"object","properties":{"avg_loss":{"type":"string","description":"The average amount of packet loss, such as the percentage of packets that failed to arrive at their destination.","example":"0.03%"},"bitrate":{"type":"string","description":"The bits per second transmitted along a digital network, in kbps.","example":"27.15 kbps"},"jitter":{"type":"string","description":"The variation in the delay of received packets, in milliseconds.","example":"0 ms"},"latency":{"type":"string","description":"The time it took a packet to travel from one point to another, in milliseconds.","example":"126 ms"},"max_loss":{"type":"string","description":"The maximum amount of packet loss, such as the maximum percentage of packets that failed to arrive at their destination.","example":"0.4%"}},"description":"The QoS metrics for audio sent by a participant who joined the meeting via a Cloud Room Connector (CRC)."},"audio_device_to_crc":{"type":"object","properties":{"avg_loss":{"type":"string","description":"The average amount of packet loss, such as the percentage of packets that failed to arrive at their destination.","example":"0.03%"},"bitrate":{"type":"string","description":"The bits per second transmitted along a digital network, in kbps.","example":"27.15 kbps"},"jitter":{"type":"string","description":"The variation in the delay of received packets, in milliseconds.","example":"0 ms"},"latency":{"type":"string","description":"The time it took a packet to travel from one point to another, in milliseconds.","example":"126 ms"},"max_loss":{"type":"string","description":"The maximum amount of packet loss, such as the maximum percentage of packets that failed to arrive at their destination.","example":"0.4%"}},"description":"The QoS metrics for audio received by a participant who joined the meeting via CRC."},"audio_input":{"title":"Audio QoS Object","type":"object","properties":{"avg_loss":{"type":"string","description":"The average amount of packet loss, such as the percentage of packets that failed to arrive at their destination.","example":"0.03%"},"bitrate":{"type":"string","description":"The bits per second transmitted along a digital network, in kbps.","example":"27.15 kbps"},"jitter":{"type":"string","description":"The variation in the delay of received packets, in milliseconds.","example":"0 ms"},"latency":{"type":"string","description":"The time it took a packet to travel from one point to another, in milliseconds.","example":"126 ms"},"max_loss":{"type":"string","description":"The maximum amount of packet loss, such as the maximum percentage of packets that failed to arrive at their destination.","example":"0.4%"}},"description":"The QoS metrics for audio sent by a participant who joined the meeting"},"audio_output":{"title":"Audio QoS Object","type":"object","properties":{"avg_loss":{"type":"string","description":"The average amount of packet loss, such as the percentage of packets that failed to arrive at their destination.","example":"0.03%"},"bitrate":{"type":"string","description":"The bits per second transmitted along a digital network, in kbps.","example":"27.15 kbps"},"jitter":{"type":"string","description":"The variation in the delay of received packets, in milliseconds.","example":"0 ms"},"latency":{"type":"string","description":"The time it took a packet to travel from one point to another, in milliseconds.","example":"126 ms"},"max_loss":{"type":"string","description":"The maximum amount of packet loss, such as the maximum percentage of packets that failed to arrive at their destination.","example":"0.4%"}},"description":"The QoS metrics for audio received by a participant who joined the meeting"},"cpu_usage":{"type":"object","properties":{"system_max_cpu_usage":{"type":"string","description":"The system's maximum CPU usage.","example":"11%"},"zoom_avg_cpu_usage":{"type":"string","description":"Zoom's average CPU usage.","example":"0%"},"zoom_max_cpu_usage":{"type":"string","description":"Zoom's maximum CPU usage.","example":"2%"},"zoom_min_cpu_usage":{"type":"string","description":"Zoom's minimum CPU usage.","example":"0%"}},"description":"Information about CPU usage."},"cpu_pressure_level":{"type":"object","properties":{"system_min_cpu_pressure_level":{"type":"string","description":"The system’s minimum CPU pressure level","example":"normal","enum":["normal","fair","serious","critical"]},"system_avg_cpu_pressure_level":{"type":"string","description":"The system’s average CPU pressure level","example":"normal","enum":["normal","fair","serious","critical"]},"system_max_cpu_pressure_level":{"type":"string","description":"The system’s maximum CPU pressure level","example":"normal","enum":["critical","serious","fair","normal"]}},"description":"The system’s CPU pressure level"},"date_time":{"type":"string","description":"The QoS date and time.","format":"date-time","example":"2022-03-01T10:16:00Z"},"video_device_from_crc":{"type":"object","properties":{"avg_loss":{"type":"string","description":"The average amount of packet loss, such as the percentage of packets that failed to arrive at their destination.","example":"0.03%"},"bitrate":{"type":"string","description":"The bits per second transmitted along a digital network, in kbps.","example":"27.15 kbps"},"jitter":{"type":"string","description":"The variation in the delay of received packets, in milliseconds.","example":"0 ms"},"latency":{"type":"string","description":"The time it took a packet to travel from one point to another, in milliseconds.","example":"126 ms"},"max_loss":{"type":"string","description":"The maximum amount of packet loss, such as the maximum percentage of packets that failed to arrive at their destination.","example":"0.03%"},"frame_rate":{"type":"string","description":"The rate where the video camera can produce unique images (frames). Zoom supports a frame rate of up to 30 fps.","example":"12 fps"},"resolution":{"type":"string","description":"The number of pixels in each dimension that the video camera can display.","example":"1280*720"}},"description":"The QoS metrics for video input being sent by a participant who joined the meeting via CRC."},"video_device_to_crc":{"type":"object","properties":{"avg_loss":{"type":"string","description":"The average amount of packet loss, such as the percentage of packets that failed to arrive at their destination.","example":"0.03%"},"bitrate":{"type":"string","description":"The bits per second transmitted along a digital network, in kbps.","example":"27.15 kbps"},"jitter":{"type":"string","description":"The variation in the delay of received packets, in milliseconds.","example":"0 ms"},"latency":{"type":"string","description":"The time it took a packet to travel from one point to another, in milliseconds.","example":"126 ms"},"max_loss":{"type":"string","description":"The maximum amount of packet loss, such as the maximum percentage of packets that failed to arrive at their destination.","example":"0.4%"},"frame_rate":{"type":"string","description":"The rate where the video camera can produce unique images (frames). Zoom supports a frame rate of up to 30 fps.","example":"12 fps"},"resolution":{"type":"string","description":"The number of pixels in each dimension that the video camera can display.","example":"1280*720"}},"description":"The QoS metrics for video output being sent by a participant who joined the meeting via CRC."},"video_input":{"title":"Video QoS Object","type":"object","description":"The QoS metrics for video input being sent by a participant who joined the meeting","allOf":[{"title":"Audio QoS Object","type":"object","properties":{"avg_loss":{"type":"string","description":"The average amount of packet loss, such as the percentage of packets that failed to arrive at their destination.","example":"0.03%"},"bitrate":{"type":"string","description":"The bits per second transmitted along a digital network, in kbps.","example":"27.15 kbps"},"jitter":{"type":"string","description":"The variation in the delay of received packets, in milliseconds.","example":"0 ms"},"latency":{"type":"string","description":"The time it took a packet to travel from one point to another, in milliseconds.","example":"126 ms"},"max_loss":{"type":"string","description":"The maximum amount of packet loss, such as the maximum percentage of packets that failed to arrive at their destination.","example":"0.4%"}}},{"type":"object","properties":{"frame_rate":{"type":"string","description":"The rate where the video camera can produce unique images (frames). Zoom supports a frame rate of up to 30 fps.","example":"12 fps"},"resolution":{"type":"string","description":"The number of pixels in each dimension that the video camera can display.","example":"1280*720"}}}]},"video_output":{"title":"Video QoS Object","type":"object","description":"The QoS metrics for video output being sent by a participant who joined the meeting","allOf":[{"title":"Audio QoS Object","type":"object","properties":{"avg_loss":{"type":"string","description":"The average amount of packet loss, such as the percentage of packets that failed to arrive at their destination.","example":"0.03%"},"bitrate":{"type":"string","description":"The bits per second transmitted along a digital network, in kbps.","example":"27.15 kbps"},"jitter":{"type":"string","description":"The variation in the delay of received packets, in milliseconds.","example":"0 ms"},"latency":{"type":"string","description":"The time it took a packet to travel from one point to another, in milliseconds.","example":"126 ms"},"max_loss":{"type":"string","description":"The maximum amount of packet loss, such as the maximum percentage of packets that failed to arrive at their destination.","example":"0.4%"}}},{"type":"object","properties":{"frame_rate":{"type":"string","description":"The rate where the video camera can produce unique images (frames). Zoom supports a frame rate of up to 30 fps.","example":"12 fps"},"resolution":{"type":"string","description":"The number of pixels in each dimension that the video camera can display.","example":"1280*720"}}}]},"as_device_from_rwg":{"type":"object","properties":{"avg_loss":{"type":"string","description":"The average amount of packet loss, such as the percentage of packets that failed to arrive at their destination.","example":"0.03%"},"bitrate":{"type":"string","description":"The bits per second transmitted along a digital network, in kbps.","example":"27.15 kbps"},"jitter":{"type":"string","description":"The variation in the delay of received packets, in milliseconds.","example":"0 ms"},"latency":{"type":"string","description":"The time it took a packet to travel from one point to another, in milliseconds.","example":"126 ms"},"max_loss":{"type":"string","description":"The maximum amount of packet loss, such as the maximum percentage of packets that failed to arrive at their destination.","example":"0.4%"},"frame_rate":{"type":"string","description":"The rate where the video camera can produce unique images (frames). Zoom supports a frame rate of up to 30 fps.","example":"12 fps"},"resolution":{"type":"string","description":"The number of pixels in each dimension that the video camera can display.","example":"1280*720"}},"description":"The QoS metrics for screen sharing by a participant who joined the meeting via the web client."},"as_device_to_rwg":{"type":"object","properties":{"avg_loss":{"type":"string","description":"The average amount of packet loss, such as the percentage of packets that failed to arrive at their destination.","example":"0.03%"},"bitrate":{"type":"string","description":"The bits per second transmitted along a digital network, in kbps.","example":"27.15 kbps"},"jitter":{"type":"string","description":"The variation in the delay of received packets, in milliseconds.","example":"0 ms"},"latency":{"type":"string","description":"The time it took a packet to travel from one point to another, in milliseconds.","example":"126 ms"},"max_loss":{"type":"string","description":"The maximum amount of packet loss, such as the maximum percentage of packets that failed to arrive at their destination.","example":"0.4%"},"frame_rate":{"type":"string","description":"The rate where the video camera can produce unique images (frames). Zoom supports a frame rate of up to 30 fps.","example":"12 fps"},"resolution":{"type":"string","description":"The number of pixels in each dimension that the video camera can display.","example":"1280*720"}},"description":"The QoS output metrics for screen sharing received by a participant who joined the meeting via the web client."},"audio_device_from_rwg":{"type":"object","properties":{"avg_loss":{"type":"string","description":"The average amount of packet loss, such as the percentage of packets that failed to arrive at their destination.","example":"0.03%"},"bitrate":{"type":"string","description":"The bits per second transmitted along a digital network, in kbps.","example":"27.15 kbps"},"jitter":{"type":"string","description":"The variation in the delay of received packets, in milliseconds.","example":"0 ms"},"latency":{"type":"string","description":"The time it took a packet to travel from one point to another, in milliseconds.","example":"126 ms"},"max_loss":{"type":"string","description":"The maximum amount of packet loss, such as the maximum percentage of packets that failed to arrive at their destination.","example":"0.4%"}},"description":"The QoS metrics for audio sent by a participant who joined the meeting via the web client."},"audio_device_to_rwg":{"type":"object","properties":{"avg_loss":{"type":"string","description":"The average amount of packet loss. For example, the percentage of packets that failed to arrive at their destination.","example":"0.03%"},"bitrate":{"type":"string","description":"The bits per second transmitted along a digital network, in kbps.","example":"27.15 kbps"},"jitter":{"type":"string","description":"The variation in the delay of received packets, in milliseconds.","example":"0 ms"},"latency":{"type":"string","description":"The time it took a packet to travel from one point to another, in milliseconds.","example":"126 ms"},"max_loss":{"type":"string","description":"The maximum amount of packet loss, such as the maximum percentage of packets that failed to arrive at their destination.","example":"0.4%"}},"description":"The QoS metrics for audio received by a participant who joined the meeting via web client."},"video_device_from_rwg":{"type":"object","properties":{"avg_loss":{"type":"string","description":"The average amount of packet loss, such as the percentage of packets that failed to arrive at their destination.","example":"0.03%"},"bitrate":{"type":"string","description":"The bits per second transmitted along a digital network, in kbps.","example":"27.15 kbps"},"jitter":{"type":"string","description":"The variation in the delay of received packets, in milliseconds.","example":"0 ms"},"latency":{"type":"string","description":"The time it took a packet to travel from one point to another, in milliseconds.","example":"126 ms"},"max_loss":{"type":"string","description":"The maximum amount of packet loss, such as the maximum percentage of packets that failed to arrive at their destination.","example":"0.03%"},"frame_rate":{"type":"string","description":"The rate where the video camera can produce unique images (frames). Zoom supports a frame rate of up to 30 fps.","example":"12 fps"},"resolution":{"type":"string","description":"The number of pixels in each dimension that the video camera can display.","example":"1280*720"}},"description":"The QoS metrics for video input being sent by a participant who joined the meeting via the web client."},"video_device_to_rwg":{"type":"object","properties":{"avg_loss":{"type":"string","description":"The average amount of packet loss, such as the percentage of packets that failed to arrive at their destination.","example":"0.03%"},"bitrate":{"type":"string","description":"The bits per second transmitted along a digital network, in kbps.","example":"27.15 kbps"},"jitter":{"type":"string","description":"The variation in the delay of received packets, in milliseconds.","example":"0 ms"},"latency":{"type":"string","description":"The time it took a packet to travel from one point to another, in milliseconds.","example":"126 ms"},"max_loss":{"type":"string","description":"The maximum amount of packet loss, such as the maximum percentage of packets that failed to arrive at their destination.","example":"0.4%"},"frame_rate":{"type":"string","description":"The rate where the video camera can produce unique images (frames). Zoom supports a frame rate of up to 30 fps.","example":"12 fps"},"resolution":{"type":"string","description":"The number of pixels in each dimension that the video camera can display.","example":"1280*720"}},"description":"The QoS metrics for video output being sent by a participant who joined the meeting via the web client."},"wifi_rssi":{"type":"object","properties":{"max_rssi":{"type":"integer","description":"Maximum value of the wireless network's received signal strength indicator (RSSI).","example":-75},"avg_rssi":{"type":"integer","description":"Average value of the wireless network's received signal strength indicator (RSSI).","example":-69},"min_rssi":{"type":"integer","description":"Minimum value of the wireless network's received signal strength indicator (RSSI).","example":-35},"rssi_unit":{"type":"string","description":"Unit of the wireless network's received signal strength indicator (RSSI).","example":"dBm"}},"description":"The QoS metrics for the wireless network's RSSI sent by a participant who joined the meeting through a wireless network."},"audio_socket_break":{"type":"object","properties":{"socket_break":{"type":"boolean","description":"Whether the participant's audio socket broke.","example":true},"socket_break_time":{"type":"string","description":"The participant's audio socket break time.","format":"date-time","example":"2026-04-20T01:50:42Z"},"socket_recover":{"type":"boolean","description":"Whether the participant's audio socket recovered.","example":false},"socket_recover_time":{"type":"string","description":"The participant's audio socket recovery time.","format":"date-time","example":"2026-04-20T01:50:42Z"}},"description":"The QoS metrics for audio socket breaks for a participant who joined the meeting."},"video_socket_break":{"type":"object","properties":{"socket_break":{"type":"boolean","description":"Whether the participant's video socket broke.","example":true},"socket_break_time":{"type":"string","description":"The participant's video socket break time.","format":"date-time","example":"2026-04-20T01:50:42Z"},"socket_recover":{"type":"boolean","description":"Whether the participant's video socket recovered.","example":false},"socket_recover_time":{"type":"string","description":"The participant's video socket recovery time.","format":"date-time","example":"2026-04-20T01:50:42Z"}},"description":"The QoS metrics for video socket breaks for a participant who joined the meeting."},"as_socket_break":{"type":"object","properties":{"socket_break":{"type":"boolean","description":"Whether the participant's screen sharing socket broke.","example":true},"socket_break_time":{"type":"string","description":"The participant's screen sharing socket break time.","format":"date-time","example":"2026-04-20T01:50:42Z"},"socket_recover":{"type":"boolean","description":"Whether the participant's screen sharing socket recovered.","example":false},"socket_recover_time":{"type":"string","description":"The participant's screen sharing socket recovery time.","format":"date-time","example":"2026-04-20T01:50:42Z"}},"description":"The QoS metrics for screen sharing socket breaks for a participant who joined the meeting."},"command_socket_break":{"type":"object","properties":{"socket_break":{"type":"boolean","description":"Whether the participant's command socket broke.","example":true},"socket_break_time":{"type":"string","description":"The participant's command socket break time.","format":"date-time","example":"2026-04-20T01:50:42Z"},"socket_recover":{"type":"boolean","description":"Whether the participant's command socket recovered.","example":false},"socket_recover_time":{"type":"string","description":"The participant's command socket recovery time.","format":"date-time","example":"2026-04-20T01:50:42Z"}},"description":"The QoS metrics for command socket breaks for a participant who joined the meeting."}}}},"version":{"type":"string","description":"The participant's Zoom client version.","example":"5.9.1.2581"},"os":{"type":"string","description":"device operation system","example":"iOS"},"os_version":{"type":"string","description":"device operation system version","example":"16.5"},"browser_name":{"type":"string","description":"webclient operation browser","example":"Firefox"},"browser_version":{"type":"string","description":"webclient operation browser version","example":"133"},"video_connection_type":{"type":"string","description":"The participant's video connection type.","example":"UDP","enum":["P2P","TCP","UDP","Reliable UDP","SSL","HTTP","TCP+Proxy","UDP+Proxy","Reliable+Proxy","SSL+Proxy","HTTP+Proxy"]},"as_connection_type":{"type":"string","description":"The participant's screen share connection type.","example":"UDP","enum":["P2P","TCP","UDP","Reliable UDP","SSL","HTTP","TCP+Proxy","UDP+Proxy","Reliable+Proxy","SSL+Proxy","HTTP+Proxy"]},"participant_uuid":{"type":"string","description":"The participant's UUID. This value assigned to a participant upon joining a meeting and is only valid for the meeting's duration.","example":"D444CD06-2ABB-2FCC-019B-39E41D8DADF7"},"network_type":{"type":"string","description":"The participant's network type. * `Wired` * `Wifi` * `PPP` - Point-to-Point. * `Cellular` - 3G, 4G, and 5G cellular. * `Others` - An unknown device.","example":"Wired","enum":["Wired","Wifi","PPP","Cellular","Others"]},"data_center":{"type":"string","description":"The data center that the participant is leveraging to join the meeting.","example":"United States (SC Top)"},"full_data_center":{"type":"string","description":"The data center where participant's meeting data is stored. This field includes a semicolon-separated list of HTTP Tunnel (HT), Cloud Room Connector (CRC), and Real-Time Web Gateway (RWG) location information.","example":"United States (SC Top);"},"connection_type":{"type":"string","description":"The participant's connection type.","example":"UDP","enum":["P2P","TCP","UDP","Reliable UDP","SSL","HTTP","TCP+Proxy","UDP+Proxy","Reliable+Proxy","SSL+Proxy","HTTP+Proxy"]},"share_application":{"type":"boolean","description":"Whether the participant chose to share an application during the meeting.","example":true},"share_desktop":{"type":"boolean","description":"Whether the participant chose to share their desktop during the screenshare.","example":true},"share_whiteboard":{"type":"boolean","description":"Whether the participant chose to share their whiteboard during the screenshare.","example":true},"recording":{"type":"boolean","description":"Whether the recording feature was used during the meeting.","example":true},"device_name":{"type":"string","description":"The device's name.","example":"iPhone 7 Global"},"groupId":{"type":"string","description":"the attendee's group id","example":"TcjqVCTzRy6hLa0d8WpAIg"},"has_archiving":{"type":"boolean","description":"The status of the archiving feature for the meeting","example":true},"optional_archiving":{"type":"string","description":"Client software version or SDK version","example":"no optional archiving","enum":["no optional archiving","join without archiving","join with archiving"]},"health":{"type":"string","description":"The participant's health","example":"Warning","default":"Good","enum":["Good","Warning","Critical"]},"total_jointime_cost":{"type":"number","description":"The participant join meeting time cost, the unit is seconds.","example":3.52},"zoom_thin_client_plugin_version":{"type":"string","description":"VDI thin client version","example":"6.5.11.26770"},"email":{"type":"string","description":"The participant's email address. 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](/docs/api-reference/using-zoom-apis#email-address) for details.","format":"email","example":"jchill@example.com"},"issue_list":{"maxItems":5,"minItems":0,"type":"array","description":"The participant's issue list","items":{"type":"string","description":"The participant's issue","example":"audio"}},"rc_reason":{"type":"string","description":"the call reconnection reason: Client crash","example":"Client crash"},"vdi_plugin_info_status":{"type":"string","description":"The participant's VDI plugin connection status.","example":"Local","enum":["Optimized","UnOptimized","Local"]},"vdi_plugin_info_fb_code_reason":{"type":"string","description":"The participant's VDI plugin fallback reason.","example":"None (no error)"}},"description":"Information about the participant and their quality of service (QoS)."}}}}]}}}},"400":{"description":"**HTTP Status Code:** `400` <br>\n Bad Request  \n\n **Error Code:** `12702` <br>\n Can not access a meeting a year ago. <br>\n"},"401":{"description":"**HTTP Status Code:** `401` <br>\n Unauthorized  \n\n "},"403":{"description":"**HTTP Status Code:** `403` <br>\n Forbidden  \n\n "},"404":{"description":"**HTTP Status Code:** `404` <br>\n Not Found  \n\n **Error Code:** `3001` <br>\n This meeting's detail info is not available.<br>The meeting ID is not valid or the meeting has not ended yet. <br>\n"},"429":{"description":"**HTTP Status Code:** `429` <br>\n Too Many Requests. For more information, see [rate limits](https://developers.zoom.us/docs/api/rest/rate-limits/). \n\n "}},"security":[{"openapi_authorization":[]}],"x-extensions":{"x-permissions":["DashboardMeetings:Read"],"x-macro-scopes":["dashboard:master"],"x-granular-scopes":["dashboard:read:list_meeting_participants_qos:master"]}}},"/accounts/{accountId}/metrics/meetings/{meetingId}/participants/satisfaction":{"get":{"tags":["Dashboards"],"summary":"Get post meeting feedback","description":"When a meeting ends, each attendee will be prompted to share their meeting experience by clicking either thumbs up or thumbs down. Use this API to retrieve the feedback submitted for a specific meeting. Note that this API only works for meetings scheduled after December 20, 2020.\n\n**Prerequisites:**\n* [Feedback to Zoom](https://support.zoom.us/hc/en-us/articles/115005838023) setting must be enabled by the participant prior to the meeting.\n* The user making the API request must be enrolled in a Business or a higher plan.\n\n  \n  \n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `dashboard:master`\n\n**[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `dashboard:read:post_meeting_feedback:master`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Heavy`","operationId":"participantFeedback","parameters":[{"name":"meetingId","in":"path","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.","required":true,"schema":{"oneOf":[{"type":"integer","example":5638296721},{"type":"string","example":"4444AAAiAAAAAiAiAiiAii=="}]}},{"name":"type","in":"query","description":"Specify a value to get the response for the corresponding meeting type. The value of this field can be one of the following:  \n    \n `past` - Meeting that already occurred in the specified date range.  \n `pastOne` - Past meetings that were attended by only one user.   \n `live` - Live meetings.  \n   \n \n\nIf you do not provide this field, the default value will be `live` and thus, the API will only query responses for live meetings.","required":false,"schema":{"type":"string","example":"past","default":"live","enum":["past","pastOne","live"]}},{"name":"next_page_token","in":"query","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.","required":false,"schema":{"type":"string","example":"IAfJX3jsOLW7w3dokmFl84zOa0MAVGyMEB2"}},{"name":"page_size","in":"query","description":"The number of records returned within a single API call.","required":false,"schema":{"maximum":300,"type":"integer","example":30,"default":30}},{"name":"accountId","in":"path","description":"Unique identifier of the account.","required":true,"schema":{"type":"string","example":"TQTvjT52Tmi_wrhASNNOEw"}}],"responses":{"200":{"description":"**HTTP Status Code:** `200`  \n \n\n","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":"ZkFS5lmGLWTjLMqt2IVCBpyKwSnbDrgJzo2"},"page_size":{"type":"integer","description":"The number of records returned within a single API call.","example":30},"participants":{"type":"array","items":{"type":"object","properties":{"date_time":{"type":"string","description":"Date and time at which the feedback was submitted.","format":"date-time","example":"2022-01-19T07:34:09Z"},"email":{"type":"string","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.","format":"email","example":"user@example.com"},"quality":{"type":"string","description":"Feedback submitted by the participant. \n\n* `GOOD`: Thumbs up.\n* `NOT GOOD`: Thumbs down.","example":"GOOD","enum":["GOOD","NOT GOOD"]},"user_id":{"type":"string","description":"User ID of the participant.","example":"NJmuvOjlRm2r7yGUPLLOhw"},"comment":{"type":"string","description":"Post meeting comment of the participant.","example":"Meeting got disconnected."}}}}}}}}},"400":{"description":"**HTTP Status Code:** `400` <br>\n Bad Request  \n\n **Error Code:** `200` <br>\n Only available for paid accounts that have dashboard feature enabled. <br>\n"},"404":{"description":"**HTTP Status Code:** `404` <br>\n Not Found  \n\n **Error Code:** `3001` <br>\n Meeting ID is invalid or not end. <br>\n"},"429":{"description":"**HTTP Status Code:** `429` <br>\n Too Many Requests. For more information, see [rate limits](https://developers.zoom.us/docs/api/rest/rate-limits/). \n\n "}},"security":[{"openapi_authorization":[]}],"x-extensions":{"x-permissions":["DashboardMeetings:Read"],"x-macro-scopes":["dashboard:master"],"x-granular-scopes":["dashboard:read:post_meeting_feedback:master"]}}},"/accounts/{accountId}/metrics/meetings/{meetingId}/participants/sharing":{"get":{"tags":["Dashboards"],"summary":"Get meeting sharing/recording details","description":"Retrieve the sharing and recording details of participants from live or past meetings.  \n \n**Prerequisites:**   \n \n* Business or a higher plan.\n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `dashboard_meetings:read:master`,`dashboard:master`\n\n**[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `dashboard:read:meeting_sharing:master`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Heavy`","operationId":"dashboardMeetingParticipantShare","parameters":[{"name":"meetingId","in":"path","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.","required":true,"schema":{"oneOf":[{"type":"integer","example":5638296721},{"type":"string","example":"4444AAAiAAAAAiAiAiiAii=="}]}},{"name":"type","in":"query","description":"The type of meeting to query: \n* `past` &mdash; All past meetings. \n* `live` - All live meetings. \n\nThis value defaults to `live`.","required":false,"schema":{"type":"string","example":"past","default":"live","enum":["past","live"]}},{"name":"page_size","in":"query","description":"The number of records returned within a single API call.","required":false,"schema":{"maximum":300,"type":"integer","example":30,"default":30}},{"name":"next_page_token","in":"query","description":"Use the next page token to paginate through large result sets. A next page token is returned whenever the set of available results exceed the current page size. This token's expiration period is 15 minutes.","required":false,"schema":{"type":"string","example":"0JblM1ZHFIdXjAHefkYOfTdCw1Lq9H1urw2"}},{"name":"accountId","in":"path","description":"Unique identifier of the account.","required":true,"schema":{"type":"string","example":"TQTvjT52Tmi_wrhASNNOEw"}}],"responses":{"200":{"description":"**HTTP Status Code:** `200`  \n \nMeeting participants returned.","content":{"application/json":{"schema":{"allOf":[{"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":"Tva2CuIdTgsv8wAnhyAdU3m06Y2HuLQtlh3"},"page_count":{"type":"integer","description":"The number of pages returned for the request made.","example":1},"page_size":{"maximum":300,"type":"integer","description":"The number of records returned within a single API call.","example":30,"default":30},"total_records":{"type":"integer","description":"The number of all records available across pages.","example":1}},"description":"Pagination object."},{"type":"object","properties":{"participants":{"type":"array","description":"Array of participants.","items":{"type":"object","properties":{"details":{"type":"array","description":"Array of sharing and recording details.","items":{"type":"object","properties":{"content":{"type":"string","description":"Type of content shared.","example":"desktop"},"end_time":{"type":"string","description":"End time of sharing.","example":"2022-02-15T08:45:59Z"},"start_time":{"type":"string","description":"Start time of sharing.","example":"2022-02-15T08:45:50Z"}}}},"id":{"type":"string","description":"Universally 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.","example":"pFyqVDCkQlCbrt-iADD4UA"},"user_id":{"type":"string","description":"Participant ID. This is a unique ID assigned to the participant joining a meeting and is valid for that meeting only.","example":"30321664"},"user_name":{"type":"string","description":"Participant display name.","example":"jchill"}}}}}}]}}}},"400":{"description":"**HTTP Status Code:** `400` <br>\n Bad Request\n\n**Error Code:** `12702` <br>\nCan not access a meeting a year ago.\n\n"},"404":{"description":"**HTTP Status Code:** `404` <br>\n Not Found\n\n**Error Code:** `3001` <br>\nThis meeting's detail info is not available or ID is not valid.\n\n"},"429":{"description":"**HTTP Status Code:** `429` <br>\n Too Many Requests. For more information, see [rate limits](https://developers.zoom.us/docs/api/rest/rate-limits/). \n\n "}},"security":[{"openapi_authorization":[]}],"x-extensions":{"x-permissions":["DashboardMeetings:Read"],"x-macro-scopes":["dashboard_meetings:read:master","dashboard:master"],"x-granular-scopes":["dashboard:read:meeting_sharing:master"]}}},"/accounts/{accountId}/metrics/meetings/{meetingId}/participants/{participantId}/qos":{"get":{"tags":["Dashboards"],"summary":"Get meeting participant QoS","description":"Return the quality of service (QoS) report for participants from live or past meetings. The data returned indicates the connection quality for sending/receiving video, audio, and shared content. The API returns this data for either the API request or when the API request was last received. \n\nWhen the sender sends data, a timestamp is attached to the sender's data packet. The receiver then returns this timestamp to the sender. This helps determine the upstream and downstream latency, which includes the application processing time. The latency data returned is the five second average and five second maximum. \n\n This API will **not** return data if there is no data being sent or received at the time of request. \n\n**Note:** \n\nThis API may return empty values for participants' `user_name`, `ip_address`, `location`, and `email` responses when the account calling this API: \n* Does **not** have a signed HIPAA business associate agreement (BAA). \n* Is a [**legacy** HIPAA BAA account](https://developers.zoom.us/docs/api/rest/other-references/legacy-business-associate-agreements/). \n* Displays data for any users who are **not** part of the host's account (external users) unless they meet certain conditions. See [Email address display rules](https://developers.zoom.us/docs/api/rest/using-zoom-apis/#email-address-display-rules) for details. \n\n\n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `dashboard:master`\n\n**[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `dashboard:read:meeting_participant_qos:master`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `HEAVY`","operationId":"dashboardMeetingParticipantQOS","parameters":[{"name":"meetingId","in":"path","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 the meeting UUID before making an API request.","required":true,"schema":{"type":"string","example":"w7fUhDMLSo25Lfvu/3I+cw=="}},{"name":"participantId","in":"path","description":"The participant's ID.","required":true,"schema":{"type":"string","example":"32977920"}},{"name":"type","in":"query","description":"The type of meeting to query. \n* `past` - All past meetings. \n* `live` - All live meetings. \n\nThis value defaults to `live`.","required":false,"schema":{"type":"string","example":"past","default":"live","enum":["past","live"]}},{"name":"accountId","in":"path","description":"Unique identifier of the account.","required":true,"schema":{"type":"string","example":"TQTvjT52Tmi_wrhASNNOEw"}}],"responses":{"200":{"description":"**HTTP Status Code:** `200`   Meeting participant QOS returned. This API is only available for ZMP and Business or higher accounts that have enabled the Dashboard feature.","content":{"application/json":{"schema":{"title":"Participant QOS","type":"object","properties":{"id":{"type":"string","description":"The participant's universally unique ID. This value is the same as the participant's user ID if the participant joins the webinar by logging into Zoom. If the participant joins the webinar without logging into Zoom, this returns an empty value.","example":"_f08HhPJS82MIVLuuFaJPg"},"device":{"type":"string","description":"The type of device the participant used to join the meeting. \n* `Phone` - The participant joined via PSTN. \n* `H.323/SIP` - The participant joined via an H.323 or SIP device. \n* `Windows` - The participant joined via VoIP using a Windows device. \n* `Mac` - The participant joined via VoIP using a Mac device. \n* `iOS` - The participant joined via VoIP using an iOS device. \n* `Android` - The participant joined via VoIP using an Android device. \n\n**Note:** This response returns an empty string (`&ldquo;&ldquo;`) value for any users who are **not** a part of the host's account (external users).","example":"Phone","enum":["Phone","H.323/SIP","Windows","Mac","iOS","Android"]},"client":{"type":"string","description":"Client software or SDK version.","example":"Web Meeting SDK 2.18"},"domain":{"type":"string","description":"The participant's PC domain. \n\n**Note:** This response returns an empty string (`&ldquo;&ldquo;`) value for any users who are **not** a part of the host's account (external users).","example":"example.com"},"harddisk_id":{"type":"string","description":"The participant's hard disk ID. \n\n**Note:** This response returns an empty string (`&ldquo;&ldquo;`) value for any users who are **not** a part of the host's account (external users).","example":"Disk01"},"internal_ip_addresses":{"type":"array","description":"The participant's internal IP addresses. This field will not return under these conditions: \n* The account calling this API is a **legacy** [business associate agreement (BAA) under HIPAA](https://www.ecfr.gov/cgi-bin/retrieveECFR?gp=1&amp;n=se45.1.160_1103&amp;r=SECTION&amp;ty=HTML). \n* The account calling this API is a BAA under HIPAA **without** a signed BAA data processing addendum.","items":{"type":"string","example":"192.0.2.1"}},"ip_address":{"type":"string","description":"The participant's IP address.","example":"192.0.2.1"},"join_time":{"type":"string","description":"The time when the participant joined the meeting.","format":"date-time","example":"2022-03-01T10:15:14Z"},"leave_time":{"type":"string","description":"The time when the participant left the meeting.","format":"date-time","example":"2022-03-01T10:15:14Z"},"location":{"type":"string","description":"The participant's location.","example":"United States"},"mac_addr":{"type":"string","description":"The participant's MAC address. \n\n**Note:** This response returns an empty string (`&ldquo;&ldquo;`) value for any users who are **not** a part of the host's account (external users).","example":"f85e-a012-92d8"},"pc_name":{"type":"string","description":"The participant's PC name.","example":"HW0010449"},"user_id":{"type":"string","description":"The participant's ID. This value is assigned to a participant upon joining a meeting and is only valid for the meeting's duration.","example":"20161536"},"user_name":{"type":"string","description":"The participant's display name.","example":"jchill"},"user_qos":{"type":"array","description":"The participant's quality of service information.","items":{"type":"object","properties":{"as_device_from_crc":{"type":"object","properties":{"avg_loss":{"type":"string","description":"The average amount of packet loss, such as the percentage of packets that failed to arrive at their destination.","example":"0.03%"},"bitrate":{"type":"string","description":"The bits per second transmitted along a digital network, in kilobits per second (kbps).","example":"27.15 kbps"},"jitter":{"type":"string","description":"The variation in the delay of received packets, in milliseconds.","example":"0 ms"},"latency":{"type":"string","description":"The time it took a packet to travel from one point to another, in milliseconds.","example":"126 ms"},"max_loss":{"type":"string","description":"The maximum amount of packet loss, such as the maximum percentage of packets that failed to arrive at their destination.","example":"0.4%"},"frame_rate":{"type":"string","description":"The rate where the video camera can produce unique images (frames). Zoom supports a frame rate of up to 30 fps.","example":"12 fps"},"resolution":{"type":"string","description":"The number of pixels in each dimension that the video camera can display.","example":"1280*720"}},"description":"The QoS metrics for screen sharing by a participant who joined the meeting via CRC."},"as_device_to_crc":{"type":"object","properties":{"avg_loss":{"type":"string","description":"The average amount of packet loss, such as the percentage of packets that failed to arrive at their destination.","example":"0.03%"},"bitrate":{"type":"string","description":"The bits per second transmitted along a digital network, in kilobits per second (kbps).","example":"27.15 kbps"},"jitter":{"type":"string","description":"The variation in the delay of received packets, in milliseconds.","example":"0 ms"},"latency":{"type":"string","description":"The time it took a packet to travel from one point to another, in milliseconds.","example":"126 ms"},"max_loss":{"type":"string","description":"The maximum amount of packet loss, such as the maximum percentage of packets that failed to arrive at their destination.","example":"0.4%"},"frame_rate":{"type":"string","description":"The rate where the video camera can produce unique images (frames). Zoom supports a frame rate of up to 30 fps.","example":"12 fps"},"resolution":{"type":"string","description":"The number of pixels in each dimension that the video camera can display.","example":"1280*720"}},"description":"The QoS metrics for screen sharing output received by a participant who joined the meeting via CRC."},"as_input":{"title":"Screen Share QoS Object","type":"object","description":"The QoS metrics for screen sharing by a participant who joined the meeting","allOf":[{"title":"Audio QoS Object","type":"object","properties":{"avg_loss":{"type":"string","description":"The average amount of packet loss, such as the percentage of packets that failed to arrive at their destination.","example":"0.03%"},"bitrate":{"type":"string","description":"The bits per second transmitted along a digital network, in kilobits per second (kbps).","example":"27.15 kbps"},"jitter":{"type":"string","description":"The variation in the delay of received packets, in milliseconds.","example":"0 ms"},"latency":{"type":"string","description":"The time it took a packet to travel from one point to another, in milliseconds.","example":"126 ms"},"max_loss":{"type":"string","description":"The maximum amount of packet loss, such as the maximum percentage of packets that failed to arrive at their destination.","example":"0.4%"}}},{"type":"object","properties":{"frame_rate":{"type":"string","description":"The rate where the video camera can produce unique images (frames). Zoom supports a frame rate of up to 30 fps.","example":"12 fps"},"resolution":{"type":"string","description":"The number of pixels in each dimension that the video camera can display.","example":"1280*720"}}}]},"as_output":{"title":"Screen Share QoS Object","type":"object","description":"The QoS metrics for screen sharing output received by a participant who joined the meeting","allOf":[{"title":"Audio QoS Object","type":"object","properties":{"avg_loss":{"type":"string","description":"The average amount of packet loss, such as the percentage of packets that failed to arrive at their destination.","example":"0.03%"},"bitrate":{"type":"string","description":"The bits per second transmitted along a digital network, in kilobits per second (kbps).","example":"27.15 kbps"},"jitter":{"type":"string","description":"The variation in the delay of received packets, in milliseconds.","example":"0 ms"},"latency":{"type":"string","description":"The time it took a packet to travel from one point to another, in milliseconds.","example":"126 ms"},"max_loss":{"type":"string","description":"The maximum amount of packet loss, such as the maximum percentage of packets that failed to arrive at their destination.","example":"0.4%"}}},{"type":"object","properties":{"frame_rate":{"type":"string","description":"The rate where the video camera can produce unique images (frames). Zoom supports a frame rate of up to 30 fps.","example":"12 fps"},"resolution":{"type":"string","description":"The number of pixels in each dimension that the video camera can display.","example":"1280*720"}}}]},"audio_device_from_crc":{"type":"object","properties":{"avg_loss":{"type":"string","description":"The average amount of packet loss, such as the percentage of packets that failed to arrive at their destination.","example":"0.03%"},"bitrate":{"type":"string","description":"The bits per second transmitted along a digital network, in kilobits per second (kbps).","example":"27.15 kbps"},"jitter":{"type":"string","description":"The variation in the delay of received packets, in milliseconds.","example":"0 ms"},"latency":{"type":"string","description":"The time it took a packet to travel from one point to another, in milliseconds.","example":"126 ms"},"max_loss":{"type":"string","description":"The maximum amount of packet loss, such as the maximum percentage of packets that failed to arrive at their destination.","example":"0.4%"}},"description":"The QoS metrics for audio sent by a participant who joined the meeting via a Cloud Room Connector (CRC)."},"audio_device_to_crc":{"type":"object","properties":{"avg_loss":{"type":"string","description":"The average amount of packet loss, such as the percentage of packets that failed to arrive at their destination.","example":"0.03%"},"bitrate":{"type":"string","description":"The bits per second transmitted along a digital network, in kilobits per second (kbps).","example":"27.15 kbps"},"jitter":{"type":"string","description":"The variation in the delay of received packets, in milliseconds.","example":"0 ms"},"latency":{"type":"string","description":"The time it took a packet to travel from one point to another, in milliseconds.","example":"126 ms"},"max_loss":{"type":"string","description":"The maximum amount of packet loss, such as the maximum percentage of packets that failed to arrive at their destination.","example":"0.4%"}},"description":"The QoS metrics for audio received by a participant who joined the meeting via CRC."},"audio_input":{"title":"Audio QoS Object","type":"object","properties":{"avg_loss":{"type":"string","description":"The average amount of packet loss, such as the percentage of packets that failed to arrive at their destination.","example":"0.03%"},"bitrate":{"type":"string","description":"The bits per second transmitted along a digital network, in kilobits per second (kbps).","example":"27.15 kbps"},"jitter":{"type":"string","description":"The variation in the delay of received packets, in milliseconds.","example":"0 ms"},"latency":{"type":"string","description":"The time it took a packet to travel from one point to another, in milliseconds.","example":"126 ms"},"max_loss":{"type":"string","description":"The maximum amount of packet loss, such as the maximum percentage of packets that failed to arrive at their destination.","example":"0.4%"}},"description":"The QoS metrics for audio sent by a participant who joined the meeting"},"audio_output":{"title":"Audio QoS Object","type":"object","properties":{"avg_loss":{"type":"string","description":"The average amount of packet loss, such as the percentage of packets that failed to arrive at their destination.","example":"0.03%"},"bitrate":{"type":"string","description":"The bits per second transmitted along a digital network, in kilobits per second (kbps).","example":"27.15 kbps"},"jitter":{"type":"string","description":"The variation in the delay of received packets, in milliseconds.","example":"0 ms"},"latency":{"type":"string","description":"The time it took a packet to travel from one point to another, in milliseconds.","example":"126 ms"},"max_loss":{"type":"string","description":"The maximum amount of packet loss, such as the maximum percentage of packets that failed to arrive at their destination.","example":"0.4%"}},"description":"The QoS metrics for audio received by a participant who joined the meeting"},"cpu_usage":{"type":"object","properties":{"system_max_cpu_usage":{"type":"string","description":"The system's maximum CPU usage.","example":"11%"},"zoom_avg_cpu_usage":{"type":"string","description":"Zoom's average CPU usage.","example":"0%"},"zoom_max_cpu_usage":{"type":"string","description":"Zoom's maximum CPU usage.","example":"2%"},"zoom_min_cpu_usage":{"type":"string","description":"Zoom's minimum CPU usage.","example":"0%"}},"description":"Information about CPU usage."},"cpu_pressure_level":{"type":"object","properties":{"system_min_cpu_pressure_level":{"type":"string","description":"The system’s minimum CPU pressure level","example":"normal","enum":["normal","fair","serious","critical"]},"system_avg_cpu_pressure_level":{"type":"string","description":"The system’s average CPU pressure level","example":"normal","enum":["normal","fair","serious","critical"]},"system_max_cpu_pressure_level":{"type":"string","description":"The system’s maximum CPU pressure level","example":"normal","enum":["critical","serious","fair","normal"]}},"description":"The system’s CPU pressure level"},"date_time":{"type":"string","description":"The QoS date and time.","format":"date-time","example":"2022-03-01T10:16:00Z"},"video_device_from_crc":{"type":"object","properties":{"avg_loss":{"type":"string","description":"The average amount of packet loss, such as the percentage of packets that failed to arrive at their destination.","example":"0.03%"},"bitrate":{"type":"string","description":"The bits per second transmitted along a digital network, in kilobits per second (kbps).","example":"27.15 kbps"},"jitter":{"type":"string","description":"The variation in the delay of received packets, in milliseconds.","example":"0 ms"},"latency":{"type":"string","description":"The time it took a packet to travel from one point to another, in milliseconds.","example":"126 ms"},"max_loss":{"type":"string","description":"The maximum amount of packet loss, such as the maximum percentage of packets that failed to arrive at their destination.","example":"0.03%"},"frame_rate":{"type":"string","description":"The rate where the video camera can produce unique images (frames). Zoom supports a frame rate of up to 30 fps.","example":"12 fps"},"resolution":{"type":"string","description":"The number of pixels in each dimension that the video camera can display.","example":"1280*720"}},"description":"The QoS metrics for video input being sent by a participant who joined the meeting via CRC."},"video_device_to_crc":{"type":"object","properties":{"avg_loss":{"type":"string","description":"The average amount of packet loss, such as the percentage of packets that failed to arrive at their destination.","example":"0.03%"},"bitrate":{"type":"string","description":"The bits per second transmitted along a digital network, in kilobits per second (kbps).","example":"27.15 kbps"},"jitter":{"type":"string","description":"The variation in the delay of received packets, in milliseconds.","example":"0 ms"},"latency":{"type":"string","description":"The time it took a packet to travel from one point to another, in milliseconds.","example":"126 ms"},"max_loss":{"type":"string","description":"The maximum amount of packet loss, such as the maximum percentage of packets that failed to arrive at their destination.","example":"0.4%"},"frame_rate":{"type":"string","description":"The rate where the video camera can produce unique images (frames). Zoom supports a frame rate of up to 30 fps.","example":"12 fps"},"resolution":{"type":"string","description":"The number of pixels in each dimension that the video camera can display.","example":"1280*720"}},"description":"The QoS metrics for video output being sent by a participant who joined the meeting via CRC."},"video_input":{"title":"Video QoS Object","type":"object","description":"The QoS metrics for video input being sent by a participant who joined the meeting","allOf":[{"title":"Audio QoS Object","type":"object","properties":{"avg_loss":{"type":"string","description":"The average amount of packet loss, such as the percentage of packets that failed to arrive at their destination.","example":"0.03%"},"bitrate":{"type":"string","description":"The bits per second transmitted along a digital network, in kilobits per second (kbps).","example":"27.15 kbps"},"jitter":{"type":"string","description":"The variation in the delay of received packets, in milliseconds.","example":"0 ms"},"latency":{"type":"string","description":"The time it took a packet to travel from one point to another, in milliseconds.","example":"126 ms"},"max_loss":{"type":"string","description":"The maximum amount of packet loss, such as the maximum percentage of packets that failed to arrive at their destination.","example":"0.4%"}}},{"type":"object","properties":{"frame_rate":{"type":"string","description":"The rate where the video camera can produce unique images (frames). Zoom supports a frame rate of up to 30 fps.","example":"12 fps"},"resolution":{"type":"string","description":"The number of pixels in each dimension that the video camera can display.","example":"1280*720"}}}]},"video_output":{"title":"Video QoS Object","type":"object","description":"The QoS metrics for video output being sent by a participant who joined the meeting","allOf":[{"title":"Audio QoS Object","type":"object","properties":{"avg_loss":{"type":"string","description":"The average amount of packet loss, such as the percentage of packets that failed to arrive at their destination.","example":"0.03%"},"bitrate":{"type":"string","description":"The bits per second transmitted along a digital network, in kilobits per second (kbps).","example":"27.15 kbps"},"jitter":{"type":"string","description":"The variation in the delay of received packets, in milliseconds.","example":"0 ms"},"latency":{"type":"string","description":"The time it took a packet to travel from one point to another, in milliseconds.","example":"126 ms"},"max_loss":{"type":"string","description":"The maximum amount of packet loss, such as the maximum percentage of packets that failed to arrive at their destination.","example":"0.4%"}}},{"type":"object","properties":{"frame_rate":{"type":"string","description":"The rate where the video camera can produce unique images (frames). Zoom supports a frame rate of up to 30 fps.","example":"12 fps"},"resolution":{"type":"string","description":"The number of pixels in each dimension that the video camera can display.","example":"1280*720"}}}]},"as_device_from_rwg":{"type":"object","properties":{"avg_loss":{"type":"string","description":"The average amount of packet loss, such as the percentage of packets that failed to arrive at their destination.","example":"0.03%"},"bitrate":{"type":"string","description":"The bits per second transmitted along a digital network, in kilobits per second (kbps).","example":"27.15 kbps"},"jitter":{"type":"string","description":"The variation in the delay of received packets, in milliseconds.","example":"0 ms"},"latency":{"type":"string","description":"The time it took a packet to travel from one point to another, in milliseconds.","example":"126 ms"},"max_loss":{"type":"string","description":"The maximum amount of packet loss, such as the maximum percentage of packets that failed to arrive at their destination.","example":"0.4%"},"frame_rate":{"type":"string","description":"The rate where the video camera can produce unique images (frames). Zoom supports a frame rate of up to 30 fps.","example":"12 fps"},"resolution":{"type":"string","description":"The number of pixels in each dimension that the video camera can display.","example":"1280*720"}},"description":"The QoS metrics for screen sharing by a participant who joined the meeting via the web client."},"as_device_to_rwg":{"type":"object","properties":{"avg_loss":{"type":"string","description":"The average amount of packet loss, such as the percentage of packets that failed to arrive at their destination.","example":"0.03%"},"bitrate":{"type":"string","description":"The bits per second transmitted along a digital network, in kilobits per second (kbps).","example":"27.15 kbps"},"jitter":{"type":"string","description":"The variation in the delay of received packets, in milliseconds.","example":"0 ms"},"latency":{"type":"string","description":"The time it took a packet to travel from one point to another, in milliseconds.","example":"126 ms"},"max_loss":{"type":"string","description":"The maximum amount of packet loss, such as the maximum percentage of packets that failed to arrive at their destination.","example":"0.4%"},"frame_rate":{"type":"string","description":"The rate where the video camera can produce unique images (frames). Zoom supports a frame rate of up to 30 fps.","example":"12 fps"},"resolution":{"type":"string","description":"The number of pixels in each dimension that the video camera can display.","example":"1280*720"}},"description":"The QoS output metrics for screen sharing received by a participant who joined the meeting via the web client."},"audio_device_from_rwg":{"type":"object","properties":{"avg_loss":{"type":"string","description":"The average amount of packet loss, such as the percentage of packets that failed to arrive at their destination.","example":"0.03%"},"bitrate":{"type":"string","description":"The bits per second transmitted along a digital network, in kilobits per second (kbps).","example":"27.15 kbps"},"jitter":{"type":"string","description":"The variation in the delay of received packets, in milliseconds.","example":"0 ms"},"latency":{"type":"string","description":"The time it took a packet to travel from one point to another, in milliseconds.","example":"126 ms"},"max_loss":{"type":"string","description":"The maximum amount of packet loss, such as the maximum percentage of packets that failed to arrive at their destination.","example":"0.4%"}},"description":"The QoS metrics for audio sent by a participant who joined the meeting via the web client."},"audio_device_to_rwg":{"type":"object","properties":{"avg_loss":{"type":"string","description":"The average amount of packet loss. For example, the percentage of packets that failed to arrive at their destination.","example":"0.03%"},"bitrate":{"type":"string","description":"The bits per second transmitted along a digital network, in kilobits per second (kbps).","example":"27.15 kbps"},"jitter":{"type":"string","description":"The variation in the delay of received packets, in milliseconds.","example":"0 ms"},"latency":{"type":"string","description":"The time it took a packet to travel from one point to another, in milliseconds.","example":"126 ms"},"max_loss":{"type":"string","description":"The maximum amount of packet loss, such as the maximum percentage of packets that failed to arrive at their destination.","example":"0.4%"}},"description":"The QoS metrics for audio received by a participant who joined the meeting via web client."},"video_device_from_rwg":{"type":"object","properties":{"avg_loss":{"type":"string","description":"The average amount of packet loss, such as the percentage of packets that failed to arrive at their destination.","example":"0.03%"},"bitrate":{"type":"string","description":"The bits per second transmitted along a digital network, in kilobits per second (kbps).","example":"27.15 kbps"},"jitter":{"type":"string","description":"The variation in the delay of received packets, in milliseconds.","example":"0 ms"},"latency":{"type":"string","description":"The time it took a packet to travel from one point to another, in milliseconds.","example":"126 ms"},"max_loss":{"type":"string","description":"The maximum amount of packet loss, such as the maximum percentage of packets that failed to arrive at their destination.","example":"0.03%"},"frame_rate":{"type":"string","description":"The rate where the video camera can produce unique images (frames). Zoom supports a frame rate of up to 30 fps.","example":"12 fps"},"resolution":{"type":"string","description":"The number of pixels in each dimension that the video camera can display.","example":"1280*720"}},"description":"The QoS metrics for video input being sent by a participant who joined the meeting via the web client."},"video_device_to_rwg":{"type":"object","properties":{"avg_loss":{"type":"string","description":"The average amount of packet loss, such as the percentage of packets that failed to arrive at their destination.","example":"0.03%"},"bitrate":{"type":"string","description":"The bits per second transmitted along a digital network, in kilobits per second (kbps).","example":"27.15 kbps"},"jitter":{"type":"string","description":"The variation in the delay of received packets, in milliseconds.","example":"0 ms"},"latency":{"type":"string","description":"The time it took a packet to travel from one point to another, in milliseconds.","example":"126 ms"},"max_loss":{"type":"string","description":"The maximum amount of packet loss, such as the maximum percentage of packets that failed to arrive at their destination.","example":"0.4%"},"frame_rate":{"type":"string","description":"The rate where the video camera can produce unique images (frames). Zoom supports a frame rate of up to 30 fps.","example":"12 fps"},"resolution":{"type":"string","description":"The number of pixels in each dimension that the video camera can display.","example":"1280*720"}},"description":"The QoS metrics for video output being sent by a participant who joined the meeting via the web client."},"wifi_rssi":{"type":"object","properties":{"max_rssi":{"type":"integer","description":"Maximum value of the wireless network's received signal strength indicator (RSSI).","example":-75},"avg_rssi":{"type":"integer","description":"Average value of the wireless network's received signal strength indicator (RSSI).","example":-69},"min_rssi":{"type":"integer","description":"Minimum value of the wireless network's received signal strength indicator (RSSI).","example":-35},"rssi_unit":{"type":"string","description":"Unit of the wireless network's received signal strength indicator (RSSI).","example":"dBm"}},"description":"The QoS metrics for the wireless network's RSSI sent by a participant who joined the meeting through a wireless network."},"audio_socket_break":{"type":"object","properties":{"socket_break":{"type":"boolean","description":"Whether the participant's audio socket broke.","example":true},"socket_break_time":{"type":"string","description":"The participant's audio socket break time.","format":"date-time","example":"2026-04-20T01:50:42Z"},"socket_recover":{"type":"boolean","description":"Whether the participant's audio socket recovered.","example":false},"socket_recover_time":{"type":"string","description":"The participant's audio socket recovery time.","format":"date-time","example":"2026-04-20T01:50:42Z"}},"description":"The QoS metrics for audio socket breaks for a participant who joined the meeting."},"video_socket_break":{"type":"object","properties":{"socket_break":{"type":"boolean","description":"Whether the participant's video socket broke.","example":true},"socket_break_time":{"type":"string","description":"The participant's video socket break time.","format":"date-time","example":"2026-04-20T01:50:42Z"},"socket_recover":{"type":"boolean","description":"Whether the participant's video socket recovered.","example":false},"socket_recover_time":{"type":"string","description":"The participant's video socket recovery time.","format":"date-time","example":"2026-04-20T01:50:42Z"}},"description":"The QoS metrics for video socket breaks for a participant who joined the meeting."},"as_socket_break":{"type":"object","properties":{"socket_break":{"type":"boolean","description":"Whether the participant's screen sharing socket broke.","example":true},"socket_break_time":{"type":"string","description":"The participant's screen sharing socket break time.","format":"date-time","example":"2026-04-20T01:50:42Z"},"socket_recover":{"type":"boolean","description":"Whether the participant's screen sharing socket recovered.","example":false},"socket_recover_time":{"type":"string","description":"The participant's screen sharing socket recovery time.","format":"date-time","example":"2026-04-20T01:50:42Z"}},"description":"The QoS metrics for screen sharing socket breaks for a participant who joined the meeting."},"command_socket_break":{"type":"object","properties":{"socket_break":{"type":"boolean","description":"Whether the participant's command socket broke.","example":true},"socket_break_time":{"type":"string","description":"The participant's command socket break time.","format":"date-time","example":"2026-04-20T01:50:42Z"},"socket_recover":{"type":"boolean","description":"Whether the participant's command socket recovered.","example":false},"socket_recover_time":{"type":"string","description":"The participant's command socket recovery time.","format":"date-time","example":"2026-04-20T01:50:42Z"}},"description":"The QoS metrics for command socket breaks for a participant who joined the meeting."}}}},"version":{"type":"string","description":"The participant's Zoom client version.","example":"5.9.1.2581"},"os":{"type":"string","description":"device operation system","example":"iOS"},"os_version":{"type":"string","description":"device operation system version","example":"16.5"},"browser_name":{"type":"string","description":"webclient operation browser","example":"Firefox"},"browser_version":{"type":"string","description":"webclient operation browser version","example":"133"},"video_connection_type":{"type":"string","description":"The participant's video connection type.","example":"UDP","enum":["P2P","TCP","UDP","Reliable UDP","SSL","HTTP","TCP+Proxy","UDP+Proxy","Reliable+Proxy","SSL+Proxy","HTTP+Proxy"]},"as_connection_type":{"type":"string","description":"The participant's screen share connection type.","example":"UDP","enum":["P2P","TCP","UDP","Reliable UDP","SSL","HTTP","TCP+Proxy","UDP+Proxy","Reliable+Proxy","SSL+Proxy","HTTP+Proxy"]},"participant_uuid":{"type":"string","description":"The participant's UUID. This value assigned to a participant upon joining a meeting and is only valid for the meeting's duration.","example":"D444CD06-2ABB-2FCC-019B-39E41D8DADF7"},"network_type":{"type":"string","description":"The participant's network type. * `Wired` * `Wifi` * `PPP` - Point-to-Point. * `Cellular` - 3G, 4G, and 5G cellular. * `Others` - An unknown device.","example":"Wired","enum":["Wired","Wifi","PPP","Cellular","Others"]},"microphone":{"type":"string","description":"The type of microphone that the participant used during the meeting. **Note:** This response returns an empty string (``) value for any users who are **not** a part of the host's account, such as external users.","example":"Microphone (2- High Definition Audio Device)"},"speaker":{"type":"string","description":"The type of speaker that the participant used during the meeting. **Note:** This response returns an empty string (``) value for any users who are **not** a part of the host's account, such as external users.","example":"speaker (2- High Definition Audio Device)"},"camera":{"type":"string","description":"The type of camera that the participant used during the meeting. **Note:** This response returns an empty string (``) value for any users who are **not** a part of the host's account, such as external users.","example":"FaceTime HD Camera"},"data_center":{"type":"string","description":"The data center that the participant is leveraging to join the meeting.","example":"United States (SC Top)"},"full_data_center":{"type":"string","description":"The data center where participant's meeting data is stored. This field includes a semicolon-separated list of HTTP Tunnel (HT), Cloud Room Connector (CRC), and Real-Time Web Gateway (RWG) location information.","example":"United States (SC Top);"},"connection_type":{"type":"string","description":"The participant's connection type.","example":"UDP","enum":["TCP","P2P","UDP","Reliable UDP","SSL","HTTP","TCP+Proxy","UDP+Proxy","Reliable+Proxy","SSL+Proxy","HTTP+Proxy"]},"share_application":{"type":"boolean","description":"Whether the participant chose to share an application during the meeting.","example":false},"share_desktop":{"type":"boolean","description":"Whether the participant chose to share their desktop during the screenshare.","example":false},"share_whiteboard":{"type":"boolean","description":"Whether the participant chose to share their whiteboard during the screenshare.","example":false},"recording":{"type":"boolean","description":"Whether the recording feature was used during the meeting.","example":false},"device_name":{"type":"string","description":"The device's name.","example":"iPhone 7 Global"},"groupId":{"type":"string","description":"the attendee's group ID.","example":"TcjqVCTzRy6hLa0d8WpAIg"},"has_archiving":{"type":"boolean","description":"The status of the archiving feature for the meeting.","example":true},"optional_archiving":{"type":"string","description":"This is shown only for internal participants who have archiving enabled.","example":"no optional archiving","enum":["no optional archiving","join without archiving","join with archiving"]},"health":{"type":"string","description":"The participant's health.","example":"Warning","default":"Good","enum":["Good","Warning","Critical"]},"total_jointime_cost":{"type":"number","description":"The participant join meeting time cost, the unit is seconds.","example":4.89},"meeting_number":{"type":"string","description":"Unique identifier of the meeting in \"long\" format(represented as int64 data type in JSON)","example":"93201235621"},"zoom_thin_client_plugin_version":{"type":"string","description":"VDI thin client version","example":"6.5.11.26770"},"email":{"type":"string","description":"The participant's email address. 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](/docs/api-reference/using-zoom-apis#email-address) for details.","format":"email","example":"jchill@example.com"},"issue_list":{"maxItems":5,"minItems":0,"type":"array","description":"The participant's issue list.","items":{"type":"string","description":"The participant's issue.","example":"audio"}},"rc_reason":{"type":"string","description":"the call reconnection reason: Client crash","example":"Client crash"},"vdi_plugin_info_status":{"type":"string","description":"The participant's VDI plugin connection status.","example":"Local","enum":["Optimized","UnOptimized","Local"]},"vdi_plugin_info_fb_code_reason":{"type":"string","description":"The participant's VDI plugin fallback reason.","example":"None (no error)"}},"description":"Information about the participant and their quality of service (QoS)."}}}},"400":{"description":"**HTTP Status Code:** `400` <br>\n Bad Request  \n\n **Error Code:** `12702` <br>\n Can not access a meeting a year ago. <br>\n"},"401":{"description":"**HTTP Status Code:** `401` <br>\n Unauthorized  \n\n "},"403":{"description":"**HTTP Status Code:** `403` <br>\n Forbidden  \n\n "},"404":{"description":"**HTTP Status Code:** `404` <br>\n Not Found  \n\n **Error Code:** `3001` <br>\n This meeting's detail info is not available.<br>\nThis meeting has not ended yet or the Meeting ID is invalid. <br>\n"},"429":{"description":"**HTTP Status Code:** `429` <br>\n Too Many Requests. For more information, see [rate limits](https://developers.zoom.us/docs/api/rest/rate-limits/). \n\n "}},"security":[{"openapi_authorization":[]}],"x-extensions":{"x-permissions":["DashboardMeetings:Read"],"x-macro-scopes":["dashboard:master"],"x-granular-scopes":["dashboard:read:meeting_participant_qos:master"]}}},"/accounts/{accountId}/metrics/quality":{"get":{"tags":["Dashboards"],"summary":"Get meeting quality scores","description":"Use this API to return [meeting quality score](https://support.zoom.us/hc/en-us/articles/360061244651-Meeting-quality-scores-and-network-alerts-on-Dashboard) information. Meeting quality scores are based on the mean opinion score (MOS). The MOS measures a meeting's quality on a scale of &quot;Good&quot; (5-4), &quot;Fair&quot; (4-3), &quot;Poor&quot; (3-2), or &quot;Bad&quot; (2-1). \n\n**Prerequisites:** \n* A Business or a higher plan.\n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `dashboard:read:master`,`dashboard:master`\n\n**[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `dashboard:read:meeting_quality_score:master`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Heavy`","operationId":"dashboardQuality","parameters":[{"name":"from","in":"query","description":"Start date in 'yyyy-mm-dd' format. The date range defined by the &quot;from&quot; and &quot;to&quot; parameters should only be one month as the report includes only one month worth of data at once.","required":true,"schema":{"type":"string","format":"date","example":"2022-01-01"}},{"name":"to","in":"query","description":"End date.","required":true,"schema":{"type":"string","format":"date","example":"2022-01-28"}},{"name":"type","in":"query","description":"The type of meeting quality score to query: \n* `meeting` &mdash; Query by meetings. \n* `participants` &mdash; Query by meeting participants.","required":false,"schema":{"type":"string","example":"meeting","default":"meeting","enum":["meeting","participants"]}},{"name":"accountId","in":"path","description":"Unique identifier of the account.","required":true,"schema":{"type":"string","example":"TQTvjT52Tmi_wrhASNNOEw"}}],"responses":{"200":{"description":"**HTTP Status Code:** `200`  \n \nMeeting quality returned","content":{"application/json":{"schema":{"type":"object","properties":{"from":{"type":"string","description":"The report's start date. This value must be within the past six months.","format":"date","example":"2022-02-01"},"quality":{"type":"object","properties":{"audio":{"title":"Meeting Quality Object","type":"object","properties":{"bad":{"type":"integer","description":"The total number of &quot;Bad&quot; quality scores.","example":0},"fair":{"type":"integer","description":"The total number of &quot;Fair&quot; quality scores.","example":0},"good":{"type":"integer","description":"The total number of &quot;Good&quot; quality scores.","example":0},"poor":{"type":"integer","description":"The total number of &quot;Poor&quot; quality scores.","example":0}}},"screen_share":{"title":"Meeting Quality Object","type":"object","properties":{"bad":{"type":"integer","description":"The total number of &quot;Bad&quot; quality scores.","example":0},"fair":{"type":"integer","description":"The total number of &quot;Fair&quot; quality scores.","example":0},"good":{"type":"integer","description":"The total number of &quot;Good&quot; quality scores.","example":0},"poor":{"type":"integer","description":"The total number of &quot;Poor&quot; quality scores.","example":0}}},"video":{"title":"Meeting Quality Object","type":"object","properties":{"bad":{"type":"integer","description":"The total number of &quot;Bad&quot; quality scores.","example":0},"fair":{"type":"integer","description":"The total number of &quot;Fair&quot; quality scores.","example":0},"good":{"type":"integer","description":"The total number of &quot;Good&quot; quality scores.","example":0},"poor":{"type":"integer","description":"The total number of &quot;Poor&quot; quality scores.","example":0}}}},"description":"Information about the meeting quality scores."},"to":{"type":"string","description":"The report's end date. This value must be within the past six months and cannot exceed a month from the `from` value.","format":"date","example":"2022-02-28"}}}}}},"429":{"description":"**HTTP Status Code:** `429` <br>\n Too Many Requests. For more information, see [rate limits](https://developers.zoom.us/docs/api/rest/rate-limits/). \n\n "}},"security":[{"openapi_authorization":[]}],"x-extensions":{"x-permissions":["DashboardHome:Read"],"x-macro-scopes":["dashboard:read:master","dashboard:master"],"x-granular-scopes":["dashboard:read:meeting_quality_score:master"]}}},"/accounts/{accountId}/metrics/webinars":{"get":{"tags":["Dashboards"],"summary":"List webinars","description":"Lists all the live or past webinars from a specified period of time.   \n   \n \n**Prerequisites**  \n \n* Business, Education or API Plan with Webinar add-on.\n\n\n\n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `dashboard:master`\n\n**[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `dashboard:read:list_webinars:master`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `RESOURCE-INTENSIVE`","operationId":"dashboardWebinars","parameters":[{"name":"type","in":"query","description":"The type of webinar to query. \n* `past` - All past webinars. \n* `live` - All live webinars. \n\nThis value defaults to `live`.","required":false,"schema":{"type":"string","example":"past","default":"live","enum":["past","live"]}},{"name":"from","in":"query","description":"The start date in 'yyyy-MM-dd HH:mm:ss' or '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's worth of data at once.","required":true,"schema":{"type":"string","format":"date","example":"2022-01-01"}},{"name":"to","in":"query","description":"The end date 'yyyy-MM-dd HH:mm:ss' or 'yyyy-MM-dd' format.","required":true,"schema":{"type":"string","format":"date","example":"2022-01-28"}},{"name":"page_size","in":"query","description":"The number of records returned within a single API call.","required":false,"schema":{"maximum":300,"type":"integer","example":30,"default":30}},{"name":"next_page_token","in":"query","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.","required":false,"schema":{"type":"string","example":"IAfJX3jsOLW7w3dokmFl84zOa0MAVGyMEB2"}},{"name":"group_id","in":"query","description":"The group ID. To get a group ID, use the [**List groups**](https://developers.zoom.us/docs/api/rest/reference/scim-api/methods/#operation/groupSCIM2List) API.  Participants would be filtered according to their primary group. \n\n **Note:** The API response will only contain webinars where the host is a member of the queried group ID if the &quot;group_include_participant&quot; is false. \nAllow to search multiple groups, when searching multiple items, separate them with commas.\nThe maximum size of groupids is 7","required":false,"schema":{"type":"string","example":"TaVA8QKik_1233,TaVA8QKik_1234"}},{"name":"group_include_participant","in":"query","description":"Whether the response will contain webinars where the participant is a member of the queried group ID.","required":false,"schema":{"type":"boolean","example":true}},{"name":"query_date_type","in":"query","description":"The type of date to query. This field is only supported when `type` is `past`. \r\n* `start_time` - Query by call start time. \r\n* `end_time` - Query by call end time. \r\n\r\nThis value defaults to `start_time`.","required":false,"schema":{"type":"string","example":"end_time","enum":["start_time","end_time"]}},{"name":"accountId","in":"path","description":"Unique identifier of the account.","required":true,"schema":{"type":"string","example":"TQTvjT52Tmi_wrhASNNOEw"}}],"responses":{"200":{"description":"**HTTP Status Code:** `200`  \n \nMeetings returned.  \n \nOnly available for paid accounts that have enabled the Dashboard feature.","content":{"application/json":{"schema":{"allOf":[{"type":"object","properties":{"from":{"type":"string","description":"The inputted 'from' parameter format, 'yyyy-MM-dd HH:mm:ss' or 'yyyy-MM-dd' format.","format":"date","example":"2022-01-01"},"to":{"type":"string","description":"The inputted 'to' parameter format, 'yyyy-MM-dd HH:mm:ss' or 'yyyy-MM-dd' format.","format":"date","example":"2022-01-30"}}},{"type":"object","properties":{"next_page_token":{"type":"string","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.","example":"Tva2CuIdTgsv8wAnhyAdU3m06Y2HuLQtlh3"},"page_count":{"type":"integer","description":"The number of pages returned for the request made.","example":1},"page_size":{"maximum":300,"type":"integer","description":"The number of records returned within a single API call.","example":30,"default":30},"total_records":{"type":"integer","description":"The number of all records available across pages.","example":1}},"description":"The pagination object."},{"type":"object","properties":{"webinars":{"type":"array","description":"The array of webinar objects.","items":{"title":"Webinar Metrics","type":"object","properties":{"host":{"type":"string","description":"The user display name.","example":"user@example.com"},"custom_keys":{"maxItems":10,"type":"array","description":"The custom keys and values assigned to the webinar.","items":{"type":"object","properties":{"key":{"maxLength":64,"type":"string","description":"The custom key associated with the webinar.","example":"key1"},"value":{"maxLength":256,"type":"string","description":"The value of the custom key associated with the webinar.","example":"value1"}}}},"dept":{"type":"string","description":"The host's department.","example":"Developers"},"duration":{"type":"string","description":"The webinar duration, formatted as `hh:mm:ss`. For example, `10:00` for ten minutes.","example":"55:01"},"email":{"type":"string","description":"The user email.","example":"user@example.com"},"end_time":{"type":"string","description":"The webinar end time.","format":"date-time","nullable":true,"example":"2022-01-13T07:00:46Z"},"has_3rd_party_audio":{"type":"boolean","description":"Whether a third paty is being used for the webinar.","example":true},"has_archiving":{"type":"boolean","description":"Whether the archiving feature was used in the webinar.","example":true},"has_pstn":{"type":"boolean","description":"Whether or not PSTN was used for the webinar.","example":true},"has_recording":{"type":"boolean","description":"Whether or not recording was used for the webinar.","example":true},"has_screen_share":{"type":"boolean","description":"Whether or not screen sharing was used for the webinar.","example":true},"has_sip":{"type":"boolean","description":"Whether or not SIP was used for the webinar.","example":true},"has_video":{"type":"boolean","description":"Whether or not video was used for the webinar.","example":true},"has_voip":{"type":"boolean","description":"Whether or not VoIP was used for the webinar.","example":true},"has_manual_captions":{"type":"boolean","description":"Whether a manual caption was enabled in the meeting.","example":true},"has_automated_captions":{"type":"boolean","description":"Whether an automated caption was enabled in the meeting.","example":true},"id":{"type":"integer","description":"The webinar ID in **long** format, represented as int64 data type in JSON. Also known as the webinar number.","format":"int64","example":99264817135},"participants":{"type":"integer","description":"The webinar participant count.","example":1},"start_time":{"type":"string","description":"The webinar start time.","format":"date-time","example":"2022-01-13T05:27:11Z"},"topic":{"type":"string","description":"The webinar topic.","example":"my webinar"},"user_type":{"type":"string","description":"User type.","example":"Licensed"},"uuid":{"type":"string","description":"The webinar UUID.","example":"NknQtFSgSUSEYt2a9gc13A=="},"audio_quality":{"type":"string","description":"The webinar's [audio quality score](https://support.zoom.us/hc/en-us/articles/360061244651-Using-meeting-quality-scores-and-network-alerts). \n* `good` - The audio is almost flawless and the quality is excellent. \n* `fair` - The audio occasionally has distortion, noise, and other problems, but the content is basically continuous. Participants can communicate normally. \n* `poor` - The audio often has distortion, noise, and other problems, but the content is basically continuous. Participants can communicate normally. \n* `bad` - The sound quality is extremely poor and the audio content is almost inaudible.","example":"good","enum":["good","fair","poor","bad"]},"video_quality":{"type":"string","description":"The webinar's [video quality score](https://support.zoom.us/hc/en-us/articles/360061244651-Using-meeting-quality-scores-and-network-alerts). \n* `good` - The video is almost flawless and the quality is excellent. \n* `fair` - The video definition is high, occasionally gets stuck, fast or slow, or other problems, but the frequency is very low and the video quality is good. \n* `poor` - The video definition is not high, but not many problems exist. The video quality is mediocre. \n* `bad` - The picture is very blurred and often gets stuck.","example":"good","enum":["good","fair","poor","bad"]},"screen_share_quality":{"type":"string","description":"The webinar's [screen share quality score](https://support.zoom.us/hc/en-us/articles/360061244651-Using-meeting-quality-scores-and-network-alerts). \n* `good` - The video is almost flawless and the quality is excellent. \n* `fair` - The video definition is high, occasionally gets stuck, fast or slow, or other problems, but the frequency is very low and the video quality is good. \n* `poor` - The video definition is not high, but not many problems exist. The video quality is mediocre. \n* `bad`- The picture is very blurred and often gets stuck.","example":"good","enum":["good","fair","poor","bad"]},"has_poll":{"type":"boolean","description":"Whether or not poll was used in the meeting.","example":false},"has_survey":{"type":"boolean","description":"Whether or not survey was used in the meeting.","example":false},"has_external_participant":{"type":"boolean","description":"Whether the webinar has an external participant.","example":true}},"description":"The webinar metric details."}}}}]}}}},"429":{"description":"**HTTP Status Code:** `429` <br>\n Too Many Requests. For more information, see [rate limits](https://developers.zoom.us/docs/api/rest/rate-limits/). \n\n "}},"security":[{"openapi_authorization":[]}],"x-extensions":{"x-permissions":[],"x-macro-scopes":["dashboard:master"],"x-granular-scopes":["dashboard:read:list_webinars:master"]}}},"/accounts/{accountId}/metrics/webinars/{webinarId}":{"get":{"tags":["Dashboards"],"summary":"Get webinar details","description":"Retrieve details from live or past webinars.  \n   \n \n**Prerequisites:**  \n \n* Business, Education or API Plan with Webinar add-on.\n\n\n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `dashboard:master`\n\n**[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `dashboard:read:webinar:master`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `HEAVY`","operationId":"dashboardWebinarDetail","parameters":[{"name":"webinarId","in":"path","description":"The webinar's ID or universally unique ID (UUID). \n* If you provide a webinar ID, the API will return a response for the latest webinar instance. \n* If you provide a webinar 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 webinar UUID before making an API request.","required":true,"schema":{"type":"string","example":"ABCDE12345"}},{"name":"type","in":"query","description":"The type of webinar to query: \n* `past` &mdash; All past webinars. \n* `live` - All live webinars. \n\nThis value defaults to `live`.","required":false,"schema":{"type":"string","example":"past","default":"live","enum":["past","live"]}},{"name":"accountId","in":"path","description":"Unique identifier of the account.","required":true,"schema":{"type":"string","example":"TQTvjT52Tmi_wrhASNNOEw"}}],"responses":{"200":{"description":"**HTTP Status Code:** `200`  \n \nWebinar details returned.  \n \nOnly available for paid accounts that have enabled the Dashboard feature.","content":{"application/json":{"schema":{"title":"Webinar Metrics","type":"object","properties":{"host":{"type":"string","description":"User display name.","example":"user@example.com"},"custom_keys":{"maxItems":10,"type":"array","description":"Custom keys and values assigned to the Webinar.","items":{"type":"object","properties":{"key":{"maxLength":64,"type":"string","description":"Custom key associated with the Webinar.","example":"key1"},"value":{"maxLength":256,"type":"string","description":"Value of the custom key associated with the Webinar.","example":"value1"}}}},"dept":{"type":"string","description":"Department of the host.","example":"Developers"},"duration":{"type":"string","description":"Webinar duration, formatted as hh:mm:ss, for example: `10:00` for ten minutes.","example":"55:01"},"email":{"type":"string","description":"User email.","example":"user@example.com"},"end_time":{"type":"string","description":"Webinar end time.","format":"date-time","example":"2022-01-13T07:00:46Z"},"has_3rd_party_audio":{"type":"boolean","description":"Use TSP for the Webinar.","example":true},"has_archiving":{"type":"boolean","description":"Whether the archiving feature was used in the webinar.","example":true},"has_pstn":{"type":"boolean","description":"Indicates whether or not PSTN was used for the Webinar.","example":true},"has_recording":{"type":"boolean","description":"Indicates whether or not recording was used for the Webinar.","example":true},"has_screen_share":{"type":"boolean","description":"Indicates whether or not screen sharing was used for the Webinar.","example":true},"has_sip":{"type":"boolean","description":"Indicates whether or not SIP was used for the Webinar.","example":true},"has_video":{"type":"boolean","description":"Indicates whether or not video was used for the Webinar.","example":true},"has_voip":{"type":"boolean","description":"Indicates whether or not VoIP was used for the Webinar.","example":true},"has_manual_captions":{"type":"boolean","description":"Indicates whether a manual caption was enabled in the meeting.","example":true},"has_automated_captions":{"type":"boolean","description":"Indicates whether an automated caption was enabled in the meeting.","example":true},"id":{"type":"integer","description":"Webinar ID in &quot;**long**&quot; format(represented as int64 data type in JSON), also known as the webinar number.","format":"int64","example":99264817135},"participants":{"type":"integer","description":"Webinar participant count.","example":1},"start_time":{"type":"string","description":"Webinar start time.","format":"date-time","example":"2022-01-13T05:27:11Z"},"topic":{"type":"string","description":"Webinar topic.","example":"my webinar"},"user_type":{"type":"string","description":"User type.","example":"Licensed"},"uuid":{"type":"string","description":"Webinar UUID.","example":"NknQtFSgSUSEYt2a9gc13A=="},"audio_quality":{"type":"string","description":"The webinar's [audio quality score](https://support.zoom.us/hc/en-us/articles/360061244651-Using-meeting-quality-scores-and-network-alerts): \n* `good` &mdash; The audio is almost flawless and the quality is excellent. \n* `fair` &mdash; The audio occasionally has distortion, noise, and other problems, but the content is basically continuous. Participants can communicate normally. \n* `poor` &mdash; The audio often has distortion, noise, and other problems, but the content is basically continuous. Participants can communicate normally. \n* `bad` &mdash; The sound quality is extremely poor and the audio content is almost inaudible.","example":"good","enum":["good","fair","poor","bad"]},"video_quality":{"type":"string","description":"The webinar's [video quality score](https://support.zoom.us/hc/en-us/articles/360061244651-Using-meeting-quality-scores-and-network-alerts): \n* `good` &mdash; The video is almost flawless and the quality is excellent. \n* `fair` &mdash; The video definition is high, occasionally gets stuck, fast or slow, or other problems, but the frequency is very low and the video quality is good. \n* `poor` &mdash; The video definition is not high, but not many problems exist. The video quality is mediocre. \n* `bad` &mdash; The picture is very blurred and often gets stuck.","example":"good","enum":["good","fair","poor","bad"]},"screen_share_quality":{"type":"string","description":"The webinar's [screen share quality score](https://support.zoom.us/hc/en-us/articles/360061244651-Using-meeting-quality-scores-and-network-alerts): \n* `good` &mdash; The video is almost flawless and the quality is excellent. \n* `fair` &mdash; The video definition is high, occasionally gets stuck, fast or slow, or other problems, but the frequency is very low and the video quality is good. \n* `poor` &mdash; The video definition is not high, but not many problems exist. The video quality is mediocre. \n* `bad` &mdash; The picture is very blurred and often gets stuck.","example":"good","enum":["good","fair","poor","bad"]},"has_meeting_summary":{"type":"boolean","description":"Whether the summary feature was used in the meeting.","example":true},"has_aic_conversation":{"type":"boolean","description":"Whether the aic conversation feature was used in the meeting.","example":true},"has_poll":{"type":"boolean","description":"Whether or not poll was used in the meeting.","example":false},"has_survey":{"type":"boolean","description":"Whether or not survey was used in the meeting.","example":false},"has_external_participant":{"type":"boolean","description":"Whether the webinar has an external participant.","example":true}},"description":"Webinar metric details."}}}},"400":{"description":"**HTTP Status Code:** `400` <br>\n Bad Request  \n\n **Error Code:** `12702` <br>\n Can not access a webinar a year ago. <br>\n"},"404":{"description":"**HTTP Status Code:** `404` <br>\n Not Found  \n\n **Error Code:** `3001` <br>\n The webinar has not ended yet or the Webinar ID is not valid.<br>\nThis webinar's detail is not available. <br>\n"},"429":{"description":"**HTTP Status Code:** `429` <br>\n Too Many Requests. For more information, see [rate limits](https://developers.zoom.us/docs/api/rest/rate-limits/). \n\n "}},"security":[{"openapi_authorization":[]}],"x-extensions":{"x-permissions":["DashboardWebinars:Read"],"x-macro-scopes":["dashboard:master"],"x-granular-scopes":["dashboard:read:webinar:master"]}}},"/accounts/{accountId}/metrics/webinars/{webinarId}/participants":{"get":{"tags":["Dashboards"],"summary":"Get webinar participants","description":"Get information about participants from live or past webinars. \n\n**Note:** This API endpoint displays only information for external users (users **not** part of the host's account) that meet the criteria of the [email address display rules](https://developers.zoom.us/docs/api/rest/using-zoom-apis/#email-address-display-rules), and returns empty values for participants who do not meet the criteria.  \n\n\n\n**Prerequisites:** \n* A Business, Education, or API Plan with Webinar add-on.\n\n* Any [**legacy** HIPAA BAA account](/docs/api-reference/other-references/legacy-business-associate-agreements). \n* No signed HIPAA business associate agreement (BAA).\n\n\n\n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `dashboard:master`\n\n**[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `dashboard:read:list_webinar_participants:master`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `HEAVY`","operationId":"dashboardWebinarParticipants","parameters":[{"name":"webinarId","in":"path","description":"The webinar's ID or universally unique ID (UUID). \n* If you provide a webinar ID, the API returns a response for the latest webinar instance. \n* If you provide a webinar UUID that begins with a `/` character or contains the `//` characters, you **must** double-encode the webinar UUID before making an API request.","required":true,"schema":{"type":"string","example":"ABCDE12345"}},{"name":"type","in":"query","description":"The type of webinar to query. \n* `past` - All past webinars. \n* `live` - All live webinars. \n\nThis value defaults to `live`.","required":false,"schema":{"type":"string","example":"past","default":"live","enum":["past","live"]}},{"name":"page_size","in":"query","description":"The number of records returned within a single API call.","required":false,"schema":{"maximum":300,"type":"integer","example":30,"default":30}},{"name":"next_page_token","in":"query","description":"The next page token paginates through a large set of results. A next page token returns whenever the set of available results exceeds the current page size. The expiration period for this token is 15 minutes.","required":false,"schema":{"type":"string","example":"IAfJX3jsOLW7w3dokmFl84zOa0MAVGyMEB2"}},{"name":"include_fields","in":"query","description":"The additional fields to include in the query. \n* `registrant_id` - Includes the webinar registrant's ID. The registrant ID is the [webinar registrant's unique ID](/docs/api-reference/zoom-api/methods#operation/webinarRegistrants).","required":false,"schema":{"type":"string","example":"registrant_id","enum":["registrant_id"]}},{"name":"accountId","in":"path","description":"Unique identifier of the account.","required":true,"schema":{"type":"string","example":"TQTvjT52Tmi_wrhASNNOEw"}}],"responses":{"200":{"description":"**HTTP Status Code:** `200`  \n \nWebinar participants returned.  \n \nThis API is only available for ZMP and Business or higher accounts that have enabled the Dashboard feature.","content":{"application/json":{"schema":{"allOf":[{"type":"object","properties":{"next_page_token":{"type":"string","description":"The next page token paginates through a large set of results. A next page token returns whenever the set of available results exceeds the current page size. The expiration period for this token is 15 minutes.","example":"Tva2CuIdTgsv8wAnhyAdU3m06Y2HuLQtlh3"},"page_count":{"type":"integer","description":"The number of pages returned for the request.","example":1},"page_size":{"maximum":300,"type":"integer","description":"The number of records returned within a single API call.","example":30,"default":30},"total_records":{"type":"integer","description":"The number of all records available across pages.","example":1},"webinar_number":{"type":"string","description":"Unique identifier of the webinar in \"long\" format(represented as int64 data type in JSON).","example":"93201235621"}},"description":"Pagination object."},{"type":"object","properties":{"participants":{"type":"array","description":"Information about the webinar participants.","items":{"type":"object","properties":{"audio_quality":{"type":"string","description":"The participant's [audio quality score](https://support.zoom.us/hc/en-us/articles/360061244651-Using-meeting-quality-scores-and-network-alerts). \n* `good` - The audio is almost flawless and the quality is excellent. \n* `fair` - The audio occasionally has distortion, noise, and other problems, but the content is basically continuous. Participants can communicate normally. \n* `poor` - The audio often has distortion, noise, and other problems, but the content is basically continuous. Participants can communicate normally. \n* `bad` - The sound quality is extremely poor and the audio content is almost inaudible.","example":"good","enum":["","good","fair","poor","bad"]},"connection_type":{"type":"string","description":"The participant' connection type.","example":"UDP","enum":["P2P","TCP","UDP","Reliable UDP","SSL","HTTP","TCP+Proxy","UDP+Proxy","Reliable+Proxy","SSL+Proxy","HTTP+Proxy"]},"video_connection_type":{"type":"string","description":"The participant's video connection type.","example":"UDP","enum":["P2P","TCP","UDP","Reliable UDP","SSL","HTTP","TCP+Proxy","UDP+Proxy","Reliable+Proxy","SSL+Proxy","HTTP+Proxy"]},"as_connection_type":{"type":"string","description":"The participant's screen share connection type.","example":"UDP","enum":["P2P","TCP","UDP","Reliable UDP","SSL","HTTP","TCP+Proxy","UDP+Proxy","Reliable+Proxy","SSL+Proxy","HTTP+Proxy"]},"customer_key":{"maxLength":35,"type":"string","description":"The participant's SDK identifier. This value can be alphanumeric, up to a maximum length of 35 characters.","example":"349589LkJyeW"},"data_center":{"type":"string","description":"The data center that the participant is leveraging to join the webinar.","example":"United States"},"device":{"type":"string","description":"The type of device the participant used to join the webinar. \n* `Phone` - The participant joined via PSTN. \n* `H.323/SIP` - The participant joined via an H.323 or SIP device. \n* `Windows` - The participant joined via VoIP using a Windows device. \n* `Mac` - The participant joined via VoIP using a Mac device. \n* `iOS` - The participant joined via VoIP using an iOS device. \n* `Android` - The participant joined via VoIP using an Android device. \n\n**Note:** This response returns an empty string (``) value for any users who are **not** a part of the host's account (external users).","example":"Phone","enum":["Phone","H.323/SIP","Windows","Mac","iOS","Android"]},"domain":{"type":"string","description":"The participant's PC domain. \n\n**Note:** This response returns an empty string (``) value for any users who are **not** a part of the host's account (external users).","example":"example.com"},"email":{"type":"string","description":"The participant's email address. 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](/docs/api-reference/using-zoom-apis#email-address) for details.","example":"jchill@example.com"},"from_sip_uri":{"type":"string","description":"The meeting participant's SIP From header URI. The API only returns this response when the participant joins a meeting via SIP.","example":"example.com"},"full_data_center":{"type":"string","description":"The data center where participant's meeting data is stored. This field includes a semicolon-separated list of HTTP Tunnel (HT), Cloud Room Connector (CRC), and Real-Time Web Gateway (RWG) location information.","example":"United States;China (TJ RWG);"},"harddisk_id":{"type":"string","description":"The participant's hard disk ID. \n\n**Note:** This response returns an empty string (``) value for any users who are **not** a part of the host's account (external users).","example":"Disk01"},"id":{"type":"string","description":"The participant's universally unique ID (UUID): \n* If the participant joins the meeting by logging into Zoom, this value is the `id` value in the [**Get a user**](/docs/api-reference/zoom-api/methods#operation/user) API response. \n* If the participant joins the meeting **without** logging into Zoom, this returns an empty string value. \n\n**Note:** Use the `participant_user_id` value instead of this value. We will remove this response in a future release.","example":"_f08HhPJS82MIVLuuFaJPg"},"internal_ip_addresses":{"type":"array","description":"The participant's internal IP addresses. This field will not return when: \n* The account calling this API is a **legacy** [business associate agreement (BAA) under HIPAA](https://www.ecfr.gov/cgi-bin/retrieveECFR?gp=1&amp;n=se45.1.160_1103&amp;r=SECTION&amp;ty=HTML). \n* The account calling this API is a BAA under HIPAA **without** a signed BAA data processing addendum.","items":{"type":"string","example":"198.51.100.1"}},"ip_address":{"type":"string","description":"The participant's IP address.","example":"192.0.2.1"},"join_time":{"type":"string","description":"The time when participant joined the webinar.","format":"date-time","example":"2022-01-13T05:27:09Z"},"leave_reason":{"type":"string","description":"The reason why the participant left the webinar, where `$name` is the participant's username: \n* `$name left the meeting.` \n* `$name got disconnected from the meeting.` \n* `Host ended the meeting.` \n* `Host closed the meeting.` \n* `Host started a new meeting.` \n* `Network connection error.` \n* `Host did not join.` \n* `Exceeded free meeting minutes limit.` \n* `Removed by host.` \n* `Unknown reason.` \n* `Leave waiting room.` \n* `Removed by host from waiting room.`","example":"Host ended the webinar.","enum":["$name left the webinar.","$name got disconnected from the webinar.","Host ended the webinar.","Host closed the webinar.","Host started a new webinar.","Network connection error.","Host did not join.","Exceeded free webinar minutes limit.","Removed by host.","Unknown reason.","Leave waiting room.","Removed by host from waiting room."]},"leave_time":{"type":"string","description":"The time when a participant left the webinar. For live webinars, this field will only return if a participant has left the ongoing webinar.","format":"date-time","example":"2022-01-13T05:41:01Z"},"location":{"type":"string","description":"The participant's location.","example":"United States"},"mac_addr":{"type":"string","description":"The participant's MAC address. \n\n**Note:** This response returns an empty string (`&ldquo;&ldquo;`) value for any users who are **not** a part of the host's account (external users).","example":"f85e-a012-92d8"},"microphone":{"type":"string","description":"The type of microphone that the participant used during the webinar. \n\n**Note:** This response returns an empty string (`&ldquo;&ldquo;`) value for any users who are **not** a part of the host's account (external users).","example":"Plantronics BT600"},"network_type":{"type":"string","description":"The participant's network type. \n\n* `Wired` \n* `Wifi` \n* `PPP` - Point-to-Point. \n* `Cellular` - 3G, 4G, and 5G cellular. \n* `Others` - An unknown device.","example":"Wired","enum":["Wired","Wifi","PPP","Cellular","Others"]},"participant_user_id":{"type":"string","description":"The participant's universally unique ID (UUID). \n* If the participant joins the meeting by logging into Zoom, this value is the `id` value in the [**Get a user**](/docs/api-reference/zoom-api/methods#operation/user) API response. \n* If the participant joins the meeting **without** logging into Zoom, this returns an empty string value.","example":"DYHrdpjrS3uaOf7dPkkg8w"},"pc_name":{"type":"string","description":"The participant's PC name.","example":"My PC"},"recording":{"type":"boolean","description":"Whether the recording feature was used during the webinar.","example":true},"registrant_id":{"type":"string","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.","example":"_f08HhPJS82MIVLuuFaJPg"},"role":{"type":"string","description":"The participant's role. \n* `host` - Host. \n* `attendee` - Attendee. \n* `panelist` - Panelist.","example":"host","enum":["host","attendee","panelist"]},"screen_share_quality":{"type":"string","description":"The participant's [screen share quality score](https://support.zoom.us/hc/en-us/articles/360061244651-Using-meeting-quality-scores-and-network-alerts). \n* `good` - The video is almost flawless and the quality is excellent. \n* `fair` - The video definition is high, occasionally gets stuck, fast or slow, or other problems, but the frequency is very low and the video quality is good. \n* `poor` - The video definition is not high, but not many problems exist. The video quality is mediocre. \n* `bad` - The picture is very blurred and often gets stuck.","example":"good","enum":["","good","fair","poor","bad"]},"share_application":{"type":"boolean","description":"Whether the participant chose to share an iPhone/iPad app during the screenshare.","example":true},"share_desktop":{"type":"boolean","description":"Whether the participant chose to share their desktop during the screenshare.","example":true},"share_whiteboard":{"type":"boolean","description":"Whether the participant chose to share their whiteboard during the screenshare.","example":true},"sip_uri":{"type":"string","description":"The meeting participant's SIP (Session Initiation Protocol) Contact header URI. The API only returns this response when the participant joins a meeting via SIP.","example":"example.com"},"speaker":{"type":"string","description":"The type of speaker that the participant used during the webinar. \n\n**Note:** This response returns an empty string (`&ldquo;&ldquo;`) value for any users who are **not** a part of the host's account (external users).","example":"speaker (2- High Definition Audio Device)"},"user_id":{"type":"string","description":"The participant's ID. This value assigned to a participant upon joining a webinar and is only valid for the webinar's duration.","example":"33080320"},"participant_uuid":{"type":"string","description":"The participant's UUID. This value assigned to a participant upon joining a webinar and is only valid for the webinar's duration.","example":"D444CD06-2ABB-2FCC-019B-39E41D8DADF7"},"user_name":{"type":"string","description":"The participant's display name.","example":"jchill"},"version":{"type":"string","description":"The participant's Zoom client version.","example":"5.9.1.2581"},"video_quality":{"type":"string","description":"The participant's video quality. \n* `good` - The video is almost flawless and the quality is excellent. \n* `fair` - The video definition is high, occasionally gets stuck, fast or slow, or other problems, but the frequency is very low and the video quality is good. \n* `poor` - The video definition is not high, but not many problems exist. The video quality is mediocre. \n* `bad` - The picture is very blurred and often gets stuck.","example":"good","enum":["","good","fair","poor","bad"]},"audio_call":{"type":"array","description":"Information about the meeting participant's audio call. Some participants may join the meeting through the phone call or are bound to the audio.","items":{"type":"object","properties":{"call_number":{"type":"string","description":"The caller's number.","example":"4131"},"call_type":{"type":"string","description":"The call type.","example":"call-in","enum":["call-in","call-out"]},"zoom_number":{"type":"string","description":"The toll-free telephone number.","example":"18773690926"}}}},"os":{"type":"string","description":"device operation system","example":"iOS"},"os_version":{"type":"string","description":"device operation system version","example":"16.5"},"browser_name":{"type":"string","description":"webclient operation browser","example":"Firefox"},"browser_version":{"type":"string","description":"webclient operation browser version","example":"133"},"device_name":{"type":"string","description":"device's name","example":"iPhone 7 Global"},"client":{"type":"string","description":"Client software version or SDK version","example":"Web Meeting SDK 2.18"},"has_archiving":{"type":"boolean","description":"The status of the archiving feature for the meeting","example":false},"optional_archiving":{"type":"string","description":"This is shown only for internal participants who have archiving enabled","example":"no optional archiving","enum":["no optional archiving","join without archiving","join with archiving"]},"bo_mtg_id":{"type":"string","description":"The [breakout room](https://support.zoom.us/hc/en-us/articles/206476313-Managing-breakout-rooms) ID. Each breakout room is assigned a unique ID.","example":"Dkgwu8nm/ExG1vM+GhLRhA=="},"zoom_thin_client_plugin_version":{"type":"string","description":"VDI thin client version","example":"6.5.11.26770"},"vdi_plugin_info_status":{"type":"string","description":"The participant's VDI plugin connection status.","example":"Local","enum":["Optimized","UnOptimized","Local"]},"vdi_plugin_info_fb_code_reason":{"type":"string","description":"The participant's VDI plugin fallback reason.","example":"None (no error)"}}}}}}]}}}},"400":{"description":"**HTTP Status Code:** `400` <br>\n Bad Request  \n\n **Error Code:** `12702` <br>\n Cannot access a webinar a year ago. <br>\n"},"401":{"description":"**HTTP Status Code:** `401` <br>\n Unauthorized  \n\n "},"403":{"description":"**HTTP Status Code:** `403` <br>\n Forbidden  \n\n "},"404":{"description":"**HTTP Status Code:** `404` <br>\n Not Found  \n\n **Error Code:** `3001` <br>\n This webinar's detail information is not available or the ID is not valid. <br>\n"},"429":{"description":"**HTTP Status Code:** `429` <br>\n Too Many Requests. For more information, see [rate limits](https://developers.zoom.us/docs/api/rest/rate-limits/). \n\n "}},"security":[{"openapi_authorization":[]}],"x-extensions":{"x-permissions":[],"x-macro-scopes":["dashboard:master"],"x-granular-scopes":["dashboard:read:list_webinar_participants:master"]}}},"/accounts/{accountId}/metrics/webinars/{webinarId}/participants/qos":{"get":{"tags":["Dashboards"],"summary":"List webinar participant QoS","description":"Show a list of webinar participants from live or past webinars and the quality of service they received during the webinar. The data returned indicates the connection quality for sending/receiving video, audio, and shared content. \n\n**Note:** \n\nThis API may return empty values for participants' `user_name`, `ip_address`, `location`, and `email` responses when the account calling this API: \n* Does **not** have a signed HIPAA business associate agreement (BAA). \n* Is a [**legacy** HIPAA BAA account](https://developers.zoom.us/docs/api/rest/other-references/legacy-business-associate-agreements/). \n* Displays data for any users who are **not** part of the host's account, such as external users, unless they meet certain conditions. See [Email address display rules](https://developers.zoom.us/docs/api/rest/using-zoom-apis/#email-address-display-rules) for details. \n\n**Prerequisites:** \n* A Business, Education, or API Plan with Webinar add-on.\n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `dashboard:master`\n\n**[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `dashboard:read:list_webinar_participants_qos:master`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `HEAVY`","operationId":"dashboardWebinarParticipantsQOS","parameters":[{"name":"webinarId","in":"path","description":"The webinar's ID or universally unique ID (UUID). \n* If you provide a webinar ID, the API will return a response for the latest webinar instance. \n* If you provide a webinar UUID that begins with a `/` character or contains the `//` characters, you **must** double-encode the webinar UUID before making an API request.","required":true,"schema":{"type":"string","example":"ABCDE12345"}},{"name":"type","in":"query","description":"The type of webinar to query. \n* `past` - All past webinars. \n* `live` - All live webinars. \n\nThis value defaults to `live`.","required":false,"schema":{"type":"string","example":"past","default":"live","enum":["past","live"]}},{"name":"page_size","in":"query","description":"The number of items returned per page.","required":false,"schema":{"maximum":10,"type":"integer","example":10,"default":1}},{"name":"next_page_token","in":"query","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.","required":false,"schema":{"type":"string","example":"IAfJX3jsOLW7w3dokmFl84zOa0MAVGyMEB2"}},{"name":"accountId","in":"path","description":"Unique identifier of the account.","required":true,"schema":{"type":"string","example":"TQTvjT52Tmi_wrhASNNOEw"}}],"responses":{"200":{"description":"**HTTP Status Code:** `200`  \n \nWebinar participants returned.  \n \nThis API is only available for ZMP and Business or higher accounts that have enabled the Dashboard feature.","content":{"application/json":{"schema":{"title":"Participant QOS List","description":"Information about the participants and their quality of service (QoS).","allOf":[{"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 exceed the current page size. The expiration period for this token is 15 minutes.","example":"y20RGLOiO2jTy3CMfnNRORmB51kAuhMy0e2"},"page_count":{"type":"integer","description":"The number of pages returned for the request made.","format":"int64","example":2},"page_size":{"maximum":10,"type":"integer","description":"The number of items per page.","example":10,"default":1},"total_records":{"type":"integer","description":"The number of all records available across pages.","format":"int64","example":2},"webinar_number":{"type":"string","description":"Unique identifier of the webinar in \"long\" format(represented as int64 data type in JSON)","example":"93201235621"}},"description":"Pagination object."},{"type":"object","properties":{"participants":{"type":"array","description":"Information about the participant.","items":{"title":"Participant QOS","type":"object","properties":{"id":{"type":"string","description":"The participant's universally unique ID. This value is the same as the participant's user ID if the participant joins the webinar by logging into Zoom. If the participant joins the webinar without logging into Zoom, this returns an empty value.","example":"_f08HhPJS82MIVLuuFaJPg"},"device":{"type":"string","description":"The type of device the participant used to join the meeting. \n* `Phone` - The participant joined via PSTN. \n* `H.323/SIP` - The participant joined via an H.323 or SIP device. \n* `Windows` - The participant joined via VoIP using a Windows device. \n* `Mac` - The participant joined via VoIP using a Mac device. \n* `iOS` - The participant joined via VoIP using an iOS device. \n* `Android` - The participant joined via VoIP using an Android device. \n\n**Note:** This response returns an empty string value for any users who are **not** a part of the host's account, such as external users.","example":"Phone","enum":["Phone","H.323/SIP","Windows","Mac","iOS","Android"]},"client":{"type":"string","description":"Client software or SDK version.","example":"Web Meeting SDK 2.18"},"domain":{"type":"string","description":"The participant's PC domain. \n\n**Note:** This response returns an empty string value for any users who are **not** a part of the host's account, such as external users.","example":"example.com"},"harddisk_id":{"type":"string","description":"The participant's hard disk ID. \n\n**Note:** This response returns an empty string value for any users who are **not** a part of the host's account, such as external users.","example":"Disk01"},"internal_ip_addresses":{"type":"array","description":"The participant's internal IP addresses. This field will not return under these conditions: \n* The account calling this API is a **legacy** [business associate agreement (BAA) under HIPAA](https://www.ecfr.gov/cgi-bin/retrieveECFR?gp=1&amp;n=se45.1.160_1103&amp;r=SECTION&amp;ty=HTML). \n* The account calling this API is a BAA under HIPAA **without** a signed BAA data processing addendum.","items":{"type":"string","example":"192.0.2.1"}},"ip_address":{"type":"string","description":"The participant's IP address.","example":"192.0.2.1"},"join_time":{"type":"string","description":"The time when the participant joined the meeting.","format":"date-time","example":"2022-03-01T10:15:14Z"},"leave_time":{"type":"string","description":"The time when the participant left the meeting.","format":"date-time","example":"2022-03-01T10:15:14Z"},"location":{"type":"string","description":"The participant's location.","example":"United States"},"mac_addr":{"type":"string","description":"The participant's MAC address. \n\n**Note:** This response returns an empty string (`&ldquo;&ldquo;`) value for any users who are **not** a part of the host's account, such as external users.","example":"f85e-a012-92d8"},"pc_name":{"type":"string","description":"The participant's PC name.","example":"HW0010449"},"user_id":{"type":"string","description":"The participant's ID. This value is assigned to a participant upon joining a meeting and is only valid for the meeting's duration.","example":"20161536"},"user_name":{"type":"string","description":"The participant's display name.","example":"jchill"},"user_qos":{"type":"array","description":"The participant's quality of service information.","items":{"type":"object","properties":{"as_device_from_crc":{"type":"object","properties":{"avg_loss":{"type":"string","description":"The average amount of packet loss, such as the percentage of packets that failed to arrive at their destination.","example":"0.03%"},"bitrate":{"type":"string","description":"The bits per second transmitted along a digital network, in kbps.","example":"27.15 kbps"},"jitter":{"type":"string","description":"The variation in the delay of received packets, in milliseconds.","example":"0 ms"},"latency":{"type":"string","description":"The time it took a packet to travel from one point to another, in milliseconds.","example":"126 ms"},"max_loss":{"type":"string","description":"The maximum amount of packet loss, such as the maximum percentage of packets that failed to arrive at their destination.","example":"0.4%"},"frame_rate":{"type":"string","description":"The rate where the video camera can produce unique images (frames). Zoom supports a frame rate of up to 30 fps.","example":"12 fps"},"resolution":{"type":"string","description":"The number of pixels in each dimension that the video camera can display.","example":"1280*720"}},"description":"The QoS metrics for screen sharing by a participant who joined the meeting via CRC."},"as_device_to_crc":{"type":"object","properties":{"avg_loss":{"type":"string","description":"The average amount of packet loss, such as the percentage of packets that failed to arrive at their destination.","example":"0.03%"},"bitrate":{"type":"string","description":"The bits per second transmitted along a digital network, in kbps.","example":"27.15 kbps"},"jitter":{"type":"string","description":"The variation in the delay of received packets, in milliseconds.","example":"0 ms"},"latency":{"type":"string","description":"The time it took a packet to travel from one point to another, in milliseconds.","example":"126 ms"},"max_loss":{"type":"string","description":"The maximum amount of packet loss, such as the maximum percentage of packets that failed to arrive at their destination.","example":"0.4%"},"frame_rate":{"type":"string","description":"The rate where the video camera can produce unique images (frames). Zoom supports a frame rate of up to 30 fps.","example":"12 fps"},"resolution":{"type":"string","description":"The number of pixels in each dimension that the video camera can display.","example":"1280*720"}},"description":"The QoS metrics for screen sharing output received by a participant who joined the meeting via CRC."},"as_input":{"title":"Screen Share QoS Object","type":"object","description":"The QoS metrics for screen sharing by a participant who joined the meeting","allOf":[{"title":"Audio QoS Object","type":"object","properties":{"avg_loss":{"type":"string","description":"The average amount of packet loss, such as the percentage of packets that failed to arrive at their destination.","example":"0.03%"},"bitrate":{"type":"string","description":"The bits per second transmitted along a digital network, in kbps.","example":"27.15 kbps"},"jitter":{"type":"string","description":"The variation in the delay of received packets, in milliseconds.","example":"0 ms"},"latency":{"type":"string","description":"The time it took a packet to travel from one point to another, in milliseconds.","example":"126 ms"},"max_loss":{"type":"string","description":"The maximum amount of packet loss, such as the maximum percentage of packets that failed to arrive at their destination.","example":"0.4%"}}},{"type":"object","properties":{"frame_rate":{"type":"string","description":"The rate where the video camera can produce unique images (frames). Zoom supports a frame rate of up to 30 fps.","example":"12 fps"},"resolution":{"type":"string","description":"The number of pixels in each dimension that the video camera can display.","example":"1280*720"}}}]},"as_output":{"title":"Screen Share QoS Object","type":"object","description":"The QoS metrics for screen sharing output received by a participant who joined the meeting","allOf":[{"title":"Audio QoS Object","type":"object","properties":{"avg_loss":{"type":"string","description":"The average amount of packet loss, such as the percentage of packets that failed to arrive at their destination.","example":"0.03%"},"bitrate":{"type":"string","description":"The bits per second transmitted along a digital network, in kbps.","example":"27.15 kbps"},"jitter":{"type":"string","description":"The variation in the delay of received packets, in milliseconds.","example":"0 ms"},"latency":{"type":"string","description":"The time it took a packet to travel from one point to another, in milliseconds.","example":"126 ms"},"max_loss":{"type":"string","description":"The maximum amount of packet loss, such as the maximum percentage of packets that failed to arrive at their destination.","example":"0.4%"}}},{"type":"object","properties":{"frame_rate":{"type":"string","description":"The rate where the video camera can produce unique images (frames). Zoom supports a frame rate of up to 30 fps.","example":"12 fps"},"resolution":{"type":"string","description":"The number of pixels in each dimension that the video camera can display.","example":"1280*720"}}}]},"audio_device_from_crc":{"type":"object","properties":{"avg_loss":{"type":"string","description":"The average amount of packet loss, such as the percentage of packets that failed to arrive at their destination.","example":"0.03%"},"bitrate":{"type":"string","description":"The bits per second transmitted along a digital network, in kbps.","example":"27.15 kbps"},"jitter":{"type":"string","description":"The variation in the delay of received packets, in milliseconds.","example":"0 ms"},"latency":{"type":"string","description":"The time it took a packet to travel from one point to another, in milliseconds.","example":"126 ms"},"max_loss":{"type":"string","description":"The maximum amount of packet loss, such as the maximum percentage of packets that failed to arrive at their destination.","example":"0.4%"}},"description":"The QoS metrics for audio sent by a participant who joined the meeting via a Cloud Room Connector (CRC)."},"audio_device_to_crc":{"type":"object","properties":{"avg_loss":{"type":"string","description":"The average amount of packet loss, such as the percentage of packets that failed to arrive at their destination.","example":"0.03%"},"bitrate":{"type":"string","description":"The bits per second transmitted along a digital network, in kbps.","example":"27.15 kbps"},"jitter":{"type":"string","description":"The variation in the delay of received packets, in milliseconds.","example":"0 ms"},"latency":{"type":"string","description":"The time it took a packet to travel from one point to another, in milliseconds.","example":"126 ms"},"max_loss":{"type":"string","description":"The maximum amount of packet loss, such as the maximum percentage of packets that failed to arrive at their destination.","example":"0.4%"}},"description":"The QoS metrics for audio received by a participant who joined the meeting via CRC."},"audio_input":{"title":"Audio QoS Object","type":"object","properties":{"avg_loss":{"type":"string","description":"The average amount of packet loss, such as the percentage of packets that failed to arrive at their destination.","example":"0.03%"},"bitrate":{"type":"string","description":"The bits per second transmitted along a digital network, in kbps.","example":"27.15 kbps"},"jitter":{"type":"string","description":"The variation in the delay of received packets, in milliseconds.","example":"0 ms"},"latency":{"type":"string","description":"The time it took a packet to travel from one point to another, in milliseconds.","example":"126 ms"},"max_loss":{"type":"string","description":"The maximum amount of packet loss, such as the maximum percentage of packets that failed to arrive at their destination.","example":"0.4%"}},"description":"The QoS metrics for audio sent by a participant who joined the meeting"},"audio_output":{"title":"Audio QoS Object","type":"object","properties":{"avg_loss":{"type":"string","description":"The average amount of packet loss, such as the percentage of packets that failed to arrive at their destination.","example":"0.03%"},"bitrate":{"type":"string","description":"The bits per second transmitted along a digital network, in kbps.","example":"27.15 kbps"},"jitter":{"type":"string","description":"The variation in the delay of received packets, in milliseconds.","example":"0 ms"},"latency":{"type":"string","description":"The time it took a packet to travel from one point to another, in milliseconds.","example":"126 ms"},"max_loss":{"type":"string","description":"The maximum amount of packet loss, such as the maximum percentage of packets that failed to arrive at their destination.","example":"0.4%"}},"description":"The QoS metrics for audio received by a participant who joined the meeting"},"cpu_usage":{"type":"object","properties":{"system_max_cpu_usage":{"type":"string","description":"The system's maximum CPU usage.","example":"11%"},"zoom_avg_cpu_usage":{"type":"string","description":"Zoom's average CPU usage.","example":"0%"},"zoom_max_cpu_usage":{"type":"string","description":"Zoom's maximum CPU usage.","example":"2%"},"zoom_min_cpu_usage":{"type":"string","description":"Zoom's minimum CPU usage.","example":"0%"}},"description":"Information about CPU usage."},"cpu_pressure_level":{"type":"object","properties":{"system_min_cpu_pressure_level":{"type":"string","description":"The system’s minimum CPU pressure level","example":"normal","enum":["normal","fair","serious","critical"]},"system_avg_cpu_pressure_level":{"type":"string","description":"The system’s average CPU pressure level","example":"normal","enum":["normal","fair","serious","critical"]},"system_max_cpu_pressure_level":{"type":"string","description":"The system’s maximum CPU pressure level","example":"normal","enum":["critical","serious","fair","normal"]}},"description":"The system’s CPU pressure level"},"date_time":{"type":"string","description":"The QoS date and time.","format":"date-time","example":"2022-03-01T10:16:00Z"},"video_device_from_crc":{"type":"object","properties":{"avg_loss":{"type":"string","description":"The average amount of packet loss, such as the percentage of packets that failed to arrive at their destination.","example":"0.03%"},"bitrate":{"type":"string","description":"The bits per second transmitted along a digital network, in kbps.","example":"27.15 kbps"},"jitter":{"type":"string","description":"The variation in the delay of received packets, in milliseconds.","example":"0 ms"},"latency":{"type":"string","description":"The time it took a packet to travel from one point to another, in milliseconds.","example":"126 ms"},"max_loss":{"type":"string","description":"The maximum amount of packet loss, such as the maximum percentage of packets that failed to arrive at their destination.","example":"0.03%"},"frame_rate":{"type":"string","description":"The rate where the video camera can produce unique images (frames). Zoom supports a frame rate of up to 30 fps.","example":"12 fps"},"resolution":{"type":"string","description":"The number of pixels in each dimension that the video camera can display.","example":"1280*720"}},"description":"The QoS metrics for video input being sent by a participant who joined the meeting via CRC."},"video_device_to_crc":{"type":"object","properties":{"avg_loss":{"type":"string","description":"The average amount of packet loss, such as the percentage of packets that failed to arrive at their destination.","example":"0.03%"},"bitrate":{"type":"string","description":"The bits per second transmitted along a digital network, in kbps.","example":"27.15 kbps"},"jitter":{"type":"string","description":"The variation in the delay of received packets, in milliseconds.","example":"0 ms"},"latency":{"type":"string","description":"The time it took a packet to travel from one point to another, in milliseconds.","example":"126 ms"},"max_loss":{"type":"string","description":"The maximum amount of packet loss, such as the maximum percentage of packets that failed to arrive at their destination.","example":"0.4%"},"frame_rate":{"type":"string","description":"The rate where the video camera can produce unique images (frames). Zoom supports a frame rate of up to 30 fps.","example":"12 fps"},"resolution":{"type":"string","description":"The number of pixels in each dimension that the video camera can display.","example":"1280*720"}},"description":"The QoS metrics for video output being sent by a participant who joined the meeting via CRC."},"video_input":{"title":"Video QoS Object","type":"object","description":"The QoS metrics for video input being sent by a participant who joined the meeting","allOf":[{"title":"Audio QoS Object","type":"object","properties":{"avg_loss":{"type":"string","description":"The average amount of packet loss, such as the percentage of packets that failed to arrive at their destination.","example":"0.03%"},"bitrate":{"type":"string","description":"The bits per second transmitted along a digital network, in kbps.","example":"27.15 kbps"},"jitter":{"type":"string","description":"The variation in the delay of received packets, in milliseconds.","example":"0 ms"},"latency":{"type":"string","description":"The time it took a packet to travel from one point to another, in milliseconds.","example":"126 ms"},"max_loss":{"type":"string","description":"The maximum amount of packet loss, such as the maximum percentage of packets that failed to arrive at their destination.","example":"0.4%"}}},{"type":"object","properties":{"frame_rate":{"type":"string","description":"The rate where the video camera can produce unique images (frames). Zoom supports a frame rate of up to 30 fps.","example":"12 fps"},"resolution":{"type":"string","description":"The number of pixels in each dimension that the video camera can display.","example":"1280*720"}}}]},"video_output":{"title":"Video QoS Object","type":"object","description":"The QoS metrics for video output being sent by a participant who joined the meeting","allOf":[{"title":"Audio QoS Object","type":"object","properties":{"avg_loss":{"type":"string","description":"The average amount of packet loss, such as the percentage of packets that failed to arrive at their destination.","example":"0.03%"},"bitrate":{"type":"string","description":"The bits per second transmitted along a digital network, in kbps.","example":"27.15 kbps"},"jitter":{"type":"string","description":"The variation in the delay of received packets, in milliseconds.","example":"0 ms"},"latency":{"type":"string","description":"The time it took a packet to travel from one point to another, in milliseconds.","example":"126 ms"},"max_loss":{"type":"string","description":"The maximum amount of packet loss, such as the maximum percentage of packets that failed to arrive at their destination.","example":"0.4%"}}},{"type":"object","properties":{"frame_rate":{"type":"string","description":"The rate where the video camera can produce unique images (frames). Zoom supports a frame rate of up to 30 fps.","example":"12 fps"},"resolution":{"type":"string","description":"The number of pixels in each dimension that the video camera can display.","example":"1280*720"}}}]},"as_device_from_rwg":{"type":"object","properties":{"avg_loss":{"type":"string","description":"The average amount of packet loss, such as the percentage of packets that failed to arrive at their destination.","example":"0.03%"},"bitrate":{"type":"string","description":"The bits per second transmitted along a digital network, in kbps.","example":"27.15 kbps"},"jitter":{"type":"string","description":"The variation in the delay of received packets, in milliseconds.","example":"0 ms"},"latency":{"type":"string","description":"The time it took a packet to travel from one point to another, in milliseconds.","example":"126 ms"},"max_loss":{"type":"string","description":"The maximum amount of packet loss, such as the maximum percentage of packets that failed to arrive at their destination.","example":"0.4%"},"frame_rate":{"type":"string","description":"The rate where the video camera can produce unique images (frames). Zoom supports a frame rate of up to 30 fps.","example":"12 fps"},"resolution":{"type":"string","description":"The number of pixels in each dimension that the video camera can display.","example":"1280*720"}},"description":"The QoS metrics for screen sharing by a participant who joined the meeting via the web client."},"as_device_to_rwg":{"type":"object","properties":{"avg_loss":{"type":"string","description":"The average amount of packet loss, such as the percentage of packets that failed to arrive at their destination.","example":"0.03%"},"bitrate":{"type":"string","description":"The bits per second transmitted along a digital network, in kbps.","example":"27.15 kbps"},"jitter":{"type":"string","description":"The variation in the delay of received packets, in milliseconds.","example":"0 ms"},"latency":{"type":"string","description":"The time it took a packet to travel from one point to another, in milliseconds.","example":"126 ms"},"max_loss":{"type":"string","description":"The maximum amount of packet loss, such as the maximum percentage of packets that failed to arrive at their destination.","example":"0.4%"},"frame_rate":{"type":"string","description":"The rate where the video camera can produce unique images (frames). Zoom supports a frame rate of up to 30 fps.","example":"12 fps"},"resolution":{"type":"string","description":"The number of pixels in each dimension that the video camera can display.","example":"1280*720"}},"description":"The QoS output metrics for screen sharing received by a participant who joined the meeting via the web client."},"audio_device_from_rwg":{"type":"object","properties":{"avg_loss":{"type":"string","description":"The average amount of packet loss, such as the percentage of packets that failed to arrive at their destination.","example":"0.03%"},"bitrate":{"type":"string","description":"The bits per second transmitted along a digital network, in kbps.","example":"27.15 kbps"},"jitter":{"type":"string","description":"The variation in the delay of received packets, in milliseconds.","example":"0 ms"},"latency":{"type":"string","description":"The time it took a packet to travel from one point to another, in milliseconds.","example":"126 ms"},"max_loss":{"type":"string","description":"The maximum amount of packet loss, such as the maximum percentage of packets that failed to arrive at their destination.","example":"0.4%"}},"description":"The QoS metrics for audio sent by a participant who joined the meeting via the web client."},"audio_device_to_rwg":{"type":"object","properties":{"avg_loss":{"type":"string","description":"The average amount of packet loss. For example, the percentage of packets that failed to arrive at their destination.","example":"0.03%"},"bitrate":{"type":"string","description":"The bits per second transmitted along a digital network, in kbps.","example":"27.15 kbps"},"jitter":{"type":"string","description":"The variation in the delay of received packets, in milliseconds.","example":"0 ms"},"latency":{"type":"string","description":"The time it took a packet to travel from one point to another, in milliseconds.","example":"126 ms"},"max_loss":{"type":"string","description":"The maximum amount of packet loss, such as the maximum percentage of packets that failed to arrive at their destination.","example":"0.4%"}},"description":"The QoS metrics for audio received by a participant who joined the meeting via web client."},"video_device_from_rwg":{"type":"object","properties":{"avg_loss":{"type":"string","description":"The average amount of packet loss, such as the percentage of packets that failed to arrive at their destination.","example":"0.03%"},"bitrate":{"type":"string","description":"The bits per second transmitted along a digital network, in kbps.","example":"27.15 kbps"},"jitter":{"type":"string","description":"The variation in the delay of received packets, in milliseconds.","example":"0 ms"},"latency":{"type":"string","description":"The time it took a packet to travel from one point to another, in milliseconds.","example":"126 ms"},"max_loss":{"type":"string","description":"The maximum amount of packet loss, such as the maximum percentage of packets that failed to arrive at their destination.","example":"0.03%"},"frame_rate":{"type":"string","description":"The rate where the video camera can produce unique images (frames). Zoom supports a frame rate of up to 30 fps.","example":"12 fps"},"resolution":{"type":"string","description":"The number of pixels in each dimension that the video camera can display.","example":"1280*720"}},"description":"The QoS metrics for video input being sent by a participant who joined the meeting via the web client."},"video_device_to_rwg":{"type":"object","properties":{"avg_loss":{"type":"string","description":"The average amount of packet loss, such as the percentage of packets that failed to arrive at their destination.","example":"0.03%"},"bitrate":{"type":"string","description":"The bits per second transmitted along a digital network, in kbps.","example":"27.15 kbps"},"jitter":{"type":"string","description":"The variation in the delay of received packets, in milliseconds.","example":"0 ms"},"latency":{"type":"string","description":"The time it took a packet to travel from one point to another, in milliseconds.","example":"126 ms"},"max_loss":{"type":"string","description":"The maximum amount of packet loss, such as the maximum percentage of packets that failed to arrive at their destination.","example":"0.4%"},"frame_rate":{"type":"string","description":"The rate where the video camera can produce unique images (frames). Zoom supports a frame rate of up to 30 fps.","example":"12 fps"},"resolution":{"type":"string","description":"The number of pixels in each dimension that the video camera can display.","example":"1280*720"}},"description":"The QoS metrics for video output being sent by a participant who joined the meeting via the web client."},"wifi_rssi":{"type":"object","properties":{"max_rssi":{"type":"integer","description":"Maximum value of the wireless network's received signal strength indicator (RSSI).","example":-75},"avg_rssi":{"type":"integer","description":"Average value of the wireless network's received signal strength indicator (RSSI).","example":-69},"min_rssi":{"type":"integer","description":"Minimum value of the wireless network's received signal strength indicator (RSSI).","example":-35},"rssi_unit":{"type":"string","description":"Unit of the wireless network's received signal strength indicator (RSSI).","example":"dBm"}},"description":"The QoS metrics for the wireless network's RSSI sent by a participant who joined the meeting through a wireless network."},"audio_socket_break":{"type":"object","properties":{"socket_break":{"type":"boolean","description":"Whether the participant's audio socket broke.","example":true},"socket_break_time":{"type":"string","description":"The participant's audio socket break time.","format":"date-time","example":"2026-04-20T01:50:42Z"},"socket_recover":{"type":"boolean","description":"Whether the participant's audio socket recovered.","example":false},"socket_recover_time":{"type":"string","description":"The participant's audio socket recovery time.","format":"date-time","example":"2026-04-20T01:50:42Z"}},"description":"The QoS metrics for audio socket breaks for a participant who joined the meeting."},"video_socket_break":{"type":"object","properties":{"socket_break":{"type":"boolean","description":"Whether the participant's video socket broke.","example":true},"socket_break_time":{"type":"string","description":"The participant's video socket break time.","format":"date-time","example":"2026-04-20T01:50:42Z"},"socket_recover":{"type":"boolean","description":"Whether the participant's video socket recovered.","example":false},"socket_recover_time":{"type":"string","description":"The participant's video socket recovery time.","format":"date-time","example":"2026-04-20T01:50:42Z"}},"description":"The QoS metrics for video socket breaks for a participant who joined the meeting."},"as_socket_break":{"type":"object","properties":{"socket_break":{"type":"boolean","description":"Whether the participant's screen sharing socket broke.","example":true},"socket_break_time":{"type":"string","description":"The participant's screen sharing socket break time.","format":"date-time","example":"2026-04-20T01:50:42Z"},"socket_recover":{"type":"boolean","description":"Whether the participant's screen sharing socket recovered.","example":false},"socket_recover_time":{"type":"string","description":"The participant's screen sharing socket recovery time.","format":"date-time","example":"2026-04-20T01:50:42Z"}},"description":"The QoS metrics for screen sharing socket breaks for a participant who joined the meeting."},"command_socket_break":{"type":"object","properties":{"socket_break":{"type":"boolean","description":"Whether the participant's command socket broke.","example":true},"socket_break_time":{"type":"string","description":"The participant's command socket break time.","format":"date-time","example":"2026-04-20T01:50:42Z"},"socket_recover":{"type":"boolean","description":"Whether the participant's command socket recovered.","example":false},"socket_recover_time":{"type":"string","description":"The participant's command socket recovery time.","format":"date-time","example":"2026-04-20T01:50:42Z"}},"description":"The QoS metrics for command socket breaks for a participant who joined the meeting."}}}},"version":{"type":"string","description":"The participant's Zoom client version.","example":"5.9.1.2581"},"os":{"type":"string","description":"device operation system","example":"iOS"},"os_version":{"type":"string","description":"device operation system version","example":"16.5"},"browser_name":{"type":"string","description":"webclient operation browser","example":"Firefox"},"browser_version":{"type":"string","description":"webclient operation browser version","example":"133"},"video_connection_type":{"type":"string","description":"The participant's video connection type.","example":"UDP","enum":["P2P","TCP","UDP","Reliable UDP","SSL","HTTP","TCP+Proxy","UDP+Proxy","Reliable+Proxy","SSL+Proxy","HTTP+Proxy"]},"as_connection_type":{"type":"string","description":"The participant's screen share connection type.","example":"UDP","enum":["P2P","TCP","UDP","Reliable UDP","SSL","HTTP","TCP+Proxy","UDP+Proxy","Reliable+Proxy","SSL+Proxy","HTTP+Proxy"]},"participant_uuid":{"type":"string","description":"The participant's UUID. This value assigned to a participant upon joining a webinar and is only valid for the webinar's duration.","example":"D444CD06-2ABB-2FCC-019B-39E41D8DADF7"},"network_type":{"type":"string","description":"The participant's network type. * `Wired` * `Wifi` * `PPP` - Point-to-Point. * `Cellular` - 3G, 4G, and 5G cellular. * `Others` - An unknown device.","example":"Wired","enum":["Wired","Wifi","PPP","Cellular","Others"]},"data_center":{"type":"string","description":"The data center that the participant is leveraging to join the webinar.","example":"United States"},"full_data_center":{"type":"string","description":"The data center where participant's meeting data is stored. This field includes a semicolon-separated list of HTTP Tunnel (HT), Cloud Room Connector (CRC), and Real-Time Web Gateway (RWG) location information.","example":"United States;China (TJ RWG);"},"connection_type":{"type":"string","description":"The participant's connection type.","example":"UDP","enum":["P2P","TCP","UDP","Reliable UDP","SSL","HTTP","TCP+Proxy","UDP+Proxy","Reliable+Proxy","SSL+Proxy","HTTP+Proxy"]},"share_application":{"type":"boolean","description":"Whether the participant chose to share an application during the meeting.","example":true},"share_desktop":{"type":"boolean","description":"Whether the participant chose to share their desktop during the screenshare.","example":true},"share_whiteboard":{"type":"boolean","description":"Whether the participant chose to share their whiteboard during the screenshare.","example":true},"recording":{"type":"boolean","description":"Whether the recording feature was used during the webinar.","example":true},"device_name":{"type":"string","description":"device's name","example":"iPhone 7 Global"},"optional_archiving":{"type":"string","description":"This is shown only for internal participants who have archiving enabled","example":"no optional archiving","enum":["no optional archiving","join without archiving","join with archiving"]},"has_archiving":{"type":"boolean","description":"The status of the archiving feature for the meeting","example":true},"groupId":{"type":"string","description":"the attendee's group id","example":"TcjqVCTzRy6hLa0d8WpAIg"},"health":{"type":"string","description":"The participant's health","example":"Warning","default":"Good","enum":["Good","Warning","Critical"]},"zoom_thin_client_plugin_version":{"type":"string","description":"VDI thin client version","example":"6.5.11.26770"},"email":{"type":"string","description":"The participant's email address. 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](/docs/api-reference/using-zoom-apis#email-address) for details.","format":"email","example":"jchill@example.com"},"issue_list":{"maxItems":5,"minItems":0,"type":"array","description":"The participant's issue","items":{"type":"string","description":"The participant's issue","example":"audio"}},"rc_reason":{"type":"string","description":"the call reconnection reason: Client crash","example":"Client crash"},"vdi_plugin_info_status":{"type":"string","description":"The participant's VDI plugin connection status.","example":"Local","enum":["Optimized","UnOptimized","Local"]},"vdi_plugin_info_fb_code_reason":{"type":"string","description":"The participant's VDI plugin fallback reason.","example":"None (no error)"}},"description":"Information about the participant and their quality of service (QoS)."}}}}]}}}},"400":{"description":"**HTTP Status Code:** `400` <br>\n Bad Request  \n\n **Error Code:** `12702` <br>\n Can not access a webinar a year ago. <br>\n"},"401":{"description":"**HTTP Status Code:** `401` <br>\n Unauthorized  \n\n "},"403":{"description":"**HTTP Status Code:** `403` <br>\n Forbidden  \n\n "},"404":{"description":"**HTTP Status Code:** `404` <br>\n Not Found  \n\n **Error Code:** `3001` <br>\n This webinar's detail is not available or the Webinar ID is not valid.<br>\nThis webinar has not ended yet. <br>\n"},"429":{"description":"**HTTP Status Code:** `429` <br>\n Too Many Requests. For more information, see [rate limits](https://developers.zoom.us/docs/api/rest/rate-limits/). \n\n "}},"security":[{"openapi_authorization":[]}],"x-extensions":{"x-permissions":["DashboardWebinars:Read"],"x-macro-scopes":["dashboard:master"],"x-granular-scopes":["dashboard:read:list_webinar_participants_qos:master"]}}},"/accounts/{accountId}/metrics/webinars/{webinarId}/participants/satisfaction":{"get":{"tags":["Dashboards"],"summary":"Get post webinar feedback","description":"When a Webinar ends, each attendee will be prompted to share their Webinar experience by clicking either thumbs up or thumbs down. Use this API to retrieve the feedback submitted for a specific webinar. Note that this API only works for meetings scheduled after December 20, 2020.\n\n**Prerequisites:**\n* [Feedback to Zoom](https://support.zoom.us/hc/en-us/articles/115005838023) setting must be enabled by the participant prior to the meeting.\n* The user making the API request must be enrolled in a Business or a higher plan.\n\n\n  \n  \n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `dashboard:master`\n\n**[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `dashboard:read:post_webinar_feedback:master`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Heavy`","operationId":"participantWebinarFeedback","parameters":[{"name":"type","in":"query","description":"Specify a value to get the response for the corresponding meeting type. The value of this field can be one of the following:  \n    \n `past` - Meeting that already occurred in the specified date range.  \n `pastOne` - Past meetings that were attended by only one user.   \n `live` - Live meetings.  \n   \n \n\nIf you do not provide this field, the default value will be `live` and thus, the API will only query responses for live meetings.","required":false,"schema":{"type":"string","example":"past","default":"live","enum":["past","pastOne","live"]}},{"name":"page_size","in":"query","description":"The number of records returned within a single API call.","required":false,"schema":{"maximum":300,"type":"integer","example":30,"default":30}},{"name":"next_page_token","in":"query","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.","required":false,"schema":{"type":"string","example":"IAfJX3jsOLW7w3dokmFl84zOa0MAVGyMEB2"}},{"name":"webinarId","in":"path","description":"The webinar's ID or universally unique ID (UUID). \n* If you provide a webinar ID, the API will return a response for the latest webinar instance. \n* If you provide a webinar 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 webinar UUID before making an API request.","required":true,"schema":{"type":"string","example":"ABCDE12345"}},{"name":"accountId","in":"path","description":"Unique identifier of the account.","required":true,"schema":{"type":"string","example":"TQTvjT52Tmi_wrhASNNOEw"}}],"responses":{"200":{"description":"**HTTP Status Code:** `200`  \n \n\n","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":"ZkFS5lmGLWTjLMqt2IVCBpyKwSnbDrgJzo2"},"page_size":{"type":"integer","description":"The number of records returned within a single API call.","example":30},"participants":{"type":"array","items":{"type":"object","properties":{"date_time":{"type":"string","description":"Date and time at which the feedback was submitted.","format":"date-time","example":"2022-01-19T07:34:09Z"},"email":{"type":"string","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.","format":"email","example":"user@example.com"},"quality":{"type":"string","description":"Feedback submitted by the participant. \n\n* `GOOD`: Thumbs up.\n* `NOT GOOD`: Thumbs down.","example":"GOOD","enum":["GOOD","NOT GOOD"]},"user_id":{"type":"string","description":"User ID of the participant.","example":"NJmuvOjlRm2r7yGUPLLOhw"},"comment":{"type":"string","description":"Post webinar comment of the participant.","example":"Webinar got disconnected."}}}}}}}}},"400":{"description":"**HTTP Status Code:** `400` <br>\n Bad Request  \n\n **Error Code:** `200` <br>\n Only available for paid accounts that have dashboard feature enabled. <br>\n"},"404":{"description":"**HTTP Status Code:** `404` <br>\n Not Found  \n\n **Error Code:** `3001` <br>\n Webinar ID is invalid or not end. <br>\n"},"429":{"description":"**HTTP Status Code:** `429` <br>\n Too Many Requests. For more information, see [rate limits](https://developers.zoom.us/docs/api/rest/rate-limits/). \n\n "}},"security":[{"openapi_authorization":[]}],"x-extensions":{"x-permissions":["DashboardWebinars:Read"],"x-macro-scopes":["dashboard:master"],"x-granular-scopes":["dashboard:read:post_webinar_feedback:master"]}}},"/accounts/{accountId}/metrics/webinars/{webinarId}/participants/sharing":{"get":{"tags":["Dashboards"],"summary":"Get webinar sharing/recording details","description":"Retrieve the sharing and recording details of participants from live or past webinars.   \n   \n \n**Prerequisites:**  \n \n* Business, Education or API Plan with Webinar add-on.\n\n\n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `dashboard_webinars:read:master`,`dashboard:master`\n\n**[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `dashboard:read:webinar_sharing:master`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Heavy`","operationId":"dashboardWebinarParticipantShare","parameters":[{"name":"webinarId","in":"path","description":"The webinar's ID or universally unique ID (UUID). \n* If you provide a webinar ID, the API will return a response for the latest webinar instance. \n* If you provide a webinar 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 webinar UUID before making an API request.","required":true,"schema":{"type":"string","example":"ABCDE12345"}},{"name":"type","in":"query","description":"The type of webinar to query: \n* `past` &mdash; All past webinars. \n* `live` - All live webinars. \n\nThis value defaults to `live`.","required":false,"schema":{"type":"string","example":"past","default":"live","enum":["past","live"]}},{"name":"page_size","in":"query","description":"The number of records returned within a single API call.","required":false,"schema":{"maximum":300,"type":"integer","example":30,"default":30}},{"name":"next_page_token","in":"query","description":"Use the next page token to paginate through large result sets. A next page token is returned whenever the set of available results exceed the current page size. This token's expiration period is 15 minutes.","required":false,"schema":{"type":"string","example":"0JblM1ZHFIdXjAHefkYOfTdCw1Lq9H1urw2"}},{"name":"accountId","in":"path","description":"Unique identifier of the account.","required":true,"schema":{"type":"string","example":"TQTvjT52Tmi_wrhASNNOEw"}}],"responses":{"200":{"description":"**HTTP Status Code:** `200`  \n \nWebinar participants returned.  \n \nOnly available for paid accounts that have enabled the Dashboard feature.","content":{"application/json":{"schema":{"allOf":[{"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":"Tva2CuIdTgsv8wAnhyAdU3m06Y2HuLQtlh3"},"page_count":{"type":"integer","description":"The number of pages returned for the request made.","example":1},"page_size":{"maximum":300,"type":"integer","description":"The number of records returned within a single API call.","example":30,"default":30},"total_records":{"type":"integer","description":"The number of all records available across pages.","example":1}},"description":"Pagination object."},{"type":"object","properties":{"participants":{"type":"array","description":"Array of participants.","items":{"type":"object","properties":{"details":{"type":"array","description":"Array of sharing and recording details.","items":{"type":"object","properties":{"content":{"type":"string","description":"Type of content shared.","example":"desktop"},"end_time":{"type":"string","description":"End time of sharing.","example":"2022-01-20T09:08:20Z"},"start_time":{"type":"string","description":"Start time of sharing.","example":"2022-01-20T09:08:13Z"}}}},"id":{"type":"string","description":"Universally 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.","example":"AVhfQ737SZ6aM8Lh60HrQg"},"user_id":{"type":"string","description":"Participant ID. This is a unique ID assigned to the participant joining a meeting and is valid for that meeting only.","example":"28513280"},"user_name":{"type":"string","description":"Participant display name.","example":"jchill"}}}}}}]}}}},"400":{"description":"**HTTP Status Code:** `400` <br>\n Bad Request\n\n**Error Code:** `12702` <br>\nCan not access a webinar a year ago.\n\n"},"404":{"description":"**HTTP Status Code:** `404` <br>\n Not Found\n\n**Error Code:** `3001` <br>\nThis webinar's detail info is not available or ID is not valid.<br>\nThis webinar has not ended yet.\n\n"},"429":{"description":"**HTTP Status Code:** `429` <br>\n Too Many Requests. For more information, see [rate limits](https://developers.zoom.us/docs/api/rest/rate-limits/). \n\n "}},"security":[{"openapi_authorization":[]}],"x-extensions":{"x-permissions":["DashboardWebinars:Read"],"x-macro-scopes":["dashboard_webinars:read:master","dashboard:master"],"x-granular-scopes":["dashboard:read:webinar_sharing:master"]}}},"/accounts/{accountId}/metrics/webinars/{webinarId}/participants/{participantId}/qos":{"get":{"tags":["Dashboards"],"summary":"Get webinar participant QoS","description":"Returns the quality of service (QoS) for participants during live or past webinars. This data returned indicates the connection quality for sending/receiving video, audio, and shared content. The API returns this data for either the API request or when the API request was last received. \n\nWhen the sender sends its data, a timestamp is attached to the sender's data packet. The receiver then returns this timestamp to the sender. This helps determine the upstream and downstream latency, which includes the application processing time. The latency data returned is the five second average and five second maximum. \n\nThis API will **not** return data if there is no data being sent or received at the time of request. \n\n**Note:** \n\nThis API may return empty values for participants' `user_name`, `ip_address`, `location`, and `email` responses when the account calling this API: \n* Does **not** have a signed HIPAA business associate agreement (BAA). \n* Is a [**legacy** HIPAA BAA account](https://developers.zoom.us/docs/api/rest/other-references/legacy-business-associate-agreements/). \n* Displays data for any users who are **not** part of the host's account, such as external users, unless they meet certain conditions. See [Email address display rules](https://developers.zoom.us/docs/api/rest/using-zoom-apis/#email-address-display-rules) for details. \n\n**Prerequisites:** \n* A Business, Education, or API Plan with Zoom Rooms set up.\n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `dashboard:master`\n\n**[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `dashboard:read:webinar_participant_qos:master`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `HEAVY`","operationId":"dashboardWebinarParticipantQOS","parameters":[{"name":"webinarId","in":"path","description":"The webinar's ID or universally unique ID (UUID). \n* If you provide a webinar ID, the API will return a response for the latest webinar instance. \n* If you provide a webinar UUID that begins with a `/` character or contains the `//` characters, you **must** double-encode the webinar UUID before making an API request.","required":true,"schema":{"type":"string","example":"ABCDE12345"}},{"name":"participantId","in":"path","description":"The participant's ID.","required":true,"schema":{"type":"string","example":"32977920"}},{"name":"type","in":"query","description":"The type of webinar to query. \n* `past` - All past webinars. \n* `live` - All live webinars. \n\nThis value defaults to `live`.","required":false,"schema":{"type":"string","example":"past","default":"live","enum":["past","live"]}},{"name":"accountId","in":"path","description":"Unique identifier of the account.","required":true,"schema":{"type":"string","example":"TQTvjT52Tmi_wrhASNNOEw"}}],"responses":{"200":{"description":"**HTTP Status Code:** `200`  \n \nWebinar participant QOS returned.  \n \nThis API is only available for ZMP and Business or higher accounts that have enabled the Dashboard feature.","content":{"application/json":{"schema":{"title":"The participant QOS.","type":"object","properties":{"id":{"type":"string","description":"The participant's universally unique ID. This value is the same as the participant's user ID if the participant joins the webinar by logging into Zoom. If the participant joins the webinar without logging into Zoom, this returns an empty value.","example":"_f08HhPJS82MIVLuuFaJPg"},"device":{"type":"string","description":"The type of device the participant used to join the meeting. \n* `Phone` - The participant joined via PSTN. \n* `H.323/SIP` - The participant joined with an H.323 or SIP device. \n* `Windows` - The participant joined with VoIP using a Windows device. \n* `Mac` - The participant joined through VoIP using a Mac device. \n* `iOS` - The participant joined through VoIP using an iOS device. \n* `Android` - The participant joined through VoIP using an Android device. \n\n**Note:** This response returns an empty string value for any users who are **not** a part of the host's account, such as external users.","example":"Phone","enum":["Phone","H.323/SIP","Windows","Mac","iOS","Android"]},"client":{"type":"string","description":"Client software or SDK version.","example":"Web Meeting SDK 2.18"},"domain":{"type":"string","description":"The participant's PC domain. \n\n**Note:** This response returns an empty string value for any users who are **not** a part of the host's account, such as external user).","example":"example.com"},"harddisk_id":{"type":"string","description":"The participant's hard disk ID. \n\n**Note:** This response returns an empty string value for any users who are **not** a part of the host's account, such as external users.","example":"Disk01"},"internal_ip_addresses":{"type":"array","description":"The participant's internal IP addresses. This field will not return under these conditions: \n* The account calling this API is a **legacy** [business associate agreement (BAA) under HIPAA](https://www.ecfr.gov/cgi-bin/retrieveECFR?gp=1&amp;n=se45.1.160_1103&amp;r=SECTION&amp;ty=HTML). \n* The account calling this API is a BAA under HIPAA **without** a signed BAA data processing addendum.","items":{"type":"string","example":"192.0.2.1"}},"ip_address":{"type":"string","description":"The participant's IP address.","example":"192.0.2.1"},"join_time":{"type":"string","description":"The time when the participant joined the meeting.","format":"date-time","example":"2022-03-01T10:15:14Z"},"leave_time":{"type":"string","description":"The time when the participant left the meeting.","format":"date-time","example":"2022-03-01T10:15:14Z"},"location":{"type":"string","description":"The participant's location.","example":"United States"},"mac_addr":{"type":"string","description":"The participant's MAC address. \n\n**Note:** This response returns an empty string value for any users who are **not** a part of the host's account, such as external users.","example":"f85e-a012-92d8"},"pc_name":{"type":"string","description":"The participant's PC name.","example":"HW0010449"},"user_id":{"type":"string","description":"The participant's ID. This value is assigned to a participant when they joining a meeting, and is only valid for the meeting's duration.","example":"20161536"},"user_name":{"type":"string","description":"The participant's display name.","example":"jchill"},"user_qos":{"type":"array","description":"The participant's quality of service information.","items":{"type":"object","properties":{"as_device_from_crc":{"type":"object","properties":{"avg_loss":{"type":"string","description":"The average amount of packet loss, such as the percentage of packets that failed to arrive at their destination.","example":"0.03%"},"bitrate":{"type":"string","description":"The bits per second transmitted along a digital network, in kbps.","example":"27.15 kbps"},"jitter":{"type":"string","description":"The variation in the delay of received packets, in milliseconds.","example":"0 ms"},"latency":{"type":"string","description":"The time it took a packet to travel from one point to another, in milliseconds.","example":"126 ms"},"max_loss":{"type":"string","description":"The maximum amount of packet loss, such as the maximum percentage of packets that failed to arrive at their destination.","example":"0.4%"},"frame_rate":{"type":"string","description":"The rate where the video camera can produce unique images (frames). Zoom supports a frame rate of up to 30 fps.","example":"12 fps"},"resolution":{"type":"string","description":"The number of pixels in each dimension that the video camera can display.","example":"1280*720"}},"description":"The QoS metrics for screen sharing by a participant who joined the meeting via CRC."},"as_device_to_crc":{"type":"object","properties":{"avg_loss":{"type":"string","description":"The average amount of packet loss, such as the percentage of packets that failed to arrive at their destination.","example":"0.03%"},"bitrate":{"type":"string","description":"The bits per second transmitted along a digital network, in kbps.","example":"27.15 kbps"},"jitter":{"type":"string","description":"The variation in the delay of received packets, in milliseconds.","example":"0 ms"},"latency":{"type":"string","description":"The time it took a packet to travel from one point to another, in milliseconds.","example":"126 ms"},"max_loss":{"type":"string","description":"The maximum amount of packet loss, such as the maximum percentage of packets that failed to arrive at their destination.","example":"0.4%"},"frame_rate":{"type":"string","description":"The rate where the video camera can produce unique images (frames). Zoom supports a frame rate of up to 30 fps.","example":"12 fps"},"resolution":{"type":"string","description":"The number of pixels in each dimension that the video camera can display.","example":"1280*720"}},"description":"The QoS metrics for screen sharing output received by a participant who joined the meeting via CRC."},"as_input":{"title":"Screen Share QoS Object","type":"object","description":"The QoS metrics for screen sharing by a participant who joined the meeting","allOf":[{"title":"Audio QoS Object","type":"object","properties":{"avg_loss":{"type":"string","description":"The average amount of packet loss, such as the percentage of packets that failed to arrive at their destination.","example":"0.03%"},"bitrate":{"type":"string","description":"The bits per second transmitted along a digital network, in kbps.","example":"27.15 kbps"},"jitter":{"type":"string","description":"The variation in the delay of received packets, in milliseconds.","example":"0 ms"},"latency":{"type":"string","description":"The time it took a packet to travel from one point to another, in milliseconds.","example":"126 ms"},"max_loss":{"type":"string","description":"The maximum amount of packet loss, such as the maximum percentage of packets that failed to arrive at their destination.","example":"0.4%"}}},{"type":"object","properties":{"frame_rate":{"type":"string","description":"The rate where the video camera can produce unique images (frames). Zoom supports a frame rate of up to 30 fps.","example":"12 fps"},"resolution":{"type":"string","description":"The number of pixels in each dimension that the video camera can display.","example":"1280*720"}}}]},"as_output":{"title":"Screen Share QoS Object","type":"object","description":"The QoS metrics for screen sharing output received by a participant who joined the meeting","allOf":[{"title":"Audio QoS Object","type":"object","properties":{"avg_loss":{"type":"string","description":"The average amount of packet loss, such as the percentage of packets that failed to arrive at their destination.","example":"0.03%"},"bitrate":{"type":"string","description":"The bits per second transmitted along a digital network, in kbps.","example":"27.15 kbps"},"jitter":{"type":"string","description":"The variation in the delay of received packets, in milliseconds.","example":"0 ms"},"latency":{"type":"string","description":"The time it took a packet to travel from one point to another, in milliseconds.","example":"126 ms"},"max_loss":{"type":"string","description":"The maximum amount of packet loss, such as the maximum percentage of packets that failed to arrive at their destination.","example":"0.4%"}}},{"type":"object","properties":{"frame_rate":{"type":"string","description":"The rate where the video camera can produce unique images (frames). Zoom supports a frame rate of up to 30 fps.","example":"12 fps"},"resolution":{"type":"string","description":"The number of pixels in each dimension that the video camera can display.","example":"1280*720"}}}]},"audio_device_from_crc":{"type":"object","properties":{"avg_loss":{"type":"string","description":"The average amount of packet loss, such as the percentage of packets that failed to arrive at their destination.","example":"0.03%"},"bitrate":{"type":"string","description":"The bits per second transmitted along a digital network, in kbps.","example":"27.15 kbps"},"jitter":{"type":"string","description":"The variation in the delay of received packets, in milliseconds.","example":"0 ms"},"latency":{"type":"string","description":"The time it took a packet to travel from one point to another, in milliseconds.","example":"126 ms"},"max_loss":{"type":"string","description":"The maximum amount of packet loss, such as the maximum percentage of packets that failed to arrive at their destination.","example":"0.4%"}},"description":"The QoS metrics for audio sent by a participant who joined the meeting via a Cloud Room Connector (CRC)."},"audio_device_to_crc":{"type":"object","properties":{"avg_loss":{"type":"string","description":"The average amount of packet loss, such as the percentage of packets that failed to arrive at their destination.","example":"0.03%"},"bitrate":{"type":"string","description":"The bits per second transmitted along a digital network, in kbps.","example":"27.15 kbps"},"jitter":{"type":"string","description":"The variation in the delay of received packets, in milliseconds.","example":"0 ms"},"latency":{"type":"string","description":"The time it took a packet to travel from one point to another, in milliseconds.","example":"126 ms"},"max_loss":{"type":"string","description":"The maximum amount of packet loss, such as the maximum percentage of packets that failed to arrive at their destination.","example":"0.4%"}},"description":"The QoS metrics for audio received by a participant who joined the meeting via CRC."},"audio_input":{"title":"Audio QoS Object","type":"object","properties":{"avg_loss":{"type":"string","description":"The average amount of packet loss, such as the percentage of packets that failed to arrive at their destination.","example":"0.03%"},"bitrate":{"type":"string","description":"The bits per second transmitted along a digital network, in kbps.","example":"27.15 kbps"},"jitter":{"type":"string","description":"The variation in the delay of received packets, in milliseconds.","example":"0 ms"},"latency":{"type":"string","description":"The time it took a packet to travel from one point to another, in milliseconds.","example":"126 ms"},"max_loss":{"type":"string","description":"The maximum amount of packet loss, such as the maximum percentage of packets that failed to arrive at their destination.","example":"0.4%"}},"description":"The QoS metrics for audio sent by a participant who joined the meeting"},"audio_output":{"title":"Audio QoS Object","type":"object","properties":{"avg_loss":{"type":"string","description":"The average amount of packet loss, such as the percentage of packets that failed to arrive at their destination.","example":"0.03%"},"bitrate":{"type":"string","description":"The bits per second transmitted along a digital network, in kbps.","example":"27.15 kbps"},"jitter":{"type":"string","description":"The variation in the delay of received packets, in milliseconds.","example":"0 ms"},"latency":{"type":"string","description":"The time it took a packet to travel from one point to another, in milliseconds.","example":"126 ms"},"max_loss":{"type":"string","description":"The maximum amount of packet loss, such as the maximum percentage of packets that failed to arrive at their destination.","example":"0.4%"}},"description":"The QoS metrics for audio received by a participant who joined the meeting"},"cpu_usage":{"type":"object","properties":{"system_max_cpu_usage":{"type":"string","description":"The system's maximum CPU usage.","example":"11%"},"zoom_avg_cpu_usage":{"type":"string","description":"The Zoom's average CPU usage.","example":"0%"},"zoom_max_cpu_usage":{"type":"string","description":"The Zoom's maximum CPU usage.","example":"2%"},"zoom_min_cpu_usage":{"type":"string","description":"The Zoom's minimum CPU usage.","example":"0%"}},"description":"Information about CPU usage."},"cpu_pressure_level":{"type":"object","properties":{"system_min_cpu_pressure_level":{"type":"string","description":"The system’s minimum CPU pressure level","example":"normal","enum":["normal","fair","serious","critical"]},"system_avg_cpu_pressure_level":{"type":"string","description":"The system’s average CPU pressure level","example":"normal","enum":["normal","fair","serious","critical"]},"system_max_cpu_pressure_level":{"type":"string","description":"The system’s maximum CPU pressure level","example":"normal","enum":["critical","serious","fair","normal"]}},"description":"The system’s CPU pressure level"},"date_time":{"type":"string","description":"The QoS date and time.","format":"date-time","example":"2022-03-01T10:16:00Z"},"video_device_from_crc":{"type":"object","properties":{"avg_loss":{"type":"string","description":"The average amount of packet loss, such as the percentage of packets that failed to arrive at their destination.","example":"0.03%"},"bitrate":{"type":"string","description":"The bits per second transmitted along a digital network, in kbps.","example":"27.15 kbps"},"jitter":{"type":"string","description":"The variation in the delay of received packets, in milliseconds.","example":"0 ms"},"latency":{"type":"string","description":"The time it took a packet to travel from one point to another, in milliseconds.","example":"126 ms"},"max_loss":{"type":"string","description":"The maximum amount of packet loss, such as the maximum percentage of packets that failed to arrive at their destination.","example":"0.03%"},"frame_rate":{"type":"string","description":"The rate where the video camera can produce unique images (frames). Zoom supports a frame rate of up to 30 fps.","example":"12 fps"},"resolution":{"type":"string","description":"The number of pixels in each dimension that the video camera can display.","example":"1280*720"}},"description":"The QoS metrics for video input being sent by a participant who joined the meeting via CRC."},"video_device_to_crc":{"type":"object","properties":{"avg_loss":{"type":"string","description":"The average amount of packet loss, such as the percentage of packets that failed to arrive at their destination.","example":"0.03%"},"bitrate":{"type":"string","description":"The bits per second transmitted along a digital network, in kbps.","example":"27.15 kbps"},"jitter":{"type":"string","description":"The variation in the delay of received packets, in milliseconds.","example":"0 ms"},"latency":{"type":"string","description":"The time it took a packet to travel from one point to another, in milliseconds.","example":"126 ms"},"max_loss":{"type":"string","description":"The maximum amount of packet loss, such as the maximum percentage of packets that failed to arrive at their destination.","example":"0.4%"},"frame_rate":{"type":"string","description":"The rate where the video camera can produce unique images (frames). Zoom supports a frame rate of up to 30 fps.","example":"12 fps"},"resolution":{"type":"string","description":"The number of pixels in each dimension that the video camera can display.","example":"1280*720"}},"description":"The QoS metrics for video output being sent by a participant who joined the meeting via CRC."},"video_input":{"title":"Video QoS Object","type":"object","description":"The QoS metrics for video input being sent by a participant who joined the meeting","allOf":[{"title":"Audio QoS Object","type":"object","properties":{"avg_loss":{"type":"string","description":"The average amount of packet loss, such as the percentage of packets that failed to arrive at their destination.","example":"0.03%"},"bitrate":{"type":"string","description":"The bits per second transmitted along a digital network, in kbps.","example":"27.15 kbps"},"jitter":{"type":"string","description":"The variation in the delay of received packets, in milliseconds.","example":"0 ms"},"latency":{"type":"string","description":"The time it took a packet to travel from one point to another, in milliseconds.","example":"126 ms"},"max_loss":{"type":"string","description":"The maximum amount of packet loss, such as the maximum percentage of packets that failed to arrive at their destination.","example":"0.4%"}}},{"type":"object","properties":{"frame_rate":{"type":"string","description":"The rate where the video camera can produce unique images (frames). Zoom supports a frame rate of up to 30 fps.","example":"12 fps"},"resolution":{"type":"string","description":"The number of pixels in each dimension that the video camera can display.","example":"1280*720"}}}]},"video_output":{"title":"Video QoS Object","type":"object","description":"The QoS metrics for video output being sent by a participant who joined the meeting","allOf":[{"title":"Audio QoS Object","type":"object","properties":{"avg_loss":{"type":"string","description":"The average amount of packet loss, such as the percentage of packets that failed to arrive at their destination.","example":"0.03%"},"bitrate":{"type":"string","description":"The bits per second transmitted along a digital network, in kbps.","example":"27.15 kbps"},"jitter":{"type":"string","description":"The variation in the delay of received packets, in milliseconds.","example":"0 ms"},"latency":{"type":"string","description":"The time it took a packet to travel from one point to another, in milliseconds.","example":"126 ms"},"max_loss":{"type":"string","description":"The maximum amount of packet loss, such as the maximum percentage of packets that failed to arrive at their destination.","example":"0.4%"}}},{"type":"object","properties":{"frame_rate":{"type":"string","description":"The rate where the video camera can produce unique images (frames). Zoom supports a frame rate of up to 30 fps.","example":"12 fps"},"resolution":{"type":"string","description":"The number of pixels in each dimension that the video camera can display.","example":"1280*720"}}}]},"as_device_from_rwg":{"type":"object","properties":{"avg_loss":{"type":"string","description":"The average amount of packet loss, such as the percentage of packets that failed to arrive at their destination.","example":"0.03%"},"bitrate":{"type":"string","description":"The bits per second transmitted along a digital network, in kbps.","example":"27.15 kbps"},"jitter":{"type":"string","description":"The variation in the delay of received packets, in milliseconds.","example":"0 ms"},"latency":{"type":"string","description":"The time it took a packet to travel from one point to another, in milliseconds.","example":"126 ms"},"max_loss":{"type":"string","description":"The maximum amount of packet loss, such as the maximum percentage of packets that failed to arrive at their destination.","example":"0.4%"},"frame_rate":{"type":"string","description":"The rate where the video camera can produce unique images (frames). Zoom supports a frame rate of up to 30 fps.","example":"12 fps"},"resolution":{"type":"string","description":"The number of pixels in each dimension that the video camera can display.","example":"1280*720"}},"description":"The QoS metrics for screen sharing by a participant who joined the meeting via the web client."},"as_device_to_rwg":{"type":"object","properties":{"avg_loss":{"type":"string","description":"The average amount of packet loss, such as the percentage of packets that failed to arrive at their destination.","example":"0.03%"},"bitrate":{"type":"string","description":"The bits per second transmitted along a digital network, in kbps.","example":"27.15 kbps"},"jitter":{"type":"string","description":"The variation in the delay of received packets, in milliseconds.","example":"0 ms"},"latency":{"type":"string","description":"The time it took a packet to travel from one point to another, in milliseconds.","example":"126 ms"},"max_loss":{"type":"string","description":"The maximum amount of packet loss, such as the maximum percentage of packets that failed to arrive at their destination.","example":"0.4%"},"frame_rate":{"type":"string","description":"The rate where the video camera can produce unique images (frames). Zoom supports a frame rate of up to 30 fps.","example":"12 fps"},"resolution":{"type":"string","description":"The number of pixels in each dimension that the video camera can display.","example":"1280*720"}},"description":"The QoS output metrics for screen sharing received by a participant who joined the meeting via the web client."},"audio_device_from_rwg":{"type":"object","properties":{"avg_loss":{"type":"string","description":"The average amount of packet loss, such as the percentage of packets that failed to arrive at their destination.","example":"0.03%"},"bitrate":{"type":"string","description":"The bits per second transmitted along a digital network, in kbps.","example":"27.15 kbps"},"jitter":{"type":"string","description":"The variation in the delay of received packets, in milliseconds.","example":"0 ms"},"latency":{"type":"string","description":"The time it took a packet to travel from one point to another, in milliseconds.","example":"126 ms"},"max_loss":{"type":"string","description":"The maximum amount of packet loss, such as the maximum percentage of packets that failed to arrive at their destination.","example":"0.4%"}},"description":"The QoS metrics for audio sent by a participant who joined the meeting via the web client."},"audio_device_to_rwg":{"type":"object","properties":{"avg_loss":{"type":"string","description":"The average amount of packet loss. For example, the percentage of packets that failed to arrive at their destination.","example":"0.03%"},"bitrate":{"type":"string","description":"The bits per second transmitted along a digital network, in kbps.","example":"27.15 kbps"},"jitter":{"type":"string","description":"The variation in the delay of received packets, in milliseconds.","example":"0 ms"},"latency":{"type":"string","description":"The time it took a packet to travel from one point to another, in milliseconds.","example":"126 ms"},"max_loss":{"type":"string","description":"The maximum amount of packet loss, such as the maximum percentage of packets that failed to arrive at their destination.","example":"0.4%"}},"description":"The QoS metrics for audio received by a participant who joined the meeting via web client."},"video_device_from_rwg":{"type":"object","properties":{"avg_loss":{"type":"string","description":"The average amount of packet loss, such as the percentage of packets that failed to arrive at their destination.","example":"0.03%"},"bitrate":{"type":"string","description":"The bits per second transmitted along a digital network, in kbps.","example":"27.15 kbps"},"jitter":{"type":"string","description":"The variation in the delay of received packets, in milliseconds.","example":"0 ms"},"latency":{"type":"string","description":"The time it took a packet to travel from one point to another, in milliseconds.","example":"126 ms"},"max_loss":{"type":"string","description":"The maximum amount of packet loss, such as the maximum percentage of packets that failed to arrive at their destination.","example":"0.03%"},"frame_rate":{"type":"string","description":"The rate where the video camera can produce unique images (frames). Zoom supports a frame rate of up to 30 fps.","example":"12 fps"},"resolution":{"type":"string","description":"The number of pixels in each dimension that the video camera can display.","example":"1280*720"}},"description":"The QoS metrics for video input being sent by a participant who joined the meeting via the web client."},"video_device_to_rwg":{"type":"object","properties":{"avg_loss":{"type":"string","description":"The average amount of packet loss, such as the percentage of packets that failed to arrive at their destination.","example":"0.03%"},"bitrate":{"type":"string","description":"The bits per second transmitted along a digital network, in kbps.","example":"27.15 kbps"},"jitter":{"type":"string","description":"The variation in the delay of received packets, in milliseconds.","example":"0 ms"},"latency":{"type":"string","description":"The time it took a packet to travel from one point to another, in milliseconds.","example":"126 ms"},"max_loss":{"type":"string","description":"The maximum amount of packet loss, such as the maximum percentage of packets that failed to arrive at their destination.","example":"0.4%"},"frame_rate":{"type":"string","description":"The rate where the video camera can produce unique images (frames). Zoom supports a frame rate of up to 30 fps.","example":"12 fps"},"resolution":{"type":"string","description":"The number of pixels in each dimension that the video camera can display.","example":"1280*720"}},"description":"The QoS metrics for video output being sent by a participant who joined the meeting via the web client."},"wifi_rssi":{"type":"object","properties":{"max_rssi":{"type":"integer","description":"Maximum value of the wireless network's received signal strength indicator (RSSI).","example":-75},"avg_rssi":{"type":"integer","description":"Average value of the wireless network's received signal strength indicator (RSSI).","example":-69},"min_rssi":{"type":"integer","description":"Minimum value of the wireless network's received signal strength indicator (RSSI).","example":-35},"rssi_unit":{"type":"string","description":"Unit of the wireless network's received signal strength indicator (RSSI).","example":"dBm"}},"description":"The QoS metrics for the wireless network's RSSI sent by a participant who joined the meeting through a wireless network."},"audio_socket_break":{"type":"object","properties":{"socket_break":{"type":"boolean","description":"Whether the participant's audio socket broke.","example":true},"socket_break_time":{"type":"string","description":"The participant's audio socket break time.","format":"date-time","example":"2026-04-20T01:50:42Z"},"socket_recover":{"type":"boolean","description":"Whether the participant's audio socket recovered.","example":false},"socket_recover_time":{"type":"string","description":"The participant's audio socket recovery time.","format":"date-time","example":"2026-04-20T01:50:42Z"}},"description":"The QoS metrics for audio socket breaks by a participant who joined the meeting."},"video_socket_break":{"type":"object","properties":{"socket_break":{"type":"boolean","description":"Whether the participant's video socket broke.","example":true},"socket_break_time":{"type":"string","description":"The participant's video socket break time.","format":"date-time","example":"2026-04-20T01:50:42Z"},"socket_recover":{"type":"boolean","description":"Whether the participant's video socket recovered.","example":false},"socket_recover_time":{"type":"string","description":"The participant's video socket recovery time.","format":"date-time","example":"2026-04-20T01:50:42Z"}},"description":"The QoS metrics for video socket breaks by a participant who joined the meeting."},"as_socket_break":{"type":"object","properties":{"socket_break":{"type":"boolean","description":"Whether the participant's screen sharing socket broke.","example":true},"socket_break_time":{"type":"string","description":"The participant's screen sharing socket break time.","format":"date-time","example":"2026-04-20T01:50:42Z"},"socket_recover":{"type":"boolean","description":"Whether the participant's screen sharing socket recovered.","example":false},"socket_recover_time":{"type":"string","description":"The participant's screen sharing socket recovery time.","format":"date-time","example":"2026-04-20T01:50:42Z"}},"description":"The QoS metrics for screen sharing socket breaks by a participant who joined the meeting."},"command_socket_break":{"type":"object","properties":{"socket_break":{"type":"boolean","description":"Whether the participant's command socket broke.","example":true},"socket_break_time":{"type":"string","description":"The participant's command socket break time.","format":"date-time","example":"2026-04-20T01:50:42Z"},"socket_recover":{"type":"boolean","description":"Whether the participant's command socket recovered.","example":false},"socket_recover_time":{"type":"string","description":"The participant's command socket recovery time.","format":"date-time","example":"2026-04-20T01:50:42Z"}},"description":"The QoS metrics for command socket breaks by a participant who joined the meeting."}}}},"version":{"type":"string","description":"The participant's Zoom client version.","example":"5.9.1.2581"},"health":{"type":"string","description":"The participant's health","example":"Warning","default":"Good","enum":["Good","Warning","Critical"]},"issue_list":{"maxItems":5,"minItems":0,"type":"array","description":"The participant's issue list","items":{"type":"string","description":"The participant's issue","example":"audio"}},"rc_reason":{"type":"string","description":"the call reconnection reason: Client crash","example":"Client crash"},"os":{"type":"string","description":"device operation system","example":"iOS"},"os_version":{"type":"string","description":"device operation system version","example":"16.5"},"browser_name":{"type":"string","description":"webclient operation browser","example":"Firefox"},"browser_version":{"type":"string","description":"webclient operation browser version","example":"133"},"participant_uuid":{"type":"string","description":"The participant's UUID. This value assigned to a participant upon joining a webinar and is only valid for the webinar's duration.","example":"D444CD06-2ABB-2FCC-019B-39E41D8DADF7"},"network_type":{"type":"string","description":"The participant's network type. * `Wired` * `Wifi` * `PPP` - Point-to-Point. * `Cellular` - 3G, 4G, and 5G cellular. * `Others` - An unknown device.","example":"Wired","enum":["Wired","Wifi","PPP","Cellular","Others"]},"data_center":{"type":"string","description":"The data center that the participant is leveraging to join the webinar.","example":"United States"},"full_data_center":{"type":"string","description":"The data center where participant's meeting data is stored. This field includes a semicolon-separated list of HTTP Tunnel (HT), Cloud Room Connector (CRC), and Real-Time Web Gateway (RWG) location information.","example":"United States;China (TJ RWG);"},"connection_type":{"type":"string","description":"The participant' connection type.","example":"UDP","enum":["P2P","TCP","UDP","Reliable UDP","SSL","HTTP","TCP+Proxy","UDP+Proxy","Reliable+Proxy","SSL+Proxy","HTTP+Proxy"]},"share_application":{"type":"boolean","description":"Whether the participant chose to share an application during the meeting.","example":true},"share_desktop":{"type":"boolean","description":"Whether the participant chose to share their desktop during the screenshare.","example":true},"share_whiteboard":{"type":"boolean","description":"Whether the participant chose to share their whiteboard during the screenshare.","example":true},"recording":{"type":"boolean","description":"Whether the recording feature was used during the webinar.","example":false},"device_name":{"type":"string","description":"device's name","example":"iPhone 7 Global"},"has_archiving":{"type":"boolean","description":"The status of the archiving feature for the meeting","example":false},"optional_archiving":{"type":"string","description":"This is shown only for internal participants who have archiving enabled","example":"no optional archiving","enum":["no optional archiving","join without archiving","join with archiving"]},"groupId":{"type":"string","description":"the attendee's group id","example":"TcjqVCTzRy6hLa0d8WpAIg"},"video_connection_type":{"type":"string","description":"The participant's video connection type.","example":"UDP","enum":["P2P","TCP","UDP","Reliable UDP","SSL","HTTP","TCP+Proxy","UDP+Proxy","Reliable+Proxy","SSL+Proxy","HTTP+Proxy"]},"webinar_number":{"type":"string","description":"Unique identifier of the webinar in \"long\" format(represented as int64 data type in JSON)","example":"93201235621"},"zoom_thin_client_plugin_version":{"type":"string","description":"VDI thin client version","example":"6.5.11.26770"},"email":{"type":"string","description":"The participant's email address. 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](/docs/api-reference/using-zoom-apis#email-address) for details.","format":"email","example":"jchill@example.com"},"as_connection_type":{"type":"string","description":"The participant's screen share connection type.","example":"UDP","enum":["P2P","TCP","UDP","Reliable UDP","SSL","HTTP","TCP+Proxy","UDP+Proxy","Reliable+Proxy","SSL+Proxy","HTTP+Proxy"]},"vdi_plugin_info_status":{"type":"string","description":"The participant's VDI plugin connection status.","example":"Local","enum":["Optimized","UnOptimized","Local"]},"vdi_plugin_info_fb_code_reason":{"type":"string","description":"The participant's VDI plugin fallback reason.","example":"None (no error)"}},"description":"The information about the participant and their quality of service (QoS)."}}}},"400":{"description":"**HTTP Status Code:** `400` <br>\n Bad Request  \n\n **Error Code:** `12702` <br>\n Can not access a webinar a year ago. <br>\n"},"401":{"description":"**HTTP Status Code:** `401` <br>\n Unauthorized  \n\n "},"403":{"description":"**HTTP Status Code:** `403` <br>\n Forbidden  \n\n "},"404":{"description":"**HTTP Status Code:** `404` <br>\n Not Found  \n\n **Error Code:** `3001` <br>\n This webinar's detail info is not available or ID is not valid. <br>\n"},"429":{"description":"**HTTP Status Code:** `429` <br>\n Too Many Requests. For more information, see [rate limits](https://developers.zoom.us/docs/api/rest/rate-limits/). \n\n "}},"security":[{"openapi_authorization":[]}],"x-extensions":{"x-permissions":["DashboardWebinars:Read"],"x-macro-scopes":["dashboard:master"],"x-granular-scopes":["dashboard:read:webinar_participant_qos:master"]}}},"/accounts/{accountId}/metrics/zoomrooms":{"get":{"tags":["Dashboards"],"summary":"List Zoom Rooms","description":"List information on all Zoom Rooms in an account.  \n   \n \n**Prerequisites:**  \n \n* Business, Education or API Plan with Zoom Rooms set up.\n\n\n\n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `dashboard_zr:read:master`,`dashboard:master`\n\n**[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `dashboard:read:list_zoomrooms:master`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Resource-intensive`","operationId":"dashboardZoomRooms","parameters":[{"name":"page_size","in":"query","description":"The number of records returned within a single API call.","required":false,"schema":{"maximum":300,"type":"integer","example":30,"default":30}},{"name":"page_number","in":"query","description":"The page number of the current page in the returned records.","required":false,"schema":{"type":"integer","example":1,"default":1}},{"name":"next_page_token","in":"query","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.","required":false,"schema":{"type":"string","example":"LkbB9n92siRxgYkffZ8KhApZCQMZpNrN0d2"}},{"name":"accountId","in":"path","description":"Unique identifier of the account.","required":true,"schema":{"type":"string","example":"TQTvjT52Tmi_wrhASNNOEw"}}],"responses":{"200":{"description":"**HTTP Status Code:** `200`  \n \nList of Zoom rooms returned.  \n \nOnly available for paid accounts that have enabled the Dashboard feature.","content":{"application/json":{"schema":{"title":"Zoom Room List","type":"object","description":"Zoom Room List","allOf":[{"type":"object","properties":{"next_page_token":{"type":"string","example":"LkbB9n92siRxgYkffZ8KhApZCQMZpNrN0d2"},"page_count":{"type":"integer","description":"The number of pages returned for the request made.","example":2},"page_number":{"type":"integer","description":"The page number of the current results.","example":1,"default":1},"page_size":{"maximum":300,"type":"integer","description":"The number of records returned with a single API call.","example":30,"default":30},"total_records":{"type":"integer","description":"The total number of all the records available across pages.","example":30}},"description":"Pagination Object."},{"type":"object","properties":{"zoom_rooms":{"type":"array","description":"Array of Zoom Rooms","items":{"title":"Zoom Room","type":"object","properties":{"account_type":{"type":"string","description":"Zoom room email type.","example":"Work Email"},"calender_name":{"type":"string","description":"Zoom calendar name.","example":"666555"},"camera":{"type":"string","description":"Zoom Room camera.\n\n**Note:** This response returns an empty string (`&ldquo;&ldquo;`) value for any users who are **not** a part of the host's account (external users).","example":"Integrated Webcam"},"device_ip":{"type":"string","description":"Zoom room device IP.","example":"Computer : 10.100.170.109"},"email":{"type":"string","description":"Zoom room email.","example":"user@example.com"},"health":{"type":"string","example":"critical"},"id":{"type":"string","description":"Zoom room ID.","example":"35QLhffMSfqUJJ9gCszciw"},"issues":{"type":"array","description":"Zoom Room issues.","items":{"type":"string","example":"Zoom room is offline"}},"last_start_time":{"type":"string","description":"Zoom room last start time.","example":"2022-03-10T11:34:39Z"},"location":{"type":"string","description":"Zoom room location.","example":"floor1"},"location_id":{"type":"string","description":"The Zoom Room's location ID.","example":"BzBAAAAAAAfprg"},"microphone":{"type":"string","description":"Zoom Room microphone.\n\n**Note:** This response returns an empty string (`&ldquo;&ldquo;`) value for any users who are **not** a part of the host's account (external users).","example":"Microphone (3- Logitech USB Headset H340)"},"room_name":{"type":"string","description":"Zoom room name.","example":"jchill"},"speaker":{"type":"string","description":"Zoom Room speaker.\n\n**Note:** This response returns an empty string (`&ldquo;&ldquo;`) value for any users who are **not** a part of the host's account (external users).","example":"Speakers (3- Logitech USB Headset H340)"},"status":{"type":"string","description":"Zoom room status.","example":"Offline"}},"description":"Zoom room."}}}}]}}}},"429":{"description":"**HTTP Status Code:** `429` <br>\n Too Many Requests. For more information, see [rate limits](https://developers.zoom.us/docs/api/rest/rate-limits/). \n\n "}},"security":[{"openapi_authorization":[]}],"x-extensions":{"x-permissions":["DashboardZR:Read"],"x-macro-scopes":["dashboard_zr:read:master","dashboard:master"],"x-granular-scopes":["dashboard:read:list_zoomrooms:master"]}}},"/accounts/{accountId}/metrics/zoomrooms/issues":{"get":{"tags":["Dashboards"],"summary":"Get top 25 issues of Zoom Rooms","description":"Get top 25 issues of Zoom Rooms.  \n \n**Prerequisites:**  \n \n* Business, Education or API Plan with Zoom Rooms set up.\n\n\n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `dashboard_zr:read:master`,`dashboard:master`\n\n**[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `dashboard:read:issues_zoomroom:master`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Heavy`","operationId":"dashboardZoomRoomIssue","parameters":[{"name":"from","in":"query","description":"Start date in 'yyyy-mm-dd' format. The date range defined by the &quot;from&quot; and &quot;to&quot; parameters should only be one month as the report includes only one month worth of data at once.","required":true,"schema":{"type":"string","format":"date","example":"2022-01-01"}},{"name":"to","in":"query","description":"End date.","required":true,"schema":{"type":"string","format":"date","example":"2022-01-28"}},{"name":"accountId","in":"path","description":"Unique identifier of the account.","required":true,"schema":{"type":"string","example":"TQTvjT52Tmi_wrhASNNOEw"}}],"responses":{"200":{"description":"**HTTP Status Code:** `200`  \n \nZoom Room Issue details returned","content":{"application/json":{"schema":{"type":"object","allOf":[{"type":"object","properties":{"from":{"type":"string","description":"Start date for this report","format":"date","example":"2022-01-01"},"to":{"type":"string","description":"End date for this report","format":"date","example":"2022-01-30"},"total_records":{"type":"integer","description":"The number of all records available across pages","example":20}}},{"type":"object","properties":{"issues":{"type":"array","items":{"type":"object","properties":{"issue_name":{"type":"string","description":"Issue Name.  \n  The value of the this field could be one of the following:  \n \n* `Room Controller disconnected`  \n \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 online`\n* `High CPU usage is detected`\n* `Low bandwidth network is detected`\n* `{name} battery is low`\n* `{name} battery is normal`\n* `{name} disconnected`\n* `{name} connected`\n* `{name} is not charging`\n\nPossible values for {name}:   \n \n* Zoom Rooms Computer \n* Controller\n* Scheduling Display","example":"Untrusted certificate is detected"},"zoom_rooms_count":{"type":"integer","description":"Zoom Room Count of Issue","example":1}}}}}}]}}}},"429":{"description":"**HTTP Status Code:** `429` <br>\n Too Many Requests. For more information, see [rate limits](https://developers.zoom.us/docs/api/rest/rate-limits/). \n\n "}},"security":[{"openapi_authorization":[]}],"x-extensions":{"x-permissions":["DashboardZR:Read"],"x-macro-scopes":["dashboard_zr:read:master","dashboard:master"],"x-granular-scopes":["dashboard:read:issues_zoomroom:master"]}}},"/accounts/{accountId}/metrics/zoomrooms/{zoomroomId}":{"get":{"tags":["Dashboards"],"summary":"Get Zoom Rooms details","description":"The Zoom Rooms dashboard metrics lets you know the type of configuration a Zoom room has and details on the meetings held in that room. \n\nUse this API to retrieve information on a specific room.  \n   \n \n**Prerequisites:**  \n \n* Business, Education or API Plan with Zoom Rooms set up.\n\n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `dashboard:master`\n\n**[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `dashboard:read:zoomroom:master`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `HEAVY`","operationId":"dashboardZoomRoom","parameters":[{"name":"zoomroomId","in":"path","description":"The Zoom room ID.","required":true,"schema":{"type":"string","example":"azGzXIVUTWOdEQB79aNHkA"}},{"name":"from","in":"query","description":"Start date in 'yyyy-mm-dd' format. The date range defined by the &quot;from&quot; and &quot;to&quot; parameters should only be one month as the report includes only one month worth of data at once.","required":true,"schema":{"type":"string","format":"date","example":"2022-01-01"}},{"name":"to","in":"query","description":"End date.","required":true,"schema":{"type":"string","format":"date","example":"2022-01-28"}},{"name":"page_size","in":"query","description":"The number of records returned within a single API call.","required":false,"schema":{"maximum":300,"type":"integer","example":30,"default":30}},{"name":"next_page_token","in":"query","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.","required":false,"schema":{"type":"string","example":"IAfJX3jsOLW7w3dokmFl84zOa0MAVGyMEB2"}},{"name":"accountId","in":"path","description":"Unique identifier of the account.","required":true,"schema":{"type":"string","example":"TQTvjT52Tmi_wrhASNNOEw"}}],"responses":{"200":{"description":"**HTTP Status Code:** `200`  \n \nZoom room returned.  \n \nOnly available for paid accounts that have enabled the Dashboard feature.","content":{"application/json":{"schema":{"type":"object","allOf":[{"title":"Zoom Room","type":"object","properties":{"account_type":{"type":"string","description":"Zoom room email type.","example":"Work Email"},"calender_name":{"type":"string","description":"Zoom calendar name.","example":"666555"},"camera":{"type":"string","description":"Zoom Room camera.\n\n**Note:** This response returns an empty string (`&ldquo;&ldquo;`) value for any users who are **not** a part of the host's account (external users).","example":"FaceTime HD Camera"},"device_ip":{"type":"string","description":"Zoom room device IP.","example":"Computer : 10.100.93.138"},"email":{"type":"string","description":"Zoom room email.","example":"user@example.com"},"health":{"type":"string","description":"Health of the Zoom Room.","example":"critical"},"id":{"type":"string","description":"Zoom room ID.","example":"_hjJhB0cQRi9Xm3HX64Ggw"},"issues":{"type":"array","description":"Issues encountered by the Zoom Room.","items":{"type":"string","example":"Zoom room is offline"}},"last_start_time":{"type":"string","description":"Zoom room last start time.","example":"2020-11-04T01:06:41Z"},"location":{"type":"string","description":"Zoom room location.","example":"floor1"},"microphone":{"type":"string","description":"Zoom Room microphone.\n\n**Note:** This response returns an empty string (`&ldquo;&ldquo;`) value for any users who are **not** a part of the host's account (external users).","example":"Built-in Microphone (External Microphone)"},"room_name":{"type":"string","description":"Zoom room name.","example":"jchill room"},"speaker":{"type":"string","description":"Zoom Room speaker.\n\n**Note:** This response returns an empty string (`&ldquo;&ldquo;`) value for any users who are **not** a part of the host's account (external users).","example":"Built-in Output (Headphones)"},"status":{"type":"string","description":"Zoom room status.","example":"Offline"}},"description":"Zoom room."},{"type":"object","properties":{"live_meeting":{"title":"Meeting Metrics","type":"object","properties":{"host":{"type":"string","description":"Host display name.","example":"API"},"custom_keys":{"maxItems":10,"type":"array","description":"Custom keys and values assigned to the meeting.","items":{"type":"object","properties":{"key":{"maxLength":64,"type":"string","description":"Custom key associated with the meeting.","example":"Host Nation"},"value":{"maxLength":256,"type":"string","description":"Value of the custom key associated with the meeting.","example":"US"}}}},"dept":{"type":"string","description":"Department of the host.","example":"Developers"},"duration":{"type":"string","description":"Meeting duration.","example":"02:21"},"email":{"type":"string","description":"Email address of the host.","example":"user@example.com"},"end_time":{"type":"string","description":"Meeting end time.","format":"date-time","example":"2022-03-01T10:17:35Z"},"has_3rd_party_audio":{"type":"boolean","description":"Indicates whether or not [third party audio](https://support.zoom.us/hc/en-us/articles/202470795-3rd-Party-Audio-Conference) was used in the meeting.","example":true},"has_archiving":{"type":"boolean","description":"Whether the archiving feature was used in the meeting.","example":true},"has_pstn":{"type":"boolean","description":"Indicates whether or not the PSTN was used in the meeting.","example":true},"has_recording":{"type":"boolean","description":"Indicates whether or not the recording feature was used in the meeting. ","example":true},"has_screen_share":{"type":"boolean","description":"Indicates whether or not screenshare feature was used in the meeting.","example":true},"has_sip":{"type":"boolean","description":"Indicates whether or not someone joined the meeting using SIP.","example":true},"has_video":{"type":"boolean","description":"Indicates whether or not video was used in the meeting.","example":true},"has_voip":{"type":"boolean","description":"Indicates whether or not VoIP was used in the meeting.","example":true},"has_manual_captions":{"type":"boolean","description":"Indicates whether a manual caption was enabled in the meeting.","example":true},"has_automated_captions":{"type":"boolean","description":"Indicates whether an automated caption was enabled in the meeting.","example":true},"id":{"type":"integer","description":"[Meeting ID](https://support.zoom.us/hc/en-us/articles/201362373-What-is-a-Meeting-ID-): Unique identifier of the meeting in &quot;**long**&quot; format(represented as int64 data type in JSON), also known as the meeting number.","format":"int64","example":575734086},"in_room_participants":{"type":"integer","description":"The number of Zoom Room participants in the meeting.","example":2},"participants":{"type":"integer","description":"Meeting participant count.","example":2},"start_time":{"type":"string","description":"Meeting start time.","format":"date-time","example":"2022-03-01T10:15:14Z"},"topic":{"type":"string","description":"Meeting topic.","example":"API Meeting"},"user_type":{"type":"string","description":"License type of the user.","example":"Licensed"},"uuid":{"type":"string","description":"Meeting UUID. [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.","example":"gaqOKVN9RAaDHKYWEcASXg=="}},"description":"Live meeting metric details."},"past_meetings":{"type":"object","description":"Past meeting metric details.","allOf":[{"type":"object","properties":{"from":{"type":"string","description":"Start date for this report in 'yyyy-mm-dd' format.","format":"date","example":"2022-04-07"},"to":{"type":"string","description":"End date for this report in 'yyyy-mm-dd' format.","format":"date","example":"2022-04-08"}}},{"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":"Tva2CuIdTgsv8wAnhyAdU3m06Y2HuLQtlh3"},"page_count":{"type":"integer","description":"The number of pages returned for the request made.","example":1},"page_size":{"maximum":300,"type":"integer","description":"The number of records returned within a single API call.","example":30,"default":30},"total_records":{"type":"integer","description":"The number of all records available across pages.","example":1}},"description":"Pagination object."},{"type":"object","properties":{"meetings":{"type":"array","description":"Array of meeting objects.","items":{"title":"Meeting Metrics","type":"object","properties":{"host":{"type":"string","description":"Host display name.","example":"API"},"custom_keys":{"maxItems":10,"type":"array","description":"Custom keys and values assigned to the meeting.","items":{"type":"object","properties":{"key":{"maxLength":64,"type":"string","description":"Custom key associated with the meeting.","example":"Host Nation"},"value":{"maxLength":256,"type":"string","description":"Value of the custom key associated with the meeting.","example":"US"}}}},"dept":{"type":"string","description":"Department of the host.","example":"Developers"},"duration":{"type":"string","description":"Meeting duration.","example":"02:21"},"email":{"type":"string","description":"Email address of the host.","example":"user@example.com"},"end_time":{"type":"string","description":"Meeting end time.","format":"date-time","example":"2022-03-01T10:17:35Z"},"has_3rd_party_audio":{"type":"boolean","description":"Indicates whether or not [third party audio](https://support.zoom.us/hc/en-us/articles/202470795-3rd-Party-Audio-Conference) was used in the meeting.","example":true},"has_archiving":{"type":"boolean","description":"Whether the archiving feature was used in the meeting.","example":true},"has_pstn":{"type":"boolean","description":"Indicates whether or not the PSTN was used in the meeting.","example":true},"has_recording":{"type":"boolean","description":"Indicates whether or not the recording feature was used in the meeting. ","example":true},"has_screen_share":{"type":"boolean","description":"Indicates whether or not screenshare feature was used in the meeting.","example":true},"has_sip":{"type":"boolean","description":"Indicates whether or not someone joined the meeting using SIP.","example":true},"has_video":{"type":"boolean","description":"Indicates whether or not video was used in the meeting.","example":true},"has_voip":{"type":"boolean","description":"Indicates whether or not VoIP was used in the meeting.","example":true},"has_manual_captions":{"type":"boolean","description":"Indicates whether a manual caption was enabled in the meeting.","example":true},"has_automated_captions":{"type":"boolean","description":"Indicates whether an automated caption was enabled in the meeting.","example":true},"id":{"type":"integer","description":"[Meeting ID](https://support.zoom.us/hc/en-us/articles/201362373-What-is-a-Meeting-ID-): Unique identifier of the meeting in &quot;**long**&quot; format(represented as int64 data type in JSON), also known as the meeting number.","format":"int64","example":575734086},"in_room_participants":{"type":"integer","description":"The number of Zoom Room participants in the meeting.","example":2},"participants":{"type":"integer","description":"Meeting participant count.","example":2},"start_time":{"type":"string","description":"Meeting start time.","format":"date-time","example":"2022-03-01T10:15:14Z"},"topic":{"type":"string","description":"Meeting topic.","example":"API Meeting"},"user_type":{"type":"string","description":"License type of the user.","example":"Licensed"},"uuid":{"type":"string","description":"Meeting UUID. [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.","example":"gaqOKVN9RAaDHKYWEcASXg=="},"meeting_platform":{"type":"string","description":"Indicates the meeting platform that hosts the meeting. This field is used to distinguish Zoom meetings from third-party meetings joined through Zoom Rooms, such as MS Teams and Google Meet.","example":"Zoom","enum":["Zoom","MS Teams","Google Meet"]}},"description":"Meeting metric details."}}}}]}}}]}}}},"429":{"description":"**HTTP Status Code:** `429` <br>\n Too Many Requests. For more information, see [rate limits](https://developers.zoom.us/docs/api/rest/rate-limits/). \n\n "}},"security":[{"openapi_authorization":[]}],"x-extensions":{"x-permissions":["DashboardZR:Read"],"x-macro-scopes":["dashboard:master"],"x-granular-scopes":["dashboard:read:zoomroom:master"]}}},"/accounts/{accountId}/information_barriers/policies":{"get":{"tags":["Information Barriers"],"summary":"List information Barrier policies","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 **Prerequisites:** \n* [Contact Zoom Support](https://support.zoom.us/hc/en-us/articles/201362003) to enable Information Barriers for your account.\n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `information_barriers:read:master`\n\n**[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `information_barrier:read:list_policies:master`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`","operationId":"InformationBarriersList","parameters":[{"name":"page_size","in":"query","description":"Number of records to return per API call","required":false,"schema":{"maximum":300,"minimum":1,"type":"integer","example":30}},{"name":"next_page_token","in":"query","description":"Token from previous API call that indicates to get the next page of results","required":false,"schema":{"type":"string","example":"eyJwYWdlIjogMiwgInBhZ2VTaXplIjogMTB9"}},{"name":"accountId","in":"path","description":"Unique identifier of the account.","required":true,"schema":{"type":"string","example":"TQTvjT52Tmi_wrhASNNOEw"}}],"responses":{"200":{"description":"**HTTP Status Code:** `200`   \n  InformationBarriers returned.","content":{"application/json":{"schema":{"required":["policies","total_records"],"type":"object","properties":{"policies":{"type":"array","description":"A list of group policy JSONs containing \"assigned_group_id\", \"id\", \"policy_name\", \"settings\", \"status\", \"to_group_id\", \"type\"","items":{"required":["assigned_group_id","id","policy_name","settings","status","to_group_id","type"],"type":"object","properties":{"assigned_group_id":{"type":"string","description":"The assignee group's (Group 1) ID.","example":"SsxAmMT7QPOH19Kf9ZHz6g"},"id":{"type":"string","description":"The Information Barriers policy's ID.","example":"ErxAmMT7QPOH19Kf9Z55ty"},"policy_name":{"type":"string","description":"The Information Barriers policy's name.","example":"test"},"chaperone_group_id":{"type":"string","description":"The chaperone group's ID","example":"0P9yYDOFRVeSNvSxwuO8rA"},"settings":{"required":["complete_phone_calls","file_transfer","im","in_meeting_chat","meeting","message_via_sms","recording","screen_share"],"type":"object","properties":{"complete_phone_calls":{"type":"boolean","description":"If true, users between groups **cannot** call each other.","example":false},"file_transfer":{"type":"boolean","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`.","example":false},"im":{"type":"boolean","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`.","example":false},"in_meeting_chat":{"type":"boolean","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`.","example":false},"meeting":{"type":"boolean","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.","example":false},"message_via_sms":{"type":"boolean","description":"If true, users between groups **cannot** user SMS.","example":false},"recording":{"type":"boolean","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.","example":false},"screen_share":{"type":"boolean","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`.","example":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."},"status":{"type":"integer","description":"The Information Barriers policy's status. \n* `0` &mdash; Disabled. \n* `1` &mdash; Enabled.","example":1,"enum":[0,1]},"to_group_id":{"type":"string","description":"The assignee group's (Group 2) ID.","example":"mjLMOSAERBaakF8kSDWB7g"},"type":{"type":"integer","description":"The Information Barriers policy's type of `settings` restrictions. \n* `0` &mdash; 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` &mdash; 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` &mdash; No blocks exist, but only users in Group 1 can chat with users in Group 2. \n* `3` &mdash; No blocks exist and users in Group 1 and Group 2 can chat with each other. \n\nThis field only supports `0`.","example":1,"default":0,"enum":[0,1,2,3]}}}},"total_records":{"type":"integer","description":"The total count of Information Barriers policies.","example":30},"next_page_token":{"type":"string","description":"Token that can be passed in a subsequent API call to retrieve next page of results.","example":"eyJwYWdlIjogMiwgInBhZ2VTaXplIjogMTB9"}}}}}},"400":{"description":"**HTTP Status Code:** `400` <br>\n Bad Request  \n\n **Error Code:** `200` <br>\n Not available for this account, {0} <br>\n**Error Code:** `200` <br>\n Only available for Paid account: {0}. <br>\n"},"429":{"description":"**HTTP Status Code:** `429` <br>\n Too Many Requests. For more information, see [rate limits](https://developers.zoom.us/docs/api/rest/rate-limits/). \n\n "}},"security":[{"openapi_authorization":[]}],"x-extensions":{"x-permissions":[],"x-macro-scopes":["information_barriers:read:master"],"x-granular-scopes":["information_barrier:read:list_policies:master"]}},"post":{"tags":["Information Barriers"],"summary":"Create an Information Barrier policy","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 **Prerequisites:** \n* [Contact Zoom Support](https://support.zoom.us/hc/en-us/articles/201362003) to enable Information Barriers for your account.\n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `information_barriers:write:master`\n\n**[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `information_barrier:write:policy:master`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`","operationId":"InformationBarriersCreate","parameters":[{"name":"accountId","in":"path","description":"Unique identifier of the account.","required":true,"schema":{"type":"string","example":"TQTvjT52Tmi_wrhASNNOEw"}}],"requestBody":{"description":"Information Barriers object","content":{"application/json":{"schema":{"required":["assigned_group_id","id","policy_name","settings","status","to_group_id","type"],"type":"object","properties":{"assigned_group_id":{"type":"string","description":"The assigner group's (Group 1) ID.","example":"SsxAmMT7QPOH19Kf9ZHz6g"},"id":{"type":"string","description":"The Information Barriers policy's ID.","example":"ErxAmMT7QPOH19Kf9Z55ty"},"policy_name":{"type":"string","description":"The Information Barriers policy's name.","example":"test"},"settings":{"required":["complete_phone_calls","file_transfer","im","in_meeting_chat","meeting","message_via_sms","recording","screen_share"],"type":"object","properties":{"complete_phone_calls":{"type":"boolean","description":"If true, users between groups **cannot** call each other.","example":false},"file_transfer":{"type":"boolean","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`.","example":false},"im":{"type":"boolean","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`.","example":false},"in_meeting_chat":{"type":"boolean","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`.","example":false},"meeting":{"type":"boolean","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.","example":false},"message_via_sms":{"type":"boolean","description":"If true, users between groups **cannot** user SMS.","example":false},"recording":{"type":"boolean","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.","example":false},"screen_share":{"type":"boolean","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`.","example":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."},"status":{"type":"integer","description":"The Information Barriers policy's status. \n* `0` &mdash; Disabled. \n* `1` &mdash; Enabled.","example":1,"enum":[0,1]},"to_group_id":{"type":"string","description":"The assignee group's (Group 2) ID.","example":"mjLMOSAERBaakF8kSDWB7g"},"type":{"type":"integer","description":"The Information Barriers policy's type of `settings` restrictions. \n* `0` &mdash; 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` &mdash; 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` &mdash; No blocks exist, but only users in Group 1 can chat with users in Group 2. \n* `3` &mdash; No blocks exist and users in Group 1 and Group 2 can chat with each other. \n\nThis field only supports `0`.","example":1,"default":0,"enum":[0,1,2,3]}}}}}},"responses":{"201":{"description":"**HTTP Status Code:** `201`   \n  Information Barriers created.","content":{"application/json":{"schema":{"required":["assigned_group_id","id","policy_name","settings","status","to_group_id","type"],"type":"object","properties":{"assigned_group_id":{"type":"string","description":"The assigner group's (Group 1) ID.","example":"SsxAmMT7QPOH19Kf9ZHz6g"},"id":{"type":"string","description":"The Information Barriers policy's ID.","example":"ErxAmMT7QPOH19Kf9Z55ty"},"policy_name":{"type":"string","description":"The Information Barriers policy's name.","example":"test"},"settings":{"required":["complete_phone_calls","file_transfer","im","in_meeting_chat","meeting","message_via_sms","recording","screen_share"],"type":"object","properties":{"complete_phone_calls":{"type":"boolean","description":"If true, users between groups **cannot** call each other.","example":false},"file_transfer":{"type":"boolean","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`.","example":false},"im":{"type":"boolean","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`.","example":false},"in_meeting_chat":{"type":"boolean","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`.","example":false},"meeting":{"type":"boolean","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.","example":false},"message_via_sms":{"type":"boolean","description":"If true, users between groups **cannot** user SMS.","example":false},"recording":{"type":"boolean","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.","example":false},"screen_share":{"type":"boolean","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`.","example":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."},"status":{"type":"integer","description":"The Information Barriers policy's status. \n* `0` &mdash; Disabled. \n* `1` &mdash; Enabled.","example":1,"enum":[0,1]},"to_group_id":{"type":"string","description":"The assignee group's (Group 2) ID.","example":"mjLMOSAERBaakF8kSDWB7g"},"type":{"type":"integer","description":"The Information Barriers policy's type of `settings` restrictions. \n* `0` &mdash; 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` &mdash; 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` &mdash; No blocks exist, but only users in Group 1 can chat with users in Group 2. \n* `3` &mdash; No blocks exist and users in Group 1 and Group 2 can chat with each other. \n\nThis field only supports `0`.","example":1,"default":0,"enum":[0,1,2,3]}}}}}},"400":{"description":"**HTTP Status Code:** `400` <br>\n Bad Request  \n\n **Error Code:** `300` <br>\n assigned_group_id and to_group_id are required fields and cannot be left empty or the same. <br>\n**Error Code:** `7002` <br>\n Unable to add this policy, as it would create duplicate policies which is not permitted. assigned_group_id: {0}, to_group_id: {1}. <br>\n**Error Code:** `200` <br>\n Not available for this account, {0} <br>\n**Error Code:** `300` <br>\n policy_name is a required field and cannot be left empty. <br>\n**Error Code:** `200` <br>\n Only available for Paid account: {0}. <br>\n"},"429":{"description":"**HTTP Status Code:** `429` <br>\n Too Many Requests. For more information, see [rate limits](https://developers.zoom.us/docs/api/rest/rate-limits/). \n\n "}},"security":[{"openapi_authorization":[]}],"x-extensions":{"x-permissions":[],"x-macro-scopes":["information_barriers:write:master"],"x-granular-scopes":["information_barrier:write:policy:master"]}}},"/accounts/{accountId}/information_barriers/policies/{policyId}":{"get":{"tags":["Information Barriers"],"summary":"Get an Information Barrier policy by ID","description":"Return an [Information Barriers](https://support.zoom.us/hc/en-us/articles/360040913711-Information-Barriers) policy by its ID. \n\n **Prerequisites:** \n* [Contact Zoom Support](https://support.zoom.us/hc/en-us/articles/201362003) to enable Information Barriers for your account.\n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `information_barriers:read:master`\n\n**[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `information_barrier:read:policy:master`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`","operationId":"InformationBarriersGet","parameters":[{"name":"policyId","in":"path","description":"The Information Barrier policy's ID.","required":true,"schema":{"type":"string","example":"ErxAmMT7QPOH19Kf9Z55ty"}},{"name":"accountId","in":"path","description":"Unique identifier of the account.","required":true,"schema":{"type":"string","example":"TQTvjT52Tmi_wrhASNNOEw"}}],"responses":{"200":{"description":"**HTTP Status Code:** `200`   \n  Information Barriers returned.","content":{"application/json":{"schema":{"required":["assigned_group_id","id","policy_name","settings","status","to_group_id","type"],"type":"object","properties":{"assigned_group_id":{"type":"string","description":"The assigner group's (Group 1) ID.","example":"SsxAmMT7QPOH19Kf9ZHz6g"},"id":{"type":"string","description":"The Information Barriers policy's ID.","example":"ErxAmMT7QPOH19Kf9Z55ty"},"policy_name":{"type":"string","description":"The Information Barriers policy's name.","example":"test"},"settings":{"required":["complete_phone_calls","file_transfer","im","in_meeting_chat","meeting","message_via_sms","recording","screen_share"],"type":"object","properties":{"complete_phone_calls":{"type":"boolean","description":"If true, users between groups **cannot** call each other.","example":false},"file_transfer":{"type":"boolean","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`.","example":false},"im":{"type":"boolean","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`.","example":false},"in_meeting_chat":{"type":"boolean","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`.","example":false},"meeting":{"type":"boolean","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.","example":false},"message_via_sms":{"type":"boolean","description":"If true, users between groups **cannot** user SMS.","example":false},"recording":{"type":"boolean","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.","example":false},"screen_share":{"type":"boolean","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`.","example":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."},"status":{"type":"integer","description":"The Information Barriers policy's status. \n* `0` &mdash; Disabled. \n* `1` &mdash; Enabled.","example":1,"enum":[0,1]},"to_group_id":{"type":"string","description":"The assignee group's (Group 2) ID.","example":"mjLMOSAERBaakF8kSDWB7g"},"type":{"type":"integer","description":"The Information Barriers policy's type of `settings` restrictions. \n* `0` &mdash; 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` &mdash; 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` &mdash; No blocks exist, but only users in Group 1 can chat with users in Group 2. \n* `3` &mdash; No blocks exist and users in Group 1 and Group 2 can chat with each other. \n\nThis field only supports `0`.","example":1,"default":0,"enum":[0,1,2,3]}}}}}},"429":{"description":"**HTTP Status Code:** `429` <br>\n Too Many Requests. For more information, see [rate limits](https://developers.zoom.us/docs/api/rest/rate-limits/). \n\n "}},"security":[{"openapi_authorization":[]}],"x-extensions":{"x-permissions":[],"x-macro-scopes":["information_barriers:read:master"],"x-granular-scopes":["information_barrier:read:policy:master"]}},"delete":{"tags":["Information Barriers"],"summary":"Remove an Information Barrier policy","description":"Remove an [Information Barrier](https://support.zoom.us/hc/en-us/articles/360040913711-Information-Barriers) policy.\n\n **Prerequisites:** \n* [Contact Zoom Support](https://support.zoom.us/hc/en-us/articles/201362003) to enable Information Barriers for your account.\n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `information_barriers:write:master`\n\n**[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `information_barrier:delete:policy:master`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`","operationId":"InformationBarriersDelete","parameters":[{"name":"policyId","in":"path","description":"The Information Barriers policy's ID.","required":true,"schema":{"type":"string","example":"ErxAmMT7QPOH19Kf9Z55ty"}},{"name":"accountId","in":"path","description":"Unique identifier of the account.","required":true,"schema":{"type":"string","example":"TQTvjT52Tmi_wrhASNNOEw"}}],"responses":{"204":{"description":"**HTTP Status Code:** `204`   \n  Information Barriers deleted."},"400":{"description":"**HTTP Status Code:** `400` <br>\n Bad Request  \n\n **Error Code:** `7001` <br>\n Group policy not found: {0}. <br>\n"},"429":{"description":"**HTTP Status Code:** `429` <br>\n Too Many Requests. For more information, see [rate limits](https://developers.zoom.us/docs/api/rest/rate-limits/). \n\n "}},"security":[{"openapi_authorization":[]}],"x-extensions":{"x-permissions":[],"x-macro-scopes":["information_barriers:write:master"],"x-granular-scopes":["information_barrier:delete:policy:master"]}},"patch":{"tags":["Information Barriers"],"summary":"Update an Information Barriers policy","description":"Update an [Information Barriers](https://support.zoom.us/hc/en-us/articles/360040913711-Information-Barriers) policy.\n\n **Prerequisites:** \n* [Contact Zoom Support](https://support.zoom.us/hc/en-us/articles/201362003) to enable Information Barriers for your account.\n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `information_barriers:write:master`\n\n**[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `information_barrier:update:policy:master`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`","operationId":"InformationBarriersUpdate","parameters":[{"name":"policyId","in":"path","description":"The Information Barriers policy's ID.","required":true,"schema":{"type":"string","example":"ErxAmMT7QPOH19Kf9Z55ty"}},{"name":"accountId","in":"path","description":"Unique identifier of the account.","required":true,"schema":{"type":"string","example":"TQTvjT52Tmi_wrhASNNOEw"}}],"requestBody":{"description":"Information about the updated Information Barriers policy.","content":{"application/json":{"schema":{"required":["assigned_group_id","id","policy_name","settings","status","to_group_id","type"],"type":"object","properties":{"assigned_group_id":{"type":"string","description":"The assigner group's (Group 1) ID.","example":"SsxAmMT7QPOH19Kf9ZHz6g"},"id":{"type":"string","description":"The Information Barriers policy's ID.","example":"ErxAmMT7QPOH19Kf9Z55ty"},"policy_name":{"type":"string","description":"The Information Barriers policy's name.","example":"test"},"settings":{"required":["complete_phone_calls","file_transfer","im","in_meeting_chat","meeting","message_via_sms","recording","screen_share"],"type":"object","properties":{"complete_phone_calls":{"type":"boolean","description":"If true, users between groups **cannot** call each other.","example":false},"file_transfer":{"type":"boolean","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`.","example":false},"im":{"type":"boolean","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`.","example":false},"in_meeting_chat":{"type":"boolean","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`.","example":false},"meeting":{"type":"boolean","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.","example":false},"message_via_sms":{"type":"boolean","description":"If true, users between groups **cannot** user SMS.","example":false},"recording":{"type":"boolean","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.","example":false},"screen_share":{"type":"boolean","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`.","example":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."},"status":{"type":"integer","description":"The Information Barriers policy's status. \n* `0` &mdash; Disabled. \n* `1` &mdash; Enabled.","example":1,"enum":[0,1]},"to_group_id":{"type":"string","description":"The assignee group's (Group 2) ID.","example":"mjLMOSAERBaakF8kSDWB7g"},"type":{"type":"integer","description":"The Information Barriers policy's type of `settings` restrictions. \n* `0` &mdash; 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` &mdash; 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` &mdash; No blocks exist, but only users in Group 1 can chat with users in Group 2. \n* `3` &mdash; No blocks exist and users in Group 1 and Group 2 can chat with each other. \n\nThis field only supports `0`.","example":1,"default":0,"enum":[0,1,2,3]}}}}}},"responses":{"200":{"description":"**HTTP Status Code:** `200`   \n  Information Barriers updated."},"400":{"description":"**HTTP Status Code:** `400` <br>\n Bad Request  \n\n **Error Code:** `7001` <br>\n Group policy not found: {0}. <br>\n"},"429":{"description":"**HTTP Status Code:** `429` <br>\n Too Many Requests. For more information, see [rate limits](https://developers.zoom.us/docs/api/rest/rate-limits/). \n\n "}},"security":[{"openapi_authorization":[]}],"x-extensions":{"x-permissions":[],"x-macro-scopes":["information_barriers:write:master"],"x-granular-scopes":["information_barrier:update:policy:master"]}}},"/accounts/{accountId}/roles":{"get":{"tags":["Roles"],"summary":"List roles","description":"List [roles](https://support.zoom.us/hc/en-us/articles/115001078646-Role-Based-Access-Control) on your account\n\n**Prerequisites** :\n*  Pro or higher plan. \n*  For setting the initial role, you must be the Account Owner. \n*  For subsequent role management, you must be the Account Owner or user with role management permissions.\n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `role:master`,`role:read:master`,`role:write:master`\n\n**[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `role:read:list_roles:master`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Medium`","operationId":"roles","parameters":[{"name":"type","in":"query","description":"Specify a value to get the response for the corresponding role type.  \n    \n `common` - common roles of Zoom.  \n `iq` - roles of Zoom IQ Sales","required":false,"schema":{"type":"string","example":"iq","default":"common","enum":["common","iq"]}},{"name":"accountId","in":"path","description":"Unique identifier of the account.","required":true,"schema":{"type":"string","example":"TQTvjT52Tmi_wrhASNNOEw"}}],"responses":{"200":{"description":"**HTTP Status Code:** `200`  \n \nList of roles returned.","content":{"application/json":{"schema":{"title":"Role List","type":"object","description":"List of Roles","allOf":[{"type":"object","properties":{"roles":{"type":"array","description":"List of Roles objects","items":{"allOf":[{"type":"object","properties":{"description":{"type":"string","description":"Role Description","example":"my role"},"id":{"type":"string","description":"Role Id","example":"RqBLcd1jLS9a7RBkbGtqn2A"},"name":{"type":"string","description":"Role Name","example":"My Role"},"type":{"type":"string","description":"Role Type","example":"iq"},"total_members":{"type":"integer","description":"Total members in this role","example":200}}}]}},"total_records":{"type":"integer","description":"The number of all records available across pages","example":200}}}]}}}},"400":{"description":"**HTTP Status Code:** `400` <br>\n Bad Request\n\n**Error Code:** `4700` <br>\nInvalid access token, does not contain role:read:admin scope.\n\n"},"429":{"description":"**HTTP Status Code:** `429` <br>\n Too Many Requests. For more information, see [rate limits](https://developers.zoom.us/docs/api/rest/rate-limits/). \n\n "}},"security":[{"openapi_authorization":[]}],"x-extensions":{"x-macro-scopes":["role:master","role:read:master","role:write:master"],"x-granular-scopes":["role:read:list_roles:master"]}},"post":{"tags":["Roles"],"summary":"Create a role","description":"Each Zoom user automatically has a role which can either be owner, administrator, or member. \n\n**Pre-requisites**  \n \n* Pro or higher plan.\n* To set the initial role, you must be the account owner.  \n \n* For subsequent role management, you must be either the account owner or user with role management permissions.  \n \n\n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `role:master`\n\n**[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `role:write:role:master`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`","operationId":"createRole","parameters":[{"name":"accountId","in":"path","description":"Unique identifier of the account.","required":true,"schema":{"type":"string","example":"TQTvjT52Tmi_wrhASNNOEw"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"description":{"type":"string","description":"The role's description.","example":"My role"},"name":{"type":"string","description":"The role's name.","example":"My role"},"type":{"type":"string","description":"Role type","example":"iq"},"privileges":{"type":"array","description":"Privileges assigned to the role. Can be one or more of [these permissions](https://developers.zoom.us/docs/api/rest/other-references/privileges/).","items":{"type":"string","example":"User:Read"}}}}}}},"responses":{"200":{"description":"**Status Code:** `200`  \n \nYou have created a role.\n\n{\n“id”: “ReP0khZqgQ3amxOFo7tbYAw”,\n“name”: “ole001”,\n“description”: “My role”,\n“type”: “common”,\n“total_members”: 0,\n“privileges”: [\n“User:Read”\n]\n}"},"400":{"description":"**HTTP Status Code:** `400` <br>\n Bad Request  \n\n **Error Code:** `1224` <br>\n Role name {roleName} has already been used. <br>\n"},"429":{"description":"**HTTP Status Code:** `429` <br>\n Too Many Requests. For more information, see [rate limits](https://developers.zoom.us/docs/api/rest/rate-limits/). \n\n "}},"security":[{"openapi_authorization":[]}],"x-extensions":{"x-permissions":[],"x-macro-scopes":["role:master"],"x-granular-scopes":["role:write:role:master"]}}},"/accounts/{accountId}/roles/{roleId}":{"get":{"tags":["Roles"],"summary":"Get role information","description":"Each Zoom user automatically has a role which can either be owner, administrator, or member. Account owners and users with edit privileges for role management can add customized roles with a list of privileges.\n\nUse this API to get information including specific privileges assigned to a [role](https://support.zoom.us/hc/en-us/articles/115001078646-Role-Based-Access-Control).  \n \n**Pre-requisites**  \n \n* A Pro or higher plan.  \n \n* For role management and updates, you must be either the account owner or a user with role management permissions.\n\n\n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `role:master`\n\n**[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `role:read:role:master`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`","operationId":"getRoleInformation","parameters":[{"name":"roleId","in":"path","description":"The role ID. ","required":true,"schema":{"type":"string","example":"2"}},{"name":"accountId","in":"path","description":"Unique identifier of the account.","required":true,"schema":{"type":"string","example":"TQTvjT52Tmi_wrhASNNOEw"}}],"responses":{"200":{"description":"**Status Code:** `200`  \n \nInformation about a specific role returned.\n\n**Error Code:** `200`  \n \nYou do not have the permission to retrieve role information.\n","content":{"application/json":{"schema":{"type":"object","properties":{"description":{"type":"string","description":"The role's description.","example":"My role"},"id":{"type":"string","description":"The role's  Id.","example":"2"},"name":{"type":"string","description":"The role's name.","example":"My role"},"type":{"type":"string","description":"The role's type.","example":"iq"},"privileges":{"type":"array","description":"Privileges assigned to the role. Can be one or more of [these permissions](https://developers.zoom.us/docs/api/rest/other-references/privileges/).\n","items":{"type":"string","example":"User:Read"}},"sub_account_privileges":{"type":"object","properties":{"second_level":{"type":"integer","description":"Indicates how the account can manage sub-accounts. \n \n`1` - Manage the sub-account as an owner of the account.  \n \n`2` - Manage the sub-account with the same privileges as the current account.  \n \n`3` - Manage the sub-account with specified privileges.","example":1}},"description":"This field will only be displayed to accounts enrolled in a partner plan and following the master accounts and sub-accounts structure."},"total_members":{"type":"integer","description":"Total members assigned to that role.","example":20},"privilege_scopes":{"maxItems":50,"type":"array","description":"Role scope info, which include permission id, group id list. This field will only return permission which checked specific scope.","items":{"type":"object","properties":{"permission_id":{"type":"string","description":"Privileges assigned to the role. Can be one or more of [these permissions](https://developers.zoom.us/docs/api/rest/other-references/privileges/).","example":"User:Read"},"group_ids":{"maxItems":100,"type":"array","description":"User group id list that you checked for specific permission(s) on the role setting page.","items":{"type":"string"}}}}}}}}}},"400":{"description":"**HTTP Status Code:** `400` <br>\n Bad Request  \n\n **Error Code:** `1034` <br>\n Provided `role_id` does not exist. <br>\n"},"429":{"description":"**HTTP Status Code:** `429` <br>\n Too Many Requests. For more information, see [rate limits](https://developers.zoom.us/docs/api/rest/rate-limits/). \n\n "}},"security":[{"openapi_authorization":[]}],"x-extensions":{"x-permissions":[],"x-macro-scopes":["role:master"],"x-granular-scopes":["role:read:role:master"]}},"delete":{"tags":["Roles"],"summary":"Delete a role","description":"Each Zoom user automatically has a role which can either be owner, administrator, or a member. Account Owners and users with edit privileges for Role management can add customized roles with a list.\n\nUse this API to delete a role.  \n \n**Pre-requisite:**  \n \n* A Pro or higher plan.  \n \n* For role management and updates, you must be the Account Owner or user with role management permissions.\n\n\n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `role:master`,`role:write:master`\n\n**[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `role:delete:role:master`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Light`","operationId":"deleteRole","parameters":[{"name":"roleId","in":"path","required":true,"schema":{"type":"string","example":"2"}},{"name":"accountId","in":"path","description":"Unique identifier of the account.","required":true,"schema":{"type":"string","example":"TQTvjT52Tmi_wrhASNNOEw"}}],"responses":{"200":{"description":"**Error Code:** `200`  \n \nRole not found."},"204":{"description":"**Status Code:** `204`  \n \nRole deleted."},"400":{"description":"**HTTP Status Code:** `400` <br>\n Bad Request\n\n**Error Code:** `1034` <br>\nProvided `role_id` does not exist.\n\n"},"429":{"description":"**HTTP Status Code:** `429` <br>\n Too Many Requests. For more information, see [rate limits](https://developers.zoom.us/docs/api/rest/rate-limits/). \n\n "}},"security":[{"openapi_authorization":[]}],"x-extensions":{"x-macro-scopes":["role:master","role:write:master"],"x-granular-scopes":["role:delete:role:master"]}},"patch":{"tags":["Roles"],"summary":"Update role information","description":"Each Zoom user automatically has a [role](https://support.zoom.us/hc/en-us/articles/115001078646-Role-Based-Access-Control) which can either be owner, administrator, or a member. Account Owners and users with edit privileges for Role management can add customized roles with a list.\n\nUse this API to change the privileges, name and description of a specific role.  \n \n**Pre-requisite:**  \n \n* A Pro or higher plan.  \n \n* For role management and updates, you must be the Account Owner or user with role management permissions.  \n \n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `role:master`,`role:write:master`\n\n**[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `role:update:role:master`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Light`","operationId":"updateRole","parameters":[{"name":"roleId","in":"path","required":true,"schema":{"type":"string","example":"2"}},{"name":"accountId","in":"path","description":"Unique identifier of the account.","required":true,"schema":{"type":"string","example":"TQTvjT52Tmi_wrhASNNOEw"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"description":{"type":"string","description":"The role's description.","example":"My role"},"name":{"type":"string","description":"The role's name.","example":"My role"},"privileges":{"type":"array","description":"The role's assigned privileges. Can be one or a combination of [these privileges](https://developers.zoom.us/docs/api/rest/other-references/privileges/).\n","items":{"type":"string","example":"User:Read"}},"sub_account_privileges":{"type":"object","properties":{"second_level":{"type":"integer","description":"Indicates how the account can manage sub-accounts.\n \n`1` - Manage the sub account as an owner of the account.\n\n`2` - Manage the sub-account with the same privileges as the current account.  \n \n`3` - Manage the sub-account with specified privileges.","example":1}},"description":"This field will only be displayed to accounts that are enrolled in the partner plan and follow master accounts and sub accounts structure."}}}}}},"responses":{"200":{"description":"**Error Code:** `200`  \n \nThe account must be a paid account to update the role.","content":{"application/json":{"schema":{"type":"object","properties":{}}}}},"400":{"description":"**HTTP Status Code:** `400` <br>\n Bad Request \n\n **Error Code:** `1224` <br>\n Role name {roleName} has already been used.<br><br> <br>\n**Error Code:** `1034` <br>\n Provided `role_id` does not exist. <br>\n"},"429":{"description":"**HTTP Status Code:** `429` <br>\n Too Many Requests. For more information, see [rate limits](https://developers.zoom.us/docs/api/rest/rate-limits/). \n\n "}},"security":[{"openapi_authorization":[]}],"x-extensions":{"x-macro-scopes":["role:master","role:write:master"],"x-granular-scopes":["role:update:role:master"]}}},"/accounts/{accountId}/roles/{roleId}/members":{"get":{"tags":["Roles"],"summary":"List members in a role","description":"User [roles](https://support.zoom.us/hc/en-us/articles/115001078646-Role-Based-Access-Control) can have a set of permissions that allows access only to the pages a user needs to view or edit. Use this API to list all the members that are assigned a specific role.\n\n**Prerequisites:**  \n \n* A Pro or a higher plan.\n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `role:master`\n\n**[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `role:read:list_members:master`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`","operationId":"roleMembers","parameters":[{"name":"roleId","in":"path","description":"The role ID","required":true,"schema":{"type":"string","example":"2"}},{"name":"page_count","in":"query","description":"The number of pages returned for this request.","required":false,"schema":{"type":"string","example":"2"}},{"name":"page_number","in":"query","description":"**Deprecated.** We will no longer support this field in a future release. Instead, use the `next_page_token` for pagination.","required":false,"schema":{"type":"integer","example":1,"default":1}},{"name":"next_page_token","in":"query","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.","required":false,"schema":{"type":"string","example":"IAfJX3jsOLW7w3dokmFl84zOa0MAVGyMEB2"}},{"name":"page_size","in":"query","description":"The number of records returned within a single API call.","required":false,"schema":{"maximum":300,"type":"integer","example":30,"default":30}},{"name":"accountId","in":"path","description":"Unique identifier of the account.","required":true,"schema":{"type":"string","example":"TQTvjT52Tmi_wrhASNNOEw"}}],"responses":{"200":{"description":"**HTTP Status Code:** `200`  \n \nSuccess","content":{"application/json":{"schema":{"title":"Role Members List","type":"object","properties":{"members":{"maxItems":300,"type":"array","description":"List of a Role Members","items":{"type":"object","allOf":[{"type":"object","properties":{"department":{"type":"string","description":"Member Department","example":"Developers"},"email":{"type":"string","description":"Member Email","example":"jchil.test@example.com"},"first_name":{"type":"string","description":"Member First Name","example":"Jill"},"id":{"type":"string","description":"Member ID","example":"49D7a0xPQvGQ2DCMZgSe7w"},"last_name":{"type":"string","description":"Member Last Name","example":"Chill"},"type":{"type":"integer","description":"Member Type","example":2}}}]}},"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":"TUNTL8kGBvdBSJiX1PaNAVxYbjV7ouJlKS2"},"page_count":{"type":"integer","description":"The number of pages returned for the request made.","example":3},"page_number":{"type":"integer","description":"The page number of the current results.","example":1,"default":1},"page_size":{"maximum":300,"type":"integer","description":"The number of records returned within a single API call.","example":30,"default":30},"total_records":{"type":"integer","description":"The total number of all the records available across pages.","example":22}},"description":"List of a Role Members"}}}},"400":{"description":"**HTTP Status Code:** `400` <br>\n Bad Request  \n\n **Error Code:** `1034` <br>\n Provided `role_id` does not exist. <br>\n"},"404":{"description":"**HTTP Status Code:** `404` <br>\n Not Found  \n\n "},"429":{"description":"**HTTP Status Code:** `429` <br>\n Too Many Requests. For more information, see [rate limits](https://developers.zoom.us/docs/api/rest/rate-limits/). \n\n "}},"security":[{"openapi_authorization":[]}],"x-extensions":{"x-permissions":[],"x-macro-scopes":["role:master"],"x-granular-scopes":["role:read:list_members:master"]}},"post":{"tags":["Roles"],"summary":"Assign a role","description":"User [roles](https://support.zoom.us/hc/en-us/articles/115001078646-Role-Based-Access-Control) can have a set of permissions that allows access only to the pages a user needs to view or edit. Use this API to [assign a role](https://support.zoom.us/hc/en-us/articles/115001078646-Role-Based-Access-Control#h_748b6fd8-5057-4cf4-bbfd-787909c09db0) to members.\n\n**Prerequisites:**  \n \n* A Pro or a higher plan.\n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `role:master`,`role:write:master`\n\n**[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `role:write:member:master`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Medium`","operationId":"AddRoleMembers","parameters":[{"name":"roleId","in":"path","description":"The role ID","required":true,"schema":{"type":"string","example":"2"}},{"name":"accountId","in":"path","description":"Unique identifier of the account.","required":true,"schema":{"type":"string","example":"TQTvjT52Tmi_wrhASNNOEw"}}],"requestBody":{"description":"Role members","content":{"application/json":{"schema":{"type":"object","properties":{"members":{"maxItems":30,"uniqueItems":false,"type":"array","description":"Array of userId/user email of users to whom you would like to assign this role. Up to 30 users can be assigned a role at once.","items":{"type":"object","properties":{"email":{"type":"string","description":"Email address of the user to whom you would like to assign the role. Provide either the userId in the ID field or the email address in the email field. If both fields are provided, only userId is used.","format":"email","example":"user@example.com"},"id":{"type":"string","description":"User ID of the user to whom you would like to assign the role. ","example":"Cs97wug2RTm5TNvuvk4yRw"}}}}}}}}},"responses":{"201":{"description":"**HTTP Status Code:** `201`  \n Members Added","content":{"application/json":{"schema":{"type":"object","properties":{"add_at":{"type":"string","description":"Date and time at which the members are assigned to the role.","format":"date-time","example":"2019-06-01T07:58:03Z"},"ids":{"type":"string","description":"User ID","example":"2"}}}}}},"400":{"description":"**HTTP Status Code:** `400` <br>\n Bad Request\n\n**Error Code:** `1034` <br>\nProvided `role_id` does not exist.<br><br>\n\n**Error Code:** `300` <br>\nRoleId required.<br>\nCan't delete or add members for Normal/Owner roles.<br><br>\n\n"},"429":{"description":"**HTTP Status Code:** `429` <br>\n Too Many Requests. For more information, see [rate limits](https://developers.zoom.us/docs/api/rest/rate-limits/). \n\n "}},"security":[{"openapi_authorization":[]}],"x-extensions":{"x-permissions":[],"x-macro-scopes":["role:master","role:write:master"],"x-granular-scopes":["role:write:member:master"]}}},"/accounts/{accountId}/roles/{roleId}/members/{memberId}":{"delete":{"tags":["Roles"],"summary":"Unassign a role","description":"User [roles](https://support.zoom.us/hc/en-us/articles/115001078646-Role-Based-Access-Control) can have a set of permissions that allows access only to the pages a user needs to view or edit. Use this API to unassign a user's role.\n\n**Prerequisites:**  \n \n* A Pro or a higher plan.\n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `role:master`,`role:write:master`\n\n**[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `role:delete:member:master`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Light`","operationId":"roleMemberDelete","parameters":[{"name":"roleId","in":"path","description":"The role ID","required":true,"schema":{"type":"string","example":"2"}},{"name":"memberId","in":"path","description":"Member's ID","required":true,"schema":{"type":"string","example":"Cs97wug2RTm5TNvuvk4yRw"}},{"name":"accountId","in":"path","description":"Unique identifier of the account.","required":true,"schema":{"type":"string","example":"TQTvjT52Tmi_wrhASNNOEw"}}],"responses":{"204":{"description":"**HTTP Status Code:** `204`  \n \nRole withdrawn from user."},"400":{"description":"**HTTP Status Code:** `400` <br>\n Bad Request\n\n**Error Code:** `1034` <br>\nProvided `role_id` does not exist.\n\n"},"404":{"description":"**HTTP Status Code:** `404` <br>\n Not Found\n\n"},"429":{"description":"**HTTP Status Code:** `429` <br>\n Too Many Requests. For more information, see [rate limits](https://developers.zoom.us/docs/api/rest/rate-limits/). \n\n "}},"security":[{"openapi_authorization":[]}],"x-extensions":{"x-macro-scopes":["role:master","role:write:master"],"x-granular-scopes":["role:delete:member:master"]}}},"/accounts/{accountId}/surveys":{"get":{"tags":["Survey Management"],"summary":"Get surveys","description":"Queries all surveys in the current account.\n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `survey:read:master`\n\n**[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `survey_management:read:list_surveys:master`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`","operationId":"getAccountSurveys","parameters":[{"name":"page_size","in":"query","description":"The number of records returned within a single API call.","required":false,"schema":{"type":"string","example":"30"}},{"name":"next_page_token","in":"query","description":"Use the next page token to paginate through a large set of results. A next page token returns whenever the set of available results exceeds the current page size. This token's expiration period is 15 minutes.","required":false,"schema":{"type":"string","example":"IAfJX3jsOLW7w3dokmFl84zOa0MAVGyMEB"}},{"name":"accountId","in":"path","description":"Unique identifier of the account.","required":true,"schema":{"type":"string","example":"TQTvjT52Tmi_wrhASNNOEw"}}],"responses":{"200":{"description":"**HTTP Status Code:** `200`   The surveys of current account returned.   ","content":{"application/json":{"schema":{"type":"object","properties":{"surveys":{"type":"array","description":"The survey list of the current account.","items":{"type":"object","properties":{"survey_id":{"type":"string","description":"The UUID of survey.","example":"4444AAAiAAAAAiAiAiiAii=="},"survey_name":{"type":"string","description":"The name of survey.","example":"The survey of meeting"},"survey_type":{"type":"string","description":"The type of survey.\n- `basic_poll` -- Basic Poll (requires the `Survey:Read` permission).\n- `advanced_poll` -- Advanced Poll (requires the `Survey:Read` permission).\n- `quiz` -- Quiz (requires the `Survey:Read` permission).\n- `survey` -- Survey (requires the `Survey:Read` permission).\n- `consumer_engagement_survey` -- Consumer Engagement Survey (requires the `EngagementSurvey:Read` permission).","example":"survey","enum":["basic_poll","advanced_poll","quiz","survey","consumer_engagement_survey"]}}}},"next_page_token":{"type":"string","description":"Use the next page token to paginates through a large set of results. A next page token returns whenever the set of available results exceeds the current page size. This token's expiration period is 15 minutes.","example":"IAfJX3jsOLW7w3dokmFl84zOa0MAVGyMEB2"}}}}}},"400":{"description":"**HTTP Status Code:** `400` <br>\n Bad Request  \n\n **Error Code:** `300` <br>\n The next page token is invalid or expired. <br>\n**Error Code:** `200` <br>\n No permission. <br>\n"},"403":{"description":"**HTTP Status Code:** `403` <br>\n Forbidden  \n\n **Error Code:** `6720` <br>\n You don't have the permissions to access survey. <br>\n"},"404":{"description":"**HTTP Status Code:** `404` <br>\n Not Found  \n\n "},"429":{"description":"**HTTP Status Code:** `429` <br>\n Too Many Requests. For more information, see [rate limits](https://developers.zoom.us/docs/api/rest/rate-limits/). \n\n "}},"security":[{"openapi_authorization":[]}],"x-extensions":{"x-permissions":["Survey:Read","EngagementSurvey:Read"],"x-macro-scopes":["survey:read:master"],"x-granular-scopes":["survey_management:read:list_surveys:master"]}}},"/accounts/{accountId}/surveys/channels/{channelId}/instances":{"get":{"tags":["Survey Management"],"summary":"List channel survey instances","description":"Query the channel survey instances based on `channelId`.\n\nThe same survey can be used multiple times, each use constituting a separate instance.\nThis API endpoint returns the historical information of each survey instance for each channel.\n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `survey:master`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`","operationId":"Getsurveyinstances","parameters":[{"name":"channelId","in":"path","description":"Channel ID: the channel's unique identifier.","required":true,"schema":{"type":"string","example":"2afb6f2028ba496bb64b6bf553a9fd55"}},{"name":"page_size","in":"query","description":"The number of records returned within a single API call.","required":false,"schema":{"maximum":20,"type":"number","example":10,"default":10}},{"name":"next_page_token","in":"query","description":"The next page token paginates through a large set of results. A next page token returns whenever the set of available results exceeds the current page size. This token's expiration period is 15 minutes.","required":false,"schema":{"type":"string","example":"eyJsYXN0X2Jsb2NrX2lkIjoiOGQwYWQ4ZTEzMGUxNGQ0NGFkYWU0Zjc4MzAzZmM2Y2MifQ=="}},{"name":"from","in":"query","description":"Start of launch time range (ISO 8601 format, e.g., 2025-09-22T10:00:00Z).","required":false,"schema":{"type":"string","example":"2025-08-22T17:30:00Z"}},{"name":"to","in":"query","description":"End of launch time range (ISO 8601 format, e.g., 2025-09-22T10:00:00Z).","required":false,"schema":{"type":"string","example":"2025-09-22T17:30:00Z"}},{"name":"survey_id","in":"query","description":"The UUID of survey.","required":false,"schema":{"type":"string","example":"WN3chY9bTjOQkbqnSIIhyG"}},{"name":"accountId","in":"path","description":"Unique identifier of the account.","required":true,"schema":{"type":"string","example":"TQTvjT52Tmi_wrhASNNOEw"}}],"responses":{"200":{"description":"HTTP Status Code: 200 Survey instances returned.","content":{"application/json":{"schema":{"type":"object","properties":{"survey_instances":{"maxItems":20,"type":"array","description":"The instances used the survey.","items":{"type":"object","properties":{"instance_name":{"type":"string","description":"The name of an instance.","example":"It's Steve's meeting "},"instance_id":{"type":"string","description":"The UUID of an instance.For meeting surveys, this field is also meeting_uuid.","example":"iOTQZPmhTUq5a232ETb9eg=="},"has_response":{"type":"boolean","description":"Attendee has a response or not.","example":true},"survey_id":{"type":"string","description":"The UUID of survey.","example":"WN3chY9bTjOQkbqnSIIhyg"},"survey_name":{"type":"string","description":"The name of survey.","example":"Survey of this meeting"},"survey_type":{"type":"string","description":"The type of survey.\n- `basic_poll` -- Basic Poll (requires the `Survey:Read` permission).\n- `advanced_poll` -- Advanced Poll (requires the `Survey:Read` permission).\n- `quiz` -- Quiz (requires the `Survey:Read` permission).\n- `survey` -- Survey (requires the `Survey:Read` permission).\n- `consumer_engagement_survey` -- Consumer Engagement Survey (requires the `EngagementSurvey:Read` permission).","example":"survey","enum":["basic_poll","advanced_poll","quiz","survey","consumer_engagement_survey"]},"anonymous":{"type":"boolean","description":"The survey instance is anonymous or non-anonymous.","example":true},"survey_questions":{"maxItems":100,"type":"array","description":"The survey's question list.","items":{"type":"object","properties":{"question_name":{"type":"string","description":"The question of survey.","example":"How are you?"},"question_id":{"type":"string","description":"The UUID of question.","example":"798fGJEWrA"},"question_order":{"type":"integer","description":"The order of question.","example":1},"question_type":{"type":"string","description":"The type of question.\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.","example":"single","enum":["single","multiple","matching","rank_order","short_answer","long_answer","fill_in_the_blank","rating_scale"]},"required":{"type":"boolean","description":"The question is required to answer or not.","example":true},"sub_questions":{"maxItems":50,"type":"array","description":"Only **Matching/Rank order** question has sub questions.","items":{"type":"object","properties":{"sub_question_name":{"type":"string","description":"The sub question in a question.","example":"Good"},"sub_question_id":{"type":"string","description":"The UUID of sub question.","example":"Sx3chY9bYhsdkbqnqwesdf"},"sub_question_order":{"type":"integer","description":"The order of sub question.","example":1}}}},"options":{"maxItems":50,"type":"array","description":"The options of a question. For example, there are four options in a **Single choice** question, and option is used to represent each of the options.","items":{"type":"object","properties":{"option_id":{"type":"string","description":"The UUID of option.","example":"HGsx45GsefchY9bYhsdkbq"},"option_value":{"type":"string","description":"The value of option.","example":"Extremely Likely"},"option_label":{"type":"string","description":"Only **Rating scale** question has this field to describe the score.","example":"5"},"option_order":{"type":"integer","description":"The order of option.","example":1}}}}}}}}}},"next_page_token":{"type":"string","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.","example":"eyJsYXN0X2Jsb2NrX2lkIjoiOGQwYWQ4ZTEzMGUxNGQ0NGFkYWU0Zjc4MzAzZmM2Y2MifQ=="}}}}}},"400":{"description":"**HTTP Status Code:** `400` <br>\n Bad Request  \n\n **Error Code:** `6701` <br>\n Invalid parameter survey id <br>\n**Error Code:** `300` <br>\n The next page token is invalid or expired. <br>\n"},"403":{"description":"**HTTP Status Code:** `403` <br>\n Forbidden  \n\n **Error Code:** `6720` <br>\n You don't have the permissions to access survey. <br>\n"},"404":{"description":"**HTTP Status Code:** `404` <br>\n Not Found  \n\n **Error Code:** `4130` <br>\n Channel does not exist: $channelId. <br>\n"},"429":{"description":"**HTTP Status Code:** `429` <br>\n Too Many Requests. For more information, see [rate limits](https://developers.zoom.us/docs/api/rate-limits/). \n\n "}},"security":[{"openapi_authorization":[]}],"x-extensions":{"x-permissions":["Survey:Read"],"x-macro-scopes":["survey:master"]}}},"/accounts/{accountId}/surveys/{surveyId}":{"get":{"tags":["Survey Management"],"summary":"Get survey info","description":"Queries the latest version of survey information from `surveyId`.\n\n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `survey:read:master`\n\n**[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `survey_management:read:survey:master`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`","operationId":"getSurveyInfo","parameters":[{"name":"surveyId","in":"path","description":"The UUID of survey.","required":true,"schema":{"type":"string","example":"WN3chY9bTjOQkbqnSIIhyG"}},{"name":"accountId","in":"path","description":"Unique identifier of the account.","required":true,"schema":{"type":"string","example":"TQTvjT52Tmi_wrhASNNOEw"}}],"responses":{"200":{"description":"**HTTP Status Code:** `200`  Survey info returned.","content":{"application/json":{"schema":{"type":"object","properties":{"survey_id":{"type":"string","description":"The UUID of survey.","example":"WN3chY9bTjOQkbqnSIIhyg"},"survey_name":{"type":"string","description":"The name of survey.","example":"Survey of this meeting"},"survey_type":{"type":"string","description":"The type of survey.\n- `basic_poll` -- Basic Poll (requires the `Survey:Read` permission).\n- `advanced_poll` -- Advanced Poll (requires the `Survey:Read` permission).\n- `quiz` -- Quiz (requires the `Survey:Read` permission).\n- `survey` -- Survey (requires the `Survey:Read` permission).\n- `consumer_engagement_survey` -- Consumer Engagement Survey (requires the `EngagementSurvey:Read` permission).","example":"survey","enum":["basic_poll","advanced_poll","quiz","survey","consumer_engagement_survey"]},"published":{"type":"boolean","description":"The survey is published or closed.","example":true},"anonymous":{"type":"boolean","description":"The survey is anonymous or non-anonymous.","example":false},"survey_questions":{"type":"array","description":"The survey's question list.","items":{"type":"object","properties":{"question_name":{"type":"string","description":"The question of survey.","example":"How are you?"},"question_id":{"type":"string","description":"The UUID of question.","example":"798fGJEWrA"},"question_order":{"type":"integer","description":"The order of question.","example":1},"question_type":{"type":"string","description":"The type of question.\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.","example":"single","enum":["single","multiple","matching","rank_order","short_answer","long_answer","fill_in_the_blank","rating_scale"]},"required":{"type":"boolean","description":"The required question to answer or not.","example":true},"sub_questions":{"type":"array","description":"Only **Matching/Rank order** question has sub questions.","items":{"type":"object","properties":{"sub_question_name":{"type":"string","description":"The sub question in a question.","example":"Good"},"sub_question_id":{"type":"string","description":"The UUID of sub question.","example":"Sx3chY9bYhsdkbqnqwesdf"},"sub_question_order":{"type":"integer","description":"The order of sub question.","example":1}}}},"options":{"type":"array","description":"The options of a question.\nFor example, there are four options in a **Single choice** question, and option is used to represent each of the options.\n\n","items":{"type":"object","properties":{"option_id":{"type":"string","description":"The UUID of option.","example":"HGsx45GsefchY9bYhsdkbq"},"option_value":{"type":"string","description":"The value of option.","example":"Extremely Likely"},"option_label":{"type":"string","description":"Only **Rating scale** question has this field to describe the score.","example":"5"},"option_order":{"type":"integer","description":"The order of option.","example":1}}}}}}}}}}}},"400":{"description":"**HTTP Status Code:** `400` <br>\n Bad Request  \n\n **Error Code:** `200` <br>\n No permission. <br>\n"},"403":{"description":"**HTTP Status Code:** `403` <br>\n Forbidden  \n\n **Error Code:** `6720` <br>\n You don't have the permissions to access survey. <br>\n"},"404":{"description":"**HTTP Status Code:** `404` <br>\n Not Found  \n\n **Error Code:** `6701` <br>\n Invalid parameter survey id. <br>\n"},"429":{"description":"**HTTP Status Code:** `429` <br>\n Too Many Requests. For more information, see [rate limits](https://developers.zoom.us/docs/api/rest/rate-limits/). \n\n "}},"security":[{"openapi_authorization":[]}],"x-extensions":{"x-permissions":["Survey:Read","EngagementSurvey:Read"],"x-macro-scopes":["survey:read:master"],"x-granular-scopes":["survey_management:read:survey:master"]}}},"/accounts/{accountId}/surveys/{surveyId}/answers":{"get":{"tags":["Survey Management"],"summary":"Get survey answers","description":"Queries the answers of survey from `surveyId`.\n\nYou can use the same survey cmultiple times in different products(Meeting/Webinar/Team Chat/Contact Center). \n\nWe call it an instance each time we use it.\n\nThis API returns the historical answers of each survey instance.\n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `survey:master`\n\n**[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `survey_management:read:list_survey_answers:master`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`","operationId":"getSurveyAnswers","parameters":[{"name":"surveyId","in":"path","description":"The UUID of survey.","required":true,"schema":{"type":"string","example":"WN3chY9bTjOQkbqnSIIhyg"}},{"name":"page_size","in":"query","description":"The number of records returned within a single API call.","required":false,"schema":{"type":"string","example":"30"}},{"name":"next_page_token","in":"query","description":"The next page token paginates through a large set of results. It returns whenever the set of available results exceeds the current page size. The expiration period for this token is 15 minutes.","required":false,"schema":{"type":"string","example":"IAfJX3jsOLW7w3dokmFl84zOa0MAVGyMEB"}},{"name":"instance_id","in":"query","description":"**Optional** Returns the answers of the survey in the specified instance.\nThis parameter needs double encode.","required":false,"schema":{"type":"string","example":"8FT3TOhmQq+I+DGHG9ybJA=="}},{"name":"submit_time_start","in":"query","description":"Start of submit time range (ISO 8601 format, e.g., 2025-09-22T10:00:00Z).","required":false,"schema":{"type":"string","example":"2025-08-22T17:30:00Z"}},{"name":"submit_time_end","in":"query","description":"End of submit time range (ISO 8601 format, e.g., 2025-09-22T10:00:00Z).","required":false,"schema":{"type":"string","example":"2025-09-22T17:30:00Z"}},{"name":"accountId","in":"path","description":"Unique identifier of the account.","required":true,"schema":{"type":"string","example":"TQTvjT52Tmi_wrhASNNOEw"}}],"responses":{"200":{"description":"**HTTP Status Code:** `200`   Survey answers returned.","content":{"application/json":{"schema":{"type":"object","properties":{"survey_answers":{"maxItems":100,"type":"array","description":"The user's answers of the survey, include user infos and answers.","items":{"type":"object","properties":{"email":{"type":"string","description":"Participant's email. If the survey is anonymous, the `email` field will contain an `Empty` string.","example":"jchilll@example.com"},"name":{"type":"string","description":"Participant's display name. If the survey is anonymous, the value of the `name` field will be `Empty` string.","example":"Jill Chill"},"instance_id":{"type":"string","description":"The UUID of an instance.For meeting surveys, this field is also meeting_uuid.","example":"iOTQZPmhTUq5a232ETb9eg=="},"submit_time":{"type":"string","description":"The answer submission time in UTC.","example":"2024-02-01T12:34:12.66Z"},"anonymous":{"type":"boolean","description":"Whether the answer is anonymous or not.","example":false},"questions":{"maxItems":100,"type":"array","description":"The user's answers of the survey.","items":{"type":"object","properties":{"question_id":{"type":"string","description":"The UUID of question.","example":"798fGJEWrA"},"question_answers":{"maxItems":50,"type":"array","description":"The answer of a question.\nIt is represented by an array. \nFor exaples:\n  - If it is a multiple choice question, the option id is the selected option. \n  - If there are three blanks in a fill-in-the-blank question and the user fills in the first and third blanks, then there are two values in the array, and the option_id represents which space it is, and the answer is the user's input.\n\n","items":{"type":"object","properties":{"option_id":{"type":"string","description":"The UUID of option.","example":"HGsx45GsefchY9bYhsdkbq"},"answer":{"type":"string","description":"The user's submitted content.","example":"abcde"}}}},"sub_questions":{"maxItems":10,"type":"array","description":"The answer of the sub question.\nOnly **Matching/Rank order** question has sub questions.","items":{"type":"object","properties":{"sub_question_id":{"type":"string","description":"The UUID of sub question.","example":"Sx3chY9bYhsdkbqnqwesdf"},"sub_question_answers":{"maxItems":16,"type":"array","description":"The answer of a sub question.\nIt is represented by an array. \nFor exaple:\n  - If it is a Matching question, the option id is the selected option of a sub question. ","items":{"type":"object","properties":{"option_id":{"type":"string","description":"The UUID of option of a sub question.","example":"HGsx45GsefchY9bYhsdkbq"},"answer":{"type":"string","description":"The user's submitted content.","example":"abc"}}}}}}}}}}}}},"next_page_token":{"type":"string","description":"The next page token paginates through a large set of results. It returns whenever the set of available results exceeds the current page size. The expiration period for this token is 15 minutes.","example":"WN3chY9bTjOQkbqnSIIhyg"}}}}}},"400":{"description":"**HTTP Status Code:** `400` <br>\n Bad Request  \n\n **Error Code:** `6703` <br>\n Invalid parameter survey instance id. <br>\n**Error Code:** `300` <br>\n The next page token is invalid or expired. <br>\n"},"403":{"description":"**HTTP Status Code:** `403` <br>\n Forbidden  \n\n **Error Code:** `6720` <br>\n You don't have the permissions to access survey. <br>\n"},"404":{"description":"**HTTP Status Code:** `404` <br>\n Not Found  \n\n **Error Code:** `6701` <br>\n Invalid parameter survey id. <br>\n"},"429":{"description":"**HTTP Status Code:** `429` <br>\n Too Many Requests. For more information, see [rate limits](https://developers.zoom.us/docs/api/rest/rate-limits/). \n\n "}},"security":[{"openapi_authorization":[]}],"x-extensions":{"x-permissions":["Survey:Read","EngagementSurvey:Read"],"x-macro-scopes":["survey:master"],"x-granular-scopes":["survey_management:read:list_survey_answers:master"]}}},"/accounts/{accountId}/surveys/{surveyId}/instances":{"get":{"tags":["Survey Management"],"summary":"Get survey instances","description":"Query the instances which used the survey, based on `surveyId`.\nThe same survey can be used multiple times in different products(meeting/webinar/team chat/contact center). Each time it is used, we call it an instance. \nThis API is used to return the historical information of each survey instance.\n\n\n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `survey:master`\n\n**[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `survey_management:read:list_survey_instances:master`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`","operationId":"getSurveyInstancesInfo","parameters":[{"name":"surveyId","in":"path","description":"The UUID of survey.","required":true,"schema":{"type":"string","example":"WN3chY9bTjOQkbqnSIIhyg"}},{"name":"page_size","in":"query","description":"The number of records returned within a single API call.","required":false,"schema":{"type":"string","example":"30"}},{"name":"next_page_token","in":"query","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.","required":false,"schema":{"type":"string","example":"IAfJX3jsOLW7w3dokmFl84zOa0MAVGyMEB"}},{"name":"instance_id","in":"query","description":"**Optional**, return the survey information used in the specified instance.\nThis parameter needs dobule encode.","required":false,"schema":{"type":"string","example":"8FT3TOhmQq+I+DGHG9ybJA=="}},{"name":"accountId","in":"path","description":"Unique identifier of the account.","required":true,"schema":{"type":"string","example":"TQTvjT52Tmi_wrhASNNOEw"}}],"responses":{"200":{"description":"**HTTP Status Code:** `200`   Survey instances returned.","content":{"application/json":{"schema":{"type":"object","properties":{"survey_instances":{"type":"array","description":"The instances used the survey.","items":{"type":"object","properties":{"instance_name":{"type":"string","description":"The name of an instance.","example":"It's Steve's meeting "},"instance_id":{"type":"string","description":"The UUID of an instance.For meeting surveys, this field is also meeting_uuid.","example":"iOTQZPmhTUq5a232ETb9eg=="},"product_type":{"type":"string","description":"The product used this survey.\n- `meeting` -- Meeting (requires `Survey:Read` permission).\n- `webinar` -- Webinar (requires `Survey:Read` permission).\n- `survey_public_link` -- Survey Public Link (requires `Survey:Read` permission).\n- `team_chat` -- Team Chat (requires `Survey:Read` permission).\n- `contact_center` -- Zoom Contact Center (requires `EngagementSurvey:Read` permission).\n- `vitual_agent` -- Zoom Vitual Agent (requires `EngagementSurvey:Read` permission).","example":"meeting","enum":["meeting","webinar","contact_center","survey_public_link","team_chat","vitual_agent"]},"has_response":{"type":"boolean","description":"Attendee has a response or not.","example":true},"survey_id":{"type":"string","description":"The UUID of survey.","example":"WN3chY9bTjOQkbqnSIIhyg"},"survey_name":{"type":"string","description":"The name of survey.","example":"Survey of this meeting"},"survey_type":{"type":"string","description":"The type of survey.\n- `basic_poll` -- Basic Poll (requires the `Survey:Read` permission).\n- `advanced_poll` -- Advanced Poll (requires the `Survey:Read` permission).\n- `quiz` -- Quiz (requires the `Survey:Read` permission).\n- `survey` -- Survey (requires the `Survey:Read` permission).\n- `consumer_engagement_survey` -- Consumer Engagement Survey (requires the `EngagementSurvey:Read` permission).","example":"survey","enum":["basic_poll","advanced_poll","quiz","survey","consumer_engagement_survey"]},"anonymous":{"type":"boolean","description":"The survey instance is anonymous or non-anonymous.","example":true},"survey_questions":{"type":"array","description":"The survey's question list.","items":{"type":"object","properties":{"question_name":{"type":"string","description":"The question of survey.","example":"How are you?"},"question_id":{"type":"string","description":"The UUID of question.","example":"798fGJEWrA"},"question_order":{"type":"integer","description":"The order of question.","example":1},"question_type":{"type":"string","description":"The type of question.\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.","example":"single","enum":["single","multiple","matching","rank_order","short_answer","long_answer","fill_in_the_blank","rating_scale"]},"required":{"type":"boolean","description":"The question is required to answer or not.","example":true},"sub_questions":{"type":"array","description":"Only **Matching/Rank order** question has sub questions.","items":{"type":"object","properties":{"sub_question_name":{"type":"string","description":"The sub question in a question.","example":"Good"},"sub_question_id":{"type":"string","description":"The UUID of sub question.","example":"Sx3chY9bYhsdkbqnqwesdf"},"sub_question_order":{"type":"integer","description":"The order of sub question.","example":1}}}},"options":{"type":"array","description":"The options of a question. For example, there are four options in a **Single choice** question, and option is used to represent each of the options.","items":{"type":"object","properties":{"option_id":{"type":"string","description":"The UUID of option.","example":"HGsx45GsefchY9bYhsdkbq"},"option_value":{"type":"string","description":"The value of option.","example":"Extremely Likely"},"option_label":{"type":"string","description":"Only **Rating scale** question has this field to describe the score.","example":"5"},"option_order":{"type":"integer","description":"The order of option.","example":1}}}}}}},"meeting_id":{"type":"string","description":"Meeting ID: Unique identifier of the meeting in \"long\" format(represented as string data type in JSON), also known as the meeting number.This field is only returned for meeting surveys.","example":"575734086"}}}},"next_page_token":{"type":"string","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.","example":"IAfJX3jsOLW7w3dokmFl84zOa0MAVGyMEB2"}}}}}},"400":{"description":"**HTTP Status Code:** `400` <br>\n Bad Request  \n\n **Error Code:** `6703` <br>\n Invalid parameter survey instance id. <br>\n**Error Code:** `300` <br>\n The next page token is invalid or expired. <br>\n"},"403":{"description":"**HTTP Status Code:** `403` <br>\n Forbidden  \n\n **Error Code:** `6720` <br>\n You don't have the permissions to access survey. <br>\n"},"404":{"description":"**HTTP Status Code:** `404` <br>\n Not Found  \n\n **Error Code:** `6701` <br>\n Invalid parameter survey id. <br>\n"},"429":{"description":"**HTTP Status Code:** `429` <br>\n Too Many Requests. For more information, see [rate limits](https://developers.zoom.us/docs/api/rest/rate-limits/). \n\n "}},"security":[{"openapi_authorization":[]}],"x-extensions":{"x-permissions":["Survey:Read","EngagementSurvey:Read"],"x-macro-scopes":["survey:master"],"x-granular-scopes":["survey_management:read:list_survey_instances:master"]}}}},"components":{"securitySchemes":{"openapi_authorization":{"scheme":"bearer","type":"http"}}},"tags":[{"name":"Accounts"},{"name":"Dashboards"},{"name":"Information Barriers"},{"name":"Roles"},{"name":"Survey Management"}]}