{ "opencollection": "1.0.0", "info": { "name": "Zoom / Account User API", "version": "1.0.0" }, "items": [ { "info": { "name": "User", "type": "folder" }, "items": [ { "info": { "name": "userAssistantDelete", "type": "http" }, "http": { "method": "POST", "url": "https://api.zoom.us/v1/user/assistant/delete", "body": { "type": "form-urlencoded", "data": [ { "name": "id", "value": "" }, { "name": "host_email", "value": "" } ] } }, "docs": "Delete a user's assistant.\n\n" }, { "info": { "name": "userAssistantSet", "type": "http" }, "http": { "method": "POST", "url": "https://api.zoom.us/v1/user/assistant/set", "body": { "type": "form-urlencoded", "data": [ { "name": "id", "value": "" }, { "name": "host_email", "value": "" }, { "name": "assistant_email", "value": "" } ] } }, "docs": "Set a user's assistant which can schedule meeting for him.\n\n" }, { "info": { "name": "userAutocreate", "type": "http" }, "http": { "method": "POST", "url": "https://api.zoom.us/v1/user/autocreate", "body": { "type": "form-urlencoded", "data": [ { "name": "email", "value": "" }, { "name": "type", "value": "" }, { "name": "password", "value": "" }, { "name": "first_name", "value": "" }, { "name": "last_name", "value": "" }, { "name": "disable_chat", "value": "" }, { "name": "enable_e2e_encryption", "value": "" }, { "name": "enable_silent_mode", "value": "" }, { "name": "disable_group_hd", "value": "" }, { "name": "disable_recording", "value": "" }, { "name": "enable_cmr", "value": "" }, { "name": "enable_auto_recording", "value": "" }, { "name": "enable_cloud_auto_recording", "value": "" }, { "name": "track_id", "value": "" }, { "name": "meeting_capacity", "value": "" }, { "name": "enable_webinar", "value": "" }, { "name": "webinar_capacity", "value": "" }, { "name": "enable_large", "value": "" }, { "name": "large_capacity", "value": "" }, { "name": "disable_feedback", "value": "" }, { "name": "disable_jbh_reminder", "value": "" }, { "name": "enable_breakout_room", "value": "" }, { "name": "enable_polling", "value": "" }, { "name": "enable_annotation", "value": "" }, { "name": "enable_share_dual_camera", "value": "" }, { "name": "enable_far_end_camera_control", "value": "" }, { "name": "disable_private_chat", "value": "" }, { "name": "enable_enter_exit_chime", "value": "" }, { "name": "option_enter_exit_chime_type", "value": "" }, { "name": "disable_cancel_meeting_notification", "value": "" }, { "name": "enable_remote_support", "value": "" }, { "name": "enable_file_transfer", "value": "" }, { "name": "enable_virtual_background", "value": "" }, { "name": "enable_attention_tracking", "value": "" }, { "name": "enable_waiting_room", "value": "" }, { "name": "enable_closed_caption", "value": "" }, { "name": "enable_co_host", "value": "" }, { "name": "enable_auto_saving_chats", "value": "" }, { "name": "enable_phone_participants_password", "value": "" }, { "name": "enable_auto_delete_cmr", "value": "" }, { "name": "auto_delete_cmr_days", "value": "" }, { "name": "dept", "value": "" }, { "name": "group_id", "value": "" }, { "name": "imgroup_id", "value": "" } ] } }, "docs": "Create a user on Zoom, returns the created user ID.\n\n\n\n\n\n" }, { "info": { "name": "userCheckemail", "type": "http" }, "http": { "method": "POST", "url": "https://api.zoom.us/v1/user/checkemail", "body": { "type": "form-urlencoded", "data": [ { "name": "email", "value": "" } ] } }, "docs": "Check if the user email exists.\n\n" }, { "info": { "name": "userCheckzpk", "type": "http" }, "http": { "method": "POST", "url": "https://api.zoom.us/v1/user/checkzpk", "body": { "type": "form-urlencoded", "data": [ { "name": "zpk", "value": "" } ] } }, "docs": "Check if the zpk is expired. The zpk is used to authenticate a user.\n\n" }, { "info": { "name": "userCreate", "type": "http" }, "http": { "method": "POST", "url": "https://api.zoom.us/v1/user/create", "body": { "type": "form-urlencoded", "data": [ { "name": "email", "value": "" }, { "name": "type", "value": "" }, { "name": "first_name", "value": "" }, { "name": "last_name", "value": "" }, { "name": "disable_chat", "value": "" }, { "name": "enable_e2e_encryption", "value": "" }, { "name": "enable_silent_mode", "value": "" }, { "name": "disable_group_hd", "value": "" }, { "name": "disable_recording", "value": "" }, { "name": "enable_cmr", "value": "" }, { "name": "enable_auto_recording", "value": "" }, { "name": "enable_cloud_auto_recording", "value": "" }, { "name": "track_id", "value": "" }, { "name": "meeting_capacity", "value": "" }, { "name": "enable_webinar", "value": "" }, { "name": "webinar_capacity", "value": "" }, { "name": "enable_large", "value": "" }, { "name": "large_capacity", "value": "" }, { "name": "disable_feedback", "value": "" }, { "name": "disable_jbh_reminder", "value": "" }, { "name": "enable_breakout_room", "value": "" }, { "name": "enable_polling", "value": "" }, { "name": "enable_annotation", "value": "" }, { "name": "enable_share_dual_camera", "value": "" }, { "name": "enable_far_end_camera_control", "value": "" }, { "name": "disable_private_chat", "value": "" }, { "name": "enable_enter_exit_chime", "value": "" }, { "name": "option_enter_exit_chime_type", "value": "" }, { "name": "disable_cancel_meeting_notification", "value": "" }, { "name": "enable_remote_support", "value": "" }, { "name": "enable_file_transfer", "value": "" }, { "name": "enable_virtual_background", "value": "" }, { "name": "enable_attention_tracking", "value": "" }, { "name": "enable_waiting_room", "value": "" }, { "name": "enable_closed_caption", "value": "" }, { "name": "enable_co_host", "value": "" }, { "name": "enable_auto_saving_chats", "value": "" }, { "name": "enable_phone_participants_password", "value": "" }, { "name": "enable_auto_delete_cmr", "value": "" }, { "name": "auto_delete_cmr_days", "value": "" }, { "name": "dept", "value": "" }, { "name": "group_id", "value": "" }, { "name": "imgroup_id", "value": "" } ] } }, "docs": "Create a user on Zoom, returns the created user ID.\n\n\n\n\n\n" }, { "info": { "name": "userCustcreate", "type": "http" }, "http": { "method": "POST", "url": "https://api.zoom.us/v1/user/custcreate", "body": { "type": "form-urlencoded", "data": [ { "name": "email", "value": "" }, { "name": "type", "value": "" }, { "name": "first_name", "value": "" }, { "name": "last_name", "value": "" }, { "name": "disable_chat", "value": "" }, { "name": "enable_e2e_encryption", "value": "" }, { "name": "enable_silent_mode", "value": "" }, { "name": "disable_group_hd", "value": "" }, { "name": "disable_recording", "value": "" }, { "name": "enable_cmr", "value": "" }, { "name": "enable_auto_recording", "value": "" }, { "name": "enable_cloud_auto_recording", "value": "" }, { "name": "track_id", "value": "" }, { "name": "meeting_capacity", "value": "" }, { "name": "enable_webinar", "value": "" }, { "name": "webinar_capacity", "value": "" }, { "name": "enable_large", "value": "" }, { "name": "large_capacity", "value": "" }, { "name": "disable_feedback", "value": "" }, { "name": "disable_jbh_reminder", "value": "" }, { "name": "enable_breakout_room", "value": "" }, { "name": "enable_polling", "value": "" }, { "name": "enable_annotation", "value": "" }, { "name": "enable_share_dual_camera", "value": "" }, { "name": "enable_far_end_camera_control", "value": "" }, { "name": "disable_private_chat", "value": "" }, { "name": "enable_enter_exit_chime", "value": "" }, { "name": "option_enter_exit_chime_type", "value": "" }, { "name": "disable_cancel_meeting_notification", "value": "" }, { "name": "enable_remote_support", "value": "" }, { "name": "enable_file_transfer", "value": "" }, { "name": "enable_virtual_background", "value": "" }, { "name": "enable_attention_tracking", "value": "" }, { "name": "enable_waiting_room", "value": "" }, { "name": "enable_closed_caption", "value": "" }, { "name": "enable_co_host", "value": "" }, { "name": "enable_auto_saving_chats", "value": "" }, { "name": "enable_phone_participants_password", "value": "" }, { "name": "enable_auto_delete_cmr", "value": "" }, { "name": "auto_delete_cmr_days", "value": "" }, { "name": "dept", "value": "" }, { "name": "group_id", "value": "" }, { "name": "imgroup_id", "value": "" } ] } }, "docs": "Create a user on Zoom, returns the created user ID.\n\n\n\n\n\n" }, { "info": { "name": "userActivate", "type": "http" }, "http": { "method": "POST", "url": "https://api.zoom.us/v1/user/activate", "body": { "type": "form-urlencoded", "data": [ { "name": "id", "value": "" } ] } }, "docs": "Activate a user on Zoom, return the user ID.\n\n" }, { "info": { "name": "userDeactivate", "type": "http" }, "http": { "method": "POST", "url": "https://api.zoom.us/v1/user/deactivate", "body": { "type": "form-urlencoded", "data": [ { "name": "id", "value": "" } ] } }, "docs": "Deactivate a user on Zoom, return the user ID.\n\n" }, { "info": { "name": "userDelete", "type": "http" }, "http": { "method": "POST", "url": "https://api.zoom.us/v1/user/delete", "body": { "type": "form-urlencoded", "data": [ { "name": "id", "value": "" }, { "name": "type", "value": "" } ] } }, "docs": "Delete a user on Zoom, return the deleted user ID.\n\n" }, { "info": { "name": "userGet", "type": "http" }, "http": { "method": "POST", "url": "https://api.zoom.us/v1/user/get", "body": { "type": "form-urlencoded", "data": [ { "name": "api_key", "value": "" }, { "name": "api_secret", "value": "" }, { "name": "id", "value": "" } ] } }, "docs": "Get a user info on Zoom via user ID\n\n" }, { "info": { "name": "userGetbyemail", "type": "http" }, "http": { "method": "POST", "url": "https://api.zoom.us/v1/user/getbyemail", "body": { "type": "form-urlencoded", "data": [ { "name": "email", "value": "" }, { "name": "login_type", "value": "" } ] } }, "docs": "Get a user on Zoom via user email address and login type, return the user info.\n\n" }, { "info": { "name": "userList", "type": "http" }, "http": { "method": "POST", "url": "https://api.zoom.us/v1/user/list", "body": { "type": "form-urlencoded", "data": [ { "name": "page_size", "value": "" }, { "name": "page_number", "value": "" } ] } }, "docs": "List all the users on Zoom\n\n" }, { "info": { "name": "userPending", "type": "http" }, "http": { "method": "POST", "url": "https://api.zoom.us/v1/user/pending", "body": { "type": "form-urlencoded", "data": [ { "name": "page_size", "value": "" }, { "name": "page_number", "value": "" } ] } }, "docs": "List all the pending users on Zoom\n\n" }, { "info": { "name": "userPermanentdelete", "type": "http" }, "http": { "method": "POST", "url": "https://api.zoom.us/v1/user/permanentdelete", "body": { "type": "form-urlencoded", "data": [ { "name": "id", "value": "" }, { "name": "email", "value": "" } ] } }, "docs": "Delete a user from Zoom system permanently.\n\n" }, { "info": { "name": "userRevoketoken", "type": "http" }, "http": { "method": "POST", "url": "https://api.zoom.us/v1/user/revoketoken", "body": { "type": "form-urlencoded", "data": [ { "name": "id", "value": "" }, { "name": "email", "value": "" } ] } }, "docs": "Revoke a user's SSO token.\n\n" }, { "info": { "name": "userScheduleforhostList", "type": "http" }, "http": { "method": "POST", "url": "https://api.zoom.us/v1/user/scheduleforhost/list", "body": { "type": "form-urlencoded", "data": [ { "name": "id", "value": "" }, { "name": "host_email", "value": "" } ] } }, "docs": "List assigned schedule privilege for host users.\n\n" }, { "info": { "name": "userSsocreate", "type": "http" }, "http": { "method": "POST", "url": "https://api.zoom.us/v1/user/ssocreate", "body": { "type": "form-urlencoded", "data": [ { "name": "email", "value": "" }, { "name": "type", "value": "" }, { "name": "first_name", "value": "" }, { "name": "last_name", "value": "" }, { "name": "meeting_capacity", "value": "" }, { "name": "enable_webinar", "value": "" }, { "name": "webinar_capacity", "value": "" }, { "name": "enable_large", "value": "" }, { "name": "large_capacity", "value": "" }, { "name": "pmi", "value": "" }, { "name": "group_id", "value": "" }, { "name": "imgroup_id", "value": "" } ] } }, "docs": "Create a SSO user on Zoom, return the created user ID.\n\n\n\n" }, { "info": { "name": "userUpdate", "type": "http" }, "http": { "method": "POST", "url": "https://api.zoom.us/v1/user/update", "body": { "type": "form-urlencoded", "data": [ { "name": "id", "value": "" }, { "name": "type", "value": "" }, { "name": "first_name", "value": "" }, { "name": "last_name", "value": "" }, { "name": "disable_chat", "value": "" }, { "name": "enable_e2e_encryption", "value": "" }, { "name": "enable_silent_mode", "value": "" }, { "name": "disable_group_hd", "value": "" }, { "name": "disable_recording", "value": "" }, { "name": "enable_cmr", "value": "" }, { "name": "enable_record_speaker_view", "value": "" }, { "name": "enable_record_gallery_view", "value": "" }, { "name": "enable_record_audio_file", "value": "" }, { "name": "enable_auto_recording", "value": "" }, { "name": "enable_cloud_auto_recording", "value": "" }, { "name": "track_id", "value": "" }, { "name": "meeting_capacity", "value": "" }, { "name": "enable_webinar", "value": "" }, { "name": "webinar_capacity", "value": "" }, { "name": "enable_large", "value": "" }, { "name": "large_capacity", "value": "" }, { "name": "disable_feedback", "value": "" }, { "name": "disable_jbh_reminder", "value": "" }, { "name": "enable_breakout_room", "value": "" }, { "name": "enable_polling", "value": "" }, { "name": "enable_annotation", "value": "" }, { "name": "enable_share_dual_camera", "value": "" }, { "name": "enable_far_end_camera_control", "value": "" }, { "name": "disable_private_chat", "value": "" }, { "name": "enable_enter_exit_chime", "value": "" }, { "name": "option_enter_exit_chime_type", "value": "" }, { "name": "disable_cancel_meeting_notification", "value": "" }, { "name": "enable_remote_support", "value": "" }, { "name": "enable_file_transfer", "value": "" }, { "name": "enable_virtual_background", "value": "" }, { "name": "enable_attention_tracking", "value": "" }, { "name": "enable_waiting_room", "value": "" }, { "name": "enable_use_pmi", "value": "" }, { "name": "enable_closed_caption", "value": "" }, { "name": "enable_co_host", "value": "" }, { "name": "enable_auto_saving_chats", "value": "" }, { "name": "enable_phone_participants_password", "value": "" }, { "name": "enable_auto_delete_cmr", "value": "" }, { "name": "auto_delete_cmr_days", "value": "" }, { "name": "pmi", "value": "" }, { "name": "dept", "value": "" }, { "name": "timezone", "value": "" }, { "name": "vanity_name", "value": "" }, { "name": "host_key", "value": "" }, { "name": "group_id", "value": "" }, { "name": "imgroup_id", "value": "" }, { "name": "cms_user_id", "value": "" } ] } }, "docs": "Update user info on Zoom via user ID.\n\n" }, { "info": { "name": "userUpdatepassword", "type": "http" }, "http": { "method": "POST", "url": "https://api.zoom.us/v1/user/updatepassword", "body": { "type": "form-urlencoded", "data": [ { "name": "id", "value": "" }, { "name": "pic_file", "value": "" } ] } }, "docs": "Upload and update user's profile picture on Zoom via user ID.\n\n" } ] } ], "bundled": true }