External DocumentationTo learn more, visit the Zoom documentation.
Parameters
| Parameter | Description |
|---|---|
| Agenda | The meeting’s agenda. This value has a maximum length of 2,000 characters. |
| Recurrence End Date Time | The final date the meeting recurs before it is cancelled. Can not be used with Recurrence End Times. |
| Recurrence End Times | The number of times the meeting recurs before it is cancelled. Can not be used with Recurrence End Date Time. Value can range between 1 and 60. |
| Recurrence Monthly Day | The day of the month the meeting recurs on. Can not be used with Recurrence End Times and Recurrence Monthly Week and Recurrence Monthly Week Day. Value can range between 1 and 31. To ensure a meeting recurs every month set Recurrence Repeat Interval to 1. To ensure it is recurring every 2 months set Recurrence Repeat Interval to 2. |
| Recurrence Monthly Week | The week of the month the meeting recurs on. To use this field you must set Recurrence Monthly Week Day. |
| Recurrence Monthly Week Day | The day of the week the meeting recurs on. To use this field you must set Recurrence Monthly Week. |
| Recurrence Repeat Interval | The interval between recurring meetings. For example, If a meeting is recurring every 2 months/weeks/days set this value to 2.For a daily meeting, the maximum number of recurrences is 99 days. For a weekly meeting, the maximum is 50 weeks. For a monthly meeting, the maximum is 10 months. |
| Recurrence Type | The recurrence meeting type. |
| Recurrence Weekly Days | The day of the week the meeting recurs on. |
| Schedule For | The email address or user ID of the user to schedule a meeting for. |
| Start Time | 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. |
| Topic | The meeting’s topic. |
| Type | The meeting type. Note: * Instant Meetings are created and start immediately. They are not saved to your Zoom calendar, the meeting joining link is returned under the join_url response field.* Scheduled Meetings are planned for a specific date and time. A single event is created and added to your Zoom calendar.* Recurring Meetings are a series of meetings that added to your Zoom calendar. You can adjust the recurrence parameters and determine the recurrence pattern. |
| User ID | The user ID or email address of the user. For user-level apps, pass the me value. |
Example Output
{
"uuid": "<string>",
"id": 120486766960,
"host_id": "<string>",
"host_email": "<string>",
"topic": "<string>",
"type": 3,
"status": "<string>",
"start_time": "2020-04-01T16:47:52Z",
"duration": 79,
"timezone": "<string>",
"created_at": "2020-04-01T16:47:52Z",
"start_url": "<string>",
"join_url": "<string>",
"password": "<string>",
"h323_password": "<string>",
"pstn_password": "<string>",
"encrypted_password": "<string>",
"settings": {
"host_video": false,
"participant_video": false,
"cn_meeting": false,
"in_meeting": false,
"join_before_host": false,
"jbh_time": 2,
"mute_upon_entry": false,
"watermark": false,
"use_pmi": false,
"approval_type": 3,
"audio": "<string>",
"auto_recording": "<string>",
"enforce_login": false,
"enforce_login_domains": "<string>",
"alternative_hosts": "<string>",
"alternative_host_update_polls": false,
"close_registration": false,
"show_share_button": false,
"allow_multiple_devices": false,
"registrants_confirmation_email": true,
"waiting_room": false,
"request_permission_to_unmute_participants": false,
"global_dial_in_countries": [
"<string>"
],
"global_dial_in_numbers": [
{
"country_name": "<string>",
"number": "<string>",
"type": "<string>",
"country": "<string>"
},
{
"country_name": "<string>",
"city": "<string>",
"number": "<string>",
"type": "<string>",
"country": "<string>"
}
],
"registrants_email_notification": true,
"meeting_authentication": false,
"encryption_type": "<string>",
"approved_or_denied_countries_or_regions": {
"enable": false
},
"question_and_answer": {
"enable": false
},
"breakout_room": {
"enable": false
},
"internal_meeting": false,
"continuous_meeting_chat": {
"enable": true,
"auto_add_invited_external_users": false,
"auto_add_meeting_participants": false,
"channel_id": "<string>"
},
"participant_focused_meeting": false,
"push_change_to_calendar": false,
"resources": [],
"auto_start_meeting_summary": false,
"auto_start_ai_companion_questions": false,
"allow_host_control_participant_mute_state": false,
"alternative_hosts_email_notification": true,
"show_join_info": false,
"device_testing": false,
"focus_mode": false,
"meeting_invitees": [],
"private_meeting": false,
"email_notification": true,
"host_save_video_order": false,
"sign_language_interpretation": {
"enable": false
},
"email_in_attendee_report": false
},
"creation_source": "<string>",
"pre_schedule": false
}