This website uses cookies. By clicking Accept, you consent to the use of cookies. Click Here to learn more about how we use cookies.
Accept
Reject
Community FAQ
cancel
Turn on suggestions
Auto-suggest helps you quickly narrow down your search results by suggesting possible matches as you type.
Showing results for 
Show  only  | Search instead for 
Did you mean: 
Glossary

This documentation is for the new preview UI. It’s still being refined and is subject to change. For documentation for the old UI, see Knowledge Base.

Zoom Connector

Article link copied to clipboard
Updated

on ‎10-31-2025 12:29 PM - edited on ‎10-31-2025 12:29 PM by Community Manager

Published
‎10-31-2025 12:29 PM
22 min read
Note on third‑party tools

We aim to provide accurate and helpful details about third‑party tools, but we can’t guarantee that this information is always complete or up to date. If you notice any discrepancies, feel free to share them in the feedback section below. For the most reliable information, please always refer to the third‑party tool’s official documentation.

Easily manage users, meetings, and webinars in your Zoom account

Connections

OAuth 2.0

OAuth 2.0 flow

This component uses OAuth 2.0 to connect to Zoom's API. To create a Zoom OAuth 2.0 app, first visit the Zoom Marketplace. Log in and click Develop -> Build App.

Zoom auto generates a name for the App, it can be modified at the top left. You can add an icon in that same section.

Select how the app is going to be managed.

Take note of the Client ID and Client secret that were generated - these will be entered when you create an integration that uses the Zoom component. These IDs are essential for authenticating your integration with Zoom.

Add the OAuth callback URL, https://oauth2.flowbuilder.eu.lansweeper.com/callback for EU sites or https://oauth2.flowbuilder.us.lansweeper.com/callback for US sites, to the OAuth Redirect URL input. The OAuth Allow Lists input should be populated automatically with the same value.

Click Continue.

At this section (Access), you can activate Event Subscriptions. To do this, check the appropriate box and copy the Secret Token for webhooks verification and functionality.

You can ignore Surface and Embed sections by clicking Continue.

Add Scopes

Scopes determine what an integration is allowed to do on your customer's behalf. For example, scopes might include permissions for accessing meetings, webinars, recordings, and user information.

Add your required scopes for meetings, webinars, recordings, and users. You can omit other scopes, as this component does not implement actions for accounts, billing, etc.

You can also add a Scope Description for clarity.

Click Continue to complete the creation of your OAuth app.

Click Add App Now. You should be redirected to a Zoom consent screen. Click Allow. After that, the the OAuth callback URL should open with an Authorization failed message. Ignore it.

You can now authenticate your integration with Zoom. Additional information on Zoom OAuth 2.0 apps is available in Zoom's documentation.

This connection uses OAuth 2.0, a common authentication mechanism for integrations.
Read about how OAuth 2.0 works here.

Input Comments Default
Client ID Client Identifier of your app for Zoom.
Client Secret Client Secret of your app for Zoom.

Server to Server

Server to Server connection

This component uses Server to Server OAuth to connect to Zoom's API for authentication. Server to Server OAuth apps are ideal for backend integrations that don't require user interaction. To create a Zoom Server to Server OAuth app, first visit the Zoom Marketplace. Log in and click Develop -> Build App.

Create Server to Server OAuth App

Navigate to Zoom Marketplace. Log in and click Develop -> Build App.
Select Server to Server OAuth App as the app type. This authentication method is designed for server applications that need to access Zoom APIs without user intervention.

App Credentials

Take note of the following credentials that are generated. These will be entered when you create an integration that uses the Zoom component:

  • Client ID: Your app's unique identifier
  • Client Secret: Your app's secret key (keep this secure)
  • Account ID: Your Zoom account identifier

Features

In the Features section, you can configure:

  • Event Subscriptions (if needed for webhooks)
  • Additional app features specific to your use case

If you plan to use Event Subscriptions, check the appropriate box and copy the Secret Token for webhook verification and functionality.

