Accounts

• OpenAPI Version: 3.1.1
• API Version: 2

The Zoom Account APIs allow developers to programatically access data related to accounts, dashboards, information barriers, and roles.

Servers

• URL: https://api.zoom.us/v2

Operations

List sub accounts

• Method: GET
• Path: /accounts
• Tags: Accounts

List all subaccounts created by a master account.

Zoom allows only approved partners to use master APIs and manage subaccounts. Email the partner programs team at partner-success@zoom.us for more details.

Prerequisites:

• Pro or a higher paid account with master account option enabled.

Scopes: account:master

Granular Scopes: account:read:list_sub_accounts:master

Rate Limit Label: MEDIUM

Responses

Status: 200 Account list returned.

Content-Type: application/json

All of:

• next_page_token

  string — Use the next page token to paginate through large result sets. A next page token is returned whenever the set of available results exceeds the current page size. This token's expiration period is 15 minutes.

• page_count

  integer — The number of pages returned for the request made.

• page_number

  integer, default: 1 — **Deprecated** We will no longer support this field in a future release. Instead, use the `next_page_token` for pagination.

• page_size

  integer, default: 30 — The number of records returned with a single API call.

• total_records

  integer — The total number of all the records available across pages.

• accounts

  array — List of account objects.

  Items:

  • account_name

    string — Account name.

  • account_number

    number — The account's account number.

  • account_type

    string — Account type.

  • bulk_license

    boolean — Indicates whether or not the account has bulk license.

  • created_at

    string, format: date-time — Account creation date and time.

  • id

    string — Account ID.

  • owner_email

    string — Account owner email.

  • reseller

    boolean — Indicates whether or not the account is a sub-reseller.

  • seats

    integer — Account seats.

  • subscription_end_time

    string, format: date-time — Account subscription end date and time.

  • subscription_start_time

    string, format: date-time — Account subscription start date and time.

Example:

{
  "next_page_token": "w7587w4eiyfsudgf",
  "page_count": 1,
  "page_size": 30,
  "total_records": 20,
  "accounts": [
    {
      "account_name": "jchill",
      "account_number": 10010370036,
      "account_type": "Free",
      "created_at": "2022-03-24T17:46:53Z",
      "id": "q6gBJVO5TzexKYTb_I2rpg",
      "owner_email": "john.doe@zoom.us",
      "seats": 0,
      "subscription_end_time": "2022-03-24T17:46:53Z",
      "subscription_start_time": "2022-03-24T17:46:53Z",
      "reseller": true,
      "bulk_license": true
    }
  ]
}

