createMeeting.Rd
Create a meeting https://support.zoom.us/hc/enus/articles/201362413Schedulingmeetings for a user. 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.<aside>The <code>start_url</code> of a meeting is a URL using which a host or an alternative host can start a meeting. The expiration time for the <code>start_url</code> field is two hours for all regular users. For custCreate meeting hosts i.e., users created using the <code>custCreate</code> option via the Create Users https://marketplace.zoom.us/docs/apireference/zoomapi/users/usercreate API , the expiration time of the <code>start_url</code> field is 90 days from the generation of the <code>start_url</code>. For security reasons, the recommended way to retrieve the updated value for the <code>start_url</code> field programmatically after expiry is by calling the Retrieve a Meeting API https://marketplace.zoom.us/docs/apireference/zoomapi/meetings/meeting and referring to the value of the <code>start_url</code> field in the response.</aside>Scopes: meeting:write:admin meeting:write ** Rate Limit Label https://marketplace.zoom.us/docs/apireference/ratelimits#ratelimits :** Medium
createMeeting( userId, topic = NULL, type = NULL, start_time = NULL, duration = NULL, schedule_for = NULL, timezone = NULL, password = NULL, agenda = NULL, tracking_fields = NULL, recurrence = NULL, settings = NULL, return_response = F )
userId | The user ID or email address of the user. For userlevel apps, pass me as the value for userId. |
---|---|
topic | Meeting topic. |
type | Meeting Type:1 Instant meeting.2 Scheduled meeting.3 Recurring meeting with no fixed time.8 Recurring meeting with fixed time. |
start_time | Meeting start time. We support two formats for start_time local time and GMT. To set time as GMT the format should be yyyyMMddTHH:mm:ssZ. Example: "20200331T12:02:00Z"To set time using a specific timezone, use yyyyMMddTHH:mm:ss format and specify the timezone ID https://marketplace.zoom.us/docs/apireference/otherreferences/abbreviationlists#timezones 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. |
duration | Meeting duration minutes . Used for scheduled meetings only. |
schedule_for | 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. |
timezone | Time zone to format start_time. For example, "America/Los_Angeles". For scheduled meetings only. Please reference our time zone https://marketplace.zoom.us/docs/apireference/otherreferences/abbreviationlists#timezones list for supported time zones and their formats. |
password | Passcode to join the meeting. By default, passcode may only contain the following characters: az AZ 09 @ _ * and can have a maximum of 10 characters.**Note:** If the account owner or the admin has configured minimum passcode requirement settings https://support.zoom.us/hc/enus/articles/360033559832Meetingandwebinarpasswords#h_a427384be3834f80864d794bf0a37604 , 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 https://marketplace.zoom.us/docs/apireference/zoomapi/users/usersettings or the Get Account Settings https://marketplace.zoom.us/docs/apireference/zoomapi/accounts/accountsettings API. |
agenda | Meeting description. |
tracking_fields | Tracking fields |
recurrence | Recurrence object. Use this object only for a meeting with type 8 i.e., a recurring meeting with fixed time. |
settings | Meeting settings. |
return_response | Whether to return the response instead of the response content. Defaults to FALSE. |