Scopes

Scopes determine what your Server to Server integration is allowed to do. Since this is a machine to machine authentication, you'll need to carefully select scopes based on your integration requirements.

Common scopes for Zoom integrations include:

Recommended Scopes

  • meeting:read:meeting:admin - View all user meetings
  • meeting:write:meeting:admin - Create and manage meetings
  • user:read:user:admin - View user information
  • user:write:user:admin - Manage user accounts
  • webinar:read:webinar:admin - View webinar information
  • webinar:write:webinar:admin - Create and manage webinars
  • cloud_recording:read:recording:admin - View recordings

Activation

Review your app configuration and click Activate your app. Unlike OAuth apps, Server to Server apps don't require user consent and are immediately active once created.

Account ID Location

Your Account ID can be found in multiple locations:

  1. In the app credentials section after creation
  2. In your Zoom account settings under Account Management -> Account Info
  3. In the Zoom Admin dashboard URL (the alphanumeric string after /account/)

Credential Management

  • Store your Client Secret securely and never expose it outside the integration.
  • Rotate credentials periodically for enhanced security
  • Use environment variables or secure configuration management for credentials

Rate Limiting

Server to Server apps are subject to Zoom's rate limiting policies. Monitor your API usage and implement appropriate retry logic with exponential backoff.

Integration Configuration

When configuring your integration, you'll need to provide:

  1. Client ID: From your Zoom Server to Server app
  2. Client Secret: From your Zoom Server to Server app
  3. Account ID: Your Zoom account identifier

This connection uses OAuth 2.0, a common authentication mechanism for integrations.
Read about how OAuth 2.0 works here.

Input Comments Default
Client ID Client Identifier of your server to server app for Zoom.
Client Secret Client Secret of your server to server app for Zoom.
Account ID Account Identifier of your server to server app for Zoom.

Triggers

Webhook

Receive and validate webhook requests from Zoom for webhooks you configure.

Input Comments Default
Zoom Webhook Secret Token Please provide your Zoom webhook key.

Actions

Add Meeting Registrant

Add a new registrant to an existing meeting

Input Comments Default
Connection
Meeting Id Provide the unique identifier of a meeting.
Email Provide a valid email address.
First Name Provide a string value for the first name.
Last Name Provide a string value for the last name
Address Provide a string value for the address.
City Provide a string value for the city
Country Provide a string value for the country. Use the format provided by the Zoom API documentation: https://marketplace.zoom.us/docs/api-reference/other-references/abbreviation-lists#countries
Zip Code Provide a string value for the zipcode
State Provide a string value for the state or province.
Phone Provide a string value for the phone number.
Industry Provide a string value for their industry
Organization Provide a string value for the registrant's organization.
Job Title Provide a string value for the job title.
Purchasing Time Frame The registrant's purchasing time frame.
Role In Purchase Process Provide a string value for the registrants role in the purchase process.
Number Of Employees Provide a value form the supplied list.
Custom Questions Provide an array custom questions for the registrant. Remove the default content if you do not want to include custom questions. [
{
"title": "What do you hope to learn from this?",
"value": "Look forward to learning how you come up with new recipes and what other services you offer."
}
]
Language The registrant's language preference for confirmation emails.
Auto Approve If a meeting was scheduled with the Approval Type field value of 1 (manual approval) but you want to automatically approve meeting registrants, set the value of this field to true. false
Comments Provide a string value for comments.
Occurrence Ids A comma-separated list of meeting occurrence IDs.

Add Webinar Registrant

Add a new registrant of an existing webinar

