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.

​
Parameters

ParameterDescription
AgendaThe meeting’s agenda. This value has a maximum length of 2,000 characters.
Schedule ForThe email address or user ID of the user to schedule a meeting for.
Start TimeThe 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.
TopicThe meeting’s topic.
User IDThe 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
}

​
Workflow Library Example

Setting Up an Incident Process

Preview this Workflow on desktop

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.

​
Parameters

ParameterDescription
AgendaThe meeting’s agenda. This value has a maximum length of 2,000 characters.
Schedule ForThe email address or user ID of the user to schedule a meeting for.
Start TimeThe 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.
TopicThe meeting’s topic.
User IDThe 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
}

​
Workflow Library Example

Setting Up an Incident Process

Preview this Workflow on desktop