Introduction
Using Zoom APIs
Pagination
Error Definitions
Rate Limits
Testing Zoom APIs with Postman
Phone
Phone Auto Receptionists
Phone Blocked List
Phone Call Queues
Phone Devices
Phone Reports
Phone Shared Line Groups
Phone Site
Common Area Phones
SMS
Provider Exchange
Archiving Events
Account Events
App Events
Billing Events
Chat Message Events
Chat Channel Events
Chatbot Events
Meeting Events
Phone Events
Recording Events
TSP Events
User Events
Webinar Events
Zoom Room Events
Deprecated API Endpoints
post

/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_url value is the URL a host or an alternative host can use to start a meeting. The expiration time for the start_url value is two hours for all regular users.
  • For custCreate meeting hosts (users created with the custCreate parameter via the Create Users API), the expiration time of the start_url parameter is 90 days from the generation of the start_url.

Note:

  • For security reasons, the recommended way to programmatically (after expiry) get the updated start_url value is to call the Retrieve a Meeting API. Refer to the start_url value in the response.
  • This API has a daily rate limit of 100 requests per day. The rate limit is applied against the userId of the meeting host used to make the request.

Scopes: meeting:write:admin, meeting:write

Rate Limit Label: Medium

Authorization

oauth2 - authorizationCode

Request Parameters

1 Path Parameter

Request Body

Meeting object.

1 Example
Schema
object

The base meeting object.

topic
string

The meeting’s topic.

type
integer

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.
3 validations
pre_schedule
boolean

Whether to create a prescheduled meeting. This field only supports schedule meetings (2):

  • true — Create a prescheduled meeting.
  • false — Create a regular meeting.
1 validation
start_time
string

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:ssZ date-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:ss date-time format and specify the timezone ID in the timezone field. If you do not specify a timezone, the timezone value defaults to your Zoom account’s timezone. You can also use UTC for the timezone value.
1 validation
duration
integer

The meeting’s scheduled duration, in minutes. This field is only used for scheduled meetings (2).

schedule_for
string

The email address or user ID of the user to schedule a meeting for.

timezone
string

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.

password
string

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.

1 validation
default_password
boolean

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.

1 validation
agenda
string

The meeting’s agenda. This value has a maximum length of 2,000 characters.

1 validation
tracking_fields
array[object]

Information about the meeting’s tracking fields.

recurrence
object

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

settings
object

Information about the meeting’s settings.

template_id
string

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.

1 Header
1 Example
Schema
object

Meeting object

id
integer

Meeting ID: Unique identifier of the meeting in “long” format(represented as int64 data type in JSON), also known as the meeting number.

1 validation
assistant_id
string

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.

host_email
string

Email address of the meeting host.

1 validation
registration_url
string

URL using which registrants can register for a meeting. This field is only returned for meetings that have enabled registration.

topic
string

Meeting topic

1 validation
type
integer

Meeting Type

3 validations
pre_schedule
boolean

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.
1 validation
start_time
string

Meeting start date-time in UTC/GMT. Example: “2020-03-31T12:02:00Z”

1 validation
duration
integer

Meeting duration.

timezone
string

Timezone to format start_time

created_at
string

The date and time at which this meeting was created.

1 validation
agenda
string

Agenda

start_url
string

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.

join_url
string

URL for participants to join the meeting. This URL should only be shared with users that you would like to invite for the meeting.

password
string

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.

h323_password
string

H.323/SIP room system password

pmi
integer

Personal Meeting Id. Only used for scheduled meetings and recurring meetings with no fixed time.

1 validation
tracking_fields
array[object]

Tracking fields

occurrences
array[object]

Array of occurrence objects.

settings
object

Meeting settings.

recurrence
object

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

Send a Test Request

Send requests directly from the browser (CORS must be enabled)
Path Params
1 path param not set
userId
$$.env
1 variable not set
oauth_access_token