Input Comments Default
Connection
First Name Provide a string value for the first name.
Last Name Provide a string value for the last name
Email Provide a valid email address.
Address Provide a string value for the address.
City Provide a string value for the city
State Provide a string value for the state or province.
Zip Code Provide a string value for the zipcode
Country Provide a string value for the country. Use the format provided by the Zoom API documentation: https://marketplace.zoom.us/docs/api-reference/other-references/abbreviation-lists#countries
Phone Provide a string value for the phone number.
Comments Provide a string value for comments.
Custom Questions Provide an array custom questions for the registrant. Remove the default content if you do not want to include custom questions. [
{
"title": "What do you hope to learn from this?",
"value": "Look forward to learning how you come up with new recipes and what other services you offer."
}
]
Industry Provide a string value for their industry
Job Title Provide a string value for the job title.
Number Of Employees Provide a value form the supplied list.
Organization Provide a string value for the registrant's organization.
Purchasing Time Frame The registrant's purchasing time frame.
Role In Purchase Process Provide a string value for the registrants role in the purchase process.
Language The registrant's language preference for confirmation emails.
Source Id The tracking source's unique identifier.
Occurrence Ids A comma-separated list of meeting occurrence IDs.

Create Meeting

Create a new meeting with an existing user as the host

Input Comments Default
Connection
User Id Provide the unique identifier of a user.
Topic The meeting's topic.
Type Provide a value from the provided list.
Start Time The meeting's start time. This field is only used for scheduled or recurring meetings with a fixed time. This supports local time and GMT formats.
Duration Provide a value for the duration in minutes. This field is only used for scheduled meetings.
Timezone The timezone to assign to the 'Start Time' input value. This field is only used for scheduled or recurring meetings with a fixed time. For a list of supported timezones and their formats, see https://developers.zoom.us/docs/api/rest/other-references/abbreviation-lists/#timezones
Password Provide a value up to 10 characters for the password.
Agenda Provide a string value for the agenda. This property has a maximum length of 2,000 characters.
Type Recurrence Pick a value from the provided list.
Repeat Interval Define the interval when the meeting should recur. For instance, to schedule a meeting that recurs every two months, set this field's value as 2 and the value of the Type field as 3.
Weekly Day This field is required if you're scheduling a recurring meeting of Type 2 to state the days of the week when the meeting should repeat. The value for this field could be a number between 1 to 7. For instance, if the meeting should recur on Sunday, provide 1 as this field's value. To set the meeting to occur on multiple days of a week, provide comma separated values for this field like 1,3 to set the meeting to occur on Sunday and Tuesday.
Monthly Day Provide a value from 1-31 to determine which days of the month your meeting will occur on. For instance if you want your meeting to occur every 5th of each month, provide a 5. This field is required if you selected Type 3 for recurrence.
Monthly Week Use this field only if you're scheduling a recurring meeting of Type 3 to state the week of the month when the meeting should recur. If you use this field, you must also use the Monthly Week Day field to state the day of the week when the meeting should recur.
Monthly Week Day Use this field only if you're scheduling a recurring meeting of Type 3 to state a specific day in a week when the monthly meeting should recur. To use this field, you must also use the Monthly Week field. Provide a value from 1 being Sunday to 7 being Saturday.
End Date Time Select the final date when the meeting will recur before it is canceled. Cannot be used with the 'End Times' input.
Host Video On Start This flag will determine if the host's video is turned on by default. false
Participant Video This flag will determine if participants video is turned on by default. false
Join Before Host This flag will determine if participants are allowed to join before the host. false
Mute Upon Entry This flag will determine if participants are muted by default when they join. false
Use Watermark This flag will determine if a watermark will be displayed on screen share. false
Use Personal Meeting ID This flag will determine whether or not to use a personal meeting Id, over a generated meeting Id. false
Approval Type Enable meeting registration approval. 2
Registration Type This field is only for recurring meetings with fixed times (8). 1
Registration Email Notifications Whether to send registrants email notifications about their registration approval, cancellation, or rejection. false
Settings Extra Fields Provide additional fields for the settings object that are not covered by the other inputs. Remove the default content if you do not want to include extra fields. For more information, refer to the Zoom API documentation: https://developers.zoom.us/docs/api/rest/reference/zoom-api/methods/#operation/meetingCreate {
"additional_data_center_regions": [
"TY"
],
"allow_multiple_devices": true,
"alternative_hosts": "jchill@example.com;thill@example.com",
"alternative_hosts_email_notification": true,
"approved_or_denied_countries_or_regions": {
"approved_list": [
"CX"
],
"denied_list": [
"CA"
],
"enable": true,
"method": "approve"
},
"audio_conference_info": "test",
"authentication_domains": "example.com",
"authentication_exception": [
{
"email": "jchill@example.com",
"name": "Jill Chill"
}
],
"authentication_option": "signIn_D8cJuqWVQ623CI4Q8yQK0Q",
"breakout_room": {
"enable": true,
"rooms": [
{
"name": "room1",
"participants": [
"jchill@example.com"
]
}
]
},
"calendar_type": 1,
"close_registration": false,
"contact_email": "jchill@example.com",
"contact_name": "Jill Chill",
"email_notification": true,
"encryption_type": "enhanced_encryption",
"focus_mode": true,
"jbh_time": 0,
"language_interpretation": {
"enable": true,
"interpreters": [
{
"email": "interpreter@example.com",
"languages": "US,FR"
}
]
},
"sign_language_interpretation": {
"enable": true,
"interpreters": [
{
"email": "interpreter@example.com",
"sign_language": "American"
}
]
},
"meeting_authentication": true,
"meeting_invitees": [
{
"email": "jchill@example.com"
}
],
"private_meeting": false,
"registrants_confirmation_email": true,
"show_share_button": true,
"waiting_room": false,
"host_save_video_order": true,
"alternative_host_update_polls": true,
"internal_meeting": false,
"continuous_meeting_chat": {
"enable": true,
"auto_add_invited_external_users": true
},
"participant_focused_meeting": false,
"push_change_to_calendar": false,
"resources": [
{
"resource_type": "whiteboard",
"resource_id": "X4Hy02w3QUOdskKofgb9Jg",
"permission_level": "editor"
}
],
"auto_start_meeting_summary": false,
"auto_start_ai_companion_questions": false
}
Audio Method How participants join the audio portion of the meeting. both
Auto Recording The automatic recording settings. none
Global Dial In Countries For each item specify the code of a country that is available for global dial in.
Default Password Whether to generate a default passcode using the user's settings. false
Pre Schedule Whether to create a prescheduled meeting via the GSuite app. false
End Times Select how many times the meeting should recur before it is canceled. If set to 0, it means there is no end time. The maximum number of recurring is 60. Cannot be used with the 'End Date Time' input. 1
Schedule For The email address or user ID of the user to schedule a meeting for.
Template Id The account admin meeting template ID used to schedule a meeting using a meeting template.
Tracking Fields Information about the meeting's tracking fields. Remove the default content if you do not want to include tracking fields. [
{
"field": "field1",
"value": "value1"
}
]

