{
"server": {
"url": "https://api.zoom.us/v2"
},
"authentication": [
{
"schema_parameters": {
"in": "header"
},
"type": "apiKey",
"value": "API_KEY"
}
],
"operations": [
{
"description": "List all the sub accounts that have been created by a master account.\u003cbr\u003e\u003cbr\u003eZoom allows only [approved partners](https://marketplace.zoom.us/docs/api-reference/master-account-apis) to use master APIs and manage sub accounts. Email the partner programs team at **partner-success@zoom.us** for more details. \u003cbr\u003e**Prerequisites:**\u003cbr\u003e * Pro or a higher paid account with master account option enabled. \u003cbr\u003e **Scope**: `account:read:admin` \u003cbr\u003e**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Medium`\u003cbr\u003e",
"name": "accounts"
},
{
"description": "Create a sub account under a master account. Your account must be a master account in order to create sub accounts. \u003cbr\u003e\u003cbr\u003eZoom allows only [approved partners](https://marketplace.zoom.us/docs/api-reference/master-account-apis) to use master APIs and manage sub accounts. Email the partner programs team at partner-success@zoom.us. for more details. Please note that the created account user will receive a confirmation email.\u003cbr\u003e\u003cbr\u003e \u003cbr\u003e **Prerequisites:**\u003cbr\u003e * Pro or a higher paid account with master account option enabled. \u003cbr\u003e **Scope**: `account:write:admin`\u003cbr\u003e **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Light`\u003cbr\u003e",
"name": "account_create"
},
{
"description": "Disassociate a sub account from its master account. This will leave the sub account intact but it will no longer be associated with the master account.\u003cbr\u003e **Prerequisites:** * Pro or a higher paid account with master account option enabled. \u003cbr\u003e * The account making this API request must be a [master account](https://marketplace.zoom.us/docs/api-reference/master-account-apis).\u003cbr\u003e\u003cbr\u003e **Scope**: `account:write:admin`\u003cbr\u003e **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Light`\u003cbr\u003e",
"name": "account_disassociate"
},
{
"description": "Get details of a sub account that is listed under a master account. Your account must be a master account in order to retrieve sub accounts\u0027 details. Zoom allows only [approved partners](https://marketplace.zoom.us/docs/api-reference/master-account-apis) to use master APIs and create sub accounts. 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. \u003cbr\u003e **Scope**: `account:write:admin`\u003cbr\u003e **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Light`\u003cbr\u003e",
"name": "account"
},
{
"description": "[Account Locked Settings](https://support.zoom.us/hc/en-us/articles/115005269866) allow you turn settings on or off for all users in your account. No user except the account admin or account owner can change these settings. With lock settings, you force the settings on for all users. Use this API to retrieve an account\u0027s locked settings. **Note:** This API can be used by Zoom Accounts that are on a Pro or a higher plan as well accounts that have master and sub accounts options enabled. \u003cbr\u003e\u003cbr\u003e **Prerequisites:** * Pro or a higher paid account. \u003cbr\u003e **Scope**: `account:read:admin`. \u003cbr\u003e **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Medium`\u003cbr\u003e **Scope:** account:read:admin",
"name": "get_account_lock_settings"
},
{
"description": "[Account Locked Settings](https://support.zoom.us/hc/en-us/articles/115005269866) allow you turn settings on or off for all users in your account. No user except the account admin or account owner can change these settings. With lock settings, you force the settings on for all users. Use this API to update an account\u0027s locked settings. **Note:** This API can be used by Zoom Accounts that are on a Pro or a higher plan as well accounts that have master and sub accounts options enabled.\u003cbr\u003e\u003cbr\u003e **Prerequisites:**\u003cbr\u003e * Pro or a higher paid account. \u003cbr\u003e **Scope:** `account:write:admin`\u003cbr\u003e **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Medium`\u003cbr\u003e",
"name": "update_account_lock_settings"
},
{
"description": "Get a sub account\u0027s [managed domains](https://support.zoom.us/hc/en-us/articles/203395207-What-is-Managed-Domain-).\u003cbr\u003e\u003cbr\u003e **Note:** This API can be used by Zoom Accounts that are on a Pro or a higher plan as well accounts that have master and sub accounts options enabled. \u003cbr\u003e\u003cbr\u003e To get managed domains of the master account, provide `me` as the value for accountId in the path parameter. Provide the sub account\u0027s Account ID as the value of accountId path parameter to get managed domains of the sub account.\u003cbr\u003e\u003cbr\u003e **Prerequisites:**\u003cbr\u003e * Pro or a higher paid account with master account option enabled. \u003cbr\u003e **Scope:** `account:read:admin`\u003cbr\u003e **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Light`\u003cbr\u003e",
"name": "account_managed_domain"
},
{
"description": "Update a sub account\u0027s options under the master account.\u003cbr\u003e \u003caside\u003eYour account must be a master account in order to update the options for sub accounts. Zoom only assigns this privilege to trusted partners. \u003c/aside\u003e **Prerequisites:** * Pro or a higher paid account with master account option enabled. * The account making this API request must be a [master account](https://marketplace.zoom.us/docs/api-reference/master-account-apis).\u003cbr\u003e\u003cbr\u003e **Scope**: `account:write:admin`\u003cbr\u003e **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Light`\u003cbr\u003e",
"name": "account_options_update"
},
{
"description": "The current account owner can [change the owner of an account](https://support.zoom.us/hc/en-us/articles/115005686983-Change-Account-Owner) to another user on the same account.\u003cbr\u003e Use this API to change the owner of a sub account. **Prerequisites**: \u003cbr\u003e * Account owner or admin permissions of an account. * The account making this API request must be on a pro or a hiigher plan with [master account](https://marketplace.zoom.us/docs/api-reference/master-account-apis) privilege.\u003cbr\u003e\u003cbr\u003e **Scopes:** `account:write:admin` or `account:master`\u003cbr\u003e**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Heavy`\u003cbr\u003e \u003cbr\u003e",
"name": "update_account_owner"
},
{
"description": "Get the settings of an account.\u003cbr\u003e To get the settings of a master account, use `me` as the value for the `accountId` path parameter.\u003cbr\u003e\u003cbr\u003e **Prerequisites**: * The account must be a paid account.\u003cbr\u003e **Scopes**: `account:read:admin` \u003cbr\u003e **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Medium`",
"name": "account_settings"
},
{
"description": "Update the settings of a sub account that is under a master account.\u003cbr\u003e To update the settings of the master account, use `me` as the value of the `accountId` path parameter.\u003cbr\u003e\u003cbr\u003e **Prerequisites**: * The sub account must be a paid account.\u003cbr\u003e **Scopes**: `account:write:admin` \u003cbr\u003e **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Medium`",
"name": "account_settings_update"
},
{
"description": "Delete existing virtual background file(s) from an account. **Prerequisites:**\u003cbr\u003e * Virtual background feature must be [enabled](https://support.zoom.us/hc/en-us/articles/210707503-Virtual-Background#h_2ef28080-fce9-4ac2-b567-dc958afab1b7) on the account. \u003cbr\u003e **Scope:** `account:write:admin`\u003cbr\u003e \u003cbr\u003e **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Light`\u003cbr\u003e",
"name": "del_v_b"
},
{
"description": "Use this API to [upload virtual background files](https://support.zoom.us/hc/en-us/articles/210707503-Virtual-Background#h_01EJF3YFEWGT8YA0ZJ079JEDQE) for all users on the account to use. **Prerequisites:**\u003cbr\u003e * Virtual background feature must be [enabled](https://support.zoom.us/hc/en-us/articles/210707503-Virtual-Background#h_2ef28080-fce9-4ac2-b567-dc958afab1b7) on the account. \u003cbr\u003e **Scope:** `account:write:admin`\u003cbr\u003e\u003cbr\u003e **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Medium`\u003cbr\u003e",
"name": "upload_v_b"
},
{
"description": "Get trusted domains of a sub account. To get the trusted domains of a master account, use `me` as the value for the `accountId` path parameter. **Prerequisites:**\u003cbr\u003e * The sub account must be a paid account.\u003cbr\u003e **Scope:** `account:read:admin`\u003cbr\u003e **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Light`",
"name": "account_trusted_domain"
}
]
}