POST /users/{userId}/meetings

The user ID or email address of the user. For user-level apps, pass me as the value for userId.

Default value: "application/json"

Meeting description.

Time zone to format start_time. For example, "America/Los_Angeles". For scheduled meetings only. Please reference our time zone list for supported time zones and their formats.

Meeting topic.

Tracking fields

Label of the tracking field.

Tracking fields value

Meeting start time. We support two formats for start_time - local time and GMT.

To set time as GMT the format should be yyyy-MM-ddTHH:mm:ssZ. Example: "2020-03-31T12:02:00Z"

To set time using a specific timezone, use yyyy-MM-ddTHH:mm:ss format and specify the timezone ID in the timezone field OR leave it blank and the timezone set on your Zoom account will be used. You can also set the time as UTC as the timezone field.

The start_time should only be used for scheduled and / or recurring webinars with fixed time.

Recurrence object. Use this object only for a meeting with type 8 i.e., a recurring meeting with fixed time.

This field is required if you're scheduling a recurring meeting of type 2 to state which day(s) of the week the meeting should repeat.

The value for this field could be a number between 1 to 7 in string format. For instance, if the meeting should recur on Sunday, provide "1" as the value of this field.

Note: If you would like the meeting to occur on multiple days of a week, you should provide comma separated values for this field. For instance, if the meeting should recur on Sundays and Tuesdays provide "1,3" as the value of this field.

1 - Sunday.
2 - Monday.
3 - Tuesday.
4 - Wednesday.
5 - Thursday.
6 - Friday.
7 - Saturday.

Valid values:

• "4"
• "3"
• "2"
• "1"
• "7"
• "6"
• "5"

Default value: "1"

Select the final date on which the meeting will recur before it is canceled. Should be in UTC time, such as 2017-11-25T12:00:00Z. (Cannot be used with "end_times".)

Select how many times the meeting should recur before it is canceled. (Cannot be used with "end_date_time".)

Default value: 1

Recurrence meeting types:
1 - Daily.
2 - Weekly.
3 - Monthly.

Valid values:

• 1
• 2
• 3

Define the interval at which the meeting should recur. For instance, if you would like to schedule a meeting that recurs every two months, you must set the value of this field as 2 and the value of the type parameter as 3.

For a daily meeting, the maximum interval you can set is 90 days. For a weekly meeting the maximum interval that you can set is of 12 weeks. For a monthly meeting, there is a maximum of 3 months.

Use this field only if you're scheduling a recurring meeting of type 3 to state which day in a month, the meeting should recur. The value range is from 1 to 31.

For instance, if you would like the meeting to recur on 23rd of each month, provide 23 as the value of this field and 1 as the value of the repeat_interval field. Instead, if you would like the meeting to recur every three months, on 23rd of the month, change the value of the repeat_interval field to 3.

Default value: 1

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.
-1 - Last week of the month.
1 - First week of the month.
2 - Second week of the month.
3 - Third week of the month.
4 - Fourth week of the month.

Valid values:

• 1
• 2
• 3
• -1
• 4

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.

1 - Sunday.
2 - Monday.
3 - Tuesday.
4 - Wednesday.
5 - Thursday.
6 - Friday.
7 - Saturday.

Valid values:

• 1
• 2
• 3
• 4
• 5
• 6
• 7

Passcode to join the meeting. By default, passcode may only contain the following characters: [a-z A-Z 0-9 @ - _ *] and can have a maximum of 10 characters.

Note: If the account owner or the admin has configured minimum passcode requirement settings, the passcode value provided here must meet those requirements.

If the requirements are enabled, you can view those requirements by calling either the Get User Settings API or the Get Account Settings API.

Meeting Type:
1 - Instant meeting.
2 - Scheduled meeting.
3 - Recurring meeting with no fixed time.
8 - Recurring meeting with fixed time.

Valid values:

• 1
• 2
• 3
• 8

Default value: 2

Meeting settings.

Contact email for registration

Alternative host's emails or IDs: multiple values separated by a comma.

Approve or block users from specific regions/countries from joining this meeting.

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/countries to join this meeting. If this setting is selected, the approved regions/countries must be included in the approved_list.

deny: Block users from specific regions/countries from joining this meeting. If this setting is selected, the approved regions/countries must be included in the denied_list

Valid values:

• "deny"
• "approve"

List of countries/regions from where participants can join this meeting.

true: Setting enabled to either allow users or block users from specific regions to join your meetings.

false: Setting disabled.

List of countries/regions from where participants can not join this meeting.

Mute participants upon entry.

Default value: false

Determine how participants can join the audio portion of the meeting.
both - Both Telephony and VoIP.
telephony - Telephony only.
voip - VoIP only.

Valid values:

• "both"
• "voip"
• "telephony"

Default value: "both"

