Logo
Zoom Public API Documentation

Create a meeting

POST {{baseUrl}}/users/:userId/meetings

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 get the updated start_url value after expiry is to call the Get a meeting API. Refer to the start_url value in the response.

100 requests per day. The rate limit is applied against the userId of the meeting host used to make the request.

Scopes: meeting:write,meeting:write:admin

Rate Limit Label: MEDIUM

 

Body PARAM

Key Datatype Required Description 



HEADERS

Key Datatype Required Description 
Content-Type
string
Accept
string




RESPONSES

status Created

{ "assistant_id": "<string>", "host_email": "<email>", "id": "<long>", "registration_url": "<string>", "agenda": "<string>", "created_at": "<dateTime>", "duration": "<integer>", "h323_password": "<string>", "join_url": "<string>", "chat_join_url": "<string>", "occurrences": [ { "duration": "<integer>", "occurrence_id": "<string>", "start_time": "<dateTime>", "status": "deleted" }, { "duration": "<integer>", "occurrence_id": "<string>", "start_time": "<dateTime>", "status": "available" } ], "password": "<string>", "pmi": "<string>", "pre_schedule": false, "recurrence": { "type": 1, "end_date_time": "<dateTime>", "end_times": 1, "monthly_day": 1, "monthly_week": 4, "monthly_week_day": 4, "repeat_interval": "<integer>", "weekly_days": "1" }, "settings": { "allow_multiple_devices": "<boolean>", "alternative_hosts": "<string>", "alternative_hosts_email_notification": true, "alternative_host_update_polls": "<boolean>", "approval_type": 2, "approved_or_denied_countries_or_regions": { "approved_list": [ "<string>", "<string>" ], "denied_list": [ "<string>", "<string>" ], "enable": "<boolean>", "method": "deny" }, "audio": "both", "audio_conference_info": "<string>", "authentication_domains": "<string>", "authentication_exception": [ { "email": "<email>", "name": "<string>", "join_url": "<string>" }, { "email": "<email>", "name": "<string>", "join_url": "<string>" } ], "authentication_name": "<string>", "authentication_option": "<string>", "auto_recording": "none", "breakout_room": { "enable": "<boolean>", "rooms": [ { "name": "<string>", "participants": [ "<string>", "<string>" ] }, { "name": "<string>", "participants": [ "<string>", "<string>" ] } ] }, "calendar_type": 1, "close_registration": false, "cn_meeting": false, "contact_email": "<string>", "contact_name": "<string>", "custom_keys": [ { "key": "<string>", "value": "<string>" }, { "key": "<string>", "value": "<string>" } ], "email_notification": true, "encryption_type": "enhanced_encryption", "enforce_login": "<boolean>", "enforce_login_domains": "<string>", "focus_mode": "<boolean>", "global_dial_in_countries": [ "<string>", "<string>" ], "global_dial_in_numbers": [ { "city": "<string>", "country": "<string>", "country_name": "<string>", "number": "<string>", "type": "tollfree" }, { "city": "<string>", "country": "<string>", "country_name": "<string>", "number": "<string>", "type": "toll" } ], "host_video": "<boolean>", "in_meeting": false, "jbh_time": 0, "join_before_host": false, "language_interpretation": { "enable": "<boolean>", "interpreters": [ { "email": "<email>", "languages": "<string>" }, { "email": "<email>", "languages": "<string>" } ] }, "sign_language_interpretation": { "enable": "<boolean>", "interpreters": [ { "email": "<email>", "sign_language": "<string>" }, { "email": "<email>", "sign_language": "<string>" } ] }, "meeting_authentication": "<boolean>", "mute_upon_entry": false, "participant_video": "<boolean>", "private_meeting": "<boolean>", "registrants_confirmation_email": "<boolean>", "registrants_email_notification": "<boolean>", "registration_type": 1, "show_share_button": "<boolean>", "use_pmi": false, "waiting_room": false, "watermark": false, "host_save_video_order": "<boolean>", "internal_meeting": false, "continuous_meeting_chat": { "enable": "<boolean>", "auto_add_invited_external_users": "<boolean>", "channel_id": "<string>" }, "participant_focused_meeting": false, "push_change_to_calendar": false, "resources": [ { "resource_type": "whiteboard", "resource_id": "<string>", "permission_level": "editor" }, { "resource_type": "whiteboard", "resource_id": "<string>", "permission_level": "editor" } ], "auto_start_meeting_summary": false, "auto_start_ai_companion_questions": false }, "start_time": "<dateTime>", "start_url": "<string>", "timezone": "<string>", "topic": "<string>", "tracking_fields": [ { "field": "<string>", "value": "<string>", "visible": "<boolean>" }, { "field": "<string>", "value": "<string>", "visible": "<boolean>" } ], "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":"\u003cstring\u003e","default_password":false,"duration":"\u003cinteger\u003e","password":"\u003cstring\u003e","pre_schedule":false,"recurrence":{"type":2,"end_date_time":"\u003cdateTime\u003e","end_times":1,"monthly_day":1,"monthly_week":1,"monthly_week_day":6,"repeat_interval":"\u003cinteger\u003e","weekly_days":"1"},"schedule_for":"\u003cstring\u003e","settings":{"additional_data_center_regions":["\u003cstring\u003e","\u003cstring\u003e"],"allow_multiple_devices":"\u003cboolean\u003e","alternative_hosts":"\u003cstring\u003e","alternative_hosts_email_notification":true,"approval_type":2,"approved_or_denied_countries_or_regions":{"approved_list":["\u003cstring\u003e","\u003cstring\u003e"],"denied_list":["\u003cstring\u003e","\u003cstring\u003e"],"enable":"\u003cboolean\u003e","method":"deny"},"audio":"both","audio_conference_info":"\u003cstring\u003e","authentication_domains":"\u003cstring\u003e","authentication_exception":[{"email":"\u003cemail\u003e","name":"\u003cstring\u003e"},{"email":"\u003cemail\u003e","name":"\u003cstring\u003e"}],"authentication_option":"\u003cstring\u003e","auto_recording":"none","breakout_room":{"enable":"\u003cboolean\u003e","rooms":[{"name":"\u003cstring\u003e","participants":["\u003cstring\u003e","\u003cstring\u003e"]},{"name":"\u003cstring\u003e","participants":["\u003cstring\u003e","\u003cstring\u003e"]}]},"calendar_type":2,"close_registration":false,"cn_meeting":false,"contact_email":"\u003cstring\u003e","contact_name":"\u003cstring\u003e","email_notification":true,"encryption_type":"enhanced_encryption","focus_mode":"\u003cboolean\u003e","global_dial_in_countries":["\u003cstring\u003e","\u003cstring\u003e"],"host_video":"\u003cboolean\u003e","in_meeting":false,"jbh_time":10,"join_before_host":false,"language_interpretation":{"enable":"\u003cboolean\u003e","interpreters":[{"email":"\u003cemail\u003e","languages":"\u003cstring\u003e"},{"email":"\u003cemail\u003e","languages":"\u003cstring\u003e"}]},"sign_language_interpretation":{"enable":"\u003cboolean\u003e","interpreters":[{"email":"\u003cemail\u003e","sign_language":"\u003cstring\u003e"},{"email":"\u003cemail\u003e","sign_language":"\u003cstring\u003e"}]},"meeting_authentication":"\u003cboolean\u003e","meeting_invitees":[{"email":"\u003cemail\u003e"},{"email":"\u003cemail\u003e"}],"mute_upon_entry":false,"participant_video":"\u003cboolean\u003e","private_meeting":"\u003cboolean\u003e","registrants_confirmation_email":"\u003cboolean\u003e","registrants_email_notification":"\u003cboolean\u003e","registration_type":1,"show_share_button":"\u003cboolean\u003e","use_pmi":false,"waiting_room":"\u003cboolean\u003e","watermark":false,"host_save_video_order":"\u003cboolean\u003e","alternative_host_update_polls":"\u003cboolean\u003e","internal_meeting":false,"continuous_meeting_chat":{"enable":"\u003cboolean\u003e","auto_add_invited_external_users":"\u003cboolean\u003e"},"participant_focused_meeting":false,"push_change_to_calendar":false,"resources":[{"resource_type":"whiteboard","resource_id":"\u003cstring\u003e","permission_level":"editor"},{"resource_type":"whiteboard","resource_id":"\u003cstring\u003e","permission_level":"editor"}],"auto_start_meeting_summary":false,"auto_start_ai_companion_questions":false},"start_time":"\u003cdateTime\u003e","template_id":"\u003cstring\u003e","timezone":"\u003cstring\u003e","topic":"\u003cstring\u003e","tracking_fields":[{"field":"\u003cstring\u003e","value":"\u003cstring\u003e"},{"field":"\u003cstring\u003e","value":"\u003cstring\u003e"}],"type":2}'

ENDPOINTS