Create User

Create a new user

Input Comments Default
Connection
User Action The action to take to create the new user. create
Email Provide a valid email address.
First Name Provide a string value for the first name.
Last Name Provide a string value for the last name
Display Name The user's display name.
User Password User password. Only used for the "autoCreate" function. The password has to have a minimum of 8 characters and maximum of 32 characters. By default (basic requirement), password must have at least one letter (a, b, c..), at least one number (1, 2, 3...) and include both uppercase and lowercase letters. It should not contain only one identical character repeatedly ('11111111' or 'aaaaaaaa') and it cannot contain consecutive characters ('12345678' or 'abcdefgh').
User Type The value provided will determine the type of user that will be created.
Zoom Phone Whether the user has the Zoom Phone feature enabled. false
Zoom One Type The type of Zoom One user.
Plan United Type The type of Plan United user.

Delete User

Disassociate (unlink) a user or permanently delete a user by ID.

Input Comments Default
Connection
User Id Provide the unique identifier of a user.
Encrypted Email Whether the email address passed for the 'User Id' value is an encrypted email address. false
Action Delete action options. disassociate
Transfer Email Transfer email. This field is required if the user has Zoom Events/Sessions feature. After you delete or disassociate the user, the user's hub assets on Zoom Events site will be transferred to the target user.
Transfer Meeting Transfer meeting. false
Transfer Webinar Transfer webinar. false
Transfer Recording Transfer recording. false
Transfer Whiteboard When deleting a user, whether to transfer all their Zoom Whiteboard data to another user. false