Status: 429 **HTTP Status Code:** `429` <br> Too Many Requests. For more information, see [rate limits](https://developers.zoom.us/docs/api/rest/rate-limits/).

Create a sub account

• Method: POST
• Path: /accounts
• Tags: Accounts

Create a subaccount under a master account. The new subaccount will receive a confirmation email.

Zoom only allows only approved partners to use master account APIs and manage subaccounts. For more information, contact the Zoom Partners team at partner-success@zoom.us.

Prerequisites:

• A Pro or a higher paid account with master account option enabled.

Scopes: account:master

Granular Scopes: account:write:sub_account:master

Rate Limit Label: LIGHT

Request Body

Content-Type: application/json

• email (required)

  string — The user's email address.

• first_name (required)

  string — The user's first name.

• last_name (required)

  string — The user's last name.

• password (required)

  string — The subaccount's password. **Note:** If the account owner or admin has enabled [enhanced password requirements](https://support.zoom.us/hc/en-us/articles/360034675592-Advanced-security-settings#h_fa9186e4-6818-4f7a-915c-2e25c19f0acd), the value provided in this field must meet those requirements. You can get these requirements via the [**Get account settings**](/docs/api-reference/zoom-api/ma#operation/accountSettings) API. Reference the `password_requirement` object in the `security` object of the API response.

• account_name

  string — The subaccount's name. If you do not pass this value, the account name will be a concatenation of the `first_name` and `last_name` parameters.

• options

  object — Information about the account's options.

  • billing_auto_renew

    boolean — Whether to enable automatic billing renewal.

  • meeting_connector_list

    array — A comma-separated list of Meeting Connector IP addresses shared with the subaccount. If you do not provide a value for this field, all the master account's Meeting Connectors will be shared with the subaccount. **Note:** You can only use this field if `share_mc` value is `true`.

    Items:

    string

  • pay_mode

    string, possible values: "master", "sub", default: "master" — The account's payee. * `master` - The master account holder pays. * `sub` - The subaccount holder pays. This value defaults to `master`.

  • resource_meeting_connector_list

    array — A comma-separated list of Meeting Connector resource name shared with the subaccount. If you do not provide a value for this field, all of the master account's meeting connector will be shared with the subaccount.

    Items:

    string

  • resource_meeting_hybrid_list

    array — A comma-separated list of Meeting Hybrid zone name shared with the subaccount. If you do not provide a value for this field, all the master account's Meeting Connectors will be shared with the subaccount. .

    Items:

    string

  • resource_share_mc

    boolean, default: false — Whether to enable the option for a subaccount to use the master account's shared resource Meeting Connectors.Meeting Connectors are only available for On-Premise accounts. This value defaults to `false`.

  • resource_share_mh

    boolean, default: false — Whether to enable the option for a subaccount to use the master account's shared resource Meeting Hybrid. Meeting Hybrid are only available for On-premise accounts. This value defaults to `false`.

  • room_connector_list

    array — A comma-separated list of VRC IP addresses shared with the subaccount. If you do not provide a value for this field, all of the master account's VRCs will be shared with the subaccount. **Note:** You can only use this field if `share_rc` value is `true`.

    Items:

    string

  • share_mc

    boolean, default: false — Whether to enable the option for a subaccount to use the master account's shared [Meeting Connectors](https://support.zoom.us/hc/en-us/articles/201363093). Meeting Connectors are only available for On-Premise accounts. This value defaults to `false`.

  • share_rc

    boolean, default: false — Whether to enable the option for a subaccount to use the master account's shared [Virtual Room Connectors (VRC)](https://support.zoom.us/hc/en-us/articles/202134758-Deploying-the-Virtual-Room-Connector). VRCs are only available for On-premise accounts. This value defaults to `false`.

• sub_reseller_id

  string — The sub-reseller's ID. To create a [third-tier subaccount](https://marketplace.zoom.us/docs/api-reference/master-account-apis/), pass the second-level master account's ID. If you do not provide this field, a new subaccount will be created for the account that calls the API.

• transfer_code

  string — Account transfer code to transfer account to current parenter

Example:

{
  "account_name": "jchill",
  "email": "jchill@example.com",
  "first_name": "Jill",
  "last_name": "Chill",
  "options": {
    "meeting_connector_list": [
      "203.0.113.1"
    ],
    "resource_meeting_hybrid_list": [
      "meeting_hybrid_resouceA"
    ],
    "resource_meeting_connector_list": [
      "meeting_connector_resourceA"
    ],
    "resource_share_mc": false,
    "resource_share_mh": false,
    "pay_mode": "master",
    "room_connector_list": [
      "[\"192.0.2.1\",\"198.51.100.1\"]"
    ],
    "share_mc": false,
    "share_rc": false
  },
  "password": "if42!LfH@",
  "sub_reseller_id": "ABCDEF12345",
  "transfer_code": "AIr7emjkNxUD4O5Q73H-Jr8ZmVGHMOsSAOps9B6-bB4.AG.hCTluR6maAXj8CZ9Bs7xm1eDfqT5Lct4WczDkqIahVK7BdMfR8Ps7_JDRtfZr-6Hci7IOyDVCc_5xTkdVrdl50NNgfZcl4NflffxgoYNMQ34Sr_vKYGvJ3eNmnv2i-qp7c24c1b6lU3APJqtxwKkm8CKmc7iyu6WlcLLILSgAlDifo4SjBVfiSC-.z_WNrlV6aXoeWpc7pKJnfA.50Jl_yAYazRkzoVR"
}

Responses

Status: 201 Account successfully created.

Content-Type: application/json

• created_at

  string, format: date-time — The subaccount's creation date and time.

• id

  string — The subaccount's ID.

• owner_email

  string, format: email — The subaccount owner's email address.

• owner_id

  string — The account owner's ID.

Example:

{
  "created_at": "2021-07-21T17:32:28Z",
  "id": "NfIX2NPgQ-mLjHOybvftuv",
  "owner_email": "admin@example.com",
  "owner_id": "tsmith@example.com"
}

Status: 400 **HTTP Status Code:** `400` <br> Bad Request **Error Code:** `300` <br> * Your request could not be completed because the name contains an invalid word: {name} * Your request was not accepted because "{field}" contains special character(s). <br> **Error Code:** `1107` <br> Email domain is blocked. <br> **Error Code:** `1111` <br> * Password should not contain repeated characters such as "aaaaaa". * Password should not contain consecutive characters such as "abc" or "123". <br> **Error Code:** `11101` <br> Account transfer disabled. Please remove the transfer token and try again. <br> **Error Code:** `11102` <br> Invalid account transfer token. <br> **Error Code:** `11103` <br> User email does not exist. <br> **Error Code:** `11104` <br> Account transfer email and request body email do not match. Please try again. <br> **Error Code:** `11105` <br> Account transfer token expired. <br> **Error Code:** `11106` <br> Account transfer token and master Zoom account number do not match. <br> **Error Code:** `11107` <br> Account transfer token already used. <br> **Error Code:** `11108` <br> Account transfer is only available for free users. <br> **Error Code:** `11109` <br> Account transfer is still processing in the backend. Please try again later. <br> **Error Code:** `11110` <br> Account already exists. <br> **Error Code:** `11111` <br> Account transfer does not support subaccounts. <br> **Error Code:** `11112` <br> Account transfer only supports free accounts. <br>

Status: 409 **HTTP Status Code:** `409` <br> Conflict **Error Code:** `1005` <br> Email "$email" has already been used. <br>

Status: 429 **HTTP Status Code:** `429` <br> Too Many Requests. For more information, see [rate limits](https://developers.zoom.us/docs/api/rest/rate-limits/).

Get sub account details

• Method: GET
• Path: /accounts/{accountId}
• Tags: Accounts

Retrieve information about a master account's sub account.

Zoom only allows approved partners to use master account APIs and create sub accounts. For information about partner programs, email the partners team at partner-success@zoom.us.

• To get a master account's details, use the account:read:sub_account:admin scope. Enter me as the value of the accountId path parameter.
• To get a subaccount's details, use use the account:read:sub_account:master scope. Enter the subaccount's actual account ID as the value of the accountId path parameter.

Prerequisites

• A Pro or a higher paid account with the Master account option enabled.

Scopes: account:master

Granular Scopes: account:read:sub_account:master,account:read:sub_account:admin

Rate Limit Label: LIGHT

Responses

Status: 200 **HTTP Status Code**: `200` Account object returned.

Content-Type: application/json

• account_name

  string — The account's name.

• account_number

  integer — The account's account number.

• account_type

  string, possible values: "Free", "Pro", "Enterprise", "API Partner", "Education", "Business", "Free Trial", "Bulk License", "Zoom Rooms", "Zoom Video SDK", "Zoom Phone" — The account type. * `Free` * `Pro` * `Enterprise` * `API Partner` * `Education` * `Business` * `Free Trial` * `Bulk License` * `Zoom Rooms` * `Zoom Video SDK` * `Zoom Phone`

• created_at

  string, format: date-time — The account's creation date and time.

• id

  string — The account ID.

• options

  object — Information about the account's options.

  • billing_auto_renew

    boolean — Whether to enable automatic billing renewal.

  • meeting_connector_list

    array — A comma-separated list of Meeting Connector IP addresses shared with the sub account. If you do not provide a value for this field, all of the master account's meeting connectors will be shared with the sub account. **Note:** You can only use this field if `share_mc` value is `true`.

    Items:

    string

  • pay_mode

    string, possible values: "master", "sub", default: "master" — The account's payee. * `master` - The Master account holder pays. * `sub` - The sub account holder pays. This value defaults to `master`.

  • resource_meeting_connector_list

    array — A comma-separated list of Meeting Connector resourece name shared with the subaccount. If you do not provide a value for this field, all of the master account's meeting connector will be shared with the subaccount.

    Items:

    string

  • resource_meeting_hybrid_list

    array — A comma-separated list of Meeting Hybrid zone name shared with the subaccount. If you do not provide a value for this field, all the master account's Meeting Connectors will be shared with the subaccount. .

    Items:

    string

  • resource_share_mc

    boolean, default: false — Whether to enable the option for a sub account to use the master account's shared resource Meeting Connectors. Meeting Connectors are only available for On-Premise accounts. This value defaults to `false`.

  • resource_share_mh

    boolean, default: false — Whether to enable the option for a sub account to use the master account's shared resource Meeting Hybrid. Meeting Hybrid are only available for On-premise accounts. This value defaults to `false`.

  • room_connector_list

    array — A comma-separated list of VRC IP addresses shared with the sub account. If you do not provide a value for this field, all of the master account's VRCs will be shared with the sub account. **Note:** You can only use this field if `share_rc` value is `true`.

    Items:

    string

  • share_mc

    boolean, default: false — Whether to enable the option for a sub account to use the master account's shared [Meeting Connectors](https://support.zoom.us/hc/en-us/articles/201363093). Meeting Connectors are only available for On-Premise accounts. This value defaults to `false`.

  • share_rc

    boolean, default: false — Whether to enable the option for a sub account to use the master account's shared [Virtual Room Connectors (VRC)](https://support.zoom.us/hc/en-us/articles/202134758-Deploying-the-Virtual-Room-Connector). VRCs are only available for On-premise accounts. This value defaults to `false`.

• owner_email

  string, format: email — The account owner's email address.

• owner_id

  string — The account owner ID.

• reseller

  boolean — The account is reseller or not.

• seats

  integer — The account's maximum number of paid seats.

• subscription_end_time

  string, format: date-time — The account's subscription end date and time. This field only returns if there is a subscription end date and time.

• subscription_start_time

  string, format: date-time — The account's subscription start date and time. If there is no subscription start date and time, this returns an empty string value.

• vanity_url

  string, format: url — The account's [vanity URL](https://support.zoom.us/hc/en-us/articles/201363233-Customizing-branding-for-your-vanity-URL).

Example:

{
  "account_name": "Account1",
  "account_number": 123456789,
  "account_type": "Pro",
  "created_at": "2021-07-21T17:32:28Z",
  "id": "ABCDEF123456",
  "options": {
    "billing_auto_renew": false,
    "meeting_connector_list": [
      "203.0.113.1"
    ],
    "pay_mode": "master",
    "room_connector_list": [
      "[\"192.0.2.1\",\"198.51.100.1\"]"
    ],
    "share_mc": false,
    "share_rc": false,
    "resource_meeting_hybrid_list": [
      "meeting_hybrid_resouceA"
    ],
    "resource_meeting_connector_list": [
      "meeting_connector_resourceA"
    ],
    "resource_share_mc": false,
    "resource_share_mh": false
  },
  "owner_email": "jchill@example.com",
  "owner_id": "654321FEDCBA",
  "seats": 1,
  "subscription_end_time": "2022-07-21T17:32:28Z",
  "subscription_start_time": "2021-07-21T17:32:28Z",
  "vanity_url": "https://vanity.example.com",
  "reseller": false
}

Status: 404 **HTTP Status Code:** `404` <br> Not Found **Error Code:** `2001` <br> Account does not exist: $subAccountId <br>

Status: 429 **HTTP Status Code:** `429` <br> Too Many Requests. For more information, see [rate limits](https://developers.zoom.us/docs/api/rest/rate-limits/).

Disassociate a sub account

• Method: DELETE
• Path: /accounts/{accountId}
• Tags: Accounts

Disassociate a sub account from its master account. This leaves the sub account intact, but it will no longer be associated with the master account.

Prerequisites

• Pro or a higher paid account with master account option enabled.

• The account making this API request must be a master account.

Scopes: account:master,account:write:master

Granular Scopes: account:delete:sub_account:master

Rate Limit Label: LIGHT

Responses

Status: 204 **HTTP Status Code**: `204` Account deleted.

Status: 404 **HTTP Status Code:** `404` <br> Not Found **Error Code:** `2000` <br> You cannot disassociate a paid account. <br> <br> **Error Code:** `2001` <br> Account does not exist: $subAccountId. <br>

Status: 429 **HTTP Status Code:** `429` <br> Too Many Requests. For more information, see [rate limits](https://developers.zoom.us/docs/api/rest/rate-limits/).

Get locked settings

• Method: GET
• Path: /accounts/{accountId}/lock_settings
• Tags: Accounts

Retrieves an account's locked settings.

Account admins and account owners can use Account Locked Settings to toggle settings on or off for all users in their account.

Note: You can use Account Locked Settings with accounts that have master and sub accounts enabled.

Prerequisites:

• Pro or a higher paid account.

Scopes: account:read:admin,account:write:admin

Granular Scopes: account:read:lock_settings:master

Rate Limit Label: MEDIUM

Responses

Status: 200 **Error Code:** `200` Only available for paid account:$accountId. **HTTP Status Code:** `200` Locked settings for the Account returned.

Content-Type: application/json

One of:

• 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 using only pre-selected emojis. If the setting is disabled, users can still use keyboard shortcuts to add emojis. Users can change their emoji skin tone in Settings.

  • 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 — 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.

  • set_retention_period_in_local

    boolean — Specify how long your messages are saved on local devices. If this setting is disabled, messages are never deleted locally.

  • 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.

• 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.

  • entry_exit_chime

    string — Play sound when participants join or leave.

  • 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 in Meeting. 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_group_hd

    boolean — Enable higher quality video for host and participants in Webinar. This will require more bandwidth.

  • 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.

• 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.

  • prevent_host_access_recording

    boolean — If set to `true`, meeting hosts cannot view their meeting cloud recordings. Only the admins who have recording management privilege can access them.

  • 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 &quot;Zoom Webinar&quot; 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.

  • continuous_meeting_chat

    boolean — Whether to enable the [**Enable continuous meeting chat**] setting.

  • embed_password_in_join_link

    boolean — If the value is set to `true`, the meeting passcode will be encrypted and included in the join meeting link to allow participants to join with just one click without having to enter the passcode.

  • enforce_login

    boolean — Allow only signed-in users to join meetings.

  • enforce_login_domains

    string — Specify the domains from which users can join a meeting.

  • 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

  • not_store_meeting_topic

    boolean — Whether to enable the [**Always display &quot;Zoom Meeting&quot; as the meeting topic**](https://support.zoom.us/hc/en-us/articles/201363253-Changing-account-settings#h_01EG9BJ646V2WJK1S3H2MP6YV6) setting.

  • participant_video

    boolean — Start meetings with participant video on.

  • require_password_for_instant_meetings

    boolean — Require passcode for instant meetings. If you use a PMI for your instant meetings, this option will be disabled. This setting is always enabled for free accounts and Pro accounts with a single host and cannot be modified for these accounts.

  • require_password_for_pmi_meetings

    boolean — Require participants to enter passcode for PMI meetings. This setting is always enabled for free accounts and Pro accounts with a single host and cannot be modified for these accounts.

  • require_password_for_scheduling_new_meetings

    boolean — This setting applies for regular meetings that do not use a PMI. If enabled, a passcode will be generated while a host schedules a new meeting and participants will be required to enter the passcode before they can join the meeting. This setting is always enabled for free accounts and Pro accounts with a single host and cannot be modified for these accounts.

  • 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

  • display_toll_free_numbers

    boolean — Display toll-free numbers

  • show_international_numbers_link

    boolean — Show international numbers link on the invitation email

• 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 passcode is encrypted and included in the invitation link. The provided link will allow participants to join the meeting without having to enter the passcode.

  • 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 passcode-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 passcodes are required for participants joining by phone. If enabled and the meeting is passcode-protected, a numeric passcode is required for participants to join by phone. For meetings with alphanumeric passcodes, a numeric passcode will be generated.

  • pmi_password

    boolean — Whether all Personal Meeting ID (PMI) meetings that users can join via client or Zoom Rooms systems are passcode-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 passcode when scheduling webinars. Participants must use the generated passcode to join the scheduled webinar.

Example:

{
  "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,
    "set_retention_period_in_cloud": true,
    "set_retention_period_in_local": 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,
    "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
  },
  "email_notification": {
    "alternative_host_reminder": true,
    "cancel_meeting_reminder": true,
    "cloud_recording_available_reminder": true,
    "jbh_reminder": true,
    "schedule_for_reminder": true
  },
  "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,
    "meeting_question_answer": 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,
    "entry_exit_chime": "none",
    "far_end_camera_control": true,
    "feedback": true,
    "file_transfer": true,
    "full_transcript": true,
    "group_hd": true,
    "webinar_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,
    "webinar_survey": true,
    "whiteboard": true
  },
  "other_options": {
    "blur_snapshot": true,
    "webinar_registration_options": 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,
    "prevent_host_access_recording": true,
    "recording_authentication": true,
    "archive": true
  },
  "schedule_meeting": {
    "audio_type": true,
    "embed_password_in_join_link": true,
    "enforce_login": true,
    "enforce_login_domains": "example.com",
    "enforce_login_with_domains": true,
    "host_video": true,
    "join_before_host": true,
    "meeting_authentication": true,
    "not_store_meeting_topic": true,
    "always_display_zoom_webinar_as_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,
    "continuous_meeting_chat": true
  },
  "telephony": {
    "telephony_regions": true,
    "third_party_audio": true
  },
  "tsp": {
    "call_out": true,
    "show_international_numbers_link": true,
    "display_toll_free_numbers": true
  }
}

Status: 400 **HTTP Status Code:** `400` <br> Bad Request **Error Code:** `2001` <br> Account does not exist: $subAccountId. <br>

Status: 429 **HTTP Status Code:** `429` <br> Too Many Requests. For more information, see [rate limits](https://developers.zoom.us/docs/api/rest/rate-limits/).

Update locked settings

• Method: PATCH
• Path: /accounts/{accountId}/lock_settings
• Tags: Accounts

Updates an account's locked settings.

Account Locked Settings allows account admins and account owners to toggle settings on or off for all users in your account.

Note: Yout must have a Pro or a higher plan and enabled master and sub accounts options.

Prerequisites:

• Pro or a higher paid account.

Scopes: account:write:admin

Granular Scopes: account:update:lock_settings:master

Rate Limit Label: MEDIUM

Request Body

Content-Type: application/json

One of:

• audio_conferencing

  object

  • 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 allowing only pre-selected emojis. If the setting is disabled, users can still use keyboard shortcuts to add emojis. Users can change their emoji skin tone in **Settings**.

  • chat_etiquette_tool

    boolean — Whether to enable the **Chat Etiquette Tool**.

  • download_file

    boolean — Whether to allow users to download 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 — 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.

  • set_retention_period_in_local

    boolean — Specify how long your messages are saved on local devices. If this setting is disabled, messages are never deleted locally.

  • 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.

• 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 — 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.

  • 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 — If set to `true`, account owners and admins on paid accounts can [select data center regions](https://support.zoom.us/hc/en-us/articles/360042411451-Selecting-data-center-regions-for-hosted-meetings-and-webinars) to use for hosting their real-time meeting and webinar traffic. These regions can be provided in the `data_center_regions` field in the account settings. If set to `false`, the regions cannot be customized and the default regions will be used.

  • 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 — Allow users to select stereo audio during a meeting.

  • e2e_encryption

    boolean — Require that all meetings are encrypted using AES.

  • entry_exit_chime

    string — Play sound when participants join or leave.

  • 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 to enable the viewing of full transcripts in the in-meeting side panel.

  • group_hd

    boolean — Enable higher quality video for host and participants in Meeting. This will require more bandwidth.

  • language_interpretation

    boolean — Whether to allow hosts to assign participants as interpreters who can interpret one language into another in real-time.

  • meeting_question_answer

    boolean — Allow participants to ask questions for the host and participants to answer.

  • 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 — 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 to allow participants to save closed captions or transcripts.

  • save_captions

    boolean — Whether to allow participants to [save closed captions 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_group_hd

    boolean — Enable higher quality video for host and participants in Webinar. This will require more bandwidth.

  • webinar_live_streaming

    boolean — Whether to enable webinar livestreaming.

  • webinar_polling

    boolean — Whether to allow the host to 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 to allow the host to present surveys to attendees once a webinar has ended.

  • whiteboard

    boolean — Allow participants to share a whiteboard that includes annotation tools.

• 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.

  • prevent_host_access_recording

    boolean — If set to `true`, meeting hosts cannot view their meeting cloud recordings. Only the admins who have recording management privilege can access them.

  • recording_authentication

    boolean

• schedule_meeting

  object

  • always_display_zoom_webinar_as_topic

    boolean — Whether to enable the [**Always show &quot;Zoom Webinar&quot; as the webinar topic**](https://support.zoom.us/hc/en-us/articles/201363253-Changing-account-settings#h_01EG9BJ646V2WJK1S3H2MP6YV6) setting.

  • audio_type

    boolean — Determine how participants can join the audio portion of the meeting.

  • continuous_meeting_chat

    boolean — Whether to enable the [**Enable continuous meeting chat**] setting.

  • embed_password_in_join_link

    boolean — If the value is set to `true`, the meeting passcode will be encrypted and included in the join meeting link to allow participants to join with just one click without having to enter the passcode.

  • enforce_login

    boolean — Participants must always sign in before joining the scheduled meeting.

  • enforce_login_domains

    string — Specify the domains from which users can join a meeting.

  • 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

  • not_store_meeting_topic

    boolean — Whether to enable the [**Always display &quot;Zoom Meeting&quot; as the meeting topic**](https://support.zoom.us/hc/en-us/articles/201363253-Changing-account-settings#h_01EG9BJ646V2WJK1S3H2MP6YV6) setting.

  • participant_video

    boolean — Start meetings with participant video on.

  • personal_meeting

    boolean — Turn the lock setting on or off for the **Enable Personal Meeting ID** setting for an entire account. `true`: Turn the **&quot;Enable Personal Meeting ID&quot;** setting **on** for all users in the account. Users can choose to use personal meeting ID for their meetings. `false`: Turn **off** the **&quot;Enable Personal Meeting ID&quot;** setting. **If this setting is [disabled](https://support.zoom.us/hc/en-us/articles/201362843-Personal-meeting-ID-PMI-and-personal-link?flash_digest=eb7ac62d8c7fb4daf285916e3e15d87537806133#h_aa0335c8-3b06-41bc-bc1f-a8b84ef17f2a), meetings that were scheduled with a PMI by the users in the account will be invalid. Users will have to update previously scheduled PMI meetings.** For Zoom Phone only: If a user has been assigned a desk phone, **&quot;Elevate to Zoom Meeting&quot;** on desk phone will be disabled.

  • require_password_for_instant_meetings

    boolean — Require passcode for instant meetings. If you use a PMI for your instant meetings, this option will be disabled. This setting is always enabled for free accounts and Pro accounts with a single host and cannot be modified for these accounts.

  • require_password_for_pmi_meetings

    boolean — Require participants to enter passcode for PMI meetings. This setting is always enabled for free accounts and Pro accounts with a single host and cannot be modified for these accounts.

  • require_password_for_scheduling_new_meetings

    boolean — This setting applies for regular meetings that do not use a PMI. If enabled, a passcode will be generated while a host schedules a new meeting and participants will be required to enter the passcode before they can join the meeting. This setting is always enabled for free accounts and Pro accounts with a single host and cannot be modified for these accounts.

  • 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

  • telephony_regions

    boolean

  • third_party_audio

    boolean — Allow users to join the meeting using the existing 3rd party audio configuration.

• tsp

  object

  • call_out

    boolean — Call Out

  • show_international_numbers_link

    boolean — Show international numbers link on the invitation email

• 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 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.

  • chat_etiquette_tool

    boolean — Whether to enable the **Chat Etiquette Tool**.

  • embed_password_in_join_link

    boolean — Whether the meeting passcode will be encrypted and included in the invitation link. The provided link will allow participants to join the meeting without having to enter the passcode.

  • encryption_type

    string, possible values: "enhanced_encryption", "e2ee" — The type of encryption to use when starting a meeting: * `enhanced_encryption` &mdash; Use enhanced encryption. Encryption data is stored in the cloud. * `e2ee` &mdash; End-to-end encryption. The encryption key is stored on the local device and cannot be obtained by anyone else. Enabling E2EE also [**disables** certain features](https://support.zoom.us/hc/en-us/articles/360048660871), such as cloud recording, live streaming, and allowing participants to join before the host.

  • 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 passcode-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 to require a passcode for participants joining by phone. If enabled and the meeting is passcode-protected, a numeric passcode is required for participants to join by phone. For meetings with alphanumeric passcodes, a numeric passcode will be generated.

  • pmi_password

    boolean — Whether all Personal Meeting ID (PMI) meetings that users can join via client or Zoom Rooms systems are passcode-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 passcode when scheduling webinars. Participants must use the generated passcode to join the scheduled webinar.

Example:

{
  "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,
    "set_retention_period_in_cloud": true,
    "set_retention_period_in_local": 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,
    "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
  },
  "email_notification": {
    "alternative_host_reminder": true,
    "cancel_meeting_reminder": true,
    "cloud_recording_available_reminder": true,
    "jbh_reminder": true,
    "schedule_for_reminder": true
  },
  "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,
    "meeting_question_answer": 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,
    "entry_exit_chime": "none",
    "far_end_camera_control": true,
    "feedback": true,
    "file_transfer": true,
    "full_transcript": true,
    "group_hd": true,
    "webinar_group_hd": true,
    "language_interpretation": true,
    "sign_language_interpretation": 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,
    "webinar_survey": true,
    "whiteboard": true
  },
  "other_options": {
    "blur_snapshot": true,
    "webinar_registration_options": 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,
    "prevent_host_access_recording": true,
    "recording_authentication": true,
    "archive": true
  },
  "schedule_meeting": {
    "audio_type": true,
    "embed_password_in_join_link": true,
    "enforce_login": true,
    "enforce_login_domains": "example.com",
    "enforce_login_with_domains": true,
    "host_video": true,
    "join_before_host": true,
    "meeting_authentication": true,
    "not_store_meeting_topic": true,
    "always_display_zoom_webinar_as_topic": false,
    "participant_video": true,
    "personal_meeting": 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,
    "continuous_meeting_chat": true
  },
  "telephony": {
    "telephony_regions": true,
    "third_party_audio": true
  },
  "tsp": {
    "call_out": true,
    "show_international_numbers_link": true
  }
}

Responses

Status: 200 **Error Code:** `200` Only available for Paid account: $accountId.

Status: 404 **HTTP Status Code:** `404` <br> Not Found **Error Code:** `2001` <br> TAccount does not exist: $subAccountId. <br>

Status: 429 **HTTP Status Code:** `429` <br> Too Many Requests. For more information, see [rate limits](https://developers.zoom.us/docs/api/rest/rate-limits/).

Get account's managed domains

• Method: GET
• Path: /accounts/{accountId}/managed_domains
• Tags: Accounts

Retrieve a list of an account's managed domains. To get the master account's managed domains, pass the me value for the accountId path parameter.

Prerequisites:

• A Pro or a higher paid account with the Master account option enabled.

Scopes: account:master,account:write:master,account:read:master

Granular Scopes: account:read:managed_domains:master

Rate Limit Label: LIGHT

Responses

Status: 200 **HTTP Status Code:** `200` Account's managed domains returned. **Error Code:** `200` Only available for Paid or ZMP account: {accountId}.

Content-Type: application/json

• domains

  array — Information about the managed domains.

  Items:

  All of:

  • domain

    string — The domain's name.

  • status

    string — The domain's status.

• total_records

  integer — The total number of records returned.

Example:

{
  "domains": [
    {
      "domain": "example.com",
      "status": "verified"
    }
  ],
  "total_records": 1
}

Status: 404 **HTTP Status Code:** `404` <br> Not Found **Error Code:** `2001` <br> Account does not exist: $accountId <br>

Status: 429 **HTTP Status Code:** `429` <br> Too Many Requests. For more information, see [rate limits](https://developers.zoom.us/docs/api/rest/rate-limits/).

Update the account owner

• Method: PUT
• Path: /accounts/{accountId}/owner
• Tags: Accounts

Changes an account's owner.

An account's current owner can change the account's owner to another user on the same account.

Prerequisites:

• An account owner or admin permissions of an account
• The account making this API request must be on a Pro or a higher account plan with Master account privileges

Scopes: account:master

Granular Scopes: account:update:owner:master

Rate Limit Label: HEAVY

Request Body

Content-Type: application/json

• email (required)

  string, format: email — The email address of the account's new owner.

Example:

{
  "email": "admin@example.com"
}

Responses

Status: 204 **HTTP Status Code:** `204` Account owner updated.

Status: 400 **HTTP Status Code:** `400` <br> Bad Request **Error Code:** `200` <br> User is not an admin or is an API user or doesn't belong to this account: {accountId}.<br> Cannot make a user outside of your account an owner.<br> Cannot update the role of an account owner. <br>

Status: 404 **HTTP Status Code:** `404` <br> Not Found **Error Code:** `2001` <br> Account does not exist: $subAccountId.<br> <br> **Error Code:** `3201` <br> Cannot find a billing account for this: $accountId.<br> <br> **Error Code:** `3211` <br> Cannot find a billing contact for this: $accountId. <br>

Status: 429 **HTTP Status Code:** `429` <br> Too Many Requests. For more information, see [rate limits](https://developers.zoom.us/docs/api/rest/rate-limits/).

Get account settings

• Method: GET
• Path: /accounts/{accountId}/settings
• Tags: Accounts

Returns an account's settings.

To get settings for a master account, use the me value for the accountId path parameter.

Prerequisites:

• The account must be a paid account.

Scopes: account:read:admin,account:write:admin

Granular Scopes: account:read:settings:master

Rate Limit Label: MEDIUM

Responses

Status: 200 **HTTP Status Code:** `200` Account settings returned. **Error Code:** `200` Only available for paid accounts.

Content-Type: application/json

One of:

• audio_conferencing

  object — Account 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.

      • allowed_countries

        array — The list of all available countries/regions that can be enabled for call out.

        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.

      • 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.

    • allowed_countries

      array — The list of all available countries/regions that can be selected for displaying dial-in numbers in the meeting 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.

    • 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 **Toll-free and Fee-based 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.

• 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. Separate multiple domains with a comma. 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 — Specified domains.

      Items:

      string — Specified domains.

  • chat_emojis

    object — Chat emojis.

    • emojis_option

      string, possible values: "all", "selected" — All emojis / selected emojis

    • 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 and view 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 — User restrictions for sharing and viewing 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 — Specified file type.

        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 — Specified file type.

        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 the 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 — Account Settings: Notification.

  • alternative_host_reminder

    boolean — Notify when an alternative host is set or removed from a meeting.

  • cancel_meeting_reminder

    boolean — Notify the host and participants when a meeting is cancelled.

  • cloud_recording_available_reminder

    boolean — Whether to notify the host when a cloud recording is available.

  • jbh_reminder

    boolean — Notify the host when participants join the meeting before them.

  • low_host_count_reminder

    boolean — Notify 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 — Notify the host there is a meeting is scheduled, rescheduled, or cancelled.

• feature

  object — Account Settings: Feature.

  • meeting_capacity

    integer — Set 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.

• in_meeting

  object — The in-meeting account setting.

  • ai_companion_questions

    object — Allow hosts and invited participants to ask questions to AI Companion during a meeting. Questions are answered based on the conversation transcript.

    • auto_enable

      boolean — Whether to automatically allow access when the meeting starts

    • enable

      boolean — Whether to allow hosts and invited participants to ask questions to AI Companion during a meeting.

    • who_can_ask_questions

      integer, possible values: 1, 2, 3, 4, 5 — Defines who can ask questions about this meeting's transcript. * `1` - All participants and invitees. * `2` - All participants only from when they join. * `3` - Only meeting host. * `4` - Participants and invitees in our organization. * `5` - Participants in our organization only from when they join.

  • alert_guest_join

    boolean — Identify guest participants in a meeting or webinar.

  • 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 to allow participants to only chat with certain groups. * `1` - The participant cannot use chat. * `2` - Host and co-hosts only. * `3` - The participant can chat with other participants publicly. * `4` - The participant can chat with other participants publicly and privately. **Note:** This setting is only available with client versions 5.7.3 and above.

  • allow_participants_to_rename

    boolean — If the value of this field is set to `true`, meeting participants and webinar panelists can be allowed to rename themselves during a meeting or a webinar.

  • allow_show_zoom_windows

    boolean — Show the Zoom desktop application when sharing screens.

  • allow_users_save_chats

    integer, possible values: 1, 2, 3 — Whether to allow participants to 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.

  • annotation

    boolean — Allow participants to use annotation tools to add information to shared screens.

  • anonymous_question_answer

    boolean — Allow an anonymous Q&amp;A in a webinar.

  • 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 [**Focus Mode**](https://support.zoom.us/hc/en-us/articles/360061113751-Using-focus-mode). When enabled, this feature only displays the host and co-hosts' video and profile pictures during a meeting. This value defaults to `false`.

  • auto_answer

    boolean — Enable users to see and add contacts to the `auto-answer group` in the chat contact list. Any call from members of this group will automatically be answered.

  • auto_generated_translation

    object — The [translated captions](https://support.zoom.us/hc/en-us/articles/6643133682957-Enabling-and-configuring-translated-captions) setting in meetings.

    • enable

      boolean — The option for participants to enable the automated translation captions in meetings.

    • language_item_pairList

      object — The input speaking language and output caption language pair list.

      • all

        boolean — The option to select all language pairs.

      • trans_lang_config

        array — The speaking language and caption language list.

        Items:

        • speak_language

          object — The input speaking language in meetings.

          • code

            string, possible values: "zh", "nl", "en", "fr", "de", "it", "ja", "ko", "pt", "ru", "es", "uk" — The input speaking language [code](https://marketplace.zoom.us/docs/api-reference/other-references/abbreviation-lists/#languages).

          • name

            string, possible values: "Chinese (Simplified)", "Dutch", "English", "French", "German", "Italian", "Japanese", "Korean", "Portuguese", "Russian", "Spanish", "Ukrainian" — The input speaking language.

        • translate_to

          object — The translated output caption language.

          • all

            boolean — The option to select all translated output caption languages.

          • language_config

            array — The translated output caption language list.

            Items:

            • code

              string, possible values: "en" — The translated output caption language [code](https://marketplace.zoom.us/docs/api-reference/other-references/abbreviation-lists/#languages).

            • name

              string, possible values: "English" — The translated output caption language name.

  • auto_saving_chat

    boolean — Automatically save all in-meeting chats so that the host does not need to manually save the chat transcript after the meeting starts.

  • breakout_room

    boolean — Allow host to 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 — Allow meeting participants to send a message that is visible to all participants.

  • closed_caption

    boolean — Allow a host to type closed captions. Enable a host to assign a participant or third party device to add closed captions.

  • closed_captioning

    object — Information about 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 — Allow the host to add co-hosts.

  • custom_data_center_regions

    boolean — If set to `true`, account owners and admins on paid accounts can [select data center regions](https://support.zoom.us/hc/en-us/articles/360042411451-Selecting-data-center-regions-for-hosted-meetings-and-webinars) to use for hosting their real-time meeting and webinar traffic. These regions can be provided in the `data_center_regions` field. If set to `false`, the regions cannot be customized and the default regions will be used.

  • custom_live_streaming_service

    boolean — Whether to allow custom livestreaming.

  • custom_service_instructions

    string — The specific instructions to configure a custom livestream.

  • 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"

  • 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_audio

    integer — DSCP audio.

  • 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 — DSCP marking.

  • dscp_video

    integer — DSCP video.

  • e2e_encryption

    boolean — Zoom requires encryption for all data between the Zoom cloud, Zoom client, and Zoom Room. Require encryption for 3rd party endpoints (H323/SIP).

  • entry_exit_chime

    string, possible values: "host", "all", "none" — Play sound when participants join or leave. `host` - Heard by host only. `all` - Heard by host and all attendees. `none` - Disable.

  • far_end_camera_control

    boolean — Allow another user to take control of your camera during a meeting.

  • feedback

    boolean — Add a **Feedback** tab to the Windows Settings or Mac Preferences dialog. Enable users to provide feedback to Zoom at the end of the meeting.

  • 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 on the account or not.

  • group_hd

    boolean — Activate higher quality video for host and participants in Meeting. Please note: This will use more bandwidth.

  • join_from_desktop

    boolean — Whether to allow participants to join a meeting directly from their desktop browser. Note that the meeting experience from the desktop browser is limited.

  • join_from_mobile

    boolean — Whether to allow participants to join a meeting directly from their mobile browser. Note that the meeting experience from the mobile browser is limited.

  • 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 the 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 to allow hosts to assign participants as interpreters who can interpret one language into another in real-time.

    • enable_language_interpretation_by_default

      boolean — Whether to enable language interpretation by default.

    • languages

      array — A list of system-supported languages.

      Items:

      string, possible values: "English", "Chinese", "Japanese", "German", "French", "Russian", "Portuguese", "Spanish", "Korean"

  • live_streaming_facebook

    boolean — Whether to allow Facebook livestreaming.

  • live_streaming_youtube

    boolean — Whether to allow YouTube livestreaming.

  • manual_captioning

    object — Information about manual captioning settings.

    • allow_to_type

      boolean — Whether to allow the host to manually caption or let the host assign a participant to provide manual captioning.

    • 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).

    • full_transcript

      boolean — Whether to enable the viewing of full transcripts in the in-meeting side panel.

    • manual_captions

      boolean — Whether to [enable manual closed captioning](https://support.zoom.us/hc/en-us/articles/207279736-Managing-closed-captioning-and-live-transcription).

    • save_captions

      boolean — Whether to allow participants to [save closed captions 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.

    • third_party_captioning_service

      boolean — Whether to allow the use of an API token to integrate with a [3rd-party device](https://support.zoom.us/hc/en-us/articles/115002212983) to provide closed captioning.

  • meeting_data_transit_and_residency_method

    string, possible values: "cloud", "On-Prem" — Select meeting data transit and residency method for meeting hosts and participants. `cloud` - Zoom Cloud. `On-Prem` - On-Prem (Zoom Meeting Connector, only applicable for licensed users).

  • meeting_polling

    object — Information about the account's meeting polling settings.

    • advanced_polls

      boolean — Whether to allow host to create advanced polls and quizzes. Advanced polls and quizzes include single choice, multiple choice, drop down, matching, short answer, long answer, rank order, and fill-in-the-blank questions. Hosts can also set the correct answers for quizzes they create.

    • allow_alternative_host_to_add_edit

      boolean — Whether to allow the alternative host to 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 to allow the host to 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 these 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_summary_with_ai_companion

    object — As a host, you can generate a summary. Summaries are sent after the meeting has ended based on the share options.

    • auto_enable

      boolean — Whether to turn on meeting summary automatically when meetings start

    • enable

      boolean — Whether to allow hosts to generate a summary.

    • who_will_receive_summary

      integer, possible values: 1, 2, 3, 4 — Defines who will receive a summary after this meeting. * `1` - Only meeting host. * `2` - Only meeting host, co-hosts, and alternative hosts. * `3` - Only meeting host and meeting invitees in our organization. * `4` - All meeting invitees including those outside of our organization.

  • 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 — Allow users to select original sound in their client settings.

  • p2p_connetion

    boolean — Peer to peer connection while only two people are in a meeting.

  • p2p_ports

    boolean — Peer to peer listening ports range.

  • participants_share_simultaneously

    string, possible values: "multiple", "one" — Indicates how many participants can share at the same time. The value can be one of the following: `one`: Only one participant can share at a time . `multiple`: Multiple participants can share simultaneously (dual monitors recommended) . For Webinar, the hosts and panelists can start screen sharing, but not the attendees.

  • polling

    boolean — Add **Polls** to the meeting controls.

  • ports_range

    string, default: "" — The listening ports range, separated by a comma, such as `55,56`. The ports range must be between 1 to 65535.

  • post_meeting_feedback

    boolean — Display a thumbs up or down survey at the end of each meeting.

  • private_chat

    boolean — Allow a meeting participant to send a private message to another participant.

  • record_play_own_voice

    boolean — Record and play their own voice.

  • remote_control

    boolean — Allow users to 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`.

  • 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.

  • screen_sharing

    boolean — Allow screen sharing.

  • sending_default_email_invites

    boolean — Only show the default email when sending email invites.

  • show_a_join_from_your_browser_link

    boolean — Whether to allow participants to join a meeting directly from their browser and bypass the Zoom application download process. This is useful for participants who cannot download, install, or run applications. Note that the meeting experience from the browser is limited.

  • show_meeting_control_toolbar

    boolean — Always show the meeting control toolbar.

  • 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 — Allow users to select stereo audio in their client settings.

  • transfer_meetings_between_devices

    boolean — Users can move to a new device without leaving the meeting they're in.

  • unchecked_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 **not** opt in to. * `EU` - Europe. * `HK` - Hong Kong. * `AU` - Australia. * `IN` - India. * `LA` - Latin America. * `TY` - Tokyo. * `CN` - China. * `US` - United States. * `CA` - Canada.

    Items:

    string, possible values: "EU", "HK", "AU", "IN", "TY", "CN", "US", "CA", "DE", "NL", "LA"

  • use_html_format_email

    boolean — Use HTML formatted email for the Outlook plugin.

  • virtual_background

    boolean — Allow users to replace their background with any selected image. Choose or upload an image in the Zoom desktop application settings.

  • virtual_background_settings

    object — Settings to manage virtual background.

    • allow_upload_custom

      boolean — Allow users to upload custom backgrounds.

    • allow_videos

      boolean — Allow use of videos for virtual backgrounds.

    • enable

      boolean — Enable virtual background.

    • files

      array

      Items:

      • id

        string — The file's unique identifier.

      • is_default

        boolean — Indicates whether or not this file is the default virtual background file.

      • name

        string — test.png

      • size

        integer — File size.

      • type

        string — File type.

  • watermark

    boolean — Add a watermark when viewing a shared screen.

  • webinar_ai_companion_questions

    object — Allow webinar hosts and panelists to ask questions to AI Companion during a webinar. Questions are answered based on the conversation transcript.

    • auto_enable

      boolean — Whether to automatically allow access when the webinar starts.

    • enable

      boolean — Whether to allow webinar hosts and panelists to ask questions to AI Companion during a webinar.

    • who_can_ask_questions

      integer, possible values: 0, 1, 2, 3 — Defines who can ask questions about the webinar's transcript. * `0` - Hosts and all panelists. * `1` - Hosts and all panelists in your organization. * `2` - Only the webinar host, co-hosts, and alternative hosts. * `3` - All participants.

  • webinar_chat

    object

    • allow_attendees_chat_with

      integer, possible values: 1, 2, 3 — Designate who webinar attendees can chat with in the meeting. * `1` - No one. * `2` - Host and all panelists. * `3` - Everyone.

    • allow_auto_save_local_chat_file

      boolean — Whether to automatically save chat messages to a local file on the host's computer when the webinar ends.

    • allow_panelists_chat_with

      integer, possible values: 1, 2 — Designate which other participants users can chat with in the meeting. * `1` - Host and all panelists. * `2` - Everyone.

    • allow_panelists_send_direct_message

      boolean — Whether to allow webinar panelists to send direct messages to other panelists.

    • allow_users_save_chats

      integer, possible values: 0, 1, 2 — Whether to allow webinar attendees to save chats. * `0` - Attendees cannot save chats. * `1` - Attendees can only save host and panelist chats. * `2` - Attendees can save all 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.

    • default_attendees_chat_with

      integer, possible values: 1, 2 — By default, allow webinar attendees to chat with: * `1` - Host and all panelists. * `2` - Everyone.

    • enable

      boolean — Whether to allow webinar participants to send chat messages.

  • webinar_group_hd

    boolean — Activate higher quality video for host and participants in Webinar. Please note: This will use more bandwidth.

  • webinar_live_streaming

    object

    • custom_service_instructions

      string — The specific instructions to allow your account's meeting hosts to configure a custom livestream.

    • enable

      boolean — Whether to enable webinar livestreaming.

    • 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 to allow host to create advanced polls and quizzes. Advanced polls and quizzes include single choice, multiple choice, drop down, matching, short answer, long answer, rank order, and fill-in-the-blank questions. Hosts can also set the correct answers for quizzes they create.

    • allow_alternative_host_to_add_edit

      boolean — Whether to allow the alternative host to 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 to allow the host to add polls before or during a webinar.

    • manage_saved_polls_and_quizzes

      boolean — Whether to allow users to manage saved polls and quizzes from Webinars

    • require_answers_to_be_anonymous

      boolean — Whether to require answers to be anonymous.

  • 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_summary_with_ai_companion

    object — As a webinar host, you can generate a summary. Summaries are sent after the webinar ends based on the share options.

    • auto_enable

      boolean — Whether to automatically turn on webinar summary when webinars start.

    • enable

      boolean — Whether to allow webinar hosts to generate a summary.

    • who_will_receive_summary

      integer, possible values: 1, 2, 3 — Defines who will receive a summary after the webinar. * `1` - Only the webinar host. * `2` - Only the webinar host, co-hosts, and panelists in your organization. * `3` - The webinar host, co-hosts, and all panelists, including those outside your organization.

  • webinar_survey

    boolean — Whether to allow the host to present surveys to attendees once a webinar has ended.

  • whiteboard

    boolean — Allow participants to share a whiteboard that includes annotation tools.

  • who_can_share_screen

    string, possible values: "host", "all" — Indicates who can share their screen or content during meetings. The value can be one of the following: `host`: Only host can share the screen. `all`: Both hosts and attendees can share their screen during meetings. For Webinar, the hosts and panelists can start screen sharing, but not the attendees.

  • who_can_share_screen_when_someone_is_sharing

    string, possible values: "host", "all" — Indicates who is allowed to start sharing screen when someone else in the meeting is sharing their screen. The value can be one of the following: `host`: Only a host can share the screen when someone else is sharing. `all`: Anyone in the meeting is allowed to start sharing their screen when someone else is sharing. For Webinar, the hosts and panelists can start screen sharing, but not the attendees.

  • workplace_by_facebook

    boolean — Whether to allow Workplace by Facebook livestreaming.

• integration

  object — Account Integration Settings

  • box

    boolean — Whether to allow users who join a meeting from their mobile device to share content from their Box account.

  • dropbox

    boolean — Whether to allow users who join a meeting from their mobile device to share content from their Dropbox account.

  • google_calendar

    boolean — Whether to enable the scheduling of meetings using Google Calendar.

  • google_drive

    boolean — Whether to allow users who join a meeting from their mobile device to share content from their Google Drive.

  • kubi

    boolean — Whether to allow users to control a connected Kubi device from within a Zoom meeting.

  • microsoft_one_drive

    boolean — Whether to allow users who join a meeting from their mobile device to 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.

• other_options

  object

  • allow_auto_active_users

    boolean — If true, administrators can activate users with a single default passcode when adding users. This activates added users immediately without waiting for them to set their own passcode.

  • allow_users_contact_support_via_chat

    boolean — If true, displays the Zoom Help badge on the bottom-right of the page.

  • allow_users_enter_and_share_pronouns

    boolean — If true, users can add pronouns to their profile cards and share them during meetings and webinars.

  • 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.

  • display_meetings_scheduled_for_others

    boolean — If true, a user with [scheduling privileges](https://support.zoom.us/hc/en-us/articles/201362803-Scheduling-privilege) can view other users' meetings.

  • email_in_attendee_report_for_meeting

    boolean — If true, include authenticated guests' email addresses in attendee reports for 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` 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` - Display the meeting quality score and network alerts on the dashboard and use custom thresholds for quality scores and network alerts.

  • show_one_user_meeting_on_dashboard

    boolean — If true, 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_join_info

      boolean — Allow host to enable **Show join info on registration confirmation page**.

    • allow_host_to_enable_social_share_buttons

      boolean — Allow host to enable **Show social share buttons on registration page**.

    • enable_custom_questions

      boolean — Enable custom questions.

• profile

  object

  • recording_storage_location

    object

    • allowed_values

      array — Users can choose the country to store their recorded content. Content can include meeting, webinar, and phone recordings, as well as voicemail, transcripts, and custom greeting prompts. See [Managing the Communications Content storage location](https://support.zoom.us/hc/en-us/articles/360050781131) for details. Provide abbreviated country codes as the value for this field. See the [Countries abbreviation list](https://marketplace.zoom.us/docs/api-reference/other-references/abbreviation-lists#countries) for details.

      Items:

      string

    • value

      string — Abbreviated country code.

• recording

  object — Account Settings: Recording.

  • account_user_access_recording

    boolean — 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 — Allow recovery of deleted cloud recordings from trash. If the value of this field is set to `true`, deleted cloud recordings will be kept in trash for 30 days after deletion and can be recovered within that period.

  • archive

    object — [Archiving solution](https://support.zoom.us/hc/en-us/articles/360050431572-Archiving-Meeting-and-Webinar-data) settings. This setting can only be used if you have been granted with archiving solution access by the Zoom support team.

    • enable

      boolean — Enable the archiving feature.

    • 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 — Include in-meeting and/or in-webinar audio in the archive.

      • cc_transcript_file

        boolean — Include closed caption or transcript in the archive.

      • chat_file

        boolean — Include in-meeting chat in the archive.

      • chat_with_direct_message

        boolean — Include direct message in in-meeting chat file.

      • chat_with_sender_email

        boolean — Include user email in 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 — Include in-meeting and/or in-webinar video in the archive.

    • type

      integer, possible values: 1, 2, 3 — Archive types. * `1` - Only meetings are archived. * `2` - Only webinars are archived. * `3` - Both meetings and webinars are archived.

  • auto_delete_cmr

    boolean — Allow Zoom to permanently delete recordings automatically after a specified number of days.

  • 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, possible values: "local", "cloud", "none" — Automatic recording: `local` - Record on local. `cloud` - Record on cloud. `none` - Disabled.

  • cloud_recording

    boolean — Allow hosts to record and save the meeting in the cloud.

  • cloud_recording_download

    boolean — Cloud recording downloads.

  • cloud_recording_download_host

    boolean — Only the host can download cloud recordings.

  • display_participant_name

    boolean — Whether to display participants' names in the recording.

  • host_delete_cloud_recording

    boolean — If the value of this field is set to `true`, hosts will be able to delete the recordings. If this option is set to `false`, the recordings cannot be deleted by the host and only admin can delete them.

  • ip_address_access_control

    object — Setting to allow cloud recording access only from specific IP address ranges.

    • enable

      boolean — If set to `true`, the cloud recordings of this account can only be accessed by the IP addresses defined in the `ip_addresses_or_ranges` property.

    • ip_addresses_or_ranges

      string — IP addresses or ranges that have access to the cloud recordings. Separate multiple IP ranges with comma. Use n.n.n.n, n.n.n.n/n or n.n.n.n - n.n.n.n syntax where n is a number. Example: `46.33.24.184, 48.99.100.2/25` or `200.181.108.17 - 220.181.108.157`

  • local_recording

    boolean — Allow hosts and participants to record the meeting using a local file.

  • optimize_recording_for_3rd_party_video_editor

    boolean — Whether to optimize recordings for a 3rd party video editor. This may increase the file size and the time it takes to generate recording files.

  • prevent_host_access_recording

    boolean — If set to `true`, meeting hosts cannot view their meeting cloud recordings. Only the admins who have recording management privilege can access them.

  • record_audio_file

    boolean — Whether to record one audio file for all participants.

  • record_audio_file_each_participant

    boolean — Whether to record a separate audio file for each participant. This only supports a maximum of 200 participants' audio files.

  • 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 to record the active speaker only.

    • gallery_view

      boolean — Whether to record the gallery view only.

    • shared_screen

      boolean — Whether to record the shared screen only.

  • record_gallery_view

    boolean — Record the gallery view with a shared screen.

  • record_speaker_view

    boolean — Record the active speaker with a shared screen.

  • recording_audio_transcript

    boolean — Automatically transcribe the audio of the meeting or webinar to the cloud.

  • recording_disclaimer

    boolean — Show a disclaimer to participants before a recording starts This field has been deprecated. The replacement field is recording_notification_for_zoom_client

  • recording_highlight

    boolean — Whether to enable the [recording highlights](https://support.zoom.us/hc/en-us/articles/360060802432) feature.

  • recording_notification_for_zoom_client

    object — setting name: Recording notifications - Zoom clients

    • ask_host_to_confirm

      boolean — Child setting name is [Ask host to confirm before starting a recording], the value is option name you selected

    • disclaimer_to_participants

      string — Child setting name is [Show a disclaimer to participants when a recording starts], the value is option name you selected.

    • play_voice_prompt

      string — Child setting name is [Play voice prompt for], the value is option name you selected.

  • recording_password_requirement

    object — This object represents the minimum passcode requirements set for recordings via Account Recording Settings.

    • have_letter

      boolean — Indicates whether or not passcode must contain at least one alphabetical letter (a, b, c..).

    • have_number

      boolean — Indicates whether or not passcode must contain at least one number(1, 2, 3..).

    • have_special_character

      boolean — Indicates whether or not passcode must contain at least one special character(!, @, #..).

    • length

      integer — Minimum required length for the passcode.

    • only_allow_numeric

      boolean — Indicates whether or not passcode must contain only numeric characters.

  • recording_thumbnails

    boolean — Whether to record thumbnails of the presenter when they are sharing their screen.

  • required_password_for_existing_cloud_recordings

    boolean — Require a passcode to access existing cloud recordings.

  • required_password_for_shared_cloud_recordings

    boolean — Whether to require a passcode to share cloud recordings.

  • save_chat_text

    boolean — Save the chat text from the meeting.

  • save_close_caption

    boolean — Whether to save [closed captions](https://support.zoom.us/hc/en-us/articles/207279736) as a VTT (Video Track Text) file.

  • save_panelist_chat

    boolean — Whether to save panelist chat to the recording. This setting saves messages sent by panelists during a webinar to either all panelists or all panelists and attendees to the recording.

  • save_poll_results

    boolean — Whether to save poll results shared during the meeting or webinar. This also includes poll results shared during the meeting or webinar.

  • show_timestamp

    boolean — Add a timestamp to the recording.

  • 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 — Account Settings: Schedule Meeting.

  • allow_host_to_disable_participant_video

    boolean — Allow host to disable participant video when scheduling a meeting.

  • 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 to enable the **Always display `Zoom Meeting` as the meeting topic** setting.

  • 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 to enable the **Always show `Zoom Webinar` as the webinar topic** setting.

  • audio_type

    string, possible values: "both", "telephony", "voip", "thirdParty", default: "both" — Determine how participants can join the audio portion of the meeting. `both` - Telephony and VoIP. `telephony` - Audio PSTN telephony only. `voip` - VoIP only. `thirdParty` - 3rd party audio conference.

  • continuous_meeting_chat

    object — Information about the **Enable continuous meeting chat** feature.

    • auto_add_invited_external_users

      boolean — Whether to enable the **Automatically add invited external users** setting.

    • can_add_external_users

      boolean — Whether to enable the **External users can be added** setting.

    • enable

      boolean — Whether to enable the **Enable continuous meeting chat** setting.

  • enable_dedicated_group_chat

    boolean — Enable dedicated group chats for meeting conversations.

  • enforce_login

    boolean — Only Zoom users who are signed in can join meetings.

  • enforce_login_domains

    string — Only signed in users with a specified domain can join the meeting.

  • enforce_login_with_domains

    boolean — Only signed in users with a specific domain can join meetings.

  • force_pmi_jbh_password

    boolean — Require a passcode for Personal Meetings if attendees can join before host.

  • hide_meeting_description

    object — Information about the **Hide meeting description** feature.

    • enable

      boolean — Whether to enable the **Hide meeting description** setting.

    • 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 to enable the **Hide webinar description** setting.

    • hide_description_for_scheduled_webinars

      boolean — Whether to hide webinar description for the webinars which have already been scheduled.

  • host_video

    boolean — Start meetings with the host video on.

  • jbh_time

    integer, possible values: 0, 5, 10, 15 — If the value of `join_before_host` field is set to `true`, this field can be used to indicate time limits when a participant may join a meeting before a host. * `0`: Allow participant to join anytime. * `5`: Allow participant to join 5 minutes before meeting start time. * `10`: Allow participant to join 10 minutes before meeting start time.

  • join_before_host

    boolean — Allow participants to join the meeting before the host arrives.

  • meeting_password_requirement

    object — Account wide meeting or webinar [passcode requirements](https://support.zoom.us/hc/en-us/articles/360033559832-Meeting-and-webinar-passwords#h_a427384b-e383-4f80-864d-794bf0a37604).

    • consecutive_characters_length

      integer, possible values: 0, 4, 5, 6, 7, 8 — Specify the max length of consecutive characters(abcde...) that can be used in a passcode. If you set the value of this field to `0`, no restriction will be applied on consecutive characters. If you would like to set this restriction, you can specify a number between `4` and `8` that will define the maximum allowed length for consecutive characters in a passcode. The maximum allowed length will be `n-1` where `n` refers to the value you provide for this field. For instance, if you provide `4` as the value, there can only be a maximum of `3` consecutive characters in a passcode(example: abc1x@8fdh).

    • have_letter

      boolean — If set to `true`, the passcode must contain at least 1 letter (such as a,b,c...).

    • have_number

      boolean — If set to `true`, the passcode must contain at least 1 number (such as 1,2,3...).

    • have_special_character

      boolean — If set to `true`, the passcode must have at least 1 special character (!,@,#...).

    • have_upper_and_lower_characters

      boolean — If set to `true`, the passcode must include both uppercase and lowercase characters.

    • length

      integer — The minimum length that the meeting or webinar passcode must have.

    • only_allow_numeric

      boolean — If set to `true`, the passcode must only contain numbers and no other characters.

    • weak_enhance_detection

      boolean — If set to `true`, users will be informed if the provided passcode is weak.

  • meeting_template

    object — Information about the **Meeting Templates** feature.

    • enable

      boolean — Whether to enable the **Meeting Templates** setting.

    • templates

      array — Information about the defined **Meeting Templates** policies.

      Items:

      • enable

        boolean — Whether to enable the meeting template. * `true` - Enable. * `false` - Disable.

      • id

        string — The meeting template ID.

      • name

        string — The meeting template name.

  • not_store_meeting_topic

    boolean — Always display **Zoom Meeting** as the meeting topic.

  • participant_video

    boolean — Start meetings with the participant video on. Participants can change this setting during the meeting.

  • personal_meeting

    boolean — Personal meeting setting. `true` - Indicates that the **Enable Personal Meeting ID** setting is turned on. Users can choose to use personal meeting ID for their meetings. `false` - Indicates that the **Enable Personal Meeting ID** setting is [turned off](https://support.zoom.us/hc/en-us/articles/201362843-Personal-meeting-ID-PMI-and-personal-link#h_aa0335c8-3b06-41bc-bc1f-a8b84ef17f2a). If this setting is disabled, meetings that were scheduled with a PMI will be invalid. Scheduled meetings will need to be manually updated. For Zoom Phone only - If a user has been assigned a desk phone, **Elevate to Zoom Meeting** on desk phone will be disabled.

  • require_password_for_instant_meetings

    boolean — Require a passcode for instant meetings. If you use a PMI for your instant meetings, this option will be disabled. This setting is always enabled for free accounts and Pro accounts with a single host and cannot be modified for these accounts.

  • require_password_for_pmi_meetings

    string, possible values: "jbh_only", "all", "none" — Require a passcode for a meeting held using a personal meeting ID (PMI). This setting is always enabled for free accounts and Pro accounts with a single host and cannot be modified for these accounts.

  • require_password_for_scheduled_meetings

    boolean — Require a passcode for meetings which have already been scheduled.

  • require_password_for_scheduling_new_meetings

    boolean — Require a passcode when scheduling new meetings. This setting applies for regular meetings that do not use a PMI. If enabled, a passcode will be generated while a host schedules a new meeting and participants will be required to enter the passcode before they can join the meeting. This setting is always enabled for free accounts and Pro accounts with a single host and cannot be modified for these accounts.

  • 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.

• security

  object — [Security settings](https://support.zoom.us/hc/en-us/articles/360034675592-Advanced-security-settings#h_bf8a25f6-9a66-447a-befd-f02ed3404f89) of an Account.

  • admin_change_name_pic

    boolean — Whether to only allow account administrators to change a user's picture.

  • admin_change_user_info

    boolean — Whether to only allow account administrators to change a user's information.

  • hide_billing_info

    boolean — Hide billing information.

  • import_photos_from_devices

    boolean — Allow users to import photos from a photo library on a device.

  • password_requirement

    object — This object refers to the [enhanced passcode rules](https://support.zoom.us/hc/en-us/articles/360034675592-Advanced-security-settings#h_bf8a25f6-9a66-447a-befd-f02ed3404f89) that allows Zoom account admins and owners to apply extra requirements to the users' Zoom login passcode.

    • consecutive_characters_length

      integer — Specify the max length of consecutive characters(abcde...) that can be used in a passcode. If you set the value of this field to `0`, no restriction will be applied on consecutive characters. If you would like to set this restriction, you can specify a number between 4 and 8 that define the maximum allowed length for consecutive characters in a passcode. The max allowed length will be `n-1` where `n` refers to the value you provide for this field. For instance, if you provide `4` as the value, there can only be a maximum of `3` consecutive characters in a passcode(example: abc1x@8fdh).

    • have_special_character

      boolean — If the value of this field is set to `true`, the passcode must have at least one special character(!, @, #...).

    • minimum_password_length

      integer — Specify a minimum length for the passcode. The passcode length can be from a minimum of 9 characters, up to 14 characters. If you provide `0` as the value of this field, this field will be disabled and not be used and the basic passcode length requirement (minimum of 8 characters) will be applied for the requirement.

    • weak_enhance_detection

      boolean — If the value of this field is set to `true`, user passcodes will have to pass detection through a weak passcode dictionary in case hackers use simple passcodes to sign in to your users' accounts.

  • sign_again_period_for_inactivity_on_client

    integer — Settings for User Sign In interval requirements after a period of inactivity. If enabled, this setting forces automatic logout of users in Zoom Client app after a set amount of time. If this setting is disabled, the value of this field will be `0`. If the setting is enabled, the value of this field will indicate the **period of inactivity** in minutes, after which an inactive user will be automatically logged out of the Zoom client. `5` - 5 minutes. `10` - 10 minutes. `15` - 15 minutes. `30` - 30 minutes. `45` - 45 minutes. `60` - 60 . `90` - 90 minutes. `120` - 120 minutes.

  • sign_again_period_for_inactivity_on_web

    integer — Settings for User Sign In interval requirements after a period of inactivity. If enabled, this setting forces automatic logout of users in Zoom Web Portal after a set amount of time. If this setting is disabled, the value of this field will be `0`. If the setting is enabled, the value of this field will indicate the **period of inactivity** in minutes, after which an inactive user will be automatically logged out of the Zoom Web Portal. `5` - 5 minutes. `10` - 10 minutes. `15` - 15 minutes. `30` - 30 minutes. `60` - 60 minutes. `120` - 120 minutes.

  • sign_in_with_two_factor_auth

    string, possible values: "all", "group", "role", "none" — Settings for 2FA( [two factor authentication](https://support.zoom.us/hc/en-us/articles/360038247071) ). `all` - Two factor authentication will be enabled for all users in the account. `none` - Two factor authentication is disabled. `group` - Two factor authentication will be enabled for users belonging to specific groups. If 2FA is enabled for certain groups, the group IDs of the group(s) will be provided in the `sign_in_with_two_factor_auth_groups` field. `role` - Two factor authentication will be enabled only for users assigned with specific roles in the account. If 2FA is enabled for specific roles, the role IDs will be provided in the `sign_in_with_two_factor_auth_roles` field.

  • sign_in_with_two_factor_auth_groups

    array — This field contains group IDs of groups that have 2FA enabled. This field is only returned if the value of `sign_in_with_two_factor_auth` is `group`

    Items:

    string

  • sign_in_with_two_factor_auth_roles

    array — This field contains role IDs of roles that have 2FA enabled. This field is only returned if the value of `sign_in_with_two_factor_auth` is `role`.

    Items:

    string

  • signin_with_sso

    object — Allow users to sign in with single sign-on (SSO).

    • domains

      array — Users on these domains must sign in with single sign-on (SSO).

      Items:

      string

    • enable

      boolean — Whether to allow users to sign in with single sign-on (SSO). If enabling this, configure your account's SSO settings. This lets users sign in with SSO through your company's vanity URL.

    • 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 email.

      • id

        string — The user id.

  • user_modifiable_info_by_admin

    array — If the `admin_change_user_info` value is `true`, the list of the types of user information that only the account administrators can modify. * `name` * `profile_picture` * `sign_in_email` * `host_key`

    Items:

    string, possible values: "name", "profile_picture", "sign_in_email", "host_key"

• smart_recognition

  object — Account Settings: Smart Recognition.

  • personalized_audio_isolation

    boolean — Allow users to enable personalized audio isolation in the Zoom Workplace app to differentiate their voice and suppress background noise.

  • workplace_app

    object — Zoom Workplace app automatic smart name tags

    • voice_name_tags

      object — Workplace App: Voice Name Tags

      • allow_enrollment_email

        boolean — Allow Zoom to send an enrollment email to users in your account to help them set up Workplace app voice name tags.

      • enabled

        boolean — Allow users to enroll in automatic smart name tags for voice from their profile in the Zoom Workplace app.

  • zoom_rooms

    object — Zoom Rooms automatic smart name tags

    • video_name_tags

      object — Zoom Rooms: Video Name Tags

      • allow_enrollment_email

        boolean — Allow Zoom to send an enrollment email to users in your account to help them set up automatic smart name tags for video.

      • allow_external_identification

        boolean — Allow external Zoom Rooms to identify users in your account using their enrolled video name tags.

      • allow_user_photos

        boolean — Allow users to use their own profile photos as the reference image for video smart name tags.

      • enabled

        boolean — Allow users to enroll in automatic smart name tags for video in Zoom Rooms. When enabled, enrolled users’ reference images are used to recognize them in the Zoom Room.

    • voice_name_tags

      object — Zoom Rooms: Voice Name Tags

      • allow_enrollment_email

        boolean — Allow Zoom to send an enrollment email to users in your account to help them set up automatic smart name tags for voice.

      • allow_external_identification

        boolean — Allow external Zoom Rooms to identify users in your account using their enrolled voice name tags.

      • enabled

        boolean — Allow users to enroll in automatic smart name tags for voice in Zoom Rooms. When enabled, enrolled users’ uploaded voice recordings are used to recognize them as speakers.

• telephony

  object — Account Settings: Telephony.

  • audio_conference_info

    string — Third party audio conference info.

  • telephony_regions

    object — Indicates where most of the participants call into or call from during a meeting.

    • allowed_values

      array — Telephony region options provided by Zoom to select from.

      Items:

      string

    • selection_values

      string — The account's selected telephony regions that indicate where most participants call into or call from during a meeting.

  • third_party_audio

    boolean — Users can join the meeting using the existing third party audio configuration.

• tsp

  object — Account Settings: TSP.

  • 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.

    • allowed_countries

      array — The list of all available countries/regions that can be selected for displaying dial-in numbers in the meeting invitation.

      Items:

      • code

        string — The code of the country or region.

      • name

        string — The name of the country or region.

    • 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 — Account Settings: Zoom Rooms.

  • auto_start_stop_scheduled_meetings

    boolean — Automatic start and stop for scheduled meetings.

  • cmr_for_instant_meeting

    boolean — Cloud recording for instant meetings.

  • force_private_meeting

    boolean — Shift all meetings to private.

  • hide_host_information

    boolean — Hide host and meeting ID from private meetings.

  • list_meetings_with_calendar

    boolean — Display meeting list with calendar integration.

  • start_airplay_manually

    boolean — Start AirPlay service manually.

  • ultrasonic

    boolean — Automatic direct sharing using an ultrasonic proximity signal.

  • upcoming_meeting_alert

    boolean — Upcoming meeting alert.

  • weekly_system_restart

    boolean — Weekly system restart.

  • zr_post_meeting_feedback

    boolean — Zoom Room post meeting feedback.

One of:

• allow_authentication_exception

  boolean — Whether to enable the [**Allow authentication exception**](https://support.zoom.us/hc/en-us/articles/360037117472#h_01F13A9N1FQFNVESC9C21NRHXY) setting. This lets hosts invite users who can bypass authentication.

• authentication_options

  array — The account's [**Meeting Authentication Options**](https://support.zoom.us/hc/en-us/articles/360060549492-Allowing-only-authenticated-users-in-meetings#h_01F51KGPWJNQBDMFSJ3ZJQ4AA2) settings.

  Items:

  • default_option

    boolean — Whether the authentication option is the default authentication option.

  • domains

    string — A comma-separated list of approved authentication domains.

  • id

    string — The authentication option's ID.

  • name

    string — The authentication option's name.

  • type

    string, possible values: "enforce_login", "enforce_login_with_same_account", "enforce_login_with_domains" — The authentication type. * `enforce_login` - Only users logged in to Zoom can join meetings. * `enforce_login_with_domains` - Only users from specific domains can join meetings. The list of domains is defined in the `domains` field. * `enforce_login_with_same_account` - Only the Zoom account's users can join meetings.

  • visible

    boolean — Whether the authentication option is visible.

• meeting_authentication

  boolean — Whether to only allow authenticated users to join meetings.

• authentication_options

  array

  Items:

  • default_option

    boolean — Authentication default option

  • domains

    string — Authentication domains.

  • id

    string — Authentication id

  • name

    string — Authentication name

  • type

    string, possible values: "internally", "enforce_login", "enforce_login_with_domains" — Authentication type

  • visible

    boolean — Authentication visible

• recording_authentication

  boolean — Only authenticated users can view cloud recordings

• meeting_security

  object

  • 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.

  • block_user_domain_list

    array — The blocked domains.

    Items:

    string

  • 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.

  • embed_password_in_join_link

    boolean — Whether the meeting passcode is encrypted and included in the invitation link. The provided link will allow participants to join the meeting without having to enter the passcode.

  • encryption_type

    string, possible values: "enhanced_encryption", "e2ee" — The type of encryption used when starting a meeting. * `enhanced_encryption` - 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.

  • meeting_password

    boolean — Whether all instant and scheduled meetings that users can join via client or Zoom Rooms systems are passcode-protected. [Personal meeting ID (PMI)](https://support.zoom.us/hc/en-us/articles/203276937) meetings are **not** included in this setting.

  • meeting_password_requirement

    object — Information about the meeting and webinar [passcode requirements](https://support.zoom.us/hc/en-us/articles/360033559832-Meeting-and-webinar-passwords#h_a427384b-e383-4f80-864d-794bf0a37604).

    • consecutive_characters_length

      integer, possible values: 0, 4, 5, 6, 7, 8 — The maximum length of consecutive characters (for example, `abcdef`) allowed in a passcode. * `4` through `8` - The maximum consecutive characters length. The length is `n` minus `1`, where `n` is the value. For example, if the value is `4`, there can only be a maximum of `3` consecutive characters in a passcode, such as `abc1x@8fdh`. * `0` - No consecutive character restriction.

    • have_letter

      boolean — Whether passcodes must contain at least one letter character.

    • have_number

      boolean — Whether passcodes must contain at least one numeric character.

    • have_special_character

      boolean — Whether passcodes must contain at least one special character. For example, `!`, `@`, and/or `#` characters.

    • have_upper_and_lower_characters

      boolean — Whether passcodes must include uppercase and lowercase characters.

    • length

      integer — The minimum passcode length.

    • only_allow_numeric

      boolean — Whether passcodes must contain **only** numeric characters.

    • weak_enhance_detection

      boolean — Whether users are informed when the provided passcode 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 passcodes are required for participants joining by phone. If enabled and the meeting is passcode-protected, a numeric passcode is required for participants to join by phone. For meetings with alphanumeric passcodes, a numeric passcode will be generated.

  • pmi_password

    boolean — Whether all Personal Meeting ID (PMI) meetings that users can join via client or Zoom Rooms systems are passcode-protected.

  • require_password_for_scheduled_meeting

    boolean — Whether passcodes are required for meetings that have already been scheduled.

  • require_password_for_scheduled_webinar

    boolean — Whether passcodes are required 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. When the **Waiting Room** feature is enabled, the [**Allow participants to join before host**](https://support.zoom.us/hc/en-us/articles/202828525-Allow-participants-to-join-before-host) setting is disabled.

  • waiting_room_options

    object — Define how participants are admitted into a meeting, including if they can join before the host. Customize the waiting room design.

    • admit_domain_allowlist

      string — If the `admit_type` field is `4`, a comma-separated list of the domains that can bypass the waiting room (`example.com,example2.com`).

    • admit_type

      integer, possible values: 1, 2, 3, 4 — The type of admission for participants from the waiting room. * `1` - Everyone is automatically admitted. * `2` - Participants are manually admitted. * `3` - External users are manually admitted. Internal users are automatically admitted10 minutes before start time. * `4` - External users and users without approved domains are manually admitted. Internal users are automatically admitted.

    • enable

      boolean — Whether to enable the waiting room.

    • internal_user_auto_admit

      integer, possible values: 1, 2, 3, 4, 5 — If the `admit_type` in (`1`,`3`,`4`), the time when the internal user can join a meeting before the host. * `1` - when the host joins. * `2` - anytime. * `3` - 5 minutes before start time. * `4` - 10 minutes before start time. * `5` - 15 minutes before start time. If the `admit_type` equal `1`, this field value can not be `2`.

    • locked

      boolean — Whether to enable the option to lock after selecting `How are participants admitted from the waiting room`.

    • more_options

      object — More Options.

      • allow_participants_to_reply_to_host

        boolean — Allow participants in the waiting room to reply to host and co-hosts. This feature is only available with version 5.8.0 or later.

      • move_participants_to_waiting_room_when_host_dropped

        boolean — Move participants to the waiting room if the host dropped unexpectedly. By enabling this option, the waiting room setting will be enabled and locked, and participants will not be allowed to join before the host.

      • user_invited_by_host_can_bypass_waiting_room

        boolean — Users invited during the meeting by the host or co-hosts will bypass the waiting room. This feature is only available with version 5.4.0 or later.

    • sort_order_of_people

      integer, possible values: 0, 1 — The type of sort order of people in the waiting room in the participants panel. * `0` - Join order. * `1` - Alphabetical. This feature is only available with version 5.10.3 or later.

    • who_can_admit_participants

      integer, possible values: 0, 1 — The type of 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 (only if host and co-hosts are not present).

  • 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 passcode when scheduling webinars. Participants must use the generated passcode to join the scheduled webinar.

• in_meeting

  object

  • custom_data_center_regions

    boolean — Whether custom [data center regions](https://support.zoom.us/hc/en-us/articles/360042411451-Selecting-data-center-regions-for-meetings-webinars) are in use. * `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 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 selected custom [data center regions](https://support.zoom.us/hc/en-us/articles/360059254691-Datacenter-abbreviation-list). * `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"

  • unchecked_data_center_regions

    array — If the value of `custom_data_center_regions` is `true`, a comma-separated list the [data center regions](https://support.zoom.us/hc/en-us/articles/360059254691-Datacenter-abbreviation-list) that are **not** selected. * `EU` - Europe. * `HK` - Hong Kong. * `AU` - Australia. * `IN` - India. * `LA` - Latin America. * `TY` - Tokyo. * `CN` - China. * `US` - United States. * `CA` - Canada.

    Items:

    string, possible values: "EU", "HK", "AU", "IN", "TY", "CN", "US", "CA", "DE", "NL", "LA"

• in_session

  object

  • custom_data_center_regions

    boolean — Whether custom [data center regions](https://support.zoom.us/hc/en-us/articles/360042411451-Selecting-data-center-regions-for-meetings-webinars) are in use. * `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 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 selected custom [data center regions](https://support.zoom.us/hc/en-us/articles/360059254691-Datacenter-abbreviation-list). * `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.

  • unchecked_data_center_regions

    array — If the value of `custom_data_center_regions` is `true`, a comma-separated list the [data center regions](https://support.zoom.us/hc/en-us/articles/360059254691-Datacenter-abbreviation-list) that are **not** selected. * `EU` - Europe. * `HK` - Hong Kong. * `AU` - Australia. * `IN` - India. * `LA` - Latin America. * `TY` - Tokyo. * `CN` - China. * `US` - United States. * `CA` - Canada.

    Items:

    string, possible values: "EU", "HK", "AU", "IN", "TY", "CN", "US", "CA", "DE", "NL", "LA"

• recording

  object

  • auto_delete_cmr

    boolean — Whether cloud recordings are automatically deleted after a specific number of days.

  • auto_delete_cmr_days

    integer, possible values: 30, 60, 90, 120 — When the `auto_delete_cmr` value is `true`, the number of days before Zoom automatically deletes cloud recordings. * `30` - 30 days. * `60` - 60 days. * `90` - 90 days. * `120` - 120 days.

  • cloud_recording

    boolean — Whether hosts can record and save meetings or webinars to the cloud.

  • cloud_recording_download

    boolean — Whether to enable the [**Cloud recording downloads**](https://support.zoom.us/hc/en-us/articles/360060240972-Managing-cloud-recording-settings) setting.

  • record_audio_file

    boolean — Whether to record one audio file for all participants.

  • record_gallery_view

    boolean — Whether to enable recording the [**Gallery** view](https://support.zoom.us/hc/en-us/articles/360025561091-Recording-layouts#h_889dc825-9d79-4139-b65d-e719669c546b) during screen sharing.

  • record_speaker_view

    boolean — Whether to enable recording the [**Active Speaker** view](https://support.zoom.us/hc/en-us/articles/360025561091-Recording-layouts#h_5c001397-33d6-47fb-bb40-1a3f68401581) during screen sharing.

  • recording_audio_transcript

    boolean — Whether to enable the [**Audio transcription**](https://support.zoom.us/hc/en-us/articles/115004794983-Audio-transcription-for-cloud-recordings) feature.

  • save_chat_text

    boolean — Whether meeting and webinar chat texts are saved.

  • show_timestamp

    boolean — Whether timestamps are added to all meeting and webinar recordings.

• 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`

Example:

{
  "security": {
    "admin_change_user_info": true,
    "user_modifiable_info_by_admin": [
      "[\"name\",\"host_key\",\"sign_in_email\"]"
    ],
    "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"
        }
      ]
    },
    "hide_billing_info": true,
    "import_photos_from_devices": true,
    "password_requirement": {
      "consecutive_characters_length": 8,
      "have_special_character": true,
      "minimum_password_length": 8,
      "weak_enhance_detection": false
    },
    "sign_again_period_for_inactivity_on_client": 5,
    "sign_again_period_for_inactivity_on_web": 10,
    "sign_in_with_two_factor_auth": "none",
    "sign_in_with_two_factor_auth_groups": [
      "group"
    ],
    "sign_in_with_two_factor_auth_roles": [
      "role"
    ]
  },
  "audio_conferencing": {
    "toll_free_and_fee_based_toll_call": {
      "allow_webinar_attendees_dial": true,
      "enable": true,
      "numbers": [
        {
          "code": "86",
          "country_code": "CN",
          "country_name": "China",
          "display_number": "+86 777 777 77",
          "number": "777 777 77"
        }
      ]
    },
    "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",
      "allow_webinar_attendees_call_me": true,
      "call_out_countries": {
        "allowed_countries": [
          {
            "code": "CN",
            "name": "China"
          }
        ],
        "selected_countries": [
          {
            "code": "CN",
            "name": "China"
          }
        ]
      }
    },
    "personal_audio_conference": true,
    "participant_phone_masking": {
      "enable": true,
      "masking_type": "mask_default"
    },
    "global_dial_in_countries": {
      "allowed_countries": [
        {
          "code": "CN",
          "name": "China"
        }
      ],
      "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
  },
  "email_notification": {
    "alternative_host_reminder": true,
    "cancel_meeting_reminder": true,
    "cloud_recording_available_reminder": true,
    "jbh_reminder": true,
    "low_host_count_reminder": true,
    "recording_available_reminder_alternative_hosts": true,
    "recording_available_reminder_schedulers": true,
    "schedule_for_reminder": true
  },
  "feature": {
    "meeting_capacity": 100
  },
  "in_meeting": {
    "auto_generated_translation": {
      "language_item_pairList": {
        "trans_lang_config": [
          {
            "speak_language": {
              "name": "Chinese (Simplified)",
              "code": "zh"
            },
            "translate_to": {
              "all": true,
              "language_config": [
                {
                  "name": "English",
                  "code": "en"
                }
              ]
            }
          }
        ],
        "all": true
      },
      "enable": true
    },
    "alert_guest_join": true,
    "allow_host_to_enable_focus_mode": true,
    "allow_live_streaming": true,
    "allow_participants_chat_with": 4,
    "allow_participants_to_rename": true,
    "allow_show_zoom_windows": true,
    "allow_users_save_chats": 2,
    "annotation": true,
    "anonymous_question_answer": true,
    "attention_mode_focus_mode": true,
    "auto_answer": true,
    "auto_saving_chat": true,
    "breakout_room": true,
    "breakout_room_schedule": true,
    "chat": true,
    "meeting_question_answer": true,
    "closed_caption": true,
    "closed_captioning": {
      "auto_transcribing": true,
      "enable": true,
      "save_caption": true,
      "third_party_captioning_service": true,
      "view_full_transcript": true
    },
    "co_host": true,
    "custom_data_center_regions": true,
    "custom_live_streaming_service": true,
    "custom_service_instructions": "1234",
    "meeting_data_transit_and_residency_method": "On-Prem",
    "data_center_regions": [
      "AU",
      "LA",
      "CA",
      "CN",
      "DE",
      "HK",
      "IN",
      "IE",
      "TY",
      "MX",
      "NL",
      "SG",
      "US"
    ],
    "disable_screen_sharing_for_host_meetings": true,
    "disable_screen_sharing_for_in_meeting_guests": true,
    "dscp_audio": 1,
    "dscp_marking": true,
    "dscp_video": 63,
    "dscp_dual": false,
    "e2e_encryption": true,
    "entry_exit_chime": "none",
    "far_end_camera_control": true,
    "feedback": true,
    "file_transfer": true,
    "group_hd": true,
    "webinar_group_hd": true,
    "join_from_desktop": true,
    "join_from_mobile": true,
    "language_interpretation": {
      "custom_languages": [
        "English"
      ],
      "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",
        "Chinese",
        "Japanese",
        "German",
        "French",
        "Russian",
        "Portuguese",
        "Spanish",
        "Korean"
      ]
    },
    "sign_language_interpretation": {
      "enable": true,
      "enable_sign_language_interpretation_by_default": true,
      "languages": [
        "American"
      ],
      "custom_languages": [
        "Language1"
      ]
    },
    "live_streaming_facebook": true,
    "live_streaming_youtube": true,
    "manual_captioning": {
      "allow_to_type": true,
      "auto_generated_captions": true,
      "full_transcript": true,
      "manual_captions": true,
      "save_captions": true,
      "third_party_captioning_service": true
    },
    "meeting_polling": {
      "advanced_polls": true,
      "allow_alternative_host_to_add_edit": true,
      "manage_saved_polls_and_quizzes": true,
      "allow_host_to_upload_image": true,
      "require_answers_to_be_anonymous": true,
      "enable": true
    },
    "meeting_reactions": true,
    "meeting_reactions_emojis": "all",
    "allow_host_panelists_to_use_audible_clap": true,
    "webinar_reactions": true,
    "meeting_survey": true,
    "original_audio": true,
    "p2p_connetion": true,
    "p2p_ports": true,
    "polling": true,
    "ports_range": "1;65535",
    "post_meeting_feedback": true,
    "private_chat": true,
    "record_play_own_voice": true,
    "remote_control": true,
    "non_verbal_feedback": true,
    "remote_support": true,
    "request_permission_to_unmute_participants": true,
    "screen_sharing": true,
    "sending_default_email_invites": true,
    "show_a_join_from_your_browser_link": true,
    "show_meeting_control_toolbar": true,
    "slide_control": true,
    "stereo_audio": true,
    "unchecked_data_center_regions": [
      "EU",
      "HK",
      "AU",
      "IN",
      "TY",
      "CN",
      "US",
      "CA",
      "DE",
      "NL",
      "LA"
    ],
    "use_html_format_email": true,
    "virtual_background": true,
    "virtual_background_settings": {
      "allow_upload_custom": true,
      "allow_videos": true,
      "enable": true,
      "files": [
        {
          "id": "ra3NawGWScGhY1hqfY2MJw",
          "is_default": true,
          "name": "file name",
          "size": 41519,
          "type": "image"
        }
      ]
    },
    "watermark": true,
    "webinar_chat": {
      "allow_attendees_chat_with": 2,
      "allow_auto_save_local_chat_file": true,
      "allow_panelists_chat_with": 1,
      "allow_panelists_send_direct_message": true,
      "allow_users_save_chats": 0,
      "allow_users_to_delete_messages_in_meeting_chat": true,
      "default_attendees_chat_with": 1,
      "enable": true
    },
    "webinar_live_streaming": {
      "custom_service_instructions": "The specific instructions",
      "enable": true,
      "live_streaming_reminder": true,
      "live_streaming_service": [
        "facebook"
      ]
    },
    "webinar_polling": {
      "advanced_polls": true,
      "allow_alternative_host_to_add_edit": true,
      "require_answers_to_be_anonymous": true,
      "manage_saved_polls_and_quizzes": true,
      "allow_host_to_upload_image": true,
      "enable": true
    },
    "webinar_question_answer": true,
    "webinar_survey": true,
    "whiteboard": true,
    "who_can_share_screen": "all",
    "who_can_share_screen_when_someone_is_sharing": "all",
    "participants_share_simultaneously": "multiple",
    "workplace_by_facebook": true,
    "transfer_meetings_between_devices": true,
    "meeting_summary_with_ai_companion": {
      "enable": true,
      "auto_enable": true,
      "who_will_receive_summary": 1
    },
    "webinar_summary_with_ai_companion": {
      "enable": true,
      "auto_enable": true,
      "who_will_receive_summary": 1
    },
    "ai_companion_questions": {
      "enable": true,
      "auto_enable": true,
      "who_can_ask_questions": 1
    },
    "webinar_ai_companion_questions": {
      "enable": true,
      "auto_enable": true,
      "who_can_ask_questions": 1
    }
  },
  "integration": {
    "box": true,
    "dropbox": true,
    "google_calendar": true,
    "google_drive": true,
    "kubi": true,
    "microsoft_one_drive": true
  },
  "other_options": {
    "allow_auto_active_users": true,
    "allow_users_contact_support_via_chat": true,
    "allow_users_enter_and_share_pronouns": true,
    "blur_snapshot": true,
    "display_meetings_scheduled_for_others": true,
    "meeting_qos_and_mos": 0,
    "show_one_user_meeting_on_dashboard": true,
    "use_cdn": "none",
    "webinar_registration_options": {
      "allow_host_to_enable_join_info": true,
      "allow_host_to_enable_social_share_buttons": true,
      "enable_custom_questions": true
    },
    "email_in_attendee_report_for_meeting": true
  },
  "profile": {
    "recording_storage_location": {
      "allowed_values": [
        "US",
        "AU",
        "CA",
        "DE",
        "JP",
        "BR",
        "SG",
        "IN"
      ],
      "value": "US"
    }
  },
  "recording": {
    "account_user_access_recording": true,
    "allow_recovery_deleted_cloud_recordings": true,
    "archive": {
      "enable": true,
      "settings": {
        "audio_file": true,
        "cc_transcript_file": true,
        "chat_file": true,
        "chat_with_sender_email": true,
        "video_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": "guest"
      },
      "type": 2
    },
    "auto_delete_cmr": true,
    "auto_delete_cmr_days": 90,
    "auto_recording": "cloud",
    "cloud_recording": true,
    "cloud_recording_download": true,
    "cloud_recording_download_host": true,
    "display_participant_name": true,
    "host_delete_cloud_recording": true,
    "ip_address_access_control": {
      "enable": true,
      "ip_addresses_or_ranges": "46.33.24.184"
    },
    "local_recording": true,
    "optimize_recording_for_3rd_party_video_editor": true,
    "prevent_host_access_recording": true,
    "record_audio_file": true,
    "record_audio_file_each_participant": true,
    "record_files_separately": {
      "active_speaker": true,
      "gallery_view": true,
      "shared_screen": true
    },
    "record_gallery_view": true,
    "record_speaker_view": true,
    "recording_audio_transcript": true,
    "smart_recording": {
      "create_recording_highlights": true,
      "create_smart_chapters": true,
      "create_next_steps": true
    },
    "recording_password_requirement": {
      "have_letter": true,
      "have_number": true,
      "have_special_character": true,
      "length": 10,
      "only_allow_numeric": true
    },
    "recording_thumbnails": true,
    "required_password_for_existing_cloud_recordings": true,
    "required_password_for_shared_cloud_recordings": true,
    "save_chat_text": true,
    "save_close_caption": true,
    "save_panelist_chat": true,
    "save_poll_results": true,
    "show_timestamp": true,
    "recording_notification_for_zoom_client": {
      "disclaimer_to_participants": "All participants or Guest only",
      "play_voice_prompt": " All participants or Guest only or  No one",
      "ask_host_to_confirm": true
    }
  },
  "schedule_meeting": {
    "audio_type": "both",
    "enforce_login": true,
    "enforce_login_domains": "example.com",
    "enforce_login_with_domains": true,
    "force_pmi_jbh_password": true,
    "host_video": true,
    "enable_dedicated_group_chat": true,
    "jbh_time": 10,
    "join_before_host": true,
    "meeting_password_requirement": {
      "consecutive_characters_length": 5,
      "have_letter": true,
      "have_number": true,
      "have_special_character": true,
      "have_upper_and_lower_characters": true,
      "length": 10,
      "only_allow_numeric": true,
      "weak_enhance_detection": true
    },
    "not_store_meeting_topic": true,
    "participant_video": true,
    "allow_host_to_disable_participant_video": true,
    "personal_meeting": true,
    "require_password_for_instant_meetings": true,
    "require_password_for_pmi_meetings": "none",
    "require_password_for_scheduled_meetings": true,
    "require_password_for_scheduling_new_meetings": true,
    "use_pmi_for_instant_meetings": true,
    "use_pmi_for_scheduled_meetings": 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
    },
    "meeting_template": {
      "enable": true,
      "templates": [
        {
          "id": "ydCUQzzVT6WZ_r_K_2iFzg",
          "name": "meeting_template_name",
          "enable": true
        }
      ]
    },
    "continuous_meeting_chat": {
      "enable": true,
      "can_add_external_users": true,
      "auto_add_invited_external_users": true
    }
  },
  "telephony": {
    "audio_conference_info": "test",
    "telephony_regions": {
      "allowed_values": [
        "CNTB",
        "USTB"
      ],
      "selection_values": "USTB"
    },
    "third_party_audio": false
  },
  "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": {
      "allowed_countries": [
        {
          "code": "CN",
          "name": "China"
        }
      ],
      "selected_countries": [
        {
          "code": "CN",
          "name": "China"
        }
      ]
    }
  },
  "zoom_rooms": {
    "auto_start_stop_scheduled_meetings": true,
    "cmr_for_instant_meeting": true,
    "force_private_meeting": true,
    "hide_host_information": true,
    "list_meetings_with_calendar": true,
    "start_airplay_manually": true,
    "ultrasonic": true,
    "upcoming_meeting_alert": true,
    "weekly_system_restart": true,
    "zr_post_meeting_feedback": true
  },
  "smart_recognition": {
    "personalized_audio_isolation": true,
    "zoom_rooms": {
      "video_name_tags": {
        "enabled": true,
        "allow_user_photos": true,
        "allow_enrollment_email": true,
        "allow_external_identification": true
      },
      "voice_name_tags": {
        "enabled": true,
        "allow_enrollment_email": true,
        "allow_external_identification": true
      }
    },
    "workplace_app": {
      "voice_name_tags": {
        "enabled": true,
        "allow_enrollment_email": true
      }
    }
  },
  "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
  }
}

Status: 404 **HTTP Status Code:** `404` <br> Not Found **Error Code:** `2001` <br> Account does not exist: $accountId <br>

Status: 429 **HTTP Status Code:** `429` <br> Too Many Requests. For more information, see [rate limits](https://developers.zoom.us/docs/api/rest/rate-limits/).

Update account settings

• Method: PATCH
• Path: /accounts/{accountId}/settings
• Tags: Accounts

Update an account's settings. To update the settings for a master account, pass the me value for the accountId path parameter.

Prerequisites:

• The account must be a paid account.

Scopes: account:write:admin

Granular Scopes: account:update:settings:master

Rate Limit Label: MEDIUM

Request Body

Content-Type: application/json

One of:

• audio_conferencing

  object — Account 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.

    • 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.

  • 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).

      • 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 **Toll-free and Fee-based 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.

• 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 internal or external domains or emails. * 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 internal or external domains or emails. * 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 — Specified domains.

      Items:

      string — Specified domains.

  • chat_emojis

    object — Chat emojis.

    • emojis_option

      string, possible values: "all", "selected" — All emojis / selected emojis

    • 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, 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.

    • operate

      string, possible values: "create", "update", "delete" — The policy operation to perform for the update. * `create` - Create policies. * `update` - Update policies. * `delete` - Delete policies.

    • 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.

  • 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`, and it is required.

    • 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`, and it is required.

    • smtp_delivery_address

      string — SMTP delivery address. It is used when the field `type` value is `global_relay`, and it is required.

    • 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`, and it is required.

  • 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 and view 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 — User restrictions for sharing and viewing 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 — Specified file types for all users.

        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 — Specified file types for external users.

        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 — Account Settings: Notification.

  • alternative_host_reminder

    boolean — Notify when an alternative host is set or removed from a meeting.

  • cancel_meeting_reminder

    boolean — Notify the host and participants when a meeting is cancelled.

  • cloud_recording_available_reminder

    boolean — Whether to notify the host when a cloud recording is available.

  • jbh_reminder

    boolean — Notify the host when participants join the meeting before them.

  • low_host_count_reminder

    boolean — Notify 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 — Notify the host there is a meeting is scheduled, rescheduled, or cancelled.

• feature

  object — Account Settings: Feature.

  • meeting_capacity

    integer — Set 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.

• in_meeting

  object — In Meeting Account Settings

  • alert_guest_join

    boolean — Whether to enable [guest participant](https://support.zoom.us/hc/en-us/articles/115004791123-Identifying-guests-in-the-meeting-webinar) alerts.

  • 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. This value defaults to `null`.

  • allow_live_streaming

    boolean — Whether to allow livestreaming.

  • allow_participants_chat_with

    integer, possible values: 1, 2, 3, 4 — Whether to allow participants to only chat with certain groups. * `1` - The participant cannot use chat. * `2` - Host and co-hosts only. * `3` - The participant can chat with other participants publicly. * `4` - The participant can chat with other participants publicly and privately. **Note:** This setting is only available with client versions 5.7.3 and above.

  • allow_participants_to_rename

    boolean — Whether to allow meeting participants to rename themselves during a meeting.

  • allow_show_zoom_windows

    boolean — Whether to enable the [**Show Zoom windows during screen share**](https://support.zoom.us/hc/en-us/articles/360061383571-Showing-Zoom-windows-during-screen-share) feature.

  • allow_users_save_chats

    integer, possible values: 1, 2, 3 — Whether to allow participants to 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 to allow meeting participants to use the [annotation tools](https://support.zoom.us/hc/en-us/articles/115005706806).

  • anonymous_question_answer

    boolean — Whether to enable anonymous Q&amp;A.

  • attendee_on_hold

    boolean, default: false — Whether to allow the host to put an attendee on hold. This value defaults to `false`. **This field has been deprecated and is no longer supported.**

  • attention_mode_focus_mode

    boolean, default: false — Whether to enable [**Focus Mode**](https://support.zoom.us/hc/en-us/articles/360061113751-Using-focus-mode). When enabled, this feature only displays the host and co-hosts' video and profile pictures during a meeting. This value defaults to `false`.

  • auto_answer

    boolean — Whether to enable the [**Auto-answer group in chat**](https://support.zoom.us/hc/en-us/articles/203736135-Auto-answering-invitations-to-meetings) setting. Calls from these group members will be answered automatically.

  • auto_generated_translation

    object — The [translated captions](https://support.zoom.us/hc/en-us/articles/6643133682957-Enabling-and-configuring-translated-captions) setting in meetings.

    • enable

      boolean — The option for participants to enable the automated translation captions in meetings.

    • language_item_pairList

      object — The input speaking language and output caption language pair list.

      • all

        boolean — The option to select all language pairs.

      • trans_lang_config

        array — The speaking language and caption language list.

        Items:

        • speak_language

          object — The input speaking language in meetings.

          • code

            string, possible values: "zh", "nl", "en", "fr", "de", "it", "ja", "ko", "pt", "ru", "es", "uk" — The input speaking language [code](https://developers.zoom.us/docs/api/rest/other-references/abbreviation-lists/#languages).

          • name

            string, possible values: "Chinese (Simplified)", "Dutch", "English", "French", "German", "Italian", "Japanese", "Korean", "Portuguese", "Russian", "Spanish", "Ukrainian" — The input speaking language.

        • translate_to

          object — The translated output caption language.

          • all

            boolean — The option to select all translated output caption languages.

          • language_config

            array — The translated output caption language list.

            Items:

            • code

              string, possible values: "en" — The translated output caption [language code](https://developers.zoom.us/docs/api/rest/other-references/abbreviation-lists/#languages).

            • name

              string, possible values: "English" — The translated output caption language name.

  • auto_saving_chat

    boolean — Whether to automatically save all in-meeting chats.

  • breakout_room

    boolean — Whether to allow the meeting host to split meeting participants into separate breakout 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 to enable chat during meeting for all participants.

  • closed_caption

    boolean — Whether to enable closed captions.

  • closed_captioning

    object — Information about the account's closed captioning settings.

    • auto_transcribing

      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).

    • enable

      boolean — Whether to enable [closed captioning and transcription services](https://support.zoom.us/hc/en-us/articles/4409683389709-Enabling-or-disabling-closed-captioning-and-live-transcription-services).

    • save_caption

      boolean — Whether to allow participants to [save closed captions or transcripts](https://support.zoom.us/hc/en-us/articles/360060958752). **Note:** If the `view_full_transcript` field is set to `false`, participants **cannot** save captions.

    • third_party_captioning_service

      boolean — Whether to allow the use of an API token to integrate with a [3rd-party device](https://support.zoom.us/hc/en-us/articles/115002212983) to provide closed captioning.

    • view_full_transcript

      boolean — Whether to enable the viewing of full transcripts in the in-meeting side panel.

  • co_host

    boolean — Whether to allow the host to add co-hosts.

  • 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.

  • custom_live_streaming_service

    boolean — Whether to allow custom livestreaming.

  • custom_service_instructions

    string — The specific instructions to configure a custom livestream.

  • 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"

  • 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_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`.

  • e2e_encryption

    boolean — Whether to require [AES encryption](https://en.wikipedia.org/wiki/Advanced_Encryption_Standard) for meetings.

  • entry_exit_chime

    string, possible values: "host", "all", "none" — When to play the meeting entry or exit sound notification. * `host` - Only when the host joins or leaves. * `all` - When any participant joins or leaves. * `none` - Disable the entry/exit sound notification.

  • far_end_camera_control

    boolean — Whether to allow another user to take control of the user's camera.

  • feedback

    boolean — Whether to enable the [**Feedback to Zoom**](https://support.zoom.us/hc/en-us/articles/115005838023-Feedback-to-Zoom) setting.

  • file_transfer

    boolean — Whether to enable the [**Send files via meeting chat**](https://support.zoom.us/hc/en-us/articles/209605493-In-meeting-file-transfer) setting.

  • group_hd

    boolean — Whether to enable group HD video in Meeting.

  • join_from_desktop

    boolean — Whether to allow participants to join a meeting directly from their desktop browser. Note that the meeting experience from the desktop browser is limited.

  • join_from_mobile

    boolean — Whether to allow participants to join a meeting directly from their mobile browser. Note that the meeting experience from the mobile browser is limited.

  • 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 the 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 to allow hosts to assign participants as interpreters who can interpret one language into another in real-time.

    • enable_language_interpretation_by_default

      boolean — Whether to enable language interpretation by default.

  • live_streaming_facebook

    boolean — Whether to allow Facebook livestreaming.

  • live_streaming_youtube

    boolean — Whether to allow YouTube livestreaming.

  • manual_captioning

    object — Information about manual captioning settings.

    • allow_to_type

      boolean — Whether to allow the host to manually caption or let the host assign a participant to provide manual captioning.

    • 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).

    • full_transcript

      boolean — Whether to enable the viewing of full transcripts in the in-meeting side panel.

    • manual_captions

      boolean — Whether to [enable manual closed captioning](https://support.zoom.us/hc/en-us/articles/207279736-Managing-closed-captioning-and-live-transcription).

    • save_captions

      boolean — Whether to allow participants to [save closed captions 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.

    • third_party_captioning_service

      boolean — Whether to allow the use of an API token to integrate with a [3rd-party device](https://support.zoom.us/hc/en-us/articles/115002212983) to provide closed captioning.

  • meeting_data_transit_and_residency_method

    string, possible values: "cloud", "On-Prem" — Select meeting data transit and residency method for meeting hosts and participants. `cloud` - Zoom Cloud. `On-Prem` - On-Prem (Zoom Meeting Connector, only applicable for licensed users).

  • meeting_polling

    object — Information about the account's meeting polling settings.

    • advanced_polls

      boolean — Whether to allow the host to create advanced polls and quizzes. Advanced polls and quizzes include single choice, multiple choice, drop down, matching, short answer, long answer, rank order, and fill-in-the-blank questions. Hosts can also set the correct answers for quizzes they create.

    • allow_alternative_host_to_add_edit

      boolean — Whether to allow the alternative host to 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 to allow the host to 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 to allow users to select original sound in their client settings.

  • 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.

  • participants_share_simultaneously

    string, possible values: "multiple", "one" — Indicates how many participants can share at the same time. The value can be one of the following: `one`: Only one participant can share at a time . `multiple`: Multiple participants can share simultaneously (dual monitors recommended).

  • polling

    boolean — Whether to add polls to the meeting controls.

  • 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.

  • post_meeting_feedback

    boolean — Whether to display a thumbs up or thumbs down feedback survey at the end of each meeting.

  • private_chat

    boolean — Whether to [enable private chat](https://support.zoom.us/hc/en-us/articles/360060835932-Enabling-and-disabling-private-chat) between participants during meetings.

  • record_play_own_voice

    boolean — Whether to let the user record and play their own voice.

  • remote_control

    boolean — Whether to enable the [**Remote control**](https://support.zoom.us/hc/en-us/articles/201362673-Requesting-or-giving-remote-control) setting.

  • 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.

  • screen_sharing

    boolean — Whether to allow hosts and participants to share their screen or content during meetings.

  • sending_default_email_invites

    boolean — Whether to enable the [**Only show default email when sending email invites**](https://support.zoom.us/hc/en-us/articles/360061433531-Showing-default-email-when-sending-email-invites) setting.

  • show_a_join_from_your_browser_link

    boolean — Whether to allow participants to join a meeting directly from their browser and bypass the Zoom application download process. This is useful for participants who cannot download, install, or run applications. Note that the meeting experience from the browser is limited.

  • show_meeting_control_toolbar

    boolean — Whether to display the in-meeting control toolbar.

  • 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.

  • 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 to allow users to select stereo audio in their client settings.

  • transfer_meetings_between_devices

    boolean — Users can move to a new device without leaving the meeting they're in.

  • use_html_format_email

    boolean — Whether to enable the use of HTML-formatted emails for the Outlook plugin.

  • virtual_background

    boolean — Whether to enable Virtual Backgrounds.

  • virtual_background_settings

    object — The account's Virtual Background settings.

    • allow_upload_custom

      boolean — Whether to allow user to upload custom Virtual Backgrounds.

    • allow_videos

      boolean — Whether to allow the use of videos for Virtual Backgrounds.

    • enable

      boolean — Whether to enable Virtual Backgrounds.

    • files

      array — Information about the Virtual Background files.

      Items:

      • id

        string — The Virtual Background file's ID.

      • is_default

        boolean — Whether the file is the default Virtual Background file.

      • name

        string — The Virtual Background file's name.

      • size

        integer — The Virtual Background file's size, in bytes.

      • type

        string — The Virtual Background file's type.

  • watermark

    boolean — Whether to include a [watermark](https://support.zoom.us/hc/en-us/articles/209605273-Adding-an-image-watermark) when viewing a shared screen.

  • webinar_chat

    object — Information about the account's webinar chat settings.

    • allow_attendees_chat_with

      integer, possible values: 1, 2, 3 — Who to let webinar attendees chat with. * `1` - No one. * `2` - Host and all panelists. * `3` - Everyone.

    • allow_auto_save_local_chat_file

      boolean — Whether to automatically save chat messages to a local file on the host's computer when the webinar ends.

    • allow_panelists_chat_with

      integer, possible values: 1, 2 — Who to let webinar panelists chat with. * `1` - Host and all panelists. * `2` - Everyone.

    • allow_panelists_send_direct_message

      boolean — Whether to allow webinar panelists to send direct messages to other panelists.

    • allow_users_save_chats

      integer, possible values: 0, 1, 2 — Whether to allow webinar attendees to 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, allow webinar attendees to chat with: * `1` - Host and all panelists. * `2` - Everyone.

    • enable

      boolean — Whether to allow webinar participants to send chat messages.

  • webinar_group_hd

    boolean — Whether to enable group HD video in Webinar.

  • webinar_live_streaming

    object

    • custom_service_instructions

      string — The specific instructions to allow the account's meeting hosts to configure a custom livestream.

    • enable

      boolean — Whether to enable webinar livestreaming.

    • 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` - Facebook. * `workplace_by_facebook` - Workplace by Facebook. * `youtube` - YouTube. * `custom_live_streaming_service` - 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 to allow the host to create advanced polls and quizzes. Advanced polls and quizzes include single choice, multiple choice, drop down, matching, short answer, long answer, rank order, and fill-in-the-blank questions. Hosts can also set the correct answers for quizzes they create.

    • allow_alternative_host_to_add_edit

      boolean — Whether to allow the alternative host to 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 to allow the host to add polls before or during a webinar.

    • manage_saved_polls_and_quizzes

      boolean — Whether to allow users to manage saved polls and quizzes from Webinars

    • require_answers_to_be_anonymous

      boolean — Whether to require answers to be anonymous.

  • 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 to allow the host to present surveys to attendees once a webinar has ended.

  • whiteboard

    boolean — Whether to enable the [**Zoom Whiteboard**](https://support.zoom.us/hc/en-us/articles/4410916881421) feature.

  • 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.

• integration

  object — Account Integration Settings

  • box

    boolean — Whether to allow users who join a meeting from their mobile device to share content from their Box account.

  • dropbox

    boolean — Whether to allow users who join a meeting from their mobile device to share content from their Dropbox account.

  • google_calendar

    boolean — Whether to enable the scheduling of meetings using Google Calendar.

  • google_drive

    boolean — Whether to allow users who join a meeting from their mobile device to share content from their Google Drive.

  • kubi

    boolean — Whether to allow users to control a connected Kubi device from within a Zoom meeting.

  • microsoft_one_drive

    boolean — Whether to allow users who join a meeting from their mobile device to 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.

• other_options

  object

  • allow_auto_active_users

    boolean — If true, administrators can activate users with a single default passcode when adding users. This activates added users immediately without waiting for them to set their own passcode.

  • allow_users_contact_support_via_chat

    boolean — If true, displays the Zoom Help badge on the bottom-right of the page.

  • allow_users_enter_and_share_pronouns

    boolean — If true, users can add pronouns to their profile cards and share them during meetings and webinars.

  • 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.

  • display_meetings_scheduled_for_others

    boolean — If true, a user with [scheduling privileges](https://support.zoom.us/hc/en-us/articles/201362803-Scheduling-privilege) can view other users' meetings.

  • email_in_attendee_report_for_meeting

    boolean — If true, include authenticated guests' email addresses in attendee reports for 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` - Display the meeting quality score and network alerts on the dashboard and use custom thresholds for quality scores and network alerts.

  • show_one_user_meeting_on_dashboard

    boolean — If true, 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_join_info

      boolean — Allow host to enable **Show join info on registration confirmation page**.

    • allow_host_to_enable_social_share_buttons

      boolean — Allow host to enable **Show social share buttons on registration page**.

    • enable_custom_questions

      boolean — Enable custom questions.

• profile

  object

  • recording_storage_location

    object

    • allowed_values

      array — Users can choose the country to store their recorded content. Content can include meeting, webinar, and phone recordings, as well as voicemail, transcripts, and custom greeting prompts. See [Managing the Communications Content storage location](https://support.zoom.us/hc/en-us/articles/360050781131) for details. Provide abbreviated country codes as the value for this field. See the [Countries abbreviation list](https://developers.zoom.us/docs/api/rest/other-references/abbreviation-lists/#countries) for details.

      Items:

      string

    • value

      string — Abbreviated country code.

• recording

  object — Account Settings: Recording.

  • account_user_access_recording

    boolean — 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 — Allow recovery of deleted cloud recordings from trash. If the value of this field is set to `true`, deleted cloud recordings will be kept in trash for 30 days after deletion and can be recovered within that period.

  • archive

    object — [Archiving solution](https://support.zoom.us/hc/en-us/articles/360050431572-Archiving-Meeting-and-Webinar-data) settings. This setting can only be used if you have been granted with archiving solution access by the Zoom support team.

    • enable

      boolean — Enable the archiving feature.

    • 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 — Include in-meeting and/or in-webinar audio in the archive.

      • cc_transcript_file

        boolean — Include closed caption or transcript in the archive.

      • chat_file

        boolean — Include in-meeting chat in the archive.

      • chat_with_direct_message

        boolean — Include direct message in in-meeting chat file.

      • chat_with_sender_email

        boolean — Include user email in 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 — Include in-meeting and/or in-webinar video in the archive.

    • type

      integer, possible values: 1, 2, 3 — Archive types. * `1`: Only meetings are archived. * `2`: Only webinars are archived. * `3`: Both meetings and webinars are archived.

  • auto_delete_cmr

    boolean — Allow Zoom to permanently delete recordings automatically after a specified number of days.

  • 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, possible values: "local", "cloud", "none" — Automatic recording: `local` - Record on local. `cloud` - Record on cloud. `none` - Disabled.

  • cloud_recording

    boolean — Allow hosts to record and save the meeting in the cloud.

  • cloud_recording_download

    boolean — Cloud recording downloads.

  • cloud_recording_download_host

    boolean — Only the host can download cloud recordings.

  • display_participant_name

    boolean — Whether to display participants' names in the recording.

  • host_delete_cloud_recording

    boolean — If the value of this field is set to `true`, hosts will be able to delete the recordings. If this option is set to `false`, the recordings cannot be deleted by the host and only admin can delete them.

  • ip_address_access_control

    object — Setting to allow cloud recording access only from specific IP address ranges.

    • enable

      boolean — If set to `true`, the cloud recordings of this account can only be accessed by the IP addresses defined in the `ip_addresses_or_ranges` property.

    • ip_addresses_or_ranges

      string — IP addresses or ranges that have access to the cloud recordings. Separate multiple IP ranges with comma. Use n.n.n.n, n.n.n.n/n or n.n.n.n - n.n.n.n syntax where n is a number. Example: `46.33.24.184, 48.99.100.2/25` or `200.181.108.17 - 220.181.108.157`

  • local_recording

    boolean — Allow hosts and participants to record the meeting using a local file.

  • optimize_recording_for_3rd_party_video_editor

    boolean — Whether to optimize recordings for a 3rd party video editor. This may increase the file size and the time it takes to generate recording files.

  • prevent_host_access_recording

    boolean — If set to `true`, meeting hosts cannot view their meeting cloud recordings. Only the admins who have recording management privilege can access them.

  • record_audio_file

    boolean — Whether to record one audio file for all participants.

  • record_audio_file_each_participant

    boolean — Whether to record a separate audio file for each participant. This only supports a maximum of 200 participants' audio files.

  • 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 to record the active speaker only.

    • gallery_view

      boolean — Whether to record the gallery view only.

    • shared_screen

      boolean — Whether to record the shared screen only.

  • record_gallery_view

    boolean — Record the gallery view with a shared screen.

  • record_speaker_view

    boolean — Record the active speaker with a shared screen.

  • recording_audio_transcript

    boolean — Automatically transcribe the audio of the meeting or webinar to the cloud.

  • recording_disclaimer

    boolean — Show a disclaimer to participants before a recording starts This field has been deprecated. The replacement field is recording_notification_for_zoom_client

  • recording_highlight

    boolean — Whether to enable the [recording highlights](https://support.zoom.us/hc/en-us/articles/360060802432) feature.

  • recording_notification_for_zoom_client

    object — Setting name: Recording notifications - Zoom clients

    • ask_host_to_confirm

      boolean — Update Child setting name is [Ask host to confirm before starting a recording], true: enable, false: disable

    • disclaimer_to_participants

      string, possible values: "All participants", "Guest only" — Update child setting name is [Show a disclaimer to participants when a recording starts]. The value is feature name, its includes "All participants" or "Guest only".

    • play_voice_prompt

      string, possible values: "All participants", "Guest only", "No one" — Update child setting name is [Play voice prompt for]. The value is feature name, its includes "All participants" or "Guest only" or "No one"

  • recording_password_requirement

    object — This object represents the minimum passcode requirements set for recordings via Account Recording Settings.

    • have_letter

      boolean — Indicates whether or not passcode must contain at least one alphabetical letter (a, b, c..).

    • have_number

      boolean — Indicates whether or not passcode must contain at least one number(1, 2, 3..).

    • have_special_character

      boolean — Indicates whether or not passcode must contain at least one special character(!, @, #..).

    • length

      integer — Minimum required length for the passcode.

    • only_allow_numeric

      boolean — Indicates whether or not passcode must contain only numeric characters.

  • recording_thumbnails

    boolean — Whether to record thumbnails of the presenter when they are sharing their screen.

  • required_password_for_existing_cloud_recordings

    boolean — Require a passcode to access existing cloud recordings.

  • required_password_for_shared_cloud_recordings

    boolean — Whether to require a passcode to share cloud recordings.

  • save_chat_text

    boolean — Save the chat text from the meeting.

  • save_close_caption

    boolean — Whether to save [closed captions](https://support.zoom.us/hc/en-us/articles/207279736) as a VTT (Video Track Text) file.

  • save_panelist_chat

    boolean — Whether to save panelist chat to the recording. This setting saves messages sent by panelists during a webinar to either all panelists or all panelists and attendees to the recording.

  • save_poll_results

    boolean — Whether to save poll results shared during the meeting or webinar. This also includes poll results shared during the meeting or webinar.

  • show_timestamp

    boolean — Add a timestamp to the recording.

  • 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 — Account Settings: Schedule Meeting.

  • allow_host_to_disable_participant_video

    boolean — Allow host to disable participant video when scheduling a meeting.

  • 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 to enable the **Always display `Zoom Meeting` as the meeting topic** setting.

  • 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 to enable the **Always show `Zoom Webinar` as the webinar topic** setting.

  • audio_type

    string, possible values: "both", "telephony", "voip", "thirdParty", default: "both" — Determine how participants can join the audio portion of the meeting. `both` - Telephony and VoIP. `telephony` - Audio PSTN telephony only. `voip` - VoIP only. `thirdParty` - 3rd party audio conference.

  • continuous_meeting_chat

    object — Information about the **Enable continuous meeting chat** feature.

    • auto_add_invited_external_users

      boolean — Whether to enable the **Automatically add invited external users** setting.

    • can_add_external_users

      boolean — Whether to enable the **External users can be added** setting.

    • enable

      boolean — Whether to enable the **Enable continuous meeting chat** setting.

  • enable_dedicated_group_chat

    boolean — Enable dedicated group chats for meeting conversations.

  • enforce_login

    boolean — Only Zoom users who are signed in can join meetings.

  • enforce_login_domains

    string — Only signed in users with a specified domain can join the meeting.

  • enforce_login_with_domains

    boolean — Only signed in users with a specific domain can join meetings.

  • force_pmi_jbh_password

    boolean — Require a passcode for Personal Meetings if attendees can join before host.

  • hide_meeting_description

    object — Information about the **Hide meeting description** feature.

    • enable

      boolean — Whether to enable the **Hide meeting description** setting.

    • 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 to enable the **Hide webinar description** setting.

    • hide_description_for_scheduled_webinars

      boolean — Whether to hide webinar description for the webinars which have already been scheduled.

  • host_video

    boolean — Start meetings with the host video on.

  • jbh_time

    integer, possible values: 0, 5, 10, 15 — If the value of `join_before_host` field is set to `true`, this field can be used to indicate time limits within which a participant may join a meeting before a host. * `0`: Allow participant to join anytime. * `5`: Allow participant to join 5 minutes before meeting start time. * `10`: Allow participant to join 10 minutes before meeting start time.

  • join_before_host

    boolean — Allow participants to join the meeting before the host arrives.

  • meeting_password_requirement

    object — Account wide meeting or webinar [passcode requirements](https://support.zoom.us/hc/en-us/articles/360033559832-Meeting-and-webinar-passwords#h_a427384b-e383-4f80-864d-794bf0a37604).

    • consecutive_characters_length

      integer, possible values: 0, 4, 5, 6, 7, 8 — Specify the max length of consecutive characters(abcde...) that can be used in a passcode. If you set the value of this field to `0`, no restriction will be applied on consecutive characters. If you would like to set this restriction, you can specify a number between 4 and 8 that define the maximum allowed length for consecutive characters in a passcode. The max allowed length will be `n-1` where `n` refers to the value you provide for this field. For instance, if you provide `4` as the value, there can only be a maximum of `3` consecutive characters in a passcode(example: abc1x@8fdh).

    • have_letter

      boolean — If set to `true`, the passcode must contain at least 1 letter (such as a,b,c...).

    • have_number

      boolean — If set to `true`, the passcode must contain at least 1 number (such as 1,2,3...).

    • have_special_character

      boolean — If set to `true`, the passcode must have at least 1 special character (!,@,#...).

    • have_upper_and_lower_characters

      boolean — If set to `true`, the passcode must include both uppercase and lowercase characters.

    • length

      integer — The minimum length that the meeting or webinar passcode must have.

    • only_allow_numeric

      boolean — If set to `true`, the passcode must only contain numbers and no other characters.

    • weak_enhance_detection

      boolean — If set to `true`, users will be informed if the provided passcode is weak.

  • meeting_template

    object — Information about the **Meeting Templates** feature.

    • action

      string — Specify the action that you would like to take via this API request: * `update`: Choose this value if you are updating an existing meeting template enable. * `delete`: Choose this value if you are deleting an existing meeting template.

    • enable

      boolean — Whether to enable the **Meeting Templates** setting.

    • templates

      array — Information about the defined **Meeting Templates** policies.

      Items:

      • enable

        boolean — Whether to enable the meeting template.

      • id

        string — The meeting template ID.

  • not_store_meeting_topic

    boolean — Always display **Zoom Meeting** as the meeting topic.

  • participant_video

    boolean — Start meetings with the participant video on. Participants can change this setting during the meeting.

  • personal_meeting

    boolean — Personal meeting setting. `true`: Indicates that the **Enable Personal Meeting ID** setting is turned on. Users can choose to use personal meeting ID for their meetings. `false`: Indicates that the **Enable Personal Meeting ID** setting is [turned off](https://support.zoom.us/hc/en-us/articles/201362843-Personal-meeting-ID-PMI-and-personal-link#h_aa0335c8-3b06-41bc-bc1f-a8b84ef17f2a). If this setting is disabled, meetings that were scheduled with a PMI will be invalid. Scheduled meetings will need to be manually updated. For Zoom Phone only: If a user has been assigned a desk phone, **Elevate to Zoom Meeting** on desk phone will be disabled.

  • require_password_for_instant_meetings

    boolean — Require a passcode for instant meetings. If you use a PMI for your instant meetings, this option will be disabled. This setting is always enabled for free accounts and Pro accounts with a single host and cannot be modified for these accounts.

  • require_password_for_pmi_meetings

    string, possible values: "jbh_only", "all", "none" — Require a passcode for a meeting held using a Personal Meeting ID (PMI). This setting is always enabled for free accounts and Pro accounts with a single host and cannot be modified for these accounts.

  • require_password_for_scheduled_meetings

    boolean — Require a passcode for meetings which have already been scheduled.

  • require_password_for_scheduling_new_meetings

    boolean — Require a passcode when scheduling new meetings. This setting applies for regular meetings that do not use a PMI. If enabled, a passcode will be generated while a host schedules a new meeting and participants will be required to enter the passcode before they can join the meeting. This setting is always enabled for free accounts and Pro accounts with a single host and cannot be modified for these accounts.

  • 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.

• security

  object — [Security settings](https://support.zoom.us/hc/en-us/articles/360034675592-Advanced-security-settings#h_bf8a25f6-9a66-447a-befd-f02ed3404f89) of an Account.

  • admin_change_name_pic

    boolean — Whether to only allow account administrators to change a user's picture.

  • admin_change_user_info

    boolean — Whether to only allow account administrators to change a user's information.

  • hide_billing_info

    boolean — Hide billing information.

  • import_photos_from_devices

    boolean — Allow users to import photos from a photo library on a device.

  • password_requirement

    object — This object refers to the [enhanced passcode rules](https://support.zoom.us/hc/en-us/articles/360034675592-Advanced-security-settings#h_bf8a25f6-9a66-447a-befd-f02ed3404f89) that allows Zoom account admins and owners to apply extra requirements to the users' Zoom login passcode.

    • consecutive_characters_length

      integer — Specify the max length of consecutive characters(abcde...) that can be used in a passcode. If you set the value of this field to `0`, no restriction will be applied on consecutive characters. If you would like to set this restriction, you can specify a number between 4 and 8 that define the maximum allowed length for consecutive characters in a passcode. The max allowed length will be `n-1` where `n` refers to the value you provide for this field. For instance, if you provide `4` as the value, there can only be a maximum of `3` consecutive characters in a passcode(example: abc1x@8fdh).

    • have_special_character

      boolean — If the value of this field is set to `true`, the passcode must have at least one special character(!, @, #...).

    • minimum_password_length

      integer — Specify a minimum length for the passcode. The passcode length can be between 9 and 14 characters. If the value of this field is `0`, this field is disabled and the basic passcode length (minimum of 8 characters) is required.

    • weak_enhance_detection

      boolean — If the value of this field is set to `true`, user passcodes will have to pass detection through a weak passcode dictionary in case hackers use simple passcodes to sign in to your users' accounts.

  • sign_again_period_for_inactivity_on_client

    integer — Settings for user sign-in interval requirements after a period of inactivity. If enabled, this setting forces automatic logout of Zoom client app users after a set amount of time. If this setting is disabled, the value of this field will be `0`. If the setting is enabled, the value of this field will indicate the **period of inactivity** in minutes after which, an inactive user will be automatically logged out of the Zoom client. The inactivity-period value can be one of these options. `5`: 5 minutes `10`: 10 minutes `15`: 15 minutes `30`: 30 minutes `45`: 45 minutes `60`: 60 minutes `90`: 90 minutes `120`: 120 minutes

  • sign_again_period_for_inactivity_on_web

    integer — Settings for user sign-in interval requirements after a period of inactivity. If enabled, this setting forces automatic logout of Zoom web portal users after a set amount of time. If this setting is disabled, the value of this field is `0`. If the setting is enabled, the value of this field indicates the **period of inactivity** in minutes, after which an inactive user will be automatically logged out of the Zoom web portal. The inactivity-period value can be one of these options. `5`: 5 minutes `10`: 10 minutes `15`: 15 minutes `30`: 30 minutes `60`: 60 minutes `120`: 120 minutes

  • sign_in_with_two_factor_auth

    string, possible values: "all", "group", "role", "none" — Settings for 2FA( [two factor authentication](https://support.zoom.us/hc/en-us/articles/360038247071) ). `all`: Two factor authentication will be enabled for all users in the account. `none`: Two factor authentication is disabled. `group`: Two factor authentication will be enabled for users belonging to specific groups. If 2FA is enabled for certain groups, the group IDs of the group(s) will be provided in the `sign_in_with_two_factor_auth_groups` field. `role`: Two factor authentication will be enabled only for users assigned with specific roles in the account. If 2FA is enabled for specific roles, the role IDs will be provided in the `sign_in_with_two_factor_auth_roles` field.

  • sign_in_with_two_factor_auth_groups

    array — This field contains group IDs of groups that have 2FA enabled. This field is only returned if the value of `sign_in_with_two_factor_auth` is `group`

    Items:

    string

  • sign_in_with_two_factor_auth_roles

    array — This field contains role IDs of roles that have 2FA enabled. This field is only returned if the value of `sign_in_with_two_factor_auth` is `role`.

    Items:

    string

  • signin_with_sso

    object — Allow users to sign in with single sign-on (SSO).

    • domains

      array — Users on these domains are required to sign in with single sign-on (SSO).

      Items:

      string

    • enable

      boolean — Whether to allow users to sign in with ssingle sign-on (SSO). If enabling this, configure your account's SSO settings. This lets users to sign in with SSO through your company's vanity URL.

    • operation

      string, possible values: "add", "remove" — The policy operation to perform for the update sso_bypass_user_ids. **If the value does not exist, it means overwrite users from sso_bypass_user_ids.** * `add` - Add some users from sso_bypass_user_ids. * `remove` - Remove users from sso_bypass_user_ids.

    • 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_user_ids

      array — The users' ID can bypass SSO sign-in.

      Items:

      string

  • user_modifiable_info_by_admin

    array — If the `admin_change_user_info` value is `true`, the list of the types of user information that only the account administrators can modify. * `name` * `profile_picture` * `sign_in_email` * `host_key`

    Items:

    string, possible values: "name", "profile_picture", "sign_in_email", "host_key"

• telephony

  object — Account Settings Update: Telephony.

  • audio_conference_info

    string — Third party audio conference info.

  • telephony_regions

    object — Indicates where most of the participants call into or call from during a meeting.

    • selection_values

      string — The account's selected telephony regions that indicate where most participants call into or call from during a meeting.

  • third_party_audio

    boolean — Users can join the meeting using the existing third party audio configuration.

• tsp

  object — Account Settings: TSP.

  • 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.

  • show_international_numbers_link

    boolean — Show international numbers link on the invitation email

• zoom_rooms

  object — Account Settings: Zoom Rooms.

  • auto_start_stop_scheduled_meetings

    boolean — Automatic start and stop for scheduled meetings.

  • cmr_for_instant_meeting

    boolean — Cloud recording for instant meetings.

  • force_private_meeting

    boolean — Shift all meetings to private.

  • hide_host_information

    boolean — Hide host and meeting ID from private meetings.

  • list_meetings_with_calendar

    boolean — Display meeting list with calendar integration.

  • start_airplay_manually

    boolean — Start AirPlay service manually.

  • ultrasonic

    boolean — Automatic direct sharing using an ultrasonic proximity signal.

  • upcoming_meeting_alert

    boolean — Upcoming meeting alert.

  • weekly_system_restart

    boolean — Weekly system restart.

  • zr_post_meeting_feedback

    boolean — Zoom Room post meeting feedback.