post

/users/{userId}/meetings

Create a meeting for a user.

The start_url of a meeting is a URL using which a host or an alternative host can start a meeting. The expiration time for the start_url field is two hours for all regular users.

For users created using the custCreate option via the Create Users API, the expiration time of the start_url field is 90 days.

For security reasons, the recommended way to retrieve the updated value for the start_url field programmatically (after expiry) is by calling the Retrieve a Meeting API and referring to the value of the start_url field in the response.

Scopes: meeting:write:admin meeting:write

Authorization

oauth2 - authorizationCode

Request Parameters

1 Path Parameter

Request Body

Meeting object.

1 Example

Schema

object

Base object for sessions.

schedule_for

string

Email or userId if you want to schedule meeting for another user.

topic

string

Meeting topic.

type

integer

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

3 validations

start_time

string

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.

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.

1 validation

duration

integer

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

timezone

string

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.

password

string

Password to join the meeting. Password may only contain the following characters: [a-z A-Z 0-9 @ - _ *]. Max of 10 characters.

1 validation

agenda

string

Meeting description.

tracking_fields

array[object]

Tracking fields

recurrence

object

Recurrence object.

settings

object

Meeting settings.

Responses

HTTP Status Code: 201
Meeting created.

1 Header

1 Example

Schema

object

Meeting object

uuid

string

Unique meeting ID. Each meeting instance will generate its own Meeting UUID.

integer

Meeting ID: also known as the meeting number.

host_id

string

ID of the user who is set as host of meeting.

topic

string

Meeting topic

type

integer

Meeting Type

3 validations

start_time

string

Meeting start time

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

Start url

join_url

string

Join url

password

string

Meeting password. Password may only contain the following characters: [a-z A-Z 0-9 @ - _ * !]

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.

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