Get Meeting

Get the information and metadata of a meeting by Id

Input Comments Default
Connection
Meeting Id Provide the unique identifier of a meeting.
Occurrence Id Meeting occurrence ID. Provide this field to view meeting details of a particular occurrence of the recurring meeting.
Show Previous Occurrences Turn this flag ON to view meeting details of all previous occurrences of a recurring meeting. false

Get Meeting Invitation

Get an invitation for a meeting

Input Comments Default
Connection
Meeting Id Provide the unique identifier of a meeting.

Get Meeting Recordings

Get a list of all recordings of a meeting

Input Comments Default
Connection
Meeting Id Provide the unique identifier of a meeting.
Include Fields The download_access_token value for downloading the meeting's recordings.
Time To Live The download_access_token Time to Live (TTL) value. This parameter is only valid if the 'Include Fields' input contains the download_access_token value. Min value is 0 and max value is 604800 (7 days).

Get Phone Recordings

List all of the given users call recordings

Input Comments Default
Connection
User Id Provide the unique identifier of a user.
From The date range defined by the 'From' and 'To' inputs should be a month as the response only includes one month's worth of data at once. The month defined should fall within the last six months. If unspecified, returns data from the past 30 days.
To Required only when the 'From' input is provided.

Get User

Get the information and metadata of a user by Id

Input Comments Default
Connection
User Id Provide the unique identifier of a user.
Login Type The user's login method.
Encrypted Email Whether the email address passed for the 'User Id' value is an encrypted email address. false
Search By Unique Id Whether the queried 'User Id' value is an employee unique ID. This value defaults to false. false

Get Webinar

Get the information and metadata of a webinar by Id

Input Comments Default
Connection
Webinar Id Provide the unique identifier of a webinar.
Occurrence Id Unique identifier for an occurrence of a recurring webinar. Recurring webinars can have a maximum of 50 occurrences.
Show Previous Occurrences Turn this flag ON to view details of all previous occurrences of a recurring webinar. false

List Meeting Registrants

Get the information and metadata of all registrants to a meeting by Id

Input Comments Default
Connection
Meeting Id Provide the unique identifier of a meeting.
Occurrence Id Meeting occurrence ID. Provide this field to view meeting details of a particular occurrence of the recurring meeting.
Registrant Status Query by the registrant's status. approved

List Meetings

List all meetings by user Id

Input Comments Default
Connection
User Id Provide the unique identifier of a user.
Type Of Meeting Query by the meeting type. scheduled
From The start date for the query.
To The end date for the query.
Timezone The timezone to assign to the 'From' and 'To' value.

List Users

List all users connected to your Zoom account

Input Comments Default
Connection
User Status The user's status. active
Role Id The role's unique ID. Use this parameter to filter the response by a specific role.
Include Fields The download_access_token value for downloading the meeting's recordings.
License The user's license. Filter the response by a specific license.

List User's Channels

List all channels of a given user

Input Comments Default
Connection
User Id Provide the unique identifier of a user.

List User's Chat Messages

List all chat messages of a given user

