/users/{userId}/meetings
Use this API to create a meeting for a user. For user-level apps, pass the me value instead of the userId parameter.
- A meeting’s
start_urlvalue is the URL a host or an alternative host can use to start a meeting. The expiration time for thestart_urlvalue is two hours for all regular users. - For
custCreatemeeting hosts (users created with thecustCreateparameter via the Create Users API), the expiration time of thestart_urlparameter is 90 days from the generation of thestart_url.
Note:
- For security reasons, the recommended way to programmatically (after expiry) get the updated
start_urlvalue is to call the Retrieve a Meeting API. Refer to thestart_urlvalue in the response. - This API has a daily rate limit of 100 requests per day. The rate limit is applied against the
userIdof the meeting host used to make the request.
Scopes: meeting:write:admin, meeting:write
Rate Limit Label: Medium
Authorization
Request Parameters
Request Body
Meeting object.
The meeting’s topic.
The type of meeting:
1— An instant meeting.2— A scheduled meeting.3— A recurring meeting with no fixed time.8— A recurring meeting with fixed time.
Whether to create a prescheduled meeting. This field only supports schedule meetings (2):
true— Create a prescheduled meeting.false— Create a regular meeting.
The meeting’s start time. This field is only used for scheduled and/or recurring meetings with a fixed time. This supports local time and GMT formats.
- To set a meeting’s start time in GMT, use the
yyyy-MM-ddTHH:mm:ssZdate-time format. For example,2020-03-31T12:02:00Z. - To set a meeting’s start time using a specific timezone, use the
yyyy-MM-ddTHH:mm:ssdate-time format and specify the timezone ID in thetimezonefield. If you do not specify a timezone, thetimezonevalue defaults to your Zoom account’s timezone. You can also useUTCfor thetimezonevalue.
The meeting’s scheduled duration, in minutes. This field is only used for scheduled meetings (2).
The email address or user ID of the user to schedule a meeting for.
The timezome to assign to the start_time value. This field is only used for scheduled meetings (2).
For a list of supported timezones and their format, refer to our timezone list documentation.
The password required to join the meeting. By default, a password can only have a maximum length of 10 characters and only contain alphanumeric characters and the @, -, _, and * characters.
- If the account owner or administrator has configured minimum passcode requirement settings, the password must meet those requirements.
- If password requirements are enabled, use the Get User Settings API or the Get Account Settings API to get the requirements.
Whether to generate a default password using the user’s settings. This value defaults to false.
If this value is true and the user has the PMI setting enabled with a password, then the user’s meetings will use the PMI password. It will not use a default password.
The meeting’s agenda. This value has a maximum length of 2,000 characters.
Information about the meeting’s tracking fields.
Recurrence object. Use this object only for a meeting with type 8 i.e., a recurring meeting with fixed time.
Information about the meeting’s settings.
The account admin meeting template ID with which to schedule a meeting using a meeting template. For a list of account admin-provided meeting templates, use the List meeting templates API.
- At this time, this field only accepts account admin meeting template IDs.
- To enable the account admin meeting templates feature, contact Zoom support.
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.