{
"server": {
"url": "https://api.zoom.us/v2"
},
"authentication": [
{
"schema_parameters": {
"in": "header"
},
"type": "apiKey",
"value": "API_KEY"
}
],
"operations": [
{
"description": "Disassociate a user from one Account and move the user to another Account under the same master account. With this API, a user under a master account or a sub account can be moved to another sub account within the same master account. To move a user from a master account to a sub account, use `me` as the value for `accountId`. In this scenario, \"me\" refers to the Account ID of the master account. To move a user from one sub account to another sub account, provide the sub account\u0027s Account ID as the value for `accountId`. **Prerequisites**: * The account should have Pro or a higher plan with master account option enabled. * The user whose account needs to be switched should not be an admin or an owner of that account. * The user should not have the same [managed domain](https://support.zoom.us/hc/en-us/articles/203395207-What-is-Managed-Domain-) as the account owner. **Scope:** `user:master`\u003cbr\u003e **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Light`",
"name": "switch_user_account"
},
{
"description": "A Zoom account can have one or more users. Use this API to list users on your account.\u003cbr\u003e\u003cbr\u003e **Scopes:** `user:read:admin`\u003cbr\u003e **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Medium`",
"name": "users"
},
{
"description": "A Zoom account can have one or more users. Use this API to add a new user to your account.\u003cbr\u003e\u003cbr\u003e **Prerequisites:**\u003cbr\u003e * Pro or higher plan\u003cbr\u003e\u003cbr\u003e **Scopes:** `user:write:admin` `user:write`\u003cbr\u003e **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Light`",
"name": "user_create"
},
{
"description": "Verify if a user\u0027s email is registered with Zoom.\u003cbr\u003e\u003cbr\u003e \u003cb\u003eNote: \u003c/b\u003eYou can successfully check if a user is a registered Zoom user only if the user **signed up for Zoom via email and is within your account.** If you provide an email address of a user who is not in your account, the value of \"existed_email\" parameter will be \"false\" irrespective of whether or not the user is registered with Zoom. The response of this API call will not include users who joined Zoom using options such as \"Sign in with SSO\", \"Sign in with Google\" or \"Sign in with Facebook\" even if they are in the same account as yours. **Scopes:** `user:read:admin` `user:read` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Light`",
"name": "user_email"
},
{
"description": "Get User\u2019s Zoom Access Token (ZAK). You can use a ZAK to enable a non-login user to join a meeting on your app. Non-login users do not need to enter their username and password to join meetings. **Scope:** `user_zak:read`\u003cbr\u003e **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Light`",
"name": "user_zak"
},
{
"description": "A personal meeting room is a virtual meeting room that can be permanently assigned to a user. Use this API to check if a personal meeting room with the given name exists or not.\u003cbr\u003e\u003cbr\u003e **Scopes:** `user:read:admin` `user:read`\u003cbr\u003e **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Light`",
"name": "user_vanity_name"
},
{
"description": "Deleting a user permanently removes the user and their data from Zoom. Users can create a new Zoom account using the same email address. An account owner or an account admin can transfer meetings, webinars and cloud recordings to another Zoom user account before deleting.\u003cbr\u003e\u003cbr\u003e This API disassociates (unlinks) a user from the associated Zoom account and provides the user their own basic free Zoom account, and the user can purchase their own licenses. You can transfer the user\u0027s data (meetings, webinars and cloud recordings) to another user before disassociation.\u003cbr\u003e To permanently delete a user, specify \"delete\" as the value of the `action` query parameter. **Scopes:** `user:write:admin` `user:write`\u003cbr\u003e **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Light`",
"name": "user_delete"
},
{
"description": "A Zoom account can have one or more users. Use this API to view information of a specific user on a Zoom account.\u003cbr\u003e\u003cbr\u003e **Scopes:** `user:read:admin` `user:read`\u003cbr\u003e **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Light` \u003cp style=\"background-color:#e1f5fe; color:#01579b; padding:8px\"\u003e \u003cb\u003eNote: \u003c/b\u003eIf a user\u0027s status is pending, only `id` and `created_at` fields will be returned. The value of `created_at` will be the time at which the API call was made until the user activates their account.\u003c/p\u003e",
"name": "user"
},
{
"description": "Update information on a user\u0027s Zoom [profile](https://support.zoom.us/hc/en-us/articles/201363203-My-Profile).\u003cbr\u003e\u003cbr\u003e **Scopes:** `user:write:admin` `user:write`\u003cbr\u003e **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Light`",
"name": "user_update"
},
{
"description": "Delete all assistants of the current user.\u003cbr\u003e Assistants are the users to whom the current user has assigned [scheduling privilege](https://support.zoom.us/hc/en-us/articles/201362803-Scheduling-Privilege). These assistants can schedule meeting on behalf of the current user as well as manage and act as an alternative host for all meetings if the admin has enabled [Co-host option](https://zoom.us/account/setting) on the account.\u003cbr\u003e **Prerequisite**: * The user as well as the assistant must have Licensed or an On-prem license. * Assistants must be under the current user\u0027s account.\u003cbr\u003e **Scopes**: `user:write:admin` `user:write` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Light`",
"name": "user_assistants_delete"
},
{
"description": "List a user\u0027s assistants. Assistants are the users to whom the current user has assigned [scheduling privilege](https://support.zoom.us/hc/en-us/articles/201362803-Scheduling-Privilege). These assistants can schedule meeting on behalf of the current user as well as manage and act as an alternative host for all meetings if the admin has enabled [Co-host option](https://zoom.us/account/setting) on the account.\u003cbr\u003e\u003cbr\u003e **Prerequisites**: \u003cbr\u003e * Current user as well as the assistant must have Licensed or an On-prem license. * Assistants must be under the current user\u0027s account.\u003cbr\u003e **Scopes**: `user:read:admin` `user:read`\u003cbr\u003e **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Medium`",
"name": "user_assistants"
},
{
"description": "Assistants are the users to whom the current user has assigned [scheduling privilege](https://support.zoom.us/hc/en-us/articles/201362803-Scheduling-Privilege). These assistants can schedule meeting on behalf of the current user as well as manage and act as an alternative host for all meetings if the admin has enabled [Co-host option](https://zoom.us/account/setting) on the account.\u003cbr\u003eUse this API to assign assistants to a user. \u003cbr\u003e In the request body, provide either the User ID or the email address of the user.\u003cbr\u003e\u003cbr\u003e **Prerequisite**: * The user as well as the assistant must have Licensed or an On-prem license. * Assistants must be under the current user\u0027s account.\u003cbr\u003e **Scopes**: `user:write:admin` `user:write` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Medium`",
"name": "user_assistant_create"
},
{
"description": "Delete a specific assistant of a user. Assistants are the users to whom the current user has assigned [scheduling privilege](https://support.zoom.us/hc/en-us/articles/201362803-Scheduling-Privilege). These assistants can schedule meeting on behalf of the current user as well as manage and act as an alternative host for all meetings if the admin has enabled [Co-host option](https://zoom.us/account/setting) on the account.\u003cbr\u003e\u003cbr\u003e **Prerequisites**: * The user as well as the assistant must have Licensed or an On-prem license. * Assistants must be under the current user\u0027s account.\u003cbr\u003e **Scopes**: `user:write:admin` `user:write` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Light`",
"name": "user_assistant_delete"
},
{
"description": "Change a user\u0027s [email address](https://support.zoom.us/hc/en-us/articles/201362563-How-Do-I-Change-the-Email-on-My-Account-) on a Zoom account that has managed domain set up.\u003cbr\u003eIf the Zoom Account in which the user belongs, has multiple [managed domains](https://support.zoom.us/hc/en-us/articles/203395207-What-is-Managed-Domain-), the email to be updated must match one of the managed domains.\u003cbr\u003e **Scopes:** `user:write:admin` `user:write`\u003cbr\u003e **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Light`\u003cbr\u003e \u003e Note: A user\u0027s email address can only be changed for a maximum of 3 times in a day(24 hours). **Prerequisite:**\u003cbr\u003e * Managed domain must be enabled in the account. * The new email address should not already exist in Zoom.",
"name": "user_email_update"
},
{
"description": "Update the [password](https://support.zoom.us/hc/en-us/articles/206344385-Change-a-User-s-Password) of a user using which the user can login to Zoom.\u003cbr\u003e After this request is processed successfully, an email notification will be sent to the user stating that the password was changed.\u003cbr\u003e **Scopes:** `user:write:admin` `user:write`\u003cbr\u003e **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Medium` **Prerequisites:**\u003cbr\u003e * Owner or admin of the Zoom account.",
"name": "user_password"
},
{
"description": "Users can be assigned a set of permissions that allows them to access only the pages/information that a user needs to view or edit.\u003cbr\u003e Use this API to get permissions that have been granted to the user.\u003cbr\u003e\u003cbr\u003e **Scopes:** `user:read:admin` `user:read`\u003cbr\u003e **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Light`",
"name": "user_permission"
},
{
"description": "Upload a user\u0027s profile picture.\u003cbr\u003e\u003cbr\u003e Provide `multipart/form-data` as the value of the `content-type` header for this request. This API supports JPEG and PNG file formats. **Scopes:** `user:write:admin` `user:write`\u003cbr\u003e **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Medium`",
"name": "user_picture"
},
{
"description": "Users in the Zoom desktop client and mobile apps are assigned with a [presence status](https://support.zoom.us/hc/en-us/articles/360032554051-Status-Icons). The presence status informs users of their contact\u0027s availability. Users can also change their own presence status to be either \"Away\", \"Do not disturb\", or \"Available\". Use this API to update a user\u0027s presence status. A user\u0027s status can not be updated more than once per minute, i.e., you can only submit a maximum of 1 update request/minute for a single user.\u003cbr\u003eNote that a user\u0027s presence status can not be updated using this API if the user is not logged in to the Zoom client. **Scopes:** `user:write`, `user:write:admin`\u003cbr\u003e **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Medium`\u003cbr\u003e",
"name": "update_presence_status"
},
{
"description": "Delete all of a user\u0027s schedulers. Schedulers are users on whose behalf the current user (assistant) can schedule meetings for. By calling this API, the current user will no longer be a scheduling assistant of any user. **Prerequisite**: Current user (assistant) must be under the same account as the scheduler.\u003cbr\u003e **Scopes**: `user:write:admin` `user:write` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Light`",
"name": "user_schedulers_delete"
},
{
"description": "List all the schedulers of a user. Schedulers in this context are the users for whom the current user can schedule meetings for. For instance, if the current user (i.e., the user whose userId was passed in the path parameter of this API call) is user A, the response of this API will contain a list of user(s), for whom user A can schedule and manage meetings. User A is the assistant of these users and thus has scheduling privilege for these user(s). **Prerequisites**: * Current user must be under the same account as the scheduler.\u003cbr\u003e **Scopes**: `user:read:admin` `user:read` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Medium`",
"name": "user_schedulers"
},
{
"description": "Delete a Scheduler. Schedulers are users on whose behalf the current user (assistant) can schedule meetings for. By calling this API, the current user will no longer be a scheduling assistant of this scheduler. **Prerequisite**: Current user must be under the same account as the scheduler.\u003cbr\u003e **Scopes**: `user:write:admin` `user:write` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Light`",
"name": "user_scheduler_delete"
},
{
"description": "Retrieve a user\u0027s settings.\u003cbr\u003e\u003cbr\u003e **Scopes:** `user:read:admin` `user:read`\u003cbr\u003e **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Medium`",
"name": "user_settings"
},
{
"description": "Update a user\u0027s settings.\u003cbr\u003e\u003cbr\u003e **Scopes:** `user:write:admin` `user:write`\u003cbr\u003e **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Medium`",
"name": "user_settings_update"
},
{
"description": "Delete existing virtual background file(s) of a user. **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:** `user:write:admin`\u003cbr\u003e **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Light`\u003cbr\u003e",
"name": "del_user_v_b"
},
{
"description": "Use this API to [upload virtual background files](https://support.zoom.us/hc/en-us/articles/210707503-Virtual-Background) for a user. **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:** `user:write:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Medium`\u003cbr\u003e",
"name": "upload_v_buser"
},
{
"description": "An account owner or admins can deactivate as well as activate a user in a Zoom account. Deactivating a user will remove all licenses associated with a user. It will prevent the deactivated user from logging into their Zoom account. A deactivated user can be reactivated. Reactivating a user grants the user access to login to their Zoom account.\u003cbr\u003e Use this API to either [deactivate](https://support.zoom.us/hc/en-us/articles/115005269946-Remove-User-from-your-Account#h_6a9bc1c3-d739-4945-b1f2-00b3b88fb5cc) an active user or to [reactivate](https://support.zoom.us/hc/en-us/articles/115005269946-Remove-User-from-your-Account#h_16319724-d120-4be6-af5d-31582d134ea0) a deactivated user .\u003cbr\u003e\u003cbr\u003e**Scopes:** `user:write:admin` `user:write`\u003cbr\u003e **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Light`",
"name": "user_status"
},
{
"description": "Revoke a user\u0027s SSO token.\u003cbr\u003e\u003cbr\u003e After calling this API, the SSO user will be logged out of their current Zoom session.\u003cbr\u003e **Scopes:** `user:write:admin` `user:write` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Light`",
"name": "user_s_s_o_token_delete"
},
{
"description": "Retrieve a user\u0027s token.\u003cbr\u003e\u003cbr\u003e This token is used for starting meetings with the Client SDK.\u003cbr\u003e **Scopes:** `user:read:admin` `user:read`\u003cbr\u003e **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Light` If a user signed into Zoom using Google or Facebook, a null value will be returned for the token. To get the token with this API, ask the user to sign into Zoom using their email and password instead.",
"name": "user_token"
}
]
}