/users/{userId}/meetings
Create a meeting for a user. For user-level apps, pass the me value instead of the userId parameter.
This API has a daily rate limit of 100 requests per day. Therefore, only 100 Create a Meeting API requests are permitted within a 24 hour window for a user.
Scopes:
meeting:write:admin meeting:write
Rate Limit Label: Medium
Authorization
Request Parameters
Request Body
Meeting object.
Meeting topic.
Meeting Type:1 - Instant meeting.2 - Scheduled meeting.3 - Recurring meeting with no fixed time.8 - Recurring meeting with fixed time.
Whether to create a prescheduled meeting. This only supports the meeting type value of 2 (Scheduled Meeting):
true— Create a prescheduled meeting.false— Create a regular meeting.
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.
Meeting duration (minutes). Used for scheduled meetings only.
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.
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.
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 description.
Tracking fields
Recurrence object. Use this object only for a meeting with type 8 i.e., a recurring meeting with fixed time.
Meeting settings.
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.
Responses
HTTP Status Code: 201
Meeting created.
Meeting ID: Unique identifier of the meeting in “long” format(represented as int64 data type in JSON), also known as the meeting number.
Unique identifier of the scheduler who scheduled this meeting on behalf of the host. This field is only returned if you used “schedule_for” option in the Create a Meeting API request.
Email address of the meeting host.
URL using which registrants can register for a meeting. This field is only returned for meetings that have enabled registration.
Meeting topic
Meeting Type
Whether to create a prescheduled meeting. This only supports the meeting type value of 2 (Scheduled Meeting):
true— Create a prescheduled meeting.false— Create a regular meeting.
Meeting start date-time in UTC/GMT. Example: “2020-03-31T12:02:00Z”
Meeting duration.
Timezone to format start_time
The date and time at which this meeting was created.
Agenda
URL to start the meeting. This URL should only be used by the host of the meeting and should not be shared with anyone other than the host of the meeting as anyone with this URL will be able to login to the Zoom Client as the host of the meeting.
URL for participants to join the meeting. This URL should only be shared with users that you would like to invite for the meeting.
Meeting password. Password may only contain the following characters: [a-z A-Z 0-9 @ - _ * !]
If “Require a password when scheduling new meetings” setting has been enabled and locked for the user, the password field will be autogenerated in the response even if it is not provided in the API request.
H.323/SIP room system password
Personal Meeting Id. Only used for scheduled meetings and recurring meetings with no fixed time.
Tracking fields
Array of occurrence objects.
Meeting settings.
Recurrence object. Use this object only for a meeting with type 8 i.e., a recurring meeting with fixed time.