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

Request Body

{"agenda"=>"<string>", "default_password"=>false, "duration"=>"<integer>", "password"=>"<string>", "pre_schedule"=>false, "recurrence"=>{"type"=>2, "end_date_time"=>"<dateTime>", "end_times"=>1, "monthly_day"=>1, "monthly_week"=>1, "monthly_week_day"=>6, "repeat_interval"=>"<integer>", "weekly_days"=>"1"}, "schedule_for"=>"<string>", "settings"=>{"additional_data_center_regions"=>["<string>", "<string>"], "allow_multiple_devices"=>"<boolean>", "alternative_hosts"=>"<string>", "alternative_hosts_email_notification"=>true, "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>"}, {"email"=>"<email>", "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"=>2, "close_registration"=>false, "cn_meeting"=>false, "contact_email"=>"<string>", "contact_name"=>"<string>", "email_notification"=>true, "encryption_type"=>"enhanced_encryption", "focus_mode"=>"<boolean>", "global_dial_in_countries"=>["<string>", "<string>"], "host_video"=>"<boolean>", "in_meeting"=>false, "jbh_time"=>10, "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>", "meeting_invitees"=>[{"email"=>"<email>"}, {"email"=>"<email>"}], "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"=>"<boolean>", "watermark"=>false, "host_save_video_order"=>"<boolean>", "alternative_host_update_polls"=>"<boolean>", "internal_meeting"=>false, "continuous_meeting_chat"=>{"enable"=>"<boolean>", "auto_add_invited_external_users"=>"<boolean>"}, "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>", "template_id"=>"<string>", "timezone"=>"<string>", "topic"=>"<string>", "tracking_fields"=>[{"field"=>"<string>", "value"=>"<string>"}, {"field"=>"<string>", "value"=>"<string>"}], "type"=>2}

HEADERS

RESPONSES

status: Created

{"assistant_id":"\u003cstring\u003e","host_email":"\u003cemail\u003e","id":"\u003clong\u003e","registration_url":"\u003cstring\u003e","agenda":"\u003cstring\u003e","created_at":"\u003cdateTime\u003e","duration":"\u003cinteger\u003e","h323_password":"\u003cstring\u003e","join_url":"\u003cstring\u003e","chat_join_url":"\u003cstring\u003e","occurrences":[{"duration":"\u003cinteger\u003e","occurrence_id":"\u003cstring\u003e","start_time":"\u003cdateTime\u003e","status":"deleted"},{"duration":"\u003cinteger\u003e","occurrence_id":"\u003cstring\u003e","start_time":"\u003cdateTime\u003e","status":"available"}],"password":"\u003cstring\u003e","pmi":"\u003cstring\u003e","pre_schedule":false,"recurrence":{"type":1,"end_date_time":"\u003cdateTime\u003e","end_times":1,"monthly_day":1,"monthly_week":4,"monthly_week_day":4,"repeat_interval":"\u003cinteger\u003e","weekly_days":"1"},"settings":{"allow_multiple_devices":"\u003cboolean\u003e","alternative_hosts":"\u003cstring\u003e","alternative_hosts_email_notification":true,"alternative_host_update_polls":"\u003cboolean\u003e","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","join_url":"\u003cstring\u003e"},{"email":"\u003cemail\u003e","name":"\u003cstring\u003e","join_url":"\u003cstring\u003e"}],"authentication_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":1,"close_registration":false,"cn_meeting":false,"contact_email":"\u003cstring\u003e","contact_name":"\u003cstring\u003e","custom_keys":[{"key":"\u003cstring\u003e","value":"\u003cstring\u003e"},{"key":"\u003cstring\u003e","value":"\u003cstring\u003e"}],"email_notification":true,"encryption_type":"enhanced_encryption","enforce_login":"\u003cboolean\u003e","enforce_login_domains":"\u003cstring\u003e","focus_mode":"\u003cboolean\u003e","global_dial_in_countries":["\u003cstring\u003e","\u003cstring\u003e"],"global_dial_in_numbers":[{"city":"\u003cstring\u003e","country":"\u003cstring\u003e","country_name":"\u003cstring\u003e","number":"\u003cstring\u003e","type":"tollfree"},{"city":"\u003cstring\u003e","country":"\u003cstring\u003e","country_name":"\u003cstring\u003e","number":"\u003cstring\u003e","type":"toll"}],"host_video":"\u003cboolean\u003e","in_meeting":false,"jbh_time":0,"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","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":false,"watermark":false,"host_save_video_order":"\u003cboolean\u003e","internal_meeting":false,"continuous_meeting_chat":{"enable":"\u003cboolean\u003e","auto_add_invited_external_users":"\u003cboolean\u003e","channel_id":"\u003cstring\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","start_url":"\u003cstring\u003e","timezone":"\u003cstring\u003e","topic":"\u003cstring\u003e","tracking_fields":[{"field":"\u003cstring\u003e","value":"\u003cstring\u003e","visible":"\u003cboolean\u003e"},{"field":"\u003cstring\u003e","value":"\u003cstring\u003e","visible":"\u003cboolean\u003e"}],"type":2}