Logo
Zoom Public API Documentation

Create a meeting

POST {{baseUrl}}/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 Get a meeting API. Refer to the start_url value in the response.

Scopes: meeting:write:admin, meeting:write

Rate Limit Label: Medium
* 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.

 

Body PARAM

Key Datatype Required Description 



HEADERS

Key Datatype Required Description 
Content-Type
string
Accept
string




RESPONSES

status Created

{ "assistant_id": "kFFvsJc-Q1OSxaJQLvaa_A", "host_email": "jchill@example.com", "id": 92674392836, "registration_url": "https://example.com/meeting/register/7ksAkRCoEpt1Jm0wa-E6lICLur9e7Lde5oW6", "agenda": "My Meeting", "created_at": "2022-03-25T07:29:29Z", "duration": 60, "h323_password": "123456", "join_url": "https://example.com/j/11111", "occurrences": [ { "value": "<Error: Too many levels of nesting to fake this schema>" }, { "value": "<Error: Too many levels of nesting to fake this schema>" } ], "password": "123456", "pmi": 97891943927, "pre_schedule": false, "recurrence": { "type": 1, "end_date_time": "2022-04-02T15:59:00Z", "end_times": 7, "monthly_day": 1, "monthly_week": 1, "monthly_week_day": 1, "repeat_interval": 1, "weekly_days": "1" }, "settings": { "allow_multiple_devices": true, "alternative_hosts": "jchill@example.com;thill@example.com", "alternative_hosts_email_notification": true, "alternative_host_update_polls": true, "approval_type": 0, "approved_or_denied_countries_or_regions": { "approved_list": { "value": "<Error: Too many levels of nesting to fake this schema>" }, "denied_list": { "value": "<Error: Too many levels of nesting to fake this schema>" }, "enable": { "value": "<Error: Too many levels of nesting to fake this schema>" }, "method": { "value": "<Error: Too many levels of nesting to fake this schema>" } }, "audio": "telephony", "authentication_domains": "example.com", "authentication_exception": [ { "value": "<Error: Too many levels of nesting to fake this schema>" }, { "value": "<Error: Too many levels of nesting to fake this schema>" } ], "authentication_name": "Sign in to Zoom", "authentication_option": "signIn_D8cJuqWVQ623CI4Q8yQK0Q", "auto_recording": "cloud", "breakout_room": { "enable": { "value": "<Error: Too many levels of nesting to fake this schema>" }, "rooms": { "value": "<Error: Too many levels of nesting to fake this schema>" } }, "calendar_type": 1, "close_registration": false, "cn_meeting": false, "contact_email": "jchill@example.com", "contact_name": "Jill Chill", "custom_keys": [ { "value": "<Error: Too many levels of nesting to fake this schema>" }, { "value": "<Error: Too many levels of nesting to fake this schema>" } ], "email_notification": true, "encryption_type": "enhanced_encryption", "enforce_login": true, "enforce_login_domains": "example.com", "focus_mode": true, "global_dial_in_countries": [ { "value": "<Error: Too many levels of nesting to fake this schema>" }, { "value": "<Error: Too many levels of nesting to fake this schema>" } ], "global_dial_in_numbers": [ { "value": "<Error: Too many levels of nesting to fake this schema>" }, { "value": "<Error: Too many levels of nesting to fake this schema>" } ], "host_video": true, "in_meeting": false, "jbh_time": 0, "join_before_host": true, "language_interpretation": { "enable": { "value": "<Error: Too many levels of nesting to fake this schema>" }, "interpreters": { "value": "<Error: Too many levels of nesting to fake this schema>" } }, "meeting_authentication": true, "mute_upon_entry": false, "participant_video": false, "private_meeting": false, "registrants_confirmation_email": true, "registrants_email_notification": true, "registration_type": 1, "show_share_button": true, "use_pmi": false, "waiting_room": false, "watermark": false }, "start_time": "2022-03-25T07:29:29Z", "start_url": "https://example.com/s/11111", "timezone": "America/Los_Angeles", "topic": "My Meeting", "tracking_fields": [ { "field": "field1", "value": "value1", "visible": true }, { "field": "field1", "value": "value1", "visible": true } ], "type": 2 }



Curl
curl -X POST 'https://api.zoom.us/v2/users/:userId/meetings' -H 'Content-Type: application/json' -H 'Accept: application/json' -d '{"agenda":"My Meeting","default_password":false,"duration":60,"password":"123456","pre_schedule":false,"recurrence":{"end_date_time":"2022-04-02T15:59:00Z","end_times":7,"monthly_day":1,"monthly_week":1,"monthly_week_day":1,"repeat_interval":1,"type":1,"weekly_days":"1"},"schedule_for":"jchill@example.com","settings":{"additional_data_center_regions":["TY"],"allow_multiple_devices":true,"alternative_hosts":"jchill@example.com;thill@example.com","alternative_hosts_email_notification":true,"approval_type":2,"approved_or_denied_countries_or_regions":{"approved_list":["CX"],"denied_list":["CA"],"enable":true,"method":"approve"},"audio":"telephony","audio_conference_info":"test","authentication_domains":"example.com","authentication_exception":[{"email":"jchill@example.com","name":"Jill Chill"}],"authentication_option":"signIn_D8cJuqWVQ623CI4Q8yQK0Q","auto_recording":"cloud","breakout_room":{"enable":true,"rooms":[{"name":"room1","participants":["jchill@example.com"]}]},"calendar_type":1,"close_registration":false,"contact_email":"jchill@example.com","contact_name":"Jill Chill","email_notification":true,"encryption_type":"enhanced_encryption","focus_mode":true,"global_dial_in_countries":["US"],"host_video":true,"jbh_time":0,"join_before_host":false,"language_interpretation":{"enable":true,"interpreters":[{"email":"interpreter@example.com","languages":"US,FR"}]},"meeting_authentication":true,"meeting_invitees":[{"email":"jchill@example.com"}],"mute_upon_entry":false,"participant_video":false,"private_meeting":false,"registrants_confirmation_email":true,"registrants_email_notification":true,"registration_type":1,"show_share_button":true,"use_pmi":false,"waiting_room":false,"watermark":false,"host_save_video_order":true,"alternative_host_update_polls":true},"start_time":"2022-03-25T07:32:55Z","template_id":"Dv4YdINdTk+Z5RToadh5ug==","timezone":"America/Los_Angeles","topic":"My Meeting","tracking_fields":[{"field":"field1","value":"value1"}],"type":2}'

ENDPOINTS