• 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:writeRate 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. | | Topic | The meeting’s topic. | | User ID | The user ID or email address of the user. For user-level apps, pass the me value. |

​
Example Output​

{    "agenda": "My Meeting",    "assistant_id": "kFFvsJc-Q1OSxaJQLvaa_A",    "created_at": "2022-03-25T07:29:29Z",    "duration": 60,    "h323_password": "123456",    "host_email": "jchill@example.com",    "id": 92674392836,    "join_url": "https://example.com/j/11111",    "occurrences": [        {            "duration": 60,            "occurrence_id": "1648194360000",            "start_time": "2022-03-25T07:46:00Z",            "status": "available"        }    ],    "password": "123456",    "pmi": 97891943927,    "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"    },    "registration_url": "https://example.com/meeting/register/7ksAkRCoEpt1Jm0wa-E6lICLur9e7Lde5oW6",    "settings": {        "allow_multiple_devices": true,        "alternative_host_update_polls": true,        "alternative_hosts": "jchill@example.com;thill@example.com",        "alternative_hosts_email_notification": true,        "approval_type": 0,        "approved_or_denied_countries_or_regions": {            "approved_list": [                "CX"            ],            "denied_list": [                "CA"            ],            "enable": true,            "method": "approve"        },        "audio": "telephony",        "authentication_domains": "example.com",        "authentication_exception": [            {                "email": "jchill@example.com",                "join_url": "https://example.com/s/11111",                "name": "Jill Chill"            }        ],        "authentication_name": "Sign in to Zoom",        "authentication_option": "signIn_D8cJuqWVQ623CI4Q8yQK0Q",        "auto_recording": "cloud",        "breakout_room": {            "enable": true,            "rooms": [                {                    "name": "room1",                    "participants": [                        "jchill@example.com"                    ]                }            ]        },        "calendar_type": 1,        "close_registration": false,        "cn_meeting": false,        "contact_email": "jchill@example.com",        "contact_name": "Jill Chill",        "custom_keys": [            {                "key": "key1",                "value": "value1"            }        ],        "email_notification": true,        "encryption_type": "enhanced_encryption",        "enforce_login": true,        "enforce_login_domains": "example.com",        "focus_mode": true,        "global_dial_in_countries": [            "US"        ],        "global_dial_in_numbers": [            {                "city": "New York",                "country": "US",                "country_name": "US",                "number": "+1 1000200200",                "type": "toll"            }        ],        "host_video": true,        "in_meeting": false,        "jbh_time": 0,        "join_before_host": true,        "language_interpretation": {            "enable": true,            "interpreters": [                {                    "email": "interpreter@example.com",                    "languages": "US,FR"                }            ]        },        "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        }    ],    "type": 2}

​
Workflow Library Example​

Setting Up an Incident Process

Preview this Workflow on desktop

Was this page helpful?

Add Members To GroupCreate User