Setting to pre-assign breakout rooms.

Create room(s).

Name of the breakout room.

Email addresses of the participants who are to be assigned to the breakout room.

Set the value of this field to true if you would like to enable the breakout room pre-assign option.

Specify the authentication type for users to join a meeting withmeeting_authentication setting set to true. The value of this field can be retrieved from the id field within authentication_options array in the response of Get User Settings API.

Meeting authentication domains. This option, allows you to specify the rule so that Zoom users, whose email address contains a certain domain, can join the meeting. You can either provide multiple domains, using a comma in between and/or use a wildcard for listing domains.

List of global dial-in countries

Start video when the host joins the meeting.

If set to true, the registration page for the meeting will include social share buttons.

Note: This setting is only applied for meetings that have enabled registration.

Close registration after event date

Default value: false

Contact name for registration

Host meeting in China.

Default value: false

Automatic recording:
local - Record on local.
cloud - Record on cloud.
none - Disabled.

Valid values:

• "local"
• "cloud"
• "none"

Default value: "none"

Enable waiting room. Note that if the value of this field is set to true, it will override and disable the join_before_host setting.

Enable additional data center regions for this meeting. Provide the value in the form of array of country code(s) for the countries which are available as data center regions in the account settings but have been opt out of in the user settings. For instance, let's say that in your account settings, the data center regions that have been selected are Europe, Honkong, Australia, India, Latin America, Japan, China, United States,and Canada. The complete list of available data center regions for your account is: ["EU", "HK", "AU", "IN", "LA", "TY", "CN", "US", "CA"]. In user settings, you have opted out of India(IN) and Japan(TY) for meeting and webinar traffic routing. If you would like, you can still include India and Japan as additional data centers for this meeting using this field. To include India and Japan as additional data center regions, you would provide ["IN", "TY"] as the value.

Start video when participants join the meeting.

Send email notifications to registrants about approval, cancellation, denial of the registration. The value of this field must be set to true in order to use the registrants_confirmation_email field.

Choose between enhanced encryption and end-to-end encryption when starting or a meeting. When using end-to-end encryption, several features (e.g. cloud recording, phone/SIP/H.323 dial-in) will be automatically disabled.

The value of this field can be one of the following:
enhanced_encryption: Enhanced encryption. Encryption is stored in the cloud if you enable this option.

e2ee: End-to-end encryption. The encryption key is stored in your local device and can not be obtained by anyone else. Enabling this setting also disables the following features: join before host, cloud recording, streaming, live transcription, breakout rooms, polling, 1:1 private chat, and meeting reactions.

Valid values:

• "enhanced_encryption"
• "e2ee"

Add watermark when viewing a shared screen.

Default value: false

Only authenticated users can join meeting if the value of this field is set to true.

Language interpretation settings for meetings.

Note: This feature is only available on certain Webinar add-on, Education, Business and higher plans. If this feature is not enabled on the host's account, this setting will not be applied for the meeting.

Information associated with the interpreter.

Email address of the interpreter.

Languages for interpretation. The string must contain two country Ids separated by a comma.

For example, if the language is to be interpreted from English to Chinese, the value of this field should be "US,CN".

Indicate whether or not you would like to enable language interpretation for this meeting.

Host meeting in India.

Default value: false

If set to true, attendees will be allowed to join a meeting from multiple devices.

Note: This setting is only applied for meetings that have enabled registration.

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. The value of this field can be one of the following:

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

Valid values:

• 0
• 5
• 10

Allow participants to join the meeting before the host starts the meeting. This field can only used for scheduled or recurring meetings.

Note: If waiting room is enabled, the join before host setting will be disabled.

Default value: false

Flag to determine whether to send email notifications to alternative hosts, default value is true.

Default value: true

The default value is 2. To enable registration required, set the approval type to 0 or 1. Values include:

0 - Automatically approve.
1 - Manually approve.
2 - No registration required.

Valid values:

• 0
• 1
• 2

Default value: 2

Registration type. Used for recurring meeting with fixed time only.
1 Attendees register once and can attend any of the occurrences.
2 Attendees need to register for each occurrence to attend.
3 Attendees register once and can choose one or more occurrences to attend.

Valid values:

• 1
• 2
• 3

Default value: 1

Use Personal Meeting ID instead of an automatically generated meeting ID. It can only be used for scheduled meetings, instant meetings and recurring meetings with no fixed time.

Default value: false

If you would like to schedule this meeting for someone else in your account, provide the Zoom user id or email address of the user here.

Meeting duration (minutes). Used for scheduled meetings only.

Unique identifier of the admin meeting template. To create admin meeting templates, contact the Zoom support team.

Use this field if you would like to schedule the meeting from a admin meeting template. You can retrieve the value of this field by calling the List meeting templates API.