# Accounts Webhooks
- **OpenAPI Version:** `3.1.1`
- **API Version:** `1.0.0`
The Zoom Account webhooks allow developers to receive events related to accounts and information barriers.
## Servers
- **URL:** `https://{your-endpoint-url}`
## Operations
### account.vanity\_url\_rejected
- **Method:** `POST`
- **Path:** `account.vanity_url_rejected`
- **Tags:** Accounts
The **Account vanity url rejected** event is triggered each time an account or subaccount's [vanity URL](https://support.zoom.us/hc/en-us/articles/215062646) is rejected.
## Prerequisites
- A Pro or higher [plan](https://zoom.us/pricing) with the **Master account** option enabled.
- **Event Subscriptions** must be enabled for your [Marketplace app](https://marketplace.zoom.us/user/build) with the following configurations:
- A valid **Event Notification Endpoint URL**
- The **Account's vanity url rejected** subscription enabled under the **Account** event.
#### Request Body
##### Content-Type: application/json
- **`event` (required)**
`string` — The name of the event.
- **`event_ts` (required)**
`integer`, format: `int64` — A timestamp at which the event occurred.
- **`payload` (required)**
`object`
- **`account_id` (required)**
`string` — The account ID of the account's owner.
- **`object` (required)**
`object` — Information about the account's rejected vanity URL.
- **`id` (required)**
`string` — The account's ID.
- **`vanity_url` (required)**
`string` — The rejected \[vanity URL]\(https\://support.zoom.us/hc/en-us/articles/215062646-Guidelines-for-Vanity-URL-requests).
- **`operator` (required)**
`string`, format: `email` — The email address of the user who rejected the account's vanity URL.
**Example:**
```json
{
"event": "",
"event_ts": 1,
"payload": {
"account_id": "",
"operator": "",
"object": {
"id": "",
"vanity_url": ""
}
}
}
```
#### Responses
##### Status: 200 Successfully received the webhook event.
### account.created
- **Method:** `POST`
- **Path:** `account.created`
- **Tags:** Accounts
The **Sub Account has been created** event is triggered every time one of your app users or account users creates a sub account.
A Master account administrator or an account owner can create sub accounts under the Master account. A sub account can be created either by using the [**Create a Sub Account**](/api-reference/zoom-api/ma#operation/accountCreate) API or by logging into the [Zoom Web Portal](https://zoom.us) and navigating to the [**Add Sub Account**](https://zoom.us/account/sub/add) page.
## Prerequisites
- A Pro or higher [plan](https://zoom.us/pricing) with the **Master account** option enabled.
- **Event Subscriptions** must be enabled for your [Marketplace app](https://marketplace.zoom.us/user/build) with the following configurations:
- A valid **Event Notification Endpoint URL**.
- The **Sub Account has been created** subscription enabled under the **Account** event.
#### Request Body
##### Content-Type: application/json
- **`event`**
`string` — The name of the event.
- **`event_ts`**
`integer`, format: `int64` — A timestamp at which the event occurred.
- **`payload`**
`object`
- **`account_id`**
`string` — The account ID of the account's owner.
- **`object`**
`object` — Information about the created account.
- **`email`**
`string`, format: `email` — The account email address.
- **`id`**
`string` — The account's ID.
- **`owner_id`**
`string` — The account owner's ID.
- **`operator`**
`string`, format: `email` — The email address of the user who created the account.
- **`operator_id`**
`string` — The user ID of the user who created the account.
**Example:**
```json
{
"event": "",
"event_ts": 1,
"payload": {
"account_id": "",
"operator": "",
"operator_id": "",
"object": {
"id": "",
"owner_id": "",
"email": ""
}
}
}
```
#### Responses
##### Status: 200 Successfully received the webhook event.
### information\_barriers.policy\_deleted
- **Method:** `POST`
- **Path:** `information_barriers.policy_deleted`
- **Tags:** Information Barriers
The **Information barriers policy has been deleted** event is triggered when using an API or web page to delete an [information barrier](https://support.zoom.us/hc/en-us/articles/360040913711-Information-Barriers).
An account owner or admin can create information barrier policies. Delete an information barrier policy either by using the Remove an information barrier policy API, or by logging into the [Zoom Web Portal](https://zoom.us) and navigating to the [**Information barrier**](https://zoom.us/account/information_barriers) page.
## Prerequisites
- To enable information barriers for your account, [contact Zoom Support](https://support.zoom.us/hc/en-us/articles/201362003).
#### Request Body
##### Content-Type: application/json
- **`event` (required)**
`string` — The name of the event.
- **`event_ts` (required)**
`integer`, format: `int64` — A timestamp when the event occurred.
- **`payload` (required)**
`object`
- **`account_id` (required)**
`string` — The account ID of the user who deleted the policy.
- **`object` (required)**
`object` — An \[information barrier's]\(https\://support.zoom.us/hc/en-us/articles/360040913711-Information-Barriers) policies and its information.
- **`assigned_group_id` (required)**
`string` — The assigner group's (Group 1) ID.
- **`id` (required)**
`string` — The information barrier's policy's ID.
- **`policy_name` (required)**
`string` — The information barrier's policy's name.
- **`settings` (required)**
`object` — The information barriers policy's settings. \* 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. \* 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.
- **`complete_phone_calls` (required)**
`boolean` — If true, users between groups \*\*cannot\*\* call each other.
- **`file_transfer` (required)**
`boolean` — 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\`.
- **`im` (required)**
`boolean` — 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\`.
- **`in_meeting_chat` (required)**
`boolean` — 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\`.
- **`meeting` (required)**
`boolean` — 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.
- **`message_via_sms` (required)**
`boolean` — If true, users between groups \*\*cannot\*\* user SMS.
- **`recording` (required)**
`boolean` — 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\`. This feature is only available for Zoom Client v5.6.0 and higher.
- **`screen_share` (required)**
`boolean` — 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\`.
- **`status` (required)**
`integer`, possible values: `0, 1` — The information barrier's policy's status: \* \`0\` — Disabled. \* \`1\` — Enabled.
- **`to_group_id` (required)**
`string` — The assignee group's (Group 2) ID.
- **`type` (required)**
`integer`, possible values: `0, 1, 2, 3`, default: `0` — The information barrier's policy's type of \`settings\` restrictions: \* \`0\` — A \[hard or soft block]\(https\://support.zoom.us/hc/en-us/articles/360040913711-Information-Barriers#h\_a603c6f7-05c8-4de5-b4b6-91982d748b34) exists, but users in Group 1 and Group 2 can chat with each other. \* \`1\` — A \[hard or soft block]\(https\://support.zoom.us/hc/en-us/articles/360040913711-Information-Barriers#h\_a603c6f7-05c8-4de5-b4b6-91982d748b34) exists and only users in Group 1 can chat with users in Group 2. \* \`2\` — No blocks exist, but only users in Group 1 can chat with users in Group 2. \* \`3\` — No blocks exist and users in Group 1 and Group 2 can chat with each other. This field only supports \`0\`.
**Example:**
```json
{
"event": "",
"event_ts": 1,
"payload": {
"account_id": "",
"object": {
"assigned_group_id": "",
"id": "",
"policy_name": "",
"settings": {
"complete_phone_calls": true,
"file_transfer": true,
"im": true,
"in_meeting_chat": true,
"meeting": true,
"message_via_sms": true,
"recording": true,
"screen_share": true
},
"status": 1,
"to_group_id": "mjLMOSAERBaakF8kSDWB7g",
"type": 1
}
}
}
```
#### Responses
##### Status: 200 Successfully received the webhook event.
### account.updated
- **Method:** `POST`
- **Path:** `account.updated`
- **Tags:** Accounts
The **Account/Sub Account's profile has been updated** event is triggered every time the [profile](https://zoom.us/account) of an account or a sub account is updated.
An account owner or a user with administrator privileges can update a Zoom account's profile. The account profile can be updated by logging into the [Zoom Web Portal](https://zoom.us/) and editing fields in the [**Account Profile**](https://zoom.us/account) interface.
The account must belong to you or a user of your [webhook-enabled](https://marketplace.zoom.us/docs/api-reference/webhook-reference#enable-webhooks) app.
## Prerequisites
- A Pro or higher [plan](https://zoom.us/pricing).
- **Event Subscriptions** must be enabled for your [Marketplace app](https://marketplace.zoom.us/user/build) with the following configurations:
- A valid **Event Notification Endpoint URL**.
- The **Account/Sub Account's profile has been updated** subscription enabled under the **Account** event.
#### Request Body
##### Content-Type: application/json
- **`event`**
`string` — The name of the event.
- **`event_ts`**
`integer`, format: `int64` — A timestamp at which the event occurred.
- **`payload`**
`object`
- **`account_id`**
`string` — The account ID of the account's owner.
- **`object`**
`object` — Information about the updated account.
- **`account_alias`**
`string` — The account's updated alias.
- **`account_name`**
`string` — The account's updated name.
- **`account_support_email`**
`string`, format: `email` — The account's updated email address for account support.
- **`account_support_name`**
`string` — The account's updated name for account support.
- **`id`**
`string` — The account's ID.
- **`managed_domains`**
`array` — The account's updated managed domains.
**Items:**
`string`
- **`old_object`**
`object` — Information about the account's previous profile settings.
- **`$changed_field_name`**
`string` — The updated field name and its previous value.
- **`operation`**
`string`, possible values: `"apply_vanity_url", "managed_domains_added", "managed_domains_deleted", "managed_domains_verifying"` — This field only returns for the following operations: \* \`apply\_vanity\_url\` \* \`managed\_domains\_added\` \* \`managed\_domains\_deleted\` \* \`managed\_domains\_verifying\`
- **`operator`**
`string`, format: `email` — The email address of the user who updated the account.
**Example:**
```json
{
"event": "",
"event_ts": 1,
"payload": {
"account_id": "",
"operator": "",
"operation": "apply_vanity_url",
"object": {
"id": "",
"account_name": "",
"account_alias": "",
"account_support_name": "",
"account_support_email": "",
"managed_domains": [
""
]
},
"old_object": {
"$changed_field_name": ""
}
}
}
```
#### Responses
##### Status: 200 Successfully received the webhook event.
### information\_barriers.policy\_created
- **Method:** `POST`
- **Path:** `information_barriers.policy_created`
- **Tags:** Information Barriers
The **Information barriers policy has been created** event is triggered when using an API or web page to add an [information barrier](https://support.zoom.us/hc/en-us/articles/360040913711-Information-Barriers).
An account owner or admin can create information barrier policies. Create an information barrier policy either by using the Create an information barrier policy API, or by logging into the [Zoom Web Portal](https://zoom.us) and navigating to the [**Information barrier**](https://zoom.us/account/information_barriers) page.
## Prerequisites
- To enable information barriers for your account, [contact Zoom Support](https://support.zoom.us/hc/en-us/articles/201362003).
#### Request Body
##### Content-Type: application/json
- **`event` (required)**
`string` — The name of the event.
- **`event_ts` (required)**
`integer`, format: `int64` — A timestamp when the event occurred.
- **`payload` (required)**
`object`
- **`account_id` (required)**
`string` — The account ID of the user who created the policy.
- **`object` (required)**
`object` — An \[information barrier's]\(https\://support.zoom.us/hc/en-us/articles/360040913711-Information-Barriers) policies and its information.
- **`assigned_group_id` (required)**
`string` — The assigner group's (Group 1) ID.
- **`id` (required)**
`string` — The information barrier's policy's ID.
- **`policy_name` (required)**
`string` — The information barrier's policy's name.
- **`settings` (required)**
`object` — The information barrier's policy's settings. \* 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. \* 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.
- **`complete_phone_calls` (required)**
`boolean` — If true, users between groups \*\*cannot\*\* call each other.
- **`file_transfer` (required)**
`boolean` — 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\`.
- **`im` (required)**
`boolean` — 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\`.
- **`in_meeting_chat` (required)**
`boolean` — 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\`.
- **`meeting` (required)**
`boolean` — 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.
- **`message_via_sms` (required)**
`boolean` — If true, users between groups \*\*cannot\*\* user SMS.
- **`recording` (required)**
`boolean` — 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\`. This feature is only available for Zoom Client v5.6.0 and higher.
- **`screen_share` (required)**
`boolean` — 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\`.
- **`status` (required)**
`integer`, possible values: `0, 1` — The information barrier's policy's status: \* \`0\` — Disabled. \* \`1\` — Enabled.
- **`to_group_id` (required)**
`string` — The assignee group's (Group 2) ID.
- **`type` (required)**
`integer`, possible values: `0, 1, 2, 3`, default: `0` — The information barrier's policy's type of \`settings\` restrictions: \* \`0\` — A \[hard or soft block]\(https\://support.zoom.us/hc/en-us/articles/360040913711-Information-Barriers#h\_a603c6f7-05c8-4de5-b4b6-91982d748b34) exists, but users in Group 1 and Group 2 can chat with each other. \* \`1\` — A \[hard or soft block]\(https\://support.zoom.us/hc/en-us/articles/360040913711-Information-Barriers#h\_a603c6f7-05c8-4de5-b4b6-91982d748b34) exists and only users in Group 1 can chat with users in Group 2. \* \`2\` — No blocks exist, but only users in Group 1 can chat with users in Group 2. \* \`3\` — No blocks exist and users in Group 1 and Group 2 can chat with each other. This field only supports \`0\`.
**Example:**
```json
{
"event": "",
"event_ts": 1,
"payload": {
"account_id": "",
"object": {
"assigned_group_id": "",
"id": "",
"policy_name": "",
"settings": {
"complete_phone_calls": true,
"file_transfer": true,
"im": true,
"in_meeting_chat": true,
"meeting": true,
"message_via_sms": true,
"recording": true,
"screen_share": true
},
"status": 1,
"to_group_id": "mjLMOSAERBaakF8kSDWB7g",
"type": 1
}
}
}
```
#### Responses
##### Status: 200 Successfully received the webhook event.
### account.lock\_settings\_updated
- **Method:** `POST`
- **Path:** `account.lock_settings_updated`
- **Tags:** Accounts
Zoom triggers this event when an account or a sub account enables or disables a lock for a [setting](https://zoom.us/account/setting).
The account must belong to either you or a user of your [webhook-enabled](https://marketplace.zoom.us/docs/api-reference/webhook-reference#enable-webhooks) app.
Account owners or users with admin privileges can [manually update](https://support.zoom.us/hc/en-us/articles/201363253-Account-Settings#h_419c57b8-0d83-4ff3-8910-3e5dfb7be3a0) account lock settings from the [Zoom Web Portal](https://zoom.us/), or by using the [Update Settings](/api-reference/zoom-api/ma#operation/updateAccountLockSettings) API.
## Prerequisites
To receive notifications for this event, you must meet the following prerequisites.
- A Pro or higher plan.
- **Event Subscriptions** must be enabled for your [Marketplace app](https://marketplace.zoom.us/user/build) with the following configurations:
- A valid **Event Notification Endpoint URL**.
- The "**Account settings lock status updated**" subscription enabled under the **Account** event.
#### Request Body
##### Content-Type: application/json
- **`event`**
`string` — The name of the event.
- **`event_ts`**
`integer`, format: `int64` — A timestamp at which the event occurred.
- **`payload`**
`object`
- **`account_id`**
`string` — The account ID of the account's owner.
- **`object`**
`object` — Information about the updated fields.
- **`id`**
`string` — The updated account's ID.
- **`settings`**
`object` — Information about the account's updated lock settings.
- **`ai`**
`object` — Lock settings for Workspace Reservation recommendations with AI.
- **`ai_generated_virtual_backgrounds`**
`boolean` — Whether the ai\_generated\_virtual\_backgrounds setting is locked.
- **`ai_panel_in_workplace`**
`object` — Lock settings for the AI panel in Zoom Workplace.
- **`delete_ai_conversation`**
`boolean` — Whether automatic AI conversation deletion in the AI panel is locked.
- **`delete_ai_conversation_time`**
`boolean` — Whether the AI panel conversation retention period is locked.
- **`enabled`**
`boolean` — Whether the AI panel in Zoom Workplace is locked.
- **`canvas_ai_content_generation`**
`boolean` — Whether the Canvas AI content generation and revision setting is locked.
- **`canvas_ai_post_meeting_writing_tasks`**
`boolean` — Whether the Canvas post-meeting writing task setting is locked.
- **`canvas_ai_sentence_completion`**
`boolean` — Whether the Canvas AI sentence completion setting is locked.
- **`chat_compose`**
`boolean` — Compose with AI Companion.
- **`chat_summary`**
`boolean` — Summarize with AI Companion.
- **`enable_ai_on_web`**
`boolean` — Whether Zoom AI on the web is locked.
- **`enable_email_compose_with_ai`**
`boolean` — Whether Zoom Mail AI compose is locked.
- **`full_display_names_in_ai_assets`**
`boolean` — Whether the full\_display\_names\_in\_ai\_assets setting is locked.
- **`google`**
`object` — Lock settings for Google data sources.
- **`enable`**
`boolean` — Whether Google data sources are locked.
- **`hub_ai_question_and_file_creation`**
`boolean` — Whether the Hub AI search and file creation setting is locked.
- **`include_webinar_summary_follow_up_email`**
`object` — Lock settings for including the webinar summary in follow-up email.
- **`enable`**
`boolean` — Whether including the webinar summary in follow-up email is locked.
- **`local_file_uploads`**
`boolean` — Whether Local file uploads as an AI data source are locked.
- **`meeting_agenda`**
`boolean` — Whether the meeting\_agenda setting is locked.
- **`meeting_chat_messages`**
`boolean` — Whether the meeting\_chat\_messages setting is locked.
- **`meeting_coach`**
`object` — Lock settings for Meeting Coach with AI.
- **`enable`**
`boolean` — Whether Meeting Coach with AI is locked.
- **`meeting_questions`**
`object` — Lock settings for meeting questions.
- **`auto_enable_locked`**
`boolean` — Whether automatic meeting questions are locked.
- **`locked`**
`boolean` — Whether meeting questions are locked.
- **`who_can_ask_questions_locked`**
`boolean` — Whether the meeting questions participant scope is locked.
- **`meeting_summary`**
`object` — Lock settings for meeting summaries.
- **`auto_enable_locked`**
`boolean` — Whether automatic meeting summaries are locked.
- **`locked`**
`boolean` — Whether meeting summaries are locked.
- **`who_will_receive_summary_locked`**
`boolean` — Whether the meeting summary recipient scope is locked.
- **`meeting_summary_default_language`**
`object` — Lock settings for the default meeting summary language.
- **`enable`**
`boolean` — Whether the default meeting summary language is locked.
- **`meeting_summary_docs`**
`object` — Lock settings for meeting summary Docs.
- **`enable`**
`boolean` — Whether automatic Zoom Doc creation is locked.
- **`share_with_summary_recipients`**
`boolean` — Whether sharing generated Zoom Docs with meeting summary recipients is locked.
- **`meeting_summary_email_only_mode`**
`boolean` — Whether the meeting\_summary\_email\_only\_mode setting is locked.
- **`meeting_summary_ip_access`**
`object` — Lock settings for meeting summary IP access.
- **`enable`**
`boolean` — Whether meeting summary IP access is locked.
- **`meeting_summary_retention`**
`object` — Lock settings for meeting summary retention.
- **`enable`**
`boolean` — Whether automatic meeting summary deletion is locked.
- **`meeting_summary_template`**
`object` — Lock settings for meeting summary templates.
- **`enable`**
`boolean` — Whether meeting summary templates are locked.
- **`microsoft_365`**
`object` — Lock settings for Microsoft 365 data sources.
- **`enable`**
`boolean` — Whether Microsoft 365 data sources are locked.
- **`my_notes_ai_content_generation`**
`boolean` — Whether the My Notes AI content generation setting is locked.
- **`my_notes_meeting_transcription`**
`boolean` — Whether the My Notes meeting transcription setting is locked.
- **`organization_custom_dictionaries`**
`boolean` — Whether allowing AI to consume the organization's custom dictionaries is locked.
- **`paper_ai_content_generation`**
`boolean` — Whether the Zoom Paper AI content generation and revision setting is locked.
- **`participant_can_request_aic_in_meeting`**
`boolean` — Whether the participant\_can\_request\_aic\_in\_meeting setting is locked.
- **`phone_user_ai_notices`**
`object` — Lock settings for phone user AI notices.
- **`enable`**
`boolean` — Whether phone user AI notices are locked.
- **`remind_me_turn_on_aic`**
`boolean` — Whether the remind\_me\_turn\_on\_aic setting is locked.
- **`remind_me_turn_on_catch_me_up`**
`boolean` — Whether the remind\_me\_turn\_on\_catch\_me\_up setting is locked.
- **`restrict_aic_when_external_user_join_meeting`**
`boolean` — Whether the restrict\_aic\_when\_external\_user\_join\_meeting setting is locked.
- **`restrict_aic_when_restrict_user_join`**
`boolean` — Whether the restrict\_aic\_when\_restrict\_user\_join setting is locked.
- **`restrict_users_from_deleting_ai_companion_assets`**
`boolean` — Whether the restrict\_users\_from\_deleting\_ai\_companion\_assets setting is locked.
- **`restrict_users_from_editing_ai_companion_assets`**
`boolean` — Whether the restrict\_users\_from\_editing\_ai\_companion\_assets setting is locked.
- **`restrict_users_from_joining_ai_enabled_meetings`**
`object` — Lock settings for restrictions on joining AI-enabled meetings.
- **`enable`**
`boolean` — Whether restrictions on joining AI-enabled meetings are locked.
- **`screen_share_ocr`**
`boolean` — Whether the screen\_share\_ocr setting is locked.
- **`sheets_ai_content_generation`**
`boolean` — Whether the Zoom Sheets AI content generation and revision setting is locked.
- **`sheets_ai_formula`**
`boolean` — Whether the Zoom Sheets AI Formula setting is locked.
- **`sheets_ai_function`**
`boolean` — Whether the Zoom Sheets AI Function setting is locked.
- **`sheets_ai_resources`**
`boolean` — Whether the Zoom Sheets AI Resources setting is locked.
- **`show_conversational_ai_companion`**
`object` — Lock settings for the conversational AI companion.
- **`delete_ai_conversation`**
`boolean` — Whether automatic AI conversation deletion is locked.
- **`delete_ai_conversation_time`**
`boolean` — Whether the AI conversation retention period is locked.
- **`enable_zoom_mate`**
`boolean` — Whether ZoomMate availability is locked.
- **`enabled`**
`boolean` — Whether conversational AI is locked.
- **`slides_ai_content_generation`**
`boolean` — Whether the Zoom Slides AI content generation and revision setting is locked.
- **`smart_recording`**
`object` — Lock settings for Smart Recording.
- **`enable`**
`boolean` — Whether the Smart Recording is locked.
- **`task_creation_and_management`**
`object` — Lock settings for task creation and management with AI.
- **`enable`**
`boolean` — Whether task creation and management with AI is locked.
- **`third_party_app_tasks`**
`boolean` — Whether allowing AI to perform tasks in third-party apps is locked.
- **`third_party_meeting_join`**
`object` — Lock settings for third-party meeting join with AI.
- **`allow_recording`**
`boolean` — Whether recording for joined third-party meetings is locked.
- **`calendar`**
`object` — Lock settings for calendar-based third-party meeting join.
- **`enable`**
`boolean` — Whether calendar-based third-party meeting join is locked.
- **`enable`**
`boolean` — Whether third-party meeting join with AI is locked.
- **`pre_meeting_email_notification`**
`object` — Lock settings for pre-meeting email notification.
- **`enable`**
`boolean` — Whether pre-meeting email notification is locked.
- **`web_content`**
`boolean` — Whether Web content as an AI data source is locked.
- **`webinar_questions`**
`object` — 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 setting is locked.
- **`auto_enable`**
`boolean` — Whether automatically allowing access when the webinar starts is locked.
- **`enable`**
`boolean` — Whether allowing users to ask webinar questions with AI is locked.
- **`who_can_ask_questions`**
`boolean` — 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.
- **`webinar_summary`**
`object` — 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 setting is locked.
- **`auto_enable`**
`boolean` — Whether turning on webinar summary automatically when the webinar starts is locked.
- **`email_notification`**
`boolean` — Whether sending an email notification when sharing to participants is locked.
- **`enable`**
`boolean` — Whether allowing hosts to generate a summary is locked.
- **`restrict_share_to_outside_of_organization`**
`boolean` — Whether restricting users from sharing summaries to those outside of the organization is locked.
- **`who_will_receive_summary`**
`boolean` — 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.
- **`webinar_summary_follow_up_email`**
`boolean` — 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.
- **`webinar_summary_ocr`**
`boolean` — Whether using screen share content with OCR for webinar summaries is locked.
- **`whiteboard_content_generation`**
`boolean` — Whether Whiteboard content generation with AI is enabled.
- **`workspace_reservation_recommendations_with_ai`**
`object` — Lock settings for Workspace Reservation recommendations with AI.
- **`enabled`**
`boolean` — Whether Workspace Reservation recommendations with AI are locked.
- **`zoom_events_chat_panel`**
`boolean` — Whether the AI chat panel in Zoom Events is locked.
- **`zoom_events_session_summary`**
`object` — Lock settings for Zoom Events session summary.
- **`auto_start`**
`boolean` — Whether turning on session summary automatically when sessions start is locked.
- **`enable`**
`boolean` — Whether Zoom Events session summaries are locked.
- **`audio_conferencing`**
`object` — Account Audio Conference Settings
- **`call_me_and_invite_by_phone`**
`boolean` — 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.
- **`participant_phone_masking`**
`boolean` — 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.
- **`personal_audio_conference`**
`boolean` — 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.
- **`toll_call`**
`boolean` — Whether the account has the \[\*\*Toll Call\*\*]\(https\://support.zoom.com/hc/en/article?id=zm\_kb\&sysparm\_article=KB0066909#h\_01F51680NJ7YHZDXGJNSKDGM2P) setting enabled.
- **`toll_free_and_fee_based_toll_call`**
`boolean` — 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.
- **`chat`**
`object`
- **`ai_compose`**
`boolean` — Compose with AI Companion.
- **`ai_quick_schedule`**
`boolean` — Quick schedule with AI Companion.
- **`ai_recommend`**
`boolean` — Chat Recommendation with Zoom AI Companion.
- **`ai_reply`**
`boolean` — Quick reply with AI Companion.
- **`ai_sentence_completion`**
`boolean` — Sentence completion with AI Companion.
- **`ai_summary`**
`boolean` — Summarize with AI Companion.
- **`allow_create_channels_and_group_chats`**
`boolean` — Whether to allow users to create channels and group chats.
- **`allow_delete_message`**
`boolean` — Whether to allow users to delete messages.
- **`allow_edit_message`**
`boolean` — Whether to allow users to edit messages.
- **`allow_huddles_from_channels`**
`boolean` — Whether to allow huddles from channels.
- **`allow_users_to_add_contacts`**
`boolean` — Whether to allow users to add contacts.
- **`allow_users_to_chat_with_others`**
`boolean` — Whether to Allow users to chat with others.
- **`chat_email_address`**
`boolean` — Chat email address.
- **`chat_emojis`**
`boolean` — 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.
- **`chat_etiquette_tool`**
`boolean` — Whether to enable the \*\*Chat Etiquette Tool\*\*.
- **`download_file`**
`boolean` — Whether to allow users to downloading files.
- **`presence_away_when_screen_saver`**
`boolean` — Change my status to away when screen saver begins.
- **`presence_on_meeting`**
`boolean` — Change my presence status when I am in a meeting or call.
- **`read_receipts`**
`boolean` — Whether to enable read receipts.
- **`record_video_messages`**
`boolean` — 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.
- **`record_voice_messages`**
`boolean` — Allow users to record voice messages that can be sent in direct messages or group conversations.
- **`schedule_meetings_in_chat`**
`boolean` — Schedule a meeting from chat or channel.
- **`screen_capture`**
`boolean` — Allow users to take and send screenshots in direct messages or group conversations.
- **`search_and_send_animated_gif_images`**
`boolean` — Whether to allow users to search GIF images from GIPHY when they compose messages.
- **`send_data_to_third_party_archiving_service`**
`boolean` — Whether to send data to third-party archiving service.
- **`set_retention_period_in_cloud`**
`boolean` — Store messages in Zoom's cloud.
- **`set_retention_period_in_local`**
`boolean` — Set retention period for messages on local devices.
- **`share_files`**
`boolean` — Users can share files in chats and channels.
- **`share_links_in_chat`**
`boolean` — Share links to messages and channels in Team Chat.
- **`share_screen_in_chat`**
`boolean` — Whether to allow users to share screen in chat.
- **`shared_spaces`**
`boolean` — Whether to allow users to create Shared Spaces.
- **`survey_poll`**
`boolean` — Allow users to launch a poll in chats and channels.
- **`translate_messages`**
`boolean` — Allow users to translate team chat messages. \[Learn more].(https\://support.zoom.us/hc/en-us/articles/12998089084685)
- **`email_notification`**
`object`
- **`alternative_host_reminder`**
`boolean` — Notify the alternative host who is set or removed.
- **`cancel_meeting_reminder`**
`boolean` — Notify host and participants when the meeting is cancelled.
- **`cloud_recording_available_reminder`**
`boolean` — Whether to notify the host when a cloud recording is available.
- **`jbh_reminder`**
`boolean` — Notify host when participants join the meeting before them.
- **`schedule_for_reminder`**
`boolean` — Notify the host there is a meeting is scheduled, rescheduled, or cancelled.
- **`h323sip_conferencing`**
`object` — The account's H.323/SIP Conferencing settings.
- **`custom_welcome_audio`**
`object` — Information about the custom welcome audio message played to H.323/SIP devices upon joining a Zoom Meeting.
- **`enable`**
`boolean`, default: `false` — Determines if a custom welcome audio message is played when H.323/SIP devices join a Zoom Meeting.
- **`in_meeting`**
`object`
- **`alert_guest_join`**
`boolean` — 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.
- **`allow_live_streaming`**
`boolean` — Whether to allow livestreaming.
- **`allow_show_zoom_windows`**
`boolean` — Show Zoom windows during screen share.
- **`allow_users_to_delete_messages_in_meeting_chat`**
`boolean` — If the value of this field is set to \`true\`, allow users to delete messages in the in-meeting chat.
- **`annotation`**
`boolean` — Allow participants to use annotation tools to add information to shared screens.
- **`anonymous_question_answer`**
`boolean`
- **`attendee_on_hold`**
`boolean`, default: `false` — Allow host to put attendee on hold. \*\*This field has been deprecated and is no longer supported.\*\*
- **`attention_mode_focus_mode`**
`boolean`, default: `false` — 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. This value defaults to \`false\`.
- **`auto_answer`**
`boolean` — 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.
- **`auto_generated_captions`**
`boolean` — 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).
- **`auto_saving_chat`**
`boolean` — Automatically save all in-meeting chats.
- **`breakout_room`**
`boolean` — Allow host to split meeting participants into separate, smaller rooms.
- **`chat`**
`boolean` — Allow meeting participants to send chat message visible to all participants.
- **`closed_caption`**
`boolean` — Allow host to type closed captions or assign a participant/third party device to add closed captions.
- **`co_host`**
`boolean` — Allow the host to add co-hosts. Co-hosts have the same in-meeting controls as the host.
- **`custom_data_center_regions`**
`boolean` — 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.
- **`disable_screen_sharing_for_host_meetings`**
`boolean` — Whether to enable the \*\*Disable desktop screen sharing for meetings you host\*\* setting.
- **`disable_screen_sharing_for_in_meeting_guests`**
`boolean` — Whether to enable the \*\*Disable screen sharing when guests are in the meeting\*\* setting.
- **`dscp_marking`**
`boolean` — Enable DSCP marking for signaling and media packets. (Default is 56 for audio, 40 for video, and 40 for signaling.)
- **`e2e_encryption`**
`boolean` — Require that all meetings are encrypted using AES.
- **`far_end_camera_control`**
`boolean` — Allow another user to take control of the camera during a meeting.
- **`feedback`**
`boolean` — Enable users to provide feedback to Zoom at the end of the meeting.
- **`file_transfer`**
`boolean` — 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.
- **`full_transcript`**
`boolean` — Whether full transcripts are available for viewing in the in-meeting side panel.
- **`group_hd`**
`boolean` — Enable higher quality video for host and participants. This will require more bandwidth.
- **`language_interpretation`**
`boolean` — Whether hosts can assign participants as interpreters to interpret one language into another in real-time.
- **`manual_captions`**
`boolean` — 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.
- **`meeting_question_answer`**
`boolean` — Allow participants to ask questions for the host and participants to answer.
- **`meeting_reactions`**
`boolean` — 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.
- **`meeting_survey`**
`boolean` — 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.
- **`non_verbal_feedback`**
`boolean`, default: `false` — 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\`.
- **`original_audio`**
`boolean` — Allow users to select original sound during a meeting.
- **`polling`**
`boolean` — Add 'Polls' to the meeting controls. This allows the host to survey the attendees.
- **`post_meeting_feedback`**
`boolean` — Display end-of-meeting experience feedback survey.
- **`private_chat`**
`boolean` — Allow meeting participants to send a private 1:1 message to another participant.
- **`remote_control`**
`boolean` — During screen sharing, allow the person who is sharing to let others control the shared content.
- **`remote_support`**
`boolean`, default: `false` — Whether to enable the \[\*\*Remote support\*\*]\(https\://support.zoom.us/hc/en-us/articles/360060951012-Enabling-remote-support) setting. This value defaults to \`false\`.
- **`request_permission_to_unmute_participants`**
`boolean` — 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.
- **`save_caption`**
`boolean` — Whether participants can save closed captions or transcripts.
- **`save_captions`**
`boolean` — Whether participants can \[save closed caption or transcripts]\(https\://support.zoom.us/hc/en-us/articles/360060958752). \*\*Note:\*\* If the \`full\_transcript\` field is set to \`false\`, participants \*\*cannot\*\* save captions.
- **`screen_sharing`**
`boolean` — Allow host and participants to share their screen or content during meetings.
- **`sending_default_email_invites`**
`boolean` — Allow users to invite participants by email only by default.
- **`show_meeting_control_toolbar`**
`boolean` — Always show meeting controls during a meeting.
- **`sign_language_interpretation`**
`boolean` — 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.
- **`slide_control`**
`boolean` — 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.
- **`stereo_audio`**
`boolean` — Allow users to select stereo audio during a meeting.
- **`use_html_format_email`**
`boolean` — Allow HTML formatting instead of plain text for meeting invitations scheduled with the Outlook plugin.
- **`virtual_background`**
`boolean` — Enable virtual background.
- **`webinar_chat`**
`boolean` — Whether to allow webinar participants to send chat messages.
- **`webinar_live_streaming`**
`boolean` — Whether to enable webinar livestreaming.
- **`webinar_polling`**
`boolean` — Whether the host can add polls before or during a webinar.
- **`webinar_question_answer`**
`boolean` — Whether attendees can ask the host and panelists questions in the webinar.
- **`webinar_reactions`**
`boolean` — Set this field to true to use \[webinar reactions]\(https\://support.zoom.us/hc/en-us/articles/4803536268429).
- **`webinar_survey`**
`boolean` — Whether the host can present surveys to attendees once a webinar has ended.
- **`whiteboard`**
`boolean` — Allow participants to share a whiteboard that includes annotation tools.
- **`meeting_security`**
`object`
- **`approved_or_denied_countries_or_regions`**
`boolean` — 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.
- **`auto_security`**
`boolean` — Whether all meetings must be secured with at least one security option. This setting can only be disabled by Enterprise, ISV, Business (with more than 100 licenses), and Education accounts.
- **`block_user_domain`**
`boolean` — Whether users in specific domains are blocked from joining meetings and webinars.
- **`chat_etiquette_tool`**
`boolean` — Whether to enable the \*\*Chat Etiquette Tool\*\*.
- **`embed_password_in_join_link`**
`boolean` — Whether the meeting password is encrypted and included in the invitation link. The provided link will allow participants to join the meeting without having to enter the password.
- **`encryption_type`**
`boolean` — Whether use encryption to start a meeting.
- **`end_to_end_encrypted_meetings`**
`boolean` — Whether to enable end-to-end encryption for meetings.
- **`meeting_password`**
`boolean` — Whether all instant and scheduled meetings that users can join via client or Zoom Rooms systems are password-protected. \[Personal Meeting ID (PMI)]\(https\://support.zoom.us/hc/en-us/articles/203276937) meetings are \*\*not\*\* included in this setting.
- **`only_authenticated_can_join_from_webclient`**
`boolean` — Whether to specify that only authenticated users can join the meeting from the web client.
- **`phone_password`**
`boolean` — Whether passwords are required for participants joining by phone. If enabled and the meeting is password-protected, a numeric password is required for participants to join by phone. For meetings with alphanumeric passwords, a numeric password will be generated.
- **`pmi_password`**
`boolean` — Whether all Personal Meeting ID (PMI) meetings that users can join via client or Zoom Rooms systems are password-protected.
- **`waiting_room`**
`boolean` — Whether participants are placed in the \[\*\*Waiting Room\*\*]\(https\://support.zoom.us/hc/en-us/articles/115000332726-Waiting-Room) when they join a meeting. 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.
- **`webinar_password`**
`boolean` — Whether to generate a password when scheduling webinars. Participants must use the generated password to join the scheduled webinar.
- **`other_options`**
`object`
- **`blur_snapshot`**
`boolean` — 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.
- **`webinar_registration_options`**
`boolean` — Webinar registration options.
- **`recording`**
`object`
- **`account_user_access_recording`**
`boolean` — Make cloud recordings accessible to account members only.
- **`archive`**
`boolean` — \[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.
- **`auto_delete_cmr`**
`boolean` — Allow Zoom to automatically delete recordings permanently after a specified number of days.
- **`auto_recording`**
`boolean` — Record meetings automatically as they start.
- **`cloud_recording`**
`boolean` — Allow hosts to record and save the meeting / webinar in the cloud.
- **`cloud_recording_download`**
`boolean` — Allow anyone with a link to the cloud recording to download.
- **`host_delete_cloud_recording`**
`boolean` — 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.
- **`ip_address_access_control`**
`boolean` — Setting to allow cloud recording access only from specific IP address ranges.
- **`local_recording`**
`boolean` — Allow hosts and participants to record the meeting to a local file.
- **`recording_authentication`**
`boolean` — Only authenticated users can view cloud recordings
- **`schedule_meeting`**
`object`
- **`always_display_zoom_webinar_as_topic`**
`boolean` — Whether to enable the \[\*\*Always show "Zoom Webinar" as the webinar topic\*\*]\(https\://support.zoom.us/hc/en-us/articles/201363253-Changing-account-settings#h\_01EG9BJ646V2WJK1S3H2MP6YV6) setting.
- **`audio_type`**
`boolean` — Determine how participants can join the audio portion of the meeting.
- **`embed_password_in_join_link`**
`boolean` — If the value is set to \`true\`, the meeting password will be encrypted and included in the join meeting link to allow participants to join with just one click without having to enter the password.
- **`enforce_login`**
`boolean` — Allow only signed-in users to join meetings.
- **`enforce_login_with_domains`**
`boolean` — Allow only signed-in users with specified domains to join meetings.
- **`host_video`**
`boolean` — Start meetings with host video on.
- **`join_before_host`**
`boolean` — Allow participants to join the meeting before the host arrives
- **`meeting_authentication`**
`boolean` — Only authenticated users can join meetings
- **`meeting_template`**
`boolean` — Whether to enable the \*\*Meeting Templates\*\* setting.
- **`not_store_meeting_topic`**
`boolean` — Whether to enable the \[\*\*Always display "Zoom Meeting" as the meeting topic\*\*]\(https\://support.zoom.us/hc/en-us/articles/201363253-Changing-account-settings#h\_01EG9BJ646V2WJK1S3H2MP6YV6) setting.
- **`participant_video`**
`boolean` — Start meetings with participant video on.
- **`require_password_for_instant_meetings`**
`boolean` — Require password for instant meetings. If you use a PMI for your instant meetings, this option will be disabled. This setting is always enabled for free accounts and Pro accounts with a single host and cannot be modified for these accounts.
- **`require_password_for_pmi_meetings`**
`boolean` — Require participants to enter password for PMI meetings. This setting is always enabled for free accounts and Pro accounts with a single host and cannot be modified for these accounts.
- **`require_password_for_scheduling_new_meetings`**
`boolean` — This setting applies for regular meetings that do not use a PMI. If enabled, a password will be generated while a host schedules a new meeting and participants will be required to enter the password before they can join the meeting. This setting is always enabled for free accounts and Pro accounts with a single host and cannot be modified for these accounts.
- **`use_pmi_for_instant_meetings`**
`boolean` — Use a Personal Meeting ID (PMI) when starting an instant meeting.
- **`use_pmi_for_scheduled_meetings`**
`boolean` — Use a Personal Meeting ID (PMI) when scheduling a meeting.
- **`telephony`**
`object` — Account Settings: Telephony.
- **`telephony_regions`**
`boolean` — Indicates where most of the participants call into or call from during a meeting.
- **`third_party_audio`**
`boolean` — Allow users to join the meeting using the existing 3rd party audio configuration.
- **`tsp`**
`object` — Account Settings: TSP.
- **`call_out`**
`boolean` — Call Out Countries/Regions
- **`show_international_numbers_link`**
`boolean` — Show international numbers link on the invitation email
- **`old_object`**
`object` — Information about the account's previous lock settings.
- **`id`**
`string` — The updated account's ID.
- **`settings`**
`object` — Information about the updated account or sub account settings. This only returns modified settings.
- **`ai`**
`object` — Lock settings for Workspace Reservation recommendations with AI.
- **`ai_generated_virtual_backgrounds`**
`boolean` — Whether the ai\_generated\_virtual\_backgrounds setting is locked.
- **`ai_panel_in_workplace`**
`object` — Lock settings for the AI panel in Zoom Workplace.
- **`delete_ai_conversation`**
`boolean` — Whether automatic AI conversation deletion in the AI panel is locked.
- **`delete_ai_conversation_time`**
`boolean` — Whether the AI panel conversation retention period is locked.
- **`enabled`**
`boolean` — Whether the AI panel in Zoom Workplace is locked.
- **`canvas_ai_content_generation`**
`boolean` — Whether the Canvas AI content generation and revision setting is locked.
- **`canvas_ai_post_meeting_writing_tasks`**
`boolean` — Whether the Canvas post-meeting writing task setting is locked.
- **`canvas_ai_sentence_completion`**
`boolean` — Whether the Canvas AI sentence completion setting is locked.
- **`chat_compose`**
`boolean` — Compose with AI Companion.
- **`chat_summary`**
`boolean` — Summarize with AI Companion.
- **`enable_ai_on_web`**
`boolean` — Whether Zoom AI on the web is locked.
- **`enable_email_compose_with_ai`**
`boolean` — Whether Zoom Mail AI compose is locked.
- **`full_display_names_in_ai_assets`**
`boolean` — Whether the full\_display\_names\_in\_ai\_assets setting is locked.
- **`google`**
`object` — Lock settings for Google data sources.
- **`enable`**
`boolean` — Whether Google data sources are locked.
- **`hub_ai_question_and_file_creation`**
`boolean` — Whether the Hub AI search and file creation setting is locked.
- **`include_webinar_summary_follow_up_email`**
`object` — Lock settings for including the webinar summary in follow-up email.
- **`enable`**
`boolean` — Whether including the webinar summary in follow-up email is locked.
- **`local_file_uploads`**
`boolean` — Whether Local file uploads as an AI data source are locked.
- **`meeting_agenda`**
`boolean` — Whether the meeting\_agenda setting is locked.
- **`meeting_chat_messages`**
`boolean` — Whether the meeting\_chat\_messages setting is locked.
- **`meeting_coach`**
`object` — Lock settings for Meeting Coach with AI.
- **`enable`**
`boolean` — Whether Meeting Coach with AI is locked.
- **`meeting_questions`**
`object` — Lock settings for meeting questions.
- **`auto_enable_locked`**
`boolean` — Whether automatic meeting questions are locked.
- **`locked`**
`boolean` — Whether meeting questions are locked.
- **`who_can_ask_questions_locked`**
`boolean` — Whether the meeting questions participant scope is locked.
- **`meeting_summary`**
`object` — Lock settings for meeting summaries.
- **`auto_enable_locked`**
`boolean` — Whether automatic meeting summaries are locked.
- **`locked`**
`boolean` — Whether meeting summaries are locked.
- **`who_will_receive_summary_locked`**
`boolean` — Whether the meeting summary recipient scope is locked.
- **`meeting_summary_default_language`**
`object` — Lock settings for the default meeting summary language.
- **`enable`**
`boolean` — Whether the default meeting summary language is locked.
- **`meeting_summary_docs`**
`object` — Lock settings for meeting summary Docs.
- **`enable`**
`boolean` — Whether automatic Zoom Doc creation is locked.
- **`share_with_summary_recipients`**
`boolean` — Whether sharing generated Zoom Docs with meeting summary recipients is locked.
- **`meeting_summary_email_only_mode`**
`boolean` — Whether the meeting\_summary\_email\_only\_mode setting is locked.
- **`meeting_summary_ip_access`**
`object` — Lock settings for meeting summary IP access.
- **`enable`**
`boolean` — Whether meeting summary IP access is locked.
- **`meeting_summary_retention`**
`object` — Lock settings for meeting summary retention.
- **`enable`**
`boolean` — Whether automatic meeting summary deletion is locked.
- **`meeting_summary_template`**
`object` — Lock settings for meeting summary templates.
- **`enable`**
`boolean` — Whether meeting summary templates are locked.
- **`microsoft_365`**
`object` — Lock settings for Microsoft 365 data sources.
- **`enable`**
`boolean` — Whether Microsoft 365 data sources are locked.
- **`my_notes_ai_content_generation`**
`boolean` — Whether the My Notes AI content generation setting is locked.
- **`my_notes_meeting_transcription`**
`boolean` — Whether the My Notes meeting transcription setting is locked.
- **`organization_custom_dictionaries`**
`boolean` — Whether allowing AI to consume the organization's custom dictionaries is locked.
- **`paper_ai_content_generation`**
`boolean` — Whether the Zoom Paper AI content generation and revision setting is locked.
- **`participant_can_request_aic_in_meeting`**
`boolean` — Whether the participant\_can\_request\_aic\_in\_meeting setting is locked.
- **`phone_user_ai_notices`**
`object` — Lock settings for phone user AI notices.
- **`enable`**
`boolean` — Whether phone user AI notices are locked.
- **`remind_me_turn_on_aic`**
`boolean` — Whether the remind\_me\_turn\_on\_aic setting is locked.
- **`remind_me_turn_on_catch_me_up`**
`boolean` — Whether the remind\_me\_turn\_on\_catch\_me\_up setting is locked.
- **`restrict_aic_when_external_user_join_meeting`**
`boolean` — Whether the restrict\_aic\_when\_external\_user\_join\_meeting setting is locked.
- **`restrict_aic_when_restrict_user_join`**
`boolean` — Whether the restrict\_aic\_when\_restrict\_user\_join setting is locked.
- **`restrict_users_from_deleting_ai_companion_assets`**
`boolean` — Whether the restrict\_users\_from\_deleting\_ai\_companion\_assets setting is locked.
- **`restrict_users_from_editing_ai_companion_assets`**
`boolean` — Whether the restrict\_users\_from\_editing\_ai\_companion\_assets setting is locked.
- **`restrict_users_from_joining_ai_enabled_meetings`**
`object` — Lock settings for restrictions on joining AI-enabled meetings.
- **`enable`**
`boolean` — Whether restrictions on joining AI-enabled meetings are locked.
- **`screen_share_ocr`**
`boolean` — Whether the screen\_share\_ocr setting is locked.
- **`sheets_ai_content_generation`**
`boolean` — Whether the Zoom Sheets AI content generation and revision setting is locked.
- **`sheets_ai_formula`**
`boolean` — Whether the Zoom Sheets AI Formula setting is locked.
- **`sheets_ai_function`**
`boolean` — Whether the Zoom Sheets AI Function setting is locked.
- **`sheets_ai_resources`**
`boolean` — Whether the Zoom Sheets AI Resources setting is locked.
- **`show_conversational_ai_companion`**
`object` — Lock settings for the conversational AI companion.
- **`delete_ai_conversation`**
`boolean` — Whether automatic AI conversation deletion is locked.
- **`delete_ai_conversation_time`**
`boolean` — Whether the AI conversation retention period is locked.
- **`enable_zoom_mate`**
`boolean` — Whether ZoomMate availability is locked.
- **`enabled`**
`boolean` — Whether conversational AI is locked.
- **`slides_ai_content_generation`**
`boolean` — Whether the Zoom Slides AI content generation and revision setting is locked.
- **`smart_recording`**
`object` — Lock settings for Smart Recording.
- **`enable`**
`boolean` — Whether the Smart Recording is locked.
- **`task_creation_and_management`**
`object` — Lock settings for task creation and management with AI.
- **`enable`**
`boolean` — Whether task creation and management with AI is locked.
- **`third_party_app_tasks`**
`boolean` — Whether allowing AI to perform tasks in third-party apps is locked.
- **`third_party_meeting_join`**
`object` — Lock settings for third-party meeting join with AI.
- **`allow_recording`**
`boolean` — Whether recording for joined third-party meetings is locked.
- **`calendar`**
`object` — Lock settings for calendar-based third-party meeting join.
- **`enable`**
`boolean` — Whether calendar-based third-party meeting join is locked.
- **`enable`**
`boolean` — Whether third-party meeting join with AI is locked.
- **`pre_meeting_email_notification`**
`object` — Lock settings for pre-meeting email notification.
- **`enable`**
`boolean` — Whether pre-meeting email notification is locked.
- **`web_content`**
`boolean` — Whether Web content as an AI data source is locked.
- **`webinar_questions`**
`object` — 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 setting is locked.
- **`auto_enable`**
`boolean` — Whether automatically allowing access when the webinar starts is locked.
- **`enable`**
`boolean` — Whether allowing users to ask webinar questions with AI is locked.
- **`who_can_ask_questions`**
`boolean` — 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.
- **`webinar_summary`**
`object` — 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 setting is locked.
- **`auto_enable`**
`boolean` — Whether turning on webinar summary automatically when the webinar starts is locked.
- **`email_notification`**
`boolean` — Whether sending an email notification when sharing to participants is locked.
- **`enable`**
`boolean` — Whether allowing hosts to generate a summary is locked.
- **`restrict_share_to_outside_of_organization`**
`boolean` — Whether restricting users from sharing summaries to those outside of the organization is locked.
- **`who_will_receive_summary`**
`boolean` — 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.
- **`webinar_summary_follow_up_email`**
`boolean` — 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.
- **`webinar_summary_ocr`**
`boolean` — Whether using screen share content with OCR for webinar summaries is locked.
- **`whiteboard_content_generation`**
`boolean` — Whether Whiteboard content generation with AI is enabled.
- **`workspace_reservation_recommendations_with_ai`**
`object` — Lock settings for Workspace Reservation recommendations with AI.
- **`enabled`**
`boolean` — Whether Workspace Reservation recommendations with AI are locked.
- **`zoom_events_chat_panel`**
`boolean` — Whether the AI chat panel in Zoom Events is locked.
- **`zoom_events_session_summary`**
`object` — Lock settings for Zoom Events session summary.
- **`auto_start`**
`boolean` — Whether turning on session summary automatically when sessions start is locked.
- **`enable`**
`boolean` — Whether Zoom Events session summaries are locked.
- **`audio_conferencing`**
`object`
- **`chat`**
`object`
- **`email_notification`**
`object`
- **`h323sip_conferencing`**
`object`
- **`in_meeting`**
`object`
- **`meeting_security`**
`object`
- **`other_options`**
`object`
- **`recording`**
`object`
- **`schedule_meeting`**
`object`
- **`telephony`**
`object`
- **`tsp`**
`object`
- **`operator`**
`string`, format: `email` — The email address of the user who updated the account's lock settings.
- **`operator_id`**
`string` — The user ID of the user who updated the account's lock settings.
- **`time_stamp`**
`integer` — A timestamp that indicates when the lock setting was updated.
**Example:**
```json
{
"event": "",
"event_ts": 1,
"payload": {
"account_id": "",
"operator": "",
"operator_id": "",
"object": {
"id": "",
"settings": {
"schedule_meeting": {
"audio_type": true,
"embed_password_in_join_link": true,
"enforce_login": true,
"enforce_login_with_domains": true,
"host_video": true,
"join_before_host": true,
"meeting_authentication": true,
"not_store_meeting_topic": false,
"participant_video": true,
"require_password_for_instant_meetings": true,
"require_password_for_pmi_meetings": true,
"require_password_for_scheduling_new_meetings": true,
"use_pmi_for_instant_meetings": true,
"use_pmi_for_scheduled_meetings": true,
"always_display_zoom_webinar_as_topic": false,
"meeting_template": false
},
"in_meeting": {
"alert_guest_join": true,
"allow_users_to_delete_messages_in_meeting_chat": true,
"allow_live_streaming": true,
"allow_show_zoom_windows": true,
"annotation": true,
"anonymous_question_answer": true,
"attention_mode_focus_mode": true,
"auto_answer": true,
"auto_generated_captions": true,
"auto_saving_chat": true,
"breakout_room": true,
"chat": true,
"closed_caption": true,
"co_host": true,
"custom_data_center_regions": true,
"disable_screen_sharing_for_host_meetings": true,
"disable_screen_sharing_for_in_meeting_guests": true,
"dscp_marking": true,
"e2e_encryption": true,
"far_end_camera_control": true,
"feedback": true,
"file_transfer": true,
"full_transcript": true,
"group_hd": true,
"language_interpretation": true,
"sign_language_interpretation": true,
"manual_captions": true,
"meeting_reactions": true,
"webinar_reactions": true,
"meeting_survey": true,
"original_audio": true,
"polling": true,
"post_meeting_feedback": true,
"private_chat": true,
"remote_control": true,
"non_verbal_feedback": true,
"remote_support": true,
"request_permission_to_unmute_participants": true,
"save_caption": true,
"save_captions": true,
"screen_sharing": true,
"sending_default_email_invites": true,
"show_meeting_control_toolbar": true,
"slide_control": true,
"stereo_audio": true,
"use_html_format_email": true,
"virtual_background": true,
"webinar_chat": true,
"webinar_live_streaming": true,
"webinar_polling": true,
"webinar_question_answer": true,
"meeting_question_answer": true,
"webinar_survey": true,
"whiteboard": true
},
"email_notification": {
"alternative_host_reminder": true,
"cancel_meeting_reminder": true,
"cloud_recording_available_reminder": true,
"jbh_reminder": true,
"schedule_for_reminder": true
},
"recording": {
"account_user_access_recording": true,
"auto_delete_cmr": true,
"auto_recording": true,
"cloud_recording": true,
"cloud_recording_download": true,
"host_delete_cloud_recording": true,
"ip_address_access_control": true,
"local_recording": true,
"recording_authentication": true,
"archive": true
},
"telephony": {
"telephony_regions": true,
"third_party_audio": true
},
"audio_conferencing": {
"toll_free_and_fee_based_toll_call": true,
"toll_call": true,
"call_me_and_invite_by_phone": true,
"personal_audio_conference": true,
"participant_phone_masking": true
},
"chat": {
"share_files": true,
"chat_emojis": true,
"record_voice_messages": true,
"record_video_messages": true,
"screen_capture": true,
"share_links_in_chat": true,
"schedule_meetings_in_chat": true,
"allow_users_to_add_contacts": true,
"allow_users_to_chat_with_others": true,
"chat_etiquette_tool": true,
"send_data_to_third_party_archiving_service": true,
"translate_messages": true,
"search_and_send_animated_gif_images": true,
"set_retention_period_in_cloud": true,
"set_retention_period_in_local": true,
"shared_spaces": true,
"allow_create_channels_and_group_chats": true,
"allow_huddles_from_channels": true,
"download_file": true,
"share_screen_in_chat": true,
"chat_email_address": true,
"read_receipts": true,
"allow_delete_message": true,
"allow_edit_message": true,
"presence_on_meeting": true,
"presence_away_when_screen_saver": true,
"ai_summary": true,
"ai_compose": true,
"ai_recommend": true,
"ai_reply": true,
"ai_sentence_completion": true,
"ai_quick_schedule": true,
"survey_poll": true
},
"other_options": {
"blur_snapshot": true,
"webinar_registration_options": true
},
"tsp": {
"call_out": true,
"show_international_numbers_link": true
},
"meeting_security": {
"approved_or_denied_countries_or_regions": true,
"auto_security": true,
"block_user_domain": true,
"chat_etiquette_tool": true,
"embed_password_in_join_link": true,
"encryption_type": true,
"end_to_end_encrypted_meetings": true,
"meeting_password": true,
"only_authenticated_can_join_from_webclient": true,
"phone_password": true,
"pmi_password": true,
"waiting_room": true,
"webinar_password": true
},
"h323sip_conferencing": {
"custom_welcome_audio": {
"enable": true
}
},
"ai": {
"screen_share_ocr": true,
"meeting_chat_messages": true,
"full_display_names_in_ai_assets": true,
"ai_generated_virtual_backgrounds": true,
"meeting_agenda": true,
"meeting_summary_docs": {
"enable": true,
"share_with_summary_recipients": false
},
"phone_user_ai_notices": {
"enable": true
},
"meeting_summary_retention": {
"enable": true
},
"meeting_coach": {
"enable": true
},
"third_party_meeting_join": {
"enable": true,
"allow_recording": true,
"calendar": {
"enable": true
},
"pre_meeting_email_notification": {
"enable": true
}
},
"whiteboard_content_generation": true,
"smart_recording": {
"enable": true
},
"task_creation_and_management": {
"enable": true
},
"show_conversational_ai_companion": {
"enabled": true,
"enable_zoom_mate": true,
"delete_ai_conversation": true,
"delete_ai_conversation_time": true
},
"ai_panel_in_workplace": {
"enabled": true,
"delete_ai_conversation": true,
"delete_ai_conversation_time": true
},
"enable_ai_on_web": true,
"enable_email_compose_with_ai": true,
"microsoft_365": {
"enable": true
},
"google": {
"enable": true
},
"web_content": true,
"local_file_uploads": true,
"organization_custom_dictionaries": true,
"third_party_app_tasks": true,
"workspace_reservation_recommendations_with_ai": {
"enabled": true
},
"participant_can_request_aic_in_meeting": false,
"restrict_aic_when_external_user_join_meeting": false,
"restrict_aic_when_restrict_user_join": false,
"restrict_users_from_joining_ai_enabled_meetings": {
"enable": false
},
"meeting_questions": {
"locked": false,
"auto_enable_locked": false,
"who_can_ask_questions_locked": false
},
"meeting_summary": {
"locked": false,
"auto_enable_locked": false,
"who_will_receive_summary_locked": false
},
"meeting_summary_template": {
"enable": false
},
"meeting_summary_default_language": {
"enable": false
},
"meeting_summary_ip_access": {
"enable": false
},
"remind_me_turn_on_aic": false,
"remind_me_turn_on_catch_me_up": false,
"meeting_summary_email_only_mode": false,
"restrict_users_from_deleting_ai_companion_assets": false,
"restrict_users_from_editing_ai_companion_assets": false,
"webinar_summary_ocr": false,
"zoom_events_session_summary": {
"enable": false,
"auto_start": false
},
"zoom_events_chat_panel": false,
"chat_summary": true,
"chat_compose": true,
"hub_ai_question_and_file_creation": true,
"canvas_ai_content_generation": true,
"canvas_ai_sentence_completion": true,
"canvas_ai_post_meeting_writing_tasks": true,
"paper_ai_content_generation": true,
"sheets_ai_content_generation": true,
"sheets_ai_formula": true,
"sheets_ai_function": true,
"sheets_ai_resources": true,
"slides_ai_content_generation": true,
"my_notes_meeting_transcription": true,
"my_notes_ai_content_generation": true,
"include_webinar_summary_follow_up_email": {
"enable": false
},
"webinar_summary": {
"enable": false,
"auto_enable": false,
"email_notification": false,
"restrict_share_to_outside_of_organization": false,
"who_will_receive_summary": false
},
"webinar_questions": {
"enable": false,
"auto_enable": false,
"who_can_ask_questions": false
}
}
}
},
"time_stamp": 1,
"old_object": {
"id": "",
"settings": {
"schedule_meeting": null,
"in_meeting": null,
"email_notification": null,
"recording": null,
"telephony": null,
"other_options": null,
"audio_conferencing": null,
"chat": null,
"meeting_security": null,
"tsp": null,
"h323sip_conferencing": null,
"ai": {
"screen_share_ocr": true,
"meeting_chat_messages": true,
"full_display_names_in_ai_assets": true,
"ai_generated_virtual_backgrounds": true,
"meeting_agenda": true,
"meeting_summary_docs": {
"enable": true,
"share_with_summary_recipients": false
},
"phone_user_ai_notices": {
"enable": true
},
"meeting_summary_retention": {
"enable": true
},
"meeting_coach": {
"enable": true
},
"third_party_meeting_join": {
"enable": true,
"allow_recording": true,
"calendar": {
"enable": true
},
"pre_meeting_email_notification": {
"enable": true
}
},
"whiteboard_content_generation": true,
"smart_recording": {
"enable": true
},
"task_creation_and_management": {
"enable": true
},
"show_conversational_ai_companion": {
"enabled": true,
"enable_zoom_mate": true,
"delete_ai_conversation": true,
"delete_ai_conversation_time": true
},
"ai_panel_in_workplace": {
"enabled": true,
"delete_ai_conversation": true,
"delete_ai_conversation_time": true
},
"enable_ai_on_web": true,
"enable_email_compose_with_ai": true,
"microsoft_365": {
"enable": true
},
"google": {
"enable": true
},
"web_content": true,
"local_file_uploads": true,
"organization_custom_dictionaries": true,
"third_party_app_tasks": true,
"workspace_reservation_recommendations_with_ai": {
"enabled": true
},
"participant_can_request_aic_in_meeting": false,
"restrict_aic_when_external_user_join_meeting": false,
"restrict_aic_when_restrict_user_join": false,
"restrict_users_from_joining_ai_enabled_meetings": {
"enable": false
},
"meeting_questions": {
"locked": false,
"auto_enable_locked": false,
"who_can_ask_questions_locked": false
},
"meeting_summary": {
"locked": false,
"auto_enable_locked": false,
"who_will_receive_summary_locked": false
},
"meeting_summary_template": {
"enable": false
},
"meeting_summary_default_language": {
"enable": false
},
"meeting_summary_ip_access": {
"enable": false
},
"remind_me_turn_on_aic": false,
"remind_me_turn_on_catch_me_up": false,
"meeting_summary_email_only_mode": false,
"restrict_users_from_deleting_ai_companion_assets": false,
"restrict_users_from_editing_ai_companion_assets": false,
"webinar_summary_ocr": false,
"zoom_events_session_summary": {
"enable": false,
"auto_start": false
},
"zoom_events_chat_panel": false,
"chat_summary": true,
"chat_compose": true,
"hub_ai_question_and_file_creation": true,
"canvas_ai_content_generation": true,
"canvas_ai_sentence_completion": true,
"canvas_ai_post_meeting_writing_tasks": true,
"paper_ai_content_generation": true,
"sheets_ai_content_generation": true,
"sheets_ai_formula": true,
"sheets_ai_function": true,
"sheets_ai_resources": true,
"slides_ai_content_generation": true,
"my_notes_meeting_transcription": true,
"my_notes_ai_content_generation": true,
"include_webinar_summary_follow_up_email": {
"enable": false
},
"webinar_summary": {
"enable": false,
"auto_enable": false,
"email_notification": false,
"restrict_share_to_outside_of_organization": false,
"who_will_receive_summary": false
},
"webinar_questions": {
"enable": false,
"auto_enable": false,
"who_can_ask_questions": false
}
}
}
}
}
}
```
#### Responses
##### Status: 200 Successfully received the webhook event.
### account.disassociated
- **Method:** `POST`
- **Path:** `account.disassociated`
- **Tags:** Accounts
The **Sub Account has been disassociated** event is triggered every time a sub account is [disassociated](/api-reference/zoom-api/ma#operation/accountDisassociate) from a Master account.
An administrator or Zoom account owner can disassociate a sub account from their Master account. To do this in the [Zoom Web Portal](https://zoom.us), click the **Disassociate** button next to the sub account in the [**Account List**](https://zoomdev.us/account/sub/list) interface. To programmatically disassociate a sub account, use the [**Disassociate a sub account**](/api-reference/zoom-api/ma#operation/accountDisassociate) API.
The Master account owner must be you or a user of your [webhook-enabled](https://marketplace.zoom.us/docs/api-reference/webhook-reference#enable-webhooks) app.
## Prerequisites
- A Pro or higher [plan](https://zoom.us/pricing) with the **Master account** option enabled.
- **Event Subscriptions** must be enabled for your [Marketplace app](https://marketplace.zoom.us/user/build) with the following configurations:
- A valid **Event Notification Endpoint URL**.
- The **Sub Account has been disassociated** subscription enabled under the **Account** event.
#### Request Body
##### Content-Type: application/json
- **`event`**
`string` — The name of the event.
- **`event_ts`**
`integer`, format: `int64` — A timestamp at which the event occurred.
- **`payload`**
`object`
- **`account_id`**
`string` — The account ID under which the account was \[disassociated]\(https\://support.zoom.us/hc/en-us/articles/115005269946-Removing-a-user-from-your-account#h\_98a81098-0ca3-45ae-8d00-aab235cc781d).
- **`object`**
`object` — Information about the disassociated account.
- **`id`**
`string` — The account's ID.
- **`owner_email`**
`string`, format: `email` — The account owner's email address.
- **`owner_id`**
`string` — The account owner's ID.
- **`operator`**
`string`, format: `email` — The email address of the user who disassociated the account.
- **`operator_id`**
`string` — The user ID of the user who disassociated the account.
**Example:**
```json
{
"event": "",
"event_ts": 1,
"payload": {
"account_id": "",
"operator": "",
"operator_id": "",
"object": {
"id": "",
"owner_id": "",
"owner_email": ""
}
}
}
```
#### Responses
##### Status: 200 Successfully received the webhook event.
### information\_barriers.policy\_updated
- **Method:** `POST`
- **Path:** `information_barriers.policy_updated`
- **Tags:** Information Barriers
The **Information barriers policy has been updated** event is triggered when using an API or web page to update an [information barrier](https://support.zoom.us/hc/en-us/articles/360040913711-Information-Barriers).
As an account owner or admin can update information barrier policies. Update an information barrier policy either by using the Update an information barriers policy API, or by logging into the [Zoom Web Portal](https://zoom.us) and navigating to the [**information barrier**](https://zoom.us/account/information_barriers) page.
## Prerequisites
- To enable information barriers for yout account, [contact Zoom Support](https://support.zoom.us/hc/en-us/articles/201362003).
#### Request Body
##### Content-Type: application/json
- **`event` (required)**
`string` — The name of the event.
- **`event_ts` (required)**
`integer`, format: `int64` — A timestamp at which the event occurred.
- **`payload` (required)**
`object`
- **`account_id` (required)**
`string` — The account ID of the user who updated the policy.
- **`object` (required)**
`object` — The diff of the \[Information Barrier]\(https\://support.zoom.us/hc/en-us/articles/360040913711-Information-Barriers) policy and its information.
- **`assigned_group_id` (required)**
`string` — The assigner group's (Group 1) ID.
- **`policy_name` (required)**
`string` — The Information Barriers policy's name.
- **`settings` (required)**
`object` — The Information Barriers policy's settings. \* 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. \* 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.
- **`complete_phone_calls` (required)**
`boolean` — If true, users between groups \*\*cannot\*\* call each other.
- **`file_transfer` (required)**
`boolean` — 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\`.
- **`im` (required)**
`boolean` — 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\`.
- **`in_meeting_chat` (required)**
`boolean` — 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\`.
- **`meeting` (required)**
`boolean` — 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.
- **`message_via_sms` (required)**
`boolean` — If true, users between groups \*\*cannot\*\* user SMS.
- **`recording` (required)**
`boolean` — 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\`. This feature is only available for Zoom Client v5.6.0 and higher.
- **`screen_share` (required)**
`boolean` — 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\`.
- **`status` (required)**
`integer`, possible values: `0, 1` — The Information Barriers policy's status: \* \`0\` — Disabled. \* \`1\` — Enabled.
- **`to_group_id` (required)**
`string` — The assignee group's (Group 2) ID.
- **`type` (required)**
`integer`, possible values: `0, 1, 2, 3`, default: `0` — The Information Barriers policy's type of \`settings\` restrictions: \* \`0\` — A \[hard or soft block]\(https\://support.zoom.us/hc/en-us/articles/360040913711-Information-Barriers#h\_a603c6f7-05c8-4de5-b4b6-91982d748b34) exists, but users in Group 1 and Group 2 can chat with each other. \* \`1\` — A \[hard or soft block]\(https\://support.zoom.us/hc/en-us/articles/360040913711-Information-Barriers#h\_a603c6f7-05c8-4de5-b4b6-91982d748b34) exists and only users in Group 1 can chat with users in Group 2. \* \`2\` — No blocks exist, but only users in Group 1 can chat with users in Group 2. \* \`3\` — No blocks exist and users in Group 1 and Group 2 can chat with each other. This field only supports \`0\`.
**Example:**
```json
{
"event": "",
"event_ts": 1,
"payload": {
"account_id": "",
"object": {
"assigned_group_id": "",
"policy_name": "",
"settings": {
"complete_phone_calls": true,
"file_transfer": true,
"im": true,
"in_meeting_chat": true,
"meeting": true,
"message_via_sms": true,
"recording": true,
"screen_share": true
},
"status": 1,
"to_group_id": "mjLMOSAERBaakF8kSDWB7g",
"type": 1
}
}
}
```
#### Responses
##### Status: 200 Successfully received the webhook event.
### account.vanity\_url\_approved
- **Method:** `POST`
- **Path:** `account.vanity_url_approved`
- **Tags:** Accounts
The **Account's vanity url approved** event is triggered each time an account or sub account's [vanity URL](https://support.zoom.us/hc/en-us/articles/215062646) is approved.
## Prerequisites
- A Pro or higher [plan](https://zoom.us/pricing) with the **Master account** option enabled.
- **Event Subscriptions** must be enabled for your [Marketplace app](https://marketplace.zoom.us/user/build) with the following configurations:
- A valid **Event Notification Endpoint URL**
- The **Account's vanity url approved** subscription enabled under the **Account** event.
#### Request Body
##### Content-Type: application/json
- **`event` (required)**
`string` — The name of the event.
- **`event_ts` (required)**
`integer`, format: `int64` — A timestamp at which the event occurred.
- **`payload` (required)**
`object`
- **`account_id` (required)**
`string` — The account ID of the account's owner.
- **`object` (required)**
`object` — Information about the account's approved vanity URL.
- **`id` (required)**
`string` — The account's ID.
- **`vanity_url` (required)**
`string` — The approved \[vanity URL]\(https\://support.zoom.us/hc/en-us/articles/215062646-Guidelines-for-Vanity-URL-requests).
- **`operator` (required)**
`string`, format: `email` — The email address of the user who approved the account's vanity URL.
**Example:**
```json
{
"event": "",
"event_ts": 1,
"payload": {
"account_id": "",
"operator": "",
"object": {
"id": "",
"vanity_url": ""
}
}
}
```
#### Responses
##### Status: 200 Successfully received the webhook event.
### account.settings\_updated
- **Method:** `POST`
- **Path:** `account.settings_updated`
- **Tags:** Accounts
Zoom triggers this event when an account or a sub account's [settings](https://zoom.us/account/setting) are updated. The account must belong either to you or a user of your [webhook-enabled](https://marketplace.zoom.us/docs/api-reference/webhook-reference#enable-webhooks) app.
## Prerequisites
- A Pro or higher plan.
- **Event Subscriptions** must be enabled for your [Marketplace app](https://marketplace.zoom.us/user/build) with the following configurations:
- A valid **Event Notification Endpoint URL**
- The "**Account/Sub Account's setting has been updated**" subscription enabled under the **Account** event.
#### Request Body
##### Content-Type: application/json
- **`event`**
`string` — The name of the event.
- **`event_ts`**
`integer`, format: `int64` — A timestamp at which the event occurred.
- **`payload`**
`object`
- **`account_id`**
`string` — The account ID of the account's owner.
- **`object`**
`object` — Information about the updated fields.
- **`id`**
`string` — The updated account's ID.
- **`settings`**
`object` — Information about the account's updated settings.
- **`ai`**
`object` — Workspace Reservation recommendations with AI.
- **`ai_generated_virtual_backgrounds`**
`boolean` — Whether AI-generated virtual backgrounds are enabled.
- **`ai_panel_in_workplace`**
`object` — AI panel in Zoom Workplace settings.
- **`delete_ai_conversation`**
`boolean` — Whether to automatically delete AI conversation history in the AI panel.
- **`delete_ai_conversation_time`**
`integer | null`, possible values: `30, 60, 90, 120` — The number of days after which AI conversation history in the AI panel is automatically deleted. Supported values are 30, 60, 90, and 120.
- **`enabled`**
`boolean` — Whether the AI panel in Zoom Workplace is enabled.
- **`canvas_ai_content_generation`**
`boolean` — 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.
- **`canvas_ai_post_meeting_writing_tasks`**
`boolean` — Whether AI can identify post-meeting writing tasks from meeting context and generate drafts that users can review and use.
- **`canvas_ai_sentence_completion`**
`boolean` — Whether users can receive predictive writing suggestions while writing in Canvas.
- **`chat_compose`**
`object` — Allow users to use AI to help them compose a response from scratch or wordsmith their chat messages.
- **`enable`**
`boolean` — Compose with AI Companion
- **`shown_in_team_chat`**
`boolean` — Show in Team Chat
- **`chat_summary`**
`object` — Allow users to summarize chats, channels, and shared documents.
- **`enable`**
`boolean` — Summarize with AI Companion
- **`shown_in_team_chat`**
`boolean` — Show in Team Chat
- **`enable_ai_on_web`**
`boolean` — Whether Zoom AI on the web is enabled.
- **`enable_email_compose_with_ai`**
`boolean` — Whether users can use AI to compose or wordsmith email responses in Zoom Mail.
- **`full_display_names_in_ai_assets`**
`boolean` — Whether AI-generated meeting assets use full display names.
- **`google`**
`object` — Settings for Google data sources.
- **`calendar_events`**
`boolean` — Whether Google Calendar events accessible to the user can be used as a data source for AI.
- **`documents`**
`boolean` — Whether Google Drive documents accessible to the user can be used as a data source for AI.
- **`emails`**
`boolean` — Whether Gmail emails accessible to the user can be used as a data source for AI.
- **`enable`**
`boolean` — Whether Google data sources can be used as data sources for AI.
- **`hub_ai_question_and_file_creation`**
`boolean` — 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.
- **`include_webinar_summary_follow_up_email`**
`object` — Webinar follow-up email. When enabled, the host can include the webinar summary in follow-up emails.
- **`absentee_follow_up_email`**
`boolean` — Whether the webinar summary is included in the absentee follow-up email.
- **`attendee_follow_up_email`**
`boolean` — Whether the webinar summary is included in the attendee follow-up email.
- **`enable`**
`boolean` — Whether the host can include the webinar summary in follow-up email.
- **`local_file_uploads`**
`boolean` — Whether files uploaded by users can be used as a data source for AI by the users who uploaded them.
- **`meeting_agenda`**
`boolean` — Whether Meeting Agenda with AI is enabled.
- **`meeting_chat_messages`**
`boolean` — Whether meeting chat messages are used to enhance transcripts.
- **`meeting_coach`**
`object` — Meeting Coach with AI.
- **`enable`**
`boolean` — Whether Meeting Coach with AI is enabled.
- **`participant_scope`**
`string`, possible values: `"all_participants_and_invitees", "participants_and_invitees_in_our_organization"` — Which participants Meeting Coach applies to.
- **`meeting_questions`**
`object` — Allow users to ask questions in a meeting with AI. Answers are based on what is said in the meeting.
- **`auto_enable`**
`boolean` — Automatically start meeting questions when the meeting starts.
- **`enable`**
`boolean` — Whether users can ask questions in a meeting with AI.
- **`who_can_ask_questions`**
`string`, possible values: `"from_entire_meeting", "from_join_meeting", "host", "org", "org_from_join_meeting"` — Participants allowed to ask meeting questions. Valid values: \`from\_entire\_meeting\` (all participants and invitees), \`from\_join\_meeting\` (all participants from when they join), \`host\` (only the meeting host), \`org\` (participants and invitees in the organization), \`org\_from\_join\_meeting\` (organization participants from when they join).
- **`meeting_summary`**
`object` — Allow hosts to generate a summary. Summaries are sent based on sharing permissions after the meeting ends.
- **`auto_enable`**
`boolean` — Auto-start the meeting summary when the meeting starts.
- **`email_notification`**
`boolean` — Send an email notification when sharing a meeting summary with participants.
- **`enable`**
`boolean` — Whether hosts can generate a meeting summary.
- **`restrict_share_to_outside_of_organization`**
`boolean` — Restrict users from sharing meeting summaries with people outside the organization.
- **`restrict_summary_share`**
`string`, possible values: `"external_users", "all_users", "all_users_except_delegate"` — Audience restricted from sharing meeting summaries. Valid values: \`external\_users\` (users outside the organization), \`all\_users\` (all users), \`all\_users\_except\_delegate\` (all users except delegates).
- **`whether_include_full_text_in_email`**
`string`, possible values: `"include_full_text_in_email", "not_include_full_text_in_email"` — Whether the meeting summary email includes summary text. Valid values: \`include\_full\_text\_in\_email\` (include the summary text), \`not\_include\_full\_text\_in\_email\` (do not include the summary text).
- **`who_will_receive_summary`**
`string`, possible values: `"host", "alt_host", "organization", "all", "host_and_panelist_in_organization", "host_and_panelist_not_in_organization", "host_and_speakers", "do_not_share"` — Recipients for automatically shared meeting summaries. Valid values: \`host\` (only the meeting host), \`alt\_host\` (meeting host, co-hosts, and alternative hosts), \`organization\` (meeting host and invitees in the organization), \`all\` (all meeting invitees, including external invitees), \`host\_and\_panelist\_in\_organization\` (meeting host and participants in the organization), \`host\_and\_panelist\_not\_in\_organization\` (meeting host and all participants, including external participants), \`host\_and\_speakers\` (meeting host and speakers), \`do\_not\_share\` (do not share a summary).
- **`meeting_summary_default_language`**
`object` — Set the default language for meeting summaries.
- **`enable`**
`boolean` — Whether meeting summaries automatically use the selected default language.
- **`language`**
`string` — Language that meeting summaries automatically use when the default-language setting is enabled. 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).
- **`meeting_summary_docs`**
`object` — Automatic Zoom Doc creation from meeting summary.
- **`enable`**
`boolean` — Whether automatic Zoom Doc creation is enabled.
- **`share_with_summary_recipients`**
`boolean` — Whether generated Zoom Docs are shared with meeting summary recipients.
- **`meeting_summary_email_only_mode`**
`boolean` — Only share meeting summaries by email. Users cannot view or edit summaries in the Zoom client or web portal because the meeting summary is not retained.
- **`meeting_summary_ip_access`**
`object` — Allow meeting summary access only from specific IP address ranges.
- **`enable`**
`boolean` — Whether access to meeting summaries is restricted to specified IP address ranges.
- **`ip_addresses_or_ranges`**
`string` — IP addresses or ranges from which meeting summaries can be accessed.
- **`meeting_summary_personal_data_redaction`**
`object` — Personal data redaction for meeting summaries.
- **`enable`**
`boolean` — Whether personal data redaction is enabled.
- **`personal_data_types`**
`array` — Personal data types to redact.
**Items:**
`string`, possible values: `"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"`
- **`meeting_summary_retention`**
`object` — Automatic meeting summary deletion.
- **`enable`**
`boolean` — Whether automatic meeting summary deletion is enabled.
- **`retention_days`**
`integer` — Number of days to retain meeting summaries before deletion.
- **`meeting_summary_sensitive_data_filter`**
`object` — Sensitive data filter for meeting summaries.
- **`enable`**
`boolean` — Whether the sensitive data filter is enabled.
- **`rules`**
`array` — Sensitive data filter rules.
**Items:**
- **`name`**
`string` — Rule display name.
- **`regular_expression`**
`string` — RE2J regular expression.
- **`meeting_summary_template`**
`object` — Allow users to select a meeting summary template for their meetings. The summary is generated using the selected template.
- **`enable`**
`boolean` — Whether users can select a meeting summary template for their meetings.
- **`summary_template_id`**
`string` — ID of the default meeting summary template used to generate meeting summaries.
- **`microsoft_365`**
`object` — Settings for Microsoft 365 data sources.
- **`calendar_events`**
`boolean` — Whether Microsoft Outlook calendar events accessible to the user can be used as a data source for AI.
- **`documents`**
`boolean` — Whether Office 365 documents accessible to the user can be used as a data source for AI.
- **`emails`**
`boolean` — Whether Microsoft Outlook emails accessible to the user can be used as a data source for AI.
- **`enable`**
`boolean` — Whether Microsoft 365 data sources can be used as data sources for AI.
- **`my_notes_ai_content_generation`**
`object` — My Notes AI content generation settings.
- **`auto_generate_summary`**
`boolean` — Whether My Notes automatically generates a summary when a note is completed.
- **`auto_send_summary_email`**
`boolean` — Whether My Notes automatically sends a summary email when a note summary is generated.
- **`enable`**
`boolean` — Whether users can use AI to generate content in My Notes and enrich their writing with the meeting transcript.
- **`my_notes_meeting_transcription`**
`boolean` — Whether users can transcribe their meetings with My Notes.
- **`organization_custom_dictionaries`**
`boolean` — Whether AI can consume the organization's custom dictionaries.
- **`paper_ai_content_generation`**
`boolean` — 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.
- **`participant_can_request_aic_in_meeting`**
`boolean` — Allow participants to request AI Companion in a meeting.
- **`phone_user_ai_notices`**
`object` — Phone user AI notices.
- **`enable`**
`boolean` — Whether phone user AI notices are enabled.
- **`multiple_notifications`**
`boolean` — Whether multiple notifications are allowed.
- **`require_press_1_consent`**
`boolean` — Whether callers must press 1 to consent.
- **`remind_me_turn_on_aic`**
`boolean` — Remind hosts to turn on Zoom AI at the beginning of a meeting when AI features are not configured to auto-start.
- **`remind_me_turn_on_catch_me_up`**
`boolean` — When joining a meeting late, prompt the user to use Zoom AI to summarize what has been discussed so far.
- **`restrict_aic_when_external_user_join_meeting`**
`boolean` — Restrict AI Companion when an external user joins a meeting.
- **`restrict_users_from_deleting_ai_companion_assets`**
`boolean` — Restrict users from deleting meeting assets generated by AI. When enabled, only admins can delete those assets.
- **`restrict_users_from_editing_ai_companion_assets`**
`boolean` — Restrict users from editing meeting assets generated by AI. When enabled, only admins can edit those assets.
- **`restrict_users_from_joining_ai_enabled_meetings`**
`object` — Restrict users from joining meetings where AI meeting processing, including meeting questions and meeting summary, is allowed.
- **`apply_scope`**
`string`, possible values: `"internal_only", "external_only", "internal_and_external"` — Meeting scope to which the restriction applies. Valid values: \`internal\_only\` (internal meetings only), \`external\_only\` (external meetings only), \`internal\_and\_external\` (internal and external meetings).
- **`enable`**
`boolean` — Whether restrictions on joining AI-enabled meetings are enabled.
- **`join_notify`**
`string`, possible values: `"out_of_compliance", "notify_and_remove"` — Action to take when a restricted user tries to join an AI-enabled meeting. Valid values: \`out\_of\_compliance\` (notify the user and allow them to remain), \`notify\_and\_remove\` (notify the user and remove them from the meeting).
- **`screen_share_ocr`**
`boolean` — Whether screen share content is used with OCR.
- **`sheets_ai_content_generation`**
`boolean` — 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.
- **`sheets_ai_formula`**
`boolean` — Whether AI can generate, explain, and apply spreadsheet formulas from natural-language input in Zoom Sheets.
- **`sheets_ai_function`**
`boolean` — Whether users can use the =AI() function in Zoom Sheets to generate, summarize, categorize, and analyze data.
- **`sheets_ai_resources`**
`boolean` — Whether users can add resources, such as meetings, docs, and data tables, to a spreadsheet and have AI suggest updates when they change.
- **`show_conversational_ai_companion`**
`object` — Show conversational AI companion settings.
- **`delete_ai_conversation`**
`boolean` — Whether to automatically delete AI conversation history.
- **`delete_ai_conversation_time`**
`integer | null`, possible values: `30, 60, 90, 120` — The number of days after which AI conversation history is automatically deleted. Supported values are 30, 60, 90, and 120.
- **`enable_zoom_mate`**
`boolean` — Whether ZoomMate is available in the web navigation and Zoom Workplace app navigation bar.
- **`enabled`**
`boolean` — Whether conversational AI is enabled.
- **`slides_ai_content_generation`**
`boolean` — 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.
- **`smart_recording`**
`object` — Smart Recording
- **`create_next_steps`**
`boolean` — Next steps
- **`create_recording_highlights`**
`boolean` — Recording highlights
- **`create_smart_chapters`**
`boolean` — Summary and smart chapters
- **`task_creation_and_management`**
`object` — AI-powered task creation and management with AI Companion.
- **`auto_generate_action`**
`boolean` — Whether to automatically generate action items from tasks.
- **`auto_generate_details`**
`boolean` — Whether to automatically generate task details.
- **`enable`**
`boolean` — Whether AI-powered task creation and management is enabled.
- **`generate_from_phone_call`**
`object` — Settings for generating tasks from phone calls.
- **`auto_add_participant_as_collaborator`**
`boolean` — Whether to automatically add phone call participants as task collaborators.
- **`auto_assign_to_collaborator`**
`boolean` — Whether to automatically assign phone call tasks to collaborators.
- **`enable`**
`boolean` — Whether to allow generating tasks from phone calls.
- **`generate_from_transcripts`**
`object` — Settings for generating tasks from meeting transcripts.
- **`auto_assign_to_collaborator`**
`boolean` — Whether to automatically assign tasks to collaborators.
- **`auto_share_with`**
`string`, possible values: `"host_only", "internal_participants", "internal_assigned_participants"` — Defines who tasks are automatically shared with when generated from transcripts.
- **`enable`**
`boolean` — Whether to allow generating tasks from meeting transcripts.
- **`generate_from_voicemail`**
`boolean` — Whether to allow generating tasks from voicemail.
- **`third_party_app_tasks`**
`boolean` — Whether AI can perform tasks on the user's behalf in third-party apps configured within AI Studio.
- **`third_party_meeting_join`**
`object` — Third-party meeting join with AI.
- **`allow_recording`**
`boolean` — Whether recording is enabled for joined third-party meetings.
- **`calendar`**
`object` — Calendar-based third-party meeting join.
- **`enable`**
`boolean` — Whether calendar-based third-party meeting join is enabled.
- **`join_scope`**
`string`, possible values: `"all_events_with_video_conference_links", "meetings_where_i_am_the_host", "meetings_where_i_am_a_participant"` — Which calendar events third-party meeting join applies to.
- **`enable`**
`boolean` — Whether third-party meeting join with AI is enabled.
- **`pre_meeting_email_notification`**
`object` — Pre-meeting email notification.
- **`enable`**
`boolean` — Whether pre-meeting email notification is enabled.
- **`recipients`**
`string`, possible values: `"all_invitees", "only_meeting_host"` — Who receives the pre-meeting email notification.
- **`web_content`**
`boolean` — Whether public web content can be used as a data source for AI.
- **`webinar_questions`**
`object` — During the webinar, answers are based on speech-to-text data. If a transcript is retained, participants with access will be able to ask questions after the webinar based on that transcript.
- **`auto_enable`**
`boolean` — Whether to automatically allow access when the webinar starts.
- **`enable`**
`boolean` — Whether to allow users to ask webinar questions with AI.
- **`who_can_ask_questions`**
`string`, possible values: `"panelist_all", "panelist_org", "host", "all_participants"` — Who can ask questions about the webinar. Valid values: \`panelist\_all\` (Hosts and all panelists), \`panelist\_org\` (Hosts and all panelists in our organization), \`host\` (Only webinar host, co-hosts, and alternative hosts), \`all\_participants\` (All participants).
- **`webinar_summary`**
`object` — Allow hosts to generate a summary. Summaries are sent after the webinar has ended based on sharing permissions.
- **`auto_enable`**
`boolean` — Whether to turn on webinar summary automatically when the webinar starts.
- **`email_notification`**
`boolean` — Whether to send an email notification when sharing to participants.
- **`enable`**
`boolean` — Whether to allow hosts to generate a summary.
- **`restrict_share_to_outside_of_organization`**
`boolean` — Whether to restrict users from sharing summaries to those outside of the organization.
- **`restrict_summary_share`**
`string`, possible values: `"external_users", "all_users", "all_users_except_delegate"` — Whether to 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).
- **`whether_include_full_text_in_email`**
`string`, possible values: `"include_full_text_in_email", "not_include_full_text_in_email"` — 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).
- **`who_will_receive_summary`**
`string`, possible values: `"host", "host_and_panelist_in_organization", "host_and_panelist_not_in_organization"` — 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 our organization), \`host\_and\_panelist\_not\_in\_organization\` (Webinar host, co-hosts, and all panelists, including those outside our organization).
- **`webinar_summary_follow_up_email`**
`boolean` — Whether webinar summaries are included in webinar follow-up email. Deprecated. Use \`include\_webinar\_summary\_follow\_up\_email\`.
- **`webinar_summary_ocr`**
`boolean` — 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.
- **`whiteboard_content_generation`**
`boolean` — Whether Whiteboard content generation with AI is enabled.
- **`workspace_reservation_recommendations_with_ai`**
`object` — Workspace Reservation recommendations with AI.
- **`custom_workspaces_recommendation`**
`boolean` — Whether custom workspace recommendations are enabled.
- **`day_recommendation`**
`boolean` — Whether day recommendations are enabled.
- **`desk_recommendation`**
`boolean` — Whether desk recommendations are enabled.
- **`enabled`**
`boolean` — Whether Workspace Reservation recommendations with AI are enabled.
- **`proactive_room_recommendation`**
`boolean` — Whether proactive room recommendations are enabled.
- **`room_recommendation`**
`boolean` — Whether room recommendations are enabled.
- **`zoom_events_analytics`**
`boolean` — Whether Zoom Events AI Analytics is enabled. AI can analyze event engagement and uncover key moments, topics of interest, and actionable insights.
- **`zoom_events_chat_compose`**
`boolean` — Whether Zoom Events Chat Compose is enabled. AI helps users compose a response from scratch or wordsmith their chat messages.
- **`zoom_events_chat_panel`**
`boolean` — 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.
- **`zoom_events_content_generation`**
`boolean` — Whether Zoom Events Content Generation with AI is enabled. AI content generation helps users create blogs, ebooks, whitepapers, emails, highlights, and sales briefs.
- **`zoom_events_content_studio`**
`boolean` — Whether Content Studio is enabled. Content Studio can turn recordings into high-quality content such as video clips, emails, and blog posts.
- **`zoom_events_email_compose`**
`boolean` — Whether Zoom Events Email Compose with AI is enabled. AI can compose emails and subject lines for events in the Email Builder.
- **`zoom_events_image_generation`**
`boolean` — Whether the Zoom Events image generator is enabled. AI can create images for use in an event.
- **`zoom_events_session_summary`**
`object` — Session summary. Allow hosts to generate a summary. Summaries are sent after the session has ended based on the in-session access options.
- **`auto_start`**
`boolean` — Whether to turn on session summary automatically when sessions start.
- **`enable`**
`boolean` — Whether Zoom Events session summaries are enabled.
- **`zoom_events_smart_compose`**
`boolean` — 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.
- **`zoom_events_smart_upload`**
`boolean` — Whether Zoom Events Smart Upload is enabled. AI can ingest files to quickly create event content such as speaker biographies.
- **`audio_conferencing`**
`object` — The account's audio conference settings.
- **`call_me_and_invite_by_phone`**
`object` — 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.
- **`allow_webinar_attendees_call_me`**
`boolean` — Whether webinar attendees can use Call Me to connect audio. This feature is only available in version 5.2.2 and higher.
- **`call_out_countries`**
`object` — The account's call out countries/regions settings.
- **`selected_countries`**
`array` — The list of countries/regions that users can call out to.
**Items:**
- **`code`**
`string` — The \[code]\(https\://developers.zoom.us/docs/api/rest/other-references/abbreviation-lists/#countries) of the country or region.
- **`name`**
`string` — The name of the country or region.
- **`enable`**
`boolean` — 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.
- **`require_press_1_for_call_me`**
`string`, possible values: `"auto", "always", "never"` — Require Call Me users to press 1 before being connected to the meeting. \* \`auto\` - Automatically determine whether to require pressing 1 before connecting to the meeting. \* \`always\` - Always require Call Me users to press 1 before connecting to the meeting. \* \`never\` - Never require Call Me users to press 1 before connecting to the meeting.
- **`global_dial_in_countries`**
`object` — The account's \[\*\*Global Dial-in Countries/Regions\*\*]\(https\://support.zoom.com/hc/en/article?id=zm\_kb\&sysparm\_article=KB0068094#h\_01F5KK9J31ZXNW10BRH86NHX4G) settings.
- **`include_toll_free`**
`boolean` — Whether to include toll-free numbers in the email invitation for the selected countries/regions.
- **`selected_countries`**
`array` — The list of selected countries/regions whose dial-in numbers will be listed in the email invitation.
**Items:**
- **`code`**
`string` — The \[code]\(https\://developers.zoom.us/docs/api/rest/other-references/abbreviation-lists/#countries) of the country or region.
- **`name`**
`string` — The name of the country or region.
- **`participant_phone_masking`**
`object` — 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.
- **`enable`**
`boolean` — 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.
- **`masking_type`**
`string`, possible values: `"mask_default", "mask_first_5", "mask_except_last_4"` — The type of phone number masking pattern to apply. \* \`mask\_default\` - Default masking pattern (Example: 888\*\*\*\*666). \* \`mask\_first\_5\` - Mask first five digits (Example: \*\*\*\*\*66666). \* \`mask\_except\_last\_4\` - Mask everything except last four digits (Example: \*\*\*\*\*6666).
- **`personal_audio_conference`**
`boolean` — 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.
- **`toll_call`**
`object` — The account's \[\*\*Toll Call\*\*]\(https\://support.zoom.com/hc/en/article?id=zm\_kb\&sysparm\_article=KB0066909#h\_01F51680NJ7YHZDXGJNSKDGM2P) settings.
- **`enable`**
`boolean` — Whether the account has the \[\*\*Toll Call\*\*]\(https\://support.zoom.com/hc/en/article?id=zm\_kb\&sysparm\_article=KB0066909#h\_01F51680NJ7YHZDXGJNSKDGM2P) setting enabled.
- **`numbers`**
`array` — The account's \*\*Toll Call\*\* phone number information.
**Items:**
- **`code`**
`string` — The phone number's \[E.164 country calling code]\(https\://en.wikipedia.org/wiki/List\_of\_country\_calling\_codes).
- **`country_code`**
`string` — The phone number's two-letter \[country code]\(https\://developers.zoom.us/docs/api/rest/other-references/abbreviation-lists/#countries).
- **`country_name`**
`string` — The country name.
- **`display_number`**
`string` — The phone number's display number.
- **`number`**
`string` — The phone number.
- **`toll_free_and_fee_based_toll_call`**
`object` — 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.
- **`allow_webinar_attendees_dial`**
`boolean` — 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.
- **`enable`**
`boolean` — 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.
- **`numbers`**
`array` — The account's phone numbers.
**Items:**
- **`code`**
`string` — The phone number's \[E.164 country calling code]\(https\://en.wikipedia.org/wiki/List\_of\_country\_calling\_codes).
- **`country_code`**
`string` — The phone number's \[country code]\(https\://marketplace.zoom.us/docs/api-reference/other-references/abbreviation-lists#countries).
- **`country_name`**
`string` — The country name.
- **`display_number`**
`string` — The phone number's display number.
- **`number`**
`string` — The phone number.
- **`chat`**
`object` — The account's chat settings.
- **`ai_compose`**
`object` — Allow users to summarize chats, channels, and shared documents.
- **`enable`**
`boolean` — Compose with AI Companion
- **`shown_in_team_chat`**
`boolean` — Show in Team Chat
- **`ai_quick_reply`**
`boolean` — Quick reply with AI Companion
- **`ai_quick_schedule`**
`boolean` — Quick schedule with AI Companion
- **`ai_recommend`**
`boolean` — Chat Recommendation with Zoom AI Companion
- **`ai_sentence_completion`**
`boolean` — Sentence completion with AI Companion
- **`ai_summary`**
`object` — Allow users to summarize chats, channels, and shared documents.
- **`enable`**
`boolean` — Summarize with AI Companion
- **`shown_in_team_chat`**
`boolean` — Show in Team Chat
- **`allow_bots_chat`**
`boolean` — Whether chatbots added to chats and channels can read and write messages.
- **`allow_delete_message`**
`object` — 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.
- **`enable`**
`boolean` — Allow users to delete messages
- **`time`**
`integer`, possible values: `0, 5, 30, 60, 1440, 10080` — Within how many minitues of posting
- **`allow_edit_message`**
`object` — 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.
- **`enable`**
`boolean` — Allow users to edit messages
- **`time`**
`integer`, possible values: `0, 5, 30, 60, 1440, 10080` — Within how many minitues of posting
- **`allow_huddles_from_channels`**
`boolean` — Allow huddles from channels
- **`allow_remove_msg_by_owner_and_admins`**
`boolean` — Allow channel owner and admin(s) to remove messages of other members
- **`allow_users_to_add_contacts`**
`object` — Allow users to add contacts.
- **`enable`**
`boolean` — By disabling this setting, users will not be able to add contacts.
- **`selected_option`**
`integer`, possible values: `1, 2, 3, 4` — The type of allowing users to add contacts: \* 1 — Anyone (internal and external contacts). \* 2 — In the same organization. \* 3 — In the same organization and specified domains. \* 4 — In the same organization and specified users.
- **`user_email_addresses`**
`string` — The domains or emails (internal or external). \* 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. \* When the \`selected\_option\` field value is \`4\`, the value is internal or external email addresses. Use a comma to separate multiple emails.
- **`allow_users_to_chat_with_others`**
`object` — Allow users to chat with others.
- **`enable`**
`boolean` — 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.
- **`selected_option`**
`integer`, possible values: `1, 2, 3, 4` — The type of allowing users to add contacts: \* 1 — Anyone (internal and external contacts). \* 2 — In the same organization. \* 3 — In the same organization and specified domains. \* 4 — In the same organization and specified users.
- **`user_email_addresses`**
`string` — The domains or emails (internal or external). \* 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. \* When the \`selected\_option\` field value is \`4\`, the value is internal or external email addresses. Use a comma to separate multiple emails.
- **`apply_local_storage_to_personal_channel`**
`object` — Store personal channel messages on local devices.
- **`enable`**
`boolean` — 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.
- **`retention_period`**
`string` — Delete data after retention period. 'y' - year, 'm' - month, 'd' - day.
- **`chat_email_address`**
`object` — 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.
- **`enable`**
`boolean` — Chat email address
- **`only_allow_specific_domains`**
`boolean` — Only allow emails from specified domains
- **`specific_domains`**
`array`
**Items:**
`string` — Specified domains.
- **`chat_emojis`**
`object` — Chat emojis.
- **`emojis_option`**
`string`, possible values: `"all", "selected"`
- **`enable`**
`boolean` — 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.
- **`chat_etiquette_tool`**
`object` — Information about the \*\*Chat Etiquette Tool\*\*.
- **`enable`**
`boolean` — Whether to enable the \*\*Chat Etiquette Tool\*\*.
- **`policies`**
`array` — Information about the defined \*\*Chat Etiquette Tool\*\* policies.
**Items:**
- **`description`**
`string` — The policy's description.
- **`id`**
`string` — The policy ID.
- **`is_locked`**
`boolean` — Whether the policy is locked by an account-level user. When it is locked, users cannot update the policy.
- **`keywords`**
`array` — A list of defined rule keywords.
**Items:**
`string`
- **`name`**
`string` — The policy name.
- **`regular_expression`**
`string` — The regular expression to match to the content of chat messages.
- **`status`**
`string`, possible values: `"activated", "deactivated"` — The policy's current status. \* \`activated\` — Activated. \* \`deactivated\` — Deactivated.
- **`trigger_action`**
`integer`, possible values: `1, 2` — The policy's trigger action. \* \`1\` — Ask the user to confirm before they send the message. \* \`2\` — Block the user's message.
- **`policy_max_count`**
`integer` — The read-only maximum number of \*\*Chat Etiquette Tool\*\* policies.
- **`code_snippet`**
`boolean` — Send code snippet
- **`create_group_chat`**
`boolean` — Allow users to create group chats.
- **`create_private_channels`**
`boolean` — Allow users to create private channels.
- **`create_public_channels`**
`boolean` — Allow users to create public channels.
- **`download_file`**
`boolean` — Downloading files
- **`external_collab_restrict`**
`object` — Restrict external collaboration in group chats and channels for a select group
- **`enable`**
`boolean` — Restrict external collaboration in group chats and channels for a select group
- **`external_chat`**
`string`, possible values: `"allowed", "not_allowed"` — The type of restrict external collaboration in group chats and channels for a select group \* - Allowed user group \* - Not allowed user group
- **`group_id`**
`string` — The group Id
- **`external_invite_approve`**
`object` — Require admin approval for adding external users in group chats and channels
- **`channel_id`**
`string` — The channel Id
- **`enable`**
`boolean` — Require admin approval for adding external users in group chats and channels
- **`external_account`**
`boolean` — Allow this setting to be edited for specified accounts
- **`selected_option`**
`integer`, possible values: `1, 2` — 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
- **`external_join_approve`**
`object` — Require admin approval for joining external group chats and channels
- **`channel_id`**
`string` — The channel Id
- **`enable`**
`boolean` — Require admin approval for joining external group chats and channels
- **`external_account`**
`boolean` — Allow this setting to be edited for specified accounts
- **`selected_option`**
`integer`, possible values: `1, 2` — The type of requiring admin approval for joining external group chats and channels \* 1 - Send requests directly to all approvers \* 2 - Send requests to a specific channel
- **`external_member_join`**
`object` — Allow members of your organization to join external group chats and channels
- **`enable`**
`boolean` — Allow members of your organization to join external group chats and channels
- **`external_account`**
`boolean` — Allow this setting to be edited for specified accounts
- **`external_user_control`**
`object` — Add external users into group chats and channels
- **`enable`**
`boolean` — Allow to add external users into group chats and channels
- **`external_account`**
`boolean` — Allow this setting to be edited for specified accounts
- **`selected_option`**
`integer`, possible values: `1, 2, 3` — The type of allowing external user control \* 1 - Everyone \* 2 - Only members in your organization, plus specified external accounts \* 3 - Only the account owner and admins
- **`hyper_link`**
`boolean` — Allow hyperlinks in Team Chat
- **`personal_channel`**
`boolean` — Enable Personal Chat
- **`presence_away_when_screen_saver`**
`boolean` — Change my status to away when screen saver begins
- **`presence_on_meeting`**
`boolean` — Change my presence status when I am in a meeting or call
- **`read_receipts`**
`object` — Indicate when messages have been seen by recipients, for chats and channels with less than 20 members.
- **`allow_users_opt_out`**
`boolean` — Allow users to opt out
- **`enable`**
`boolean` — Enable read receipts
- **`record_video_messages`**
`boolean` — 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.
- **`record_voice_messages`**
`boolean` — Allow users to record voice messages that can be sent in direct messages or group conversations.
- **`schedule_meetings_in_chat`**
`boolean` — Schedule a meeting from chat or channel.
- **`screen_capture`**
`boolean` — Allow users to take and send screenshots in direct messages or group conversations.
- **`search_and_send_animated_gif_images`**
`object` — Allow users to search GIF images from GIPHY when they compose messages. See GIPHY's website for more information about content ratings.
- **`enable`**
`boolean` — Whether to allow users to search GIF images from GIPHY when they compose messages.
- **`giphy_content_rating`**
`integer`, possible values: `1, 2, 3, 4` — Set the GIPHY content rating. This feature is only available for Zoom Client v5.11.0 or later.
- **`send_data_to_third_party_archiving_service`**
`object` — Send data to third-party archiving service.
- **`authorized_channel_token`**
`string` — Authorized channel token. It is used when the field \`type\` value is \`smarsh\`.
- **`enable`**
`boolean` — Allow users to send data to third-party archiving service.
- **`passcode`**
`string` — passcode. It is used when the field \`type\` value is \`global\_relay\`.
- **`smtp_delivery_address`**
`string` — SMTP delivery address. It is used when the field \`type\` value is \`global\_relay\`.
- **`type`**
`string`, possible values: `"global_relay", "smarsh"` — The type of global relay. \* \`global\_relay\` — The participant cannot use chat. \* \`smarsh\` — Host and co-hosts only.
- **`user_name`**
`string` — User name. It is used when the field \`type\` value is \`global\_relay\`.
- **`set_chat_as_default_tab`**
`boolean` — Set Team Chat as a default tab for first-time users
- **`set_retention_period_in_cloud`**
`object` — Set retention period for messages and files in Zoom's cloud.
- **`enable`**
`boolean` — 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.
- **`retention_period_of_channels`**
`string` — Delete data in channels after retention period. 'y' - year, 'm' - month, 'd' - day
- **`retention_period_of_direct_messages_and_group_conversation`**
`string` — Delete direct messages and group conversations after retention period. 'y' - year, 'm' - month, 'd' - day
- **`set_retention_period_in_local`**
`object` — Store messages on local devices, excluding personal channel messages.
- **`enable`**
`boolean` — Specify how long your messages are saved on local devices. If this setting is disabled, messages are never deleted locally.
- **`retention_period_of_channels`**
`string` — Delete data in channels after retention period. 'y' - year, 'm' - month, 'd' - day
- **`retention_period_of_direct_messages_and_group_conversation`**
`string` — Delete direct messages and group conversations after retention period. 'y' - year, 'm' - month, 'd' - day
- **`share_files`**
`object` — Users can share files in chats and channels.
- **`enable`**
`boolean` — 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.
- **`restrictions`**
`object` — The restrictions of users can share files in chats and channels
- **`file_restrictions_apply_to`**
`string`, possible values: `"sharing_and_viewing", "sharing"` — Apply restrictions to both sharing and viewing, or only apply to sharing
- **`file_size_restrictions`**
`integer`, possible values: `50, 100, 200, 300, 400, 500` — Maximum file size
- **`file_size_restrictions_for_external`**
`integer`, possible values: `50, 100, 200, 300, 400, 500` — Maximum file size for external users
- **`file_type_restrictions`**
`array` — The restrictions of users can share files in chats and channels
**Items:**
`string`, possible values: `".gz", ".rar", ".zip", ".xls", ".xlsx", ".json", ".png", ".pptx", ".ppt", ".7z", ".xmind", ".pdf", ".pps", ".txt", ".docx", ".doc"` — Specified file type
- **`file_type_restrictions_for_external`**
`array`
**Items:**
`string`, possible values: `".gz", ".rar", ".zip", ".xls", ".xlsx", ".json", ".png", ".pptx", ".ppt", ".7z", ".xmind", ".pdf", ".pps", ".txt", ".docx", ".doc"` — Specified file type
- **`maximum_file_size`**
`boolean` — Whether to restrict file size
- **`only_allow_specific_file_types`**
`boolean` — Only allow specified file types
- **`share_option`**
`string`, possible values: `"disable", "anyone", "account", "organization"` — Allow users of this account to send files in chats and channels.
- **`view_option`**
`string`, possible values: `"anyone", "account", "organization"` — Allow users of this account to view files in chats and channels.
- **`share_links_in_chat`**
`boolean` — Share links to messages and channels in Team Chat.
- **`share_screen_in_chat`**
`boolean` — Share screen in chat
- **`shared_spaces`**
`boolean` — Allow users to create Shared Spaces
- **`show_h323_contact_tab`**
`boolean` — Show H.323 contacts
- **`show_status_to_internal_contact`**
`boolean` — Show status to internal contacts
- **`store_revise_chat`**
`boolean` — Store edited and deleted message revisions
- **`suppress_removal_notification`**
`boolean` — Suppress deleted, deactivated, and reactivated user notice in group chats and channels
- **`suppress_user_group_notification`**
`boolean` — Suppress add and remove user notice in channels
- **`survey_poll`**
`boolean` — Allow users to launch a poll in chats and channels
- **`translate_messages`**
`boolean` — Allow users to translate team chat messages. \[Learn more].(https\://support.zoom.us/hc/en-us/articles/12998089084685)
- **`email_notification`**
`object` — Information about the email notification settings.
- **`alternative_host_reminder`**
`boolean` — Whether to notify when an alternative host is added to or removed from a meeting.
- **`cancel_meeting_reminder`**
`boolean` — Whether to notify the host and participants when a meeting is canceled.
- **`cloud_recording_available_reminder`**
`boolean` — Whether to notify the host when a cloud recording is available.
- **`jbh_reminder`**
`boolean` — Whether to notify the host when participants join the meeting before them.
- **`low_host_count_reminder`**
`boolean` — Whether to notify the user when host licenses are running low.
- **`recording_available_reminder_alternative_hosts`**
`boolean` — Whether to notify any alternative hosts when a cloud recording is available.
- **`recording_available_reminder_schedulers`**
`boolean` — Whether to notify the person who scheduled the meeting or webinar for the host when a cloud recording is available.
- **`schedule_for_reminder`**
`boolean` — Whether to notify the host that there is a meeting is scheduled, rescheduled, or canceled.
- **`feature`**
`object` — Feature
- **`meeting_capacity`**
`integer` — The maximum number of participants a host can have in a single meeting.
- **`general_setting`**
`object` — General settings.
- **`auto_zoom_room_proximity_connect`**
`boolean` — Allow automatic direct sharing and connecting to Zoom Rooms using ultrasonic proximity signal.
- **`show_zoom_room_feature`**
`boolean` — Show "Zoom Room" feature in the Zoom Workplace app.
- **`h323sip_conferencing`**
`object` — The account's H.323/SIP Conferencing settings.
- **`custom_welcome_audio`**
`object` — Information about the custom welcome audio message played to H.323/SIP devices upon joining a Zoom Meeting.
- **`audio_file`**
`string` — The URL for the configured custom audio file.
- **`enable`**
`boolean`, default: `false` — Determines if a custom welcome audio message is played when H.323/SIP devices join a Zoom Meeting.
- **`in_meeting`**
`object` — Information about the in meeting settings.
- **`alert_guest_join`**
`boolean` — Whether to alert when a guest joins a meeting.
- **`allow_host_panelists_to_use_audible_clap`**
`boolean` — Whether to allow host and panelist to use audible clap.
- **`allow_host_to_enable_focus_mode`**
`boolean` — Whether the host can enable \[\*\*Focus Mode\*\*]\(https\://support.zoom.us/hc/en-us/articles/360061113751-Using-focus-mode) when scheduling a meeting.
- **`allow_live_streaming`**
`boolean` — Whether to allow livestreaming.
- **`allow_participants_chat_with`**
`integer`, possible values: `1, 2, 3, 4` — Whether participants can chat with certain groups: \* \`1\` — The participants cannot use chat. \* \`2\` — Host and co-hosts only. \* \`3\` — The participants can chat with other participants publicly. \* \`4\` - The participants can chat with other participants publicly and privately. \*\*Note:\*\* This setting is only available with client versions 5.7.3 and above.
- **`allow_show_zoom_windows`**
`boolean` — Whether to display the Zoom desktop application when sharing access.
- **`allow_users_save_chats`**
`integer`, possible values: `1, 2, 3` — Whether participants can save meeting chats: \* \`1\` — Participants cannot save meeting chats. \* \`2\` — Participants can only save host and co-host meeting chats. \* \`3\` — Participants can save all meeting chats.
- **`allow_users_to_delete_messages_in_meeting_chat`**
`boolean` — If the value of this field is set to \`true\`, allow users to delete messages in the in-meeting chat.
- **`annotation`**
`boolean` — Whether participants can use annotation tools to add information to shared screens.
- **`anonymous_question_answer`**
`boolean` — Whether anonymous Q\&A is enabled in a webinar.
- **`attendee_on_hold`**
`boolean` — Whether hosts can temporarily place an attendee on hold.
- **`attention_mode_focus_mode`**
`boolean` — Whether the \[\*\*Focus Mode\*\*]\(https\://support.zoom.us/hc/en-us/articles/360061113751-Using-focus-mode) feature is enabled. When enabled, this feature only displays the host and co-hosts' video and profile pictures during a meeting.
- **`audio_watermark_by_default`**
`boolean` — Whether to turn on \[audio watermark]\(https\://support.zoom.us/hc/en-us/articles/360021839031-Adding-audio-watermark) by default when scheduling a meeting.
- **`auto_answer`**
`boolean` — Whether users can 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.
- **`auto_saving_chat`**
`boolean` — Whether to automatically save all in-meeting chats.
- **`breakout_room`**
`boolean` — Whether the host can split meeting participants into separate, smaller rooms.
- **`breakout_room_schedule`**
`boolean` — Whether the host can assign participants to breakout rooms when scheduling. This feature is \*\*only\*\* available in version 4.5.0 or higher.
- **`chat`**
`boolean` — Whether meeting participants can use \[in-meeting chat]\(https\://support.zoom.us/hc/en-us/articles/203650445-In-Meeting-Chat).
- **`closed_caption`**
`boolean` — Whether the host can add closed captions.
- **`closed_captioning`**
`object` — The account's closed captioning settings.
- **`auto_transcribing`**
`boolean` — Whether to allow a live transcription service to transcribe meetings.
- **`enable`**
`boolean` — Whether to allow the host to type closed captions or assign a participant or 3rd-party service to provide closed captioning.
- **`save_caption`**
`boolean` — Whether to allow participants to save closed captions or transcripts.
- **`third_party_captioning_service`**
`boolean` — Whether to allow the use of an API token to integrate with 3rd-party closed captioning services.
- **`view_full_transcript`**
`boolean` — Whether to allow the viewing of full transcripts in the in-meeting side panel.
- **`co_host`**
`boolean` — Whether to allow the meeting host to add co-hosts.
- **`custom_data_center_regions`**
`boolean` — Whether custom \[data center regions]\(https\://support.zoom.us/hc/en-us/articles/360042411451-Selecting-data-center-regions-for-hosted-meetings-and-webinars) are enabled for hosting real-time meeting and webinar traffic: \* \`true\` — Enabled. Provide the data center regions in the \`data\_center\_regions\` field. \* \`false\` — Disabled. Only use the default data center regions.
- **`custom_live_streaming_service`**
`boolean` — Whether to allow custom livestreaming.
- **`custom_service_instructions`**
`string` — The custom livestreaming service instructions.
- **`data_center_regions`**
`array` — The user's selected custom data center regions. This field only returns if the \`custom\_data\_center\_regions\` value is \`true\`: \* \`AU\` — Australia. \* \`LA\` — Latin America. \* \`CA\` — Canada. \* \`CN\` — China. \* \`DE\` — Germany. \* \`HK\` — Hong Kong SAR. \* \`IN\` — India. \* \`IE\` — Ireland. \* \`TY\` — Japan. \* \`MX\` — Mexico. \* \`NL\` — Netherlands. \* \`SG\` — Singapore. \* \`US\` — United States.
**Items:**
`string`, possible values: `"AU", "LA", "CA", "CN", "DE", "HK", "IN", "IE", "TY", "MX", "NL", "SG", "US"`
- **`disable_screen_sharing_for_host_meetings`**
`boolean` — Whether the \*\*Disable desktop screen sharing for meetings you host\*\* setting is enabled.
- **`disable_screen_sharing_for_in_meeting_guests`**
`boolean` — Whether the \*\*Disable screen sharing when guests are in the meeting\*\* setting is enabled.
- **`dscp_audio`**
`integer` — The DSCP audio value.
- **`dscp_marking`**
`boolean` — Whether to use DSCP (differentiated services code point) marking.
- **`dscp_video`**
`integer` — The DSCP video value.
- **`e2e_encryption`**
`boolean` — Whether to require \[AES encryption]\(https\://en.wikipedia.org/wiki/Advanced\_Encryption\_Standard) for meetings.
- **`far_end_camera_control`**
`boolean` — Whether another user can take control of camera during a meeting.
- **`feedback`**
`boolean` — Whether users can send feedback to Zoom at the end of the meeting.
- **`file_transfer`**
`boolean` — Whether file sharing via in-meeting chat is enabled.
- **`group_hd`**
`boolean` — Whether higher quality video for the host and participants is enabled.
- **`join_from_desktop`**
`boolean` — Whether participants can join a meeting directly from their desktop browser.
- **`join_from_mobile`**
`boolean` — Whether participants can join a meeting directly from their mobile browser.
- **`language_interpretation`**
`object` — Information about the \[language interpretation]\(https\://support.zoom.us/hc/en-us/articles/360034919791-Using-Language-Interpretation-in-your-meeting-or-webinar) settings.
- **`allow_participants_to_speak_in_listening_channel`**
`boolean` — Whether to allow participants to speak in listening channel.
- **`allow_up_to_25_custom_languages_when_scheduling_meetings`**
`boolean` — Whether to allow up to 25 custom languages when scheduling meetings.
- **`custom_languages`**
`array` — A list of user-defined supported languages.
**Items:**
`string`
- **`enable`**
`boolean` — Whether hosts can assign participants as interpreters to interpret one language into another in real-time.
- **`enable_language_interpretation_by_default`**
`boolean` — Whether enable language interpretation by default.
- **`languages`**
`array`, possible values: `"English", "Chinese", "Japanese", "German", "French", "Russian", "Portuguese", "Spanish", "Korean"` — A list of system-supported languages.
**Items:**
`string`
- **`live_streaming_facebook`**
`boolean` — Whether to allow Facebook livestreaming.
- **`live_streaming_youtube`**
`boolean` — Whether to allow YouTube livestreaming.
- **`meeting_polling`**
`object` — Information about the account's meeting polling settings.
- **`advanced_polls`**
`boolean` — Whether the host can 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.
- **`allow_alternative_host_to_add_edit`**
`boolean` — Whether alternative hosts can add or edit polls and quizzes.
- **`allow_host_to_upload_image`**
`boolean` — Whether to allow host to upload an image for each question.
- **`enable`**
`boolean` — Whether the host can add polls before or during a meeting.
- **`manage_saved_polls_and_quizzes`**
`boolean` — Whether to allow users to manage saved polls and quizzes from Meetings
- **`require_answers_to_be_anonymous`**
`boolean` — Whether to require answers to be anonymous.
- **`meeting_question_answer`**
`boolean` — Allow participants to ask questions for the host and participants to answer.
- **`meeting_reactions`**
`boolean` — 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.
- **`meeting_reactions_emojis`**
`string`, possible values: `"all", "selected"` — Choose from the following meeting reaction options: \* \`all\` — All emojis: Allow meeting participants to use any emoji available in Zoom chat as a reaction in a meeting. \* \`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)
- **`meeting_survey`**
`boolean` — 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.
- **`non_verbal_feedback`**
`boolean`, default: `false` — 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\`.
- **`original_audio`**
`boolean` — Whether users can select original sound in their client settings.
- **`p2p_connetion`**
`boolean` — Whether peer-to-peer connection when only two people are in a meeting is enabled.
- **`p2p_ports`**
`boolean` — Whether a peer-to-peer listening ports range is enabled.
- **`participants_share_simultaneously`**
`string`, possible values: `"multiple", "one"` — Indicates how many participants can screen share at the same time. The value can be one of the following:\
\`one\`: Only one participant can screen share at a time .\
\`multiple\`: Multiple participants can screen share simultaneously (dual monitors recommended).
- **`polling`**
`boolean` — Whether polls are available in the meeting controls.
- **`ports_range`**
`string` — The comma-separated peer-to-peer listening ports range (for example, \`55,56\`), between 1 to 65535.
- **`post_meeting_feedback`**
`boolean` — Whether to display a post-meeting feedback survey at the end of a meeting.
- **`private_chat`**
`boolean` — Whether meeting participants can use private chat.
- **`remote_control`**
`boolean` — Whether users can request remote control.
- **`remote_support`**
`boolean`, default: `false` — Whether to enable the \[\*\*Remote support\*\*]\(https\://support.zoom.us/hc/en-us/articles/360060951012-Enabling-remote-support) setting. This value defaults to \`false\`.
- **`screen_sharing`**
`boolean` — Whether to allow screen sharing.
- **`sending_default_email_invites`**
`boolean` — Whether to display the default email when sending email invites.
- **`show_a_join_from_your_browser_link`**
`boolean` — Whether participants can join a meeting directly from their browser and bypass the Zoom application download process.
- **`show_meeting_control_toolbar`**
`boolean` — Whether to always display the meeting control bar.
- **`sign_language_interpretation`**
`object` — 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.
- **`custom_languages`**
`array` — A list of user-defined supported languages.
**Items:**
`string`
- **`enable`**
`boolean` — Whether to allow hosts to assign participants as sign language interpreters who can interpret one language into another in real-time.
- **`enable_sign_language_interpretation_by_default`**
`boolean` — Whether to enable sign language interpretation view by default in scheduler.
- **`languages`**
`array` — A list of system-supported languages.
**Items:**
`string`, possible values: `"American", "Chinese", "French", "German", "Japanese", "Russian", "Brazilian", "Spanish", "Mexican", "British"`
- **`slide_control`**
`boolean` — 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.
- **`stereo_audio`**
`boolean` — Whether users can select stereo audio in their client settings.
- **`use_html_format_email`**
`boolean` — Whether to use HTML-formatted email for the Outlook plugin.
- **`virtual_background`**
`boolean` — Whether users can change their background.
- **`watermark`**
`boolean` — Whether to add watermark when viewing a shared screen.
- **`watermark_by_default`**
`boolean` — Whether to turn on watermark by default when scheduling a meeting.
- **`webinar_chat`**
`object`
- **`allow_attendees_chat_with`**
`integer`, possible values: `1, 2, 3` — Webinar attendees can chat with: \* \`1\` — No one. \* \`2\` — Host and all panelists. \* \`3\` — Everyone.
- **`allow_auto_save_local_chat_file`**
`boolean` — Whether chat messages are saved automatically to a local file on the host's computer when the webinar ends.
- **`allow_panelists_chat_with`**
`integer`, possible values: `1, 2` — Webinar panelists can chat with: \* \`1\` — Host and all panelists. \* \`2\` — Everyone.
- **`allow_panelists_send_direct_message`**
`boolean` — Whether webinar panelists can send direct messages to other panelists.
- **`allow_users_save_chats`**
`integer`, possible values: `0, 1, 2` — Whether webinar attendees can save chats: \* \`0\` — Attendees cannot save chats. \* \`1\` — Attendees can only save host and panelist chats. \* \`2\` — Attendees can save all chats.
- **`default_attendees_chat_with`**
`integer`, possible values: `1, 2` — By default, webinar attendees can chat with: \* \`1\` — Host and all panelists. \* \`2\` — Everyone.
- **`enable`**
`boolean` — Whether webinar participants can send chat messages.
- **`webinar_live_streaming`**
`object`
- **`custom_service_instructions`**
`string` — The specific instructions that allow the account's meeting hosts to configure a custom livestream.
- **`enable`**
`boolean` — Whether webinar livestreaming is enabled.
- **`live_streaming_reminder`**
`boolean` — Whether to notify users to watch the livestream. This does not apply to custom RTMP (real-time messaging protocol).
- **`live_streaming_service`**
`array` — The available livestreaming services: \* \`facebook\` \* \`workplace\_by\_facebook\` \* \`youtube\` \* \`custom\_live\_streaming\_service\`
**Items:**
`string`, possible values: `"facebook", "workplace_by_facebook", "youtube", "custom_live_streaming_service"`
- **`webinar_polling`**
`object` — Information about the account's webinar polling settings.
- **`advanced_polls`**
`boolean` — Whether the host can 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.
- **`allow_alternative_host_to_add_edit`**
`boolean` — Whether alternative hosts can add or edit polls and quizzes.
- **`allow_host_to_upload_image`**
`boolean` — Whether to allow host to upload an image for each question.
- **`enable`**
`boolean` — Whether the host can add polls before or during a webinar.
- **`manage_saved_polls_and_quizzes`**
`boolean` — Whether to allow users to manage saved polls and quizzes from Meetings
- **`require_answers_to_be_anonymous`**
`boolean` — Whether to require answers to be anonymous.
- **`webinar_question_answer`**
`boolean` — Whether Q\&A is enabled in a webinar.
- **`webinar_reactions`**
`boolean` — Set this field to true to use \[webinar reactions]\(https\://support.zoom.us/hc/en-us/articles/4803536268429).
- **`webinar_survey`**
`boolean` — Whether to allow the host to present surveys to attendees once a webinar has ended.
- **`whiteboard`**
`boolean` — Whether participants can share a whiteboard that includes annotation tools.
- **`who_can_share_screen`**
`string`, possible values: `"host", "all"` — The type of user who can share their screen or content during meetings: \* \`host\` — Only hosts can screen share. \* \`all\` — Both hosts and participants can screen share.
- **`who_can_share_screen_when_someone_is_sharing`**
`string`, possible values: `"host", "all"` — The type of user that can begin sharing their screen when someone else in the meeting is sharing their screen: \* \`host\` — Only hosts can screen share when someone else is sharing. \* \`all\` — Both hosts and participants can screen share when someone else is sharing.
- **`workplace_by_facebook`**
`boolean` — Whether to allow Workplace by Facebook livestreaming.
- **`in_session`**
`object`
- **`custom_data_center_regions`**
`boolean` — Whether to use custom \[data center regions]\(https\://support.zoom.us/hc/en-us/articles/360042411451-Selecting-data-center-regions-for-meetings-webinars): \* \`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. \* \`false\` — Only use the default data center regions.
- **`data_center_regions`**
`array` — 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: \* \`AU\` — Australia. \* \`LA\` — Latin America. \* \`CA\` — Canada. \* \`CN\` — China. \* \`DE\` — Germany. \* \`HK\` — Hong Kong SAR. \* \`IN\` — India. \* \`IE\` — Ireland. \* \`TY\` — Japan. \* \`MX\` — Mexico. \* \`NL\` — Netherlands. \* \`SG\` — Singapore. \* \`US\` — United States.
**Items:**
`string`, possible values: `"AU", "LA", "CA", "CN", "DE", "HK", "IN", "IE", "TY", "MX", "NL", "SG", "US"`
- **`dscp_audio`**
`integer`, default: `56` — The DSCP audio marking value. This value defaults to \`56\`.
- **`dscp_dual`**
`boolean` — Whether to use the differentiated services code point classifiers ('dscp\_video', 'dscp\_audio') in the dual way (incoming and outgoing).
- **`dscp_marking`**
`boolean` — Whether to enable \[differentiated services code point (DSCP)]\(https\://en.wikipedia.org/wiki/Differentiated\_services) marking.
- **`dscp_video`**
`integer`, default: `40` — The DSCP video marking value. This value defaults to \`40\`.
- **`p2p_connetion`**
`boolean` — 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.
- **`p2p_ports`**
`boolean` — Whether to enable the \*\*Listening ports range\*\* setting.
- **`ports_range`**
`string`, default: `""` — 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.
- **`subsession`**
`boolean` — Allow host to split meeting participants into separate, smaller rooms.
- **`integration`**
`object` — Information about integration settings
- **`box`**
`boolean` — Whether users who join a meeting from their mobile device can share content from their Box account.
- **`dropbox`**
`boolean` — Whether users who join a meeting from their mobile device can share content from their Dropbox account.
- **`google_calendar`**
`boolean` — Whether meetings can be scheduled using Google Calendar.
- **`google_drive`**
`boolean` — Whether users who join a meeting from their mobile device can share content from their Google Drive.
- **`kubi`**
`boolean` — Whether users can control a connected Kubi device from within a Zoom meeting.
- **`microsoft_one_drive`**
`boolean` — Whether users who join a meeting from their mobile device can share content from their Microsoft OneDrive account.
- **`mail_calendar`**
`object` — Email and calendar related settings.
- **`email_calendar_management`**
`boolean` — Allow the Zoom client to manage both emails and calendar events for the user.
- **`email_management`**
`boolean` — Allow the Zoom client to manage user emails.
- **`zoom_email_provider`**
`boolean` — Allow users to select Zoom as their email service provider.
- **`meeting_security`**
`object`
- **`auto_security`**
`boolean` — Whether to require that all meetings are secured with at least one security option. This setting can only be disabled by Enterprise, ISV, Business (with more than 100 licenses), and Education accounts.
- **`block_user_domain`**
`boolean` — Whether to block users in specific domains from joining meetings and webinars.
- **`block_user_domain_list`**
`array` — The domain to block, up to 20 domains. For example, the \`\*.example.com\` domain.
**Items:**
`string`
- **`chat_etiquette_tool`**
`object` — Information about the \*\*Chat Etiquette\*\* Tool.
- **`enable`**
`boolean`, default: `false` — Whether to enable the \*\*Chat Etiquette Tool\*\*. This value defaults to \`false\`. The \*\*Chat Etiquette Tool\*\* allows you to define specific keywords and text patterns in chat to prevent users from inadvertently sharing unwanted messages.
- **`policies`**
`array` — Information about the defined \*\*Chat Etiquette Tool\*\* policies.
**Items:**
- **`description`**
`string` — The policy's description.
- **`id`**
`string` — The policy ID.
- **`is_locked`**
`boolean`, default: `false` — Whether to lock the policy. When it is locked, users cannot update the policy. This value defaults to \`false\`.
- **`keywords`**
`array` — A list of defined rule keywords.
**Items:**
`string`
- **`name`**
`string` — The policy name.
- **`regular_expression`**
`string` — The regular expression to match to the content of chat messages.
- **`status`**
`string`, possible values: `"activated", "deactivated"` — The policy's current status: \* \`activated\` — Activated. \* \`deactivated\` — Deactivated.
- **`trigger_action`**
`integer`, possible values: `1, 2` — The policy's trigger action: \* \`1\` — Ask the user to confirm before they send the message. \* \`2\` — Block the user's message.
- **`embed_password_in_join_link`**
`boolean` — Whether the meeting password will be encrypted and included in the invitation link. The provided link will allow participants to join the meeting without having to enter the password.
- **`encryption_type`**
`string`, possible values: `"enhanced_encryption", "e2ee"` — The type of encryption to use when starting a meeting: \* \`enhanced\_encryption\` — Use enhanced encryption. Encryption data is stored in the cloud. \* \`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.
- **`end_to_end_encrypted_meetings`**
`boolean` — Whether to enable end-to-end encryption for meetings. If enabled, you can specify the type of encryption in the \`encryption\_type\` field.
- **`meeting_password`**
`boolean` — Whether all instant and scheduled meetings that users can join via client or Zoom Rooms systems are password-protected. \[Personal Meeting ID (PMI)]\(https\://support.zoom.us/hc/en-us/articles/203276937) meetings are \*\*not\*\* included in this setting.
- **`meeting_password_requirement`**
`object` — Information about the meeting and webinar \[password requirements]\(https\://support.zoom.us/hc/en-us/articles/360033559832-Meeting-and-webinar-passwords#h\_a427384b-e383-4f80-864d-794bf0a37604).
- **`consecutive_characters_length`**
`integer`, possible values: `0, 4, 5, 6, 7, 8` — The maximum length of consecutive characters (for example, \`abcdef\`) allowed in a password: \* \`4\` through \`8\` — The maximum consecutive characters length. The length is \`n\` minus \`1\`, where \`n\` is the provided value. For example, if you provide the \`4\` value, there can only be a maximum of \`3\` consecutive characters in a password (for example, \`abc1x\@8fdh\`). \* \`0\` — Do not apply a consecutive character restriction.
- **`have_letter`**
`boolean` — Whether the password must contain at least one letter character.
- **`have_number`**
`boolean` — Whether the password must contain at least one numeric character.
- **`have_special_character`**
`boolean` — Whether the password must contain at least one special character. For example, \`!\`, \`@\`, and/or \`#\` characters.
- **`have_upper_and_lower_characters`**
`boolean` — Whether the password must include uppercase and lowercase characters.
- **`length`**
`integer` — The password's minimum length.
- **`only_allow_numeric`**
`boolean` — Whether the password must contain \*\*only\*\* numeric characters.
- **`weak_enhance_detection`**
`boolean` — Whether users will be informed when the provided password is weak.
- **`only_authenticated_can_join_from_webclient`**
`boolean` — Whether to specify that only authenticated users can join the meeting from the web client.
- **`phone_password`**
`boolean` — Whether to require a password for participants joining by phone. If enabled and the meeting is password-protected, a numeric password is required for participants to join by phone. For meetings with alphanumeric passwords, a numeric password will be generated.
- **`pmi_password`**
`boolean` — Whether all Personal Meeting ID (PMI) meetings that users can join via client or Zoom Rooms systems are password-protected.
- **`require_password_for_scheduled_meeting`**
`boolean` — Whether to require a password for meetings that have already been scheduled.
- **`require_password_for_scheduled_webinar`**
`boolean` — Whether to require a password for webinars that have already been scheduled.
- **`waiting_room`**
`boolean` — Whether participants are placed in the \[\*\*Waiting Room\*\*]\(https\://support.zoom.us/hc/en-us/articles/115000332726-Waiting-Room) when they join a meeting. 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.
- **`waiting_room_settings`**
`object` — Information about the waiting room settings.
- **`participants_to_place_in_waiting_room`**
`integer`, possible values: `0, 1, 2` — The type of participants to be admitted to the Waiting Room: \* \`0\` — All attendees. \* \`1\` — Users who are not in your account. \* \`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).
- **`users_who_can_admit_participants_from_waiting_room`**
`integer`, possible values: `0, 1` — The users who can admit participants from the Waiting Room: \* \`0\` — Host and co-hosts only. \* \`1\` — Host, co-hosts, and anyone who bypassed the Waiting Room if the host and co-hosts are not present.
- **`whitelisted_domains_for_waiting_room`**
`string` — 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").
- **`webinar_password`**
`boolean` — Whether to generate a password when scheduling webinars. Participants must use the generated password to join the scheduled webinar.
- **`other_options`**
`object`
- **`allow_auto_active_users`**
`boolean` — Whether administrators can activate users with a single default password when they add users. This immediately activates the users without waiting for them to set their own password.
- **`allow_users_contact_support_via_chat`**
`boolean` — Whether to display the Zoom Help badge on the bottom-right of the page.
- **`allow_users_enter_and_share_pronouns`**
`boolean` — Whether users can add pronouns to their profile cards and share them during meetings and webinars.
- **`blur_snapshot`**
`boolean` — Whether iOS blurs the screenshot in the task switcher when multiple apps are open. Android hides the screenshot in the system-level list of recent apps.
- **`display_meetings_scheduled_for_others`**
`boolean` — Whether a user with the \[scheduling privilege]\(https\://support.zoom.us/hc/en-us/articles/201362803-Scheduling-privilege) can view other users' meetings.
- **`meeting_qos_and_mos`**
`integer`, possible values: `0, 1, 2, 3` — The Dashboard meeting \[quality scores and network alerts]\(https\://support.zoom.us/hc/en-us/articles/360061244651) setting: \* \`0\` — Do not enable meeting quality scores and network alerts on the Dashboard. \* \`1\` — Display the meeting quality score and network alerts on the Dashboard. \* \`2\` — Use custom thresholds for quality scores and network alerts. \* \`3\` —Both Use custom thresholds for quality scores and network alerts and Display the meeting quality score and network alerts on the Dashboard.
- **`show_one_user_meeting_on_dashboard`**
`boolean` — Whether meetings with only one person will display on the Dashboard and in reports.
- **`use_cdn`**
`string`, possible values: `"none", "default", "wangsu"` — 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: \* \`none\` — Do not use a CDN. \* \`default\` — Use the Amazon CloudFront CDN for users \*\*except\*\* Chinese Mainland users. Chinese Mainland users will use the Wangsu CDN (China). \* \`wangsu\` — Use the Wangsu CDN for all users.
- **`webinar_registration_options`**
`object` — Webinar registration options.
- **`allow_host_to_enable_social_share_buttons`**
`boolean` — Allow host to enable "Show social share buttons on registration page"
- **`recording`**
`object` — Information about recording settings.
- **`account_user_access_recording`**
`boolean` — Whether cloud recordings are only accessible to account members. People outside of your organization \*\*cannot\*\* open links that provide access to cloud recordings.
- **`allow_recovery_deleted_cloud_recordings`**
`boolean` — Whether the recovery of deleted cloud recordings from the trash is enabled. If enabled, then deleted cloud recordings are kept in the trash for 30 days after deletion. The recordings can be recovered within that period.
- **`archive`**
`object` — Information about the \[archiving solution]\(https\://support.zoom.us/hc/en-us/articles/360050431572-Archiving-Meeting-and-Webinar-data) settings. This is only available if granted archiving solution access by the Zoom support team.
- **`enable`**
`boolean` — Whether the archiving feature is enabled.
- **`settings`**
`object`
- **`action_when_archive_failed`**
`integer`, possible values: `1, 2` — Perform the action when meetings or webinars cannot be archived.\
\`1\` - Participants can stay in the meeting and will receive a notification.\
\`2\` - Nobody can join or stay in the meeting.
- **`archive_retention`**
`integer`, possible values: `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` — The retention period for archiving content, in days.
- **`audio_file`**
`boolean` — Whether to include in-meeting and/or in-webinar audio in the archive.
- **`cc_transcript_file`**
`boolean` — Whether to include closed captions or transcripts in the archive.
- **`chat_file`**
`boolean` — Whether to include in-meeting chat in the archive.
- **`chat_with_direct_message`**
`object` — Include direct message in in-meeting chat file.
- **`chat_with_sender_email`**
`boolean` — Whether to include user emails in the in-meeting chat file.
- **`notification_when_archiving_starts`**
`string`, possible values: `"participants", "guest"` — Show notification when video or audio archiving starts.\
\`1\` - Participants can stay in the meeting and will receive a notification.\
\`2\` - Nobody can join or stay in the meeting.
- **`play_voice_prompt_when_archiving_starts`**
`string`, possible values: `"participants", "guest", "none"` — Play voice prompt when video or audio archiving starts.\
\`1\` - Participants can stay in the meeting and will receive a notification.\
\`2\` - Nobody can join or stay in the meeting.
- **`video_file`**
`boolean` — Whether to include in-meeting and/or in-webinar video in the archive.
- **`type`**
`integer`, possible values: `1, 2, 3` — The archive solution type: \* \`1\` — Only meetings are archived. \* \`2\` — Only webinars are archived. \* \`3\` — Both meetings and webinars are archived.
- **`ask_host_to_confirm_disclaimer`**
`boolean` — Whether to ask the host to confirm the recording disclaimer is enabled.
- **`ask_participants_to_consent_disclaimer`**
`boolean` — Whether to ask participants for consent when a recording begins is enabled. This is only available when the value of the \`recording\_disclaimer\` field is set to \`true\`.
- **`auto_delete_cmr`**
`boolean` — Whether Zoom will permanently delete recordings automatically after a specified number of days is enabled. The number of days is displayed in the \`auto\_delete\_cmr\_days\` field.
- **`auto_delete_cmr_days`**
`integer`, possible values: `30, 60, 90, 120` — When the \`auto\_delete\_cmr\` value is \`true\`, this value is the number of days before the auto-deletion of cloud recordings: \* \`30\` — 30 days. \* \`60\` — 60 days. \* \`90\` — 90 days. \* \`120\` — 120 days.
- **`auto_recording`**
`string` — The automatic recording setting: \* \`local\` — Record locally \* \`cloud\` — Record on the cloud. \* \`none\` — Disabled.
- **`cloud_recording`**
`boolean` — Whether hosts can record and save the meeting in the cloud.
- **`cloud_recording_download`**
`boolean` — Whether cloud recording downloads are enabled.
- **`cloud_recording_download_host`**
`boolean` — Whether only the host can download cloud recordings.
- **`display_participant_name`**
`boolean` — Whether participants' names display in the recording.
- **`host_delete_cloud_recording`**
`boolean` — Whether the host can delete recordings. If this is disabled, the recordings cannot be deleted by the host. Only an administrator can delete the recordings.
- **`host_pause_stop_recording`**
`boolean` — Whether the meeting's host can pause or stop the cloud's auto recording is enabled.
- **`ip_address_access_control`**
`object` — Information about the settings to allow cloud recording access only from specific IP address ranges.
- **`enable`**
`boolean` — Whether the cloud recordings of the account can only be accessed by the IP addresses defined in the \`ip\_addresses\_or\_ranges\` property.
- **`ip_addresses_or_ranges`**
`string` — The IP addresses or ranges that have access to the cloud recordings.
- **`local_recording`**
`boolean` — Whether hosts and participants can record the meeting using a local file.
- **`optimize_recording_for_3rd_party_video_editor`**
`boolean` — Whether recordings will be optimized for a 3rd party video editor. This can increase the file size and the time it takes to generate recording files.
- **`prevent_host_access_recording`**
`boolean` — Whether meeting hosts are prevented from accessing their meeting cloud recordings. Only the administrators with recording management privileges can access them.
- **`record_audio_file`**
`boolean` — Whether recording an audio-only file is enabled.
- **`record_audio_file_each_participant`**
`boolean` — Whether to record separate audio files for each participant is enabled.
- **`record_files_separately`**
`object` — 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.
- **`active_speaker`**
`boolean` — Whether recording only the active speaker is enabled.
- **`gallery_view`**
`boolean` — Whether recording only the gallery view is enabled.
- **`shared_screen`**
`boolean` — Whether recording only the gallery view is enabled.
- **`record_gallery_view`**
`boolean` — Whether recording the \[gallery view]\(https\://support.zoom.us/hc/en-us/articles/360000005883-Displaying-Participants-in-Gallery-View) with a shared screen is enabled.
- **`record_speaker_view`**
`boolean` — Whether recording the active speaker with a shared screen is enabled.
- **`recording_audio_transcript`**
`boolean` — Whether automatically transcribing the audio of the meeting or webinar to the cloud is enabled.
- **`recording_disclaimer`**
`boolean` — Whether to display a disclaimer to participants before a recording begins is enabled.
- **`recording_highlight`**
`boolean` — Whether the \[recording highlights]\(https\://support.zoom.us/hc/en-us/articles/360060802432) feature is enabled.
- **`recording_password_requirement`**
`object` — Information about the minimum password requirements for recordings via the Account Recording settings.
- **`have_letter`**
`boolean` — Whether the password must contain at least one alphabetical letter.
- **`have_number`**
`boolean` — Whether the password must contain at least one numeric character.
- **`have_special_character`**
`boolean` — Whether the password must contain at least one special character (for example, \`!\`, \`@\`, or \`#\`).
- **`length`**
`integer` — The password's minimum required length.
- **`only_allow_numeric`**
`boolean` — Whether the password must contain \*\*only\*\* numeric characters.
- **`recording_thumbnails`**
`boolean` — Whether thumbnails of the presenter are recorded when they are sharing their screen.
- **`save_chat_text`**
`boolean` — Whether saving the chat text from the meeting is enabled.
- **`save_close_caption`**
`boolean` — Whether \[closed captions]\(https\://support.zoom.us/hc/en-us/articles/207279736) are saved as a VTT (Video Track Text) file.
- **`save_panelist_chat`**
`boolean` — Whether panelist chats are saved to the recording.
- **`save_poll_results`**
`boolean` — Whether poll results shared during the meeting or webinar are saved. This also includes poll results shared during the meeting or webinar.
- **`show_timestamp`**
`boolean` — Whether adding a timestamp to the recording is enabled.
- **`smart_recording`**
`object` — 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.
- **`create_next_steps`**
`boolean` — By selecting this option, there will be a summary of actions to take after the recorded meeting.
- **`create_recording_highlights`**
`boolean` — 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.
- **`create_smart_chapters`**
`boolean` — By selecting this option, your recording will have chapters with overview. Hosts can edit the chapters.
- **`schedule_meeting`**
`object` — Information about the schedule meeting settings.
- **`always_display_zoom_meeting_as_topic`**
`object` — 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.
- **`display_topic_for_scheduled_meetings`**
`boolean` — Whether to display "Zoom Meeting" as the topic for already-scheduled meetings.
- **`enable`**
`boolean` — Whether the \*\*Always display "Zoom Meeting" as the meeting topic\*\* setting is enabled.
- **`always_display_zoom_webinar_as_topic`**
`object` — 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.
- **`display_topic_for_scheduled_webinars`**
`boolean` — Whether to display "Zoom Webinar" as the topic for already-scheduled meetings.
- **`enable`**
`boolean` — Whether the \*\*Always show "Zoom Webinar" as the webinar topic\*\* setting is enabled.
- **`audio_type`**
`string` — The type of audio used to join the meeting.
- **`enforce_login`**
`boolean` — Whether only users who are signed in to Zoom can join meetings.
- **`enforce_login_domains`**
`string` — The specified domains for users to sign in to in order to join meetings.
- **`enforce_login_with_domains`**
`boolean` — Whether only users with a specific domain can join meetings.
- **`force_pmi_jbh_password`**
`boolean` — Whether to require a password for personal meetings if attendees can join before host.
- **`hide_meeting_description`**
`object` — Information about the \*\*Hide meeting description\*\* feature.
- **`enable`**
`boolean` — Whether the \*\*Hide meeting description\*\* setting is enabled.
- **`hide_description_for_scheduled_meetings`**
`boolean` — Whether to hide the description for already-scheduled meetings.
- **`hide_webinar_description`**
`object` — Information about the \*\*Hide webinar description\*\* feature.
- **`enable`**
`boolean` — Whether the \*\*Hide webinar description\*\* setting is enabled.
- **`hide_description_for_scheduled_webinars`**
`boolean` — Whether to hide webinar description for the webinars which have already been scheduled.
- **`host_video`**
`boolean` — Whether to start meetings with the host video on.
- **`jbh_time`**
`integer`, possible values: `0, 5, 10, 15` — If the value of the \`join\_before\_host\` field is \`true\`, this field indicates the time limits within which a participant can join a meeting before the meeting's host: \* \`0\` — Allow the participant to join the meeting at anytime. \* \`5\` — Allow the participant to join 5 minutes before the meeting's start time. \* \`10\` — Allow the participant to join 10 minutes before the meeting's start time.
- **`join_before_host`**
`boolean` — Whether participants can join the meeting before its host.
- **`mute_upon_entry`**
`boolean` — Whether to automatically mute all participants when they join the meeting.
- **`not_store_meeting_topic`**
`boolean` — Whether to display the "Zoom Meeting" message as the meeting's topic.
- **`participant_video`**
`boolean` — Whether to start meetings with the participant video on.
- **`personal_meeting`**
`boolean` — The personal meeting settings: \* \`true\` — Indicates that the \*\*Enable Personal Meeting ID\*\* setting is enabled. Users can use a personal meeting ID for their meetings. \* \`false\` — Indicates that the \*\*Enable Personal Meeting ID\*\* setting is \[disabled]\(https\://support.zoom.us/hc/en-us/articles/201362843-Personal-meeting-ID-PMI-and-personal-link#h\_aa0335c8-3b06-41bc-bc1f-a8b84ef17f2a). When this setting is \*\*disabled\*\*, meetings that were scheduled with a PMI will be invalid. You must manually update any scheduled meetings. \*\*For Zoom Phone only:\*\* If a user has been assigned a desk phone, the desk phone's \*\*Elevate to Zoom Meeting\*\* setting will be disabled.
- **`pmi_password`**
`string` — The PMI's password.
- **`pstn_password_protected`**
`string` — Require a password from participants before joining a meeting via \[PSTN]\(https\://support.zoom.us/hc/en-us/articles/204517069-Getting-Started-with-Personal-Audio-Conference).
- **`require_password_for_instant_meetings`**
`boolean` — Whether a random password will be generated on the end of user who starts the instant meeting. Other meeting participants \*\*must\*\* enter the generated password to join the meeting. If instant meetings use a PMI, this option is \*\*disabled\*\*.
- **`require_password_for_pmi_meetings`**
`string`, possible values: `"jbh_only", "all", "none"` — Require participants to enter password for PMI meetings: \* \`jbh\_only\` — Only when a participant joins before the host. \* \`all\` — All participants must enter a password to join the meeting. \* \`none\` — No password required.
- **`require_password_for_scheduling_new_meetings`**
`boolean` — Whether a password is generated when a meeting host schedules a new meeting. Meeting participants will be required to enter the password before they can join the meeting. This setting only applies to regular meetings that do \*\*not\*\* use a PMI.
- **`upcoming_meeting_reminder`**
`boolean` — Whether to receive a desktop notification for upcoming meetings.
- **`use_pmi_for_instant_meetings`**
`boolean` — Whether PMI is enabled for all instant meetings.
- **`use_pmi_for_scheduled_meetings`**
`boolean` — Use a \[PMI (Personal Meeting ID)]\(https\://support.zoom.us/hc/en-us/articles/203276937-Using-Personal-Meeting-ID-PMI-) to schedule meeting.
- **`security`**
`object` — Information about the security settings.
- **`admin_change_name_pic`**
`boolean` — Whether only account administrators can change a user's username and picture.
- **`hide_billing_info`**
`boolean` — Whether hiding of billing information is enabled.
- **`import_photos_from_devices`**
`boolean` — Whether users can import photos from a photo library on a device.
- **`password_requirement`**
`object` — Information about the \[enhanced password rules]\(https\://support.zoom.us/hc/en-us/articles/360034675592-Advanced-security-settings#h\_bf8a25f6-9a66-447a-befd-f02ed3404f89) that allows Zoom account administrators and owners to apply additinal requirements to the users' Zoom login password.
- **`consecutive_characters_length`**
`integer` — The password's maximum length of consecutive characters (for example, \`abcde\`). If this is a \`0\` value, there is no consecutive character restriction.
- **`have_special_character`**
`boolean` — Whether a password requires at least one special character (for example, \`!\`, \`@\`, and \`#\`).
- **`minimum_password_length`**
`integer` — A password's required minimum length value. The password length can be between a minimum of 8 characters, up to 14 characters. If this is a \`0\` value, this setting is \*\*disabled\*\* and is not used. The default password length requirement will be a minimum of 8 characters.
- **`weak_enhance_detection`**
`boolean` — Whether passwords must pass detection through a weak password dictionary.
- **`signin_with_sso`**
`object` — Allow users to sign in with single sign-on (SSO).
- **`domains`**
`array` — Users using these domains are required to sign in with single sign-on (SSO).
**Items:**
`string`
- **`enable`**
`boolean` — Whether to allow users to sign in with single sign-on (SSO). Enabling this requires you to configure your account's SSO settings. This lets users sign in with SSO through your company's vanity URL.
- **`require_sso_for_domains`**
`boolean` — Whether to require users to sign in with single sign-on (SSO) if their e-mail address belongs to one of the \`domains\`.
- **`sso_bypass_users`**
`array` — The users can bypass SSO sign-in.
**Items:**
- **`email`**
`string` — The user's email.
- **`id`**
`string` — The user's ID.
- **`session_security`**
`object`
- **`approved_or_denied_countries_or_regions`**
`object` — Approve or block users from specific regions or countries from joining this meeting.
- **`approved_list`**
`array` — List of countries/regions from where participants can join this meeting.
**Items:**
`string`
- **`denied_list`**
`array` — List of countries/regions from where participants can not join this meeting.
**Items:**
`string`
- **`enable`**
`boolean` — \`true\`: Setting enabled to either allow or block users from specific regions from joining your meetings. \
\`false\`: Setting disabled.
- **`method`**
`string`, possible values: `"approve", "deny"` — Specify whether to allow users from specific regions to join this meeting; or block users from specific regions from joining this meeting. \
\
\`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\`.\
\
\`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\`
- **`telephony`**
`object` — Information about telephony settings.
- **`audio_conference_info`**
`string` — Information about the third-party audio configuration.
- **`telephony_regions`**
`object` — Information about where most of the participants call into or call from during a meeting.
- **`allowed_values`**
`array` — The telephony region options provided by Zoom.
**Items:**
`string`
- **`selection_values`**
`string` — The account's selected telephony regions that indicates where most of the participants call into or call from during a meeting.
- **`third_party_audio`**
`boolean` — Whether users can join the meeting using an existing third-party audio configuration.
- **`tsp`**
`object` — Information about TSP settings.
- **`allow_webinar_attendees_call_me`**
`boolean` — Whether webinar attendees can use Call Me to connect audio. This feature is only available in version 5.2.2 and higher.
- **`allow_webinar_attendees_toll_free_dial`**
`boolean` — 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.
- **`call_out`**
`boolean` — Call Out
- **`call_out_countries`**
`array` — Call Out Countries/Regions
**Items:**
`string`
- **`display_toll_free_numbers`**
`boolean` — Display toll-free numbers
- **`global_dial_in_countries`**
`object` — The account's \*\*Global Dial-in Countries/Regions\*\* settings.
- **`selected_countries`**
`array` — 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:**
- **`code`**
`string` — The code of the country or region.
- **`name`**
`string` — The name of the country or region.
- **`show_international_numbers_link`**
`boolean` — Show international numbers link on the invitation email
- **`zoom_rooms`**
`object` — Information about the Zoom Rooms settings.
- **`auto_start_stop_scheduled_meetings`**
`boolean` — Whether an automatic start time and stop time for scheduled meetings is enabled.
- **`cmr_for_instant_meeting`**
`boolean` — Whether cloud recording for instant meetings is enabled.
- **`force_private_meeting`**
`boolean` — Whether to force all meetings to be \[private meetings]\(https\://support.zoom.us/hc/en-us/articles/115001051063-Zoom-Rooms-Private-Meetings).
- **`hide_host_information`**
`boolean` — Whether hiding of the host and meeting ID in private meetings is enabled.
- **`list_meetings_with_calendar`**
`boolean` — Whether to display meeting lists with calendar integration.
- **`start_airplay_manually`**
`boolean` — Whether to start the AirPlay service manually.
- **`ultrasonic`**
`boolean` — Whether the automatic direct sharing using an ultrasonic proximity signal is enabled.
- **`upcoming_meeting_alert`**
`boolean` — Whether upcoming meeting alerts are enabled.
- **`weekly_system_restart`**
`boolean` — Whether weekly system restarts are enabled.
- **`zr_post_meeting_feedback`**
`boolean` — Whether Zoom Room post-meeting feedback is enabled.
- **`old_object`**
`object` — Information about the account's previous settings.
- **`id`**
`string` — The updated account's ID.
- **`settings`**
`object` — Information about the updated account or sub account settings. This only returns modified settings.
- **`ai`**
`object` — Workspace Reservation recommendations with AI.
- **`ai_generated_virtual_backgrounds`**
`boolean` — Whether AI-generated virtual backgrounds are enabled.
- **`ai_panel_in_workplace`**
`object` — AI panel in Zoom Workplace settings.
- **`delete_ai_conversation`**
`boolean` — Whether to automatically delete AI conversation history in the AI panel.
- **`delete_ai_conversation_time`**
`integer | null`, possible values: `30, 60, 90, 120` — The number of days after which AI conversation history in the AI panel is automatically deleted. Supported values are 30, 60, 90, and 120.
- **`enabled`**
`boolean` — Whether the AI panel in Zoom Workplace is enabled.
- **`chat_compose`**
`object` — Allow users to use AI to help them compose a response from scratch or wordsmith their chat messages.
- **`enable`**
`boolean` — Compose with AI Companion
- **`shown_in_team_chat`**
`boolean` — Show in Team Chat
- **`chat_summary`**
`object` — Allow users to summarize chats, channels, and shared documents.
- **`enable`**
`boolean` — Summarize with AI Companion
- **`shown_in_team_chat`**
`boolean` — Show in Team Chat
- **`enable_ai_on_web`**
`boolean` — Whether Zoom AI on the web is enabled.
- **`enable_email_compose_with_ai`**
`boolean` — Whether users can use AI to compose or wordsmith email responses in Zoom Mail.
- **`full_display_names_in_ai_assets`**
`boolean` — Whether AI-generated meeting assets use full display names.
- **`google`**
`object` — Settings for Google data sources.
- **`calendar_events`**
`boolean` — Whether Google Calendar events accessible to the user can be used as a data source for AI.
- **`documents`**
`boolean` — Whether Google Drive documents accessible to the user can be used as a data source for AI.
- **`emails`**
`boolean` — Whether Gmail emails accessible to the user can be used as a data source for AI.
- **`enable`**
`boolean` — Whether Google data sources can be used as data sources for AI.
- **`include_webinar_summary_follow_up_email`**
`object` — Webinar follow-up email. When enabled, the host can include the webinar summary in follow-up emails.
- **`absentee_follow_up_email`**
`boolean` — Whether the webinar summary is included in the absentee follow-up email.
- **`attendee_follow_up_email`**
`boolean` — Whether the webinar summary is included in the attendee follow-up email.
- **`enable`**
`boolean` — Whether the host can include the webinar summary in follow-up email.
- **`local_file_uploads`**
`boolean` — Whether files uploaded by users can be used as a data source for AI by the users who uploaded them.
- **`meeting_agenda`**
`boolean` — Whether Meeting Agenda with AI is enabled.
- **`meeting_chat_messages`**
`boolean` — Whether meeting chat messages are used to enhance transcripts.
- **`meeting_coach`**
`object` — Meeting Coach with AI.
- **`enable`**
`boolean` — Whether Meeting Coach with AI is enabled.
- **`participant_scope`**
`string`, possible values: `"all_participants_and_invitees", "participants_and_invitees_in_our_organization"` — Which participants Meeting Coach applies to.
- **`meeting_questions`**
`object` — Allow users to ask questions in a meeting with AI. Answers are based on what is said in the meeting.
- **`auto_enable`**
`boolean` — Automatically start meeting questions when the meeting starts.
- **`enable`**
`boolean` — Whether users can ask questions in a meeting with AI.
- **`who_can_ask_questions`**
`string`, possible values: `"from_entire_meeting", "from_join_meeting", "host", "org", "org_from_join_meeting"` — Participants allowed to ask meeting questions. Valid values: \`from\_entire\_meeting\` (all participants and invitees), \`from\_join\_meeting\` (all participants from when they join), \`host\` (only the meeting host), \`org\` (participants and invitees in the organization), \`org\_from\_join\_meeting\` (organization participants from when they join).
- **`meeting_summary`**
`object` — Allow hosts to generate a summary. Summaries are sent based on sharing permissions after the meeting ends.
- **`auto_enable`**
`boolean` — Auto-start the meeting summary when the meeting starts.
- **`email_notification`**
`boolean` — Send an email notification when sharing a meeting summary with participants.
- **`enable`**
`boolean` — Whether hosts can generate a meeting summary.
- **`restrict_share_to_outside_of_organization`**
`boolean` — Restrict users from sharing meeting summaries with people outside the organization.
- **`restrict_summary_share`**
`string`, possible values: `"external_users", "all_users", "all_users_except_delegate"` — Audience restricted from sharing meeting summaries. Valid values: \`external\_users\` (users outside the organization), \`all\_users\` (all users), \`all\_users\_except\_delegate\` (all users except delegates).
- **`whether_include_full_text_in_email`**
`string`, possible values: `"include_full_text_in_email", "not_include_full_text_in_email"` — Whether the meeting summary email includes summary text. Valid values: \`include\_full\_text\_in\_email\` (include the summary text), \`not\_include\_full\_text\_in\_email\` (do not include the summary text).
- **`who_will_receive_summary`**
`string`, possible values: `"host", "alt_host", "organization", "all", "host_and_panelist_in_organization", "host_and_panelist_not_in_organization", "host_and_speakers", "do_not_share"` — Recipients for automatically shared meeting summaries. Valid values: \`host\` (only the meeting host), \`alt\_host\` (meeting host, co-hosts, and alternative hosts), \`organization\` (meeting host and invitees in the organization), \`all\` (all meeting invitees, including external invitees), \`host\_and\_panelist\_in\_organization\` (meeting host and participants in the organization), \`host\_and\_panelist\_not\_in\_organization\` (meeting host and all participants, including external participants), \`host\_and\_speakers\` (meeting host and speakers), \`do\_not\_share\` (do not share a summary).
- **`meeting_summary_default_language`**
`object` — Set the default language for meeting summaries.
- **`enable`**
`boolean` — Whether meeting summaries automatically use the selected default language.
- **`language`**
`string` — Language that meeting summaries automatically use when the default-language setting is enabled. 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).
- **`meeting_summary_docs`**
`object` — Automatic Zoom Doc creation from meeting summary.
- **`enable`**
`boolean` — Whether automatic Zoom Doc creation is enabled.
- **`share_with_summary_recipients`**
`boolean` — Whether generated Zoom Docs are shared with meeting summary recipients.
- **`meeting_summary_email_only_mode`**
`boolean` — Only share meeting summaries by email. Users cannot view or edit summaries in the Zoom client or web portal because the meeting summary is not retained.
- **`meeting_summary_ip_access`**
`object` — Allow meeting summary access only from specific IP address ranges.
- **`enable`**
`boolean` — Whether access to meeting summaries is restricted to specified IP address ranges.
- **`ip_addresses_or_ranges`**
`string` — IP addresses or ranges from which meeting summaries can be accessed.
- **`meeting_summary_personal_data_redaction`**
`object` — Personal data redaction for meeting summaries.
- **`enable`**
`boolean` — Whether personal data redaction is enabled.
- **`personal_data_types`**
`array` — Personal data types to redact.
**Items:**
`string`, possible values: `"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"`
- **`meeting_summary_retention`**
`object` — Automatic meeting summary deletion.
- **`enable`**
`boolean` — Whether automatic meeting summary deletion is enabled.
- **`retention_days`**
`integer` — Number of days to retain meeting summaries before deletion.
- **`meeting_summary_sensitive_data_filter`**
`object` — Sensitive data filter for meeting summaries.
- **`enable`**
`boolean` — Whether the sensitive data filter is enabled.
- **`rules`**
`array` — Sensitive data filter rules.
**Items:**
- **`name`**
`string` — Rule display name.
- **`regular_expression`**
`string` — RE2J regular expression.
- **`meeting_summary_template`**
`object` — Allow users to select a meeting summary template for their meetings. The summary is generated using the selected template.
- **`enable`**
`boolean` — Whether users can select a meeting summary template for their meetings.
- **`summary_template_id`**
`string` — ID of the default meeting summary template used to generate meeting summaries.
- **`microsoft_365`**
`object` — Settings for Microsoft 365 data sources.
- **`calendar_events`**
`boolean` — Whether Microsoft Outlook calendar events accessible to the user can be used as a data source for AI.
- **`documents`**
`boolean` — Whether Office 365 documents accessible to the user can be used as a data source for AI.
- **`emails`**
`boolean` — Whether Microsoft Outlook emails accessible to the user can be used as a data source for AI.
- **`enable`**
`boolean` — Whether Microsoft 365 data sources can be used as data sources for AI.
- **`organization_custom_dictionaries`**
`boolean` — Whether AI can consume the organization's custom dictionaries.
- **`participant_can_request_aic_in_meeting`**
`boolean` — Allow participants to request AI Companion in a meeting.
- **`phone_user_ai_notices`**
`object` — Phone user AI notices.
- **`enable`**
`boolean` — Whether phone user AI notices are enabled.
- **`multiple_notifications`**
`boolean` — Whether multiple notifications are allowed.
- **`require_press_1_consent`**
`boolean` — Whether callers must press 1 to consent.
- **`remind_me_turn_on_aic`**
`boolean` — Remind hosts to turn on Zoom AI at the beginning of a meeting when AI features are not configured to auto-start.
- **`remind_me_turn_on_catch_me_up`**
`boolean` — When joining a meeting late, prompt the user to use Zoom AI to summarize what has been discussed so far.
- **`restrict_aic_when_external_user_join_meeting`**
`boolean` — Restrict AI Companion when an external user joins a meeting.
- **`restrict_users_from_deleting_ai_companion_assets`**
`boolean` — Restrict users from deleting meeting assets generated by AI. When enabled, only admins can delete those assets.
- **`restrict_users_from_editing_ai_companion_assets`**
`boolean` — Restrict users from editing meeting assets generated by AI. When enabled, only admins can edit those assets.
- **`restrict_users_from_joining_ai_enabled_meetings`**
`object` — Restrict users from joining meetings where AI meeting processing, including meeting questions and meeting summary, is allowed.
- **`apply_scope`**
`string`, possible values: `"internal_only", "external_only", "internal_and_external"` — Meeting scope to which the restriction applies. Valid values: \`internal\_only\` (internal meetings only), \`external\_only\` (external meetings only), \`internal\_and\_external\` (internal and external meetings).
- **`enable`**
`boolean` — Whether restrictions on joining AI-enabled meetings are enabled.
- **`join_notify`**
`string`, possible values: `"out_of_compliance", "notify_and_remove"` — Action to take when a restricted user tries to join an AI-enabled meeting. Valid values: \`out\_of\_compliance\` (notify the user and allow them to remain), \`notify\_and\_remove\` (notify the user and remove them from the meeting).
- **`screen_share_ocr`**
`boolean` — Whether screen share content is used with OCR.
- **`show_conversational_ai_companion`**
`object` — Show conversational AI companion settings.
- **`delete_ai_conversation`**
`boolean` — Whether to automatically delete AI conversation history.
- **`delete_ai_conversation_time`**
`integer | null`, possible values: `30, 60, 90, 120` — The number of days after which AI conversation history is automatically deleted. Supported values are 30, 60, 90, and 120.
- **`enable_zoom_mate`**
`boolean` — Whether ZoomMate is available in the web navigation and Zoom Workplace app navigation bar.
- **`enabled`**
`boolean` — Whether conversational AI is enabled.
- **`smart_recording`**
`object` — Smart Recording
- **`create_next_steps`**
`boolean` — Next steps
- **`create_recording_highlights`**
`boolean` — Recording highlights
- **`create_smart_chapters`**
`boolean` — Summary and smart chapters
- **`task_creation_and_management`**
`object` — AI-powered task creation and management with AI Companion.
- **`auto_generate_action`**
`boolean` — Whether to automatically generate action items from tasks.
- **`auto_generate_details`**
`boolean` — Whether to automatically generate task details.
- **`enable`**
`boolean` — Whether AI-powered task creation and management is enabled.
- **`generate_from_phone_call`**
`object` — Settings for generating tasks from phone calls.
- **`auto_add_participant_as_collaborator`**
`boolean` — Whether to automatically add phone call participants as task collaborators.
- **`auto_assign_to_collaborator`**
`boolean` — Whether to automatically assign phone call tasks to collaborators.
- **`enable`**
`boolean` — Whether to allow generating tasks from phone calls.
- **`generate_from_transcripts`**
`object` — Settings for generating tasks from meeting transcripts.
- **`auto_assign_to_collaborator`**
`boolean` — Whether to automatically assign tasks to collaborators.
- **`auto_share_with`**
`string`, possible values: `"host_only", "internal_participants", "internal_assigned_participants"` — Defines who tasks are automatically shared with when generated from transcripts.
- **`enable`**
`boolean` — Whether to allow generating tasks from meeting transcripts.
- **`generate_from_voicemail`**
`boolean` — Whether to allow generating tasks from voicemail.
- **`third_party_app_tasks`**
`boolean` — Whether AI can perform tasks on the user's behalf in third-party apps configured within AI Studio.
- **`third_party_meeting_join`**
`object` — Third-party meeting join with AI.
- **`allow_recording`**
`boolean` — Whether recording is enabled for joined third-party meetings.
- **`calendar`**
`object` — Calendar-based third-party meeting join.
- **`enable`**
`boolean` — Whether calendar-based third-party meeting join is enabled.
- **`join_scope`**
`string`, possible values: `"all_events_with_video_conference_links", "meetings_where_i_am_the_host", "meetings_where_i_am_a_participant"` — Which calendar events third-party meeting join applies to.
- **`enable`**
`boolean` — Whether third-party meeting join with AI is enabled.
- **`pre_meeting_email_notification`**
`object` — Pre-meeting email notification.
- **`enable`**
`boolean` — Whether pre-meeting email notification is enabled.
- **`recipients`**
`string`, possible values: `"all_invitees", "only_meeting_host"` — Who receives the pre-meeting email notification.
- **`web_content`**
`boolean` — Whether public web content can be used as a data source for AI.
- **`webinar_questions`**
`object` — During the webinar, answers are based on speech-to-text data. If a transcript is retained, participants with access will be able to ask questions after the webinar based on that transcript.
- **`auto_enable`**
`boolean` — Whether to automatically allow access when the webinar starts.
- **`enable`**
`boolean` — Whether to allow users to ask webinar questions with AI.
- **`who_can_ask_questions`**
`string`, possible values: `"panelist_all", "panelist_org", "host", "all_participants"` — Who can ask questions about the webinar. Valid values: \`panelist\_all\` (Hosts and all panelists), \`panelist\_org\` (Hosts and all panelists in our organization), \`host\` (Only webinar host, co-hosts, and alternative hosts), \`all\_participants\` (All participants).
- **`webinar_summary`**
`object` — Allow hosts to generate a summary. Summaries are sent after the webinar has ended based on sharing permissions.
- **`auto_enable`**
`boolean` — Whether to turn on webinar summary automatically when the webinar starts.
- **`email_notification`**
`boolean` — Whether to send an email notification when sharing to participants.
- **`enable`**
`boolean` — Whether to allow hosts to generate a summary.
- **`restrict_share_to_outside_of_organization`**
`boolean` — Whether to restrict users from sharing summaries to those outside of the organization.
- **`restrict_summary_share`**
`string`, possible values: `"external_users", "all_users", "all_users_except_delegate"` — Whether to 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).
- **`whether_include_full_text_in_email`**
`string`, possible values: `"include_full_text_in_email", "not_include_full_text_in_email"` — 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).
- **`who_will_receive_summary`**
`string`, possible values: `"host", "host_and_panelist_in_organization", "host_and_panelist_not_in_organization"` — 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 our organization), \`host\_and\_panelist\_not\_in\_organization\` (Webinar host, co-hosts, and all panelists, including those outside our organization).
- **`webinar_summary_follow_up_email`**
`boolean` — Whether webinar summaries are included in webinar follow-up email. Deprecated. Use \`include\_webinar\_summary\_follow\_up\_email\`.
- **`webinar_summary_ocr`**
`boolean` — 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.
- **`whiteboard_content_generation`**
`boolean` — Whether Whiteboard content generation with AI is enabled.
- **`workspace_reservation_recommendations_with_ai`**
`object` — Workspace Reservation recommendations with AI.
- **`custom_workspaces_recommendation`**
`boolean` — Whether custom workspace recommendations are enabled.
- **`day_recommendation`**
`boolean` — Whether day recommendations are enabled.
- **`desk_recommendation`**
`boolean` — Whether desk recommendations are enabled.
- **`enabled`**
`boolean` — Whether Workspace Reservation recommendations with AI are enabled.
- **`proactive_room_recommendation`**
`boolean` — Whether proactive room recommendations are enabled.
- **`room_recommendation`**
`boolean` — Whether room recommendations are enabled.
- **`zoom_events_analytics`**
`boolean` — Whether Zoom Events AI Analytics is enabled. AI can analyze event engagement and uncover key moments, topics of interest, and actionable insights.
- **`zoom_events_chat_compose`**
`boolean` — Whether Zoom Events Chat Compose is enabled. AI helps users compose a response from scratch or wordsmith their chat messages.
- **`zoom_events_chat_panel`**
`boolean` — 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.
- **`zoom_events_content_generation`**
`boolean` — Whether Zoom Events Content Generation with AI is enabled. AI content generation helps users create blogs, ebooks, whitepapers, emails, highlights, and sales briefs.
- **`zoom_events_content_studio`**
`boolean` — Whether Content Studio is enabled. Content Studio can turn recordings into high-quality content such as video clips, emails, and blog posts.
- **`zoom_events_email_compose`**
`boolean` — Whether Zoom Events Email Compose with AI is enabled. AI can compose emails and subject lines for events in the Email Builder.
- **`zoom_events_image_generation`**
`boolean` — Whether the Zoom Events image generator is enabled. AI can create images for use in an event.
- **`zoom_events_session_summary`**
`object` — Session summary. Allow hosts to generate a summary. Summaries are sent after the session has ended based on the in-session access options.
- **`auto_start`**
`boolean` — Whether to turn on session summary automatically when sessions start.
- **`enable`**
`boolean` — Whether Zoom Events session summaries are enabled.
- **`zoom_events_smart_compose`**
`boolean` — 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.
- **`zoom_events_smart_upload`**
`boolean` — Whether Zoom Events Smart Upload is enabled. AI can ingest files to quickly create event content such as speaker biographies.
- **`audio_conferencing`**
`object` — The account's audio conference settings.
- **`call_me_and_invite_by_phone`**
`object` — 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.
- **`allow_webinar_attendees_call_me`**
`boolean` — Whether webinar attendees can use Call Me to connect audio. This feature is only available in version 5.2.2 and higher.
- **`call_out_countries`**
`object` — The account's call out countries/regions settings.
- **`selected_countries`**
`array` — The list of countries/regions that users can call out to.
**Items:**
- **`code`**
`string` — The \[code]\(https\://developers.zoom.us/docs/api/rest/other-references/abbreviation-lists/#countries) of the country or region.
- **`name`**
`string` — The name of the country or region.
- **`enable`**
`boolean` — 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.
- **`require_press_1_for_call_me`**
`string`, possible values: `"auto", "always", "never"` — Require Call Me users to press 1 before being connected to the meeting. \* \`auto\` - Automatically determine whether to require pressing 1 before connecting to the meeting. \* \`always\` - Always require Call Me users to press 1 before connecting to the meeting. \* \`never\` - Never require Call Me users to press 1 before connecting to the meeting.
- **`global_dial_in_countries`**
`object` — The account's \[\*\*Global Dial-in Countries/Regions\*\*]\(https\://support.zoom.com/hc/en/article?id=zm\_kb\&sysparm\_article=KB0068094#h\_01F5KK9J31ZXNW10BRH86NHX4G) settings.
- **`include_toll_free`**
`boolean` — Whether to include toll-free numbers in the email invitation for the selected countries/regions.
- **`selected_countries`**
`array` — The list of selected countries/regions whose dial-in numbers will be listed in the email invitation.
**Items:**
- **`code`**
`string` — The \[code]\(https\://developers.zoom.us/docs/api/rest/other-references/abbreviation-lists/#countries) of the country or region.
- **`name`**
`string` — The name of the country or region.
- **`participant_phone_masking`**
`object` — 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.
- **`enable`**
`boolean` — 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.
- **`masking_type`**
`string`, possible values: `"mask_default", "mask_first_5", "mask_except_last_4"` — The type of phone number masking pattern to apply. \* \`mask\_default\` - Default masking pattern (Example: 888\*\*\*\*666). \* \`mask\_first\_5\` - Mask first five digits (Example: \*\*\*\*\*66666). \* \`mask\_except\_last\_4\` - Mask everything except last four digits (Example: \*\*\*\*\*6666).
- **`personal_audio_conference`**
`boolean` — 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.
- **`toll_call`**
`object` — The account's \[\*\*Toll Call\*\*]\(https\://support.zoom.com/hc/en/article?id=zm\_kb\&sysparm\_article=KB0066909#h\_01F51680NJ7YHZDXGJNSKDGM2P) settings.
- **`enable`**
`boolean` — Whether the account has the \[\*\*Toll Call\*\*]\(https\://support.zoom.com/hc/en/article?id=zm\_kb\&sysparm\_article=KB0066909#h\_01F51680NJ7YHZDXGJNSKDGM2P) setting enabled.
- **`numbers`**
`array` — The account's \*\*Toll Call\*\* phone number information.
**Items:**
- **`code`**
`string` — The phone number's \[E.164 country calling code]\(https\://en.wikipedia.org/wiki/List\_of\_country\_calling\_codes).
- **`country_code`**
`string` — The phone number's two-letter \[country code]\(https\://developers.zoom.us/docs/api/rest/other-references/abbreviation-lists/#countries).
- **`country_name`**
`string` — The country name.
- **`display_number`**
`string` — The phone number's display number.
- **`number`**
`string` — The phone number.
- **`toll_free_and_fee_based_toll_call`**
`object` — 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.
- **`allow_webinar_attendees_dial`**
`boolean` — 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.
- **`enable`**
`boolean` — 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.
- **`numbers`**
`array` — The account's phone numbers.
**Items:**
- **`code`**
`string` — The phone number's \[E.164 country calling code]\(https\://en.wikipedia.org/wiki/List\_of\_country\_calling\_codes).
- **`country_code`**
`string` — The phone number's \[country code]\(https\://marketplace.zoom.us/docs/api-reference/other-references/abbreviation-lists#countries).
- **`country_name`**
`string` — The country name.
- **`display_number`**
`string` — The phone number's display number.
- **`number`**
`string` — The phone number.
- **`chat`**
`object` — The account's chat settings.
- **`ai_compose`**
`object` — Allow users to summarize chats, channels, and shared documents.
- **`enable`**
`boolean` — Compose with AI Companion
- **`shown_in_team_chat`**
`boolean` — Show in Team Chat
- **`ai_quick_reply`**
`boolean` — Quick reply with AI Companion
- **`ai_quick_schedule`**
`boolean` — Quick schedule with AI Companion
- **`ai_recommend`**
`boolean` — Chat Recommendation with Zoom AI Companion
- **`ai_sentence_completion`**
`boolean` — Sentence completion with AI Companion
- **`ai_summary`**
`object` — Allow users to summarize chats, channels, and shared documents.
- **`enable`**
`boolean` — Summarize with AI Companion
- **`shown_in_team_chat`**
`boolean` — Show in Team Chat
- **`allow_bots_chat`**
`boolean` — Whether chatbots added to chats and channels can read and write messages.
- **`allow_delete_message`**
`object` — 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.
- **`enable`**
`boolean` — Allow users to delete messages
- **`time`**
`integer`, possible values: `0, 5, 30, 60, 1440, 10080` — Within how many minitues of posting
- **`allow_edit_message`**
`object` — 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.
- **`enable`**
`boolean` — Allow users to edit messages
- **`time`**
`integer`, possible values: `0, 5, 30, 60, 1440, 10080` — Within how many minitues of posting
- **`allow_huddles_from_channels`**
`boolean` — Allow huddles from channels
- **`allow_remove_msg_by_owner_and_admins`**
`boolean` — Allow channel owner and admin(s) to remove messages of other members
- **`allow_users_to_add_contacts`**
`object` — Allow users to add contacts.
- **`enable`**
`boolean` — By disabling this setting, users will not be able to add contacts.
- **`selected_option`**
`integer`, possible values: `1, 2, 3, 4` — The type of allowing users to add contacts: \* 1 — Anyone (internal and external contacts). \* 2 — In the same organization. \* 3 — In the same organization and specified domains. \* 4 — In the same organization and specified users.
- **`user_email_addresses`**
`string` — The domains or emails (internal or external). \* 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. \* When the \`selected\_option\` field value is \`4\`, the value is internal or external email addresses. Use a comma to separate multiple emails.
- **`allow_users_to_chat_with_others`**
`object` — Allow users to chat with others.
- **`enable`**
`boolean` — 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.
- **`selected_option`**
`integer`, possible values: `1, 2, 3, 4` — The type of allowing users to add contacts: \* 1 — Anyone (internal and external contacts). \* 2 — In the same organization. \* 3 — In the same organization and specified domains. \* 4 — In the same organization and specified users.
- **`user_email_addresses`**
`string` — The domains or emails (internal or external). \* 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. \* When the \`selected\_option\` field value is \`4\`, the value is internal or external email addresses. Use a comma to separate multiple emails.
- **`apply_local_storage_to_personal_channel`**
`object` — Store personal channel messages on local devices.
- **`enable`**
`boolean` — 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.
- **`retention_period`**
`string` — Delete data after retention period. 'y' - year, 'm' - month, 'd' - day.
- **`chat_email_address`**
`object` — 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.
- **`enable`**
`boolean` — Chat email address
- **`only_allow_specific_domains`**
`boolean` — Only allow emails from specified domains
- **`specific_domains`**
`array`
**Items:**
`string` — Specified domains.
- **`chat_emojis`**
`object` — Chat emojis.
- **`emojis_option`**
`string`, possible values: `"all", "selected"`
- **`enable`**
`boolean` — 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.
- **`chat_etiquette_tool`**
`object` — Information about the \*\*Chat Etiquette Tool\*\*.
- **`enable`**
`boolean` — Whether to enable the \*\*Chat Etiquette Tool\*\*.
- **`policies`**
`array` — Information about the defined \*\*Chat Etiquette Tool\*\* policies.
**Items:**
- **`description`**
`string` — The policy's description.
- **`id`**
`string` — The policy ID.
- **`is_locked`**
`boolean` — Whether the policy is locked by an account-level user. When it is locked, users cannot update the policy.
- **`keywords`**
`array` — A list of defined rule keywords.
**Items:**
`string`
- **`name`**
`string` — The policy name.
- **`regular_expression`**
`string` — The regular expression to match to the content of chat messages.
- **`status`**
`string`, possible values: `"activated", "deactivated"` — The policy's current status. \* \`activated\` — Activated. \* \`deactivated\` — Deactivated.
- **`trigger_action`**
`integer`, possible values: `1, 2` — The policy's trigger action. \* \`1\` — Ask the user to confirm before they send the message. \* \`2\` — Block the user's message.
- **`policy_max_count`**
`integer` — The read-only maximum number of \*\*Chat Etiquette Tool\*\* policies.
- **`code_snippet`**
`boolean` — Send code snippet
- **`create_group_chat`**
`boolean` — Allow users to create group chats.
- **`create_private_channels`**
`boolean` — Allow users to create private channels.
- **`create_public_channels`**
`boolean` — Allow users to create public channels.
- **`download_file`**
`boolean` — Downloading files
- **`external_collab_restrict`**
`object` — Restrict external collaboration in group chats and channels for a select group
- **`enable`**
`boolean` — Restrict external collaboration in group chats and channels for a select group
- **`external_chat`**
`string`, possible values: `"allowed", "not_allowed"` — The type of restrict external collaboration in group chats and channels for a select group \* - Allowed user group \* - Not allowed user group
- **`group_id`**
`string` — The group Id
- **`external_invite_approve`**
`object` — Require admin approval for adding external users in group chats and channels
- **`channel_id`**
`string` — The channel Id
- **`enable`**
`boolean` — Require admin approval for adding external users in group chats and channels
- **`external_account`**
`boolean` — Allow this setting to be edited for specified accounts
- **`selected_option`**
`integer`, possible values: `1, 2` — 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
- **`external_join_approve`**
`object` — Require admin approval for joining external group chats and channels
- **`channel_id`**
`string` — The channel Id
- **`enable`**
`boolean` — Require admin approval for joining external group chats and channels
- **`external_account`**
`boolean` — Allow this setting to be edited for specified accounts
- **`selected_option`**
`integer`, possible values: `1, 2` — The type of requiring admin approval for joining external group chats and channels \* 1 - Send requests directly to all approvers \* 2 - Send requests to a specific channel
- **`external_member_join`**
`object` — Allow members of your organization to join external group chats and channels
- **`enable`**
`boolean` — Allow members of your organization to join external group chats and channels
- **`external_account`**
`boolean` — Allow this setting to be edited for specified accounts
- **`external_user_control`**
`object` — Add external users into group chats and channels
- **`enable`**
`boolean` — Allow to add external users into group chats and channels
- **`external_account`**
`boolean` — Allow this setting to be edited for specified accounts
- **`selected_option`**
`integer`, possible values: `1, 2, 3` — The type of allowing external user control \* 1 - Everyone \* 2 - Only members in your organization, plus specified external accounts \* 3 - Only the account owner and admins
- **`hyper_link`**
`boolean` — Allow hyperlinks in Team Chat
- **`personal_channel`**
`boolean` — Enable Personal Chat
- **`presence_away_when_screen_saver`**
`boolean` — Change my status to away when screen saver begins
- **`presence_on_meeting`**
`boolean` — Change my presence status when I am in a meeting or call
- **`read_receipts`**
`object` — Indicate when messages have been seen by recipients, for chats and channels with less than 20 members.
- **`allow_users_opt_out`**
`boolean` — Allow users to opt out
- **`enable`**
`boolean` — Enable read receipts
- **`record_video_messages`**
`boolean` — 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.
- **`record_voice_messages`**
`boolean` — Allow users to record voice messages that can be sent in direct messages or group conversations.
- **`schedule_meetings_in_chat`**
`boolean` — Schedule a meeting from chat or channel.
- **`screen_capture`**
`boolean` — Allow users to take and send screenshots in direct messages or group conversations.
- **`search_and_send_animated_gif_images`**
`object` — Allow users to search GIF images from GIPHY when they compose messages. See GIPHY's website for more information about content ratings.
- **`enable`**
`boolean` — Whether to allow users to search GIF images from GIPHY when they compose messages.
- **`giphy_content_rating`**
`integer`, possible values: `1, 2, 3, 4` — Set the GIPHY content rating. This feature is only available for Zoom Client v5.11.0 or later.
- **`send_data_to_third_party_archiving_service`**
`object` — Send data to third-party archiving service.
- **`authorized_channel_token`**
`string` — Authorized channel token. It is used when the field \`type\` value is \`smarsh\`.
- **`enable`**
`boolean` — Allow users to send data to third-party archiving service.
- **`passcode`**
`string` — passcode. It is used when the field \`type\` value is \`global\_relay\`.
- **`smtp_delivery_address`**
`string` — SMTP delivery address. It is used when the field \`type\` value is \`global\_relay\`.
- **`type`**
`string`, possible values: `"global_relay", "smarsh"` — The type of global relay. \* \`global\_relay\` — The participant cannot use chat. \* \`smarsh\` — Host and co-hosts only.
- **`user_name`**
`string` — User name. It is used when the field \`type\` value is \`global\_relay\`.
- **`set_chat_as_default_tab`**
`boolean` — Set Team Chat as a default tab for first-time users
- **`set_retention_period_in_cloud`**
`object` — Set retention period for messages and files in Zoom's cloud.
- **`enable`**
`boolean` — 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.
- **`retention_period_of_channels`**
`string` — Delete data in channels after retention period. 'y' - year, 'm' - month, 'd' - day
- **`retention_period_of_direct_messages_and_group_conversation`**
`string` — Delete direct messages and group conversations after retention period. 'y' - year, 'm' - month, 'd' - day
- **`set_retention_period_in_local`**
`object` — Store messages on local devices, excluding personal channel messages.
- **`enable`**
`boolean` — Specify how long your messages are saved on local devices. If this setting is disabled, messages are never deleted locally.
- **`retention_period_of_channels`**
`string` — Delete data in channels after retention period. 'y' - year, 'm' - month, 'd' - day
- **`retention_period_of_direct_messages_and_group_conversation`**
`string` — Delete direct messages and group conversations after retention period. 'y' - year, 'm' - month, 'd' - day
- **`share_files`**
`object` — Users can share files in chats and channels.
- **`enable`**
`boolean` — 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.
- **`restrictions`**
`object` — The restrictions of users can share files in chats and channels
- **`file_restrictions_apply_to`**
`string`, possible values: `"sharing_and_viewing", "sharing"` — Apply restrictions to both sharing and viewing, or only apply to sharing
- **`file_size_restrictions`**
`integer`, possible values: `50, 100, 200, 300, 400, 500` — Maximum file size
- **`file_size_restrictions_for_external`**
`integer`, possible values: `50, 100, 200, 300, 400, 500` — Maximum file size for external users
- **`file_type_restrictions`**
`array` — The restrictions of users can share files in chats and channels
**Items:**
`string`, possible values: `".gz", ".rar", ".zip", ".xls", ".xlsx", ".json", ".png", ".pptx", ".ppt", ".7z", ".xmind", ".pdf", ".pps", ".txt", ".docx", ".doc"` — Specified file type
- **`file_type_restrictions_for_external`**
`array`
**Items:**
`string`, possible values: `".gz", ".rar", ".zip", ".xls", ".xlsx", ".json", ".png", ".pptx", ".ppt", ".7z", ".xmind", ".pdf", ".pps", ".txt", ".docx", ".doc"` — Specified file type
- **`maximum_file_size`**
`boolean` — Whether to restrict file size
- **`only_allow_specific_file_types`**
`boolean` — Only allow specified file types
- **`share_option`**
`string`, possible values: `"disable", "anyone", "account", "organization"` — Allow users of this account to send files in chats and channels.
- **`view_option`**
`string`, possible values: `"anyone", "account", "organization"` — Allow users of this account to view files in chats and channels.
- **`share_links_in_chat`**
`boolean` — Share links to messages and channels in Team Chat.
- **`share_screen_in_chat`**
`boolean` — Share screen in chat
- **`shared_spaces`**
`boolean` — Allow users to create Shared Spaces
- **`show_h323_contact_tab`**
`boolean` — Show H.323 contacts
- **`show_status_to_internal_contact`**
`boolean` — Show status to internal contacts
- **`store_revise_chat`**
`boolean` — Store edited and deleted message revisions
- **`suppress_removal_notification`**
`boolean` — Suppress deleted, deactivated, and reactivated user notice in group chats and channels
- **`suppress_user_group_notification`**
`boolean` — Suppress add and remove user notice in channels
- **`survey_poll`**
`boolean` — Allow users to launch a poll in chats and channels
- **`translate_messages`**
`boolean` — Allow users to translate team chat messages. \[Learn more].(https\://support.zoom.us/hc/en-us/articles/12998089084685)
- **`email_notification`**
`object` — Information about the email notification settings.
- **`alternative_host_reminder`**
`boolean` — Whether to notify when an alternative host is added to or removed from a meeting.
- **`cancel_meeting_reminder`**
`boolean` — Whether to notify the host and participants when a meeting is canceled.
- **`cloud_recording_available_reminder`**
`boolean` — Whether to notify the host when a cloud recording is available.
- **`jbh_reminder`**
`boolean` — Whether to notify the host when participants join the meeting before them.
- **`low_host_count_reminder`**
`boolean` — Whether to notify the user when host licenses are running low.
- **`recording_available_reminder_alternative_hosts`**
`boolean` — Whether to notify any alternative hosts when a cloud recording is available.
- **`recording_available_reminder_schedulers`**
`boolean` — Whether to notify the person who scheduled the meeting or webinar for the host when a cloud recording is available.
- **`schedule_for_reminder`**
`boolean` — Whether to notify the host that there is a meeting is scheduled, rescheduled, or canceled.
- **`feature`**
`object` — Feature
- **`meeting_capacity`**
`integer` — The maximum number of participants a host can have in a single meeting.
- **`general_setting`**
`object` — General settings.
- **`auto_zoom_room_proximity_connect`**
`boolean` — Allow automatic direct sharing and connecting to Zoom Rooms using ultrasonic proximity signal.
- **`show_zoom_room_feature`**
`boolean` — Show "Zoom Room" feature in the Zoom Workplace app.
- **`h323sip_conferencing`**
`object` — The account's H.323/SIP Conferencing settings.
- **`custom_welcome_audio`**
`object` — Information about the custom welcome audio message played to H.323/SIP devices upon joining a Zoom Meeting.
- **`audio_file`**
`string` — The URL for the configured custom audio file.
- **`enable`**
`boolean`, default: `false` — Determines if a custom welcome audio message is played when H.323/SIP devices join a Zoom Meeting.
- **`in_meeting`**
`object` — Information about the in meeting settings.
- **`alert_guest_join`**
`boolean` — Whether to alert when a guest joins a meeting.
- **`allow_host_panelists_to_use_audible_clap`**
`boolean` — Whether to allow host and panelist to use audible clap.
- **`allow_host_to_enable_focus_mode`**
`boolean` — Whether the host can enable \[\*\*Focus Mode\*\*]\(https\://support.zoom.us/hc/en-us/articles/360061113751-Using-focus-mode) when scheduling a meeting.
- **`allow_live_streaming`**
`boolean` — Whether to allow livestreaming.
- **`allow_participants_chat_with`**
`integer`, possible values: `1, 2, 3, 4` — Whether participants can chat with certain groups: \* \`1\` — The participants cannot use chat. \* \`2\` — Host and co-hosts only. \* \`3\` — The participants can chat with other participants publicly. \* \`4\` - The participants can chat with other participants publicly and privately. \*\*Note:\*\* This setting is only available with client versions 5.7.3 and above.
- **`allow_show_zoom_windows`**
`boolean` — Whether to display the Zoom desktop application when sharing access.
- **`allow_users_save_chats`**
`integer`, possible values: `1, 2, 3` — Whether participants can save meeting chats: \* \`1\` — Participants cannot save meeting chats. \* \`2\` — Participants can only save host and co-host meeting chats. \* \`3\` — Participants can save all meeting chats.
- **`allow_users_to_delete_messages_in_meeting_chat`**
`boolean` — If the value of this field is set to \`true\`, allow users to delete messages in the in-meeting chat.
- **`annotation`**
`boolean` — Whether participants can use annotation tools to add information to shared screens.
- **`anonymous_question_answer`**
`boolean` — Whether anonymous Q\&A is enabled in a webinar.
- **`attendee_on_hold`**
`boolean` — Whether hosts can temporarily place an attendee on hold.
- **`attention_mode_focus_mode`**
`boolean` — Whether the \[\*\*Focus Mode\*\*]\(https\://support.zoom.us/hc/en-us/articles/360061113751-Using-focus-mode) feature is enabled. When enabled, this feature only displays the host and co-hosts' video and profile pictures during a meeting.
- **`audio_watermark_by_default`**
`boolean` — Whether to turn on \[audio watermark]\(https\://support.zoom.us/hc/en-us/articles/360021839031-Adding-audio-watermark) by default when scheduling a meeting.
- **`auto_answer`**
`boolean` — Whether users can 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.
- **`auto_saving_chat`**
`boolean` — Whether to automatically save all in-meeting chats.
- **`breakout_room`**
`boolean` — Whether the host can split meeting participants into separate, smaller rooms.
- **`breakout_room_schedule`**
`boolean` — Whether the host can assign participants to breakout rooms when scheduling. This feature is \*\*only\*\* available in version 4.5.0 or higher.
- **`chat`**
`boolean` — Whether meeting participants can use \[in-meeting chat]\(https\://support.zoom.us/hc/en-us/articles/203650445-In-Meeting-Chat).
- **`closed_caption`**
`boolean` — Whether the host can add closed captions.
- **`closed_captioning`**
`object` — The account's closed captioning settings.
- **`auto_transcribing`**
`boolean` — Whether to allow a live transcription service to transcribe meetings.
- **`enable`**
`boolean` — Whether to allow the host to type closed captions or assign a participant or 3rd-party service to provide closed captioning.
- **`save_caption`**
`boolean` — Whether to allow participants to save closed captions or transcripts.
- **`third_party_captioning_service`**
`boolean` — Whether to allow the use of an API token to integrate with 3rd-party closed captioning services.
- **`view_full_transcript`**
`boolean` — Whether to allow the viewing of full transcripts in the in-meeting side panel.
- **`co_host`**
`boolean` — Whether to allow the meeting host to add co-hosts.
- **`custom_data_center_regions`**
`boolean` — Whether custom \[data center regions]\(https\://support.zoom.us/hc/en-us/articles/360042411451-Selecting-data-center-regions-for-hosted-meetings-and-webinars) are enabled for hosting real-time meeting and webinar traffic: \* \`true\` — Enabled. Provide the data center regions in the \`data\_center\_regions\` field. \* \`false\` — Disabled. Only use the default data center regions.
- **`custom_live_streaming_service`**
`boolean` — Whether to allow custom livestreaming.
- **`custom_service_instructions`**
`string` — The custom livestreaming service instructions.
- **`data_center_regions`**
`array` — The user's selected custom data center regions. This field only returns if the \`custom\_data\_center\_regions\` value is \`true\`: \* \`AU\` — Australia. \* \`LA\` — Latin America. \* \`CA\` — Canada. \* \`CN\` — China. \* \`DE\` — Germany. \* \`HK\` — Hong Kong SAR. \* \`IN\` — India. \* \`IE\` — Ireland. \* \`TY\` — Japan. \* \`MX\` — Mexico. \* \`NL\` — Netherlands. \* \`SG\` — Singapore. \* \`US\` — United States.
**Items:**
`string`, possible values: `"AU", "LA", "CA", "CN", "DE", "HK", "IN", "IE", "TY", "MX", "NL", "SG", "US"`
- **`disable_screen_sharing_for_host_meetings`**
`boolean` — Whether the \*\*Disable desktop screen sharing for meetings you host\*\* setting is enabled.
- **`disable_screen_sharing_for_in_meeting_guests`**
`boolean` — Whether the \*\*Disable screen sharing when guests are in the meeting\*\* setting is enabled.
- **`dscp_audio`**
`integer` — The DSCP audio value.
- **`dscp_marking`**
`boolean` — Whether to use DSCP (differentiated services code point) marking.
- **`dscp_video`**
`integer` — The DSCP video value.
- **`e2e_encryption`**
`boolean` — Whether to require \[AES encryption]\(https\://en.wikipedia.org/wiki/Advanced\_Encryption\_Standard) for meetings.
- **`far_end_camera_control`**
`boolean` — Whether another user can take control of camera during a meeting.
- **`feedback`**
`boolean` — Whether users can send feedback to Zoom at the end of the meeting.
- **`file_transfer`**
`boolean` — Whether file sharing via in-meeting chat is enabled.
- **`group_hd`**
`boolean` — Whether higher quality video for the host and participants is enabled.
- **`join_from_desktop`**
`boolean` — Whether participants can join a meeting directly from their desktop browser.
- **`join_from_mobile`**
`boolean` — Whether participants can join a meeting directly from their mobile browser.
- **`language_interpretation`**
`object` — Information about the \[language interpretation]\(https\://support.zoom.us/hc/en-us/articles/360034919791-Using-Language-Interpretation-in-your-meeting-or-webinar) settings.
- **`allow_participants_to_speak_in_listening_channel`**
`boolean` — Whether to allow participants to speak in listening channel.
- **`allow_up_to_25_custom_languages_when_scheduling_meetings`**
`boolean` — Whether to allow up to 25 custom languages when scheduling meetings.
- **`custom_languages`**
`array` — A list of user-defined supported languages.
**Items:**
`string`
- **`enable`**
`boolean` — Whether hosts can assign participants as interpreters to interpret one language into another in real-time.
- **`enable_language_interpretation_by_default`**
`boolean` — Whether enable language interpretation by default.
- **`languages`**
`array`, possible values: `"English", "Chinese", "Japanese", "German", "French", "Russian", "Portuguese", "Spanish", "Korean"` — A list of system-supported languages.
**Items:**
`string`
- **`live_streaming_facebook`**
`boolean` — Whether to allow Facebook livestreaming.
- **`live_streaming_youtube`**
`boolean` — Whether to allow YouTube livestreaming.
- **`meeting_polling`**
`object` — Information about the account's meeting polling settings.
- **`advanced_polls`**
`boolean` — Whether the host can 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.
- **`allow_alternative_host_to_add_edit`**
`boolean` — Whether alternative hosts can add or edit polls and quizzes.
- **`allow_host_to_upload_image`**
`boolean` — Whether to allow host to upload an image for each question.
- **`enable`**
`boolean` — Whether the host can add polls before or during a meeting.
- **`manage_saved_polls_and_quizzes`**
`boolean` — Whether to allow users to manage saved polls and quizzes from Meetings
- **`require_answers_to_be_anonymous`**
`boolean` — Whether to require answers to be anonymous.
- **`meeting_question_answer`**
`boolean` — Allow participants to ask questions for the host and participants to answer.
- **`meeting_reactions`**
`boolean` — 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.
- **`meeting_reactions_emojis`**
`string`, possible values: `"all", "selected"` — Choose from the following meeting reaction options: \* \`all\` — All emojis: Allow meeting participants to use any emoji available in Zoom chat as a reaction in a meeting. \* \`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)
- **`meeting_survey`**
`boolean` — 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.
- **`non_verbal_feedback`**
`boolean`, default: `false` — 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\`.
- **`original_audio`**
`boolean` — Whether users can select original sound in their client settings.
- **`p2p_connetion`**
`boolean` — Whether peer-to-peer connection when only two people are in a meeting is enabled.
- **`p2p_ports`**
`boolean` — Whether a peer-to-peer listening ports range is enabled.
- **`participants_share_simultaneously`**
`string`, possible values: `"multiple", "one"` — Indicates how many participants can screen share at the same time. The value can be one of the following:\
\`one\`: Only one participant can screen share at a time .\
\`multiple\`: Multiple participants can screen share simultaneously (dual monitors recommended).
- **`polling`**
`boolean` — Whether polls are available in the meeting controls.
- **`ports_range`**
`string` — The comma-separated peer-to-peer listening ports range (for example, \`55,56\`), between 1 to 65535.
- **`post_meeting_feedback`**
`boolean` — Whether to display a post-meeting feedback survey at the end of a meeting.
- **`private_chat`**
`boolean` — Whether meeting participants can use private chat.
- **`remote_control`**
`boolean` — Whether users can request remote control.
- **`remote_support`**
`boolean`, default: `false` — Whether to enable the \[\*\*Remote support\*\*]\(https\://support.zoom.us/hc/en-us/articles/360060951012-Enabling-remote-support) setting. This value defaults to \`false\`.
- **`screen_sharing`**
`boolean` — Whether to allow screen sharing.
- **`sending_default_email_invites`**
`boolean` — Whether to display the default email when sending email invites.
- **`show_a_join_from_your_browser_link`**
`boolean` — Whether participants can join a meeting directly from their browser and bypass the Zoom application download process.
- **`show_meeting_control_toolbar`**
`boolean` — Whether to always display the meeting control bar.
- **`sign_language_interpretation`**
`object` — 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.
- **`custom_languages`**
`array` — A list of user-defined supported languages.
**Items:**
`string`
- **`enable`**
`boolean` — Whether to allow hosts to assign participants as sign language interpreters who can interpret one language into another in real-time.
- **`enable_sign_language_interpretation_by_default`**
`boolean` — Whether to enable sign language interpretation view by default in scheduler.
- **`languages`**
`array` — A list of system-supported languages.
**Items:**
`string`, possible values: `"American", "Chinese", "French", "German", "Japanese", "Russian", "Brazilian", "Spanish", "Mexican", "British"`
- **`slide_control`**
`boolean` — 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.
- **`stereo_audio`**
`boolean` — Whether users can select stereo audio in their client settings.
- **`use_html_format_email`**
`boolean` — Whether to use HTML-formatted email for the Outlook plugin.
- **`virtual_background`**
`boolean` — Whether users can change their background.
- **`watermark`**
`boolean` — Whether to add watermark when viewing a shared screen.
- **`watermark_by_default`**
`boolean` — Whether to turn on watermark by default when scheduling a meeting.
- **`webinar_chat`**
`object`
- **`allow_attendees_chat_with`**
`integer`, possible values: `1, 2, 3` — Webinar attendees can chat with: \* \`1\` — No one. \* \`2\` — Host and all panelists. \* \`3\` — Everyone.
- **`allow_auto_save_local_chat_file`**
`boolean` — Whether chat messages are saved automatically to a local file on the host's computer when the webinar ends.
- **`allow_panelists_chat_with`**
`integer`, possible values: `1, 2` — Webinar panelists can chat with: \* \`1\` — Host and all panelists. \* \`2\` — Everyone.
- **`allow_panelists_send_direct_message`**
`boolean` — Whether webinar panelists can send direct messages to other panelists.
- **`allow_users_save_chats`**
`integer`, possible values: `0, 1, 2` — Whether webinar attendees can save chats: \* \`0\` — Attendees cannot save chats. \* \`1\` — Attendees can only save host and panelist chats. \* \`2\` — Attendees can save all chats.
- **`default_attendees_chat_with`**
`integer`, possible values: `1, 2` — By default, webinar attendees can chat with: \* \`1\` — Host and all panelists. \* \`2\` — Everyone.
- **`enable`**
`boolean` — Whether webinar participants can send chat messages.
- **`webinar_live_streaming`**
`object`
- **`custom_service_instructions`**
`string` — The specific instructions that allow the account's meeting hosts to configure a custom livestream.
- **`enable`**
`boolean` — Whether webinar livestreaming is enabled.
- **`live_streaming_reminder`**
`boolean` — Whether to notify users to watch the livestream. This does not apply to custom RTMP (real-time messaging protocol).
- **`live_streaming_service`**
`array` — The available livestreaming services: \* \`facebook\` \* \`workplace\_by\_facebook\` \* \`youtube\` \* \`custom\_live\_streaming\_service\`
**Items:**
`string`, possible values: `"facebook", "workplace_by_facebook", "youtube", "custom_live_streaming_service"`
- **`webinar_polling`**
`object` — Information about the account's webinar polling settings.
- **`advanced_polls`**
`boolean` — Whether the host can 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.
- **`allow_alternative_host_to_add_edit`**
`boolean` — Whether alternative hosts can add or edit polls and quizzes.
- **`allow_host_to_upload_image`**
`boolean` — Whether to allow host to upload an image for each question.
- **`enable`**
`boolean` — Whether the host can add polls before or during a webinar.
- **`manage_saved_polls_and_quizzes`**
`boolean` — Whether to allow users to manage saved polls and quizzes from Meetings
- **`require_answers_to_be_anonymous`**
`boolean` — Whether to require answers to be anonymous.
- **`webinar_question_answer`**
`boolean` — Whether Q\&A is enabled in a webinar.
- **`webinar_reactions`**
`boolean` — Set this field to true to use \[webinar reactions]\(https\://support.zoom.us/hc/en-us/articles/4803536268429).
- **`webinar_survey`**
`boolean` — Whether to allow the host to present surveys to attendees once a webinar has ended.
- **`whiteboard`**
`boolean` — Whether participants can share a whiteboard that includes annotation tools.
- **`who_can_share_screen`**
`string`, possible values: `"host", "all"` — The type of user who can share their screen or content during meetings: \* \`host\` — Only hosts can screen share. \* \`all\` — Both hosts and participants can screen share.
- **`who_can_share_screen_when_someone_is_sharing`**
`string`, possible values: `"host", "all"` — The type of user that can begin sharing their screen when someone else in the meeting is sharing their screen: \* \`host\` — Only hosts can screen share when someone else is sharing. \* \`all\` — Both hosts and participants can screen share when someone else is sharing.
- **`workplace_by_facebook`**
`boolean` — Whether to allow Workplace by Facebook livestreaming.
- **`in_session`**
`object`
- **`custom_data_center_regions`**
`boolean` — Whether to use custom \[data center regions]\(https\://support.zoom.us/hc/en-us/articles/360042411451-Selecting-data-center-regions-for-meetings-webinars): \* \`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. \* \`false\` — Only use the default data center regions.
- **`data_center_regions`**
`array` — 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: \* \`AU\` — Australia. \* \`LA\` — Latin America. \* \`CA\` — Canada. \* \`CN\` — China. \* \`DE\` — Germany. \* \`HK\` — Hong Kong SAR. \* \`IN\` — India. \* \`IE\` — Ireland. \* \`TY\` — Japan. \* \`MX\` — Mexico. \* \`NL\` — Netherlands. \* \`SG\` — Singapore. \* \`US\` — United States.
**Items:**
`string`, possible values: `"AU", "LA", "CA", "CN", "DE", "HK", "IN", "IE", "TY", "MX", "NL", "SG", "US"`
- **`dscp_audio`**
`integer`, default: `56` — The DSCP audio marking value. This value defaults to \`56\`.
- **`dscp_dual`**
`boolean` — Whether to use the differentiated services code point classifiers ('dscp\_video', 'dscp\_audio') in the dual way (incoming and outgoing).
- **`dscp_marking`**
`boolean` — Whether to enable \[differentiated services code point (DSCP)]\(https\://en.wikipedia.org/wiki/Differentiated\_services) marking.
- **`dscp_video`**
`integer`, default: `40` — The DSCP video marking value. This value defaults to \`40\`.
- **`p2p_connetion`**
`boolean` — 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.
- **`p2p_ports`**
`boolean` — Whether to enable the \*\*Listening ports range\*\* setting.
- **`ports_range`**
`string`, default: `""` — 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.
- **`subsession`**
`boolean` — Allow host to split meeting participants into separate, smaller rooms.
- **`integration`**
`object` — Information about integration settings
- **`box`**
`boolean` — Whether users who join a meeting from their mobile device can share content from their Box account.
- **`dropbox`**
`boolean` — Whether users who join a meeting from their mobile device can share content from their Dropbox account.
- **`google_calendar`**
`boolean` — Whether meetings can be scheduled using Google Calendar.
- **`google_drive`**
`boolean` — Whether users who join a meeting from their mobile device can share content from their Google Drive.
- **`kubi`**
`boolean` — Whether users can control a connected Kubi device from within a Zoom meeting.
- **`microsoft_one_drive`**
`boolean` — Whether users who join a meeting from their mobile device can share content from their Microsoft OneDrive account.
- **`mail_calendar`**
`object` — Email and calendar related settings.
- **`email_calendar_management`**
`boolean` — Allow the Zoom client to manage both emails and calendar events for the user.
- **`email_management`**
`boolean` — Allow the Zoom client to manage user emails.
- **`zoom_email_provider`**
`boolean` — Allow users to select Zoom as their email service provider.
- **`meeting_security`**
`object`
- **`auto_security`**
`boolean` — Whether to require that all meetings are secured with at least one security option. This setting can only be disabled by Enterprise, ISV, Business (with more than 100 licenses), and Education accounts.
- **`block_user_domain`**
`boolean` — Whether to block users in specific domains from joining meetings and webinars.
- **`block_user_domain_list`**
`array` — The domain to block, up to 20 domains. For example, the \`\*.example.com\` domain.
**Items:**
`string`
- **`chat_etiquette_tool`**
`object` — Information about the \*\*Chat Etiquette\*\* Tool.
- **`enable`**
`boolean`, default: `false` — Whether to enable the \*\*Chat Etiquette Tool\*\*. This value defaults to \`false\`. The \*\*Chat Etiquette Tool\*\* allows you to define specific keywords and text patterns in chat to prevent users from inadvertently sharing unwanted messages.
- **`policies`**
`array` — Information about the defined \*\*Chat Etiquette Tool\*\* policies.
**Items:**
- **`description`**
`string` — The policy's description.
- **`id`**
`string` — The policy ID.
- **`is_locked`**
`boolean`, default: `false` — Whether to lock the policy. When it is locked, users cannot update the policy. This value defaults to \`false\`.
- **`keywords`**
`array` — A list of defined rule keywords.
**Items:**
`string`
- **`name`**
`string` — The policy name.
- **`regular_expression`**
`string` — The regular expression to match to the content of chat messages.
- **`status`**
`string`, possible values: `"activated", "deactivated"` — The policy's current status: \* \`activated\` — Activated. \* \`deactivated\` — Deactivated.
- **`trigger_action`**
`integer`, possible values: `1, 2` — The policy's trigger action: \* \`1\` — Ask the user to confirm before they send the message. \* \`2\` — Block the user's message.
- **`embed_password_in_join_link`**
`boolean` — Whether the meeting password will be encrypted and included in the invitation link. The provided link will allow participants to join the meeting without having to enter the password.
- **`encryption_type`**
`string`, possible values: `"enhanced_encryption", "e2ee"` — The type of encryption to use when starting a meeting: \* \`enhanced\_encryption\` — Use enhanced encryption. Encryption data is stored in the cloud. \* \`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.
- **`end_to_end_encrypted_meetings`**
`boolean` — Whether to enable end-to-end encryption for meetings. If enabled, you can specify the type of encryption in the \`encryption\_type\` field.
- **`meeting_password`**
`boolean` — Whether all instant and scheduled meetings that users can join via client or Zoom Rooms systems are password-protected. \[Personal Meeting ID (PMI)]\(https\://support.zoom.us/hc/en-us/articles/203276937) meetings are \*\*not\*\* included in this setting.
- **`meeting_password_requirement`**
`object` — Information about the meeting and webinar \[password requirements]\(https\://support.zoom.us/hc/en-us/articles/360033559832-Meeting-and-webinar-passwords#h\_a427384b-e383-4f80-864d-794bf0a37604).
- **`consecutive_characters_length`**
`integer`, possible values: `0, 4, 5, 6, 7, 8` — The maximum length of consecutive characters (for example, \`abcdef\`) allowed in a password: \* \`4\` through \`8\` — The maximum consecutive characters length. The length is \`n\` minus \`1\`, where \`n\` is the provided value. For example, if you provide the \`4\` value, there can only be a maximum of \`3\` consecutive characters in a password (for example, \`abc1x\@8fdh\`). \* \`0\` — Do not apply a consecutive character restriction.
- **`have_letter`**
`boolean` — Whether the password must contain at least one letter character.
- **`have_number`**
`boolean` — Whether the password must contain at least one numeric character.
- **`have_special_character`**
`boolean` — Whether the password must contain at least one special character. For example, \`!\`, \`@\`, and/or \`#\` characters.
- **`have_upper_and_lower_characters`**
`boolean` — Whether the password must include uppercase and lowercase characters.
- **`length`**
`integer` — The password's minimum length.
- **`only_allow_numeric`**
`boolean` — Whether the password must contain \*\*only\*\* numeric characters.
- **`weak_enhance_detection`**
`boolean` — Whether users will be informed when the provided password is weak.
- **`only_authenticated_can_join_from_webclient`**
`boolean` — Whether to specify that only authenticated users can join the meeting from the web client.
- **`phone_password`**
`boolean` — Whether to require a password for participants joining by phone. If enabled and the meeting is password-protected, a numeric password is required for participants to join by phone. For meetings with alphanumeric passwords, a numeric password will be generated.
- **`pmi_password`**
`boolean` — Whether all Personal Meeting ID (PMI) meetings that users can join via client or Zoom Rooms systems are password-protected.
- **`require_password_for_scheduled_meeting`**
`boolean` — Whether to require a password for meetings that have already been scheduled.
- **`require_password_for_scheduled_webinar`**
`boolean` — Whether to require a password for webinars that have already been scheduled.
- **`waiting_room`**
`boolean` — Whether participants are placed in the \[\*\*Waiting Room\*\*]\(https\://support.zoom.us/hc/en-us/articles/115000332726-Waiting-Room) when they join a meeting. 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.
- **`waiting_room_settings`**
`object` — Information about the waiting room settings.
- **`participants_to_place_in_waiting_room`**
`integer`, possible values: `0, 1, 2` — The type of participants to be admitted to the Waiting Room: \* \`0\` — All attendees. \* \`1\` — Users who are not in your account. \* \`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).
- **`users_who_can_admit_participants_from_waiting_room`**
`integer`, possible values: `0, 1` — The users who can admit participants from the Waiting Room: \* \`0\` — Host and co-hosts only. \* \`1\` — Host, co-hosts, and anyone who bypassed the Waiting Room if the host and co-hosts are not present.
- **`whitelisted_domains_for_waiting_room`**
`string` — 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").
- **`webinar_password`**
`boolean` — Whether to generate a password when scheduling webinars. Participants must use the generated password to join the scheduled webinar.
- **`other_options`**
`object`
- **`allow_auto_active_users`**
`boolean` — Whether administrators can activate users with a single default password when they add users. This immediately activates the users without waiting for them to set their own password.
- **`allow_users_contact_support_via_chat`**
`boolean` — Whether to display the Zoom Help badge on the bottom-right of the page.
- **`allow_users_enter_and_share_pronouns`**
`boolean` — Whether users can add pronouns to their profile cards and share them during meetings and webinars.
- **`blur_snapshot`**
`boolean` — Whether iOS blurs the screenshot in the task switcher when multiple apps are open. Android hides the screenshot in the system-level list of recent apps.
- **`display_meetings_scheduled_for_others`**
`boolean` — Whether a user with the \[scheduling privilege]\(https\://support.zoom.us/hc/en-us/articles/201362803-Scheduling-privilege) can view other users' meetings.
- **`meeting_qos_and_mos`**
`integer`, possible values: `0, 1, 2, 3` — The Dashboard meeting \[quality scores and network alerts]\(https\://support.zoom.us/hc/en-us/articles/360061244651) setting: \* \`0\` — Do not enable meeting quality scores and network alerts on the Dashboard. \* \`1\` — Display the meeting quality score and network alerts on the Dashboard. \* \`2\` — Use custom thresholds for quality scores and network alerts. \* \`3\` —Both Use custom thresholds for quality scores and network alerts and Display the meeting quality score and network alerts on the Dashboard.
- **`show_one_user_meeting_on_dashboard`**
`boolean` — Whether meetings with only one person will display on the Dashboard and in reports.
- **`use_cdn`**
`string`, possible values: `"none", "default", "wangsu"` — 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: \* \`none\` — Do not use a CDN. \* \`default\` — Use the Amazon CloudFront CDN for users \*\*except\*\* Chinese Mainland users. Chinese Mainland users will use the Wangsu CDN (China). \* \`wangsu\` — Use the Wangsu CDN for all users.
- **`webinar_registration_options`**
`object` — Webinar registration options.
- **`allow_host_to_enable_social_share_buttons`**
`boolean` — Allow host to enable "Show social share buttons on registration page"
- **`recording`**
`object` — Information about recording settings.
- **`account_user_access_recording`**
`boolean` — Whether cloud recordings are only accessible to account members. People outside of your organization \*\*cannot\*\* open links that provide access to cloud recordings.
- **`allow_recovery_deleted_cloud_recordings`**
`boolean` — Whether the recovery of deleted cloud recordings from the trash is enabled. If enabled, then deleted cloud recordings are kept in the trash for 30 days after deletion. The recordings can be recovered within that period.
- **`archive`**
`object` — Information about the \[archiving solution]\(https\://support.zoom.us/hc/en-us/articles/360050431572-Archiving-Meeting-and-Webinar-data) settings. This is only available if granted archiving solution access by the Zoom support team.
- **`enable`**
`boolean` — Whether the archiving feature is enabled.
- **`settings`**
`object`
- **`action_when_archive_failed`**
`integer`, possible values: `1, 2` — Perform the action when meetings or webinars cannot be archived.\
\`1\` - Participants can stay in the meeting and will receive a notification.\
\`2\` - Nobody can join or stay in the meeting.
- **`archive_retention`**
`integer`, possible values: `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` — The retention period for archiving content, in days.
- **`audio_file`**
`boolean` — Whether to include in-meeting and/or in-webinar audio in the archive.
- **`cc_transcript_file`**
`boolean` — Whether to include closed captions or transcripts in the archive.
- **`chat_file`**
`boolean` — Whether to include in-meeting chat in the archive.
- **`chat_with_direct_message`**
`object` — Include direct message in in-meeting chat file.
- **`chat_with_sender_email`**
`boolean` — Whether to include user emails in the in-meeting chat file.
- **`notification_when_archiving_starts`**
`string`, possible values: `"participants", "guest"` — Show notification when video or audio archiving starts.\
\`1\` - Participants can stay in the meeting and will receive a notification.\
\`2\` - Nobody can join or stay in the meeting.
- **`play_voice_prompt_when_archiving_starts`**
`string`, possible values: `"participants", "guest", "none"` — Play voice prompt when video or audio archiving starts.\
\`1\` - Participants can stay in the meeting and will receive a notification.\
\`2\` - Nobody can join or stay in the meeting.
- **`video_file`**
`boolean` — Whether to include in-meeting and/or in-webinar video in the archive.
- **`type`**
`integer`, possible values: `1, 2, 3` — The archive solution type: \* \`1\` — Only meetings are archived. \* \`2\` — Only webinars are archived. \* \`3\` — Both meetings and webinars are archived.
- **`ask_host_to_confirm_disclaimer`**
`boolean` — Whether to ask the host to confirm the recording disclaimer is enabled.
- **`ask_participants_to_consent_disclaimer`**
`boolean` — Whether to ask participants for consent when a recording begins is enabled. This is only available when the value of the \`recording\_disclaimer\` field is set to \`true\`.
- **`auto_delete_cmr`**
`boolean` — Whether Zoom will permanently delete recordings automatically after a specified number of days is enabled. The number of days is displayed in the \`auto\_delete\_cmr\_days\` field.
- **`auto_delete_cmr_days`**
`integer`, possible values: `30, 60, 90, 120` — When the \`auto\_delete\_cmr\` value is \`true\`, this value is the number of days before the auto-deletion of cloud recordings: \* \`30\` — 30 days. \* \`60\` — 60 days. \* \`90\` — 90 days. \* \`120\` — 120 days.
- **`auto_recording`**
`string` — The automatic recording setting: \* \`local\` — Record locally \* \`cloud\` — Record on the cloud. \* \`none\` — Disabled.
- **`cloud_recording`**
`boolean` — Whether hosts can record and save the meeting in the cloud.
- **`cloud_recording_download`**
`boolean` — Whether cloud recording downloads are enabled.
- **`cloud_recording_download_host`**
`boolean` — Whether only the host can download cloud recordings.
- **`display_participant_name`**
`boolean` — Whether participants' names display in the recording.
- **`host_delete_cloud_recording`**
`boolean` — Whether the host can delete recordings. If this is disabled, the recordings cannot be deleted by the host. Only an administrator can delete the recordings.
- **`host_pause_stop_recording`**
`boolean` — Whether the meeting's host can pause or stop the cloud's auto recording is enabled.
- **`ip_address_access_control`**
`object` — Information about the settings to allow cloud recording access only from specific IP address ranges.
- **`enable`**
`boolean` — Whether the cloud recordings of the account can only be accessed by the IP addresses defined in the \`ip\_addresses\_or\_ranges\` property.
- **`ip_addresses_or_ranges`**
`string` — The IP addresses or ranges that have access to the cloud recordings.
- **`local_recording`**
`boolean` — Whether hosts and participants can record the meeting using a local file.
- **`optimize_recording_for_3rd_party_video_editor`**
`boolean` — Whether recordings will be optimized for a 3rd party video editor. This can increase the file size and the time it takes to generate recording files.
- **`prevent_host_access_recording`**
`boolean` — Whether meeting hosts are prevented from accessing their meeting cloud recordings. Only the administrators with recording management privileges can access them.
- **`record_audio_file`**
`boolean` — Whether recording an audio-only file is enabled.
- **`record_audio_file_each_participant`**
`boolean` — Whether to record separate audio files for each participant is enabled.
- **`record_files_separately`**
`object` — 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.
- **`active_speaker`**
`boolean` — Whether recording only the active speaker is enabled.
- **`gallery_view`**
`boolean` — Whether recording only the gallery view is enabled.
- **`shared_screen`**
`boolean` — Whether recording only the gallery view is enabled.
- **`record_gallery_view`**
`boolean` — Whether recording the \[gallery view]\(https\://support.zoom.us/hc/en-us/articles/360000005883-Displaying-Participants-in-Gallery-View) with a shared screen is enabled.
- **`record_speaker_view`**
`boolean` — Whether recording the active speaker with a shared screen is enabled.
- **`recording_audio_transcript`**
`boolean` — Whether automatically transcribing the audio of the meeting or webinar to the cloud is enabled.
- **`recording_disclaimer`**
`boolean` — Whether to display a disclaimer to participants before a recording begins is enabled.
- **`recording_highlight`**
`boolean` — Whether the \[recording highlights]\(https\://support.zoom.us/hc/en-us/articles/360060802432) feature is enabled.
- **`recording_password_requirement`**
`object` — Information about the minimum password requirements for recordings via the Account Recording settings.
- **`have_letter`**
`boolean` — Whether the password must contain at least one alphabetical letter.
- **`have_number`**
`boolean` — Whether the password must contain at least one numeric character.
- **`have_special_character`**
`boolean` — Whether the password must contain at least one special character (for example, \`!\`, \`@\`, or \`#\`).
- **`length`**
`integer` — The password's minimum required length.
- **`only_allow_numeric`**
`boolean` — Whether the password must contain \*\*only\*\* numeric characters.
- **`recording_thumbnails`**
`boolean` — Whether thumbnails of the presenter are recorded when they are sharing their screen.
- **`save_chat_text`**
`boolean` — Whether saving the chat text from the meeting is enabled.
- **`save_close_caption`**
`boolean` — Whether \[closed captions]\(https\://support.zoom.us/hc/en-us/articles/207279736) are saved as a VTT (Video Track Text) file.
- **`save_panelist_chat`**
`boolean` — Whether panelist chats are saved to the recording.
- **`save_poll_results`**
`boolean` — Whether poll results shared during the meeting or webinar are saved. This also includes poll results shared during the meeting or webinar.
- **`show_timestamp`**
`boolean` — Whether adding a timestamp to the recording is enabled.
- **`smart_recording`**
`object` — 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.
- **`create_next_steps`**
`boolean` — By selecting this option, there will be a summary of actions to take after the recorded meeting.
- **`create_recording_highlights`**
`boolean` — 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.
- **`create_smart_chapters`**
`boolean` — By selecting this option, your recording will have chapters with overview. Hosts can edit the chapters.
- **`schedule_meeting`**
`object` — Information about the schedule meeting settings.
- **`always_display_zoom_meeting_as_topic`**
`object` — 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.
- **`display_topic_for_scheduled_meetings`**
`boolean` — Whether to display "Zoom Meeting" as the topic for already-scheduled meetings.
- **`enable`**
`boolean` — Whether the \*\*Always display "Zoom Meeting" as the meeting topic\*\* setting is enabled.
- **`always_display_zoom_webinar_as_topic`**
`object` — 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.
- **`display_topic_for_scheduled_webinars`**
`boolean` — Whether to display "Zoom Webinar" as the topic for already-scheduled meetings.
- **`enable`**
`boolean` — Whether the \*\*Always show "Zoom Webinar" as the webinar topic\*\* setting is enabled.
- **`audio_type`**
`string` — The type of audio used to join the meeting.
- **`enforce_login`**
`boolean` — Whether only users who are signed in to Zoom can join meetings.
- **`enforce_login_domains`**
`string` — The specified domains for users to sign in to in order to join meetings.
- **`enforce_login_with_domains`**
`boolean` — Whether only users with a specific domain can join meetings.
- **`force_pmi_jbh_password`**
`boolean` — Whether to require a password for personal meetings if attendees can join before host.
- **`hide_meeting_description`**
`object` — Information about the \*\*Hide meeting description\*\* feature.
- **`enable`**
`boolean` — Whether the \*\*Hide meeting description\*\* setting is enabled.
- **`hide_description_for_scheduled_meetings`**
`boolean` — Whether to hide the description for already-scheduled meetings.
- **`hide_webinar_description`**
`object` — Information about the \*\*Hide webinar description\*\* feature.
- **`enable`**
`boolean` — Whether the \*\*Hide webinar description\*\* setting is enabled.
- **`hide_description_for_scheduled_webinars`**
`boolean` — Whether to hide webinar description for the webinars which have already been scheduled.
- **`host_video`**
`boolean` — Whether to start meetings with the host video on.
- **`jbh_time`**
`integer`, possible values: `0, 5, 10, 15` — If the value of the \`join\_before\_host\` field is \`true\`, this field indicates the time limits within which a participant can join a meeting before the meeting's host: \* \`0\` — Allow the participant to join the meeting at anytime. \* \`5\` — Allow the participant to join 5 minutes before the meeting's start time. \* \`10\` — Allow the participant to join 10 minutes before the meeting's start time.
- **`join_before_host`**
`boolean` — Whether participants can join the meeting before its host.
- **`mute_upon_entry`**
`boolean` — Whether to automatically mute all participants when they join the meeting.
- **`not_store_meeting_topic`**
`boolean` — Whether to display the "Zoom Meeting" message as the meeting's topic.
- **`participant_video`**
`boolean` — Whether to start meetings with the participant video on.
- **`personal_meeting`**
`boolean` — The personal meeting settings: \* \`true\` — Indicates that the \*\*Enable Personal Meeting ID\*\* setting is enabled. Users can use a personal meeting ID for their meetings. \* \`false\` — Indicates that the \*\*Enable Personal Meeting ID\*\* setting is \[disabled]\(https\://support.zoom.us/hc/en-us/articles/201362843-Personal-meeting-ID-PMI-and-personal-link#h\_aa0335c8-3b06-41bc-bc1f-a8b84ef17f2a). When this setting is \*\*disabled\*\*, meetings that were scheduled with a PMI will be invalid. You must manually update any scheduled meetings. \*\*For Zoom Phone only:\*\* If a user has been assigned a desk phone, the desk phone's \*\*Elevate to Zoom Meeting\*\* setting will be disabled.
- **`pmi_password`**
`string` — The PMI's password.
- **`pstn_password_protected`**
`string` — Require a password from participants before joining a meeting via \[PSTN]\(https\://support.zoom.us/hc/en-us/articles/204517069-Getting-Started-with-Personal-Audio-Conference).
- **`require_password_for_instant_meetings`**
`boolean` — Whether a random password will be generated on the end of user who starts the instant meeting. Other meeting participants \*\*must\*\* enter the generated password to join the meeting. If instant meetings use a PMI, this option is \*\*disabled\*\*.
- **`require_password_for_pmi_meetings`**
`string`, possible values: `"jbh_only", "all", "none"` — Require participants to enter password for PMI meetings: \* \`jbh\_only\` — Only when a participant joins before the host. \* \`all\` — All participants must enter a password to join the meeting. \* \`none\` — No password required.
- **`require_password_for_scheduling_new_meetings`**
`boolean` — Whether a password is generated when a meeting host schedules a new meeting. Meeting participants will be required to enter the password before they can join the meeting. This setting only applies to regular meetings that do \*\*not\*\* use a PMI.
- **`upcoming_meeting_reminder`**
`boolean` — Whether to receive a desktop notification for upcoming meetings.
- **`use_pmi_for_instant_meetings`**
`boolean` — Whether PMI is enabled for all instant meetings.
- **`use_pmi_for_scheduled_meetings`**
`boolean` — Use a \[PMI (Personal Meeting ID)]\(https\://support.zoom.us/hc/en-us/articles/203276937-Using-Personal-Meeting-ID-PMI-) to schedule meeting.
- **`security`**
`object` — Information about the security settings.
- **`admin_change_name_pic`**
`boolean` — Whether only account administrators can change a user's username and picture.
- **`hide_billing_info`**
`boolean` — Whether hiding of billing information is enabled.
- **`import_photos_from_devices`**
`boolean` — Whether users can import photos from a photo library on a device.
- **`password_requirement`**
`object` — Information about the \[enhanced password rules]\(https\://support.zoom.us/hc/en-us/articles/360034675592-Advanced-security-settings#h\_bf8a25f6-9a66-447a-befd-f02ed3404f89) that allows Zoom account administrators and owners to apply additinal requirements to the users' Zoom login password.
- **`consecutive_characters_length`**
`integer` — The password's maximum length of consecutive characters (for example, \`abcde\`). If this is a \`0\` value, there is no consecutive character restriction.
- **`have_special_character`**
`boolean` — Whether a password requires at least one special character (for example, \`!\`, \`@\`, and \`#\`).
- **`minimum_password_length`**
`integer` — A password's required minimum length value. The password length can be between a minimum of 8 characters, up to 14 characters. If this is a \`0\` value, this setting is \*\*disabled\*\* and is not used. The default password length requirement will be a minimum of 8 characters.
- **`weak_enhance_detection`**
`boolean` — Whether passwords must pass detection through a weak password dictionary.
- **`signin_with_sso`**
`object` — Allow users to sign in with single sign-on (SSO).
- **`domains`**
`array` — Users using these domains are required to sign in with single sign-on (SSO).
**Items:**
`string`
- **`enable`**
`boolean` — Whether to allow users to sign in with single sign-on (SSO). Enabling this requires you to configure your account's SSO settings. This lets users sign in with SSO through your company's vanity URL.
- **`require_sso_for_domains`**
`boolean` — Whether to require users to sign in with single sign-on (SSO) if their e-mail address belongs to one of the \`domains\`.
- **`sso_bypass_users`**
`array` — The users can bypass SSO sign-in.
**Items:**
- **`email`**
`string` — The user's email.
- **`id`**
`string` — The user's ID.
- **`session_security`**
`object`
- **`approved_or_denied_countries_or_regions`**
`object` — Approve or block users from specific regions or countries from joining this meeting.
- **`approved_list`**
`array` — List of countries/regions from where participants can join this meeting.
**Items:**
`string`
- **`denied_list`**
`array` — List of countries/regions from where participants can not join this meeting.
**Items:**
`string`
- **`enable`**
`boolean` — \`true\`: Setting enabled to either allow or block users from specific regions from joining your meetings. \
\`false\`: Setting disabled.
- **`method`**
`string`, possible values: `"approve", "deny"` — Specify whether to allow users from specific regions to join this meeting; or block users from specific regions from joining this meeting. \
\
\`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\`.\
\
\`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\`
- **`telephony`**
`object` — Information about telephony settings.
- **`audio_conference_info`**
`string` — Information about the third-party audio configuration.
- **`telephony_regions`**
`object` — Information about where most of the participants call into or call from during a meeting.
- **`allowed_values`**
`array` — The telephony region options provided by Zoom.
**Items:**
`string`
- **`selection_values`**
`string` — The account's selected telephony regions that indicates where most of the participants call into or call from during a meeting.
- **`third_party_audio`**
`boolean` — Whether users can join the meeting using an existing third-party audio configuration.
- **`tsp`**
`object` — Information about TSP settings.
- **`allow_webinar_attendees_call_me`**
`boolean` — Whether webinar attendees can use Call Me to connect audio. This feature is only available in version 5.2.2 and higher.
- **`allow_webinar_attendees_toll_free_dial`**
`boolean` — 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.
- **`call_out`**
`boolean` — Call Out
- **`call_out_countries`**
`array` — Call Out Countries/Regions
**Items:**
`string`
- **`display_toll_free_numbers`**
`boolean` — Display toll-free numbers
- **`global_dial_in_countries`**
`object` — The account's \*\*Global Dial-in Countries/Regions\*\* settings.
- **`selected_countries`**
`array` — 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:**
- **`code`**
`string` — The code of the country or region.
- **`name`**
`string` — The name of the country or region.
- **`show_international_numbers_link`**
`boolean` — Show international numbers link on the invitation email
- **`zoom_rooms`**
`object` — Information about the Zoom Rooms settings.
- **`auto_start_stop_scheduled_meetings`**
`boolean` — Whether an automatic start time and stop time for scheduled meetings is enabled.
- **`cmr_for_instant_meeting`**
`boolean` — Whether cloud recording for instant meetings is enabled.
- **`force_private_meeting`**
`boolean` — Whether to force all meetings to be \[private meetings]\(https\://support.zoom.us/hc/en-us/articles/115001051063-Zoom-Rooms-Private-Meetings).
- **`hide_host_information`**
`boolean` — Whether hiding of the host and meeting ID in private meetings is enabled.
- **`list_meetings_with_calendar`**
`boolean` — Whether to display meeting lists with calendar integration.
- **`start_airplay_manually`**
`boolean` — Whether to start the AirPlay service manually.
- **`ultrasonic`**
`boolean` — Whether the automatic direct sharing using an ultrasonic proximity signal is enabled.
- **`upcoming_meeting_alert`**
`boolean` — Whether upcoming meeting alerts are enabled.
- **`weekly_system_restart`**
`boolean` — Whether weekly system restarts are enabled.
- **`zr_post_meeting_feedback`**
`boolean` — Whether Zoom Room post-meeting feedback is enabled.
- **`operator`**
`string`, format: `email` — The email address of the user who updated the account's settings.
- **`operator_id`**
`string` — The user ID of the user who updated the account's settings.
- **`time_stamp`**
`integer` — A timestamp that indicates when the setting was updated.
**Example:**
```json
{
"event": "",
"event_ts": 1,
"payload": {
"account_id": "",
"operator": "",
"operator_id": "",
"object": {
"id": "",
"settings": {
"schedule_meeting": {
"host_video": true,
"participant_video": true,
"audio_type": "",
"join_before_host": true,
"enforce_login": true,
"enforce_login_with_domains": true,
"enforce_login_domains": "",
"not_store_meeting_topic": true,
"force_pmi_jbh_password": true,
"use_pmi_for_scheduled_meetings": true,
"pstn_password_protected": "",
"jbh_time": 0,
"personal_meeting": true,
"require_password_for_instant_meetings": true,
"mute_upon_entry": true,
"require_password_for_pmi_meetings": "jbh_only",
"use_pmi_for_instant_meetings": true,
"require_password_for_scheduling_new_meetings": true,
"pmi_password": "",
"upcoming_meeting_reminder": true,
"always_display_zoom_meeting_as_topic": {
"enable": true,
"display_topic_for_scheduled_meetings": true
},
"hide_meeting_description": {
"enable": true,
"hide_description_for_scheduled_meetings": true
},
"always_display_zoom_webinar_as_topic": {
"enable": true,
"display_topic_for_scheduled_webinars": true
},
"hide_webinar_description": {
"enable": true,
"hide_description_for_scheduled_webinars": true
}
},
"in_meeting": {
"e2e_encryption": true,
"chat": true,
"allow_users_to_delete_messages_in_meeting_chat": true,
"allow_participants_chat_with": 1,
"allow_users_save_chats": 1,
"private_chat": true,
"auto_saving_chat": true,
"file_transfer": true,
"feedback": true,
"post_meeting_feedback": true,
"co_host": true,
"polling": true,
"meeting_polling": {
"enable": true,
"advanced_polls": true,
"require_answers_to_be_anonymous": true,
"allow_alternative_host_to_add_edit": true,
"manage_saved_polls_and_quizzes": true,
"allow_host_to_upload_image": true
},
"attendee_on_hold": true,
"show_meeting_control_toolbar": true,
"allow_show_zoom_windows": true,
"annotation": true,
"whiteboard": true,
"webinar_question_answer": true,
"meeting_question_answer": true,
"anonymous_question_answer": true,
"breakout_room": true,
"breakout_room_schedule": true,
"closed_caption": true,
"far_end_camera_control": true,
"group_hd": true,
"virtual_background": true,
"watermark": true,
"watermark_by_default": true,
"audio_watermark_by_default": true,
"attention_mode_focus_mode": true,
"allow_host_to_enable_focus_mode": true,
"alert_guest_join": true,
"auto_answer": true,
"p2p_connetion": true,
"p2p_ports": true,
"ports_range": "",
"sending_default_email_invites": true,
"use_html_format_email": true,
"dscp_marking": true,
"dscp_audio": 1,
"dscp_video": 1,
"stereo_audio": true,
"original_audio": true,
"screen_sharing": true,
"remote_control": true,
"non_verbal_feedback": false,
"remote_support": false,
"custom_data_center_regions": true,
"data_center_regions": [
"AU"
],
"language_interpretation": {
"enable": true,
"enable_language_interpretation_by_default": true,
"allow_participants_to_speak_in_listening_channel": true,
"allow_up_to_25_custom_languages_when_scheduling_meetings": true,
"languages": "English",
"custom_languages": [
""
]
},
"sign_language_interpretation": {
"enable": true,
"enable_sign_language_interpretation_by_default": true,
"languages": [
"American"
],
"custom_languages": [
""
]
},
"meeting_reactions": true,
"meeting_reactions_emojis": "all",
"allow_host_panelists_to_use_audible_clap": true,
"webinar_reactions": true,
"show_a_join_from_your_browser_link": true,
"join_from_mobile": true,
"join_from_desktop": true,
"allow_live_streaming": true,
"live_streaming_facebook": true,
"workplace_by_facebook": true,
"live_streaming_youtube": true,
"custom_live_streaming_service": true,
"custom_service_instructions": "",
"webinar_live_streaming": {
"enable": true,
"live_streaming_service": [
"facebook"
],
"custom_service_instructions": "",
"live_streaming_reminder": true
},
"webinar_chat": {
"enable": true,
"allow_panelists_chat_with": 1,
"allow_attendees_chat_with": 1,
"default_attendees_chat_with": 1,
"allow_panelists_send_direct_message": true,
"allow_users_save_chats": 0,
"allow_auto_save_local_chat_file": true
},
"closed_captioning": {
"enable": true,
"third_party_captioning_service": true,
"auto_transcribing": true,
"view_full_transcript": true,
"save_caption": true
},
"slide_control": true,
"meeting_survey": true,
"webinar_polling": {
"enable": true,
"advanced_polls": true,
"require_answers_to_be_anonymous": true,
"allow_alternative_host_to_add_edit": true,
"manage_saved_polls_and_quizzes": true,
"allow_host_to_upload_image": true
},
"webinar_survey": true,
"disable_screen_sharing_for_host_meetings": true,
"disable_screen_sharing_for_in_meeting_guests": true,
"who_can_share_screen": "all",
"who_can_share_screen_when_someone_is_sharing": "host",
"participants_share_simultaneously": "multiple"
},
"email_notification": {
"cloud_recording_available_reminder": true,
"recording_available_reminder_schedulers": true,
"recording_available_reminder_alternative_hosts": true,
"jbh_reminder": true,
"cancel_meeting_reminder": true,
"low_host_count_reminder": true,
"alternative_host_reminder": true,
"schedule_for_reminder": true
},
"zoom_rooms": {
"upcoming_meeting_alert": true,
"start_airplay_manually": true,
"weekly_system_restart": true,
"list_meetings_with_calendar": true,
"zr_post_meeting_feedback": true,
"ultrasonic": true,
"force_private_meeting": true,
"hide_host_information": true,
"cmr_for_instant_meeting": true,
"auto_start_stop_scheduled_meetings": true
},
"security": {
"admin_change_name_pic": true,
"import_photos_from_devices": true,
"hide_billing_info": true,
"password_requirement": {
"minimum_password_length": 8,
"have_special_character": true,
"consecutive_characters_length": 1,
"weak_enhance_detection": true
},
"signin_with_sso": {
"enable": true,
"require_sso_for_domains": true,
"domains": [
"test.com",
"example.us"
],
"sso_bypass_users": [
{
"id": "21212_aefwef32233",
"email": "123@test.com"
}
]
}
},
"recording": {
"local_recording": true,
"cloud_recording": true,
"record_speaker_view": true,
"record_gallery_view": true,
"record_audio_file": true,
"save_chat_text": true,
"show_timestamp": true,
"recording_audio_transcript": true,
"auto_recording": "",
"cloud_recording_download": true,
"cloud_recording_download_host": true,
"account_user_access_recording": true,
"auto_delete_cmr": true,
"auto_delete_cmr_days": 30,
"record_files_separately": {
"active_speaker": true,
"gallery_view": true,
"shared_screen": true
},
"display_participant_name": true,
"recording_thumbnails": true,
"optimize_recording_for_3rd_party_video_editor": true,
"recording_highlight": true,
"smart_recording": {
"create_recording_highlights": true,
"create_smart_chapters": true,
"create_next_steps": true
},
"save_panelist_chat": true,
"save_poll_results": true,
"save_close_caption": true,
"record_audio_file_each_participant": true,
"host_pause_stop_recording": true,
"recording_disclaimer": true,
"ask_participants_to_consent_disclaimer": true,
"ask_host_to_confirm_disclaimer": true,
"recording_password_requirement": {
"length": 1,
"have_letter": true,
"have_number": true,
"have_special_character": true,
"only_allow_numeric": true
},
"ip_address_access_control": {
"enable": true,
"ip_addresses_or_ranges": ""
},
"prevent_host_access_recording": true,
"host_delete_cloud_recording": true,
"allow_recovery_deleted_cloud_recordings": true,
"archive": {
"enable": true,
"type": 1,
"settings": {
"chat_file": true,
"chat_with_sender_email": true,
"audio_file": true,
"video_file": true,
"cc_transcript_file": true,
"chat_with_direct_message": true,
"archive_retention": 1,
"action_when_archive_failed": 1,
"notification_when_archiving_starts": "participants",
"play_voice_prompt_when_archiving_starts": "participants"
}
}
},
"telephony": {
"third_party_audio": true,
"audio_conference_info": "",
"telephony_regions": {
"allowed_values": [
""
],
"selection_values": ""
}
},
"tsp": {
"call_out": true,
"call_out_countries": [
"us"
],
"allow_webinar_attendees_call_me": true,
"display_toll_free_numbers": true,
"allow_webinar_attendees_toll_free_dial": true,
"show_international_numbers_link": true,
"global_dial_in_countries": {
"selected_countries": [
{
"code": "CN",
"name": "China"
}
]
}
},
"integration": {
"google_calendar": true,
"google_drive": true,
"dropbox": true,
"box": true,
"microsoft_one_drive": true,
"kubi": true
},
"feature": {
"meeting_capacity": 1
},
"other_options": {
"allow_auto_active_users": true,
"blur_snapshot": true,
"display_meetings_scheduled_for_others": true,
"use_cdn": "none",
"allow_users_contact_support_via_chat": true,
"show_one_user_meeting_on_dashboard": true,
"meeting_qos_and_mos": 0,
"allow_users_enter_and_share_pronouns": true,
"webinar_registration_options": {
"allow_host_to_enable_social_share_buttons": true
}
},
"audio_conferencing": {
"toll_free_and_fee_based_toll_call": {
"enable": true,
"numbers": [
{
"code": "",
"country_code": "",
"country_name": "",
"number": "",
"display_number": ""
}
],
"allow_webinar_attendees_dial": true
},
"toll_call": {
"enable": true,
"numbers": [
{
"code": "86",
"country_code": "CN",
"country_name": "China",
"display_number": "+86 777 777 77",
"number": "777 777 77"
}
]
},
"call_me_and_invite_by_phone": {
"enable": true,
"require_press_1_for_call_me": "auto",
"call_out_countries": {
"selected_countries": [
{
"code": "CN",
"name": "China"
}
]
},
"allow_webinar_attendees_call_me": true
},
"personal_audio_conference": true,
"participant_phone_masking": {
"enable": true,
"masking_type": "mask_default"
},
"global_dial_in_countries": {
"selected_countries": [
{
"code": "CN",
"name": "China"
}
],
"include_toll_free": true
}
},
"chat": {
"allow_bots_chat": true,
"share_files": {
"enable": true,
"share_option": "account",
"view_option": "anyone",
"restrictions": {
"only_allow_specific_file_types": true,
"file_type_restrictions": [
".gz"
],
"file_type_restrictions_for_external": [
".gz"
],
"maximum_file_size": true,
"file_size_restrictions": 100,
"file_size_restrictions_for_external": 100,
"file_restrictions_apply_to": "sharing_and_viewing"
}
},
"chat_emojis": {
"enable": true,
"emojis_option": "all"
},
"record_voice_messages": true,
"record_video_messages": true,
"screen_capture": true,
"create_public_channels": true,
"create_private_channels": true,
"create_group_chat": true,
"share_links_in_chat": true,
"schedule_meetings_in_chat": true,
"set_retention_period_in_cloud": {
"enable": true,
"retention_period_of_direct_messages_and_group_conversation": "2m",
"retention_period_of_channels": "2m"
},
"set_retention_period_in_local": {
"enable": true,
"retention_period_of_direct_messages_and_group_conversation": "2m",
"retention_period_of_channels": "2m"
},
"allow_users_to_add_contacts": {
"enable": true,
"selected_option": 4,
"user_email_addresses": "123@test.com"
},
"allow_users_to_chat_with_others": {
"enable": true,
"selected_option": 4,
"user_email_addresses": "123@test.com"
},
"chat_etiquette_tool": {
"enable": true,
"policies": [
{
"description": "The policy's description",
"id": "afwef342tr2qfwrg",
"is_locked": true,
"keywords": [
"test"
],
"name": "The policy name",
"regular_expression": "^test",
"status": "activated",
"trigger_action": 1
}
],
"policy_max_count": 50
},
"send_data_to_third_party_archiving_service": {
"enable": true,
"type": "global_relay",
"smtp_delivery_address": "test@zoom.us",
"user_name": "test",
"passcode": "111111111",
"authorized_channel_token": "as1131zxwrwcssd32r4fkmaksjiajco999999999999a9qef23jr43twn4%^&IBNByeq"
},
"apply_local_storage_to_personal_channel": {
"enable": true,
"retention_period": "2m"
},
"translate_messages": true,
"search_and_send_animated_gif_images": {
"enable": true,
"giphy_content_rating": 1
},
"external_collab_restrict": {
"enable": true,
"external_chat": "allowed",
"group_id": "QSuHwTcvQoWPoG0ennkRug"
},
"external_user_control": {
"enable": true,
"selected_option": 1,
"external_account": true
},
"external_invite_approve": {
"enable": true,
"selected_option": 1,
"channel_id": "5fedbc697f8545aca465b5b114ad4275",
"external_account": true
},
"external_member_join": {
"enable": true,
"external_account": true
},
"external_join_approve": {
"enable": true,
"selected_option": 1,
"channel_id": "5fedbc697f8545aca465b5b114ad4275",
"external_account": true
},
"download_file": true,
"share_screen_in_chat": true,
"code_snippet": true,
"personal_channel": true,
"store_revise_chat": false,
"set_chat_as_default_tab": false,
"hyper_link": true,
"suppress_removal_notification": true,
"suppress_user_group_notification": false,
"allow_remove_msg_by_owner_and_admins": true,
"allow_huddles_from_channels": true,
"shared_spaces": true,
"chat_email_address": {
"enable": true,
"only_allow_specific_domains": false,
"specific_domains": [
"[\"example.com\"]"
]
},
"read_receipts": {
"enable": false,
"allow_users_opt_out": false
},
"allow_delete_message": {
"enable": true,
"time": 5
},
"allow_edit_message": {
"enable": true,
"time": 5
},
"show_status_to_internal_contact": true,
"presence_on_meeting": true,
"presence_away_when_screen_saver": false,
"show_h323_contact_tab": false,
"ai_summary": {
"enable": false,
"shown_in_team_chat": true
},
"ai_compose": {
"enable": false,
"shown_in_team_chat": true
},
"ai_recommend": false,
"ai_quick_reply": false,
"ai_sentence_completion": false,
"ai_quick_schedule": false,
"survey_poll": true
},
"meeting_security": {
"auto_security": true,
"waiting_room": true,
"waiting_room_settings": {
"participants_to_place_in_waiting_room": 0,
"whitelisted_domains_for_waiting_room": "",
"users_who_can_admit_participants_from_waiting_room": 0
},
"meeting_password": true,
"require_password_for_scheduled_meeting": true,
"pmi_password": true,
"phone_password": true,
"webinar_password": true,
"require_password_for_scheduled_webinar": true,
"meeting_password_requirement": {
"length": 1,
"have_letter": true,
"have_number": true,
"have_special_character": true,
"only_allow_numeric": true,
"have_upper_and_lower_characters": true,
"consecutive_characters_length": 0,
"weak_enhance_detection": true
},
"embed_password_in_join_link": true,
"end_to_end_encrypted_meetings": true,
"encryption_type": "enhanced_encryption",
"block_user_domain": true,
"block_user_domain_list": [
""
],
"only_authenticated_can_join_from_webclient": true,
"chat_etiquette_tool": {
"enable": false,
"policies": [
{
"id": "",
"name": "",
"description": "",
"trigger_action": 1,
"keywords": [
""
],
"regular_expression": "",
"status": "activated",
"is_locked": false
}
]
}
},
"in_session": {
"custom_data_center_regions": false,
"data_center_regions": [
"US"
],
"p2p_connetion": true,
"p2p_ports": true,
"ports_range": "1;65535",
"dscp_audio": 56,
"dscp_marking": true,
"dscp_video": 40,
"dscp_dual": false,
"subsession": true
},
"session_security": {
"approved_or_denied_countries_or_regions": {
"approved_list": [
"CX"
],
"denied_list": [
"CA"
],
"enable": true,
"method": "approve"
}
},
"mail_calendar": {
"email_calendar_management": true,
"email_management": true,
"zoom_email_provider": true
},
"general_setting": {
"auto_zoom_room_proximity_connect": true,
"show_zoom_room_feature": true
},
"h323sip_conferencing": {
"custom_welcome_audio": {
"enable": true,
"audio_file": "https://file-paa.zoom.us/bNbghCQbTYa_ml3QrsDpHQ/MS41LtClXjWRKeEPhw7xuW9bVORZ8nc-L0WtGlaitlWYw2Y7/FTxtmfjFTYS0pgQu_lo-NA"
}
},
"ai": {
"screen_share_ocr": true,
"meeting_chat_messages": true,
"full_display_names_in_ai_assets": true,
"ai_generated_virtual_backgrounds": true,
"meeting_agenda": true,
"meeting_summary_docs": {
"enable": true,
"share_with_summary_recipients": true
},
"phone_user_ai_notices": {
"enable": true,
"require_press_1_consent": true,
"multiple_notifications": true
},
"meeting_summary_retention": {
"enable": true,
"retention_days": 30
},
"meeting_summary_personal_data_redaction": {
"enable": true,
"personal_data_types": [
"NAME",
"EMAIL"
]
},
"meeting_summary_sensitive_data_filter": {
"enable": true,
"rules": [
{
"name": "Employee ID",
"regular_expression": "[0-9]{6}"
}
]
},
"meeting_coach": {
"enable": true,
"participant_scope": "participants_and_invitees_in_our_organization"
},
"third_party_meeting_join": {
"enable": true,
"allow_recording": true,
"calendar": {
"enable": true,
"join_scope": "all_events_with_video_conference_links"
},
"pre_meeting_email_notification": {
"enable": true,
"recipients": "all_invitees"
}
},
"whiteboard_content_generation": true,
"smart_recording": {
"create_recording_highlights": true,
"create_smart_chapters": true,
"create_next_steps": true
},
"task_creation_and_management": {
"enable": false,
"auto_generate_details": false,
"auto_generate_action": true,
"generate_from_transcripts": {
"enable": false,
"auto_share_with": "internal_participants",
"auto_assign_to_collaborator": true
},
"generate_from_phone_call": {
"enable": false,
"auto_add_participant_as_collaborator": true,
"auto_assign_to_collaborator": true
},
"generate_from_voicemail": false
},
"show_conversational_ai_companion": {
"enabled": true,
"enable_zoom_mate": true,
"delete_ai_conversation": true,
"delete_ai_conversation_time": 30
},
"ai_panel_in_workplace": {
"enabled": true,
"delete_ai_conversation": true,
"delete_ai_conversation_time": 30
},
"enable_ai_on_web": true,
"enable_email_compose_with_ai": true,
"microsoft_365": {
"enable": true,
"calendar_events": true,
"emails": true,
"documents": true
},
"google": {
"enable": true,
"calendar_events": true,
"emails": true,
"documents": true
},
"web_content": true,
"local_file_uploads": true,
"organization_custom_dictionaries": true,
"third_party_app_tasks": true,
"workspace_reservation_recommendations_with_ai": {
"enabled": true,
"day_recommendation": true,
"desk_recommendation": true,
"custom_workspaces_recommendation": true,
"room_recommendation": true,
"proactive_room_recommendation": true
},
"participant_can_request_aic_in_meeting": true,
"restrict_aic_when_external_user_join_meeting": true,
"restrict_users_from_joining_ai_enabled_meetings": {
"enable": true,
"join_notify": "notify_and_remove",
"apply_scope": "internal_and_external"
},
"meeting_questions": {
"enable": true,
"auto_enable": false,
"who_can_ask_questions": "org_from_join_meeting"
},
"meeting_summary": {
"enable": true,
"auto_enable": false,
"email_notification": true,
"whether_include_full_text_in_email": "include_full_text_in_email",
"restrict_share_to_outside_of_organization": true,
"restrict_summary_share": "external_users",
"who_will_receive_summary": "alt_host"
},
"meeting_summary_template": {
"enable": true,
"summary_template_id": "template_123"
},
"meeting_summary_default_language": {
"enable": true,
"language": "en-US"
},
"meeting_summary_ip_access": {
"enable": true,
"ip_addresses_or_ranges": "192.0.2.0/24"
},
"remind_me_turn_on_aic": true,
"remind_me_turn_on_catch_me_up": true,
"meeting_summary_email_only_mode": false,
"restrict_users_from_deleting_ai_companion_assets": true,
"restrict_users_from_editing_ai_companion_assets": true,
"webinar_summary_ocr": true,
"zoom_events_session_summary": {
"enable": true,
"auto_start": true
},
"zoom_events_chat_panel": true,
"zoom_events_analytics": true,
"zoom_events_chat_compose": true,
"zoom_events_email_compose": true,
"zoom_events_smart_compose": true,
"zoom_events_image_generation": true,
"zoom_events_smart_upload": true,
"zoom_events_content_generation": true,
"hub_ai_question_and_file_creation": true,
"canvas_ai_content_generation": true,
"canvas_ai_sentence_completion": true,
"canvas_ai_post_meeting_writing_tasks": true,
"paper_ai_content_generation": true,
"sheets_ai_content_generation": true,
"sheets_ai_formula": true,
"sheets_ai_function": true,
"sheets_ai_resources": true,
"slides_ai_content_generation": true,
"my_notes_meeting_transcription": true,
"my_notes_ai_content_generation": {
"enable": true,
"auto_generate_summary": true,
"auto_send_summary_email": true
},
"chat_summary": {
"enable": false,
"shown_in_team_chat": true
},
"chat_compose": {
"enable": false,
"shown_in_team_chat": true
},
"include_webinar_summary_follow_up_email": {
"enable": true,
"attendee_follow_up_email": true,
"absentee_follow_up_email": true
},
"zoom_events_content_studio": true,
"webinar_summary": {
"enable": true,
"auto_enable": false,
"email_notification": true,
"whether_include_full_text_in_email": "include_full_text_in_email",
"restrict_share_to_outside_of_organization": true,
"restrict_summary_share": "external_users",
"who_will_receive_summary": "host_and_panelist_in_organization"
},
"webinar_questions": {
"enable": true,
"auto_enable": false,
"who_can_ask_questions": "panelist_org"
}
}
}
},
"time_stamp": 1,
"old_object": {
"id": "",
"settings": {
"schedule_meeting": {
"host_video": true,
"participant_video": true,
"audio_type": "",
"join_before_host": true,
"enforce_login": true,
"enforce_login_with_domains": true,
"enforce_login_domains": "",
"not_store_meeting_topic": true,
"force_pmi_jbh_password": true,
"use_pmi_for_scheduled_meetings": true,
"pstn_password_protected": "",
"jbh_time": 0,
"personal_meeting": true,
"require_password_for_instant_meetings": true,
"mute_upon_entry": true,
"require_password_for_pmi_meetings": "jbh_only",
"use_pmi_for_instant_meetings": true,
"require_password_for_scheduling_new_meetings": true,
"pmi_password": "",
"upcoming_meeting_reminder": true,
"always_display_zoom_meeting_as_topic": {
"enable": true,
"display_topic_for_scheduled_meetings": true
},
"hide_meeting_description": {
"enable": true,
"hide_description_for_scheduled_meetings": true
},
"always_display_zoom_webinar_as_topic": {
"enable": true,
"display_topic_for_scheduled_webinars": true
},
"hide_webinar_description": {
"enable": true,
"hide_description_for_scheduled_webinars": true
}
},
"in_meeting": {
"e2e_encryption": true,
"chat": true,
"allow_users_to_delete_messages_in_meeting_chat": true,
"allow_participants_chat_with": 1,
"allow_users_save_chats": 1,
"private_chat": true,
"auto_saving_chat": true,
"file_transfer": true,
"feedback": true,
"post_meeting_feedback": true,
"co_host": true,
"polling": true,
"meeting_polling": {
"enable": true,
"advanced_polls": true,
"require_answers_to_be_anonymous": true,
"allow_alternative_host_to_add_edit": true,
"manage_saved_polls_and_quizzes": true,
"allow_host_to_upload_image": true
},
"attendee_on_hold": true,
"show_meeting_control_toolbar": true,
"allow_show_zoom_windows": true,
"annotation": true,
"whiteboard": true,
"webinar_question_answer": true,
"meeting_question_answer": true,
"anonymous_question_answer": true,
"breakout_room": true,
"breakout_room_schedule": true,
"closed_caption": true,
"far_end_camera_control": true,
"group_hd": true,
"virtual_background": true,
"watermark": true,
"watermark_by_default": true,
"audio_watermark_by_default": true,
"attention_mode_focus_mode": true,
"allow_host_to_enable_focus_mode": true,
"alert_guest_join": true,
"auto_answer": true,
"p2p_connetion": true,
"p2p_ports": true,
"ports_range": "",
"sending_default_email_invites": true,
"use_html_format_email": true,
"dscp_marking": true,
"dscp_audio": 1,
"dscp_video": 1,
"stereo_audio": true,
"original_audio": true,
"screen_sharing": true,
"remote_control": true,
"non_verbal_feedback": false,
"remote_support": false,
"custom_data_center_regions": true,
"data_center_regions": [
"AU"
],
"language_interpretation": {
"enable": true,
"enable_language_interpretation_by_default": true,
"allow_participants_to_speak_in_listening_channel": true,
"allow_up_to_25_custom_languages_when_scheduling_meetings": true,
"languages": "English",
"custom_languages": [
""
]
},
"sign_language_interpretation": {
"enable": true,
"enable_sign_language_interpretation_by_default": true,
"languages": [
"American"
],
"custom_languages": [
""
]
},
"meeting_reactions": true,
"meeting_reactions_emojis": "all",
"allow_host_panelists_to_use_audible_clap": true,
"webinar_reactions": true,
"show_a_join_from_your_browser_link": true,
"join_from_mobile": true,
"join_from_desktop": true,
"allow_live_streaming": true,
"live_streaming_facebook": true,
"workplace_by_facebook": true,
"live_streaming_youtube": true,
"custom_live_streaming_service": true,
"custom_service_instructions": "",
"webinar_live_streaming": {
"enable": true,
"live_streaming_service": [
"facebook"
],
"custom_service_instructions": "",
"live_streaming_reminder": true
},
"webinar_chat": {
"enable": true,
"allow_panelists_chat_with": 1,
"allow_attendees_chat_with": 1,
"default_attendees_chat_with": 1,
"allow_panelists_send_direct_message": true,
"allow_users_save_chats": 0,
"allow_auto_save_local_chat_file": true
},
"closed_captioning": {
"enable": true,
"third_party_captioning_service": true,
"auto_transcribing": true,
"view_full_transcript": true,
"save_caption": true
},
"slide_control": true,
"meeting_survey": true,
"webinar_polling": {
"enable": true,
"advanced_polls": true,
"require_answers_to_be_anonymous": true,
"allow_alternative_host_to_add_edit": true,
"manage_saved_polls_and_quizzes": true,
"allow_host_to_upload_image": true
},
"webinar_survey": true,
"disable_screen_sharing_for_host_meetings": true,
"disable_screen_sharing_for_in_meeting_guests": true,
"who_can_share_screen": "all",
"who_can_share_screen_when_someone_is_sharing": "host",
"participants_share_simultaneously": "multiple"
},
"email_notification": {
"cloud_recording_available_reminder": true,
"recording_available_reminder_schedulers": true,
"recording_available_reminder_alternative_hosts": true,
"jbh_reminder": true,
"cancel_meeting_reminder": true,
"low_host_count_reminder": true,
"alternative_host_reminder": true,
"schedule_for_reminder": true
},
"zoom_rooms": {
"upcoming_meeting_alert": true,
"start_airplay_manually": true,
"weekly_system_restart": true,
"list_meetings_with_calendar": true,
"zr_post_meeting_feedback": true,
"ultrasonic": true,
"force_private_meeting": true,
"hide_host_information": true,
"cmr_for_instant_meeting": true,
"auto_start_stop_scheduled_meetings": true
},
"security": {
"admin_change_name_pic": true,
"import_photos_from_devices": true,
"hide_billing_info": true,
"password_requirement": {
"minimum_password_length": 8,
"have_special_character": true,
"consecutive_characters_length": 1,
"weak_enhance_detection": true
},
"signin_with_sso": {
"enable": true,
"require_sso_for_domains": true,
"domains": [
"test.com",
"example.us"
],
"sso_bypass_users": [
{
"id": "21212_aefwef32233",
"email": "123@test.com"
}
]
}
},
"recording": {
"local_recording": true,
"cloud_recording": true,
"record_speaker_view": true,
"record_gallery_view": true,
"record_audio_file": true,
"save_chat_text": true,
"show_timestamp": true,
"recording_audio_transcript": true,
"auto_recording": "",
"cloud_recording_download": true,
"cloud_recording_download_host": true,
"account_user_access_recording": true,
"auto_delete_cmr": true,
"auto_delete_cmr_days": 30,
"record_files_separately": {
"active_speaker": true,
"gallery_view": true,
"shared_screen": true
},
"display_participant_name": true,
"recording_thumbnails": true,
"optimize_recording_for_3rd_party_video_editor": true,
"recording_highlight": true,
"smart_recording": {
"create_recording_highlights": true,
"create_smart_chapters": true,
"create_next_steps": true
},
"save_panelist_chat": true,
"save_poll_results": true,
"save_close_caption": true,
"record_audio_file_each_participant": true,
"host_pause_stop_recording": true,
"recording_disclaimer": true,
"ask_participants_to_consent_disclaimer": true,
"ask_host_to_confirm_disclaimer": true,
"recording_password_requirement": {
"length": 1,
"have_letter": true,
"have_number": true,
"have_special_character": true,
"only_allow_numeric": true
},
"ip_address_access_control": {
"enable": true,
"ip_addresses_or_ranges": ""
},
"prevent_host_access_recording": true,
"host_delete_cloud_recording": true,
"allow_recovery_deleted_cloud_recordings": true,
"archive": {
"enable": true,
"type": 1,
"settings": {
"chat_file": true,
"chat_with_sender_email": true,
"audio_file": true,
"video_file": true,
"cc_transcript_file": true,
"chat_with_direct_message": true,
"archive_retention": 1,
"action_when_archive_failed": 1,
"notification_when_archiving_starts": "participants",
"play_voice_prompt_when_archiving_starts": "participants"
}
}
},
"telephony": {
"third_party_audio": true,
"audio_conference_info": "",
"telephony_regions": {
"allowed_values": [
""
],
"selection_values": ""
}
},
"tsp": {
"call_out": true,
"call_out_countries": [
"us"
],
"allow_webinar_attendees_call_me": true,
"display_toll_free_numbers": true,
"allow_webinar_attendees_toll_free_dial": true,
"show_international_numbers_link": true,
"global_dial_in_countries": {
"selected_countries": [
{
"code": "CN",
"name": "China"
}
]
}
},
"integration": {
"google_calendar": true,
"google_drive": true,
"dropbox": true,
"box": true,
"microsoft_one_drive": true,
"kubi": true
},
"feature": {
"meeting_capacity": 1
},
"other_options": {
"allow_auto_active_users": true,
"blur_snapshot": true,
"display_meetings_scheduled_for_others": true,
"use_cdn": "none",
"allow_users_contact_support_via_chat": true,
"show_one_user_meeting_on_dashboard": true,
"meeting_qos_and_mos": 0,
"allow_users_enter_and_share_pronouns": true,
"webinar_registration_options": {
"allow_host_to_enable_social_share_buttons": true
}
},
"audio_conferencing": {
"toll_free_and_fee_based_toll_call": {
"allow_webinar_attendees_dial": true,
"enable": true,
"numbers": [
{
"code": "",
"country_code": "",
"country_name": "",
"number": "",
"display_number": ""
}
]
},
"toll_call": {
"enable": true,
"numbers": [
{
"code": "86",
"country_code": "CN",
"country_name": "China",
"display_number": "+86 777 777 77",
"number": "777 777 77"
}
]
},
"call_me_and_invite_by_phone": {
"enable": true,
"require_press_1_for_call_me": "auto",
"call_out_countries": {
"selected_countries": [
{
"code": "CN",
"name": "China"
}
]
},
"allow_webinar_attendees_call_me": true
},
"personal_audio_conference": true,
"participant_phone_masking": {
"enable": true,
"masking_type": "mask_default"
},
"global_dial_in_countries": {
"selected_countries": [
{
"code": "CN",
"name": "China"
}
],
"include_toll_free": true
}
},
"chat": {
"allow_bots_chat": true,
"share_files": {
"enable": true,
"share_option": "account",
"view_option": "anyone",
"restrictions": {
"only_allow_specific_file_types": true,
"file_type_restrictions": [
".gz"
],
"file_type_restrictions_for_external": [
".gz"
],
"maximum_file_size": true,
"file_size_restrictions": 100,
"file_size_restrictions_for_external": 100,
"file_restrictions_apply_to": "sharing_and_viewing"
}
},
"chat_emojis": {
"enable": true,
"emojis_option": "all"
},
"record_voice_messages": true,
"record_video_messages": true,
"screen_capture": true,
"create_public_channels": true,
"create_private_channels": true,
"create_group_chat": true,
"share_links_in_chat": true,
"schedule_meetings_in_chat": true,
"set_retention_period_in_cloud": {
"enable": true,
"retention_period_of_direct_messages_and_group_conversation": "2m",
"retention_period_of_channels": "2m"
},
"set_retention_period_in_local": {
"enable": true,
"retention_period_of_direct_messages_and_group_conversation": "2m",
"retention_period_of_channels": "2m"
},
"allow_users_to_add_contacts": {
"enable": true,
"selected_option": 4,
"user_email_addresses": "123@test.com"
},
"allow_users_to_chat_with_others": {
"enable": true,
"selected_option": 4,
"user_email_addresses": "123@test.com"
},
"chat_etiquette_tool": {
"enable": true,
"policies": [
{
"description": "The policy's description",
"id": "afwef342tr2qfwrg",
"is_locked": true,
"keywords": [
"test"
],
"name": "The policy name",
"regular_expression": "^test",
"status": "activated",
"trigger_action": 1
}
],
"policy_max_count": 50
},
"send_data_to_third_party_archiving_service": {
"enable": true,
"type": "global_relay",
"smtp_delivery_address": "test@zoom.us",
"user_name": "test",
"passcode": "111111111",
"authorized_channel_token": "as1131zxwrwcssd32r4fkmaksjiajco999999999999a9qef23jr43twn4%^&IBNByeq"
},
"apply_local_storage_to_personal_channel": {
"enable": true,
"retention_period": "2m"
},
"translate_messages": true,
"search_and_send_animated_gif_images": {
"enable": true,
"giphy_content_rating": 1
},
"external_collab_restrict": {
"enable": true,
"external_chat": "allowed",
"group_id": "QSuHwTcvQoWPoG0ennkRug"
},
"external_user_control": {
"enable": true,
"selected_option": 1,
"external_account": true
},
"external_invite_approve": {
"enable": true,
"selected_option": 1,
"channel_id": "5fedbc697f8545aca465b5b114ad4275",
"external_account": true
},
"external_member_join": {
"enable": true,
"external_account": true
},
"external_join_approve": {
"enable": true,
"selected_option": 1,
"channel_id": "5fedbc697f8545aca465b5b114ad4275",
"external_account": true
},
"download_file": true,
"share_screen_in_chat": true,
"code_snippet": true,
"personal_channel": true,
"store_revise_chat": false,
"set_chat_as_default_tab": false,
"hyper_link": true,
"suppress_removal_notification": true,
"suppress_user_group_notification": false,
"allow_remove_msg_by_owner_and_admins": true,
"allow_huddles_from_channels": true,
"shared_spaces": true,
"chat_email_address": {
"enable": true,
"only_allow_specific_domains": false,
"specific_domains": [
"[\"example.com\"]"
]
},
"read_receipts": {
"enable": false,
"allow_users_opt_out": false
},
"allow_delete_message": {
"enable": true,
"time": 5
},
"allow_edit_message": {
"enable": true,
"time": 5
},
"show_status_to_internal_contact": true,
"presence_on_meeting": true,
"presence_away_when_screen_saver": false,
"show_h323_contact_tab": false,
"ai_summary": {
"enable": false,
"shown_in_team_chat": true
},
"ai_compose": {
"enable": false,
"shown_in_team_chat": true
},
"ai_recommend": false,
"ai_quick_reply": false,
"ai_sentence_completion": false,
"ai_quick_schedule": false,
"survey_poll": true
},
"meeting_security": {
"auto_security": true,
"waiting_room": true,
"waiting_room_settings": {
"participants_to_place_in_waiting_room": 0,
"whitelisted_domains_for_waiting_room": "",
"users_who_can_admit_participants_from_waiting_room": 0
},
"meeting_password": true,
"require_password_for_scheduled_meeting": true,
"pmi_password": true,
"phone_password": true,
"webinar_password": true,
"require_password_for_scheduled_webinar": true,
"meeting_password_requirement": {
"length": 1,
"have_letter": true,
"have_number": true,
"have_special_character": true,
"only_allow_numeric": true,
"have_upper_and_lower_characters": true,
"consecutive_characters_length": 0,
"weak_enhance_detection": true
},
"embed_password_in_join_link": true,
"end_to_end_encrypted_meetings": true,
"encryption_type": "enhanced_encryption",
"block_user_domain": true,
"block_user_domain_list": [
""
],
"only_authenticated_can_join_from_webclient": true,
"chat_etiquette_tool": {
"enable": false,
"policies": [
{
"id": "",
"name": "",
"description": "",
"trigger_action": 1,
"keywords": [
""
],
"regular_expression": "",
"status": "activated",
"is_locked": false
}
]
}
},
"in_session": {
"custom_data_center_regions": false,
"data_center_regions": [
"US"
],
"p2p_connetion": true,
"p2p_ports": true,
"ports_range": "1;65535",
"dscp_audio": 56,
"dscp_marking": true,
"dscp_video": 40,
"dscp_dual": false,
"subsession": true
},
"session_security": {
"approved_or_denied_countries_or_regions": {
"approved_list": [
"CX"
],
"denied_list": [
"CA"
],
"enable": true,
"method": "approve"
}
},
"mail_calendar": {
"email_calendar_management": true,
"email_management": true,
"zoom_email_provider": true
},
"general_setting": {
"auto_zoom_room_proximity_connect": true,
"show_zoom_room_feature": true
},
"h323sip_conferencing": {
"custom_welcome_audio": {
"enable": true,
"audio_file": "https://file-paa.zoom.us/bNbghCQbTYa_ml3QrsDpHQ/MS41LtClXjWRKeEPhw7xuW9bVORZ8nc-L0WtGlaitlWYw2Y7/FTxtmfjFTYS0pgQu_lo-NA"
}
},
"ai": {
"screen_share_ocr": true,
"meeting_chat_messages": true,
"full_display_names_in_ai_assets": true,
"ai_generated_virtual_backgrounds": true,
"meeting_agenda": true,
"meeting_summary_docs": {
"enable": true,
"share_with_summary_recipients": true
},
"phone_user_ai_notices": {
"enable": true,
"require_press_1_consent": true,
"multiple_notifications": true
},
"meeting_summary_retention": {
"enable": true,
"retention_days": 30
},
"meeting_summary_personal_data_redaction": {
"enable": true,
"personal_data_types": [
"NAME",
"EMAIL"
]
},
"meeting_summary_sensitive_data_filter": {
"enable": true,
"rules": [
{
"name": "Employee ID",
"regular_expression": "[0-9]{6}"
}
]
},
"meeting_coach": {
"enable": true,
"participant_scope": "participants_and_invitees_in_our_organization"
},
"third_party_meeting_join": {
"enable": true,
"allow_recording": true,
"calendar": {
"enable": true,
"join_scope": "all_events_with_video_conference_links"
},
"pre_meeting_email_notification": {
"enable": true,
"recipients": "all_invitees"
}
},
"whiteboard_content_generation": true,
"smart_recording": {
"create_recording_highlights": true,
"create_smart_chapters": true,
"create_next_steps": true
},
"task_creation_and_management": {
"enable": false,
"auto_generate_details": false,
"auto_generate_action": true,
"generate_from_transcripts": {
"enable": false,
"auto_share_with": "internal_participants",
"auto_assign_to_collaborator": true
},
"generate_from_phone_call": {
"enable": false,
"auto_add_participant_as_collaborator": true,
"auto_assign_to_collaborator": true
},
"generate_from_voicemail": false
},
"show_conversational_ai_companion": {
"enabled": true,
"enable_zoom_mate": true,
"delete_ai_conversation": true,
"delete_ai_conversation_time": 30
},
"ai_panel_in_workplace": {
"enabled": true,
"delete_ai_conversation": true,
"delete_ai_conversation_time": 30
},
"enable_ai_on_web": true,
"enable_email_compose_with_ai": true,
"microsoft_365": {
"enable": true,
"calendar_events": true,
"emails": true,
"documents": true
},
"google": {
"enable": true,
"calendar_events": true,
"emails": true,
"documents": true
},
"web_content": true,
"local_file_uploads": true,
"organization_custom_dictionaries": true,
"third_party_app_tasks": true,
"workspace_reservation_recommendations_with_ai": {
"enabled": true,
"day_recommendation": true,
"desk_recommendation": true,
"custom_workspaces_recommendation": true,
"room_recommendation": true,
"proactive_room_recommendation": true
},
"participant_can_request_aic_in_meeting": true,
"restrict_aic_when_external_user_join_meeting": true,
"restrict_users_from_joining_ai_enabled_meetings": {
"enable": true,
"join_notify": "notify_and_remove",
"apply_scope": "internal_and_external"
},
"meeting_questions": {
"enable": true,
"auto_enable": false,
"who_can_ask_questions": "org_from_join_meeting"
},
"meeting_summary": {
"enable": true,
"auto_enable": false,
"email_notification": true,
"whether_include_full_text_in_email": "include_full_text_in_email",
"restrict_share_to_outside_of_organization": true,
"restrict_summary_share": "external_users",
"who_will_receive_summary": "alt_host"
},
"meeting_summary_template": {
"enable": true,
"summary_template_id": "template_123"
},
"meeting_summary_default_language": {
"enable": true,
"language": "en-US"
},
"meeting_summary_ip_access": {
"enable": true,
"ip_addresses_or_ranges": "192.0.2.0/24"
},
"remind_me_turn_on_aic": true,
"remind_me_turn_on_catch_me_up": true,
"meeting_summary_email_only_mode": false,
"restrict_users_from_deleting_ai_companion_assets": true,
"restrict_users_from_editing_ai_companion_assets": true,
"webinar_summary_ocr": true,
"zoom_events_session_summary": {
"enable": true,
"auto_start": true
},
"zoom_events_chat_panel": true,
"zoom_events_analytics": true,
"zoom_events_chat_compose": true,
"zoom_events_email_compose": true,
"zoom_events_smart_compose": true,
"zoom_events_image_generation": true,
"zoom_events_smart_upload": true,
"zoom_events_content_generation": true,
"chat_summary": {
"enable": false,
"shown_in_team_chat": true
},
"chat_compose": {
"enable": false,
"shown_in_team_chat": true
},
"include_webinar_summary_follow_up_email": {
"enable": true,
"attendee_follow_up_email": true,
"absentee_follow_up_email": true
},
"zoom_events_content_studio": true,
"webinar_summary": {
"enable": true,
"auto_enable": false,
"email_notification": true,
"whether_include_full_text_in_email": "include_full_text_in_email",
"restrict_share_to_outside_of_organization": true,
"restrict_summary_share": "external_users",
"who_will_receive_summary": "host_and_panelist_in_organization"
},
"webinar_questions": {
"enable": true,
"auto_enable": false,
"who_can_ask_questions": "panelist_org"
}
}
}
}
}
}
```
#### Responses
##### Status: 200 Successfully received the webhook event.
## Schemas
### Account.vanity\_url\_rejectedEvent
- **Type:**`object`
* **`event` (required)**
`string` — The name of the event.
* **`event_ts` (required)**
`integer`, format: `int64` — A timestamp at which the event occurred.
* **`payload` (required)**
`object`
- **`account_id` (required)**
`string` — The account ID of the account's owner.
- **`object` (required)**
`object` — Information about the account's rejected vanity URL.
- **`id` (required)**
`string` — The account's ID.
- **`vanity_url` (required)**
`string` — The rejected \[vanity URL]\(https\://support.zoom.us/hc/en-us/articles/215062646-Guidelines-for-Vanity-URL-requests).
- **`operator` (required)**
`string`, format: `email` — The email address of the user who rejected the account's vanity URL.
**Example:**
```json
{
"event": "",
"event_ts": 1,
"payload": {
"account_id": "",
"operator": "",
"object": {
"id": "",
"vanity_url": ""
}
}
}
```
### Account.createdEvent
- **Type:**`object`
* **`event`**
`string` — The name of the event.
* **`event_ts`**
`integer`, format: `int64` — A timestamp at which the event occurred.
* **`payload`**
`object`
- **`account_id`**
`string` — The account ID of the account's owner.
- **`object`**
`object` — Information about the created account.
- **`email`**
`string`, format: `email` — The account email address.
- **`id`**
`string` — The account's ID.
- **`owner_id`**
`string` — The account owner's ID.
- **`operator`**
`string`, format: `email` — The email address of the user who created the account.
- **`operator_id`**
`string` — The user ID of the user who created the account.
**Example:**
```json
{
"event": "",
"event_ts": 1,
"payload": {
"account_id": "",
"operator": "",
"operator_id": "",
"object": {
"id": "",
"owner_id": "",
"email": ""
}
}
}
```
### Information\_barriers.policy\_deletedEvent
- **Type:**`object`
* **`event` (required)**
`string` — The name of the event.
* **`event_ts` (required)**
`integer`, format: `int64` — A timestamp when the event occurred.
* **`payload` (required)**
`object`
- **`account_id` (required)**
`string` — The account ID of the user who deleted the policy.
- **`object` (required)**
`object` — An \[information barrier's]\(https\://support.zoom.us/hc/en-us/articles/360040913711-Information-Barriers) policies and its information.
- **`assigned_group_id` (required)**
`string` — The assigner group's (Group 1) ID.
- **`id` (required)**
`string` — The information barrier's policy's ID.
- **`policy_name` (required)**
`string` — The information barrier's policy's name.
- **`settings` (required)**
`object` — The information barriers policy's settings. \* 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. \* 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.
- **`complete_phone_calls` (required)**
`boolean` — If true, users between groups \*\*cannot\*\* call each other.
- **`file_transfer` (required)**
`boolean` — 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\`.
- **`im` (required)**
`boolean` — 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\`.
- **`in_meeting_chat` (required)**
`boolean` — 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\`.
- **`meeting` (required)**
`boolean` — 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.
- **`message_via_sms` (required)**
`boolean` — If true, users between groups \*\*cannot\*\* user SMS.
- **`recording` (required)**
`boolean` — 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\`. This feature is only available for Zoom Client v5.6.0 and higher.
- **`screen_share` (required)**
`boolean` — 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\`.
- **`status` (required)**
`integer`, possible values: `0, 1` — The information barrier's policy's status: \* \`0\` — Disabled. \* \`1\` — Enabled.
- **`to_group_id` (required)**
`string` — The assignee group's (Group 2) ID.
- **`type` (required)**
`integer`, possible values: `0, 1, 2, 3`, default: `0` — The information barrier's policy's type of \`settings\` restrictions: \* \`0\` — A \[hard or soft block]\(https\://support.zoom.us/hc/en-us/articles/360040913711-Information-Barriers#h\_a603c6f7-05c8-4de5-b4b6-91982d748b34) exists, but users in Group 1 and Group 2 can chat with each other. \* \`1\` — A \[hard or soft block]\(https\://support.zoom.us/hc/en-us/articles/360040913711-Information-Barriers#h\_a603c6f7-05c8-4de5-b4b6-91982d748b34) exists and only users in Group 1 can chat with users in Group 2. \* \`2\` — No blocks exist, but only users in Group 1 can chat with users in Group 2. \* \`3\` — No blocks exist and users in Group 1 and Group 2 can chat with each other. This field only supports \`0\`.
**Example:**
```json
{
"event": "",
"event_ts": 1,
"payload": {
"account_id": "",
"object": {
"assigned_group_id": "",
"id": "",
"policy_name": "",
"settings": {
"complete_phone_calls": true,
"file_transfer": true,
"im": true,
"in_meeting_chat": true,
"meeting": true,
"message_via_sms": true,
"recording": true,
"screen_share": true
},
"status": 1,
"to_group_id": "mjLMOSAERBaakF8kSDWB7g",
"type": 1
}
}
}
```
### Account.updatedEvent
- **Type:**`object`
* **`event`**
`string` — The name of the event.
* **`event_ts`**
`integer`, format: `int64` — A timestamp at which the event occurred.
* **`payload`**
`object`
- **`account_id`**
`string` — The account ID of the account's owner.
- **`object`**
`object` — Information about the updated account.
- **`account_alias`**
`string` — The account's updated alias.
- **`account_name`**
`string` — The account's updated name.
- **`account_support_email`**
`string`, format: `email` — The account's updated email address for account support.
- **`account_support_name`**
`string` — The account's updated name for account support.
- **`id`**
`string` — The account's ID.
- **`managed_domains`**
`array` — The account's updated managed domains.
**Items:**
`string`
- **`old_object`**
`object` — Information about the account's previous profile settings.
- **`$changed_field_name`**
`string` — The updated field name and its previous value.
- **`operation`**
`string`, possible values: `"apply_vanity_url", "managed_domains_added", "managed_domains_deleted", "managed_domains_verifying"` — This field only returns for the following operations: \* \`apply\_vanity\_url\` \* \`managed\_domains\_added\` \* \`managed\_domains\_deleted\` \* \`managed\_domains\_verifying\`
- **`operator`**
`string`, format: `email` — The email address of the user who updated the account.
**Example:**
```json
{
"event": "",
"event_ts": 1,
"payload": {
"account_id": "",
"operator": "",
"operation": "apply_vanity_url",
"object": {
"id": "",
"account_name": "",
"account_alias": "",
"account_support_name": "",
"account_support_email": "",
"managed_domains": [
""
]
},
"old_object": {
"$changed_field_name": ""
}
}
}
```
### Information\_barriers.policy\_createdEvent
- **Type:**`object`
* **`event` (required)**
`string` — The name of the event.
* **`event_ts` (required)**
`integer`, format: `int64` — A timestamp when the event occurred.
* **`payload` (required)**
`object`
- **`account_id` (required)**
`string` — The account ID of the user who created the policy.
- **`object` (required)**
`object` — An \[information barrier's]\(https\://support.zoom.us/hc/en-us/articles/360040913711-Information-Barriers) policies and its information.
- **`assigned_group_id` (required)**
`string` — The assigner group's (Group 1) ID.
- **`id` (required)**
`string` — The information barrier's policy's ID.
- **`policy_name` (required)**
`string` — The information barrier's policy's name.
- **`settings` (required)**
`object` — The information barrier's policy's settings. \* 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. \* 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.
- **`complete_phone_calls` (required)**
`boolean` — If true, users between groups \*\*cannot\*\* call each other.
- **`file_transfer` (required)**
`boolean` — 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\`.
- **`im` (required)**
`boolean` — 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\`.
- **`in_meeting_chat` (required)**
`boolean` — 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\`.
- **`meeting` (required)**
`boolean` — 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.
- **`message_via_sms` (required)**
`boolean` — If true, users between groups \*\*cannot\*\* user SMS.
- **`recording` (required)**
`boolean` — 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\`. This feature is only available for Zoom Client v5.6.0 and higher.
- **`screen_share` (required)**
`boolean` — 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\`.
- **`status` (required)**
`integer`, possible values: `0, 1` — The information barrier's policy's status: \* \`0\` — Disabled. \* \`1\` — Enabled.
- **`to_group_id` (required)**
`string` — The assignee group's (Group 2) ID.
- **`type` (required)**
`integer`, possible values: `0, 1, 2, 3`, default: `0` — The information barrier's policy's type of \`settings\` restrictions: \* \`0\` — A \[hard or soft block]\(https\://support.zoom.us/hc/en-us/articles/360040913711-Information-Barriers#h\_a603c6f7-05c8-4de5-b4b6-91982d748b34) exists, but users in Group 1 and Group 2 can chat with each other. \* \`1\` — A \[hard or soft block]\(https\://support.zoom.us/hc/en-us/articles/360040913711-Information-Barriers#h\_a603c6f7-05c8-4de5-b4b6-91982d748b34) exists and only users in Group 1 can chat with users in Group 2. \* \`2\` — No blocks exist, but only users in Group 1 can chat with users in Group 2. \* \`3\` — No blocks exist and users in Group 1 and Group 2 can chat with each other. This field only supports \`0\`.
**Example:**
```json
{
"event": "",
"event_ts": 1,
"payload": {
"account_id": "",
"object": {
"assigned_group_id": "",
"id": "",
"policy_name": "",
"settings": {
"complete_phone_calls": true,
"file_transfer": true,
"im": true,
"in_meeting_chat": true,
"meeting": true,
"message_via_sms": true,
"recording": true,
"screen_share": true
},
"status": 1,
"to_group_id": "mjLMOSAERBaakF8kSDWB7g",
"type": 1
}
}
}
```
### Account.lock\_settings\_updatedEvent
- **Type:**`object`
* **`event`**
`string` — The name of the event.
* **`event_ts`**
`integer`, format: `int64` — A timestamp at which the event occurred.
* **`payload`**
`object`
- **`account_id`**
`string` — The account ID of the account's owner.
- **`object`**
`object` — Information about the updated fields.
- **`id`**
`string` — The updated account's ID.
- **`settings`**
`object` — Information about the account's updated lock settings.
- **`ai`**
`object` — Lock settings for Workspace Reservation recommendations with AI.
- **`ai_generated_virtual_backgrounds`**
`boolean` — Whether the ai\_generated\_virtual\_backgrounds setting is locked.
- **`ai_panel_in_workplace`**
`object` — Lock settings for the AI panel in Zoom Workplace.
- **`delete_ai_conversation`**
`boolean` — Whether automatic AI conversation deletion in the AI panel is locked.
- **`delete_ai_conversation_time`**
`boolean` — Whether the AI panel conversation retention period is locked.
- **`enabled`**
`boolean` — Whether the AI panel in Zoom Workplace is locked.
- **`canvas_ai_content_generation`**
`boolean` — Whether the Canvas AI content generation and revision setting is locked.
- **`canvas_ai_post_meeting_writing_tasks`**
`boolean` — Whether the Canvas post-meeting writing task setting is locked.
- **`canvas_ai_sentence_completion`**
`boolean` — Whether the Canvas AI sentence completion setting is locked.
- **`chat_compose`**
`boolean` — Compose with AI Companion.
- **`chat_summary`**
`boolean` — Summarize with AI Companion.
- **`enable_ai_on_web`**
`boolean` — Whether Zoom AI on the web is locked.
- **`enable_email_compose_with_ai`**
`boolean` — Whether Zoom Mail AI compose is locked.
- **`full_display_names_in_ai_assets`**
`boolean` — Whether the full\_display\_names\_in\_ai\_assets setting is locked.
- **`google`**
`object` — Lock settings for Google data sources.
- **`enable`**
`boolean` — Whether Google data sources are locked.
- **`hub_ai_question_and_file_creation`**
`boolean` — Whether the Hub AI search and file creation setting is locked.
- **`include_webinar_summary_follow_up_email`**
`object` — Lock settings for including the webinar summary in follow-up email.
- **`enable`**
`boolean` — Whether including the webinar summary in follow-up email is locked.
- **`local_file_uploads`**
`boolean` — Whether Local file uploads as an AI data source are locked.
- **`meeting_agenda`**
`boolean` — Whether the meeting\_agenda setting is locked.
- **`meeting_chat_messages`**
`boolean` — Whether the meeting\_chat\_messages setting is locked.
- **`meeting_coach`**
`object` — Lock settings for Meeting Coach with AI.
- **`enable`**
`boolean` — Whether Meeting Coach with AI is locked.
- **`meeting_questions`**
`object` — Lock settings for meeting questions.
- **`auto_enable_locked`**
`boolean` — Whether automatic meeting questions are locked.
- **`locked`**
`boolean` — Whether meeting questions are locked.
- **`who_can_ask_questions_locked`**
`boolean` — Whether the meeting questions participant scope is locked.
- **`meeting_summary`**
`object` — Lock settings for meeting summaries.
- **`auto_enable_locked`**
`boolean` — Whether automatic meeting summaries are locked.
- **`locked`**
`boolean` — Whether meeting summaries are locked.
- **`who_will_receive_summary_locked`**
`boolean` — Whether the meeting summary recipient scope is locked.
- **`meeting_summary_default_language`**
`object` — Lock settings for the default meeting summary language.
- **`enable`**
`boolean` — Whether the default meeting summary language is locked.
- **`meeting_summary_docs`**
`object` — Lock settings for meeting summary Docs.
- **`enable`**
`boolean` — Whether automatic Zoom Doc creation is locked.
- **`share_with_summary_recipients`**
`boolean` — Whether sharing generated Zoom Docs with meeting summary recipients is locked.
- **`meeting_summary_email_only_mode`**
`boolean` — Whether the meeting\_summary\_email\_only\_mode setting is locked.
- **`meeting_summary_ip_access`**
`object` — Lock settings for meeting summary IP access.
- **`enable`**
`boolean` — Whether meeting summary IP access is locked.
- **`meeting_summary_retention`**
`object` — Lock settings for meeting summary retention.
- **`enable`**
`boolean` — Whether automatic meeting summary deletion is locked.
- **`meeting_summary_template`**
`object` — Lock settings for meeting summary templates.
- **`enable`**
`boolean` — Whether meeting summary templates are locked.
- **`microsoft_365`**
`object` — Lock settings for Microsoft 365 data sources.
- **`enable`**
`boolean` — Whether Microsoft 365 data sources are locked.
- **`my_notes_ai_content_generation`**
`boolean` — Whether the My Notes AI content generation setting is locked.
- **`my_notes_meeting_transcription`**
`boolean` — Whether the My Notes meeting transcription setting is locked.
- **`organization_custom_dictionaries`**
`boolean` — Whether allowing AI to consume the organization's custom dictionaries is locked.
- **`paper_ai_content_generation`**
`boolean` — Whether the Zoom Paper AI content generation and revision setting is locked.
- **`participant_can_request_aic_in_meeting`**
`boolean` — Whether the participant\_can\_request\_aic\_in\_meeting setting is locked.
- **`phone_user_ai_notices`**
`object` — Lock settings for phone user AI notices.
- **`enable`**
`boolean` — Whether phone user AI notices are locked.
- **`remind_me_turn_on_aic`**
`boolean` — Whether the remind\_me\_turn\_on\_aic setting is locked.
- **`remind_me_turn_on_catch_me_up`**
`boolean` — Whether the remind\_me\_turn\_on\_catch\_me\_up setting is locked.
- **`restrict_aic_when_external_user_join_meeting`**
`boolean` — Whether the restrict\_aic\_when\_external\_user\_join\_meeting setting is locked.
- **`restrict_aic_when_restrict_user_join`**
`boolean` — Whether the restrict\_aic\_when\_restrict\_user\_join setting is locked.
- **`restrict_users_from_deleting_ai_companion_assets`**
`boolean` — Whether the restrict\_users\_from\_deleting\_ai\_companion\_assets setting is locked.
- **`restrict_users_from_editing_ai_companion_assets`**
`boolean` — Whether the restrict\_users\_from\_editing\_ai\_companion\_assets setting is locked.
- **`restrict_users_from_joining_ai_enabled_meetings`**
`object` — Lock settings for restrictions on joining AI-enabled meetings.
- **`enable`**
`boolean` — Whether restrictions on joining AI-enabled meetings are locked.
- **`screen_share_ocr`**
`boolean` — Whether the screen\_share\_ocr setting is locked.
- **`sheets_ai_content_generation`**
`boolean` — Whether the Zoom Sheets AI content generation and revision setting is locked.
- **`sheets_ai_formula`**
`boolean` — Whether the Zoom Sheets AI Formula setting is locked.
- **`sheets_ai_function`**
`boolean` — Whether the Zoom Sheets AI Function setting is locked.
- **`sheets_ai_resources`**
`boolean` — Whether the Zoom Sheets AI Resources setting is locked.
- **`show_conversational_ai_companion`**
`object` — Lock settings for the conversational AI companion.
- **`delete_ai_conversation`**
`boolean` — Whether automatic AI conversation deletion is locked.
- **`delete_ai_conversation_time`**
`boolean` — Whether the AI conversation retention period is locked.
- **`enable_zoom_mate`**
`boolean` — Whether ZoomMate availability is locked.
- **`enabled`**
`boolean` — Whether conversational AI is locked.
- **`slides_ai_content_generation`**
`boolean` — Whether the Zoom Slides AI content generation and revision setting is locked.
- **`smart_recording`**
`object` — Lock settings for Smart Recording.
- **`enable`**
`boolean` — Whether the Smart Recording is locked.
- **`task_creation_and_management`**
`object` — Lock settings for task creation and management with AI.
- **`enable`**
`boolean` — Whether task creation and management with AI is locked.
- **`third_party_app_tasks`**
`boolean` — Whether allowing AI to perform tasks in third-party apps is locked.
- **`third_party_meeting_join`**
`object` — Lock settings for third-party meeting join with AI.
- **`allow_recording`**
`boolean` — Whether recording for joined third-party meetings is locked.
- **`calendar`**
`object` — Lock settings for calendar-based third-party meeting join.
- **`enable`**
`boolean` — Whether calendar-based third-party meeting join is locked.
- **`enable`**
`boolean` — Whether third-party meeting join with AI is locked.
- **`pre_meeting_email_notification`**
`object` — Lock settings for pre-meeting email notification.
- **`enable`**
`boolean` — Whether pre-meeting email notification is locked.
- **`web_content`**
`boolean` — Whether Web content as an AI data source is locked.
- **`webinar_questions`**
`object` — 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 setting is locked.
- **`auto_enable`**
`boolean` — Whether automatically allowing access when the webinar starts is locked.
- **`enable`**
`boolean` — Whether allowing users to ask webinar questions with AI is locked.
- **`who_can_ask_questions`**
`boolean` — 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.
- **`webinar_summary`**
`object` — 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 setting is locked.
- **`auto_enable`**
`boolean` — Whether turning on webinar summary automatically when the webinar starts is locked.
- **`email_notification`**
`boolean` — Whether sending an email notification when sharing to participants is locked.
- **`enable`**
`boolean` — Whether allowing hosts to generate a summary is locked.
- **`restrict_share_to_outside_of_organization`**
`boolean` — Whether restricting users from sharing summaries to those outside of the organization is locked.
- **`who_will_receive_summary`**
`boolean` — 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.
- **`webinar_summary_follow_up_email`**
`boolean` — 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.
- **`webinar_summary_ocr`**
`boolean` — Whether using screen share content with OCR for webinar summaries is locked.
- **`whiteboard_content_generation`**
`boolean` — Whether Whiteboard content generation with AI is enabled.
- **`workspace_reservation_recommendations_with_ai`**
`object` — Lock settings for Workspace Reservation recommendations with AI.
- **`enabled`**
`boolean` — Whether Workspace Reservation recommendations with AI are locked.
- **`zoom_events_chat_panel`**
`boolean` — Whether the AI chat panel in Zoom Events is locked.
- **`zoom_events_session_summary`**
`object` — Lock settings for Zoom Events session summary.
- **`auto_start`**
`boolean` — Whether turning on session summary automatically when sessions start is locked.
- **`enable`**
`boolean` — Whether Zoom Events session summaries are locked.
- **`audio_conferencing`**
`object` — Account Audio Conference Settings
- **`call_me_and_invite_by_phone`**
`boolean` — 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.
- **`participant_phone_masking`**
`boolean` — 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.
- **`personal_audio_conference`**
`boolean` — 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.
- **`toll_call`**
`boolean` — Whether the account has the \[\*\*Toll Call\*\*]\(https\://support.zoom.com/hc/en/article?id=zm\_kb\&sysparm\_article=KB0066909#h\_01F51680NJ7YHZDXGJNSKDGM2P) setting enabled.
- **`toll_free_and_fee_based_toll_call`**
`boolean` — 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.
- **`chat`**
`object`
- **`ai_compose`**
`boolean` — Compose with AI Companion.
- **`ai_quick_schedule`**
`boolean` — Quick schedule with AI Companion.
- **`ai_recommend`**
`boolean` — Chat Recommendation with Zoom AI Companion.
- **`ai_reply`**
`boolean` — Quick reply with AI Companion.
- **`ai_sentence_completion`**
`boolean` — Sentence completion with AI Companion.
- **`ai_summary`**
`boolean` — Summarize with AI Companion.
- **`allow_create_channels_and_group_chats`**
`boolean` — Whether to allow users to create channels and group chats.
- **`allow_delete_message`**
`boolean` — Whether to allow users to delete messages.
- **`allow_edit_message`**
`boolean` — Whether to allow users to edit messages.
- **`allow_huddles_from_channels`**
`boolean` — Whether to allow huddles from channels.
- **`allow_users_to_add_contacts`**
`boolean` — Whether to allow users to add contacts.
- **`allow_users_to_chat_with_others`**
`boolean` — Whether to Allow users to chat with others.
- **`chat_email_address`**
`boolean` — Chat email address.
- **`chat_emojis`**
`boolean` — 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.
- **`chat_etiquette_tool`**
`boolean` — Whether to enable the \*\*Chat Etiquette Tool\*\*.
- **`download_file`**
`boolean` — Whether to allow users to downloading files.
- **`presence_away_when_screen_saver`**
`boolean` — Change my status to away when screen saver begins.
- **`presence_on_meeting`**
`boolean` — Change my presence status when I am in a meeting or call.
- **`read_receipts`**
`boolean` — Whether to enable read receipts.
- **`record_video_messages`**
`boolean` — 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.
- **`record_voice_messages`**
`boolean` — Allow users to record voice messages that can be sent in direct messages or group conversations.
- **`schedule_meetings_in_chat`**
`boolean` — Schedule a meeting from chat or channel.
- **`screen_capture`**
`boolean` — Allow users to take and send screenshots in direct messages or group conversations.
- **`search_and_send_animated_gif_images`**
`boolean` — Whether to allow users to search GIF images from GIPHY when they compose messages.
- **`send_data_to_third_party_archiving_service`**
`boolean` — Whether to send data to third-party archiving service.
- **`set_retention_period_in_cloud`**
`boolean` — Store messages in Zoom's cloud.
- **`set_retention_period_in_local`**
`boolean` — Set retention period for messages on local devices.
- **`share_files`**
`boolean` — Users can share files in chats and channels.
- **`share_links_in_chat`**
`boolean` — Share links to messages and channels in Team Chat.
- **`share_screen_in_chat`**
`boolean` — Whether to allow users to share screen in chat.
- **`shared_spaces`**
`boolean` — Whether to allow users to create Shared Spaces.
- **`survey_poll`**
`boolean` — Allow users to launch a poll in chats and channels.
- **`translate_messages`**
`boolean` — Allow users to translate team chat messages. \[Learn more].(https\://support.zoom.us/hc/en-us/articles/12998089084685)
- **`email_notification`**
`object`
- **`alternative_host_reminder`**
`boolean` — Notify the alternative host who is set or removed.
- **`cancel_meeting_reminder`**
`boolean` — Notify host and participants when the meeting is cancelled.
- **`cloud_recording_available_reminder`**
`boolean` — Whether to notify the host when a cloud recording is available.
- **`jbh_reminder`**
`boolean` — Notify host when participants join the meeting before them.
- **`schedule_for_reminder`**
`boolean` — Notify the host there is a meeting is scheduled, rescheduled, or cancelled.
- **`h323sip_conferencing`**
`object` — The account's H.323/SIP Conferencing settings.
- **`custom_welcome_audio`**
`object` — Information about the custom welcome audio message played to H.323/SIP devices upon joining a Zoom Meeting.
- **`enable`**
`boolean`, default: `false` — Determines if a custom welcome audio message is played when H.323/SIP devices join a Zoom Meeting.
- **`in_meeting`**
`object`
- **`alert_guest_join`**
`boolean` — 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.
- **`allow_live_streaming`**
`boolean` — Whether to allow livestreaming.
- **`allow_show_zoom_windows`**
`boolean` — Show Zoom windows during screen share.
- **`allow_users_to_delete_messages_in_meeting_chat`**
`boolean` — If the value of this field is set to \`true\`, allow users to delete messages in the in-meeting chat.
- **`annotation`**
`boolean` — Allow participants to use annotation tools to add information to shared screens.
- **`anonymous_question_answer`**
`boolean`
- **`attendee_on_hold`**
`boolean`, default: `false` — Allow host to put attendee on hold. \*\*This field has been deprecated and is no longer supported.\*\*
- **`attention_mode_focus_mode`**
`boolean`, default: `false` — 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. This value defaults to \`false\`.
- **`auto_answer`**
`boolean` — 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.
- **`auto_generated_captions`**
`boolean` — 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).
- **`auto_saving_chat`**
`boolean` — Automatically save all in-meeting chats.
- **`breakout_room`**
`boolean` — Allow host to split meeting participants into separate, smaller rooms.
- **`chat`**
`boolean` — Allow meeting participants to send chat message visible to all participants.
- **`closed_caption`**
`boolean` — Allow host to type closed captions or assign a participant/third party device to add closed captions.
- **`co_host`**
`boolean` — Allow the host to add co-hosts. Co-hosts have the same in-meeting controls as the host.
- **`custom_data_center_regions`**
`boolean` — 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.
- **`disable_screen_sharing_for_host_meetings`**
`boolean` — Whether to enable the \*\*Disable desktop screen sharing for meetings you host\*\* setting.
- **`disable_screen_sharing_for_in_meeting_guests`**
`boolean` — Whether to enable the \*\*Disable screen sharing when guests are in the meeting\*\* setting.
- **`dscp_marking`**
`boolean` — Enable DSCP marking for signaling and media packets. (Default is 56 for audio, 40 for video, and 40 for signaling.)
- **`e2e_encryption`**
`boolean` — Require that all meetings are encrypted using AES.
- **`far_end_camera_control`**
`boolean` — Allow another user to take control of the camera during a meeting.
- **`feedback`**
`boolean` — Enable users to provide feedback to Zoom at the end of the meeting.
- **`file_transfer`**
`boolean` — 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.
- **`full_transcript`**
`boolean` — Whether full transcripts are available for viewing in the in-meeting side panel.
- **`group_hd`**
`boolean` — Enable higher quality video for host and participants. This will require more bandwidth.
- **`language_interpretation`**
`boolean` — Whether hosts can assign participants as interpreters to interpret one language into another in real-time.
- **`manual_captions`**
`boolean` — 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.
- **`meeting_question_answer`**
`boolean` — Allow participants to ask questions for the host and participants to answer.
- **`meeting_reactions`**
`boolean` — 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.
- **`meeting_survey`**
`boolean` — 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.
- **`non_verbal_feedback`**
`boolean`, default: `false` — 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\`.
- **`original_audio`**
`boolean` — Allow users to select original sound during a meeting.
- **`polling`**
`boolean` — Add 'Polls' to the meeting controls. This allows the host to survey the attendees.
- **`post_meeting_feedback`**
`boolean` — Display end-of-meeting experience feedback survey.
- **`private_chat`**
`boolean` — Allow meeting participants to send a private 1:1 message to another participant.
- **`remote_control`**
`boolean` — During screen sharing, allow the person who is sharing to let others control the shared content.
- **`remote_support`**
`boolean`, default: `false` — Whether to enable the \[\*\*Remote support\*\*]\(https\://support.zoom.us/hc/en-us/articles/360060951012-Enabling-remote-support) setting. This value defaults to \`false\`.
- **`request_permission_to_unmute_participants`**
`boolean` — 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.
- **`save_caption`**
`boolean` — Whether participants can save closed captions or transcripts.
- **`save_captions`**
`boolean` — Whether participants can \[save closed caption or transcripts]\(https\://support.zoom.us/hc/en-us/articles/360060958752). \*\*Note:\*\* If the \`full\_transcript\` field is set to \`false\`, participants \*\*cannot\*\* save captions.
- **`screen_sharing`**
`boolean` — Allow host and participants to share their screen or content during meetings.
- **`sending_default_email_invites`**
`boolean` — Allow users to invite participants by email only by default.
- **`show_meeting_control_toolbar`**
`boolean` — Always show meeting controls during a meeting.
- **`sign_language_interpretation`**
`boolean` — 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.
- **`slide_control`**
`boolean` — 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.
- **`stereo_audio`**
`boolean` — Allow users to select stereo audio during a meeting.
- **`use_html_format_email`**
`boolean` — Allow HTML formatting instead of plain text for meeting invitations scheduled with the Outlook plugin.
- **`virtual_background`**
`boolean` — Enable virtual background.
- **`webinar_chat`**
`boolean` — Whether to allow webinar participants to send chat messages.
- **`webinar_live_streaming`**
`boolean` — Whether to enable webinar livestreaming.
- **`webinar_polling`**
`boolean` — Whether the host can add polls before or during a webinar.
- **`webinar_question_answer`**
`boolean` — Whether attendees can ask the host and panelists questions in the webinar.
- **`webinar_reactions`**
`boolean` — Set this field to true to use \[webinar reactions]\(https\://support.zoom.us/hc/en-us/articles/4803536268429).
- **`webinar_survey`**
`boolean` — Whether the host can present surveys to attendees once a webinar has ended.
- **`whiteboard`**
`boolean` — Allow participants to share a whiteboard that includes annotation tools.
- **`meeting_security`**
`object`
- **`approved_or_denied_countries_or_regions`**
`boolean` — 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.
- **`auto_security`**
`boolean` — Whether all meetings must be secured with at least one security option. This setting can only be disabled by Enterprise, ISV, Business (with more than 100 licenses), and Education accounts.
- **`block_user_domain`**
`boolean` — Whether users in specific domains are blocked from joining meetings and webinars.
- **`chat_etiquette_tool`**
`boolean` — Whether to enable the \*\*Chat Etiquette Tool\*\*.
- **`embed_password_in_join_link`**
`boolean` — Whether the meeting password is encrypted and included in the invitation link. The provided link will allow participants to join the meeting without having to enter the password.
- **`encryption_type`**
`boolean` — Whether use encryption to start a meeting.
- **`end_to_end_encrypted_meetings`**
`boolean` — Whether to enable end-to-end encryption for meetings.
- **`meeting_password`**
`boolean` — Whether all instant and scheduled meetings that users can join via client or Zoom Rooms systems are password-protected. \[Personal Meeting ID (PMI)]\(https\://support.zoom.us/hc/en-us/articles/203276937) meetings are \*\*not\*\* included in this setting.
- **`only_authenticated_can_join_from_webclient`**
`boolean` — Whether to specify that only authenticated users can join the meeting from the web client.
- **`phone_password`**
`boolean` — Whether passwords are required for participants joining by phone. If enabled and the meeting is password-protected, a numeric password is required for participants to join by phone. For meetings with alphanumeric passwords, a numeric password will be generated.
- **`pmi_password`**
`boolean` — Whether all Personal Meeting ID (PMI) meetings that users can join via client or Zoom Rooms systems are password-protected.
- **`waiting_room`**
`boolean` — Whether participants are placed in the \[\*\*Waiting Room\*\*]\(https\://support.zoom.us/hc/en-us/articles/115000332726-Waiting-Room) when they join a meeting. 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.
- **`webinar_password`**
`boolean` — Whether to generate a password when scheduling webinars. Participants must use the generated password to join the scheduled webinar.
- **`other_options`**
`object`
- **`blur_snapshot`**
`boolean` — 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.
- **`webinar_registration_options`**
`boolean` — Webinar registration options.
- **`recording`**
`object`
- **`account_user_access_recording`**
`boolean` — Make cloud recordings accessible to account members only.
- **`archive`**
`boolean` — \[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.
- **`auto_delete_cmr`**
`boolean` — Allow Zoom to automatically delete recordings permanently after a specified number of days.
- **`auto_recording`**
`boolean` — Record meetings automatically as they start.
- **`cloud_recording`**
`boolean` — Allow hosts to record and save the meeting / webinar in the cloud.
- **`cloud_recording_download`**
`boolean` — Allow anyone with a link to the cloud recording to download.
- **`host_delete_cloud_recording`**
`boolean` — 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.
- **`ip_address_access_control`**
`boolean` — Setting to allow cloud recording access only from specific IP address ranges.
- **`local_recording`**
`boolean` — Allow hosts and participants to record the meeting to a local file.
- **`recording_authentication`**
`boolean` — Only authenticated users can view cloud recordings
- **`schedule_meeting`**
`object`
- **`always_display_zoom_webinar_as_topic`**
`boolean` — Whether to enable the \[\*\*Always show "Zoom Webinar" as the webinar topic\*\*]\(https\://support.zoom.us/hc/en-us/articles/201363253-Changing-account-settings#h\_01EG9BJ646V2WJK1S3H2MP6YV6) setting.
- **`audio_type`**
`boolean` — Determine how participants can join the audio portion of the meeting.
- **`embed_password_in_join_link`**
`boolean` — If the value is set to \`true\`, the meeting password will be encrypted and included in the join meeting link to allow participants to join with just one click without having to enter the password.
- **`enforce_login`**
`boolean` — Allow only signed-in users to join meetings.
- **`enforce_login_with_domains`**
`boolean` — Allow only signed-in users with specified domains to join meetings.
- **`host_video`**
`boolean` — Start meetings with host video on.
- **`join_before_host`**
`boolean` — Allow participants to join the meeting before the host arrives
- **`meeting_authentication`**
`boolean` — Only authenticated users can join meetings
- **`meeting_template`**
`boolean` — Whether to enable the \*\*Meeting Templates\*\* setting.
- **`not_store_meeting_topic`**
`boolean` — Whether to enable the \[\*\*Always display "Zoom Meeting" as the meeting topic\*\*]\(https\://support.zoom.us/hc/en-us/articles/201363253-Changing-account-settings#h\_01EG9BJ646V2WJK1S3H2MP6YV6) setting.
- **`participant_video`**
`boolean` — Start meetings with participant video on.
- **`require_password_for_instant_meetings`**
`boolean` — Require password for instant meetings. If you use a PMI for your instant meetings, this option will be disabled. This setting is always enabled for free accounts and Pro accounts with a single host and cannot be modified for these accounts.
- **`require_password_for_pmi_meetings`**
`boolean` — Require participants to enter password for PMI meetings. This setting is always enabled for free accounts and Pro accounts with a single host and cannot be modified for these accounts.
- **`require_password_for_scheduling_new_meetings`**
`boolean` — This setting applies for regular meetings that do not use a PMI. If enabled, a password will be generated while a host schedules a new meeting and participants will be required to enter the password before they can join the meeting. This setting is always enabled for free accounts and Pro accounts with a single host and cannot be modified for these accounts.
- **`use_pmi_for_instant_meetings`**
`boolean` — Use a Personal Meeting ID (PMI) when starting an instant meeting.
- **`use_pmi_for_scheduled_meetings`**
`boolean` — Use a Personal Meeting ID (PMI) when scheduling a meeting.
- **`telephony`**
`object` — Account Settings: Telephony.
- **`telephony_regions`**
`boolean` — Indicates where most of the participants call into or call from during a meeting.
- **`third_party_audio`**
`boolean` — Allow users to join the meeting using the existing 3rd party audio configuration.
- **`tsp`**
`object` — Account Settings: TSP.
- **`call_out`**
`boolean` — Call Out Countries/Regions
- **`show_international_numbers_link`**
`boolean` — Show international numbers link on the invitation email
- **`old_object`**
`object` — Information about the account's previous lock settings.
- **`id`**
`string` — The updated account's ID.
- **`settings`**
`object` — Information about the updated account or sub account settings. This only returns modified settings.
- **`ai`**
`object` — Lock settings for Workspace Reservation recommendations with AI.
- **`ai_generated_virtual_backgrounds`**
`boolean` — Whether the ai\_generated\_virtual\_backgrounds setting is locked.
- **`ai_panel_in_workplace`**
`object` — Lock settings for the AI panel in Zoom Workplace.
- **`delete_ai_conversation`**
`boolean` — Whether automatic AI conversation deletion in the AI panel is locked.
- **`delete_ai_conversation_time`**
`boolean` — Whether the AI panel conversation retention period is locked.
- **`enabled`**
`boolean` — Whether the AI panel in Zoom Workplace is locked.
- **`canvas_ai_content_generation`**
`boolean` — Whether the Canvas AI content generation and revision setting is locked.
- **`canvas_ai_post_meeting_writing_tasks`**
`boolean` — Whether the Canvas post-meeting writing task setting is locked.
- **`canvas_ai_sentence_completion`**
`boolean` — Whether the Canvas AI sentence completion setting is locked.
- **`chat_compose`**
`boolean` — Compose with AI Companion.
- **`chat_summary`**
`boolean` — Summarize with AI Companion.
- **`enable_ai_on_web`**
`boolean` — Whether Zoom AI on the web is locked.
- **`enable_email_compose_with_ai`**
`boolean` — Whether Zoom Mail AI compose is locked.
- **`full_display_names_in_ai_assets`**
`boolean` — Whether the full\_display\_names\_in\_ai\_assets setting is locked.
- **`google`**
`object` — Lock settings for Google data sources.
- **`enable`**
`boolean` — Whether Google data sources are locked.
- **`hub_ai_question_and_file_creation`**
`boolean` — Whether the Hub AI search and file creation setting is locked.
- **`include_webinar_summary_follow_up_email`**
`object` — Lock settings for including the webinar summary in follow-up email.
- **`enable`**
`boolean` — Whether including the webinar summary in follow-up email is locked.
- **`local_file_uploads`**
`boolean` — Whether Local file uploads as an AI data source are locked.
- **`meeting_agenda`**
`boolean` — Whether the meeting\_agenda setting is locked.
- **`meeting_chat_messages`**
`boolean` — Whether the meeting\_chat\_messages setting is locked.
- **`meeting_coach`**
`object` — Lock settings for Meeting Coach with AI.
- **`enable`**
`boolean` — Whether Meeting Coach with AI is locked.
- **`meeting_questions`**
`object` — Lock settings for meeting questions.
- **`auto_enable_locked`**
`boolean` — Whether automatic meeting questions are locked.
- **`locked`**
`boolean` — Whether meeting questions are locked.
- **`who_can_ask_questions_locked`**
`boolean` — Whether the meeting questions participant scope is locked.
- **`meeting_summary`**
`object` — Lock settings for meeting summaries.
- **`auto_enable_locked`**
`boolean` — Whether automatic meeting summaries are locked.
- **`locked`**
`boolean` — Whether meeting summaries are locked.
- **`who_will_receive_summary_locked`**
`boolean` — Whether the meeting summary recipient scope is locked.
- **`meeting_summary_default_language`**
`object` — Lock settings for the default meeting summary language.
- **`enable`**
`boolean` — Whether the default meeting summary language is locked.
- **`meeting_summary_docs`**
`object` — Lock settings for meeting summary Docs.
- **`enable`**
`boolean` — Whether automatic Zoom Doc creation is locked.
- **`share_with_summary_recipients`**
`boolean` — Whether sharing generated Zoom Docs with meeting summary recipients is locked.
- **`meeting_summary_email_only_mode`**
`boolean` — Whether the meeting\_summary\_email\_only\_mode setting is locked.
- **`meeting_summary_ip_access`**
`object` — Lock settings for meeting summary IP access.
- **`enable`**
`boolean` — Whether meeting summary IP access is locked.
- **`meeting_summary_retention`**
`object` — Lock settings for meeting summary retention.
- **`enable`**
`boolean` — Whether automatic meeting summary deletion is locked.
- **`meeting_summary_template`**
`object` — Lock settings for meeting summary templates.
- **`enable`**
`boolean` — Whether meeting summary templates are locked.
- **`microsoft_365`**
`object` — Lock settings for Microsoft 365 data sources.
- **`enable`**
`boolean` — Whether Microsoft 365 data sources are locked.
- **`my_notes_ai_content_generation`**
`boolean` — Whether the My Notes AI content generation setting is locked.
- **`my_notes_meeting_transcription`**
`boolean` — Whether the My Notes meeting transcription setting is locked.
- **`organization_custom_dictionaries`**
`boolean` — Whether allowing AI to consume the organization's custom dictionaries is locked.
- **`paper_ai_content_generation`**
`boolean` — Whether the Zoom Paper AI content generation and revision setting is locked.
- **`participant_can_request_aic_in_meeting`**
`boolean` — Whether the participant\_can\_request\_aic\_in\_meeting setting is locked.
- **`phone_user_ai_notices`**
`object` — Lock settings for phone user AI notices.
- **`enable`**
`boolean` — Whether phone user AI notices are locked.
- **`remind_me_turn_on_aic`**
`boolean` — Whether the remind\_me\_turn\_on\_aic setting is locked.
- **`remind_me_turn_on_catch_me_up`**
`boolean` — Whether the remind\_me\_turn\_on\_catch\_me\_up setting is locked.
- **`restrict_aic_when_external_user_join_meeting`**
`boolean` — Whether the restrict\_aic\_when\_external\_user\_join\_meeting setting is locked.
- **`restrict_aic_when_restrict_user_join`**
`boolean` — Whether the restrict\_aic\_when\_restrict\_user\_join setting is locked.
- **`restrict_users_from_deleting_ai_companion_assets`**
`boolean` — Whether the restrict\_users\_from\_deleting\_ai\_companion\_assets setting is locked.
- **`restrict_users_from_editing_ai_companion_assets`**
`boolean` — Whether the restrict\_users\_from\_editing\_ai\_companion\_assets setting is locked.
- **`restrict_users_from_joining_ai_enabled_meetings`**
`object` — Lock settings for restrictions on joining AI-enabled meetings.
- **`enable`**
`boolean` — Whether restrictions on joining AI-enabled meetings are locked.
- **`screen_share_ocr`**
`boolean` — Whether the screen\_share\_ocr setting is locked.
- **`sheets_ai_content_generation`**
`boolean` — Whether the Zoom Sheets AI content generation and revision setting is locked.
- **`sheets_ai_formula`**
`boolean` — Whether the Zoom Sheets AI Formula setting is locked.
- **`sheets_ai_function`**
`boolean` — Whether the Zoom Sheets AI Function setting is locked.
- **`sheets_ai_resources`**
`boolean` — Whether the Zoom Sheets AI Resources setting is locked.
- **`show_conversational_ai_companion`**
`object` — Lock settings for the conversational AI companion.
- **`delete_ai_conversation`**
`boolean` — Whether automatic AI conversation deletion is locked.
- **`delete_ai_conversation_time`**
`boolean` — Whether the AI conversation retention period is locked.
- **`enable_zoom_mate`**
`boolean` — Whether ZoomMate availability is locked.
- **`enabled`**
`boolean` — Whether conversational AI is locked.
- **`slides_ai_content_generation`**
`boolean` — Whether the Zoom Slides AI content generation and revision setting is locked.
- **`smart_recording`**
`object` — Lock settings for Smart Recording.
- **`enable`**
`boolean` — Whether the Smart Recording is locked.
- **`task_creation_and_management`**
`object` — Lock settings for task creation and management with AI.
- **`enable`**
`boolean` — Whether task creation and management with AI is locked.
- **`third_party_app_tasks`**
`boolean` — Whether allowing AI to perform tasks in third-party apps is locked.
- **`third_party_meeting_join`**
`object` — Lock settings for third-party meeting join with AI.
- **`allow_recording`**
`boolean` — Whether recording for joined third-party meetings is locked.
- **`calendar`**
`object` — Lock settings for calendar-based third-party meeting join.
- **`enable`**
`boolean` — Whether calendar-based third-party meeting join is locked.
- **`enable`**
`boolean` — Whether third-party meeting join with AI is locked.
- **`pre_meeting_email_notification`**
`object` — Lock settings for pre-meeting email notification.
- **`enable`**
`boolean` — Whether pre-meeting email notification is locked.
- **`web_content`**
`boolean` — Whether Web content as an AI data source is locked.
- **`webinar_questions`**
`object` — 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 setting is locked.
- **`auto_enable`**
`boolean` — Whether automatically allowing access when the webinar starts is locked.
- **`enable`**
`boolean` — Whether allowing users to ask webinar questions with AI is locked.
- **`who_can_ask_questions`**
`boolean` — 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.
- **`webinar_summary`**
`object` — 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 setting is locked.
- **`auto_enable`**
`boolean` — Whether turning on webinar summary automatically when the webinar starts is locked.
- **`email_notification`**
`boolean` — Whether sending an email notification when sharing to participants is locked.
- **`enable`**
`boolean` — Whether allowing hosts to generate a summary is locked.
- **`restrict_share_to_outside_of_organization`**
`boolean` — Whether restricting users from sharing summaries to those outside of the organization is locked.
- **`who_will_receive_summary`**
`boolean` — 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.
- **`webinar_summary_follow_up_email`**
`boolean` — 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.
- **`webinar_summary_ocr`**
`boolean` — Whether using screen share content with OCR for webinar summaries is locked.
- **`whiteboard_content_generation`**
`boolean` — Whether Whiteboard content generation with AI is enabled.
- **`workspace_reservation_recommendations_with_ai`**
`object` — Lock settings for Workspace Reservation recommendations with AI.
- **`enabled`**
`boolean` — Whether Workspace Reservation recommendations with AI are locked.
- **`zoom_events_chat_panel`**
`boolean` — Whether the AI chat panel in Zoom Events is locked.
- **`zoom_events_session_summary`**
`object` — Lock settings for Zoom Events session summary.
- **`auto_start`**
`boolean` — Whether turning on session summary automatically when sessions start is locked.
- **`enable`**
`boolean` — Whether Zoom Events session summaries are locked.
- **`audio_conferencing`**
`object`
- **`chat`**
`object`
- **`email_notification`**
`object`
- **`h323sip_conferencing`**
`object`
- **`in_meeting`**
`object`
- **`meeting_security`**
`object`
- **`other_options`**
`object`
- **`recording`**
`object`
- **`schedule_meeting`**
`object`
- **`telephony`**
`object`
- **`tsp`**
`object`
- **`operator`**
`string`, format: `email` — The email address of the user who updated the account's lock settings.
- **`operator_id`**
`string` — The user ID of the user who updated the account's lock settings.
- **`time_stamp`**
`integer` — A timestamp that indicates when the lock setting was updated.
**Example:**
```json
{
"event": "",
"event_ts": 1,
"payload": {
"account_id": "",
"operator": "",
"operator_id": "",
"object": {
"id": "",
"settings": {
"schedule_meeting": {
"audio_type": true,
"embed_password_in_join_link": true,
"enforce_login": true,
"enforce_login_with_domains": true,
"host_video": true,
"join_before_host": true,
"meeting_authentication": true,
"not_store_meeting_topic": false,
"participant_video": true,
"require_password_for_instant_meetings": true,
"require_password_for_pmi_meetings": true,
"require_password_for_scheduling_new_meetings": true,
"use_pmi_for_instant_meetings": true,
"use_pmi_for_scheduled_meetings": true,
"always_display_zoom_webinar_as_topic": false,
"meeting_template": false
},
"in_meeting": {
"alert_guest_join": true,
"allow_users_to_delete_messages_in_meeting_chat": true,
"allow_live_streaming": true,
"allow_show_zoom_windows": true,
"annotation": true,
"anonymous_question_answer": true,
"attention_mode_focus_mode": true,
"auto_answer": true,
"auto_generated_captions": true,
"auto_saving_chat": true,
"breakout_room": true,
"chat": true,
"closed_caption": true,
"co_host": true,
"custom_data_center_regions": true,
"disable_screen_sharing_for_host_meetings": true,
"disable_screen_sharing_for_in_meeting_guests": true,
"dscp_marking": true,
"e2e_encryption": true,
"far_end_camera_control": true,
"feedback": true,
"file_transfer": true,
"full_transcript": true,
"group_hd": true,
"language_interpretation": true,
"sign_language_interpretation": true,
"manual_captions": true,
"meeting_reactions": true,
"webinar_reactions": true,
"meeting_survey": true,
"original_audio": true,
"polling": true,
"post_meeting_feedback": true,
"private_chat": true,
"remote_control": true,
"non_verbal_feedback": true,
"remote_support": true,
"request_permission_to_unmute_participants": true,
"save_caption": true,
"save_captions": true,
"screen_sharing": true,
"sending_default_email_invites": true,
"show_meeting_control_toolbar": true,
"slide_control": true,
"stereo_audio": true,
"use_html_format_email": true,
"virtual_background": true,
"webinar_chat": true,
"webinar_live_streaming": true,
"webinar_polling": true,
"webinar_question_answer": true,
"meeting_question_answer": true,
"webinar_survey": true,
"whiteboard": true
},
"email_notification": {
"alternative_host_reminder": true,
"cancel_meeting_reminder": true,
"cloud_recording_available_reminder": true,
"jbh_reminder": true,
"schedule_for_reminder": true
},
"recording": {
"account_user_access_recording": true,
"auto_delete_cmr": true,
"auto_recording": true,
"cloud_recording": true,
"cloud_recording_download": true,
"host_delete_cloud_recording": true,
"ip_address_access_control": true,
"local_recording": true,
"recording_authentication": true,
"archive": true
},
"telephony": {
"telephony_regions": true,
"third_party_audio": true
},
"audio_conferencing": {
"toll_free_and_fee_based_toll_call": true,
"toll_call": true,
"call_me_and_invite_by_phone": true,
"personal_audio_conference": true,
"participant_phone_masking": true
},
"chat": {
"share_files": true,
"chat_emojis": true,
"record_voice_messages": true,
"record_video_messages": true,
"screen_capture": true,
"share_links_in_chat": true,
"schedule_meetings_in_chat": true,
"allow_users_to_add_contacts": true,
"allow_users_to_chat_with_others": true,
"chat_etiquette_tool": true,
"send_data_to_third_party_archiving_service": true,
"translate_messages": true,
"search_and_send_animated_gif_images": true,
"set_retention_period_in_cloud": true,
"set_retention_period_in_local": true,
"shared_spaces": true,
"allow_create_channels_and_group_chats": true,
"allow_huddles_from_channels": true,
"download_file": true,
"share_screen_in_chat": true,
"chat_email_address": true,
"read_receipts": true,
"allow_delete_message": true,
"allow_edit_message": true,
"presence_on_meeting": true,
"presence_away_when_screen_saver": true,
"ai_summary": true,
"ai_compose": true,
"ai_recommend": true,
"ai_reply": true,
"ai_sentence_completion": true,
"ai_quick_schedule": true,
"survey_poll": true
},
"other_options": {
"blur_snapshot": true,
"webinar_registration_options": true
},
"tsp": {
"call_out": true,
"show_international_numbers_link": true
},
"meeting_security": {
"approved_or_denied_countries_or_regions": true,
"auto_security": true,
"block_user_domain": true,
"chat_etiquette_tool": true,
"embed_password_in_join_link": true,
"encryption_type": true,
"end_to_end_encrypted_meetings": true,
"meeting_password": true,
"only_authenticated_can_join_from_webclient": true,
"phone_password": true,
"pmi_password": true,
"waiting_room": true,
"webinar_password": true
},
"h323sip_conferencing": {
"custom_welcome_audio": {
"enable": true
}
},
"ai": {
"screen_share_ocr": true,
"meeting_chat_messages": true,
"full_display_names_in_ai_assets": true,
"ai_generated_virtual_backgrounds": true,
"meeting_agenda": true,
"meeting_summary_docs": {
"enable": true,
"share_with_summary_recipients": false
},
"phone_user_ai_notices": {
"enable": true
},
"meeting_summary_retention": {
"enable": true
},
"meeting_coach": {
"enable": true
},
"third_party_meeting_join": {
"enable": true,
"allow_recording": true,
"calendar": {
"enable": true
},
"pre_meeting_email_notification": {
"enable": true
}
},
"whiteboard_content_generation": true,
"smart_recording": {
"enable": true
},
"task_creation_and_management": {
"enable": true
},
"show_conversational_ai_companion": {
"enabled": true,
"enable_zoom_mate": true,
"delete_ai_conversation": true,
"delete_ai_conversation_time": true
},
"ai_panel_in_workplace": {
"enabled": true,
"delete_ai_conversation": true,
"delete_ai_conversation_time": true
},
"enable_ai_on_web": true,
"enable_email_compose_with_ai": true,
"microsoft_365": {
"enable": true
},
"google": {
"enable": true
},
"web_content": true,
"local_file_uploads": true,
"organization_custom_dictionaries": true,
"third_party_app_tasks": true,
"workspace_reservation_recommendations_with_ai": {
"enabled": true
},
"participant_can_request_aic_in_meeting": false,
"restrict_aic_when_external_user_join_meeting": false,
"restrict_aic_when_restrict_user_join": false,
"restrict_users_from_joining_ai_enabled_meetings": {
"enable": false
},
"meeting_questions": {
"locked": false,
"auto_enable_locked": false,
"who_can_ask_questions_locked": false
},
"meeting_summary": {
"locked": false,
"auto_enable_locked": false,
"who_will_receive_summary_locked": false
},
"meeting_summary_template": {
"enable": false
},
"meeting_summary_default_language": {
"enable": false
},
"meeting_summary_ip_access": {
"enable": false
},
"remind_me_turn_on_aic": false,
"remind_me_turn_on_catch_me_up": false,
"meeting_summary_email_only_mode": false,
"restrict_users_from_deleting_ai_companion_assets": false,
"restrict_users_from_editing_ai_companion_assets": false,
"webinar_summary_ocr": false,
"zoom_events_session_summary": {
"enable": false,
"auto_start": false
},
"zoom_events_chat_panel": false,
"chat_summary": true,
"chat_compose": true,
"hub_ai_question_and_file_creation": true,
"canvas_ai_content_generation": true,
"canvas_ai_sentence_completion": true,
"canvas_ai_post_meeting_writing_tasks": true,
"paper_ai_content_generation": true,
"sheets_ai_content_generation": true,
"sheets_ai_formula": true,
"sheets_ai_function": true,
"sheets_ai_resources": true,
"slides_ai_content_generation": true,
"my_notes_meeting_transcription": true,
"my_notes_ai_content_generation": true,
"include_webinar_summary_follow_up_email": {
"enable": false
},
"webinar_summary": {
"enable": false,
"auto_enable": false,
"email_notification": false,
"restrict_share_to_outside_of_organization": false,
"who_will_receive_summary": false
},
"webinar_questions": {
"enable": false,
"auto_enable": false,
"who_can_ask_questions": false
}
}
}
},
"time_stamp": 1,
"old_object": {
"id": "",
"settings": {
"schedule_meeting": null,
"in_meeting": null,
"email_notification": null,
"recording": null,
"telephony": null,
"other_options": null,
"audio_conferencing": null,
"chat": null,
"meeting_security": null,
"tsp": null,
"h323sip_conferencing": null,
"ai": {
"screen_share_ocr": true,
"meeting_chat_messages": true,
"full_display_names_in_ai_assets": true,
"ai_generated_virtual_backgrounds": true,
"meeting_agenda": true,
"meeting_summary_docs": {
"enable": true,
"share_with_summary_recipients": false
},
"phone_user_ai_notices": {
"enable": true
},
"meeting_summary_retention": {
"enable": true
},
"meeting_coach": {
"enable": true
},
"third_party_meeting_join": {
"enable": true,
"allow_recording": true,
"calendar": {
"enable": true
},
"pre_meeting_email_notification": {
"enable": true
}
},
"whiteboard_content_generation": true,
"smart_recording": {
"enable": true
},
"task_creation_and_management": {
"enable": true
},
"show_conversational_ai_companion": {
"enabled": true,
"enable_zoom_mate": true,
"delete_ai_conversation": true,
"delete_ai_conversation_time": true
},
"ai_panel_in_workplace": {
"enabled": true,
"delete_ai_conversation": true,
"delete_ai_conversation_time": true
},
"enable_ai_on_web": true,
"enable_email_compose_with_ai": true,
"microsoft_365": {
"enable": true
},
"google": {
"enable": true
},
"web_content": true,
"local_file_uploads": true,
"organization_custom_dictionaries": true,
"third_party_app_tasks": true,
"workspace_reservation_recommendations_with_ai": {
"enabled": true
},
"participant_can_request_aic_in_meeting": false,
"restrict_aic_when_external_user_join_meeting": false,
"restrict_aic_when_restrict_user_join": false,
"restrict_users_from_joining_ai_enabled_meetings": {
"enable": false
},
"meeting_questions": {
"locked": false,
"auto_enable_locked": false,
"who_can_ask_questions_locked": false
},
"meeting_summary": {
"locked": false,
"auto_enable_locked": false,
"who_will_receive_summary_locked": false
},
"meeting_summary_template": {
"enable": false
},
"meeting_summary_default_language": {
"enable": false
},
"meeting_summary_ip_access": {
"enable": false
},
"remind_me_turn_on_aic": false,
"remind_me_turn_on_catch_me_up": false,
"meeting_summary_email_only_mode": false,
"restrict_users_from_deleting_ai_companion_assets": false,
"restrict_users_from_editing_ai_companion_assets": false,
"webinar_summary_ocr": false,
"zoom_events_session_summary": {
"enable": false,
"auto_start": false
},
"zoom_events_chat_panel": false,
"chat_summary": true,
"chat_compose": true,
"hub_ai_question_and_file_creation": true,
"canvas_ai_content_generation": true,
"canvas_ai_sentence_completion": true,
"canvas_ai_post_meeting_writing_tasks": true,
"paper_ai_content_generation": true,
"sheets_ai_content_generation": true,
"sheets_ai_formula": true,
"sheets_ai_function": true,
"sheets_ai_resources": true,
"slides_ai_content_generation": true,
"my_notes_meeting_transcription": true,
"my_notes_ai_content_generation": true,
"include_webinar_summary_follow_up_email": {
"enable": false
},
"webinar_summary": {
"enable": false,
"auto_enable": false,
"email_notification": false,
"restrict_share_to_outside_of_organization": false,
"who_will_receive_summary": false
},
"webinar_questions": {
"enable": false,
"auto_enable": false,
"who_can_ask_questions": false
}
}
}
}
}
}
```
### Account.disassociatedEvent
- **Type:**`object`
* **`event`**
`string` — The name of the event.
* **`event_ts`**
`integer`, format: `int64` — A timestamp at which the event occurred.
* **`payload`**
`object`
- **`account_id`**
`string` — The account ID under which the account was \[disassociated]\(https\://support.zoom.us/hc/en-us/articles/115005269946-Removing-a-user-from-your-account#h\_98a81098-0ca3-45ae-8d00-aab235cc781d).
- **`object`**
`object` — Information about the disassociated account.
- **`id`**
`string` — The account's ID.
- **`owner_email`**
`string`, format: `email` — The account owner's email address.
- **`owner_id`**
`string` — The account owner's ID.
- **`operator`**
`string`, format: `email` — The email address of the user who disassociated the account.
- **`operator_id`**
`string` — The user ID of the user who disassociated the account.
**Example:**
```json
{
"event": "",
"event_ts": 1,
"payload": {
"account_id": "",
"operator": "",
"operator_id": "",
"object": {
"id": "",
"owner_id": "",
"owner_email": ""
}
}
}
```
### Information\_barriers.policy\_updatedEvent
- **Type:**`object`
* **`event` (required)**
`string` — The name of the event.
* **`event_ts` (required)**
`integer`, format: `int64` — A timestamp at which the event occurred.
* **`payload` (required)**
`object`
- **`account_id` (required)**
`string` — The account ID of the user who updated the policy.
- **`object` (required)**
`object` — The diff of the \[Information Barrier]\(https\://support.zoom.us/hc/en-us/articles/360040913711-Information-Barriers) policy and its information.
- **`assigned_group_id` (required)**
`string` — The assigner group's (Group 1) ID.
- **`policy_name` (required)**
`string` — The Information Barriers policy's name.
- **`settings` (required)**
`object` — The Information Barriers policy's settings. \* 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. \* 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.
- **`complete_phone_calls` (required)**
`boolean` — If true, users between groups \*\*cannot\*\* call each other.
- **`file_transfer` (required)**
`boolean` — 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\`.
- **`im` (required)**
`boolean` — 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\`.
- **`in_meeting_chat` (required)**
`boolean` — 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\`.
- **`meeting` (required)**
`boolean` — 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.
- **`message_via_sms` (required)**
`boolean` — If true, users between groups \*\*cannot\*\* user SMS.
- **`recording` (required)**
`boolean` — 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\`. This feature is only available for Zoom Client v5.6.0 and higher.
- **`screen_share` (required)**
`boolean` — 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\`.
- **`status` (required)**
`integer`, possible values: `0, 1` — The Information Barriers policy's status: \* \`0\` — Disabled. \* \`1\` — Enabled.
- **`to_group_id` (required)**
`string` — The assignee group's (Group 2) ID.
- **`type` (required)**
`integer`, possible values: `0, 1, 2, 3`, default: `0` — The Information Barriers policy's type of \`settings\` restrictions: \* \`0\` — A \[hard or soft block]\(https\://support.zoom.us/hc/en-us/articles/360040913711-Information-Barriers#h\_a603c6f7-05c8-4de5-b4b6-91982d748b34) exists, but users in Group 1 and Group 2 can chat with each other. \* \`1\` — A \[hard or soft block]\(https\://support.zoom.us/hc/en-us/articles/360040913711-Information-Barriers#h\_a603c6f7-05c8-4de5-b4b6-91982d748b34) exists and only users in Group 1 can chat with users in Group 2. \* \`2\` — No blocks exist, but only users in Group 1 can chat with users in Group 2. \* \`3\` — No blocks exist and users in Group 1 and Group 2 can chat with each other. This field only supports \`0\`.
**Example:**
```json
{
"event": "",
"event_ts": 1,
"payload": {
"account_id": "",
"object": {
"assigned_group_id": "",
"policy_name": "",
"settings": {
"complete_phone_calls": true,
"file_transfer": true,
"im": true,
"in_meeting_chat": true,
"meeting": true,
"message_via_sms": true,
"recording": true,
"screen_share": true
},
"status": 1,
"to_group_id": "mjLMOSAERBaakF8kSDWB7g",
"type": 1
}
}
}
```
### Account.vanity\_url\_approvedEvent
- **Type:**`object`
* **`event` (required)**
`string` — The name of the event.
* **`event_ts` (required)**
`integer`, format: `int64` — A timestamp at which the event occurred.
* **`payload` (required)**
`object`
- **`account_id` (required)**
`string` — The account ID of the account's owner.
- **`object` (required)**
`object` — Information about the account's approved vanity URL.
- **`id` (required)**
`string` — The account's ID.
- **`vanity_url` (required)**
`string` — The approved \[vanity URL]\(https\://support.zoom.us/hc/en-us/articles/215062646-Guidelines-for-Vanity-URL-requests).
- **`operator` (required)**
`string`, format: `email` — The email address of the user who approved the account's vanity URL.
**Example:**
```json
{
"event": "",
"event_ts": 1,
"payload": {
"account_id": "",
"operator": "",
"object": {
"id": "",
"vanity_url": ""
}
}
}
```
### Account.settings\_updatedEvent
- **Type:**`object`
* **`event`**
`string` — The name of the event.
* **`event_ts`**
`integer`, format: `int64` — A timestamp at which the event occurred.
* **`payload`**
`object`
- **`account_id`**
`string` — The account ID of the account's owner.
- **`object`**
`object` — Information about the updated fields.
- **`id`**
`string` — The updated account's ID.
- **`settings`**
`object` — Information about the account's updated settings.
- **`ai`**
`object` — Workspace Reservation recommendations with AI.
- **`ai_generated_virtual_backgrounds`**
`boolean` — Whether AI-generated virtual backgrounds are enabled.
- **`ai_panel_in_workplace`**
`object` — AI panel in Zoom Workplace settings.
- **`delete_ai_conversation`**
`boolean` — Whether to automatically delete AI conversation history in the AI panel.
- **`delete_ai_conversation_time`**
`integer | null`, possible values: `30, 60, 90, 120` — The number of days after which AI conversation history in the AI panel is automatically deleted. Supported values are 30, 60, 90, and 120.
- **`enabled`**
`boolean` — Whether the AI panel in Zoom Workplace is enabled.
- **`canvas_ai_content_generation`**
`boolean` — 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.
- **`canvas_ai_post_meeting_writing_tasks`**
`boolean` — Whether AI can identify post-meeting writing tasks from meeting context and generate drafts that users can review and use.
- **`canvas_ai_sentence_completion`**
`boolean` — Whether users can receive predictive writing suggestions while writing in Canvas.
- **`chat_compose`**
`object` — Allow users to use AI to help them compose a response from scratch or wordsmith their chat messages.
- **`enable`**
`boolean` — Compose with AI Companion
- **`shown_in_team_chat`**
`boolean` — Show in Team Chat
- **`chat_summary`**
`object` — Allow users to summarize chats, channels, and shared documents.
- **`enable`**
`boolean` — Summarize with AI Companion
- **`shown_in_team_chat`**
`boolean` — Show in Team Chat
- **`enable_ai_on_web`**
`boolean` — Whether Zoom AI on the web is enabled.
- **`enable_email_compose_with_ai`**
`boolean` — Whether users can use AI to compose or wordsmith email responses in Zoom Mail.
- **`full_display_names_in_ai_assets`**
`boolean` — Whether AI-generated meeting assets use full display names.
- **`google`**
`object` — Settings for Google data sources.
- **`calendar_events`**
`boolean` — Whether Google Calendar events accessible to the user can be used as a data source for AI.
- **`documents`**
`boolean` — Whether Google Drive documents accessible to the user can be used as a data source for AI.
- **`emails`**
`boolean` — Whether Gmail emails accessible to the user can be used as a data source for AI.
- **`enable`**
`boolean` — Whether Google data sources can be used as data sources for AI.
- **`hub_ai_question_and_file_creation`**
`boolean` — 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.
- **`include_webinar_summary_follow_up_email`**
`object` — Webinar follow-up email. When enabled, the host can include the webinar summary in follow-up emails.
- **`absentee_follow_up_email`**
`boolean` — Whether the webinar summary is included in the absentee follow-up email.
- **`attendee_follow_up_email`**
`boolean` — Whether the webinar summary is included in the attendee follow-up email.
- **`enable`**
`boolean` — Whether the host can include the webinar summary in follow-up email.
- **`local_file_uploads`**
`boolean` — Whether files uploaded by users can be used as a data source for AI by the users who uploaded them.
- **`meeting_agenda`**
`boolean` — Whether Meeting Agenda with AI is enabled.
- **`meeting_chat_messages`**
`boolean` — Whether meeting chat messages are used to enhance transcripts.
- **`meeting_coach`**
`object` — Meeting Coach with AI.
- **`enable`**
`boolean` — Whether Meeting Coach with AI is enabled.
- **`participant_scope`**
`string`, possible values: `"all_participants_and_invitees", "participants_and_invitees_in_our_organization"` — Which participants Meeting Coach applies to.
- **`meeting_questions`**
`object` — Allow users to ask questions in a meeting with AI. Answers are based on what is said in the meeting.
- **`auto_enable`**
`boolean` — Automatically start meeting questions when the meeting starts.
- **`enable`**
`boolean` — Whether users can ask questions in a meeting with AI.
- **`who_can_ask_questions`**
`string`, possible values: `"from_entire_meeting", "from_join_meeting", "host", "org", "org_from_join_meeting"` — Participants allowed to ask meeting questions. Valid values: \`from\_entire\_meeting\` (all participants and invitees), \`from\_join\_meeting\` (all participants from when they join), \`host\` (only the meeting host), \`org\` (participants and invitees in the organization), \`org\_from\_join\_meeting\` (organization participants from when they join).
- **`meeting_summary`**
`object` — Allow hosts to generate a summary. Summaries are sent based on sharing permissions after the meeting ends.
- **`auto_enable`**
`boolean` — Auto-start the meeting summary when the meeting starts.
- **`email_notification`**
`boolean` — Send an email notification when sharing a meeting summary with participants.
- **`enable`**
`boolean` — Whether hosts can generate a meeting summary.
- **`restrict_share_to_outside_of_organization`**
`boolean` — Restrict users from sharing meeting summaries with people outside the organization.
- **`restrict_summary_share`**
`string`, possible values: `"external_users", "all_users", "all_users_except_delegate"` — Audience restricted from sharing meeting summaries. Valid values: \`external\_users\` (users outside the organization), \`all\_users\` (all users), \`all\_users\_except\_delegate\` (all users except delegates).
- **`whether_include_full_text_in_email`**
`string`, possible values: `"include_full_text_in_email", "not_include_full_text_in_email"` — Whether the meeting summary email includes summary text. Valid values: \`include\_full\_text\_in\_email\` (include the summary text), \`not\_include\_full\_text\_in\_email\` (do not include the summary text).
- **`who_will_receive_summary`**
`string`, possible values: `"host", "alt_host", "organization", "all", "host_and_panelist_in_organization", "host_and_panelist_not_in_organization", "host_and_speakers", "do_not_share"` — Recipients for automatically shared meeting summaries. Valid values: \`host\` (only the meeting host), \`alt\_host\` (meeting host, co-hosts, and alternative hosts), \`organization\` (meeting host and invitees in the organization), \`all\` (all meeting invitees, including external invitees), \`host\_and\_panelist\_in\_organization\` (meeting host and participants in the organization), \`host\_and\_panelist\_not\_in\_organization\` (meeting host and all participants, including external participants), \`host\_and\_speakers\` (meeting host and speakers), \`do\_not\_share\` (do not share a summary).
- **`meeting_summary_default_language`**
`object` — Set the default language for meeting summaries.
- **`enable`**
`boolean` — Whether meeting summaries automatically use the selected default language.
- **`language`**
`string` — Language that meeting summaries automatically use when the default-language setting is enabled. 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).
- **`meeting_summary_docs`**
`object` — Automatic Zoom Doc creation from meeting summary.
- **`enable`**
`boolean` — Whether automatic Zoom Doc creation is enabled.
- **`share_with_summary_recipients`**
`boolean` — Whether generated Zoom Docs are shared with meeting summary recipients.
- **`meeting_summary_email_only_mode`**
`boolean` — Only share meeting summaries by email. Users cannot view or edit summaries in the Zoom client or web portal because the meeting summary is not retained.
- **`meeting_summary_ip_access`**
`object` — Allow meeting summary access only from specific IP address ranges.
- **`enable`**
`boolean` — Whether access to meeting summaries is restricted to specified IP address ranges.
- **`ip_addresses_or_ranges`**
`string` — IP addresses or ranges from which meeting summaries can be accessed.
- **`meeting_summary_personal_data_redaction`**
`object` — Personal data redaction for meeting summaries.
- **`enable`**
`boolean` — Whether personal data redaction is enabled.
- **`personal_data_types`**
`array` — Personal data types to redact.
**Items:**
`string`, possible values: `"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"`
- **`meeting_summary_retention`**
`object` — Automatic meeting summary deletion.
- **`enable`**
`boolean` — Whether automatic meeting summary deletion is enabled.
- **`retention_days`**
`integer` — Number of days to retain meeting summaries before deletion.
- **`meeting_summary_sensitive_data_filter`**
`object` — Sensitive data filter for meeting summaries.
- **`enable`**
`boolean` — Whether the sensitive data filter is enabled.
- **`rules`**
`array` — Sensitive data filter rules.
**Items:**
- **`name`**
`string` — Rule display name.
- **`regular_expression`**
`string` — RE2J regular expression.
- **`meeting_summary_template`**
`object` — Allow users to select a meeting summary template for their meetings. The summary is generated using the selected template.
- **`enable`**
`boolean` — Whether users can select a meeting summary template for their meetings.
- **`summary_template_id`**
`string` — ID of the default meeting summary template used to generate meeting summaries.
- **`microsoft_365`**
`object` — Settings for Microsoft 365 data sources.
- **`calendar_events`**
`boolean` — Whether Microsoft Outlook calendar events accessible to the user can be used as a data source for AI.
- **`documents`**
`boolean` — Whether Office 365 documents accessible to the user can be used as a data source for AI.
- **`emails`**
`boolean` — Whether Microsoft Outlook emails accessible to the user can be used as a data source for AI.
- **`enable`**
`boolean` — Whether Microsoft 365 data sources can be used as data sources for AI.
- **`my_notes_ai_content_generation`**
`object` — My Notes AI content generation settings.
- **`auto_generate_summary`**
`boolean` — Whether My Notes automatically generates a summary when a note is completed.
- **`auto_send_summary_email`**
`boolean` — Whether My Notes automatically sends a summary email when a note summary is generated.
- **`enable`**
`boolean` — Whether users can use AI to generate content in My Notes and enrich their writing with the meeting transcript.
- **`my_notes_meeting_transcription`**
`boolean` — Whether users can transcribe their meetings with My Notes.
- **`organization_custom_dictionaries`**
`boolean` — Whether AI can consume the organization's custom dictionaries.
- **`paper_ai_content_generation`**
`boolean` — 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.
- **`participant_can_request_aic_in_meeting`**
`boolean` — Allow participants to request AI Companion in a meeting.
- **`phone_user_ai_notices`**
`object` — Phone user AI notices.
- **`enable`**
`boolean` — Whether phone user AI notices are enabled.
- **`multiple_notifications`**
`boolean` — Whether multiple notifications are allowed.
- **`require_press_1_consent`**
`boolean` — Whether callers must press 1 to consent.
- **`remind_me_turn_on_aic`**
`boolean` — Remind hosts to turn on Zoom AI at the beginning of a meeting when AI features are not configured to auto-start.
- **`remind_me_turn_on_catch_me_up`**
`boolean` — When joining a meeting late, prompt the user to use Zoom AI to summarize what has been discussed so far.
- **`restrict_aic_when_external_user_join_meeting`**
`boolean` — Restrict AI Companion when an external user joins a meeting.
- **`restrict_users_from_deleting_ai_companion_assets`**
`boolean` — Restrict users from deleting meeting assets generated by AI. When enabled, only admins can delete those assets.
- **`restrict_users_from_editing_ai_companion_assets`**
`boolean` — Restrict users from editing meeting assets generated by AI. When enabled, only admins can edit those assets.
- **`restrict_users_from_joining_ai_enabled_meetings`**
`object` — Restrict users from joining meetings where AI meeting processing, including meeting questions and meeting summary, is allowed.
- **`apply_scope`**
`string`, possible values: `"internal_only", "external_only", "internal_and_external"` — Meeting scope to which the restriction applies. Valid values: \`internal\_only\` (internal meetings only), \`external\_only\` (external meetings only), \`internal\_and\_external\` (internal and external meetings).
- **`enable`**
`boolean` — Whether restrictions on joining AI-enabled meetings are enabled.
- **`join_notify`**
`string`, possible values: `"out_of_compliance", "notify_and_remove"` — Action to take when a restricted user tries to join an AI-enabled meeting. Valid values: \`out\_of\_compliance\` (notify the user and allow them to remain), \`notify\_and\_remove\` (notify the user and remove them from the meeting).
- **`screen_share_ocr`**
`boolean` — Whether screen share content is used with OCR.
- **`sheets_ai_content_generation`**
`boolean` — 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.
- **`sheets_ai_formula`**
`boolean` — Whether AI can generate, explain, and apply spreadsheet formulas from natural-language input in Zoom Sheets.
- **`sheets_ai_function`**
`boolean` — Whether users can use the =AI() function in Zoom Sheets to generate, summarize, categorize, and analyze data.
- **`sheets_ai_resources`**
`boolean` — Whether users can add resources, such as meetings, docs, and data tables, to a spreadsheet and have AI suggest updates when they change.
- **`show_conversational_ai_companion`**
`object` — Show conversational AI companion settings.
- **`delete_ai_conversation`**
`boolean` — Whether to automatically delete AI conversation history.
- **`delete_ai_conversation_time`**
`integer | null`, possible values: `30, 60, 90, 120` — The number of days after which AI conversation history is automatically deleted. Supported values are 30, 60, 90, and 120.
- **`enable_zoom_mate`**
`boolean` — Whether ZoomMate is available in the web navigation and Zoom Workplace app navigation bar.
- **`enabled`**
`boolean` — Whether conversational AI is enabled.
- **`slides_ai_content_generation`**
`boolean` — 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.
- **`smart_recording`**
`object` — Smart Recording
- **`create_next_steps`**
`boolean` — Next steps
- **`create_recording_highlights`**
`boolean` — Recording highlights
- **`create_smart_chapters`**
`boolean` — Summary and smart chapters
- **`task_creation_and_management`**
`object` — AI-powered task creation and management with AI Companion.
- **`auto_generate_action`**
`boolean` — Whether to automatically generate action items from tasks.
- **`auto_generate_details`**
`boolean` — Whether to automatically generate task details.
- **`enable`**
`boolean` — Whether AI-powered task creation and management is enabled.
- **`generate_from_phone_call`**
`object` — Settings for generating tasks from phone calls.
- **`auto_add_participant_as_collaborator`**
`boolean` — Whether to automatically add phone call participants as task collaborators.
- **`auto_assign_to_collaborator`**
`boolean` — Whether to automatically assign phone call tasks to collaborators.
- **`enable`**
`boolean` — Whether to allow generating tasks from phone calls.
- **`generate_from_transcripts`**
`object` — Settings for generating tasks from meeting transcripts.
- **`auto_assign_to_collaborator`**
`boolean` — Whether to automatically assign tasks to collaborators.
- **`auto_share_with`**
`string`, possible values: `"host_only", "internal_participants", "internal_assigned_participants"` — Defines who tasks are automatically shared with when generated from transcripts.
- **`enable`**
`boolean` — Whether to allow generating tasks from meeting transcripts.
- **`generate_from_voicemail`**
`boolean` — Whether to allow generating tasks from voicemail.
- **`third_party_app_tasks`**
`boolean` — Whether AI can perform tasks on the user's behalf in third-party apps configured within AI Studio.
- **`third_party_meeting_join`**
`object` — Third-party meeting join with AI.
- **`allow_recording`**
`boolean` — Whether recording is enabled for joined third-party meetings.
- **`calendar`**
`object` — Calendar-based third-party meeting join.
- **`enable`**
`boolean` — Whether calendar-based third-party meeting join is enabled.
- **`join_scope`**
`string`, possible values: `"all_events_with_video_conference_links", "meetings_where_i_am_the_host", "meetings_where_i_am_a_participant"` — Which calendar events third-party meeting join applies to.
- **`enable`**
`boolean` — Whether third-party meeting join with AI is enabled.
- **`pre_meeting_email_notification`**
`object` — Pre-meeting email notification.
- **`enable`**
`boolean` — Whether pre-meeting email notification is enabled.
- **`recipients`**
`string`, possible values: `"all_invitees", "only_meeting_host"` — Who receives the pre-meeting email notification.
- **`web_content`**
`boolean` — Whether public web content can be used as a data source for AI.
- **`webinar_questions`**
`object` — During the webinar, answers are based on speech-to-text data. If a transcript is retained, participants with access will be able to ask questions after the webinar based on that transcript.
- **`auto_enable`**
`boolean` — Whether to automatically allow access when the webinar starts.
- **`enable`**
`boolean` — Whether to allow users to ask webinar questions with AI.
- **`who_can_ask_questions`**
`string`, possible values: `"panelist_all", "panelist_org", "host", "all_participants"` — Who can ask questions about the webinar. Valid values: \`panelist\_all\` (Hosts and all panelists), \`panelist\_org\` (Hosts and all panelists in our organization), \`host\` (Only webinar host, co-hosts, and alternative hosts), \`all\_participants\` (All participants).
- **`webinar_summary`**
`object` — Allow hosts to generate a summary. Summaries are sent after the webinar has ended based on sharing permissions.
- **`auto_enable`**
`boolean` — Whether to turn on webinar summary automatically when the webinar starts.
- **`email_notification`**
`boolean` — Whether to send an email notification when sharing to participants.
- **`enable`**
`boolean` — Whether to allow hosts to generate a summary.
- **`restrict_share_to_outside_of_organization`**
`boolean` — Whether to restrict users from sharing summaries to those outside of the organization.
- **`restrict_summary_share`**
`string`, possible values: `"external_users", "all_users", "all_users_except_delegate"` — Whether to 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).
- **`whether_include_full_text_in_email`**
`string`, possible values: `"include_full_text_in_email", "not_include_full_text_in_email"` — 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).
- **`who_will_receive_summary`**
`string`, possible values: `"host", "host_and_panelist_in_organization", "host_and_panelist_not_in_organization"` — 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 our organization), \`host\_and\_panelist\_not\_in\_organization\` (Webinar host, co-hosts, and all panelists, including those outside our organization).
- **`webinar_summary_follow_up_email`**
`boolean` — Whether webinar summaries are included in webinar follow-up email. Deprecated. Use \`include\_webinar\_summary\_follow\_up\_email\`.
- **`webinar_summary_ocr`**
`boolean` — 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.
- **`whiteboard_content_generation`**
`boolean` — Whether Whiteboard content generation with AI is enabled.
- **`workspace_reservation_recommendations_with_ai`**
`object` — Workspace Reservation recommendations with AI.
- **`custom_workspaces_recommendation`**
`boolean` — Whether custom workspace recommendations are enabled.
- **`day_recommendation`**
`boolean` — Whether day recommendations are enabled.
- **`desk_recommendation`**
`boolean` — Whether desk recommendations are enabled.
- **`enabled`**
`boolean` — Whether Workspace Reservation recommendations with AI are enabled.
- **`proactive_room_recommendation`**
`boolean` — Whether proactive room recommendations are enabled.
- **`room_recommendation`**
`boolean` — Whether room recommendations are enabled.
- **`zoom_events_analytics`**
`boolean` — Whether Zoom Events AI Analytics is enabled. AI can analyze event engagement and uncover key moments, topics of interest, and actionable insights.
- **`zoom_events_chat_compose`**
`boolean` — Whether Zoom Events Chat Compose is enabled. AI helps users compose a response from scratch or wordsmith their chat messages.
- **`zoom_events_chat_panel`**
`boolean` — 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.
- **`zoom_events_content_generation`**
`boolean` — Whether Zoom Events Content Generation with AI is enabled. AI content generation helps users create blogs, ebooks, whitepapers, emails, highlights, and sales briefs.
- **`zoom_events_content_studio`**
`boolean` — Whether Content Studio is enabled. Content Studio can turn recordings into high-quality content such as video clips, emails, and blog posts.
- **`zoom_events_email_compose`**
`boolean` — Whether Zoom Events Email Compose with AI is enabled. AI can compose emails and subject lines for events in the Email Builder.
- **`zoom_events_image_generation`**
`boolean` — Whether the Zoom Events image generator is enabled. AI can create images for use in an event.
- **`zoom_events_session_summary`**
`object` — Session summary. Allow hosts to generate a summary. Summaries are sent after the session has ended based on the in-session access options.
- **`auto_start`**
`boolean` — Whether to turn on session summary automatically when sessions start.
- **`enable`**
`boolean` — Whether Zoom Events session summaries are enabled.
- **`zoom_events_smart_compose`**
`boolean` — 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.
- **`zoom_events_smart_upload`**
`boolean` — Whether Zoom Events Smart Upload is enabled. AI can ingest files to quickly create event content such as speaker biographies.
- **`audio_conferencing`**
`object` — The account's audio conference settings.
- **`call_me_and_invite_by_phone`**
`object` — 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.
- **`allow_webinar_attendees_call_me`**
`boolean` — Whether webinar attendees can use Call Me to connect audio. This feature is only available in version 5.2.2 and higher.
- **`call_out_countries`**
`object` — The account's call out countries/regions settings.
- **`selected_countries`**
`array` — The list of countries/regions that users can call out to.
**Items:**
- **`code`**
`string` — The \[code]\(https\://developers.zoom.us/docs/api/rest/other-references/abbreviation-lists/#countries) of the country or region.
- **`name`**
`string` — The name of the country or region.
- **`enable`**
`boolean` — 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.
- **`require_press_1_for_call_me`**
`string`, possible values: `"auto", "always", "never"` — Require Call Me users to press 1 before being connected to the meeting. \* \`auto\` - Automatically determine whether to require pressing 1 before connecting to the meeting. \* \`always\` - Always require Call Me users to press 1 before connecting to the meeting. \* \`never\` - Never require Call Me users to press 1 before connecting to the meeting.
- **`global_dial_in_countries`**
`object` — The account's \[\*\*Global Dial-in Countries/Regions\*\*]\(https\://support.zoom.com/hc/en/article?id=zm\_kb\&sysparm\_article=KB0068094#h\_01F5KK9J31ZXNW10BRH86NHX4G) settings.
- **`include_toll_free`**
`boolean` — Whether to include toll-free numbers in the email invitation for the selected countries/regions.
- **`selected_countries`**
`array` — The list of selected countries/regions whose dial-in numbers will be listed in the email invitation.
**Items:**
- **`code`**
`string` — The \[code]\(https\://developers.zoom.us/docs/api/rest/other-references/abbreviation-lists/#countries) of the country or region.
- **`name`**
`string` — The name of the country or region.
- **`participant_phone_masking`**
`object` — 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.
- **`enable`**
`boolean` — 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.
- **`masking_type`**
`string`, possible values: `"mask_default", "mask_first_5", "mask_except_last_4"` — The type of phone number masking pattern to apply. \* \`mask\_default\` - Default masking pattern (Example: 888\*\*\*\*666). \* \`mask\_first\_5\` - Mask first five digits (Example: \*\*\*\*\*66666). \* \`mask\_except\_last\_4\` - Mask everything except last four digits (Example: \*\*\*\*\*6666).
- **`personal_audio_conference`**
`boolean` — 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.
- **`toll_call`**
`object` — The account's \[\*\*Toll Call\*\*]\(https\://support.zoom.com/hc/en/article?id=zm\_kb\&sysparm\_article=KB0066909#h\_01F51680NJ7YHZDXGJNSKDGM2P) settings.
- **`enable`**
`boolean` — Whether the account has the \[\*\*Toll Call\*\*]\(https\://support.zoom.com/hc/en/article?id=zm\_kb\&sysparm\_article=KB0066909#h\_01F51680NJ7YHZDXGJNSKDGM2P) setting enabled.
- **`numbers`**
`array` — The account's \*\*Toll Call\*\* phone number information.
**Items:**
- **`code`**
`string` — The phone number's \[E.164 country calling code]\(https\://en.wikipedia.org/wiki/List\_of\_country\_calling\_codes).
- **`country_code`**
`string` — The phone number's two-letter \[country code]\(https\://developers.zoom.us/docs/api/rest/other-references/abbreviation-lists/#countries).
- **`country_name`**
`string` — The country name.
- **`display_number`**
`string` — The phone number's display number.
- **`number`**
`string` — The phone number.
- **`toll_free_and_fee_based_toll_call`**
`object` — 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.
- **`allow_webinar_attendees_dial`**
`boolean` — 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.
- **`enable`**
`boolean` — 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.
- **`numbers`**
`array` — The account's phone numbers.
**Items:**
- **`code`**
`string` — The phone number's \[E.164 country calling code]\(https\://en.wikipedia.org/wiki/List\_of\_country\_calling\_codes).
- **`country_code`**
`string` — The phone number's \[country code]\(https\://marketplace.zoom.us/docs/api-reference/other-references/abbreviation-lists#countries).
- **`country_name`**
`string` — The country name.
- **`display_number`**
`string` — The phone number's display number.
- **`number`**
`string` — The phone number.
- **`chat`**
`object` — The account's chat settings.
- **`ai_compose`**
`object` — Allow users to summarize chats, channels, and shared documents.
- **`enable`**
`boolean` — Compose with AI Companion
- **`shown_in_team_chat`**
`boolean` — Show in Team Chat
- **`ai_quick_reply`**
`boolean` — Quick reply with AI Companion
- **`ai_quick_schedule`**
`boolean` — Quick schedule with AI Companion
- **`ai_recommend`**
`boolean` — Chat Recommendation with Zoom AI Companion
- **`ai_sentence_completion`**
`boolean` — Sentence completion with AI Companion
- **`ai_summary`**
`object` — Allow users to summarize chats, channels, and shared documents.
- **`enable`**
`boolean` — Summarize with AI Companion
- **`shown_in_team_chat`**
`boolean` — Show in Team Chat
- **`allow_bots_chat`**
`boolean` — Whether chatbots added to chats and channels can read and write messages.
- **`allow_delete_message`**
`object` — 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.
- **`enable`**
`boolean` — Allow users to delete messages
- **`time`**
`integer`, possible values: `0, 5, 30, 60, 1440, 10080` — Within how many minitues of posting
- **`allow_edit_message`**
`object` — 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.
- **`enable`**
`boolean` — Allow users to edit messages
- **`time`**
`integer`, possible values: `0, 5, 30, 60, 1440, 10080` — Within how many minitues of posting
- **`allow_huddles_from_channels`**
`boolean` — Allow huddles from channels
- **`allow_remove_msg_by_owner_and_admins`**
`boolean` — Allow channel owner and admin(s) to remove messages of other members
- **`allow_users_to_add_contacts`**
`object` — Allow users to add contacts.
- **`enable`**
`boolean` — By disabling this setting, users will not be able to add contacts.
- **`selected_option`**
`integer`, possible values: `1, 2, 3, 4` — The type of allowing users to add contacts: \* 1 — Anyone (internal and external contacts). \* 2 — In the same organization. \* 3 — In the same organization and specified domains. \* 4 — In the same organization and specified users.
- **`user_email_addresses`**
`string` — The domains or emails (internal or external). \* 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. \* When the \`selected\_option\` field value is \`4\`, the value is internal or external email addresses. Use a comma to separate multiple emails.
- **`allow_users_to_chat_with_others`**
`object` — Allow users to chat with others.
- **`enable`**
`boolean` — 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.
- **`selected_option`**
`integer`, possible values: `1, 2, 3, 4` — The type of allowing users to add contacts: \* 1 — Anyone (internal and external contacts). \* 2 — In the same organization. \* 3 — In the same organization and specified domains. \* 4 — In the same organization and specified users.
- **`user_email_addresses`**
`string` — The domains or emails (internal or external). \* 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. \* When the \`selected\_option\` field value is \`4\`, the value is internal or external email addresses. Use a comma to separate multiple emails.
- **`apply_local_storage_to_personal_channel`**
`object` — Store personal channel messages on local devices.
- **`enable`**
`boolean` — 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.
- **`retention_period`**
`string` — Delete data after retention period. 'y' - year, 'm' - month, 'd' - day.
- **`chat_email_address`**
`object` — 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.
- **`enable`**
`boolean` — Chat email address
- **`only_allow_specific_domains`**
`boolean` — Only allow emails from specified domains
- **`specific_domains`**
`array`
**Items:**
`string` — Specified domains.
- **`chat_emojis`**
`object` — Chat emojis.
- **`emojis_option`**
`string`, possible values: `"all", "selected"`
- **`enable`**
`boolean` — 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.
- **`chat_etiquette_tool`**
`object` — Information about the \*\*Chat Etiquette Tool\*\*.
- **`enable`**
`boolean` — Whether to enable the \*\*Chat Etiquette Tool\*\*.
- **`policies`**
`array` — Information about the defined \*\*Chat Etiquette Tool\*\* policies.
**Items:**
- **`description`**
`string` — The policy's description.
- **`id`**
`string` — The policy ID.
- **`is_locked`**
`boolean` — Whether the policy is locked by an account-level user. When it is locked, users cannot update the policy.
- **`keywords`**
`array` — A list of defined rule keywords.
**Items:**
`string`
- **`name`**
`string` — The policy name.
- **`regular_expression`**
`string` — The regular expression to match to the content of chat messages.
- **`status`**
`string`, possible values: `"activated", "deactivated"` — The policy's current status. \* \`activated\` — Activated. \* \`deactivated\` — Deactivated.
- **`trigger_action`**
`integer`, possible values: `1, 2` — The policy's trigger action. \* \`1\` — Ask the user to confirm before they send the message. \* \`2\` — Block the user's message.
- **`policy_max_count`**
`integer` — The read-only maximum number of \*\*Chat Etiquette Tool\*\* policies.
- **`code_snippet`**
`boolean` — Send code snippet
- **`create_group_chat`**
`boolean` — Allow users to create group chats.
- **`create_private_channels`**
`boolean` — Allow users to create private channels.
- **`create_public_channels`**
`boolean` — Allow users to create public channels.
- **`download_file`**
`boolean` — Downloading files
- **`external_collab_restrict`**
`object` — Restrict external collaboration in group chats and channels for a select group
- **`enable`**
`boolean` — Restrict external collaboration in group chats and channels for a select group
- **`external_chat`**
`string`, possible values: `"allowed", "not_allowed"` — The type of restrict external collaboration in group chats and channels for a select group \* - Allowed user group \* - Not allowed user group
- **`group_id`**
`string` — The group Id
- **`external_invite_approve`**
`object` — Require admin approval for adding external users in group chats and channels
- **`channel_id`**
`string` — The channel Id
- **`enable`**
`boolean` — Require admin approval for adding external users in group chats and channels
- **`external_account`**
`boolean` — Allow this setting to be edited for specified accounts
- **`selected_option`**
`integer`, possible values: `1, 2` — 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
- **`external_join_approve`**
`object` — Require admin approval for joining external group chats and channels
- **`channel_id`**
`string` — The channel Id
- **`enable`**
`boolean` — Require admin approval for joining external group chats and channels
- **`external_account`**
`boolean` — Allow this setting to be edited for specified accounts
- **`selected_option`**
`integer`, possible values: `1, 2` — The type of requiring admin approval for joining external group chats and channels \* 1 - Send requests directly to all approvers \* 2 - Send requests to a specific channel
- **`external_member_join`**
`object` — Allow members of your organization to join external group chats and channels
- **`enable`**
`boolean` — Allow members of your organization to join external group chats and channels
- **`external_account`**
`boolean` — Allow this setting to be edited for specified accounts
- **`external_user_control`**
`object` — Add external users into group chats and channels
- **`enable`**
`boolean` — Allow to add external users into group chats and channels
- **`external_account`**
`boolean` — Allow this setting to be edited for specified accounts
- **`selected_option`**
`integer`, possible values: `1, 2, 3` — The type of allowing external user control \* 1 - Everyone \* 2 - Only members in your organization, plus specified external accounts \* 3 - Only the account owner and admins
- **`hyper_link`**
`boolean` — Allow hyperlinks in Team Chat
- **`personal_channel`**
`boolean` — Enable Personal Chat
- **`presence_away_when_screen_saver`**
`boolean` — Change my status to away when screen saver begins
- **`presence_on_meeting`**
`boolean` — Change my presence status when I am in a meeting or call
- **`read_receipts`**
`object` — Indicate when messages have been seen by recipients, for chats and channels with less than 20 members.
- **`allow_users_opt_out`**
`boolean` — Allow users to opt out
- **`enable`**
`boolean` — Enable read receipts
- **`record_video_messages`**
`boolean` — 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.
- **`record_voice_messages`**
`boolean` — Allow users to record voice messages that can be sent in direct messages or group conversations.
- **`schedule_meetings_in_chat`**
`boolean` — Schedule a meeting from chat or channel.
- **`screen_capture`**
`boolean` — Allow users to take and send screenshots in direct messages or group conversations.
- **`search_and_send_animated_gif_images`**
`object` — Allow users to search GIF images from GIPHY when they compose messages. See GIPHY's website for more information about content ratings.
- **`enable`**
`boolean` — Whether to allow users to search GIF images from GIPHY when they compose messages.
- **`giphy_content_rating`**
`integer`, possible values: `1, 2, 3, 4` — Set the GIPHY content rating. This feature is only available for Zoom Client v5.11.0 or later.
- **`send_data_to_third_party_archiving_service`**
`object` — Send data to third-party archiving service.
- **`authorized_channel_token`**
`string` — Authorized channel token. It is used when the field \`type\` value is \`smarsh\`.
- **`enable`**
`boolean` — Allow users to send data to third-party archiving service.
- **`passcode`**
`string` — passcode. It is used when the field \`type\` value is \`global\_relay\`.
- **`smtp_delivery_address`**
`string` — SMTP delivery address. It is used when the field \`type\` value is \`global\_relay\`.
- **`type`**
`string`, possible values: `"global_relay", "smarsh"` — The type of global relay. \* \`global\_relay\` — The participant cannot use chat. \* \`smarsh\` — Host and co-hosts only.
- **`user_name`**
`string` — User name. It is used when the field \`type\` value is \`global\_relay\`.
- **`set_chat_as_default_tab`**
`boolean` — Set Team Chat as a default tab for first-time users
- **`set_retention_period_in_cloud`**
`object` — Set retention period for messages and files in Zoom's cloud.
- **`enable`**
`boolean` — 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.
- **`retention_period_of_channels`**
`string` — Delete data in channels after retention period. 'y' - year, 'm' - month, 'd' - day
- **`retention_period_of_direct_messages_and_group_conversation`**
`string` — Delete direct messages and group conversations after retention period. 'y' - year, 'm' - month, 'd' - day
- **`set_retention_period_in_local`**
`object` — Store messages on local devices, excluding personal channel messages.
- **`enable`**
`boolean` — Specify how long your messages are saved on local devices. If this setting is disabled, messages are never deleted locally.
- **`retention_period_of_channels`**
`string` — Delete data in channels after retention period. 'y' - year, 'm' - month, 'd' - day
- **`retention_period_of_direct_messages_and_group_conversation`**
`string` — Delete direct messages and group conversations after retention period. 'y' - year, 'm' - month, 'd' - day
- **`share_files`**
`object` — Users can share files in chats and channels.
- **`enable`**
`boolean` — 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.
- **`restrictions`**
`object` — The restrictions of users can share files in chats and channels
- **`file_restrictions_apply_to`**
`string`, possible values: `"sharing_and_viewing", "sharing"` — Apply restrictions to both sharing and viewing, or only apply to sharing
- **`file_size_restrictions`**
`integer`, possible values: `50, 100, 200, 300, 400, 500` — Maximum file size
- **`file_size_restrictions_for_external`**
`integer`, possible values: `50, 100, 200, 300, 400, 500` — Maximum file size for external users
- **`file_type_restrictions`**
`array` — The restrictions of users can share files in chats and channels
**Items:**
`string`, possible values: `".gz", ".rar", ".zip", ".xls", ".xlsx", ".json", ".png", ".pptx", ".ppt", ".7z", ".xmind", ".pdf", ".pps", ".txt", ".docx", ".doc"` — Specified file type
- **`file_type_restrictions_for_external`**
`array`
**Items:**
`string`, possible values: `".gz", ".rar", ".zip", ".xls", ".xlsx", ".json", ".png", ".pptx", ".ppt", ".7z", ".xmind", ".pdf", ".pps", ".txt", ".docx", ".doc"` — Specified file type
- **`maximum_file_size`**
`boolean` — Whether to restrict file size
- **`only_allow_specific_file_types`**
`boolean` — Only allow specified file types
- **`share_option`**
`string`, possible values: `"disable", "anyone", "account", "organization"` — Allow users of this account to send files in chats and channels.
- **`view_option`**
`string`, possible values: `"anyone", "account", "organization"` — Allow users of this account to view files in chats and channels.
- **`share_links_in_chat`**
`boolean` — Share links to messages and channels in Team Chat.
- **`share_screen_in_chat`**
`boolean` — Share screen in chat
- **`shared_spaces`**
`boolean` — Allow users to create Shared Spaces
- **`show_h323_contact_tab`**
`boolean` — Show H.323 contacts
- **`show_status_to_internal_contact`**
`boolean` — Show status to internal contacts
- **`store_revise_chat`**
`boolean` — Store edited and deleted message revisions
- **`suppress_removal_notification`**
`boolean` — Suppress deleted, deactivated, and reactivated user notice in group chats and channels
- **`suppress_user_group_notification`**
`boolean` — Suppress add and remove user notice in channels
- **`survey_poll`**
`boolean` — Allow users to launch a poll in chats and channels
- **`translate_messages`**
`boolean` — Allow users to translate team chat messages. \[Learn more].(https\://support.zoom.us/hc/en-us/articles/12998089084685)
- **`email_notification`**
`object` — Information about the email notification settings.
- **`alternative_host_reminder`**
`boolean` — Whether to notify when an alternative host is added to or removed from a meeting.
- **`cancel_meeting_reminder`**
`boolean` — Whether to notify the host and participants when a meeting is canceled.
- **`cloud_recording_available_reminder`**
`boolean` — Whether to notify the host when a cloud recording is available.
- **`jbh_reminder`**
`boolean` — Whether to notify the host when participants join the meeting before them.
- **`low_host_count_reminder`**
`boolean` — Whether to notify the user when host licenses are running low.
- **`recording_available_reminder_alternative_hosts`**
`boolean` — Whether to notify any alternative hosts when a cloud recording is available.
- **`recording_available_reminder_schedulers`**
`boolean` — Whether to notify the person who scheduled the meeting or webinar for the host when a cloud recording is available.
- **`schedule_for_reminder`**
`boolean` — Whether to notify the host that there is a meeting is scheduled, rescheduled, or canceled.
- **`feature`**
`object` — Feature
- **`meeting_capacity`**
`integer` — The maximum number of participants a host can have in a single meeting.
- **`general_setting`**
`object` — General settings.
- **`auto_zoom_room_proximity_connect`**
`boolean` — Allow automatic direct sharing and connecting to Zoom Rooms using ultrasonic proximity signal.
- **`show_zoom_room_feature`**
`boolean` — Show "Zoom Room" feature in the Zoom Workplace app.
- **`h323sip_conferencing`**
`object` — The account's H.323/SIP Conferencing settings.
- **`custom_welcome_audio`**
`object` — Information about the custom welcome audio message played to H.323/SIP devices upon joining a Zoom Meeting.
- **`audio_file`**
`string` — The URL for the configured custom audio file.
- **`enable`**
`boolean`, default: `false` — Determines if a custom welcome audio message is played when H.323/SIP devices join a Zoom Meeting.
- **`in_meeting`**
`object` — Information about the in meeting settings.
- **`alert_guest_join`**
`boolean` — Whether to alert when a guest joins a meeting.
- **`allow_host_panelists_to_use_audible_clap`**
`boolean` — Whether to allow host and panelist to use audible clap.
- **`allow_host_to_enable_focus_mode`**
`boolean` — Whether the host can enable \[\*\*Focus Mode\*\*]\(https\://support.zoom.us/hc/en-us/articles/360061113751-Using-focus-mode) when scheduling a meeting.
- **`allow_live_streaming`**
`boolean` — Whether to allow livestreaming.
- **`allow_participants_chat_with`**
`integer`, possible values: `1, 2, 3, 4` — Whether participants can chat with certain groups: \* \`1\` — The participants cannot use chat. \* \`2\` — Host and co-hosts only. \* \`3\` — The participants can chat with other participants publicly. \* \`4\` - The participants can chat with other participants publicly and privately. \*\*Note:\*\* This setting is only available with client versions 5.7.3 and above.
- **`allow_show_zoom_windows`**
`boolean` — Whether to display the Zoom desktop application when sharing access.
- **`allow_users_save_chats`**
`integer`, possible values: `1, 2, 3` — Whether participants can save meeting chats: \* \`1\` — Participants cannot save meeting chats. \* \`2\` — Participants can only save host and co-host meeting chats. \* \`3\` — Participants can save all meeting chats.
- **`allow_users_to_delete_messages_in_meeting_chat`**
`boolean` — If the value of this field is set to \`true\`, allow users to delete messages in the in-meeting chat.
- **`annotation`**
`boolean` — Whether participants can use annotation tools to add information to shared screens.
- **`anonymous_question_answer`**
`boolean` — Whether anonymous Q\&A is enabled in a webinar.
- **`attendee_on_hold`**
`boolean` — Whether hosts can temporarily place an attendee on hold.
- **`attention_mode_focus_mode`**
`boolean` — Whether the \[\*\*Focus Mode\*\*]\(https\://support.zoom.us/hc/en-us/articles/360061113751-Using-focus-mode) feature is enabled. When enabled, this feature only displays the host and co-hosts' video and profile pictures during a meeting.
- **`audio_watermark_by_default`**
`boolean` — Whether to turn on \[audio watermark]\(https\://support.zoom.us/hc/en-us/articles/360021839031-Adding-audio-watermark) by default when scheduling a meeting.
- **`auto_answer`**
`boolean` — Whether users can 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.
- **`auto_saving_chat`**
`boolean` — Whether to automatically save all in-meeting chats.
- **`breakout_room`**
`boolean` — Whether the host can split meeting participants into separate, smaller rooms.
- **`breakout_room_schedule`**
`boolean` — Whether the host can assign participants to breakout rooms when scheduling. This feature is \*\*only\*\* available in version 4.5.0 or higher.
- **`chat`**
`boolean` — Whether meeting participants can use \[in-meeting chat]\(https\://support.zoom.us/hc/en-us/articles/203650445-In-Meeting-Chat).
- **`closed_caption`**
`boolean` — Whether the host can add closed captions.
- **`closed_captioning`**
`object` — The account's closed captioning settings.
- **`auto_transcribing`**
`boolean` — Whether to allow a live transcription service to transcribe meetings.
- **`enable`**
`boolean` — Whether to allow the host to type closed captions or assign a participant or 3rd-party service to provide closed captioning.
- **`save_caption`**
`boolean` — Whether to allow participants to save closed captions or transcripts.
- **`third_party_captioning_service`**
`boolean` — Whether to allow the use of an API token to integrate with 3rd-party closed captioning services.
- **`view_full_transcript`**
`boolean` — Whether to allow the viewing of full transcripts in the in-meeting side panel.
- **`co_host`**
`boolean` — Whether to allow the meeting host to add co-hosts.
- **`custom_data_center_regions`**
`boolean` — Whether custom \[data center regions]\(https\://support.zoom.us/hc/en-us/articles/360042411451-Selecting-data-center-regions-for-hosted-meetings-and-webinars) are enabled for hosting real-time meeting and webinar traffic: \* \`true\` — Enabled. Provide the data center regions in the \`data\_center\_regions\` field. \* \`false\` — Disabled. Only use the default data center regions.
- **`custom_live_streaming_service`**
`boolean` — Whether to allow custom livestreaming.
- **`custom_service_instructions`**
`string` — The custom livestreaming service instructions.
- **`data_center_regions`**
`array` — The user's selected custom data center regions. This field only returns if the \`custom\_data\_center\_regions\` value is \`true\`: \* \`AU\` — Australia. \* \`LA\` — Latin America. \* \`CA\` — Canada. \* \`CN\` — China. \* \`DE\` — Germany. \* \`HK\` — Hong Kong SAR. \* \`IN\` — India. \* \`IE\` — Ireland. \* \`TY\` — Japan. \* \`MX\` — Mexico. \* \`NL\` — Netherlands. \* \`SG\` — Singapore. \* \`US\` — United States.
**Items:**
`string`, possible values: `"AU", "LA", "CA", "CN", "DE", "HK", "IN", "IE", "TY", "MX", "NL", "SG", "US"`
- **`disable_screen_sharing_for_host_meetings`**
`boolean` — Whether the \*\*Disable desktop screen sharing for meetings you host\*\* setting is enabled.
- **`disable_screen_sharing_for_in_meeting_guests`**
`boolean` — Whether the \*\*Disable screen sharing when guests are in the meeting\*\* setting is enabled.
- **`dscp_audio`**
`integer` — The DSCP audio value.
- **`dscp_marking`**
`boolean` — Whether to use DSCP (differentiated services code point) marking.
- **`dscp_video`**
`integer` — The DSCP video value.
- **`e2e_encryption`**
`boolean` — Whether to require \[AES encryption]\(https\://en.wikipedia.org/wiki/Advanced\_Encryption\_Standard) for meetings.
- **`far_end_camera_control`**
`boolean` — Whether another user can take control of camera during a meeting.
- **`feedback`**
`boolean` — Whether users can send feedback to Zoom at the end of the meeting.
- **`file_transfer`**
`boolean` — Whether file sharing via in-meeting chat is enabled.
- **`group_hd`**
`boolean` — Whether higher quality video for the host and participants is enabled.
- **`join_from_desktop`**
`boolean` — Whether participants can join a meeting directly from their desktop browser.
- **`join_from_mobile`**
`boolean` — Whether participants can join a meeting directly from their mobile browser.
- **`language_interpretation`**
`object` — Information about the \[language interpretation]\(https\://support.zoom.us/hc/en-us/articles/360034919791-Using-Language-Interpretation-in-your-meeting-or-webinar) settings.
- **`allow_participants_to_speak_in_listening_channel`**
`boolean` — Whether to allow participants to speak in listening channel.
- **`allow_up_to_25_custom_languages_when_scheduling_meetings`**
`boolean` — Whether to allow up to 25 custom languages when scheduling meetings.
- **`custom_languages`**
`array` — A list of user-defined supported languages.
**Items:**
`string`
- **`enable`**
`boolean` — Whether hosts can assign participants as interpreters to interpret one language into another in real-time.
- **`enable_language_interpretation_by_default`**
`boolean` — Whether enable language interpretation by default.
- **`languages`**
`array`, possible values: `"English", "Chinese", "Japanese", "German", "French", "Russian", "Portuguese", "Spanish", "Korean"` — A list of system-supported languages.
**Items:**
`string`
- **`live_streaming_facebook`**
`boolean` — Whether to allow Facebook livestreaming.
- **`live_streaming_youtube`**
`boolean` — Whether to allow YouTube livestreaming.
- **`meeting_polling`**
`object` — Information about the account's meeting polling settings.
- **`advanced_polls`**
`boolean` — Whether the host can 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.
- **`allow_alternative_host_to_add_edit`**
`boolean` — Whether alternative hosts can add or edit polls and quizzes.
- **`allow_host_to_upload_image`**
`boolean` — Whether to allow host to upload an image for each question.
- **`enable`**
`boolean` — Whether the host can add polls before or during a meeting.
- **`manage_saved_polls_and_quizzes`**
`boolean` — Whether to allow users to manage saved polls and quizzes from Meetings
- **`require_answers_to_be_anonymous`**
`boolean` — Whether to require answers to be anonymous.
- **`meeting_question_answer`**
`boolean` — Allow participants to ask questions for the host and participants to answer.
- **`meeting_reactions`**
`boolean` — 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.
- **`meeting_reactions_emojis`**
`string`, possible values: `"all", "selected"` — Choose from the following meeting reaction options: \* \`all\` — All emojis: Allow meeting participants to use any emoji available in Zoom chat as a reaction in a meeting. \* \`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)
- **`meeting_survey`**
`boolean` — 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.
- **`non_verbal_feedback`**
`boolean`, default: `false` — 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\`.
- **`original_audio`**
`boolean` — Whether users can select original sound in their client settings.
- **`p2p_connetion`**
`boolean` — Whether peer-to-peer connection when only two people are in a meeting is enabled.
- **`p2p_ports`**
`boolean` — Whether a peer-to-peer listening ports range is enabled.
- **`participants_share_simultaneously`**
`string`, possible values: `"multiple", "one"` — Indicates how many participants can screen share at the same time. The value can be one of the following:\
\`one\`: Only one participant can screen share at a time .\
\`multiple\`: Multiple participants can screen share simultaneously (dual monitors recommended).
- **`polling`**
`boolean` — Whether polls are available in the meeting controls.
- **`ports_range`**
`string` — The comma-separated peer-to-peer listening ports range (for example, \`55,56\`), between 1 to 65535.
- **`post_meeting_feedback`**
`boolean` — Whether to display a post-meeting feedback survey at the end of a meeting.
- **`private_chat`**
`boolean` — Whether meeting participants can use private chat.
- **`remote_control`**
`boolean` — Whether users can request remote control.
- **`remote_support`**
`boolean`, default: `false` — Whether to enable the \[\*\*Remote support\*\*]\(https\://support.zoom.us/hc/en-us/articles/360060951012-Enabling-remote-support) setting. This value defaults to \`false\`.
- **`screen_sharing`**
`boolean` — Whether to allow screen sharing.
- **`sending_default_email_invites`**
`boolean` — Whether to display the default email when sending email invites.
- **`show_a_join_from_your_browser_link`**
`boolean` — Whether participants can join a meeting directly from their browser and bypass the Zoom application download process.
- **`show_meeting_control_toolbar`**
`boolean` — Whether to always display the meeting control bar.
- **`sign_language_interpretation`**
`object` — 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.
- **`custom_languages`**
`array` — A list of user-defined supported languages.
**Items:**
`string`
- **`enable`**
`boolean` — Whether to allow hosts to assign participants as sign language interpreters who can interpret one language into another in real-time.
- **`enable_sign_language_interpretation_by_default`**
`boolean` — Whether to enable sign language interpretation view by default in scheduler.
- **`languages`**
`array` — A list of system-supported languages.
**Items:**
`string`, possible values: `"American", "Chinese", "French", "German", "Japanese", "Russian", "Brazilian", "Spanish", "Mexican", "British"`
- **`slide_control`**
`boolean` — 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.
- **`stereo_audio`**
`boolean` — Whether users can select stereo audio in their client settings.
- **`use_html_format_email`**
`boolean` — Whether to use HTML-formatted email for the Outlook plugin.
- **`virtual_background`**
`boolean` — Whether users can change their background.
- **`watermark`**
`boolean` — Whether to add watermark when viewing a shared screen.
- **`watermark_by_default`**
`boolean` — Whether to turn on watermark by default when scheduling a meeting.
- **`webinar_chat`**
`object`
- **`allow_attendees_chat_with`**
`integer`, possible values: `1, 2, 3` — Webinar attendees can chat with: \* \`1\` — No one. \* \`2\` — Host and all panelists. \* \`3\` — Everyone.
- **`allow_auto_save_local_chat_file`**
`boolean` — Whether chat messages are saved automatically to a local file on the host's computer when the webinar ends.
- **`allow_panelists_chat_with`**
`integer`, possible values: `1, 2` — Webinar panelists can chat with: \* \`1\` — Host and all panelists. \* \`2\` — Everyone.
- **`allow_panelists_send_direct_message`**
`boolean` — Whether webinar panelists can send direct messages to other panelists.
- **`allow_users_save_chats`**
`integer`, possible values: `0, 1, 2` — Whether webinar attendees can save chats: \* \`0\` — Attendees cannot save chats. \* \`1\` — Attendees can only save host and panelist chats. \* \`2\` — Attendees can save all chats.
- **`default_attendees_chat_with`**
`integer`, possible values: `1, 2` — By default, webinar attendees can chat with: \* \`1\` — Host and all panelists. \* \`2\` — Everyone.
- **`enable`**
`boolean` — Whether webinar participants can send chat messages.
- **`webinar_live_streaming`**
`object`
- **`custom_service_instructions`**
`string` — The specific instructions that allow the account's meeting hosts to configure a custom livestream.
- **`enable`**
`boolean` — Whether webinar livestreaming is enabled.
- **`live_streaming_reminder`**
`boolean` — Whether to notify users to watch the livestream. This does not apply to custom RTMP (real-time messaging protocol).
- **`live_streaming_service`**
`array` — The available livestreaming services: \* \`facebook\` \* \`workplace\_by\_facebook\` \* \`youtube\` \* \`custom\_live\_streaming\_service\`
**Items:**
`string`, possible values: `"facebook", "workplace_by_facebook", "youtube", "custom_live_streaming_service"`
- **`webinar_polling`**
`object` — Information about the account's webinar polling settings.
- **`advanced_polls`**
`boolean` — Whether the host can 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.
- **`allow_alternative_host_to_add_edit`**
`boolean` — Whether alternative hosts can add or edit polls and quizzes.
- **`allow_host_to_upload_image`**
`boolean` — Whether to allow host to upload an image for each question.
- **`enable`**
`boolean` — Whether the host can add polls before or during a webinar.
- **`manage_saved_polls_and_quizzes`**
`boolean` — Whether to allow users to manage saved polls and quizzes from Meetings
- **`require_answers_to_be_anonymous`**
`boolean` — Whether to require answers to be anonymous.
- **`webinar_question_answer`**
`boolean` — Whether Q\&A is enabled in a webinar.
- **`webinar_reactions`**
`boolean` — Set this field to true to use \[webinar reactions]\(https\://support.zoom.us/hc/en-us/articles/4803536268429).
- **`webinar_survey`**
`boolean` — Whether to allow the host to present surveys to attendees once a webinar has ended.
- **`whiteboard`**
`boolean` — Whether participants can share a whiteboard that includes annotation tools.
- **`who_can_share_screen`**
`string`, possible values: `"host", "all"` — The type of user who can share their screen or content during meetings: \* \`host\` — Only hosts can screen share. \* \`all\` — Both hosts and participants can screen share.
- **`who_can_share_screen_when_someone_is_sharing`**
`string`, possible values: `"host", "all"` — The type of user that can begin sharing their screen when someone else in the meeting is sharing their screen: \* \`host\` — Only hosts can screen share when someone else is sharing. \* \`all\` — Both hosts and participants can screen share when someone else is sharing.
- **`workplace_by_facebook`**
`boolean` — Whether to allow Workplace by Facebook livestreaming.
- **`in_session`**
`object`
- **`custom_data_center_regions`**
`boolean` — Whether to use custom \[data center regions]\(https\://support.zoom.us/hc/en-us/articles/360042411451-Selecting-data-center-regions-for-meetings-webinars): \* \`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. \* \`false\` — Only use the default data center regions.
- **`data_center_regions`**
`array` — 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: \* \`AU\` — Australia. \* \`LA\` — Latin America. \* \`CA\` — Canada. \* \`CN\` — China. \* \`DE\` — Germany. \* \`HK\` — Hong Kong SAR. \* \`IN\` — India. \* \`IE\` — Ireland. \* \`TY\` — Japan. \* \`MX\` — Mexico. \* \`NL\` — Netherlands. \* \`SG\` — Singapore. \* \`US\` — United States.
**Items:**
`string`, possible values: `"AU", "LA", "CA", "CN", "DE", "HK", "IN", "IE", "TY", "MX", "NL", "SG", "US"`
- **`dscp_audio`**
`integer`, default: `56` — The DSCP audio marking value. This value defaults to \`56\`.
- **`dscp_dual`**
`boolean` — Whether to use the differentiated services code point classifiers ('dscp\_video', 'dscp\_audio') in the dual way (incoming and outgoing).
- **`dscp_marking`**
`boolean` — Whether to enable \[differentiated services code point (DSCP)]\(https\://en.wikipedia.org/wiki/Differentiated\_services) marking.
- **`dscp_video`**
`integer`, default: `40` — The DSCP video marking value. This value defaults to \`40\`.
- **`p2p_connetion`**
`boolean` — 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.
- **`p2p_ports`**
`boolean` — Whether to enable the \*\*Listening ports range\*\* setting.
- **`ports_range`**
`string`, default: `""` — 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.
- **`subsession`**
`boolean` — Allow host to split meeting participants into separate, smaller rooms.
- **`integration`**
`object` — Information about integration settings
- **`box`**
`boolean` — Whether users who join a meeting from their mobile device can share content from their Box account.
- **`dropbox`**
`boolean` — Whether users who join a meeting from their mobile device can share content from their Dropbox account.
- **`google_calendar`**
`boolean` — Whether meetings can be scheduled using Google Calendar.
- **`google_drive`**
`boolean` — Whether users who join a meeting from their mobile device can share content from their Google Drive.
- **`kubi`**
`boolean` — Whether users can control a connected Kubi device from within a Zoom meeting.
- **`microsoft_one_drive`**
`boolean` — Whether users who join a meeting from their mobile device can share content from their Microsoft OneDrive account.
- **`mail_calendar`**
`object` — Email and calendar related settings.
- **`email_calendar_management`**
`boolean` — Allow the Zoom client to manage both emails and calendar events for the user.
- **`email_management`**
`boolean` — Allow the Zoom client to manage user emails.
- **`zoom_email_provider`**
`boolean` — Allow users to select Zoom as their email service provider.
- **`meeting_security`**
`object`
- **`auto_security`**
`boolean` — Whether to require that all meetings are secured with at least one security option. This setting can only be disabled by Enterprise, ISV, Business (with more than 100 licenses), and Education accounts.
- **`block_user_domain`**
`boolean` — Whether to block users in specific domains from joining meetings and webinars.
- **`block_user_domain_list`**
`array` — The domain to block, up to 20 domains. For example, the \`\*.example.com\` domain.
**Items:**
`string`
- **`chat_etiquette_tool`**
`object` — Information about the \*\*Chat Etiquette\*\* Tool.
- **`enable`**
`boolean`, default: `false` — Whether to enable the \*\*Chat Etiquette Tool\*\*. This value defaults to \`false\`. The \*\*Chat Etiquette Tool\*\* allows you to define specific keywords and text patterns in chat to prevent users from inadvertently sharing unwanted messages.
- **`policies`**
`array` — Information about the defined \*\*Chat Etiquette Tool\*\* policies.
**Items:**
- **`description`**
`string` — The policy's description.
- **`id`**
`string` — The policy ID.
- **`is_locked`**
`boolean`, default: `false` — Whether to lock the policy. When it is locked, users cannot update the policy. This value defaults to \`false\`.
- **`keywords`**
`array` — A list of defined rule keywords.
**Items:**
`string`
- **`name`**
`string` — The policy name.
- **`regular_expression`**
`string` — The regular expression to match to the content of chat messages.
- **`status`**
`string`, possible values: `"activated", "deactivated"` — The policy's current status: \* \`activated\` — Activated. \* \`deactivated\` — Deactivated.
- **`trigger_action`**
`integer`, possible values: `1, 2` — The policy's trigger action: \* \`1\` — Ask the user to confirm before they send the message. \* \`2\` — Block the user's message.
- **`embed_password_in_join_link`**
`boolean` — Whether the meeting password will be encrypted and included in the invitation link. The provided link will allow participants to join the meeting without having to enter the password.
- **`encryption_type`**
`string`, possible values: `"enhanced_encryption", "e2ee"` — The type of encryption to use when starting a meeting: \* \`enhanced\_encryption\` — Use enhanced encryption. Encryption data is stored in the cloud. \* \`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.
- **`end_to_end_encrypted_meetings`**
`boolean` — Whether to enable end-to-end encryption for meetings. If enabled, you can specify the type of encryption in the \`encryption\_type\` field.
- **`meeting_password`**
`boolean` — Whether all instant and scheduled meetings that users can join via client or Zoom Rooms systems are password-protected. \[Personal Meeting ID (PMI)]\(https\://support.zoom.us/hc/en-us/articles/203276937) meetings are \*\*not\*\* included in this setting.
- **`meeting_password_requirement`**
`object` — Information about the meeting and webinar \[password requirements]\(https\://support.zoom.us/hc/en-us/articles/360033559832-Meeting-and-webinar-passwords#h\_a427384b-e383-4f80-864d-794bf0a37604).
- **`consecutive_characters_length`**
`integer`, possible values: `0, 4, 5, 6, 7, 8` — The maximum length of consecutive characters (for example, \`abcdef\`) allowed in a password: \* \`4\` through \`8\` — The maximum consecutive characters length. The length is \`n\` minus \`1\`, where \`n\` is the provided value. For example, if you provide the \`4\` value, there can only be a maximum of \`3\` consecutive characters in a password (for example, \`abc1x\@8fdh\`). \* \`0\` — Do not apply a consecutive character restriction.
- **`have_letter`**
`boolean` — Whether the password must contain at least one letter character.
- **`have_number`**
`boolean` — Whether the password must contain at least one numeric character.
- **`have_special_character`**
`boolean` — Whether the password must contain at least one special character. For example, \`!\`, \`@\`, and/or \`#\` characters.
- **`have_upper_and_lower_characters`**
`boolean` — Whether the password must include uppercase and lowercase characters.
- **`length`**
`integer` — The password's minimum length.
- **`only_allow_numeric`**
`boolean` — Whether the password must contain \*\*only\*\* numeric characters.
- **`weak_enhance_detection`**
`boolean` — Whether users will be informed when the provided password is weak.
- **`only_authenticated_can_join_from_webclient`**
`boolean` — Whether to specify that only authenticated users can join the meeting from the web client.
- **`phone_password`**
`boolean` — Whether to require a password for participants joining by phone. If enabled and the meeting is password-protected, a numeric password is required for participants to join by phone. For meetings with alphanumeric passwords, a numeric password will be generated.
- **`pmi_password`**
`boolean` — Whether all Personal Meeting ID (PMI) meetings that users can join via client or Zoom Rooms systems are password-protected.
- **`require_password_for_scheduled_meeting`**
`boolean` — Whether to require a password for meetings that have already been scheduled.
- **`require_password_for_scheduled_webinar`**
`boolean` — Whether to require a password for webinars that have already been scheduled.
- **`waiting_room`**
`boolean` — Whether participants are placed in the \[\*\*Waiting Room\*\*]\(https\://support.zoom.us/hc/en-us/articles/115000332726-Waiting-Room) when they join a meeting. 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.
- **`waiting_room_settings`**
`object` — Information about the waiting room settings.
- **`participants_to_place_in_waiting_room`**
`integer`, possible values: `0, 1, 2` — The type of participants to be admitted to the Waiting Room: \* \`0\` — All attendees. \* \`1\` — Users who are not in your account. \* \`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).
- **`users_who_can_admit_participants_from_waiting_room`**
`integer`, possible values: `0, 1` — The users who can admit participants from the Waiting Room: \* \`0\` — Host and co-hosts only. \* \`1\` — Host, co-hosts, and anyone who bypassed the Waiting Room if the host and co-hosts are not present.
- **`whitelisted_domains_for_waiting_room`**
`string` — 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").
- **`webinar_password`**
`boolean` — Whether to generate a password when scheduling webinars. Participants must use the generated password to join the scheduled webinar.
- **`other_options`**
`object`
- **`allow_auto_active_users`**
`boolean` — Whether administrators can activate users with a single default password when they add users. This immediately activates the users without waiting for them to set their own password.
- **`allow_users_contact_support_via_chat`**
`boolean` — Whether to display the Zoom Help badge on the bottom-right of the page.
- **`allow_users_enter_and_share_pronouns`**
`boolean` — Whether users can add pronouns to their profile cards and share them during meetings and webinars.
- **`blur_snapshot`**
`boolean` — Whether iOS blurs the screenshot in the task switcher when multiple apps are open. Android hides the screenshot in the system-level list of recent apps.
- **`display_meetings_scheduled_for_others`**
`boolean` — Whether a user with the \[scheduling privilege]\(https\://support.zoom.us/hc/en-us/articles/201362803-Scheduling-privilege) can view other users' meetings.
- **`meeting_qos_and_mos`**
`integer`, possible values: `0, 1, 2, 3` — The Dashboard meeting \[quality scores and network alerts]\(https\://support.zoom.us/hc/en-us/articles/360061244651) setting: \* \`0\` — Do not enable meeting quality scores and network alerts on the Dashboard. \* \`1\` — Display the meeting quality score and network alerts on the Dashboard. \* \`2\` — Use custom thresholds for quality scores and network alerts. \* \`3\` —Both Use custom thresholds for quality scores and network alerts and Display the meeting quality score and network alerts on the Dashboard.
- **`show_one_user_meeting_on_dashboard`**
`boolean` — Whether meetings with only one person will display on the Dashboard and in reports.
- **`use_cdn`**
`string`, possible values: `"none", "default", "wangsu"` — 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: \* \`none\` — Do not use a CDN. \* \`default\` — Use the Amazon CloudFront CDN for users \*\*except\*\* Chinese Mainland users. Chinese Mainland users will use the Wangsu CDN (China). \* \`wangsu\` — Use the Wangsu CDN for all users.
- **`webinar_registration_options`**
`object` — Webinar registration options.
- **`allow_host_to_enable_social_share_buttons`**
`boolean` — Allow host to enable "Show social share buttons on registration page"
- **`recording`**
`object` — Information about recording settings.
- **`account_user_access_recording`**
`boolean` — Whether cloud recordings are only accessible to account members. People outside of your organization \*\*cannot\*\* open links that provide access to cloud recordings.
- **`allow_recovery_deleted_cloud_recordings`**
`boolean` — Whether the recovery of deleted cloud recordings from the trash is enabled. If enabled, then deleted cloud recordings are kept in the trash for 30 days after deletion. The recordings can be recovered within that period.
- **`archive`**
`object` — Information about the \[archiving solution]\(https\://support.zoom.us/hc/en-us/articles/360050431572-Archiving-Meeting-and-Webinar-data) settings. This is only available if granted archiving solution access by the Zoom support team.
- **`enable`**
`boolean` — Whether the archiving feature is enabled.
- **`settings`**
`object`
- **`action_when_archive_failed`**
`integer`, possible values: `1, 2` — Perform the action when meetings or webinars cannot be archived.\
\`1\` - Participants can stay in the meeting and will receive a notification.\
\`2\` - Nobody can join or stay in the meeting.
- **`archive_retention`**
`integer`, possible values: `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` — The retention period for archiving content, in days.
- **`audio_file`**
`boolean` — Whether to include in-meeting and/or in-webinar audio in the archive.
- **`cc_transcript_file`**
`boolean` — Whether to include closed captions or transcripts in the archive.
- **`chat_file`**
`boolean` — Whether to include in-meeting chat in the archive.
- **`chat_with_direct_message`**
`object` — Include direct message in in-meeting chat file.
- **`chat_with_sender_email`**
`boolean` — Whether to include user emails in the in-meeting chat file.
- **`notification_when_archiving_starts`**
`string`, possible values: `"participants", "guest"` — Show notification when video or audio archiving starts.\
\`1\` - Participants can stay in the meeting and will receive a notification.\
\`2\` - Nobody can join or stay in the meeting.
- **`play_voice_prompt_when_archiving_starts`**
`string`, possible values: `"participants", "guest", "none"` — Play voice prompt when video or audio archiving starts.\
\`1\` - Participants can stay in the meeting and will receive a notification.\
\`2\` - Nobody can join or stay in the meeting.
- **`video_file`**
`boolean` — Whether to include in-meeting and/or in-webinar video in the archive.
- **`type`**
`integer`, possible values: `1, 2, 3` — The archive solution type: \* \`1\` — Only meetings are archived. \* \`2\` — Only webinars are archived. \* \`3\` — Both meetings and webinars are archived.
- **`ask_host_to_confirm_disclaimer`**
`boolean` — Whether to ask the host to confirm the recording disclaimer is enabled.
- **`ask_participants_to_consent_disclaimer`**
`boolean` — Whether to ask participants for consent when a recording begins is enabled. This is only available when the value of the \`recording\_disclaimer\` field is set to \`true\`.
- **`auto_delete_cmr`**
`boolean` — Whether Zoom will permanently delete recordings automatically after a specified number of days is enabled. The number of days is displayed in the \`auto\_delete\_cmr\_days\` field.
- **`auto_delete_cmr_days`**
`integer`, possible values: `30, 60, 90, 120` — When the \`auto\_delete\_cmr\` value is \`true\`, this value is the number of days before the auto-deletion of cloud recordings: \* \`30\` — 30 days. \* \`60\` — 60 days. \* \`90\` — 90 days. \* \`120\` — 120 days.
- **`auto_recording`**
`string` — The automatic recording setting: \* \`local\` — Record locally \* \`cloud\` — Record on the cloud. \* \`none\` — Disabled.
- **`cloud_recording`**
`boolean` — Whether hosts can record and save the meeting in the cloud.
- **`cloud_recording_download`**
`boolean` — Whether cloud recording downloads are enabled.
- **`cloud_recording_download_host`**
`boolean` — Whether only the host can download cloud recordings.
- **`display_participant_name`**
`boolean` — Whether participants' names display in the recording.
- **`host_delete_cloud_recording`**
`boolean` — Whether the host can delete recordings. If this is disabled, the recordings cannot be deleted by the host. Only an administrator can delete the recordings.
- **`host_pause_stop_recording`**
`boolean` — Whether the meeting's host can pause or stop the cloud's auto recording is enabled.
- **`ip_address_access_control`**
`object` — Information about the settings to allow cloud recording access only from specific IP address ranges.
- **`enable`**
`boolean` — Whether the cloud recordings of the account can only be accessed by the IP addresses defined in the \`ip\_addresses\_or\_ranges\` property.
- **`ip_addresses_or_ranges`**
`string` — The IP addresses or ranges that have access to the cloud recordings.
- **`local_recording`**
`boolean` — Whether hosts and participants can record the meeting using a local file.
- **`optimize_recording_for_3rd_party_video_editor`**
`boolean` — Whether recordings will be optimized for a 3rd party video editor. This can increase the file size and the time it takes to generate recording files.
- **`prevent_host_access_recording`**
`boolean` — Whether meeting hosts are prevented from accessing their meeting cloud recordings. Only the administrators with recording management privileges can access them.
- **`record_audio_file`**
`boolean` — Whether recording an audio-only file is enabled.
- **`record_audio_file_each_participant`**
`boolean` — Whether to record separate audio files for each participant is enabled.
- **`record_files_separately`**
`object` — 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.
- **`active_speaker`**
`boolean` — Whether recording only the active speaker is enabled.
- **`gallery_view`**
`boolean` — Whether recording only the gallery view is enabled.
- **`shared_screen`**
`boolean` — Whether recording only the gallery view is enabled.
- **`record_gallery_view`**
`boolean` — Whether recording the \[gallery view]\(https\://support.zoom.us/hc/en-us/articles/360000005883-Displaying-Participants-in-Gallery-View) with a shared screen is enabled.
- **`record_speaker_view`**
`boolean` — Whether recording the active speaker with a shared screen is enabled.
- **`recording_audio_transcript`**
`boolean` — Whether automatically transcribing the audio of the meeting or webinar to the cloud is enabled.
- **`recording_disclaimer`**
`boolean` — Whether to display a disclaimer to participants before a recording begins is enabled.
- **`recording_highlight`**
`boolean` — Whether the \[recording highlights]\(https\://support.zoom.us/hc/en-us/articles/360060802432) feature is enabled.
- **`recording_password_requirement`**
`object` — Information about the minimum password requirements for recordings via the Account Recording settings.
- **`have_letter`**
`boolean` — Whether the password must contain at least one alphabetical letter.
- **`have_number`**
`boolean` — Whether the password must contain at least one numeric character.
- **`have_special_character`**
`boolean` — Whether the password must contain at least one special character (for example, \`!\`, \`@\`, or \`#\`).
- **`length`**
`integer` — The password's minimum required length.
- **`only_allow_numeric`**
`boolean` — Whether the password must contain \*\*only\*\* numeric characters.
- **`recording_thumbnails`**
`boolean` — Whether thumbnails of the presenter are recorded when they are sharing their screen.
- **`save_chat_text`**
`boolean` — Whether saving the chat text from the meeting is enabled.
- **`save_close_caption`**
`boolean` — Whether \[closed captions]\(https\://support.zoom.us/hc/en-us/articles/207279736) are saved as a VTT (Video Track Text) file.
- **`save_panelist_chat`**
`boolean` — Whether panelist chats are saved to the recording.
- **`save_poll_results`**
`boolean` — Whether poll results shared during the meeting or webinar are saved. This also includes poll results shared during the meeting or webinar.
- **`show_timestamp`**
`boolean` — Whether adding a timestamp to the recording is enabled.
- **`smart_recording`**
`object` — 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.
- **`create_next_steps`**
`boolean` — By selecting this option, there will be a summary of actions to take after the recorded meeting.
- **`create_recording_highlights`**
`boolean` — 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.
- **`create_smart_chapters`**
`boolean` — By selecting this option, your recording will have chapters with overview. Hosts can edit the chapters.
- **`schedule_meeting`**
`object` — Information about the schedule meeting settings.
- **`always_display_zoom_meeting_as_topic`**
`object` — 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.
- **`display_topic_for_scheduled_meetings`**
`boolean` — Whether to display "Zoom Meeting" as the topic for already-scheduled meetings.
- **`enable`**
`boolean` — Whether the \*\*Always display "Zoom Meeting" as the meeting topic\*\* setting is enabled.
- **`always_display_zoom_webinar_as_topic`**
`object` — 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.
- **`display_topic_for_scheduled_webinars`**
`boolean` — Whether to display "Zoom Webinar" as the topic for already-scheduled meetings.
- **`enable`**
`boolean` — Whether the \*\*Always show "Zoom Webinar" as the webinar topic\*\* setting is enabled.
- **`audio_type`**
`string` — The type of audio used to join the meeting.
- **`enforce_login`**
`boolean` — Whether only users who are signed in to Zoom can join meetings.
- **`enforce_login_domains`**
`string` — The specified domains for users to sign in to in order to join meetings.
- **`enforce_login_with_domains`**
`boolean` — Whether only users with a specific domain can join meetings.
- **`force_pmi_jbh_password`**
`boolean` — Whether to require a password for personal meetings if attendees can join before host.
- **`hide_meeting_description`**
`object` — Information about the \*\*Hide meeting description\*\* feature.
- **`enable`**
`boolean` — Whether the \*\*Hide meeting description\*\* setting is enabled.
- **`hide_description_for_scheduled_meetings`**
`boolean` — Whether to hide the description for already-scheduled meetings.
- **`hide_webinar_description`**
`object` — Information about the \*\*Hide webinar description\*\* feature.
- **`enable`**
`boolean` — Whether the \*\*Hide webinar description\*\* setting is enabled.
- **`hide_description_for_scheduled_webinars`**
`boolean` — Whether to hide webinar description for the webinars which have already been scheduled.
- **`host_video`**
`boolean` — Whether to start meetings with the host video on.
- **`jbh_time`**
`integer`, possible values: `0, 5, 10, 15` — If the value of the \`join\_before\_host\` field is \`true\`, this field indicates the time limits within which a participant can join a meeting before the meeting's host: \* \`0\` — Allow the participant to join the meeting at anytime. \* \`5\` — Allow the participant to join 5 minutes before the meeting's start time. \* \`10\` — Allow the participant to join 10 minutes before the meeting's start time.
- **`join_before_host`**
`boolean` — Whether participants can join the meeting before its host.
- **`mute_upon_entry`**
`boolean` — Whether to automatically mute all participants when they join the meeting.
- **`not_store_meeting_topic`**
`boolean` — Whether to display the "Zoom Meeting" message as the meeting's topic.
- **`participant_video`**
`boolean` — Whether to start meetings with the participant video on.
- **`personal_meeting`**
`boolean` — The personal meeting settings: \* \`true\` — Indicates that the \*\*Enable Personal Meeting ID\*\* setting is enabled. Users can use a personal meeting ID for their meetings. \* \`false\` — Indicates that the \*\*Enable Personal Meeting ID\*\* setting is \[disabled]\(https\://support.zoom.us/hc/en-us/articles/201362843-Personal-meeting-ID-PMI-and-personal-link#h\_aa0335c8-3b06-41bc-bc1f-a8b84ef17f2a). When this setting is \*\*disabled\*\*, meetings that were scheduled with a PMI will be invalid. You must manually update any scheduled meetings. \*\*For Zoom Phone only:\*\* If a user has been assigned a desk phone, the desk phone's \*\*Elevate to Zoom Meeting\*\* setting will be disabled.
- **`pmi_password`**
`string` — The PMI's password.
- **`pstn_password_protected`**
`string` — Require a password from participants before joining a meeting via \[PSTN]\(https\://support.zoom.us/hc/en-us/articles/204517069-Getting-Started-with-Personal-Audio-Conference).
- **`require_password_for_instant_meetings`**
`boolean` — Whether a random password will be generated on the end of user who starts the instant meeting. Other meeting participants \*\*must\*\* enter the generated password to join the meeting. If instant meetings use a PMI, this option is \*\*disabled\*\*.
- **`require_password_for_pmi_meetings`**
`string`, possible values: `"jbh_only", "all", "none"` — Require participants to enter password for PMI meetings: \* \`jbh\_only\` — Only when a participant joins before the host. \* \`all\` — All participants must enter a password to join the meeting. \* \`none\` — No password required.
- **`require_password_for_scheduling_new_meetings`**
`boolean` — Whether a password is generated when a meeting host schedules a new meeting. Meeting participants will be required to enter the password before they can join the meeting. This setting only applies to regular meetings that do \*\*not\*\* use a PMI.
- **`upcoming_meeting_reminder`**
`boolean` — Whether to receive a desktop notification for upcoming meetings.
- **`use_pmi_for_instant_meetings`**
`boolean` — Whether PMI is enabled for all instant meetings.
- **`use_pmi_for_scheduled_meetings`**
`boolean` — Use a \[PMI (Personal Meeting ID)]\(https\://support.zoom.us/hc/en-us/articles/203276937-Using-Personal-Meeting-ID-PMI-) to schedule meeting.
- **`security`**
`object` — Information about the security settings.
- **`admin_change_name_pic`**
`boolean` — Whether only account administrators can change a user's username and picture.
- **`hide_billing_info`**
`boolean` — Whether hiding of billing information is enabled.
- **`import_photos_from_devices`**
`boolean` — Whether users can import photos from a photo library on a device.
- **`password_requirement`**
`object` — Information about the \[enhanced password rules]\(https\://support.zoom.us/hc/en-us/articles/360034675592-Advanced-security-settings#h\_bf8a25f6-9a66-447a-befd-f02ed3404f89) that allows Zoom account administrators and owners to apply additinal requirements to the users' Zoom login password.
- **`consecutive_characters_length`**
`integer` — The password's maximum length of consecutive characters (for example, \`abcde\`). If this is a \`0\` value, there is no consecutive character restriction.
- **`have_special_character`**
`boolean` — Whether a password requires at least one special character (for example, \`!\`, \`@\`, and \`#\`).
- **`minimum_password_length`**
`integer` — A password's required minimum length value. The password length can be between a minimum of 8 characters, up to 14 characters. If this is a \`0\` value, this setting is \*\*disabled\*\* and is not used. The default password length requirement will be a minimum of 8 characters.
- **`weak_enhance_detection`**
`boolean` — Whether passwords must pass detection through a weak password dictionary.
- **`signin_with_sso`**
`object` — Allow users to sign in with single sign-on (SSO).
- **`domains`**
`array` — Users using these domains are required to sign in with single sign-on (SSO).
**Items:**
`string`
- **`enable`**
`boolean` — Whether to allow users to sign in with single sign-on (SSO). Enabling this requires you to configure your account's SSO settings. This lets users sign in with SSO through your company's vanity URL.
- **`require_sso_for_domains`**
`boolean` — Whether to require users to sign in with single sign-on (SSO) if their e-mail address belongs to one of the \`domains\`.
- **`sso_bypass_users`**
`array` — The users can bypass SSO sign-in.
**Items:**
- **`email`**
`string` — The user's email.
- **`id`**
`string` — The user's ID.
- **`session_security`**
`object`
- **`approved_or_denied_countries_or_regions`**
`object` — Approve or block users from specific regions or countries from joining this meeting.
- **`approved_list`**
`array` — List of countries/regions from where participants can join this meeting.
**Items:**
`string`
- **`denied_list`**
`array` — List of countries/regions from where participants can not join this meeting.
**Items:**
`string`
- **`enable`**
`boolean` — \`true\`: Setting enabled to either allow or block users from specific regions from joining your meetings. \
\`false\`: Setting disabled.
- **`method`**
`string`, possible values: `"approve", "deny"` — Specify whether to allow users from specific regions to join this meeting; or block users from specific regions from joining this meeting. \
\
\`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\`.\
\
\`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\`
- **`telephony`**
`object` — Information about telephony settings.
- **`audio_conference_info`**
`string` — Information about the third-party audio configuration.
- **`telephony_regions`**
`object` — Information about where most of the participants call into or call from during a meeting.
- **`allowed_values`**
`array` — The telephony region options provided by Zoom.
**Items:**
`string`
- **`selection_values`**
`string` — The account's selected telephony regions that indicates where most of the participants call into or call from during a meeting.
- **`third_party_audio`**
`boolean` — Whether users can join the meeting using an existing third-party audio configuration.
- **`tsp`**
`object` — Information about TSP settings.
- **`allow_webinar_attendees_call_me`**
`boolean` — Whether webinar attendees can use Call Me to connect audio. This feature is only available in version 5.2.2 and higher.
- **`allow_webinar_attendees_toll_free_dial`**
`boolean` — 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.
- **`call_out`**
`boolean` — Call Out
- **`call_out_countries`**
`array` — Call Out Countries/Regions
**Items:**
`string`
- **`display_toll_free_numbers`**
`boolean` — Display toll-free numbers
- **`global_dial_in_countries`**
`object` — The account's \*\*Global Dial-in Countries/Regions\*\* settings.
- **`selected_countries`**
`array` — 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:**
- **`code`**
`string` — The code of the country or region.
- **`name`**
`string` — The name of the country or region.
- **`show_international_numbers_link`**
`boolean` — Show international numbers link on the invitation email
- **`zoom_rooms`**
`object` — Information about the Zoom Rooms settings.
- **`auto_start_stop_scheduled_meetings`**
`boolean` — Whether an automatic start time and stop time for scheduled meetings is enabled.
- **`cmr_for_instant_meeting`**
`boolean` — Whether cloud recording for instant meetings is enabled.
- **`force_private_meeting`**
`boolean` — Whether to force all meetings to be \[private meetings]\(https\://support.zoom.us/hc/en-us/articles/115001051063-Zoom-Rooms-Private-Meetings).
- **`hide_host_information`**
`boolean` — Whether hiding of the host and meeting ID in private meetings is enabled.
- **`list_meetings_with_calendar`**
`boolean` — Whether to display meeting lists with calendar integration.
- **`start_airplay_manually`**
`boolean` — Whether to start the AirPlay service manually.
- **`ultrasonic`**
`boolean` — Whether the automatic direct sharing using an ultrasonic proximity signal is enabled.
- **`upcoming_meeting_alert`**
`boolean` — Whether upcoming meeting alerts are enabled.
- **`weekly_system_restart`**
`boolean` — Whether weekly system restarts are enabled.
- **`zr_post_meeting_feedback`**
`boolean` — Whether Zoom Room post-meeting feedback is enabled.
- **`old_object`**
`object` — Information about the account's previous settings.
- **`id`**
`string` — The updated account's ID.
- **`settings`**
`object` — Information about the updated account or sub account settings. This only returns modified settings.
- **`ai`**
`object` — Workspace Reservation recommendations with AI.
- **`ai_generated_virtual_backgrounds`**
`boolean` — Whether AI-generated virtual backgrounds are enabled.
- **`ai_panel_in_workplace`**
`object` — AI panel in Zoom Workplace settings.
- **`delete_ai_conversation`**
`boolean` — Whether to automatically delete AI conversation history in the AI panel.
- **`delete_ai_conversation_time`**
`integer | null`, possible values: `30, 60, 90, 120` — The number of days after which AI conversation history in the AI panel is automatically deleted. Supported values are 30, 60, 90, and 120.
- **`enabled`**
`boolean` — Whether the AI panel in Zoom Workplace is enabled.
- **`chat_compose`**
`object` — Allow users to use AI to help them compose a response from scratch or wordsmith their chat messages.
- **`enable`**
`boolean` — Compose with AI Companion
- **`shown_in_team_chat`**
`boolean` — Show in Team Chat
- **`chat_summary`**
`object` — Allow users to summarize chats, channels, and shared documents.
- **`enable`**
`boolean` — Summarize with AI Companion
- **`shown_in_team_chat`**
`boolean` — Show in Team Chat
- **`enable_ai_on_web`**
`boolean` — Whether Zoom AI on the web is enabled.
- **`enable_email_compose_with_ai`**
`boolean` — Whether users can use AI to compose or wordsmith email responses in Zoom Mail.
- **`full_display_names_in_ai_assets`**
`boolean` — Whether AI-generated meeting assets use full display names.
- **`google`**
`object` — Settings for Google data sources.
- **`calendar_events`**
`boolean` — Whether Google Calendar events accessible to the user can be used as a data source for AI.
- **`documents`**
`boolean` — Whether Google Drive documents accessible to the user can be used as a data source for AI.
- **`emails`**
`boolean` — Whether Gmail emails accessible to the user can be used as a data source for AI.
- **`enable`**
`boolean` — Whether Google data sources can be used as data sources for AI.
- **`include_webinar_summary_follow_up_email`**
`object` — Webinar follow-up email. When enabled, the host can include the webinar summary in follow-up emails.
- **`absentee_follow_up_email`**
`boolean` — Whether the webinar summary is included in the absentee follow-up email.
- **`attendee_follow_up_email`**
`boolean` — Whether the webinar summary is included in the attendee follow-up email.
- **`enable`**
`boolean` — Whether the host can include the webinar summary in follow-up email.
- **`local_file_uploads`**
`boolean` — Whether files uploaded by users can be used as a data source for AI by the users who uploaded them.
- **`meeting_agenda`**
`boolean` — Whether Meeting Agenda with AI is enabled.
- **`meeting_chat_messages`**
`boolean` — Whether meeting chat messages are used to enhance transcripts.
- **`meeting_coach`**
`object` — Meeting Coach with AI.
- **`enable`**
`boolean` — Whether Meeting Coach with AI is enabled.
- **`participant_scope`**
`string`, possible values: `"all_participants_and_invitees", "participants_and_invitees_in_our_organization"` — Which participants Meeting Coach applies to.
- **`meeting_questions`**
`object` — Allow users to ask questions in a meeting with AI. Answers are based on what is said in the meeting.
- **`auto_enable`**
`boolean` — Automatically start meeting questions when the meeting starts.
- **`enable`**
`boolean` — Whether users can ask questions in a meeting with AI.
- **`who_can_ask_questions`**
`string`, possible values: `"from_entire_meeting", "from_join_meeting", "host", "org", "org_from_join_meeting"` — Participants allowed to ask meeting questions. Valid values: \`from\_entire\_meeting\` (all participants and invitees), \`from\_join\_meeting\` (all participants from when they join), \`host\` (only the meeting host), \`org\` (participants and invitees in the organization), \`org\_from\_join\_meeting\` (organization participants from when they join).
- **`meeting_summary`**
`object` — Allow hosts to generate a summary. Summaries are sent based on sharing permissions after the meeting ends.
- **`auto_enable`**
`boolean` — Auto-start the meeting summary when the meeting starts.
- **`email_notification`**
`boolean` — Send an email notification when sharing a meeting summary with participants.
- **`enable`**
`boolean` — Whether hosts can generate a meeting summary.
- **`restrict_share_to_outside_of_organization`**
`boolean` — Restrict users from sharing meeting summaries with people outside the organization.
- **`restrict_summary_share`**
`string`, possible values: `"external_users", "all_users", "all_users_except_delegate"` — Audience restricted from sharing meeting summaries. Valid values: \`external\_users\` (users outside the organization), \`all\_users\` (all users), \`all\_users\_except\_delegate\` (all users except delegates).
- **`whether_include_full_text_in_email`**
`string`, possible values: `"include_full_text_in_email", "not_include_full_text_in_email"` — Whether the meeting summary email includes summary text. Valid values: \`include\_full\_text\_in\_email\` (include the summary text), \`not\_include\_full\_text\_in\_email\` (do not include the summary text).
- **`who_will_receive_summary`**
`string`, possible values: `"host", "alt_host", "organization", "all", "host_and_panelist_in_organization", "host_and_panelist_not_in_organization", "host_and_speakers", "do_not_share"` — Recipients for automatically shared meeting summaries. Valid values: \`host\` (only the meeting host), \`alt\_host\` (meeting host, co-hosts, and alternative hosts), \`organization\` (meeting host and invitees in the organization), \`all\` (all meeting invitees, including external invitees), \`host\_and\_panelist\_in\_organization\` (meeting host and participants in the organization), \`host\_and\_panelist\_not\_in\_organization\` (meeting host and all participants, including external participants), \`host\_and\_speakers\` (meeting host and speakers), \`do\_not\_share\` (do not share a summary).
- **`meeting_summary_default_language`**
`object` — Set the default language for meeting summaries.
- **`enable`**
`boolean` — Whether meeting summaries automatically use the selected default language.
- **`language`**
`string` — Language that meeting summaries automatically use when the default-language setting is enabled. 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).
- **`meeting_summary_docs`**
`object` — Automatic Zoom Doc creation from meeting summary.
- **`enable`**
`boolean` — Whether automatic Zoom Doc creation is enabled.
- **`share_with_summary_recipients`**
`boolean` — Whether generated Zoom Docs are shared with meeting summary recipients.
- **`meeting_summary_email_only_mode`**
`boolean` — Only share meeting summaries by email. Users cannot view or edit summaries in the Zoom client or web portal because the meeting summary is not retained.
- **`meeting_summary_ip_access`**
`object` — Allow meeting summary access only from specific IP address ranges.
- **`enable`**
`boolean` — Whether access to meeting summaries is restricted to specified IP address ranges.
- **`ip_addresses_or_ranges`**
`string` — IP addresses or ranges from which meeting summaries can be accessed.
- **`meeting_summary_personal_data_redaction`**
`object` — Personal data redaction for meeting summaries.
- **`enable`**
`boolean` — Whether personal data redaction is enabled.
- **`personal_data_types`**
`array` — Personal data types to redact.
**Items:**
`string`, possible values: `"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"`
- **`meeting_summary_retention`**
`object` — Automatic meeting summary deletion.
- **`enable`**
`boolean` — Whether automatic meeting summary deletion is enabled.
- **`retention_days`**
`integer` — Number of days to retain meeting summaries before deletion.
- **`meeting_summary_sensitive_data_filter`**
`object` — Sensitive data filter for meeting summaries.
- **`enable`**
`boolean` — Whether the sensitive data filter is enabled.
- **`rules`**
`array` — Sensitive data filter rules.
**Items:**
- **`name`**
`string` — Rule display name.
- **`regular_expression`**
`string` — RE2J regular expression.
- **`meeting_summary_template`**
`object` — Allow users to select a meeting summary template for their meetings. The summary is generated using the selected template.
- **`enable`**
`boolean` — Whether users can select a meeting summary template for their meetings.
- **`summary_template_id`**
`string` — ID of the default meeting summary template used to generate meeting summaries.
- **`microsoft_365`**
`object` — Settings for Microsoft 365 data sources.
- **`calendar_events`**
`boolean` — Whether Microsoft Outlook calendar events accessible to the user can be used as a data source for AI.
- **`documents`**
`boolean` — Whether Office 365 documents accessible to the user can be used as a data source for AI.
- **`emails`**
`boolean` — Whether Microsoft Outlook emails accessible to the user can be used as a data source for AI.
- **`enable`**
`boolean` — Whether Microsoft 365 data sources can be used as data sources for AI.
- **`organization_custom_dictionaries`**
`boolean` — Whether AI can consume the organization's custom dictionaries.
- **`participant_can_request_aic_in_meeting`**
`boolean` — Allow participants to request AI Companion in a meeting.
- **`phone_user_ai_notices`**
`object` — Phone user AI notices.
- **`enable`**
`boolean` — Whether phone user AI notices are enabled.
- **`multiple_notifications`**
`boolean` — Whether multiple notifications are allowed.
- **`require_press_1_consent`**
`boolean` — Whether callers must press 1 to consent.
- **`remind_me_turn_on_aic`**
`boolean` — Remind hosts to turn on Zoom AI at the beginning of a meeting when AI features are not configured to auto-start.
- **`remind_me_turn_on_catch_me_up`**
`boolean` — When joining a meeting late, prompt the user to use Zoom AI to summarize what has been discussed so far.
- **`restrict_aic_when_external_user_join_meeting`**
`boolean` — Restrict AI Companion when an external user joins a meeting.
- **`restrict_users_from_deleting_ai_companion_assets`**
`boolean` — Restrict users from deleting meeting assets generated by AI. When enabled, only admins can delete those assets.
- **`restrict_users_from_editing_ai_companion_assets`**
`boolean` — Restrict users from editing meeting assets generated by AI. When enabled, only admins can edit those assets.
- **`restrict_users_from_joining_ai_enabled_meetings`**
`object` — Restrict users from joining meetings where AI meeting processing, including meeting questions and meeting summary, is allowed.
- **`apply_scope`**
`string`, possible values: `"internal_only", "external_only", "internal_and_external"` — Meeting scope to which the restriction applies. Valid values: \`internal\_only\` (internal meetings only), \`external\_only\` (external meetings only), \`internal\_and\_external\` (internal and external meetings).
- **`enable`**
`boolean` — Whether restrictions on joining AI-enabled meetings are enabled.
- **`join_notify`**
`string`, possible values: `"out_of_compliance", "notify_and_remove"` — Action to take when a restricted user tries to join an AI-enabled meeting. Valid values: \`out\_of\_compliance\` (notify the user and allow them to remain), \`notify\_and\_remove\` (notify the user and remove them from the meeting).
- **`screen_share_ocr`**
`boolean` — Whether screen share content is used with OCR.
- **`show_conversational_ai_companion`**
`object` — Show conversational AI companion settings.
- **`delete_ai_conversation`**
`boolean` — Whether to automatically delete AI conversation history.
- **`delete_ai_conversation_time`**
`integer | null`, possible values: `30, 60, 90, 120` — The number of days after which AI conversation history is automatically deleted. Supported values are 30, 60, 90, and 120.
- **`enable_zoom_mate`**
`boolean` — Whether ZoomMate is available in the web navigation and Zoom Workplace app navigation bar.
- **`enabled`**
`boolean` — Whether conversational AI is enabled.
- **`smart_recording`**
`object` — Smart Recording
- **`create_next_steps`**
`boolean` — Next steps
- **`create_recording_highlights`**
`boolean` — Recording highlights
- **`create_smart_chapters`**
`boolean` — Summary and smart chapters
- **`task_creation_and_management`**
`object` — AI-powered task creation and management with AI Companion.
- **`auto_generate_action`**
`boolean` — Whether to automatically generate action items from tasks.
- **`auto_generate_details`**
`boolean` — Whether to automatically generate task details.
- **`enable`**
`boolean` — Whether AI-powered task creation and management is enabled.
- **`generate_from_phone_call`**
`object` — Settings for generating tasks from phone calls.
- **`auto_add_participant_as_collaborator`**
`boolean` — Whether to automatically add phone call participants as task collaborators.
- **`auto_assign_to_collaborator`**
`boolean` — Whether to automatically assign phone call tasks to collaborators.
- **`enable`**
`boolean` — Whether to allow generating tasks from phone calls.
- **`generate_from_transcripts`**
`object` — Settings for generating tasks from meeting transcripts.
- **`auto_assign_to_collaborator`**
`boolean` — Whether to automatically assign tasks to collaborators.
- **`auto_share_with`**
`string`, possible values: `"host_only", "internal_participants", "internal_assigned_participants"` — Defines who tasks are automatically shared with when generated from transcripts.
- **`enable`**
`boolean` — Whether to allow generating tasks from meeting transcripts.
- **`generate_from_voicemail`**
`boolean` — Whether to allow generating tasks from voicemail.
- **`third_party_app_tasks`**
`boolean` — Whether AI can perform tasks on the user's behalf in third-party apps configured within AI Studio.
- **`third_party_meeting_join`**
`object` — Third-party meeting join with AI.
- **`allow_recording`**
`boolean` — Whether recording is enabled for joined third-party meetings.
- **`calendar`**
`object` — Calendar-based third-party meeting join.
- **`enable`**
`boolean` — Whether calendar-based third-party meeting join is enabled.
- **`join_scope`**
`string`, possible values: `"all_events_with_video_conference_links", "meetings_where_i_am_the_host", "meetings_where_i_am_a_participant"` — Which calendar events third-party meeting join applies to.
- **`enable`**
`boolean` — Whether third-party meeting join with AI is enabled.
- **`pre_meeting_email_notification`**
`object` — Pre-meeting email notification.
- **`enable`**
`boolean` — Whether pre-meeting email notification is enabled.
- **`recipients`**
`string`, possible values: `"all_invitees", "only_meeting_host"` — Who receives the pre-meeting email notification.
- **`web_content`**
`boolean` — Whether public web content can be used as a data source for AI.
- **`webinar_questions`**
`object` — During the webinar, answers are based on speech-to-text data. If a transcript is retained, participants with access will be able to ask questions after the webinar based on that transcript.
- **`auto_enable`**
`boolean` — Whether to automatically allow access when the webinar starts.
- **`enable`**
`boolean` — Whether to allow users to ask webinar questions with AI.
- **`who_can_ask_questions`**
`string`, possible values: `"panelist_all", "panelist_org", "host", "all_participants"` — Who can ask questions about the webinar. Valid values: \`panelist\_all\` (Hosts and all panelists), \`panelist\_org\` (Hosts and all panelists in our organization), \`host\` (Only webinar host, co-hosts, and alternative hosts), \`all\_participants\` (All participants).
- **`webinar_summary`**
`object` — Allow hosts to generate a summary. Summaries are sent after the webinar has ended based on sharing permissions.
- **`auto_enable`**
`boolean` — Whether to turn on webinar summary automatically when the webinar starts.
- **`email_notification`**
`boolean` — Whether to send an email notification when sharing to participants.
- **`enable`**
`boolean` — Whether to allow hosts to generate a summary.
- **`restrict_share_to_outside_of_organization`**
`boolean` — Whether to restrict users from sharing summaries to those outside of the organization.
- **`restrict_summary_share`**
`string`, possible values: `"external_users", "all_users", "all_users_except_delegate"` — Whether to 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).
- **`whether_include_full_text_in_email`**
`string`, possible values: `"include_full_text_in_email", "not_include_full_text_in_email"` — 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).
- **`who_will_receive_summary`**
`string`, possible values: `"host", "host_and_panelist_in_organization", "host_and_panelist_not_in_organization"` — 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 our organization), \`host\_and\_panelist\_not\_in\_organization\` (Webinar host, co-hosts, and all panelists, including those outside our organization).
- **`webinar_summary_follow_up_email`**
`boolean` — Whether webinar summaries are included in webinar follow-up email. Deprecated. Use \`include\_webinar\_summary\_follow\_up\_email\`.
- **`webinar_summary_ocr`**
`boolean` — 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.
- **`whiteboard_content_generation`**
`boolean` — Whether Whiteboard content generation with AI is enabled.
- **`workspace_reservation_recommendations_with_ai`**
`object` — Workspace Reservation recommendations with AI.
- **`custom_workspaces_recommendation`**
`boolean` — Whether custom workspace recommendations are enabled.
- **`day_recommendation`**
`boolean` — Whether day recommendations are enabled.
- **`desk_recommendation`**
`boolean` — Whether desk recommendations are enabled.
- **`enabled`**
`boolean` — Whether Workspace Reservation recommendations with AI are enabled.
- **`proactive_room_recommendation`**
`boolean` — Whether proactive room recommendations are enabled.
- **`room_recommendation`**
`boolean` — Whether room recommendations are enabled.
- **`zoom_events_analytics`**
`boolean` — Whether Zoom Events AI Analytics is enabled. AI can analyze event engagement and uncover key moments, topics of interest, and actionable insights.
- **`zoom_events_chat_compose`**
`boolean` — Whether Zoom Events Chat Compose is enabled. AI helps users compose a response from scratch or wordsmith their chat messages.
- **`zoom_events_chat_panel`**
`boolean` — 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.
- **`zoom_events_content_generation`**
`boolean` — Whether Zoom Events Content Generation with AI is enabled. AI content generation helps users create blogs, ebooks, whitepapers, emails, highlights, and sales briefs.
- **`zoom_events_content_studio`**
`boolean` — Whether Content Studio is enabled. Content Studio can turn recordings into high-quality content such as video clips, emails, and blog posts.
- **`zoom_events_email_compose`**
`boolean` — Whether Zoom Events Email Compose with AI is enabled. AI can compose emails and subject lines for events in the Email Builder.
- **`zoom_events_image_generation`**
`boolean` — Whether the Zoom Events image generator is enabled. AI can create images for use in an event.
- **`zoom_events_session_summary`**
`object` — Session summary. Allow hosts to generate a summary. Summaries are sent after the session has ended based on the in-session access options.
- **`auto_start`**
`boolean` — Whether to turn on session summary automatically when sessions start.
- **`enable`**
`boolean` — Whether Zoom Events session summaries are enabled.
- **`zoom_events_smart_compose`**
`boolean` — 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.
- **`zoom_events_smart_upload`**
`boolean` — Whether Zoom Events Smart Upload is enabled. AI can ingest files to quickly create event content such as speaker biographies.
- **`audio_conferencing`**
`object` — The account's audio conference settings.
- **`call_me_and_invite_by_phone`**
`object` — 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.
- **`allow_webinar_attendees_call_me`**
`boolean` — Whether webinar attendees can use Call Me to connect audio. This feature is only available in version 5.2.2 and higher.
- **`call_out_countries`**
`object` — The account's call out countries/regions settings.
- **`selected_countries`**
`array` — The list of countries/regions that users can call out to.
**Items:**
- **`code`**
`string` — The \[code]\(https\://developers.zoom.us/docs/api/rest/other-references/abbreviation-lists/#countries) of the country or region.
- **`name`**
`string` — The name of the country or region.
- **`enable`**
`boolean` — 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.
- **`require_press_1_for_call_me`**
`string`, possible values: `"auto", "always", "never"` — Require Call Me users to press 1 before being connected to the meeting. \* \`auto\` - Automatically determine whether to require pressing 1 before connecting to the meeting. \* \`always\` - Always require Call Me users to press 1 before connecting to the meeting. \* \`never\` - Never require Call Me users to press 1 before connecting to the meeting.
- **`global_dial_in_countries`**
`object` — The account's \[\*\*Global Dial-in Countries/Regions\*\*]\(https\://support.zoom.com/hc/en/article?id=zm\_kb\&sysparm\_article=KB0068094#h\_01F5KK9J31ZXNW10BRH86NHX4G) settings.
- **`include_toll_free`**
`boolean` — Whether to include toll-free numbers in the email invitation for the selected countries/regions.
- **`selected_countries`**
`array` — The list of selected countries/regions whose dial-in numbers will be listed in the email invitation.
**Items:**
- **`code`**
`string` — The \[code]\(https\://developers.zoom.us/docs/api/rest/other-references/abbreviation-lists/#countries) of the country or region.
- **`name`**
`string` — The name of the country or region.
- **`participant_phone_masking`**
`object` — 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.
- **`enable`**
`boolean` — 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.
- **`masking_type`**
`string`, possible values: `"mask_default", "mask_first_5", "mask_except_last_4"` — The type of phone number masking pattern to apply. \* \`mask\_default\` - Default masking pattern (Example: 888\*\*\*\*666). \* \`mask\_first\_5\` - Mask first five digits (Example: \*\*\*\*\*66666). \* \`mask\_except\_last\_4\` - Mask everything except last four digits (Example: \*\*\*\*\*6666).
- **`personal_audio_conference`**
`boolean` — 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.
- **`toll_call`**
`object` — The account's \[\*\*Toll Call\*\*]\(https\://support.zoom.com/hc/en/article?id=zm\_kb\&sysparm\_article=KB0066909#h\_01F51680NJ7YHZDXGJNSKDGM2P) settings.
- **`enable`**
`boolean` — Whether the account has the \[\*\*Toll Call\*\*]\(https\://support.zoom.com/hc/en/article?id=zm\_kb\&sysparm\_article=KB0066909#h\_01F51680NJ7YHZDXGJNSKDGM2P) setting enabled.
- **`numbers`**
`array` — The account's \*\*Toll Call\*\* phone number information.
**Items:**
- **`code`**
`string` — The phone number's \[E.164 country calling code]\(https\://en.wikipedia.org/wiki/List\_of\_country\_calling\_codes).
- **`country_code`**
`string` — The phone number's two-letter \[country code]\(https\://developers.zoom.us/docs/api/rest/other-references/abbreviation-lists/#countries).
- **`country_name`**
`string` — The country name.
- **`display_number`**
`string` — The phone number's display number.
- **`number`**
`string` — The phone number.
- **`toll_free_and_fee_based_toll_call`**
`object` — 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.
- **`allow_webinar_attendees_dial`**
`boolean` — 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.
- **`enable`**
`boolean` — 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.
- **`numbers`**
`array` — The account's phone numbers.
**Items:**
- **`code`**
`string` — The phone number's \[E.164 country calling code]\(https\://en.wikipedia.org/wiki/List\_of\_country\_calling\_codes).
- **`country_code`**
`string` — The phone number's \[country code]\(https\://marketplace.zoom.us/docs/api-reference/other-references/abbreviation-lists#countries).
- **`country_name`**
`string` — The country name.
- **`display_number`**
`string` — The phone number's display number.
- **`number`**
`string` — The phone number.
- **`chat`**
`object` — The account's chat settings.
- **`ai_compose`**
`object` — Allow users to summarize chats, channels, and shared documents.
- **`enable`**
`boolean` — Compose with AI Companion
- **`shown_in_team_chat`**
`boolean` — Show in Team Chat
- **`ai_quick_reply`**
`boolean` — Quick reply with AI Companion
- **`ai_quick_schedule`**
`boolean` — Quick schedule with AI Companion
- **`ai_recommend`**
`boolean` — Chat Recommendation with Zoom AI Companion
- **`ai_sentence_completion`**
`boolean` — Sentence completion with AI Companion
- **`ai_summary`**
`object` — Allow users to summarize chats, channels, and shared documents.
- **`enable`**
`boolean` — Summarize with AI Companion
- **`shown_in_team_chat`**
`boolean` — Show in Team Chat
- **`allow_bots_chat`**
`boolean` — Whether chatbots added to chats and channels can read and write messages.
- **`allow_delete_message`**
`object` — 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.
- **`enable`**
`boolean` — Allow users to delete messages
- **`time`**
`integer`, possible values: `0, 5, 30, 60, 1440, 10080` — Within how many minitues of posting
- **`allow_edit_message`**
`object` — 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.
- **`enable`**
`boolean` — Allow users to edit messages
- **`time`**
`integer`, possible values: `0, 5, 30, 60, 1440, 10080` — Within how many minitues of posting
- **`allow_huddles_from_channels`**
`boolean` — Allow huddles from channels
- **`allow_remove_msg_by_owner_and_admins`**
`boolean` — Allow channel owner and admin(s) to remove messages of other members
- **`allow_users_to_add_contacts`**
`object` — Allow users to add contacts.
- **`enable`**
`boolean` — By disabling this setting, users will not be able to add contacts.
- **`selected_option`**
`integer`, possible values: `1, 2, 3, 4` — The type of allowing users to add contacts: \* 1 — Anyone (internal and external contacts). \* 2 — In the same organization. \* 3 — In the same organization and specified domains. \* 4 — In the same organization and specified users.
- **`user_email_addresses`**
`string` — The domains or emails (internal or external). \* 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. \* When the \`selected\_option\` field value is \`4\`, the value is internal or external email addresses. Use a comma to separate multiple emails.
- **`allow_users_to_chat_with_others`**
`object` — Allow users to chat with others.
- **`enable`**
`boolean` — 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.
- **`selected_option`**
`integer`, possible values: `1, 2, 3, 4` — The type of allowing users to add contacts: \* 1 — Anyone (internal and external contacts). \* 2 — In the same organization. \* 3 — In the same organization and specified domains. \* 4 — In the same organization and specified users.
- **`user_email_addresses`**
`string` — The domains or emails (internal or external). \* 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. \* When the \`selected\_option\` field value is \`4\`, the value is internal or external email addresses. Use a comma to separate multiple emails.
- **`apply_local_storage_to_personal_channel`**
`object` — Store personal channel messages on local devices.
- **`enable`**
`boolean` — 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.
- **`retention_period`**
`string` — Delete data after retention period. 'y' - year, 'm' - month, 'd' - day.
- **`chat_email_address`**
`object` — 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.
- **`enable`**
`boolean` — Chat email address
- **`only_allow_specific_domains`**
`boolean` — Only allow emails from specified domains
- **`specific_domains`**
`array`
**Items:**
`string` — Specified domains.
- **`chat_emojis`**
`object` — Chat emojis.
- **`emojis_option`**
`string`, possible values: `"all", "selected"`
- **`enable`**
`boolean` — 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.
- **`chat_etiquette_tool`**
`object` — Information about the \*\*Chat Etiquette Tool\*\*.
- **`enable`**
`boolean` — Whether to enable the \*\*Chat Etiquette Tool\*\*.
- **`policies`**
`array` — Information about the defined \*\*Chat Etiquette Tool\*\* policies.
**Items:**
- **`description`**
`string` — The policy's description.
- **`id`**
`string` — The policy ID.
- **`is_locked`**
`boolean` — Whether the policy is locked by an account-level user. When it is locked, users cannot update the policy.
- **`keywords`**
`array` — A list of defined rule keywords.
**Items:**
`string`
- **`name`**
`string` — The policy name.
- **`regular_expression`**
`string` — The regular expression to match to the content of chat messages.
- **`status`**
`string`, possible values: `"activated", "deactivated"` — The policy's current status. \* \`activated\` — Activated. \* \`deactivated\` — Deactivated.
- **`trigger_action`**
`integer`, possible values: `1, 2` — The policy's trigger action. \* \`1\` — Ask the user to confirm before they send the message. \* \`2\` — Block the user's message.
- **`policy_max_count`**
`integer` — The read-only maximum number of \*\*Chat Etiquette Tool\*\* policies.
- **`code_snippet`**
`boolean` — Send code snippet
- **`create_group_chat`**
`boolean` — Allow users to create group chats.
- **`create_private_channels`**
`boolean` — Allow users to create private channels.
- **`create_public_channels`**
`boolean` — Allow users to create public channels.
- **`download_file`**
`boolean` — Downloading files
- **`external_collab_restrict`**
`object` — Restrict external collaboration in group chats and channels for a select group
- **`enable`**
`boolean` — Restrict external collaboration in group chats and channels for a select group
- **`external_chat`**
`string`, possible values: `"allowed", "not_allowed"` — The type of restrict external collaboration in group chats and channels for a select group \* - Allowed user group \* - Not allowed user group
- **`group_id`**
`string` — The group Id
- **`external_invite_approve`**
`object` — Require admin approval for adding external users in group chats and channels
- **`channel_id`**
`string` — The channel Id
- **`enable`**
`boolean` — Require admin approval for adding external users in group chats and channels
- **`external_account`**
`boolean` — Allow this setting to be edited for specified accounts
- **`selected_option`**
`integer`, possible values: `1, 2` — 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
- **`external_join_approve`**
`object` — Require admin approval for joining external group chats and channels
- **`channel_id`**
`string` — The channel Id
- **`enable`**
`boolean` — Require admin approval for joining external group chats and channels
- **`external_account`**
`boolean` — Allow this setting to be edited for specified accounts
- **`selected_option`**
`integer`, possible values: `1, 2` — The type of requiring admin approval for joining external group chats and channels \* 1 - Send requests directly to all approvers \* 2 - Send requests to a specific channel
- **`external_member_join`**
`object` — Allow members of your organization to join external group chats and channels
- **`enable`**
`boolean` — Allow members of your organization to join external group chats and channels
- **`external_account`**
`boolean` — Allow this setting to be edited for specified accounts
- **`external_user_control`**
`object` — Add external users into group chats and channels
- **`enable`**
`boolean` — Allow to add external users into group chats and channels
- **`external_account`**
`boolean` — Allow this setting to be edited for specified accounts
- **`selected_option`**
`integer`, possible values: `1, 2, 3` — The type of allowing external user control \* 1 - Everyone \* 2 - Only members in your organization, plus specified external accounts \* 3 - Only the account owner and admins
- **`hyper_link`**
`boolean` — Allow hyperlinks in Team Chat
- **`personal_channel`**
`boolean` — Enable Personal Chat
- **`presence_away_when_screen_saver`**
`boolean` — Change my status to away when screen saver begins
- **`presence_on_meeting`**
`boolean` — Change my presence status when I am in a meeting or call
- **`read_receipts`**
`object` — Indicate when messages have been seen by recipients, for chats and channels with less than 20 members.
- **`allow_users_opt_out`**
`boolean` — Allow users to opt out
- **`enable`**
`boolean` — Enable read receipts
- **`record_video_messages`**
`boolean` — 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.
- **`record_voice_messages`**
`boolean` — Allow users to record voice messages that can be sent in direct messages or group conversations.
- **`schedule_meetings_in_chat`**
`boolean` — Schedule a meeting from chat or channel.
- **`screen_capture`**
`boolean` — Allow users to take and send screenshots in direct messages or group conversations.
- **`search_and_send_animated_gif_images`**
`object` — Allow users to search GIF images from GIPHY when they compose messages. See GIPHY's website for more information about content ratings.
- **`enable`**
`boolean` — Whether to allow users to search GIF images from GIPHY when they compose messages.
- **`giphy_content_rating`**
`integer`, possible values: `1, 2, 3, 4` — Set the GIPHY content rating. This feature is only available for Zoom Client v5.11.0 or later.
- **`send_data_to_third_party_archiving_service`**
`object` — Send data to third-party archiving service.
- **`authorized_channel_token`**
`string` — Authorized channel token. It is used when the field \`type\` value is \`smarsh\`.
- **`enable`**
`boolean` — Allow users to send data to third-party archiving service.
- **`passcode`**
`string` — passcode. It is used when the field \`type\` value is \`global\_relay\`.
- **`smtp_delivery_address`**
`string` — SMTP delivery address. It is used when the field \`type\` value is \`global\_relay\`.
- **`type`**
`string`, possible values: `"global_relay", "smarsh"` — The type of global relay. \* \`global\_relay\` — The participant cannot use chat. \* \`smarsh\` — Host and co-hosts only.
- **`user_name`**
`string` — User name. It is used when the field \`type\` value is \`global\_relay\`.
- **`set_chat_as_default_tab`**
`boolean` — Set Team Chat as a default tab for first-time users
- **`set_retention_period_in_cloud`**
`object` — Set retention period for messages and files in Zoom's cloud.
- **`enable`**
`boolean` — 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.
- **`retention_period_of_channels`**
`string` — Delete data in channels after retention period. 'y' - year, 'm' - month, 'd' - day
- **`retention_period_of_direct_messages_and_group_conversation`**
`string` — Delete direct messages and group conversations after retention period. 'y' - year, 'm' - month, 'd' - day
- **`set_retention_period_in_local`**
`object` — Store messages on local devices, excluding personal channel messages.
- **`enable`**
`boolean` — Specify how long your messages are saved on local devices. If this setting is disabled, messages are never deleted locally.
- **`retention_period_of_channels`**
`string` — Delete data in channels after retention period. 'y' - year, 'm' - month, 'd' - day
- **`retention_period_of_direct_messages_and_group_conversation`**
`string` — Delete direct messages and group conversations after retention period. 'y' - year, 'm' - month, 'd' - day
- **`share_files`**
`object` — Users can share files in chats and channels.
- **`enable`**
`boolean` — 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.
- **`restrictions`**
`object` — The restrictions of users can share files in chats and channels
- **`file_restrictions_apply_to`**
`string`, possible values: `"sharing_and_viewing", "sharing"` — Apply restrictions to both sharing and viewing, or only apply to sharing
- **`file_size_restrictions`**
`integer`, possible values: `50, 100, 200, 300, 400, 500` — Maximum file size
- **`file_size_restrictions_for_external`**
`integer`, possible values: `50, 100, 200, 300, 400, 500` — Maximum file size for external users
- **`file_type_restrictions`**
`array` — The restrictions of users can share files in chats and channels
**Items:**
`string`, possible values: `".gz", ".rar", ".zip", ".xls", ".xlsx", ".json", ".png", ".pptx", ".ppt", ".7z", ".xmind", ".pdf", ".pps", ".txt", ".docx", ".doc"` — Specified file type
- **`file_type_restrictions_for_external`**
`array`
**Items:**
`string`, possible values: `".gz", ".rar", ".zip", ".xls", ".xlsx", ".json", ".png", ".pptx", ".ppt", ".7z", ".xmind", ".pdf", ".pps", ".txt", ".docx", ".doc"` — Specified file type
- **`maximum_file_size`**
`boolean` — Whether to restrict file size
- **`only_allow_specific_file_types`**
`boolean` — Only allow specified file types
- **`share_option`**
`string`, possible values: `"disable", "anyone", "account", "organization"` — Allow users of this account to send files in chats and channels.
- **`view_option`**
`string`, possible values: `"anyone", "account", "organization"` — Allow users of this account to view files in chats and channels.
- **`share_links_in_chat`**
`boolean` — Share links to messages and channels in Team Chat.
- **`share_screen_in_chat`**
`boolean` — Share screen in chat
- **`shared_spaces`**
`boolean` — Allow users to create Shared Spaces
- **`show_h323_contact_tab`**
`boolean` — Show H.323 contacts
- **`show_status_to_internal_contact`**
`boolean` — Show status to internal contacts
- **`store_revise_chat`**
`boolean` — Store edited and deleted message revisions
- **`suppress_removal_notification`**
`boolean` — Suppress deleted, deactivated, and reactivated user notice in group chats and channels
- **`suppress_user_group_notification`**
`boolean` — Suppress add and remove user notice in channels
- **`survey_poll`**
`boolean` — Allow users to launch a poll in chats and channels
- **`translate_messages`**
`boolean` — Allow users to translate team chat messages. \[Learn more].(https\://support.zoom.us/hc/en-us/articles/12998089084685)
- **`email_notification`**
`object` — Information about the email notification settings.
- **`alternative_host_reminder`**
`boolean` — Whether to notify when an alternative host is added to or removed from a meeting.
- **`cancel_meeting_reminder`**
`boolean` — Whether to notify the host and participants when a meeting is canceled.
- **`cloud_recording_available_reminder`**
`boolean` — Whether to notify the host when a cloud recording is available.
- **`jbh_reminder`**
`boolean` — Whether to notify the host when participants join the meeting before them.
- **`low_host_count_reminder`**
`boolean` — Whether to notify the user when host licenses are running low.
- **`recording_available_reminder_alternative_hosts`**
`boolean` — Whether to notify any alternative hosts when a cloud recording is available.
- **`recording_available_reminder_schedulers`**
`boolean` — Whether to notify the person who scheduled the meeting or webinar for the host when a cloud recording is available.
- **`schedule_for_reminder`**
`boolean` — Whether to notify the host that there is a meeting is scheduled, rescheduled, or canceled.
- **`feature`**
`object` — Feature
- **`meeting_capacity`**
`integer` — The maximum number of participants a host can have in a single meeting.
- **`general_setting`**
`object` — General settings.
- **`auto_zoom_room_proximity_connect`**
`boolean` — Allow automatic direct sharing and connecting to Zoom Rooms using ultrasonic proximity signal.
- **`show_zoom_room_feature`**
`boolean` — Show "Zoom Room" feature in the Zoom Workplace app.
- **`h323sip_conferencing`**
`object` — The account's H.323/SIP Conferencing settings.
- **`custom_welcome_audio`**
`object` — Information about the custom welcome audio message played to H.323/SIP devices upon joining a Zoom Meeting.
- **`audio_file`**
`string` — The URL for the configured custom audio file.
- **`enable`**
`boolean`, default: `false` — Determines if a custom welcome audio message is played when H.323/SIP devices join a Zoom Meeting.
- **`in_meeting`**
`object` — Information about the in meeting settings.
- **`alert_guest_join`**
`boolean` — Whether to alert when a guest joins a meeting.
- **`allow_host_panelists_to_use_audible_clap`**
`boolean` — Whether to allow host and panelist to use audible clap.
- **`allow_host_to_enable_focus_mode`**
`boolean` — Whether the host can enable \[\*\*Focus Mode\*\*]\(https\://support.zoom.us/hc/en-us/articles/360061113751-Using-focus-mode) when scheduling a meeting.
- **`allow_live_streaming`**
`boolean` — Whether to allow livestreaming.
- **`allow_participants_chat_with`**
`integer`, possible values: `1, 2, 3, 4` — Whether participants can chat with certain groups: \* \`1\` — The participants cannot use chat. \* \`2\` — Host and co-hosts only. \* \`3\` — The participants can chat with other participants publicly. \* \`4\` - The participants can chat with other participants publicly and privately. \*\*Note:\*\* This setting is only available with client versions 5.7.3 and above.
- **`allow_show_zoom_windows`**
`boolean` — Whether to display the Zoom desktop application when sharing access.
- **`allow_users_save_chats`**
`integer`, possible values: `1, 2, 3` — Whether participants can save meeting chats: \* \`1\` — Participants cannot save meeting chats. \* \`2\` — Participants can only save host and co-host meeting chats. \* \`3\` — Participants can save all meeting chats.
- **`allow_users_to_delete_messages_in_meeting_chat`**
`boolean` — If the value of this field is set to \`true\`, allow users to delete messages in the in-meeting chat.
- **`annotation`**
`boolean` — Whether participants can use annotation tools to add information to shared screens.
- **`anonymous_question_answer`**
`boolean` — Whether anonymous Q\&A is enabled in a webinar.
- **`attendee_on_hold`**
`boolean` — Whether hosts can temporarily place an attendee on hold.
- **`attention_mode_focus_mode`**
`boolean` — Whether the \[\*\*Focus Mode\*\*]\(https\://support.zoom.us/hc/en-us/articles/360061113751-Using-focus-mode) feature is enabled. When enabled, this feature only displays the host and co-hosts' video and profile pictures during a meeting.
- **`audio_watermark_by_default`**
`boolean` — Whether to turn on \[audio watermark]\(https\://support.zoom.us/hc/en-us/articles/360021839031-Adding-audio-watermark) by default when scheduling a meeting.
- **`auto_answer`**
`boolean` — Whether users can 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.
- **`auto_saving_chat`**
`boolean` — Whether to automatically save all in-meeting chats.
- **`breakout_room`**
`boolean` — Whether the host can split meeting participants into separate, smaller rooms.
- **`breakout_room_schedule`**
`boolean` — Whether the host can assign participants to breakout rooms when scheduling. This feature is \*\*only\*\* available in version 4.5.0 or higher.
- **`chat`**
`boolean` — Whether meeting participants can use \[in-meeting chat]\(https\://support.zoom.us/hc/en-us/articles/203650445-In-Meeting-Chat).
- **`closed_caption`**
`boolean` — Whether the host can add closed captions.
- **`closed_captioning`**
`object` — The account's closed captioning settings.
- **`auto_transcribing`**
`boolean` — Whether to allow a live transcription service to transcribe meetings.
- **`enable`**
`boolean` — Whether to allow the host to type closed captions or assign a participant or 3rd-party service to provide closed captioning.
- **`save_caption`**
`boolean` — Whether to allow participants to save closed captions or transcripts.
- **`third_party_captioning_service`**
`boolean` — Whether to allow the use of an API token to integrate with 3rd-party closed captioning services.
- **`view_full_transcript`**
`boolean` — Whether to allow the viewing of full transcripts in the in-meeting side panel.
- **`co_host`**
`boolean` — Whether to allow the meeting host to add co-hosts.
- **`custom_data_center_regions`**
`boolean` — Whether custom \[data center regions]\(https\://support.zoom.us/hc/en-us/articles/360042411451-Selecting-data-center-regions-for-hosted-meetings-and-webinars) are enabled for hosting real-time meeting and webinar traffic: \* \`true\` — Enabled. Provide the data center regions in the \`data\_center\_regions\` field. \* \`false\` — Disabled. Only use the default data center regions.
- **`custom_live_streaming_service`**
`boolean` — Whether to allow custom livestreaming.
- **`custom_service_instructions`**
`string` — The custom livestreaming service instructions.
- **`data_center_regions`**
`array` — The user's selected custom data center regions. This field only returns if the \`custom\_data\_center\_regions\` value is \`true\`: \* \`AU\` — Australia. \* \`LA\` — Latin America. \* \`CA\` — Canada. \* \`CN\` — China. \* \`DE\` — Germany. \* \`HK\` — Hong Kong SAR. \* \`IN\` — India. \* \`IE\` — Ireland. \* \`TY\` — Japan. \* \`MX\` — Mexico. \* \`NL\` — Netherlands. \* \`SG\` — Singapore. \* \`US\` — United States.
**Items:**
`string`, possible values: `"AU", "LA", "CA", "CN", "DE", "HK", "IN", "IE", "TY", "MX", "NL", "SG", "US"`
- **`disable_screen_sharing_for_host_meetings`**
`boolean` — Whether the \*\*Disable desktop screen sharing for meetings you host\*\* setting is enabled.
- **`disable_screen_sharing_for_in_meeting_guests`**
`boolean` — Whether the \*\*Disable screen sharing when guests are in the meeting\*\* setting is enabled.
- **`dscp_audio`**
`integer` — The DSCP audio value.
- **`dscp_marking`**
`boolean` — Whether to use DSCP (differentiated services code point) marking.
- **`dscp_video`**
`integer` — The DSCP video value.
- **`e2e_encryption`**
`boolean` — Whether to require \[AES encryption]\(https\://en.wikipedia.org/wiki/Advanced\_Encryption\_Standard) for meetings.
- **`far_end_camera_control`**
`boolean` — Whether another user can take control of camera during a meeting.
- **`feedback`**
`boolean` — Whether users can send feedback to Zoom at the end of the meeting.
- **`file_transfer`**
`boolean` — Whether file sharing via in-meeting chat is enabled.
- **`group_hd`**
`boolean` — Whether higher quality video for the host and participants is enabled.
- **`join_from_desktop`**
`boolean` — Whether participants can join a meeting directly from their desktop browser.
- **`join_from_mobile`**
`boolean` — Whether participants can join a meeting directly from their mobile browser.
- **`language_interpretation`**
`object` — Information about the \[language interpretation]\(https\://support.zoom.us/hc/en-us/articles/360034919791-Using-Language-Interpretation-in-your-meeting-or-webinar) settings.
- **`allow_participants_to_speak_in_listening_channel`**
`boolean` — Whether to allow participants to speak in listening channel.
- **`allow_up_to_25_custom_languages_when_scheduling_meetings`**
`boolean` — Whether to allow up to 25 custom languages when scheduling meetings.
- **`custom_languages`**
`array` — A list of user-defined supported languages.
**Items:**
`string`
- **`enable`**
`boolean` — Whether hosts can assign participants as interpreters to interpret one language into another in real-time.
- **`enable_language_interpretation_by_default`**
`boolean` — Whether enable language interpretation by default.
- **`languages`**
`array`, possible values: `"English", "Chinese", "Japanese", "German", "French", "Russian", "Portuguese", "Spanish", "Korean"` — A list of system-supported languages.
**Items:**
`string`
- **`live_streaming_facebook`**
`boolean` — Whether to allow Facebook livestreaming.
- **`live_streaming_youtube`**
`boolean` — Whether to allow YouTube livestreaming.
- **`meeting_polling`**
`object` — Information about the account's meeting polling settings.
- **`advanced_polls`**
`boolean` — Whether the host can 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.
- **`allow_alternative_host_to_add_edit`**
`boolean` — Whether alternative hosts can add or edit polls and quizzes.
- **`allow_host_to_upload_image`**
`boolean` — Whether to allow host to upload an image for each question.
- **`enable`**
`boolean` — Whether the host can add polls before or during a meeting.
- **`manage_saved_polls_and_quizzes`**
`boolean` — Whether to allow users to manage saved polls and quizzes from Meetings
- **`require_answers_to_be_anonymous`**
`boolean` — Whether to require answers to be anonymous.
- **`meeting_question_answer`**
`boolean` — Allow participants to ask questions for the host and participants to answer.
- **`meeting_reactions`**
`boolean` — 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.
- **`meeting_reactions_emojis`**
`string`, possible values: `"all", "selected"` — Choose from the following meeting reaction options: \* \`all\` — All emojis: Allow meeting participants to use any emoji available in Zoom chat as a reaction in a meeting. \* \`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)
- **`meeting_survey`**
`boolean` — 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.
- **`non_verbal_feedback`**
`boolean`, default: `false` — 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\`.
- **`original_audio`**
`boolean` — Whether users can select original sound in their client settings.
- **`p2p_connetion`**
`boolean` — Whether peer-to-peer connection when only two people are in a meeting is enabled.
- **`p2p_ports`**
`boolean` — Whether a peer-to-peer listening ports range is enabled.
- **`participants_share_simultaneously`**
`string`, possible values: `"multiple", "one"` — Indicates how many participants can screen share at the same time. The value can be one of the following:\
\`one\`: Only one participant can screen share at a time .\
\`multiple\`: Multiple participants can screen share simultaneously (dual monitors recommended).
- **`polling`**
`boolean` — Whether polls are available in the meeting controls.
- **`ports_range`**
`string` — The comma-separated peer-to-peer listening ports range (for example, \`55,56\`), between 1 to 65535.
- **`post_meeting_feedback`**
`boolean` — Whether to display a post-meeting feedback survey at the end of a meeting.
- **`private_chat`**
`boolean` — Whether meeting participants can use private chat.
- **`remote_control`**
`boolean` — Whether users can request remote control.
- **`remote_support`**
`boolean`, default: `false` — Whether to enable the \[\*\*Remote support\*\*]\(https\://support.zoom.us/hc/en-us/articles/360060951012-Enabling-remote-support) setting. This value defaults to \`false\`.
- **`screen_sharing`**
`boolean` — Whether to allow screen sharing.
- **`sending_default_email_invites`**
`boolean` — Whether to display the default email when sending email invites.
- **`show_a_join_from_your_browser_link`**
`boolean` — Whether participants can join a meeting directly from their browser and bypass the Zoom application download process.
- **`show_meeting_control_toolbar`**
`boolean` — Whether to always display the meeting control bar.
- **`sign_language_interpretation`**
`object` — 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.
- **`custom_languages`**
`array` — A list of user-defined supported languages.
**Items:**
`string`
- **`enable`**
`boolean` — Whether to allow hosts to assign participants as sign language interpreters who can interpret one language into another in real-time.
- **`enable_sign_language_interpretation_by_default`**
`boolean` — Whether to enable sign language interpretation view by default in scheduler.
- **`languages`**
`array` — A list of system-supported languages.
**Items:**
`string`, possible values: `"American", "Chinese", "French", "German", "Japanese", "Russian", "Brazilian", "Spanish", "Mexican", "British"`
- **`slide_control`**
`boolean` — 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.
- **`stereo_audio`**
`boolean` — Whether users can select stereo audio in their client settings.
- **`use_html_format_email`**
`boolean` — Whether to use HTML-formatted email for the Outlook plugin.
- **`virtual_background`**
`boolean` — Whether users can change their background.
- **`watermark`**
`boolean` — Whether to add watermark when viewing a shared screen.
- **`watermark_by_default`**
`boolean` — Whether to turn on watermark by default when scheduling a meeting.
- **`webinar_chat`**
`object`
- **`allow_attendees_chat_with`**
`integer`, possible values: `1, 2, 3` — Webinar attendees can chat with: \* \`1\` — No one. \* \`2\` — Host and all panelists. \* \`3\` — Everyone.
- **`allow_auto_save_local_chat_file`**
`boolean` — Whether chat messages are saved automatically to a local file on the host's computer when the webinar ends.
- **`allow_panelists_chat_with`**
`integer`, possible values: `1, 2` — Webinar panelists can chat with: \* \`1\` — Host and all panelists. \* \`2\` — Everyone.
- **`allow_panelists_send_direct_message`**
`boolean` — Whether webinar panelists can send direct messages to other panelists.
- **`allow_users_save_chats`**
`integer`, possible values: `0, 1, 2` — Whether webinar attendees can save chats: \* \`0\` — Attendees cannot save chats. \* \`1\` — Attendees can only save host and panelist chats. \* \`2\` — Attendees can save all chats.
- **`default_attendees_chat_with`**
`integer`, possible values: `1, 2` — By default, webinar attendees can chat with: \* \`1\` — Host and all panelists. \* \`2\` — Everyone.
- **`enable`**
`boolean` — Whether webinar participants can send chat messages.
- **`webinar_live_streaming`**
`object`
- **`custom_service_instructions`**
`string` — The specific instructions that allow the account's meeting hosts to configure a custom livestream.
- **`enable`**
`boolean` — Whether webinar livestreaming is enabled.
- **`live_streaming_reminder`**
`boolean` — Whether to notify users to watch the livestream. This does not apply to custom RTMP (real-time messaging protocol).
- **`live_streaming_service`**
`array` — The available livestreaming services: \* \`facebook\` \* \`workplace\_by\_facebook\` \* \`youtube\` \* \`custom\_live\_streaming\_service\`
**Items:**
`string`, possible values: `"facebook", "workplace_by_facebook", "youtube", "custom_live_streaming_service"`
- **`webinar_polling`**
`object` — Information about the account's webinar polling settings.
- **`advanced_polls`**
`boolean` — Whether the host can 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.
- **`allow_alternative_host_to_add_edit`**
`boolean` — Whether alternative hosts can add or edit polls and quizzes.
- **`allow_host_to_upload_image`**
`boolean` — Whether to allow host to upload an image for each question.
- **`enable`**
`boolean` — Whether the host can add polls before or during a webinar.
- **`manage_saved_polls_and_quizzes`**
`boolean` — Whether to allow users to manage saved polls and quizzes from Meetings
- **`require_answers_to_be_anonymous`**
`boolean` — Whether to require answers to be anonymous.
- **`webinar_question_answer`**
`boolean` — Whether Q\&A is enabled in a webinar.
- **`webinar_reactions`**
`boolean` — Set this field to true to use \[webinar reactions]\(https\://support.zoom.us/hc/en-us/articles/4803536268429).
- **`webinar_survey`**
`boolean` — Whether to allow the host to present surveys to attendees once a webinar has ended.
- **`whiteboard`**
`boolean` — Whether participants can share a whiteboard that includes annotation tools.
- **`who_can_share_screen`**
`string`, possible values: `"host", "all"` — The type of user who can share their screen or content during meetings: \* \`host\` — Only hosts can screen share. \* \`all\` — Both hosts and participants can screen share.
- **`who_can_share_screen_when_someone_is_sharing`**
`string`, possible values: `"host", "all"` — The type of user that can begin sharing their screen when someone else in the meeting is sharing their screen: \* \`host\` — Only hosts can screen share when someone else is sharing. \* \`all\` — Both hosts and participants can screen share when someone else is sharing.
- **`workplace_by_facebook`**
`boolean` — Whether to allow Workplace by Facebook livestreaming.
- **`in_session`**
`object`
- **`custom_data_center_regions`**
`boolean` — Whether to use custom \[data center regions]\(https\://support.zoom.us/hc/en-us/articles/360042411451-Selecting-data-center-regions-for-meetings-webinars): \* \`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. \* \`false\` — Only use the default data center regions.
- **`data_center_regions`**
`array` — 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: \* \`AU\` — Australia. \* \`LA\` — Latin America. \* \`CA\` — Canada. \* \`CN\` — China. \* \`DE\` — Germany. \* \`HK\` — Hong Kong SAR. \* \`IN\` — India. \* \`IE\` — Ireland. \* \`TY\` — Japan. \* \`MX\` — Mexico. \* \`NL\` — Netherlands. \* \`SG\` — Singapore. \* \`US\` — United States.
**Items:**
`string`, possible values: `"AU", "LA", "CA", "CN", "DE", "HK", "IN", "IE", "TY", "MX", "NL", "SG", "US"`
- **`dscp_audio`**
`integer`, default: `56` — The DSCP audio marking value. This value defaults to \`56\`.
- **`dscp_dual`**
`boolean` — Whether to use the differentiated services code point classifiers ('dscp\_video', 'dscp\_audio') in the dual way (incoming and outgoing).
- **`dscp_marking`**
`boolean` — Whether to enable \[differentiated services code point (DSCP)]\(https\://en.wikipedia.org/wiki/Differentiated\_services) marking.
- **`dscp_video`**
`integer`, default: `40` — The DSCP video marking value. This value defaults to \`40\`.
- **`p2p_connetion`**
`boolean` — 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.
- **`p2p_ports`**
`boolean` — Whether to enable the \*\*Listening ports range\*\* setting.
- **`ports_range`**
`string`, default: `""` — 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.
- **`subsession`**
`boolean` — Allow host to split meeting participants into separate, smaller rooms.
- **`integration`**
`object` — Information about integration settings
- **`box`**
`boolean` — Whether users who join a meeting from their mobile device can share content from their Box account.
- **`dropbox`**
`boolean` — Whether users who join a meeting from their mobile device can share content from their Dropbox account.
- **`google_calendar`**
`boolean` — Whether meetings can be scheduled using Google Calendar.
- **`google_drive`**
`boolean` — Whether users who join a meeting from their mobile device can share content from their Google Drive.
- **`kubi`**
`boolean` — Whether users can control a connected Kubi device from within a Zoom meeting.
- **`microsoft_one_drive`**
`boolean` — Whether users who join a meeting from their mobile device can share content from their Microsoft OneDrive account.
- **`mail_calendar`**
`object` — Email and calendar related settings.
- **`email_calendar_management`**
`boolean` — Allow the Zoom client to manage both emails and calendar events for the user.
- **`email_management`**
`boolean` — Allow the Zoom client to manage user emails.
- **`zoom_email_provider`**
`boolean` — Allow users to select Zoom as their email service provider.
- **`meeting_security`**
`object`
- **`auto_security`**
`boolean` — Whether to require that all meetings are secured with at least one security option. This setting can only be disabled by Enterprise, ISV, Business (with more than 100 licenses), and Education accounts.
- **`block_user_domain`**
`boolean` — Whether to block users in specific domains from joining meetings and webinars.
- **`block_user_domain_list`**
`array` — The domain to block, up to 20 domains. For example, the \`\*.example.com\` domain.
**Items:**
`string`
- **`chat_etiquette_tool`**
`object` — Information about the \*\*Chat Etiquette\*\* Tool.
- **`enable`**
`boolean`, default: `false` — Whether to enable the \*\*Chat Etiquette Tool\*\*. This value defaults to \`false\`. The \*\*Chat Etiquette Tool\*\* allows you to define specific keywords and text patterns in chat to prevent users from inadvertently sharing unwanted messages.
- **`policies`**
`array` — Information about the defined \*\*Chat Etiquette Tool\*\* policies.
**Items:**
- **`description`**
`string` — The policy's description.
- **`id`**
`string` — The policy ID.
- **`is_locked`**
`boolean`, default: `false` — Whether to lock the policy. When it is locked, users cannot update the policy. This value defaults to \`false\`.
- **`keywords`**
`array` — A list of defined rule keywords.
**Items:**
`string`
- **`name`**
`string` — The policy name.
- **`regular_expression`**
`string` — The regular expression to match to the content of chat messages.
- **`status`**
`string`, possible values: `"activated", "deactivated"` — The policy's current status: \* \`activated\` — Activated. \* \`deactivated\` — Deactivated.
- **`trigger_action`**
`integer`, possible values: `1, 2` — The policy's trigger action: \* \`1\` — Ask the user to confirm before they send the message. \* \`2\` — Block the user's message.
- **`embed_password_in_join_link`**
`boolean` — Whether the meeting password will be encrypted and included in the invitation link. The provided link will allow participants to join the meeting without having to enter the password.
- **`encryption_type`**
`string`, possible values: `"enhanced_encryption", "e2ee"` — The type of encryption to use when starting a meeting: \* \`enhanced\_encryption\` — Use enhanced encryption. Encryption data is stored in the cloud. \* \`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.
- **`end_to_end_encrypted_meetings`**
`boolean` — Whether to enable end-to-end encryption for meetings. If enabled, you can specify the type of encryption in the \`encryption\_type\` field.
- **`meeting_password`**
`boolean` — Whether all instant and scheduled meetings that users can join via client or Zoom Rooms systems are password-protected. \[Personal Meeting ID (PMI)]\(https\://support.zoom.us/hc/en-us/articles/203276937) meetings are \*\*not\*\* included in this setting.
- **`meeting_password_requirement`**
`object` — Information about the meeting and webinar \[password requirements]\(https\://support.zoom.us/hc/en-us/articles/360033559832-Meeting-and-webinar-passwords#h\_a427384b-e383-4f80-864d-794bf0a37604).
- **`consecutive_characters_length`**
`integer`, possible values: `0, 4, 5, 6, 7, 8` — The maximum length of consecutive characters (for example, \`abcdef\`) allowed in a password: \* \`4\` through \`8\` — The maximum consecutive characters length. The length is \`n\` minus \`1\`, where \`n\` is the provided value. For example, if you provide the \`4\` value, there can only be a maximum of \`3\` consecutive characters in a password (for example, \`abc1x\@8fdh\`). \* \`0\` — Do not apply a consecutive character restriction.
- **`have_letter`**
`boolean` — Whether the password must contain at least one letter character.
- **`have_number`**
`boolean` — Whether the password must contain at least one numeric character.
- **`have_special_character`**
`boolean` — Whether the password must contain at least one special character. For example, \`!\`, \`@\`, and/or \`#\` characters.
- **`have_upper_and_lower_characters`**
`boolean` — Whether the password must include uppercase and lowercase characters.
- **`length`**
`integer` — The password's minimum length.
- **`only_allow_numeric`**
`boolean` — Whether the password must contain \*\*only\*\* numeric characters.
- **`weak_enhance_detection`**
`boolean` — Whether users will be informed when the provided password is weak.
- **`only_authenticated_can_join_from_webclient`**
`boolean` — Whether to specify that only authenticated users can join the meeting from the web client.
- **`phone_password`**
`boolean` — Whether to require a password for participants joining by phone. If enabled and the meeting is password-protected, a numeric password is required for participants to join by phone. For meetings with alphanumeric passwords, a numeric password will be generated.
- **`pmi_password`**
`boolean` — Whether all Personal Meeting ID (PMI) meetings that users can join via client or Zoom Rooms systems are password-protected.
- **`require_password_for_scheduled_meeting`**
`boolean` — Whether to require a password for meetings that have already been scheduled.
- **`require_password_for_scheduled_webinar`**
`boolean` — Whether to require a password for webinars that have already been scheduled.
- **`waiting_room`**
`boolean` — Whether participants are placed in the \[\*\*Waiting Room\*\*]\(https\://support.zoom.us/hc/en-us/articles/115000332726-Waiting-Room) when they join a meeting. 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.
- **`waiting_room_settings`**
`object` — Information about the waiting room settings.
- **`participants_to_place_in_waiting_room`**
`integer`, possible values: `0, 1, 2` — The type of participants to be admitted to the Waiting Room: \* \`0\` — All attendees. \* \`1\` — Users who are not in your account. \* \`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).
- **`users_who_can_admit_participants_from_waiting_room`**
`integer`, possible values: `0, 1` — The users who can admit participants from the Waiting Room: \* \`0\` — Host and co-hosts only. \* \`1\` — Host, co-hosts, and anyone who bypassed the Waiting Room if the host and co-hosts are not present.
- **`whitelisted_domains_for_waiting_room`**
`string` — 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").
- **`webinar_password`**
`boolean` — Whether to generate a password when scheduling webinars. Participants must use the generated password to join the scheduled webinar.
- **`other_options`**
`object`
- **`allow_auto_active_users`**
`boolean` — Whether administrators can activate users with a single default password when they add users. This immediately activates the users without waiting for them to set their own password.
- **`allow_users_contact_support_via_chat`**
`boolean` — Whether to display the Zoom Help badge on the bottom-right of the page.
- **`allow_users_enter_and_share_pronouns`**
`boolean` — Whether users can add pronouns to their profile cards and share them during meetings and webinars.
- **`blur_snapshot`**
`boolean` — Whether iOS blurs the screenshot in the task switcher when multiple apps are open. Android hides the screenshot in the system-level list of recent apps.
- **`display_meetings_scheduled_for_others`**
`boolean` — Whether a user with the \[scheduling privilege]\(https\://support.zoom.us/hc/en-us/articles/201362803-Scheduling-privilege) can view other users' meetings.
- **`meeting_qos_and_mos`**
`integer`, possible values: `0, 1, 2, 3` — The Dashboard meeting \[quality scores and network alerts]\(https\://support.zoom.us/hc/en-us/articles/360061244651) setting: \* \`0\` — Do not enable meeting quality scores and network alerts on the Dashboard. \* \`1\` — Display the meeting quality score and network alerts on the Dashboard. \* \`2\` — Use custom thresholds for quality scores and network alerts. \* \`3\` —Both Use custom thresholds for quality scores and network alerts and Display the meeting quality score and network alerts on the Dashboard.
- **`show_one_user_meeting_on_dashboard`**
`boolean` — Whether meetings with only one person will display on the Dashboard and in reports.
- **`use_cdn`**
`string`, possible values: `"none", "default", "wangsu"` — 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: \* \`none\` — Do not use a CDN. \* \`default\` — Use the Amazon CloudFront CDN for users \*\*except\*\* Chinese Mainland users. Chinese Mainland users will use the Wangsu CDN (China). \* \`wangsu\` — Use the Wangsu CDN for all users.
- **`webinar_registration_options`**
`object` — Webinar registration options.
- **`allow_host_to_enable_social_share_buttons`**
`boolean` — Allow host to enable "Show social share buttons on registration page"
- **`recording`**
`object` — Information about recording settings.
- **`account_user_access_recording`**
`boolean` — Whether cloud recordings are only accessible to account members. People outside of your organization \*\*cannot\*\* open links that provide access to cloud recordings.
- **`allow_recovery_deleted_cloud_recordings`**
`boolean` — Whether the recovery of deleted cloud recordings from the trash is enabled. If enabled, then deleted cloud recordings are kept in the trash for 30 days after deletion. The recordings can be recovered within that period.
- **`archive`**
`object` — Information about the \[archiving solution]\(https\://support.zoom.us/hc/en-us/articles/360050431572-Archiving-Meeting-and-Webinar-data) settings. This is only available if granted archiving solution access by the Zoom support team.
- **`enable`**
`boolean` — Whether the archiving feature is enabled.
- **`settings`**
`object`
- **`action_when_archive_failed`**
`integer`, possible values: `1, 2` — Perform the action when meetings or webinars cannot be archived.\
\`1\` - Participants can stay in the meeting and will receive a notification.\
\`2\` - Nobody can join or stay in the meeting.
- **`archive_retention`**
`integer`, possible values: `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` — The retention period for archiving content, in days.
- **`audio_file`**
`boolean` — Whether to include in-meeting and/or in-webinar audio in the archive.
- **`cc_transcript_file`**
`boolean` — Whether to include closed captions or transcripts in the archive.
- **`chat_file`**
`boolean` — Whether to include in-meeting chat in the archive.
- **`chat_with_direct_message`**
`object` — Include direct message in in-meeting chat file.
- **`chat_with_sender_email`**
`boolean` — Whether to include user emails in the in-meeting chat file.
- **`notification_when_archiving_starts`**
`string`, possible values: `"participants", "guest"` — Show notification when video or audio archiving starts.\
\`1\` - Participants can stay in the meeting and will receive a notification.\
\`2\` - Nobody can join or stay in the meeting.
- **`play_voice_prompt_when_archiving_starts`**
`string`, possible values: `"participants", "guest", "none"` — Play voice prompt when video or audio archiving starts.\
\`1\` - Participants can stay in the meeting and will receive a notification.\
\`2\` - Nobody can join or stay in the meeting.
- **`video_file`**
`boolean` — Whether to include in-meeting and/or in-webinar video in the archive.
- **`type`**
`integer`, possible values: `1, 2, 3` — The archive solution type: \* \`1\` — Only meetings are archived. \* \`2\` — Only webinars are archived. \* \`3\` — Both meetings and webinars are archived.
- **`ask_host_to_confirm_disclaimer`**
`boolean` — Whether to ask the host to confirm the recording disclaimer is enabled.
- **`ask_participants_to_consent_disclaimer`**
`boolean` — Whether to ask participants for consent when a recording begins is enabled. This is only available when the value of the \`recording\_disclaimer\` field is set to \`true\`.
- **`auto_delete_cmr`**
`boolean` — Whether Zoom will permanently delete recordings automatically after a specified number of days is enabled. The number of days is displayed in the \`auto\_delete\_cmr\_days\` field.
- **`auto_delete_cmr_days`**
`integer`, possible values: `30, 60, 90, 120` — When the \`auto\_delete\_cmr\` value is \`true\`, this value is the number of days before the auto-deletion of cloud recordings: \* \`30\` — 30 days. \* \`60\` — 60 days. \* \`90\` — 90 days. \* \`120\` — 120 days.
- **`auto_recording`**
`string` — The automatic recording setting: \* \`local\` — Record locally \* \`cloud\` — Record on the cloud. \* \`none\` — Disabled.
- **`cloud_recording`**
`boolean` — Whether hosts can record and save the meeting in the cloud.
- **`cloud_recording_download`**
`boolean` — Whether cloud recording downloads are enabled.
- **`cloud_recording_download_host`**
`boolean` — Whether only the host can download cloud recordings.
- **`display_participant_name`**
`boolean` — Whether participants' names display in the recording.
- **`host_delete_cloud_recording`**
`boolean` — Whether the host can delete recordings. If this is disabled, the recordings cannot be deleted by the host. Only an administrator can delete the recordings.
- **`host_pause_stop_recording`**
`boolean` — Whether the meeting's host can pause or stop the cloud's auto recording is enabled.
- **`ip_address_access_control`**
`object` — Information about the settings to allow cloud recording access only from specific IP address ranges.
- **`enable`**
`boolean` — Whether the cloud recordings of the account can only be accessed by the IP addresses defined in the \`ip\_addresses\_or\_ranges\` property.
- **`ip_addresses_or_ranges`**
`string` — The IP addresses or ranges that have access to the cloud recordings.
- **`local_recording`**
`boolean` — Whether hosts and participants can record the meeting using a local file.
- **`optimize_recording_for_3rd_party_video_editor`**
`boolean` — Whether recordings will be optimized for a 3rd party video editor. This can increase the file size and the time it takes to generate recording files.
- **`prevent_host_access_recording`**
`boolean` — Whether meeting hosts are prevented from accessing their meeting cloud recordings. Only the administrators with recording management privileges can access them.
- **`record_audio_file`**
`boolean` — Whether recording an audio-only file is enabled.
- **`record_audio_file_each_participant`**
`boolean` — Whether to record separate audio files for each participant is enabled.
- **`record_files_separately`**
`object` — 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.
- **`active_speaker`**
`boolean` — Whether recording only the active speaker is enabled.
- **`gallery_view`**
`boolean` — Whether recording only the gallery view is enabled.
- **`shared_screen`**
`boolean` — Whether recording only the gallery view is enabled.
- **`record_gallery_view`**
`boolean` — Whether recording the \[gallery view]\(https\://support.zoom.us/hc/en-us/articles/360000005883-Displaying-Participants-in-Gallery-View) with a shared screen is enabled.
- **`record_speaker_view`**
`boolean` — Whether recording the active speaker with a shared screen is enabled.
- **`recording_audio_transcript`**
`boolean` — Whether automatically transcribing the audio of the meeting or webinar to the cloud is enabled.
- **`recording_disclaimer`**
`boolean` — Whether to display a disclaimer to participants before a recording begins is enabled.
- **`recording_highlight`**
`boolean` — Whether the \[recording highlights]\(https\://support.zoom.us/hc/en-us/articles/360060802432) feature is enabled.
- **`recording_password_requirement`**
`object` — Information about the minimum password requirements for recordings via the Account Recording settings.
- **`have_letter`**
`boolean` — Whether the password must contain at least one alphabetical letter.
- **`have_number`**
`boolean` — Whether the password must contain at least one numeric character.
- **`have_special_character`**
`boolean` — Whether the password must contain at least one special character (for example, \`!\`, \`@\`, or \`#\`).
- **`length`**
`integer` — The password's minimum required length.
- **`only_allow_numeric`**
`boolean` — Whether the password must contain \*\*only\*\* numeric characters.
- **`recording_thumbnails`**
`boolean` — Whether thumbnails of the presenter are recorded when they are sharing their screen.
- **`save_chat_text`**
`boolean` — Whether saving the chat text from the meeting is enabled.
- **`save_close_caption`**
`boolean` — Whether \[closed captions]\(https\://support.zoom.us/hc/en-us/articles/207279736) are saved as a VTT (Video Track Text) file.
- **`save_panelist_chat`**
`boolean` — Whether panelist chats are saved to the recording.
- **`save_poll_results`**
`boolean` — Whether poll results shared during the meeting or webinar are saved. This also includes poll results shared during the meeting or webinar.
- **`show_timestamp`**
`boolean` — Whether adding a timestamp to the recording is enabled.
- **`smart_recording`**
`object` — 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.
- **`create_next_steps`**
`boolean` — By selecting this option, there will be a summary of actions to take after the recorded meeting.
- **`create_recording_highlights`**
`boolean` — 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.
- **`create_smart_chapters`**
`boolean` — By selecting this option, your recording will have chapters with overview. Hosts can edit the chapters.
- **`schedule_meeting`**
`object` — Information about the schedule meeting settings.
- **`always_display_zoom_meeting_as_topic`**
`object` — 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.
- **`display_topic_for_scheduled_meetings`**
`boolean` — Whether to display "Zoom Meeting" as the topic for already-scheduled meetings.
- **`enable`**
`boolean` — Whether the \*\*Always display "Zoom Meeting" as the meeting topic\*\* setting is enabled.
- **`always_display_zoom_webinar_as_topic`**
`object` — 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.
- **`display_topic_for_scheduled_webinars`**
`boolean` — Whether to display "Zoom Webinar" as the topic for already-scheduled meetings.
- **`enable`**
`boolean` — Whether the \*\*Always show "Zoom Webinar" as the webinar topic\*\* setting is enabled.
- **`audio_type`**
`string` — The type of audio used to join the meeting.
- **`enforce_login`**
`boolean` — Whether only users who are signed in to Zoom can join meetings.
- **`enforce_login_domains`**
`string` — The specified domains for users to sign in to in order to join meetings.
- **`enforce_login_with_domains`**
`boolean` — Whether only users with a specific domain can join meetings.
- **`force_pmi_jbh_password`**
`boolean` — Whether to require a password for personal meetings if attendees can join before host.
- **`hide_meeting_description`**
`object` — Information about the \*\*Hide meeting description\*\* feature.
- **`enable`**
`boolean` — Whether the \*\*Hide meeting description\*\* setting is enabled.
- **`hide_description_for_scheduled_meetings`**
`boolean` — Whether to hide the description for already-scheduled meetings.
- **`hide_webinar_description`**
`object` — Information about the \*\*Hide webinar description\*\* feature.
- **`enable`**
`boolean` — Whether the \*\*Hide webinar description\*\* setting is enabled.
- **`hide_description_for_scheduled_webinars`**
`boolean` — Whether to hide webinar description for the webinars which have already been scheduled.
- **`host_video`**
`boolean` — Whether to start meetings with the host video on.
- **`jbh_time`**
`integer`, possible values: `0, 5, 10, 15` — If the value of the \`join\_before\_host\` field is \`true\`, this field indicates the time limits within which a participant can join a meeting before the meeting's host: \* \`0\` — Allow the participant to join the meeting at anytime. \* \`5\` — Allow the participant to join 5 minutes before the meeting's start time. \* \`10\` — Allow the participant to join 10 minutes before the meeting's start time.
- **`join_before_host`**
`boolean` — Whether participants can join the meeting before its host.
- **`mute_upon_entry`**
`boolean` — Whether to automatically mute all participants when they join the meeting.
- **`not_store_meeting_topic`**
`boolean` — Whether to display the "Zoom Meeting" message as the meeting's topic.
- **`participant_video`**
`boolean` — Whether to start meetings with the participant video on.
- **`personal_meeting`**
`boolean` — The personal meeting settings: \* \`true\` — Indicates that the \*\*Enable Personal Meeting ID\*\* setting is enabled. Users can use a personal meeting ID for their meetings. \* \`false\` — Indicates that the \*\*Enable Personal Meeting ID\*\* setting is \[disabled]\(https\://support.zoom.us/hc/en-us/articles/201362843-Personal-meeting-ID-PMI-and-personal-link#h\_aa0335c8-3b06-41bc-bc1f-a8b84ef17f2a). When this setting is \*\*disabled\*\*, meetings that were scheduled with a PMI will be invalid. You must manually update any scheduled meetings. \*\*For Zoom Phone only:\*\* If a user has been assigned a desk phone, the desk phone's \*\*Elevate to Zoom Meeting\*\* setting will be disabled.
- **`pmi_password`**
`string` — The PMI's password.
- **`pstn_password_protected`**
`string` — Require a password from participants before joining a meeting via \[PSTN]\(https\://support.zoom.us/hc/en-us/articles/204517069-Getting-Started-with-Personal-Audio-Conference).
- **`require_password_for_instant_meetings`**
`boolean` — Whether a random password will be generated on the end of user who starts the instant meeting. Other meeting participants \*\*must\*\* enter the generated password to join the meeting. If instant meetings use a PMI, this option is \*\*disabled\*\*.
- **`require_password_for_pmi_meetings`**
`string`, possible values: `"jbh_only", "all", "none"` — Require participants to enter password for PMI meetings: \* \`jbh\_only\` — Only when a participant joins before the host. \* \`all\` — All participants must enter a password to join the meeting. \* \`none\` — No password required.
- **`require_password_for_scheduling_new_meetings`**
`boolean` — Whether a password is generated when a meeting host schedules a new meeting. Meeting participants will be required to enter the password before they can join the meeting. This setting only applies to regular meetings that do \*\*not\*\* use a PMI.
- **`upcoming_meeting_reminder`**
`boolean` — Whether to receive a desktop notification for upcoming meetings.
- **`use_pmi_for_instant_meetings`**
`boolean` — Whether PMI is enabled for all instant meetings.
- **`use_pmi_for_scheduled_meetings`**
`boolean` — Use a \[PMI (Personal Meeting ID)]\(https\://support.zoom.us/hc/en-us/articles/203276937-Using-Personal-Meeting-ID-PMI-) to schedule meeting.
- **`security`**
`object` — Information about the security settings.
- **`admin_change_name_pic`**
`boolean` — Whether only account administrators can change a user's username and picture.
- **`hide_billing_info`**
`boolean` — Whether hiding of billing information is enabled.
- **`import_photos_from_devices`**
`boolean` — Whether users can import photos from a photo library on a device.
- **`password_requirement`**
`object` — Information about the \[enhanced password rules]\(https\://support.zoom.us/hc/en-us/articles/360034675592-Advanced-security-settings#h\_bf8a25f6-9a66-447a-befd-f02ed3404f89) that allows Zoom account administrators and owners to apply additinal requirements to the users' Zoom login password.
- **`consecutive_characters_length`**
`integer` — The password's maximum length of consecutive characters (for example, \`abcde\`). If this is a \`0\` value, there is no consecutive character restriction.
- **`have_special_character`**
`boolean` — Whether a password requires at least one special character (for example, \`!\`, \`@\`, and \`#\`).
- **`minimum_password_length`**
`integer` — A password's required minimum length value. The password length can be between a minimum of 8 characters, up to 14 characters. If this is a \`0\` value, this setting is \*\*disabled\*\* and is not used. The default password length requirement will be a minimum of 8 characters.
- **`weak_enhance_detection`**
`boolean` — Whether passwords must pass detection through a weak password dictionary.
- **`signin_with_sso`**
`object` — Allow users to sign in with single sign-on (SSO).
- **`domains`**
`array` — Users using these domains are required to sign in with single sign-on (SSO).
**Items:**
`string`
- **`enable`**
`boolean` — Whether to allow users to sign in with single sign-on (SSO). Enabling this requires you to configure your account's SSO settings. This lets users sign in with SSO through your company's vanity URL.
- **`require_sso_for_domains`**
`boolean` — Whether to require users to sign in with single sign-on (SSO) if their e-mail address belongs to one of the \`domains\`.
- **`sso_bypass_users`**
`array` — The users can bypass SSO sign-in.
**Items:**
- **`email`**
`string` — The user's email.
- **`id`**
`string` — The user's ID.
- **`session_security`**
`object`
- **`approved_or_denied_countries_or_regions`**
`object` — Approve or block users from specific regions or countries from joining this meeting.
- **`approved_list`**
`array` — List of countries/regions from where participants can join this meeting.
**Items:**
`string`
- **`denied_list`**
`array` — List of countries/regions from where participants can not join this meeting.
**Items:**
`string`
- **`enable`**
`boolean` — \`true\`: Setting enabled to either allow or block users from specific regions from joining your meetings. \
\`false\`: Setting disabled.
- **`method`**
`string`, possible values: `"approve", "deny"` — Specify whether to allow users from specific regions to join this meeting; or block users from specific regions from joining this meeting. \
\
\`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\`.\
\
\`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\`
- **`telephony`**
`object` — Information about telephony settings.
- **`audio_conference_info`**
`string` — Information about the third-party audio configuration.
- **`telephony_regions`**
`object` — Information about where most of the participants call into or call from during a meeting.
- **`allowed_values`**
`array` — The telephony region options provided by Zoom.
**Items:**
`string`
- **`selection_values`**
`string` — The account's selected telephony regions that indicates where most of the participants call into or call from during a meeting.
- **`third_party_audio`**
`boolean` — Whether users can join the meeting using an existing third-party audio configuration.
- **`tsp`**
`object` — Information about TSP settings.
- **`allow_webinar_attendees_call_me`**
`boolean` — Whether webinar attendees can use Call Me to connect audio. This feature is only available in version 5.2.2 and higher.
- **`allow_webinar_attendees_toll_free_dial`**
`boolean` — 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.
- **`call_out`**
`boolean` — Call Out
- **`call_out_countries`**
`array` — Call Out Countries/Regions
**Items:**
`string`
- **`display_toll_free_numbers`**
`boolean` — Display toll-free numbers
- **`global_dial_in_countries`**
`object` — The account's \*\*Global Dial-in Countries/Regions\*\* settings.
- **`selected_countries`**
`array` — 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:**
- **`code`**
`string` — The code of the country or region.
- **`name`**
`string` — The name of the country or region.
- **`show_international_numbers_link`**
`boolean` — Show international numbers link on the invitation email
- **`zoom_rooms`**
`object` — Information about the Zoom Rooms settings.
- **`auto_start_stop_scheduled_meetings`**
`boolean` — Whether an automatic start time and stop time for scheduled meetings is enabled.
- **`cmr_for_instant_meeting`**
`boolean` — Whether cloud recording for instant meetings is enabled.
- **`force_private_meeting`**
`boolean` — Whether to force all meetings to be \[private meetings]\(https\://support.zoom.us/hc/en-us/articles/115001051063-Zoom-Rooms-Private-Meetings).
- **`hide_host_information`**
`boolean` — Whether hiding of the host and meeting ID in private meetings is enabled.
- **`list_meetings_with_calendar`**
`boolean` — Whether to display meeting lists with calendar integration.
- **`start_airplay_manually`**
`boolean` — Whether to start the AirPlay service manually.
- **`ultrasonic`**
`boolean` — Whether the automatic direct sharing using an ultrasonic proximity signal is enabled.
- **`upcoming_meeting_alert`**
`boolean` — Whether upcoming meeting alerts are enabled.
- **`weekly_system_restart`**
`boolean` — Whether weekly system restarts are enabled.
- **`zr_post_meeting_feedback`**
`boolean` — Whether Zoom Room post-meeting feedback is enabled.
- **`operator`**
`string`, format: `email` — The email address of the user who updated the account's settings.
- **`operator_id`**
`string` — The user ID of the user who updated the account's settings.
- **`time_stamp`**
`integer` — A timestamp that indicates when the setting was updated.
**Example:**
```json
{
"event": "",
"event_ts": 1,
"payload": {
"account_id": "",
"operator": "",
"operator_id": "",
"object": {
"id": "",
"settings": {
"schedule_meeting": {
"host_video": true,
"participant_video": true,
"audio_type": "",
"join_before_host": true,
"enforce_login": true,
"enforce_login_with_domains": true,
"enforce_login_domains": "",
"not_store_meeting_topic": true,
"force_pmi_jbh_password": true,
"use_pmi_for_scheduled_meetings": true,
"pstn_password_protected": "",
"jbh_time": 0,
"personal_meeting": true,
"require_password_for_instant_meetings": true,
"mute_upon_entry": true,
"require_password_for_pmi_meetings": "jbh_only",
"use_pmi_for_instant_meetings": true,
"require_password_for_scheduling_new_meetings": true,
"pmi_password": "",
"upcoming_meeting_reminder": true,
"always_display_zoom_meeting_as_topic": {
"enable": true,
"display_topic_for_scheduled_meetings": true
},
"hide_meeting_description": {
"enable": true,
"hide_description_for_scheduled_meetings": true
},
"always_display_zoom_webinar_as_topic": {
"enable": true,
"display_topic_for_scheduled_webinars": true
},
"hide_webinar_description": {
"enable": true,
"hide_description_for_scheduled_webinars": true
}
},
"in_meeting": {
"e2e_encryption": true,
"chat": true,
"allow_users_to_delete_messages_in_meeting_chat": true,
"allow_participants_chat_with": 1,
"allow_users_save_chats": 1,
"private_chat": true,
"auto_saving_chat": true,
"file_transfer": true,
"feedback": true,
"post_meeting_feedback": true,
"co_host": true,
"polling": true,
"meeting_polling": {
"enable": true,
"advanced_polls": true,
"require_answers_to_be_anonymous": true,
"allow_alternative_host_to_add_edit": true,
"manage_saved_polls_and_quizzes": true,
"allow_host_to_upload_image": true
},
"attendee_on_hold": true,
"show_meeting_control_toolbar": true,
"allow_show_zoom_windows": true,
"annotation": true,
"whiteboard": true,
"webinar_question_answer": true,
"meeting_question_answer": true,
"anonymous_question_answer": true,
"breakout_room": true,
"breakout_room_schedule": true,
"closed_caption": true,
"far_end_camera_control": true,
"group_hd": true,
"virtual_background": true,
"watermark": true,
"watermark_by_default": true,
"audio_watermark_by_default": true,
"attention_mode_focus_mode": true,
"allow_host_to_enable_focus_mode": true,
"alert_guest_join": true,
"auto_answer": true,
"p2p_connetion": true,
"p2p_ports": true,
"ports_range": "",
"sending_default_email_invites": true,
"use_html_format_email": true,
"dscp_marking": true,
"dscp_audio": 1,
"dscp_video": 1,
"stereo_audio": true,
"original_audio": true,
"screen_sharing": true,
"remote_control": true,
"non_verbal_feedback": false,
"remote_support": false,
"custom_data_center_regions": true,
"data_center_regions": [
"AU"
],
"language_interpretation": {
"enable": true,
"enable_language_interpretation_by_default": true,
"allow_participants_to_speak_in_listening_channel": true,
"allow_up_to_25_custom_languages_when_scheduling_meetings": true,
"languages": "English",
"custom_languages": [
""
]
},
"sign_language_interpretation": {
"enable": true,
"enable_sign_language_interpretation_by_default": true,
"languages": [
"American"
],
"custom_languages": [
""
]
},
"meeting_reactions": true,
"meeting_reactions_emojis": "all",
"allow_host_panelists_to_use_audible_clap": true,
"webinar_reactions": true,
"show_a_join_from_your_browser_link": true,
"join_from_mobile": true,
"join_from_desktop": true,
"allow_live_streaming": true,
"live_streaming_facebook": true,
"workplace_by_facebook": true,
"live_streaming_youtube": true,
"custom_live_streaming_service": true,
"custom_service_instructions": "",
"webinar_live_streaming": {
"enable": true,
"live_streaming_service": [
"facebook"
],
"custom_service_instructions": "",
"live_streaming_reminder": true
},
"webinar_chat": {
"enable": true,
"allow_panelists_chat_with": 1,
"allow_attendees_chat_with": 1,
"default_attendees_chat_with": 1,
"allow_panelists_send_direct_message": true,
"allow_users_save_chats": 0,
"allow_auto_save_local_chat_file": true
},
"closed_captioning": {
"enable": true,
"third_party_captioning_service": true,
"auto_transcribing": true,
"view_full_transcript": true,
"save_caption": true
},
"slide_control": true,
"meeting_survey": true,
"webinar_polling": {
"enable": true,
"advanced_polls": true,
"require_answers_to_be_anonymous": true,
"allow_alternative_host_to_add_edit": true,
"manage_saved_polls_and_quizzes": true,
"allow_host_to_upload_image": true
},
"webinar_survey": true,
"disable_screen_sharing_for_host_meetings": true,
"disable_screen_sharing_for_in_meeting_guests": true,
"who_can_share_screen": "all",
"who_can_share_screen_when_someone_is_sharing": "host",
"participants_share_simultaneously": "multiple"
},
"email_notification": {
"cloud_recording_available_reminder": true,
"recording_available_reminder_schedulers": true,
"recording_available_reminder_alternative_hosts": true,
"jbh_reminder": true,
"cancel_meeting_reminder": true,
"low_host_count_reminder": true,
"alternative_host_reminder": true,
"schedule_for_reminder": true
},
"zoom_rooms": {
"upcoming_meeting_alert": true,
"start_airplay_manually": true,
"weekly_system_restart": true,
"list_meetings_with_calendar": true,
"zr_post_meeting_feedback": true,
"ultrasonic": true,
"force_private_meeting": true,
"hide_host_information": true,
"cmr_for_instant_meeting": true,
"auto_start_stop_scheduled_meetings": true
},
"security": {
"admin_change_name_pic": true,
"import_photos_from_devices": true,
"hide_billing_info": true,
"password_requirement": {
"minimum_password_length": 8,
"have_special_character": true,
"consecutive_characters_length": 1,
"weak_enhance_detection": true
},
"signin_with_sso": {
"enable": true,
"require_sso_for_domains": true,
"domains": [
"test.com",
"example.us"
],
"sso_bypass_users": [
{
"id": "21212_aefwef32233",
"email": "123@test.com"
}
]
}
},
"recording": {
"local_recording": true,
"cloud_recording": true,
"record_speaker_view": true,
"record_gallery_view": true,
"record_audio_file": true,
"save_chat_text": true,
"show_timestamp": true,
"recording_audio_transcript": true,
"auto_recording": "",
"cloud_recording_download": true,
"cloud_recording_download_host": true,
"account_user_access_recording": true,
"auto_delete_cmr": true,
"auto_delete_cmr_days": 30,
"record_files_separately": {
"active_speaker": true,
"gallery_view": true,
"shared_screen": true
},
"display_participant_name": true,
"recording_thumbnails": true,
"optimize_recording_for_3rd_party_video_editor": true,
"recording_highlight": true,
"smart_recording": {
"create_recording_highlights": true,
"create_smart_chapters": true,
"create_next_steps": true
},
"save_panelist_chat": true,
"save_poll_results": true,
"save_close_caption": true,
"record_audio_file_each_participant": true,
"host_pause_stop_recording": true,
"recording_disclaimer": true,
"ask_participants_to_consent_disclaimer": true,
"ask_host_to_confirm_disclaimer": true,
"recording_password_requirement": {
"length": 1,
"have_letter": true,
"have_number": true,
"have_special_character": true,
"only_allow_numeric": true
},
"ip_address_access_control": {
"enable": true,
"ip_addresses_or_ranges": ""
},
"prevent_host_access_recording": true,
"host_delete_cloud_recording": true,
"allow_recovery_deleted_cloud_recordings": true,
"archive": {
"enable": true,
"type": 1,
"settings": {
"chat_file": true,
"chat_with_sender_email": true,
"audio_file": true,
"video_file": true,
"cc_transcript_file": true,
"chat_with_direct_message": true,
"archive_retention": 1,
"action_when_archive_failed": 1,
"notification_when_archiving_starts": "participants",
"play_voice_prompt_when_archiving_starts": "participants"
}
}
},
"telephony": {
"third_party_audio": true,
"audio_conference_info": "",
"telephony_regions": {
"allowed_values": [
""
],
"selection_values": ""
}
},
"tsp": {
"call_out": true,
"call_out_countries": [
"us"
],
"allow_webinar_attendees_call_me": true,
"display_toll_free_numbers": true,
"allow_webinar_attendees_toll_free_dial": true,
"show_international_numbers_link": true,
"global_dial_in_countries": {
"selected_countries": [
{
"code": "CN",
"name": "China"
}
]
}
},
"integration": {
"google_calendar": true,
"google_drive": true,
"dropbox": true,
"box": true,
"microsoft_one_drive": true,
"kubi": true
},
"feature": {
"meeting_capacity": 1
},
"other_options": {
"allow_auto_active_users": true,
"blur_snapshot": true,
"display_meetings_scheduled_for_others": true,
"use_cdn": "none",
"allow_users_contact_support_via_chat": true,
"show_one_user_meeting_on_dashboard": true,
"meeting_qos_and_mos": 0,
"allow_users_enter_and_share_pronouns": true,
"webinar_registration_options": {
"allow_host_to_enable_social_share_buttons": true
}
},
"audio_conferencing": {
"toll_free_and_fee_based_toll_call": {
"enable": true,
"numbers": [
{
"code": "",
"country_code": "",
"country_name": "",
"number": "",
"display_number": ""
}
],
"allow_webinar_attendees_dial": true
},
"toll_call": {
"enable": true,
"numbers": [
{
"code": "86",
"country_code": "CN",
"country_name": "China",
"display_number": "+86 777 777 77",
"number": "777 777 77"
}
]
},
"call_me_and_invite_by_phone": {
"enable": true,
"require_press_1_for_call_me": "auto",
"call_out_countries": {
"selected_countries": [
{
"code": "CN",
"name": "China"
}
]
},
"allow_webinar_attendees_call_me": true
},
"personal_audio_conference": true,
"participant_phone_masking": {
"enable": true,
"masking_type": "mask_default"
},
"global_dial_in_countries": {
"selected_countries": [
{
"code": "CN",
"name": "China"
}
],
"include_toll_free": true
}
},
"chat": {
"allow_bots_chat": true,
"share_files": {
"enable": true,
"share_option": "account",
"view_option": "anyone",
"restrictions": {
"only_allow_specific_file_types": true,
"file_type_restrictions": [
".gz"
],
"file_type_restrictions_for_external": [
".gz"
],
"maximum_file_size": true,
"file_size_restrictions": 100,
"file_size_restrictions_for_external": 100,
"file_restrictions_apply_to": "sharing_and_viewing"
}
},
"chat_emojis": {
"enable": true,
"emojis_option": "all"
},
"record_voice_messages": true,
"record_video_messages": true,
"screen_capture": true,
"create_public_channels": true,
"create_private_channels": true,
"create_group_chat": true,
"share_links_in_chat": true,
"schedule_meetings_in_chat": true,
"set_retention_period_in_cloud": {
"enable": true,
"retention_period_of_direct_messages_and_group_conversation": "2m",
"retention_period_of_channels": "2m"
},
"set_retention_period_in_local": {
"enable": true,
"retention_period_of_direct_messages_and_group_conversation": "2m",
"retention_period_of_channels": "2m"
},
"allow_users_to_add_contacts": {
"enable": true,
"selected_option": 4,
"user_email_addresses": "123@test.com"
},
"allow_users_to_chat_with_others": {
"enable": true,
"selected_option": 4,
"user_email_addresses": "123@test.com"
},
"chat_etiquette_tool": {
"enable": true,
"policies": [
{
"description": "The policy's description",
"id": "afwef342tr2qfwrg",
"is_locked": true,
"keywords": [
"test"
],
"name": "The policy name",
"regular_expression": "^test",
"status": "activated",
"trigger_action": 1
}
],
"policy_max_count": 50
},
"send_data_to_third_party_archiving_service": {
"enable": true,
"type": "global_relay",
"smtp_delivery_address": "test@zoom.us",
"user_name": "test",
"passcode": "111111111",
"authorized_channel_token": "as1131zxwrwcssd32r4fkmaksjiajco999999999999a9qef23jr43twn4%^&IBNByeq"
},
"apply_local_storage_to_personal_channel": {
"enable": true,
"retention_period": "2m"
},
"translate_messages": true,
"search_and_send_animated_gif_images": {
"enable": true,
"giphy_content_rating": 1
},
"external_collab_restrict": {
"enable": true,
"external_chat": "allowed",
"group_id": "QSuHwTcvQoWPoG0ennkRug"
},
"external_user_control": {
"enable": true,
"selected_option": 1,
"external_account": true
},
"external_invite_approve": {
"enable": true,
"selected_option": 1,
"channel_id": "5fedbc697f8545aca465b5b114ad4275",
"external_account": true
},
"external_member_join": {
"enable": true,
"external_account": true
},
"external_join_approve": {
"enable": true,
"selected_option": 1,
"channel_id": "5fedbc697f8545aca465b5b114ad4275",
"external_account": true
},
"download_file": true,
"share_screen_in_chat": true,
"code_snippet": true,
"personal_channel": true,
"store_revise_chat": false,
"set_chat_as_default_tab": false,
"hyper_link": true,
"suppress_removal_notification": true,
"suppress_user_group_notification": false,
"allow_remove_msg_by_owner_and_admins": true,
"allow_huddles_from_channels": true,
"shared_spaces": true,
"chat_email_address": {
"enable": true,
"only_allow_specific_domains": false,
"specific_domains": [
"[\"example.com\"]"
]
},
"read_receipts": {
"enable": false,
"allow_users_opt_out": false
},
"allow_delete_message": {
"enable": true,
"time": 5
},
"allow_edit_message": {
"enable": true,
"time": 5
},
"show_status_to_internal_contact": true,
"presence_on_meeting": true,
"presence_away_when_screen_saver": false,
"show_h323_contact_tab": false,
"ai_summary": {
"enable": false,
"shown_in_team_chat": true
},
"ai_compose": {
"enable": false,
"shown_in_team_chat": true
},
"ai_recommend": false,
"ai_quick_reply": false,
"ai_sentence_completion": false,
"ai_quick_schedule": false,
"survey_poll": true
},
"meeting_security": {
"auto_security": true,
"waiting_room": true,
"waiting_room_settings": {
"participants_to_place_in_waiting_room": 0,
"whitelisted_domains_for_waiting_room": "",
"users_who_can_admit_participants_from_waiting_room": 0
},
"meeting_password": true,
"require_password_for_scheduled_meeting": true,
"pmi_password": true,
"phone_password": true,
"webinar_password": true,
"require_password_for_scheduled_webinar": true,
"meeting_password_requirement": {
"length": 1,
"have_letter": true,
"have_number": true,
"have_special_character": true,
"only_allow_numeric": true,
"have_upper_and_lower_characters": true,
"consecutive_characters_length": 0,
"weak_enhance_detection": true
},
"embed_password_in_join_link": true,
"end_to_end_encrypted_meetings": true,
"encryption_type": "enhanced_encryption",
"block_user_domain": true,
"block_user_domain_list": [
""
],
"only_authenticated_can_join_from_webclient": true,
"chat_etiquette_tool": {
"enable": false,
"policies": [
{
"id": "",
"name": "",
"description": "",
"trigger_action": 1,
"keywords": [
""
],
"regular_expression": "",
"status": "activated",
"is_locked": false
}
]
}
},
"in_session": {
"custom_data_center_regions": false,
"data_center_regions": [
"US"
],
"p2p_connetion": true,
"p2p_ports": true,
"ports_range": "1;65535",
"dscp_audio": 56,
"dscp_marking": true,
"dscp_video": 40,
"dscp_dual": false,
"subsession": true
},
"session_security": {
"approved_or_denied_countries_or_regions": {
"approved_list": [
"CX"
],
"denied_list": [
"CA"
],
"enable": true,
"method": "approve"
}
},
"mail_calendar": {
"email_calendar_management": true,
"email_management": true,
"zoom_email_provider": true
},
"general_setting": {
"auto_zoom_room_proximity_connect": true,
"show_zoom_room_feature": true
},
"h323sip_conferencing": {
"custom_welcome_audio": {
"enable": true,
"audio_file": "https://file-paa.zoom.us/bNbghCQbTYa_ml3QrsDpHQ/MS41LtClXjWRKeEPhw7xuW9bVORZ8nc-L0WtGlaitlWYw2Y7/FTxtmfjFTYS0pgQu_lo-NA"
}
},
"ai": {
"screen_share_ocr": true,
"meeting_chat_messages": true,
"full_display_names_in_ai_assets": true,
"ai_generated_virtual_backgrounds": true,
"meeting_agenda": true,
"meeting_summary_docs": {
"enable": true,
"share_with_summary_recipients": true
},
"phone_user_ai_notices": {
"enable": true,
"require_press_1_consent": true,
"multiple_notifications": true
},
"meeting_summary_retention": {
"enable": true,
"retention_days": 30
},
"meeting_summary_personal_data_redaction": {
"enable": true,
"personal_data_types": [
"NAME",
"EMAIL"
]
},
"meeting_summary_sensitive_data_filter": {
"enable": true,
"rules": [
{
"name": "Employee ID",
"regular_expression": "[0-9]{6}"
}
]
},
"meeting_coach": {
"enable": true,
"participant_scope": "participants_and_invitees_in_our_organization"
},
"third_party_meeting_join": {
"enable": true,
"allow_recording": true,
"calendar": {
"enable": true,
"join_scope": "all_events_with_video_conference_links"
},
"pre_meeting_email_notification": {
"enable": true,
"recipients": "all_invitees"
}
},
"whiteboard_content_generation": true,
"smart_recording": {
"create_recording_highlights": true,
"create_smart_chapters": true,
"create_next_steps": true
},
"task_creation_and_management": {
"enable": false,
"auto_generate_details": false,
"auto_generate_action": true,
"generate_from_transcripts": {
"enable": false,
"auto_share_with": "internal_participants",
"auto_assign_to_collaborator": true
},
"generate_from_phone_call": {
"enable": false,
"auto_add_participant_as_collaborator": true,
"auto_assign_to_collaborator": true
},
"generate_from_voicemail": false
},
"show_conversational_ai_companion": {
"enabled": true,
"enable_zoom_mate": true,
"delete_ai_conversation": true,
"delete_ai_conversation_time": 30
},
"ai_panel_in_workplace": {
"enabled": true,
"delete_ai_conversation": true,
"delete_ai_conversation_time": 30
},
"enable_ai_on_web": true,
"enable_email_compose_with_ai": true,
"microsoft_365": {
"enable": true,
"calendar_events": true,
"emails": true,
"documents": true
},
"google": {
"enable": true,
"calendar_events": true,
"emails": true,
"documents": true
},
"web_content": true,
"local_file_uploads": true,
"organization_custom_dictionaries": true,
"third_party_app_tasks": true,
"workspace_reservation_recommendations_with_ai": {
"enabled": true,
"day_recommendation": true,
"desk_recommendation": true,
"custom_workspaces_recommendation": true,
"room_recommendation": true,
"proactive_room_recommendation": true
},
"participant_can_request_aic_in_meeting": true,
"restrict_aic_when_external_user_join_meeting": true,
"restrict_users_from_joining_ai_enabled_meetings": {
"enable": true,
"join_notify": "notify_and_remove",
"apply_scope": "internal_and_external"
},
"meeting_questions": {
"enable": true,
"auto_enable": false,
"who_can_ask_questions": "org_from_join_meeting"
},
"meeting_summary": {
"enable": true,
"auto_enable": false,
"email_notification": true,
"whether_include_full_text_in_email": "include_full_text_in_email",
"restrict_share_to_outside_of_organization": true,
"restrict_summary_share": "external_users",
"who_will_receive_summary": "alt_host"
},
"meeting_summary_template": {
"enable": true,
"summary_template_id": "template_123"
},
"meeting_summary_default_language": {
"enable": true,
"language": "en-US"
},
"meeting_summary_ip_access": {
"enable": true,
"ip_addresses_or_ranges": "192.0.2.0/24"
},
"remind_me_turn_on_aic": true,
"remind_me_turn_on_catch_me_up": true,
"meeting_summary_email_only_mode": false,
"restrict_users_from_deleting_ai_companion_assets": true,
"restrict_users_from_editing_ai_companion_assets": true,
"webinar_summary_ocr": true,
"zoom_events_session_summary": {
"enable": true,
"auto_start": true
},
"zoom_events_chat_panel": true,
"zoom_events_analytics": true,
"zoom_events_chat_compose": true,
"zoom_events_email_compose": true,
"zoom_events_smart_compose": true,
"zoom_events_image_generation": true,
"zoom_events_smart_upload": true,
"zoom_events_content_generation": true,
"hub_ai_question_and_file_creation": true,
"canvas_ai_content_generation": true,
"canvas_ai_sentence_completion": true,
"canvas_ai_post_meeting_writing_tasks": true,
"paper_ai_content_generation": true,
"sheets_ai_content_generation": true,
"sheets_ai_formula": true,
"sheets_ai_function": true,
"sheets_ai_resources": true,
"slides_ai_content_generation": true,
"my_notes_meeting_transcription": true,
"my_notes_ai_content_generation": {
"enable": true,
"auto_generate_summary": true,
"auto_send_summary_email": true
},
"chat_summary": {
"enable": false,
"shown_in_team_chat": true
},
"chat_compose": {
"enable": false,
"shown_in_team_chat": true
},
"include_webinar_summary_follow_up_email": {
"enable": true,
"attendee_follow_up_email": true,
"absentee_follow_up_email": true
},
"zoom_events_content_studio": true,
"webinar_summary": {
"enable": true,
"auto_enable": false,
"email_notification": true,
"whether_include_full_text_in_email": "include_full_text_in_email",
"restrict_share_to_outside_of_organization": true,
"restrict_summary_share": "external_users",
"who_will_receive_summary": "host_and_panelist_in_organization"
},
"webinar_questions": {
"enable": true,
"auto_enable": false,
"who_can_ask_questions": "panelist_org"
}
}
}
},
"time_stamp": 1,
"old_object": {
"id": "",
"settings": {
"schedule_meeting": {
"host_video": true,
"participant_video": true,
"audio_type": "",
"join_before_host": true,
"enforce_login": true,
"enforce_login_with_domains": true,
"enforce_login_domains": "",
"not_store_meeting_topic": true,
"force_pmi_jbh_password": true,
"use_pmi_for_scheduled_meetings": true,
"pstn_password_protected": "",
"jbh_time": 0,
"personal_meeting": true,
"require_password_for_instant_meetings": true,
"mute_upon_entry": true,
"require_password_for_pmi_meetings": "jbh_only",
"use_pmi_for_instant_meetings": true,
"require_password_for_scheduling_new_meetings": true,
"pmi_password": "",
"upcoming_meeting_reminder": true,
"always_display_zoom_meeting_as_topic": {
"enable": true,
"display_topic_for_scheduled_meetings": true
},
"hide_meeting_description": {
"enable": true,
"hide_description_for_scheduled_meetings": true
},
"always_display_zoom_webinar_as_topic": {
"enable": true,
"display_topic_for_scheduled_webinars": true
},
"hide_webinar_description": {
"enable": true,
"hide_description_for_scheduled_webinars": true
}
},
"in_meeting": {
"e2e_encryption": true,
"chat": true,
"allow_users_to_delete_messages_in_meeting_chat": true,
"allow_participants_chat_with": 1,
"allow_users_save_chats": 1,
"private_chat": true,
"auto_saving_chat": true,
"file_transfer": true,
"feedback": true,
"post_meeting_feedback": true,
"co_host": true,
"polling": true,
"meeting_polling": {
"enable": true,
"advanced_polls": true,
"require_answers_to_be_anonymous": true,
"allow_alternative_host_to_add_edit": true,
"manage_saved_polls_and_quizzes": true,
"allow_host_to_upload_image": true
},
"attendee_on_hold": true,
"show_meeting_control_toolbar": true,
"allow_show_zoom_windows": true,
"annotation": true,
"whiteboard": true,
"webinar_question_answer": true,
"meeting_question_answer": true,
"anonymous_question_answer": true,
"breakout_room": true,
"breakout_room_schedule": true,
"closed_caption": true,
"far_end_camera_control": true,
"group_hd": true,
"virtual_background": true,
"watermark": true,
"watermark_by_default": true,
"audio_watermark_by_default": true,
"attention_mode_focus_mode": true,
"allow_host_to_enable_focus_mode": true,
"alert_guest_join": true,
"auto_answer": true,
"p2p_connetion": true,
"p2p_ports": true,
"ports_range": "",
"sending_default_email_invites": true,
"use_html_format_email": true,
"dscp_marking": true,
"dscp_audio": 1,
"dscp_video": 1,
"stereo_audio": true,
"original_audio": true,
"screen_sharing": true,
"remote_control": true,
"non_verbal_feedback": false,
"remote_support": false,
"custom_data_center_regions": true,
"data_center_regions": [
"AU"
],
"language_interpretation": {
"enable": true,
"enable_language_interpretation_by_default": true,
"allow_participants_to_speak_in_listening_channel": true,
"allow_up_to_25_custom_languages_when_scheduling_meetings": true,
"languages": "English",
"custom_languages": [
""
]
},
"sign_language_interpretation": {
"enable": true,
"enable_sign_language_interpretation_by_default": true,
"languages": [
"American"
],
"custom_languages": [
""
]
},
"meeting_reactions": true,
"meeting_reactions_emojis": "all",
"allow_host_panelists_to_use_audible_clap": true,
"webinar_reactions": true,
"show_a_join_from_your_browser_link": true,
"join_from_mobile": true,
"join_from_desktop": true,
"allow_live_streaming": true,
"live_streaming_facebook": true,
"workplace_by_facebook": true,
"live_streaming_youtube": true,
"custom_live_streaming_service": true,
"custom_service_instructions": "",
"webinar_live_streaming": {
"enable": true,
"live_streaming_service": [
"facebook"
],
"custom_service_instructions": "",
"live_streaming_reminder": true
},
"webinar_chat": {
"enable": true,
"allow_panelists_chat_with": 1,
"allow_attendees_chat_with": 1,
"default_attendees_chat_with": 1,
"allow_panelists_send_direct_message": true,
"allow_users_save_chats": 0,
"allow_auto_save_local_chat_file": true
},
"closed_captioning": {
"enable": true,
"third_party_captioning_service": true,
"auto_transcribing": true,
"view_full_transcript": true,
"save_caption": true
},
"slide_control": true,
"meeting_survey": true,
"webinar_polling": {
"enable": true,
"advanced_polls": true,
"require_answers_to_be_anonymous": true,
"allow_alternative_host_to_add_edit": true,
"manage_saved_polls_and_quizzes": true,
"allow_host_to_upload_image": true
},
"webinar_survey": true,
"disable_screen_sharing_for_host_meetings": true,
"disable_screen_sharing_for_in_meeting_guests": true,
"who_can_share_screen": "all",
"who_can_share_screen_when_someone_is_sharing": "host",
"participants_share_simultaneously": "multiple"
},
"email_notification": {
"cloud_recording_available_reminder": true,
"recording_available_reminder_schedulers": true,
"recording_available_reminder_alternative_hosts": true,
"jbh_reminder": true,
"cancel_meeting_reminder": true,
"low_host_count_reminder": true,
"alternative_host_reminder": true,
"schedule_for_reminder": true
},
"zoom_rooms": {
"upcoming_meeting_alert": true,
"start_airplay_manually": true,
"weekly_system_restart": true,
"list_meetings_with_calendar": true,
"zr_post_meeting_feedback": true,
"ultrasonic": true,
"force_private_meeting": true,
"hide_host_information": true,
"cmr_for_instant_meeting": true,
"auto_start_stop_scheduled_meetings": true
},
"security": {
"admin_change_name_pic": true,
"import_photos_from_devices": true,
"hide_billing_info": true,
"password_requirement": {
"minimum_password_length": 8,
"have_special_character": true,
"consecutive_characters_length": 1,
"weak_enhance_detection": true
},
"signin_with_sso": {
"enable": true,
"require_sso_for_domains": true,
"domains": [
"test.com",
"example.us"
],
"sso_bypass_users": [
{
"id": "21212_aefwef32233",
"email": "123@test.com"
}
]
}
},
"recording": {
"local_recording": true,
"cloud_recording": true,
"record_speaker_view": true,
"record_gallery_view": true,
"record_audio_file": true,
"save_chat_text": true,
"show_timestamp": true,
"recording_audio_transcript": true,
"auto_recording": "",
"cloud_recording_download": true,
"cloud_recording_download_host": true,
"account_user_access_recording": true,
"auto_delete_cmr": true,
"auto_delete_cmr_days": 30,
"record_files_separately": {
"active_speaker": true,
"gallery_view": true,
"shared_screen": true
},
"display_participant_name": true,
"recording_thumbnails": true,
"optimize_recording_for_3rd_party_video_editor": true,
"recording_highlight": true,
"smart_recording": {
"create_recording_highlights": true,
"create_smart_chapters": true,
"create_next_steps": true
},
"save_panelist_chat": true,
"save_poll_results": true,
"save_close_caption": true,
"record_audio_file_each_participant": true,
"host_pause_stop_recording": true,
"recording_disclaimer": true,
"ask_participants_to_consent_disclaimer": true,
"ask_host_to_confirm_disclaimer": true,
"recording_password_requirement": {
"length": 1,
"have_letter": true,
"have_number": true,
"have_special_character": true,
"only_allow_numeric": true
},
"ip_address_access_control": {
"enable": true,
"ip_addresses_or_ranges": ""
},
"prevent_host_access_recording": true,
"host_delete_cloud_recording": true,
"allow_recovery_deleted_cloud_recordings": true,
"archive": {
"enable": true,
"type": 1,
"settings": {
"chat_file": true,
"chat_with_sender_email": true,
"audio_file": true,
"video_file": true,
"cc_transcript_file": true,
"chat_with_direct_message": true,
"archive_retention": 1,
"action_when_archive_failed": 1,
"notification_when_archiving_starts": "participants",
"play_voice_prompt_when_archiving_starts": "participants"
}
}
},
"telephony": {
"third_party_audio": true,
"audio_conference_info": "",
"telephony_regions": {
"allowed_values": [
""
],
"selection_values": ""
}
},
"tsp": {
"call_out": true,
"call_out_countries": [
"us"
],
"allow_webinar_attendees_call_me": true,
"display_toll_free_numbers": true,
"allow_webinar_attendees_toll_free_dial": true,
"show_international_numbers_link": true,
"global_dial_in_countries": {
"selected_countries": [
{
"code": "CN",
"name": "China"
}
]
}
},
"integration": {
"google_calendar": true,
"google_drive": true,
"dropbox": true,
"box": true,
"microsoft_one_drive": true,
"kubi": true
},
"feature": {
"meeting_capacity": 1
},
"other_options": {
"allow_auto_active_users": true,
"blur_snapshot": true,
"display_meetings_scheduled_for_others": true,
"use_cdn": "none",
"allow_users_contact_support_via_chat": true,
"show_one_user_meeting_on_dashboard": true,
"meeting_qos_and_mos": 0,
"allow_users_enter_and_share_pronouns": true,
"webinar_registration_options": {
"allow_host_to_enable_social_share_buttons": true
}
},
"audio_conferencing": {
"toll_free_and_fee_based_toll_call": {
"allow_webinar_attendees_dial": true,
"enable": true,
"numbers": [
{
"code": "",
"country_code": "",
"country_name": "",
"number": "",
"display_number": ""
}
]
},
"toll_call": {
"enable": true,
"numbers": [
{
"code": "86",
"country_code": "CN",
"country_name": "China",
"display_number": "+86 777 777 77",
"number": "777 777 77"
}
]
},
"call_me_and_invite_by_phone": {
"enable": true,
"require_press_1_for_call_me": "auto",
"call_out_countries": {
"selected_countries": [
{
"code": "CN",
"name": "China"
}
]
},
"allow_webinar_attendees_call_me": true
},
"personal_audio_conference": true,
"participant_phone_masking": {
"enable": true,
"masking_type": "mask_default"
},
"global_dial_in_countries": {
"selected_countries": [
{
"code": "CN",
"name": "China"
}
],
"include_toll_free": true
}
},
"chat": {
"allow_bots_chat": true,
"share_files": {
"enable": true,
"share_option": "account",
"view_option": "anyone",
"restrictions": {
"only_allow_specific_file_types": true,
"file_type_restrictions": [
".gz"
],
"file_type_restrictions_for_external": [
".gz"
],
"maximum_file_size": true,
"file_size_restrictions": 100,
"file_size_restrictions_for_external": 100,
"file_restrictions_apply_to": "sharing_and_viewing"
}
},
"chat_emojis": {
"enable": true,
"emojis_option": "all"
},
"record_voice_messages": true,
"record_video_messages": true,
"screen_capture": true,
"create_public_channels": true,
"create_private_channels": true,
"create_group_chat": true,
"share_links_in_chat": true,
"schedule_meetings_in_chat": true,
"set_retention_period_in_cloud": {
"enable": true,
"retention_period_of_direct_messages_and_group_conversation": "2m",
"retention_period_of_channels": "2m"
},
"set_retention_period_in_local": {
"enable": true,
"retention_period_of_direct_messages_and_group_conversation": "2m",
"retention_period_of_channels": "2m"
},
"allow_users_to_add_contacts": {
"enable": true,
"selected_option": 4,
"user_email_addresses": "123@test.com"
},
"allow_users_to_chat_with_others": {
"enable": true,
"selected_option": 4,
"user_email_addresses": "123@test.com"
},
"chat_etiquette_tool": {
"enable": true,
"policies": [
{
"description": "The policy's description",
"id": "afwef342tr2qfwrg",
"is_locked": true,
"keywords": [
"test"
],
"name": "The policy name",
"regular_expression": "^test",
"status": "activated",
"trigger_action": 1
}
],
"policy_max_count": 50
},
"send_data_to_third_party_archiving_service": {
"enable": true,
"type": "global_relay",
"smtp_delivery_address": "test@zoom.us",
"user_name": "test",
"passcode": "111111111",
"authorized_channel_token": "as1131zxwrwcssd32r4fkmaksjiajco999999999999a9qef23jr43twn4%^&IBNByeq"
},
"apply_local_storage_to_personal_channel": {
"enable": true,
"retention_period": "2m"
},
"translate_messages": true,
"search_and_send_animated_gif_images": {
"enable": true,
"giphy_content_rating": 1
},
"external_collab_restrict": {
"enable": true,
"external_chat": "allowed",
"group_id": "QSuHwTcvQoWPoG0ennkRug"
},
"external_user_control": {
"enable": true,
"selected_option": 1,
"external_account": true
},
"external_invite_approve": {
"enable": true,
"selected_option": 1,
"channel_id": "5fedbc697f8545aca465b5b114ad4275",
"external_account": true
},
"external_member_join": {
"enable": true,
"external_account": true
},
"external_join_approve": {
"enable": true,
"selected_option": 1,
"channel_id": "5fedbc697f8545aca465b5b114ad4275",
"external_account": true
},
"download_file": true,
"share_screen_in_chat": true,
"code_snippet": true,
"personal_channel": true,
"store_revise_chat": false,
"set_chat_as_default_tab": false,
"hyper_link": true,
"suppress_removal_notification": true,
"suppress_user_group_notification": false,
"allow_remove_msg_by_owner_and_admins": true,
"allow_huddles_from_channels": true,
"shared_spaces": true,
"chat_email_address": {
"enable": true,
"only_allow_specific_domains": false,
"specific_domains": [
"[\"example.com\"]"
]
},
"read_receipts": {
"enable": false,
"allow_users_opt_out": false
},
"allow_delete_message": {
"enable": true,
"time": 5
},
"allow_edit_message": {
"enable": true,
"time": 5
},
"show_status_to_internal_contact": true,
"presence_on_meeting": true,
"presence_away_when_screen_saver": false,
"show_h323_contact_tab": false,
"ai_summary": {
"enable": false,
"shown_in_team_chat": true
},
"ai_compose": {
"enable": false,
"shown_in_team_chat": true
},
"ai_recommend": false,
"ai_quick_reply": false,
"ai_sentence_completion": false,
"ai_quick_schedule": false,
"survey_poll": true
},
"meeting_security": {
"auto_security": true,
"waiting_room": true,
"waiting_room_settings": {
"participants_to_place_in_waiting_room": 0,
"whitelisted_domains_for_waiting_room": "",
"users_who_can_admit_participants_from_waiting_room": 0
},
"meeting_password": true,
"require_password_for_scheduled_meeting": true,
"pmi_password": true,
"phone_password": true,
"webinar_password": true,
"require_password_for_scheduled_webinar": true,
"meeting_password_requirement": {
"length": 1,
"have_letter": true,
"have_number": true,
"have_special_character": true,
"only_allow_numeric": true,
"have_upper_and_lower_characters": true,
"consecutive_characters_length": 0,
"weak_enhance_detection": true
},
"embed_password_in_join_link": true,
"end_to_end_encrypted_meetings": true,
"encryption_type": "enhanced_encryption",
"block_user_domain": true,
"block_user_domain_list": [
""
],
"only_authenticated_can_join_from_webclient": true,
"chat_etiquette_tool": {
"enable": false,
"policies": [
{
"id": "",
"name": "",
"description": "",
"trigger_action": 1,
"keywords": [
""
],
"regular_expression": "",
"status": "activated",
"is_locked": false
}
]
}
},
"in_session": {
"custom_data_center_regions": false,
"data_center_regions": [
"US"
],
"p2p_connetion": true,
"p2p_ports": true,
"ports_range": "1;65535",
"dscp_audio": 56,
"dscp_marking": true,
"dscp_video": 40,
"dscp_dual": false,
"subsession": true
},
"session_security": {
"approved_or_denied_countries_or_regions": {
"approved_list": [
"CX"
],
"denied_list": [
"CA"
],
"enable": true,
"method": "approve"
}
},
"mail_calendar": {
"email_calendar_management": true,
"email_management": true,
"zoom_email_provider": true
},
"general_setting": {
"auto_zoom_room_proximity_connect": true,
"show_zoom_room_feature": true
},
"h323sip_conferencing": {
"custom_welcome_audio": {
"enable": true,
"audio_file": "https://file-paa.zoom.us/bNbghCQbTYa_ml3QrsDpHQ/MS41LtClXjWRKeEPhw7xuW9bVORZ8nc-L0WtGlaitlWYw2Y7/FTxtmfjFTYS0pgQu_lo-NA"
}
},
"ai": {
"screen_share_ocr": true,
"meeting_chat_messages": true,
"full_display_names_in_ai_assets": true,
"ai_generated_virtual_backgrounds": true,
"meeting_agenda": true,
"meeting_summary_docs": {
"enable": true,
"share_with_summary_recipients": true
},
"phone_user_ai_notices": {
"enable": true,
"require_press_1_consent": true,
"multiple_notifications": true
},
"meeting_summary_retention": {
"enable": true,
"retention_days": 30
},
"meeting_summary_personal_data_redaction": {
"enable": true,
"personal_data_types": [
"NAME",
"EMAIL"
]
},
"meeting_summary_sensitive_data_filter": {
"enable": true,
"rules": [
{
"name": "Employee ID",
"regular_expression": "[0-9]{6}"
}
]
},
"meeting_coach": {
"enable": true,
"participant_scope": "participants_and_invitees_in_our_organization"
},
"third_party_meeting_join": {
"enable": true,
"allow_recording": true,
"calendar": {
"enable": true,
"join_scope": "all_events_with_video_conference_links"
},
"pre_meeting_email_notification": {
"enable": true,
"recipients": "all_invitees"
}
},
"whiteboard_content_generation": true,
"smart_recording": {
"create_recording_highlights": true,
"create_smart_chapters": true,
"create_next_steps": true
},
"task_creation_and_management": {
"enable": false,
"auto_generate_details": false,
"auto_generate_action": true,
"generate_from_transcripts": {
"enable": false,
"auto_share_with": "internal_participants",
"auto_assign_to_collaborator": true
},
"generate_from_phone_call": {
"enable": false,
"auto_add_participant_as_collaborator": true,
"auto_assign_to_collaborator": true
},
"generate_from_voicemail": false
},
"show_conversational_ai_companion": {
"enabled": true,
"enable_zoom_mate": true,
"delete_ai_conversation": true,
"delete_ai_conversation_time": 30
},
"ai_panel_in_workplace": {
"enabled": true,
"delete_ai_conversation": true,
"delete_ai_conversation_time": 30
},
"enable_ai_on_web": true,
"enable_email_compose_with_ai": true,
"microsoft_365": {
"enable": true,
"calendar_events": true,
"emails": true,
"documents": true
},
"google": {
"enable": true,
"calendar_events": true,
"emails": true,
"documents": true
},
"web_content": true,
"local_file_uploads": true,
"organization_custom_dictionaries": true,
"third_party_app_tasks": true,
"workspace_reservation_recommendations_with_ai": {
"enabled": true,
"day_recommendation": true,
"desk_recommendation": true,
"custom_workspaces_recommendation": true,
"room_recommendation": true,
"proactive_room_recommendation": true
},
"participant_can_request_aic_in_meeting": true,
"restrict_aic_when_external_user_join_meeting": true,
"restrict_users_from_joining_ai_enabled_meetings": {
"enable": true,
"join_notify": "notify_and_remove",
"apply_scope": "internal_and_external"
},
"meeting_questions": {
"enable": true,
"auto_enable": false,
"who_can_ask_questions": "org_from_join_meeting"
},
"meeting_summary": {
"enable": true,
"auto_enable": false,
"email_notification": true,
"whether_include_full_text_in_email": "include_full_text_in_email",
"restrict_share_to_outside_of_organization": true,
"restrict_summary_share": "external_users",
"who_will_receive_summary": "alt_host"
},
"meeting_summary_template": {
"enable": true,
"summary_template_id": "template_123"
},
"meeting_summary_default_language": {
"enable": true,
"language": "en-US"
},
"meeting_summary_ip_access": {
"enable": true,
"ip_addresses_or_ranges": "192.0.2.0/24"
},
"remind_me_turn_on_aic": true,
"remind_me_turn_on_catch_me_up": true,
"meeting_summary_email_only_mode": false,
"restrict_users_from_deleting_ai_companion_assets": true,
"restrict_users_from_editing_ai_companion_assets": true,
"webinar_summary_ocr": true,
"zoom_events_session_summary": {
"enable": true,
"auto_start": true
},
"zoom_events_chat_panel": true,
"zoom_events_analytics": true,
"zoom_events_chat_compose": true,
"zoom_events_email_compose": true,
"zoom_events_smart_compose": true,
"zoom_events_image_generation": true,
"zoom_events_smart_upload": true,
"zoom_events_content_generation": true,
"chat_summary": {
"enable": false,
"shown_in_team_chat": true
},
"chat_compose": {
"enable": false,
"shown_in_team_chat": true
},
"include_webinar_summary_follow_up_email": {
"enable": true,
"attendee_follow_up_email": true,
"absentee_follow_up_email": true
},
"zoom_events_content_studio": true,
"webinar_summary": {
"enable": true,
"auto_enable": false,
"email_notification": true,
"whether_include_full_text_in_email": "include_full_text_in_email",
"restrict_share_to_outside_of_organization": true,
"restrict_summary_share": "external_users",
"who_will_receive_summary": "host_and_panelist_in_organization"
},
"webinar_questions": {
"enable": true,
"auto_enable": false,
"who_can_ask_questions": "panelist_org"
}
}
}
}
}
}
```