Input Comments Default
Connection
User Id Provide the unique identifier of a user.
To Contact This field allows you to query by the email address, user ID, or member ID of a chat contact with whom the user communicated. The API only returns messages sent and received between the user and the queried contact. You must provide either the 'To Contact' or the 'To Channel' query parameter. When you use the 'Search Key' and 'Search Type' parameters, this parameter is optional and not required.
To Channel This field allows you to query by the channel ID of a channel in which the user had chat conversations. The API only returns messages sent and received by the user in the queried channel. You must provide either the 'To Contact' or the 'To Channel' query parameter. When you use the 'Search Key' and 'Search Type' parameters, this parameter is optional and not required. You must provide either the to_contact or the to_channel query parameter. When you call the 'Search Key' and 'Search Type' query parameters, this query parameter is optional and not required.
Date The query date from which to retrieve the chat messages. This value defaults to the current date. If you do not provide the 'Date' or 'From' inputs, the API defaults to the 'Date' parameter.
From The query start date in yyyy-MM-dd'T'HH:mm:ss'Z' format. If you provide both the 'Date' and 'from' inputs, the API uses the 'Date' input value to query.
To The query end date in yyyy-MM-dd'T'HH:mm:ss'Z' format. This value defaults to the current date.
Include Deleted And Edited Message This field sets the value of this field to true to include edited and deleted messages in the response. false
Search Type The type of search. If you use this input, you must also include a 'Search Key' input value. The 'To Contact' and the 'To Channel' inputs are not required when you use this input. If you do not call them, the API returns all contact and channel messages that match the 'Search Type' input. If you use this parameter, you cannot also query the 'Include Deleted And Edited Message' input. This parameter does not support the return of deleted or updated messages.
Search Key The query string for messages or files, up to 256 characters. If you use this input, you must also include a 'Search Type' input value. The 'To Contact' and the 'To Channel' inputs are not required when you use this input. If you do not call them, the API returns all contact and channel messages that match the 'Search Key' input. If you use this parameter, you cannot also query the 'Include Deleted And Edited Message' input. This parameter does not support the return of deleted or updated messages.
Exclude Child Message This parameter excludes returning all child messages in a chat. It leaves only the parent messages. false
Download File Formats This field returns the download URL in the specified format for different types of files. Currently, we only support the download URL in the .mp4 format for audio files. If this parameter is not specified, it returns the download URL of the file in its default format.

List Webinar Participants

List all participants of a given webinar

Input Comments Default
Connection
Webinar Id Provide the unique identifier of a webinar.

List Webinar Registrants

List all registrants of a given webinar.

Input Comments Default
Connection
Webinar Id Provide the unique identifier of a webinar.
Occurrence Id The meeting or webinar occurrence ID.
Registrant Status Query by the registrant's status. approved
Tracking Source Id The tracking source ID for the registrants. Useful if you share the webinar registration page in multiple locations.

List Webinars

List all webinars for the given user

Input Comments Default
Connection
User Id Provide the unique identifier of a user.
Webinar Type The type of webinar.

Raw Request

Send raw HTTP request to Zoom

Input Comments Default
Connection
URL Input the path only (/workspaces), The base URL is already included (https://api.zoom.us/v2). For example, to connect to https://api.zoom.us/v2/workspaces, only /workspaces is entered in this field.
Method The HTTP method to use.
Data The HTTP body payload to send to the URL.
Form Data The Form Data to be sent as a multipart form upload.
File Data File Data to be sent as a multipart form upload.
File Data File Names File names to apply to the file data inputs. Keys must match the file data keys above.
Query Parameter A list of query parameters to send with the request. This is the portion at the end of the URL similar to ?key1=value1&key2=value2.
Header A list of headers to send with the request.
Response Type The type of data you expect in the response. You can request json, text, or binary data. json
Timeout The maximum time that a client will await a response to its request
Debug Request Enabling this flag will log out the current request. false
Retry Delay (ms) The delay in milliseconds between retries. This is used when 'Use Exponential Backoff' is disabled. 0
Retry On All Errors If true, retries on all erroneous responses regardless of type. This is helpful when retrying after HTTP 429 or other 3xx or 4xx errors. Otherwise, only retries on HTTP 5xx and network errors. false
Max Retry Count The maximum number of retries to attempt. Specify 0 for no retries. 0
Use Exponential Backoff Specifies whether to use a pre-defined exponential backoff strategy for retries. When enabled, 'Retry Delay (ms)' is ignored. false

Update Meeting

Update the information and metadata of an existing meeting by Id

Input Comments Default
Connection
Meeting Id Provide the unique identifier of a meeting.
Type Recurrence Pick a value from the provided list.
Topic Provide a string value for the topic.
Type Provide a value from the provided list.
Start Time The meeting's start time. This field is only used for scheduled or recurring meetings with a fixed time. This supports local time and GMT formats.
Duration Provide a value for the duration in minutes. This field is only used for scheduled meetings.
Timezone Provide a string value for a valid timezone. Refer to the Id value in the timezone list: https://developers.zoom.us/docs/api/rest/other-references/abbreviation-lists/#timezones
Password Provide a value up to 10 characters for the password.
Pre Schedule Whether to create a prescheduled meeting via the GSuite app. false
Schedule For The email address or user ID of the user to schedule a meeting for.
Template Id The account admin meeting template ID used to schedule a meeting using a meeting template.
Agenda Provide a string value for the agenda. This property has a maximum length of 2,000 characters.
Repeat Interval Define the interval when the meeting should recur. For instance, to schedule a meeting that recurs every two months, set this field's value as 2 and the value of the Type field as 3.
Weekly Day This field is required if you're scheduling a recurring meeting of Type 2 to state the days of the week when the meeting should repeat. The value for this field could be a number between 1 to 7. For instance, if the meeting should recur on Sunday, provide 1 as this field's value. To set the meeting to occur on multiple days of a week, provide comma separated values for this field like 1,3 to set the meeting to occur on Sunday and Tuesday.
Monthly Day Provide a value from 1-31 to determine which days of the month your meeting will occur on. For instance if you want your meeting to occur every 5th of each month, provide a 5. This field is required if you selected Type 3 for recurrence.
Monthly Week Use this field only if you're scheduling a recurring meeting of Type 3 to state the week of the month when the meeting should recur. If you use this field, you must also use the Monthly Week Day field to state the day of the week when the meeting should recur.
Monthly Week Day Use this field only if you're scheduling a recurring meeting of Type 3 to state a specific day in a week when the monthly meeting should recur. To use this field, you must also use the Monthly Week field. Provide a value from 1 being Sunday to 7 being Saturday.
End Date Time Select the final date when the meeting will recur before it is canceled. Cannot be used with the 'End Times' input.
End Times Select how many times the meeting should recur before it is canceled. If set to 0, it means there is no end time. The maximum number of recurring is 60. Cannot be used with the 'End Date Time' input. 1
Host Video On Start This flag will determine if the host's video is turned on by default. false
Participant Video This flag will determine if participants video is turned on by default. false
Join Before Host This flag will determine if participants are allowed to join before the host. false
Mute Upon Entry This flag will determine if participants are muted by default when they join. false
Use Watermark This flag will determine if a watermark will be displayed on screen share. false
Use Personal Meeting ID This flag will determine whether or not to use a personal meeting Id, over a generated meeting Id. false
Approval Type Enable meeting registration approval. 2
Registration Type This field is only for recurring meetings with fixed times (8). 1
Registration Email Notifications Whether to send registrants email notifications about their registration approval, cancellation, or rejection. false
Settings Extra Fields Provide additional fields for the settings object that are not covered by the other inputs. Remove the default content if you do not want to include extra fields. For more information, refer to the Zoom API documentation: https://developers.zoom.us/docs/api/rest/reference/zoom-api/methods/#operation/meetingCreate {
"additional_data_center_regions": [
"TY"
],
"allow_multiple_devices": true,
"alternative_hosts": "jchill@example.com;thill@example.com",
"alternative_hosts_email_notification": true,
"approved_or_denied_countries_or_regions": {
"approved_list": [
"CX"
],
"denied_list": [
"CA"
],
"enable": true,
"method": "approve"
},
"audio_conference_info": "test",
"authentication_domains": "example.com",
"authentication_exception": [
{
"email": "jchill@example.com",
"name": "Jill Chill"
}
],
"authentication_option": "signIn_D8cJuqWVQ623CI4Q8yQK0Q",
"breakout_room": {
"enable": true,
"rooms": [
{
"name": "room1",
"participants": [
"jchill@example.com"
]
}
]
},
"calendar_type": 1,
"close_registration": false,
"contact_email": "jchill@example.com",
"contact_name": "Jill Chill",
"email_notification": true,
"encryption_type": "enhanced_encryption",
"focus_mode": true,
"jbh_time": 0,
"language_interpretation": {
"enable": true,
"interpreters": [
{
"email": "interpreter@example.com",
"languages": "US,FR"
}
]
},
"sign_language_interpretation": {
"enable": true,
"interpreters": [
{
"email": "interpreter@example.com",
"sign_language": "American"
}
]
},
"meeting_authentication": true,
"meeting_invitees": [
{
"email": "jchill@example.com"
}
],
"private_meeting": false,
"registrants_confirmation_email": true,
"show_share_button": true,
"waiting_room": false,
"host_save_video_order": true,
"alternative_host_update_polls": true,
"internal_meeting": false,
"continuous_meeting_chat": {
"enable": true,
"auto_add_invited_external_users": true
},
"participant_focused_meeting": false,
"push_change_to_calendar": false,
"resources": [
{
"resource_type": "whiteboard",
"resource_id": "X4Hy02w3QUOdskKofgb9Jg",
"permission_level": "editor"
}
],
"auto_start_meeting_summary": false,
"auto_start_ai_companion_questions": false
}
Audio Method How participants join the audio portion of the meeting. both
Auto Recording The automatic recording settings. none
Global Dial In Countries For each item specify the code of a country that is available for global dial in.
Occurrence Id Meeting occurrence ID.
Tracking Fields Information about the meeting's tracking fields. Remove the default content if you do not want to include tracking fields. [
{
"field": "field1",
"value": "value1"
}
]

Update User

Update the information or metadata of a user by Id

Input Comments Default
Connection
Login Type The user's login method.
Remove TSP Credentials Whether to remove the user's TSP credentials. false
User Id Provide the unique identifier of a user.
CMS User Id Provide a string value for the user Id in the CMS.
Company Provide a string value for the company.
Custom Attributes The user's assigned custom attributes. Remove the default content if you do not want to include custom attributes. [
{
"key": "cbf_cywdkexrtqc73f97gd4w6g",
"name": "A1",
"value": "1"
}
]
Timezone Provide a string value for the department of the user.
First Name Provide a string value for the first name.
Group Id Provide the unique identifier of the group that you would like to add a pending user to.
Host Key Provide a 6-10 digit value for the host key of the user.
Job Title Provide a string value for the job title.
User Language The user's language.
Last Name Provide a string value for the last name
Location Provide a string value for the location.
Manager The user's assigned manager.
Phone Numbers Information about the user's assigned phone numbers. Remove the default content if you do not want to include phone numbers. Allowed label values are: Mobile┃Office┃Home┃Fax [
{
"code": "+1",
"country": "US",
"label": "Mobile",
"number": "5550100"
}
]
Personal Meeting Id Provide an integer value for the personal meeting Id of a user.
Pronouns The user's pronouns.
Pronouns The user's pronouns.
Timezone Provide a string value for a valid timezone. Refer to the Id value in the timezone list: https://developers.zoom.us/docs/api/rest/other-references/abbreviation-lists/#timezones
User Type The type of user.
Use Personal Meeting ID This flag will determine whether or not to use a personal meeting Id, over a generated meeting Id. false
Vanity Name This value will determine the name of your personal meeting room.
Display Name The user's display name.
Zoom One Type The Zoom One plan option.
Plan United Type The Plan United plan option.
Zoom Phone Whether the user has the Zoom Phone feature enabled. false
About Me The user's self-introduction. Hyperlinks or HTML code not allowed in this field.
LinkedIn URL The user's LinkedIn URL.