Update a Meeting
The PUT method is still supported and behaves the same as before, will be deprecated in the future. Use the PATCH method instead.
Updates details for a meeting with a specified meeting ID. This operation applies to meeting series and scheduled meetings. It doesn't apply to ended or in-progress meeting instances. Ad-hoc meetings created by Create a Meeting with adhoc of true and a roomId cannot be updated.
If the
meetingIdvalue specified is for a scheduled meeting, the operation updates that scheduled meeting without impact on other scheduled meeting of the parent meeting series.If the
meetingIdvalue specified is for a meeting series, the operation updates the entire meeting series. Note: If the value ofstart,end, orrecurrencefor the meeting series is changed, any exceptional scheduled meeting in this series is cancelled when the meeting series is updated.If the parameter
recurrencehas a value, a recurring meeting is created based on the rule defined by the value ofrecurrence. For a non-recurring meeting which has norecurrencevalue set, itsmeetingTypeis alsomeetingSerieswhich is a meeting series with only one occurrence in Webex meeting modeling. If you specify arecurrencelikeFREQ=DAILY;INTERVAL=1which never ends, the furthest date of the series is unlimited. You can also specify arecurrencewith a very distant ending date in the future, e.g.FREQ=DAILY;INTERVAL=1;UNTIL=21241001T000000Z, but the actual furthest date accepted for the recurring meeting is five years from now. Specifically, if it has an ending date, there can be up to 5 occurrences for a yearly meeting, 60 occurrences for a monthly meeting, 261 occurrences for a weekly meeting, or 1826 occurrences for a daily meeting.
URI Parameters
Unique identifier for the meeting to be updated. This parameter applies to meeting series and scheduled meetings. It doesn't apply to ended or in-progress meeting instances. Please note that currently meeting ID of a scheduled personal room meeting is not supported for this API.
Body Parameters
Meeting title. The title can be a maximum of 128 characters long.
Meeting agenda. The agenda can be a maximum of 1300 characters long.
Meeting password. Must conform to the site's password complexity settings. Read password management for details.
Date and time for the start of meeting in any ISO 8601 compliant format. start cannot be before current date and time or after end. Duration between start and end cannot be shorter than 10 minutes or longer than 23 hours 59 minutes. Refer to the Webex Meetings guide for more information about restrictions on updating date and time for a meeting. Please note that when a meeting is being updated, start of the meeting will be accurate to minutes, not seconds or milliseconds. Therefore, if start is within the same minute as the current time, start will be adjusted to the upcoming minute; otherwise, start will be adjusted with seconds and milliseconds stripped off. For instance, if the current time is 2022-03-01T10:32:16.657+08:00, start of 2022-03-01T10:32:28.076+08:00 or 2022-03-01T10:32:41+08:00 will be adjusted to 2022-03-01T10:33:00+08:00, and start of 2022-03-01T11:32:28.076+08:00 or 2022-03-01T11:32:41+08:00 will be adjusted to 2022-03-01T11:32:00+08:00.
Date and time for the end of meeting in any ISO 8601 compliant format. end cannot be before current date and time or before start. Duration between start and end cannot be shorter than 10 minutes or longer than 23 hours 59 minutes. Refer to the Webex Meetings guide for more information about restrictions on updating date and time for a meeting. Please note that when a meeting is being updated, end of the meeting will be accurate to minutes, not seconds or milliseconds. Therefore, end will be adjusted with seconds and milliseconds stripped off. For instance, end of 2022-03-01T11:52:28.076+08:00 or 2022-03-01T11:52:41+08:00 will be adjusted to 2022-03-01T11:52:00+08:00.
Time zone in which the meeting was originally scheduled (conforming with the IANA time zone database).
Meeting series recurrence rule (conforming with RFC 2445). Applies only to a recurring meeting series, not to a meeting series with only one scheduled meeting. Multiple days or dates for monthly or yearly recurrence rule are not supported, only the first day or date specified is taken. For example, "FREQ=MONTHLY;INTERVAL=1;COUNT=10;BYMONTHDAY=10,11,12" is not supported and it will be partially supported as "FREQ=MONTHLY;INTERVAL=1;COUNT=10;BYMONTHDAY=10". If you specify a recurrence like FREQ=DAILY;INTERVAL=1 which never ends, the furthest date of the series is unlimited. You can also specify a recurrence with a very distant ending date in the future, e.g. FREQ=DAILY;INTERVAL=1;UNTIL=21241001T000000Z, but the actual furthest date accepted for the recurring meeting is five years from now. Specifically, if it has an ending date, there can be up to 5 occurrences for a yearly meeting, 60 occurrences for a monthly meeting, 261 occurrences for a weekly meeting, or 1826 occurrences for a daily meeting.
Whether or not meeting is recorded automatically.
Whether or not to allow any attendee with a host account on the target site to become a cohost when joining the meeting. The target site is specified by siteUrl parameter when creating the meeting; if not specified, it's user's preferred site.
Whether or not to allow any attendee to join the meeting before the host joins the meeting.
Whether or not to allow any attendee to connect audio in the meeting before the host joins the meeting. This attribute is only applicable if the enabledJoinBeforeHost attribute is set to true.
Number of minutes an attendee can join the meeting before the meeting start time and the host joins. Only applicable if the enabledJoinBeforeHost attribute is set to true. Valid options for a meeting are 0, 5, 10, and 15, and valid options for a webinar are 0, 15, 30, 45, and 60. The default is 0 if not specified.
Whether or not to exclude the meeting password from the email invitation.
Whether or not to allow the meeting to be listed on the public calendar.
The number of minutes before the meeting begins, that an email reminder is sent to the host.
Specifies how the people who aren't on the invite can join the unlocked meeting.
If the value of unlockedMeetingJoinSecurity attribute is allowJoin, people can join the unlocked meeting directly.
If the value of unlockedMeetingJoinSecurity attribute is allowJoinWithLobby, people will wait in the lobby until the host admits them.
If the value of unlockedMeetingJoinSecurity attribute is blockFromJoin, people can't join the unlocked meeting.
Unique identifier for a meeting session type for the user. This attribute is required while scheduling webinar meeting. All available meeting session types enabled for the user can be retrieved by List Meeting Session Types API.
Whether or not webcast view is enabled.
Password for panelists of a webinar meeting. Must conform to the site's password complexity settings. Read password management for details. If not specified, a random password conforming to the site's password rules will be generated automatically.
Whether or not to automatically lock the meeting after it starts.
The number of minutes after the meeting begins, for automatically locking it.
Whether or not to allow the first attendee of the meeting with a host account on the target site to become a cohost. The target site is specified by siteUrl parameter when creating the meeting; if not specified, it's user's preferred site.
Whether or not to allow authenticated video devices in the meeting's organization to start or join the meeting without a prompt.
Whether or not to send emails to host and invitees. It is an optional field and default value is true.
Email address for the meeting host. This attribute should only be set if the user or application calling the API has the admin-level scopes. When used, the admin may specify the email of a user in a site they manage to be the meeting host. The field is not editable and is only used to update a meeting on behalf of the real meeting host. Please use the Reassign Meetings to a New Host API if you need to update the meeting host.
Meeting Options.
Whether or not to allow any attendee to chat in the meeting. Also depends on the session type.
Whether or not to allow any attendee to have video in the meeting. Also depends on the session type.
Whether or not to allow any attendee to poll in the meeting. Can only be set true for a webinar. The value of this attribute depends on the session type for a meeting. Please contact your site admin if this attribute is not available. Not supported if the site has been migrated to the Webex Suite meeting platform.
Whether or not to allow any attendee to take notes in the meeting. The value of this attribute also depends on the session type. Not supported if the site has been migrated to the Webex Suite meeting platform.
Whether note taking is enabled. If the value of enabledNote is false, users cannot set this attribute and get the default value allowAll. Not supported if the site has been migrated to the Webex Suite meeting platform.
If the value of noteType attribute is allowAll, all participants can take notes.
If the value of noteType attribute is allowOne, only a single note taker is allowed.
Whether or not to allow any attendee to transfer files in the meeting. The value of this attribute also depends on the session type.
Whether or not to allow any attendee to share Universal Communications Format media files in the meeting. The value of this attribute also depends on the sessionType. Not supported if the site has been migrated to the Webex Suite meeting platform.
Attendee Privileges. This attribute is not supported for a webinar.
Whether or not to allow any attendee to share content in the meeting.
Whether or not to allow any attendee to save shared documents, slides, or whiteboards when they are shared as files in the content viewer instead of in a window or application.
Whether or not to allow any attendee to print shared documents, slides, or whiteboards when they are shared as files in the content viewer instead of in a window or application.
Whether or not to allow any attendee to annotate shared documents, slides, or whiteboards when they are shared as files in the content viewer instead of in a window or application.
Whether or not to allow any attendee to view participants.
Whether or not to allow any attendee to see a small preview image of any page of shared documents or slides when they are shared as files in the content viewer instead of in a window or application.
Whether or not to allow any attendee to control applications, web browsers, or desktops remotely.
Whether or not to allow any attendee to view any shared documents or slides when they are shared as files in the content viewer instead of in a window or application.
Whether or not to allow any attendee to scroll through any page of shared documents or slides when they are shared as files in the content viewer instead of in a window or application.
Whether or not to allow any attendee to contact the operator privately.
Whether or not to allow any attendee to chat with the host in private.
Whether or not to allow any attendee to chat with the presenter in private.
Whether or not to allow any attendee to chat with other participants in private.
External keys created by an integration application in its own domain, for example Zendesk ticket IDs, Jira IDs, Salesforce Opportunity IDs, etc. The integration application queries meetings by a key in its own domain. The maximum size of integrationTags is 3 and each item of integrationTags can be a maximum of 64 characters long. Please note that an empty or null integrationTags will delete all existing integration tags for the meeting implicitly. Developer can update integration tags for a meetingSeries but he cannot update it for a scheduledMeeting or a meeting instance.
Whether or not breakout sessions are enabled. If the value of enabledBreakoutSessions is false, users can not set breakout sessions. If the value of enabledBreakoutSessions is true, users can update breakout sessions using the Update Breakout Sessions API. Updating breakout sessions are not supported by this API.
Tracking codes information. All available tracking codes and their options for the specified site can be retrieved by List Meeting Tracking Codes API. If an optional tracking code is missing from the trackingCodes array and there's a default option for this tracking code, the default option is assigned automatically. If the inputMode of a tracking code is select, its value must be one of the site-level options or the user-level value. Tracking code is not supported for a personal room meeting or an ad-hoc space meeting.
Name of the tracking code. The name cannot be empty and the maximum size is 120 characters.
Value for the tracking code. value cannot be empty and the maximum size is 120 characters.
Whether or not the audio watermark is enabled. If it's true, scheduledType equals or defaults to meeting, and audioConnectionOptions.audioConnectionType equals VoIP, the audio for this meeting will have a watermark. In this case, a unique identifier is embedded into the audio that plays out of each Webex app and device. An administrator can use this watermark when analyzing an unauthorized recording to identify which Webex app or device was the source of the recording.
Whether or not the visual watermark is enabled. If it's true, the video for this meeting will have a watermark. In this case, Webex superimposes a watermark image pattern on top of the meeting video and shared content to deter participants from leaking meeting information. Each participant viewing the meeting sees a watermark image pattern with their email address. If the participant is not signed in, the watermark image pattern includes their display name and email address.
Opacity level for the visual watermark. The value must be between 5 and 80, inclusive. A smaller value means less distraction for meeting participants, while a larger value shows a clearer watermark. It's supported when enabledVisualWatermark is true.
Audio connection options.
Choose how meeting attendees join the audio portion of the meeting.
Provide a hybrid audio option, allowing attendees to join using their computer audio or a phone.
Only restricts attendees to join the audio portion of the meeting using their computer instead of a telephone option.
Other teleconference services.
The way of attendees join the audio portion of the meeting is the default value.
Whether or not to show toll-free call-in numbers.
Whether or not to show global call-in numbers to attendees.
Whether or not to allow attendees to receive a call-back and call-in is available. Can only be set true for a webinar.
Select the sound you want users who have a phone audio connection to hear when someone enters or exits the meeting.
All call-in users joining the meeting will hear the beep.
All call-in users joining the meeting will hear their names.
Turn off beeps and name announcements.
Whether or not to allow the host to unmute participants.
Whether or not to allow attendees to unmute themselves.
Whether or not to auto-mute attendees when attendees enter meetings.
Require attendees to sign in before joining the webinar. This option works when the value of scheduledType attribute is webinar. Please note that requireAttendeeLogin cannot be set if someone has already registered for the webinar.
Restrict webinar to invited attendees only. This option works when the registration option is disabled and the value of scheduledType attribute is webinar. Please note that restrictToInvitees cannot be set to true if requireAttendeeLogin is false.
Response Properties
Unique identifier for meeting. For a meeting series, the id is used to identify the entire series. For scheduled meetings from a series, the id is used to identify that scheduled meeting. For a meeting instance that is in progress or has concluded, the id is used to identify that instance.
Meeting number. Applies to meeting series, scheduled meeting, and meeting instances, but not to meeting instances which have ended.
Meeting title. Can be modified for a meeting series or a scheduled meeting using the Update a Meeting API.
Meeting agenda. The agenda can be a maximum of 1300 characters long. This attribute can be modified for a meeting series or a scheduled meeting using the Update a Meeting API.
Meeting password. Applies to meeting series, scheduled meetings, and in-progress meeting instances, but not to meeting instances which have ended. Can be modified for a meeting series or a scheduled meeting using the Update a Meeting API.
8-digit numeric password used to join a meeting from audio and video devices. This attribute applies to meeting series, scheduled meetings, and in-progress meeting instances, but not to meeting instances which have ended.
Meeting type.
Primary instance of a scheduled series of meetings which consists of one or more scheduled meetings based on a recurrence rule. When a non-recurring meeting is scheduled with no recurrence, its meetingType is also meetingSeries which is a meeting series with only one occurrence in Webex meeting modeling.
Instance from a primary meeting series.
Meeting instance that is in progress or has completed.
Meeting state.
Only applies to a meeting series. Indicates that one or more future scheduled meetings exist for this meeting series.
Only applies to scheduled meeting. Indicates that the meeting is scheduled in the future.
Only applies to scheduled meeting. Indicates that this scheduled meeting is ready to start or join immediately.
Only applies to meeting instances. Indicates that a locked meeting has been joined by participants, but no hosts have joined.
Applies to meeting series and meeting instances. For a meeting series, indicates that an instance of this series is happening now. For a meeting instance, indicates that the meeting has been joined and unlocked.
Applies to scheduled meetings and meeting instances. For scheduled meetings, indicates that the meeting was started and is now over. For meeting instances, indicates that the meeting instance has concluded.
This state only applies to scheduled meetings. Indicates that the meeting was scheduled in the past but never happened.
This state only applies to a meeting series. Indicates that all scheduled meetings of this series have passed.
Only applies to meeting series in the inProgress state, scheduled meetings in the ready state, and meeting instances in the inProgress state, whether or not the meeting host joined the meeting. If true, the meeting host has joined the meeitng even if they dropped off; otherwise, the meeting host hasn't ever join the meeting. Indicates that someone is waiting in the lobby and the host hasn't joined the meeting if attendeeDidJoin is true and hostDidJoin is false.
Only applies to meeting series in the inProgress state, scheduled meetings in the ready state, and meeting instances in the inProgress state. Whether or not anyone has joined the meeting. If true, the meeting host or any attendee has joined the meeting; otherwise, no one has joined the meeting. Indicates that someone is waiting in the lobby and the host hasn't joined the meeting if attendeeDidJoin is true and hostDidJoin is false.
Time zone of start and end, conforming with the IANA time zone database.
Start time for meeting in ISO 8601 compliant format. If the meeting is a meeting series, start is the date and time the first meeting of the series starts. If the meeting is a meeting series and the current filter is true, start is the date and time the upcoming or ongoing meeting of the series starts. If the meeting is a scheduled meeting from a meeting series, start is the date and time when that scheduled meeting starts. If the meeting is a meeting instance that has happened or is happening, start is the date and time that the instance actually starts. Can be modified for a meeting series or a scheduled meeting using the Update a Meeting API.
End time for a meeting in ISO 8601 compliant format. If the meeting is a meeting series, end is the date and time the first meeting of the series ends. If the meeting is a meeting series and the current filter is true, end is the date and time the upcoming or ongoing meeting of the series ends. If the meeting is a scheduled meeting from a meeting series, end is the date and time when that scheduled meeting ends. If the meeting is a meeting instance that has happened, end is the date and time that instance actually ends. If a meeting instance is in progress, end is not available. Can be modified for a meeting series or a scheduled meeting using the Update a Meeting API.
Meeting series recurrence rule (conforming with RFC 2445). Applies only to a recurring meeting series, not to a meeting series with only one scheduled meeting. Can be modified for a meeting series using the Update a Meeting API. Multiple days or dates for monthly or yearly recurrence rule are not supported, only the first day or date specified is taken. For example, "FREQ=MONTHLY;INTERVAL=1;COUNT=10;BYMONTHDAY=10,11,12" is not supported and it will be partially supported as "FREQ=MONTHLY;INTERVAL=1;COUNT=10;BYMONTHDAY=10". For a non-recurring meeting which has no recurrence, its meetingType is also meetingSeries which is a meeting series with only one occurrence in Webex meeting modeling.
Unique identifier for the meeting host.
Display name for the meeting host.
Email address for the meeting host.
Key for joining the meeting as host.
Site URL for the meeting.
Link to a meeting information page where the meeting client is launched if the meeting is ready to start or join.
SIP address for callback from a video system.
IP address for callback from a video system.
Room ID of the associated Webex space. Only applies to ad-hoc meetings and space meetings.
Whether or not meeting is recorded automatically. Can be modified for a meeting series or a scheduled meeting using the Update a Meeting API.
Whether or not to allow any attendee with a host account on the target site to become a cohost when joining the meeting. The target site is specified by a siteUrl parameter when creating the meeting. If not specified, it's a user's preferred site. The allowAnyUserToBeCoHost attribute can be modified for a meeting series or a scheduled meeting using the Update a Meeting API.
Whether or not to allow any attendee to join the meeting before the host joins the meeting. The enabledJoinBeforeHost attribute can be modified for a meeting series or a scheduled meeting using the Update a Meeting API.
Whether or not to allow any attendee to connect to audio before the host joins the meeting. Only applicable if the enabledJoinBeforeHost attribute is set to true. The enableConnectAudioBeforeHost attribute can be modified for a meeting series or a scheduled meeting using the Update a Meeting API.
Number of minutes an attendee can join the meeting before the meeting start time and the host joins. Only applicable if the enabledJoinBeforeHost attribute is set to true. The joinBeforeHostMinutes attribute can be modified for a meeting series or a scheduled meeting using the Update a Meeting API. Valid options for a meeting are 0, 5, 10, and 15, and valid options for a webinar are 0, 15, 30, 45, and 60. The default is 0 if not specified.
Whether or not to exclude the meeting password from the email invitation.
Whether or not to allow the meeting to be listed on the public calendar.
The number of minutes before the meeting begins, that an email reminder is sent to the host.
Specifies how the people who aren't on the invite can join the unlocked meeting.
If the value of unlockedMeetingJoinSecurity attribute is allowJoin, people can join the unlocked meeting directly.
If the value of unlockedMeetingJoinSecurity attribute is allowJoinWithLobby, people will wait in the lobby until the host admits them.
If the value of unlockedMeetingJoinSecurity attribute is blockFromJoin, people can't join the unlocked meeting.
Unique identifier for a meeting session type for the user. This attribute is required when scheduling a webinar meeting. All available meeting session types enabled for the user can be retrieved using the List Meeting Session Types API.
Specifies whether the meeting is a regular meeting, a webinar, or a meeting scheduled in the user's personal room.
If the value of scheduledType attribute is meeting, it is a regular meeting.
If the value of scheduledType attribute is webinar, it is a webinar meeting.
If the value of scheduledType attribute is personalRoomMeeting, it is a meeting scheduled in the user's personal room.
Whether or not webcast view is enabled.
Password for panelists of a webinar meeting. Must conform to the site's password complexity settings. Read password management for details. If not specified, a random password conforming to the site's password rules will be generated automatically.
8-digit numeric panelist password to join a webinar meeting from audio and video devices.
Whether or not to automatically lock the meeting after it starts.
The number of minutes after the meeting begins, for automatically locking it.
Whether or not to allow the first attendee of the meeting with a host account on the target site to become a cohost. The target site is specified by the siteUrl parameter when creating the meeting. If not specified, it's a user's preferred site. The allowFirstUserToBeCoHost attribute can be modified for a meeting series or a scheduled meeting uisng the Update a Meeting API.
Whether or not to allow authenticated video devices in the meeting's organization to start or join the meeting without a prompt. This attribute can be modified for a meeting series or a scheduled meeting using the Update a Meeting API.
Information for callbacks from a meeting to phone or for joining a teleconference using a phone.
Code for authenticating a user to join teleconference. Users join the teleconference using the call-in number or the global call-in number, followed by the value of the accessCode.
Array of call-in numbers for joining a teleconference from a phone.
Label for the call-in number.
Call-in number to join the teleconference from a phone.
Type of toll for the call-in number.
HATEOAS information of global call-in numbers for joining a teleconference from a phone.
Meeting Options.
Whether or not to allow any attendee to chat in the meeting. Also depends on the session type.
Whether or not to allow any attendee to have video in the meeting. Also depends on the session type.
Whether or not to allow any attendee to poll in the meeting. Can only be set true for a webinar. The value of this attribute depends on the session type for a meeting. Please contact your site admin if this attribute is not available. Not supported if the site has been migrated to the Webex Suite meeting platform.
Whether or not to allow any attendee to take notes in the meeting. The value of this attribute also depends on the session type. Not supported if the site has been migrated to the Webex Suite meeting platform.
Whether note taking is enabled. If the value of enabledNote is false, users cannot set this attribute and get the default value allowAll. Not supported if the site has been migrated to the Webex Suite meeting platform.
If the value of noteType attribute is allowAll, all participants can take notes.
If the value of noteType attribute is allowOne, only a single note taker is allowed.
Whether or not to allow any attendee to transfer files in the meeting. The value of this attribute also depends on the session type.
Whether or not to allow any attendee to share Universal Communications Format media files in the meeting. The value of this attribute also depends on the sessionType. Not supported if the site has been migrated to the Webex Suite meeting platform.
Attendee Privileges. This attribute is not supported for a webinar.
Whether or not to allow any attendee to share content in the meeting.
Whether or not to allow any attendee to save shared documents, slides, or whiteboards when they are shared as files in the content viewer instead of in a window or application.
Whether or not to allow any attendee to print shared documents, slides, or whiteboards when they are shared as files in the content viewer instead of in a window or application.
Whether or not to allow any attendee to annotate shared documents, slides, or whiteboards when they are shared as files in the content viewer instead of in a window or application.
Whether or not to allow any attendee to view participants.
Whether or not to allow any attendee to see a small preview image of any page of shared documents or slides when they are shared as files in the content viewer instead of in a window or application.
Whether or not to allow any attendee to control applications, web browsers, or desktops remotely.
Whether or not to allow any attendee to view any shared documents or slides when they are shared as files in the content viewer instead of in a window or application.
Whether or not to allow any attendee to scroll through any page of shared documents or slides when they are shared as files in the content viewer instead of in a window or application.
Whether or not to allow any attendee to contact the operator privately.
Whether or not to allow any attendee to chat with the host in private.
Whether or not to allow any attendee to chat with the presenter in private.
Whether or not to allow any attendee to chat with other participants in private.
Meeting registration. When this option is enabled, meeting invitees must register personal information in order to join the meeting. Meeting invitees will receive an email with a registration link for the registration. When the registration form has been submitted and approved, an email with a real meeting link will be received. By clicking that link the meeting invitee can join the meeting. Please note that meeting registration does not apply to a meeting when it's a recurring meeting with a recurrence field or no password or when the feature toggle DecoupleJBHWithRegistration is disabled the Join Before Host option is enabled for the meeting, See Register for a Meeting in Cisco Webex Meetings for details.
Whether or not meeting registration requests are accepted automatically.
Whether or not a registrant's first name is required for meeting registration.
Whether or not a registrant's last name is required for meeting registration.
Whether or not a registrant's email is required for meeting registration.
Whether or not a registrant's job title is shown or required for meeting registration.
Whether or not a registrant's company name is shown or required for meeting registration.
Whether or not a registrant's first address field is shown or required for meeting registration.
Whether or not a registrant's second address field is shown or required for meeting registration.
Whether or not a registrant's city is shown or required for meeting registration.
Whether or not a registrant's state is shown or required for meeting registration.
Whether or not a registrant's postal code is shown or required for meeting registration.
Whether or not a registrant's country or region is shown or required for meeting registration.
Whether or not a registrant's work phone number is shown or required for meeting registration.
Whether or not a registrant's fax number is shown or required for meeting registration.
Maximum number of meeting registrations. This only applies to meetings. The maximum number of participants for meetings and webinars, with the limit based on the user capacity and controlled by a toggle at the site level. The default maximum number of participants for webinars is 10000, but the actual maximum number of participants is limited by the user capacity.
Customized questions for meeting registration.
Unique identifier for the question.
Title of the customized question.
Whether or not the customized question is required to be answered by participants.
Type of the question being asked.
Single line text box.
Multiple line text box.
Check box which requires options.
Drop down list box which requires options.
Single radio button which requires options.
The maximum length of a string that can be entered by the user, ranging from 0 to 999. Only required by singleLineTextBox and multiLineTextBox.
TThe content of options. Required if the question type is one of checkbox, dropdownList, or radioButtons.
The unique id of options.
The content of the option.
The automatic approval rules for customized questions.
Judgment expression for approval rules.
The content of the answer contains the value.
The content of the answer does not contain the value
The content of the answer begins with the value.
The content of the answer ends with the value.
The content of the answer is the same as the value.
The content of the answer is not the same as the value.
The keyword for the approval rule. If the rule matches the keyword, the corresponding action will be executed.
The automatic approval result for the approval rule.
If the user's registration value meets the criteria, the registration form will be automatically approved.
If the user's registration value meets the criteria, the registration form will be automatically rejected.
Whether to check the case of values.
The priority number of the approval rule. Approval rules for standard questions and custom questions need to be ordered together.
The approval rules for standard questions.
Name for standard question.
If the value is lastName, this approval rule applies to the standard question of "Last Name".
If the value is email, this approval rule applies to the standard question of "Email".
If the value is jobTitle, this approval rule applies to the standard question of "Job Title".
If the value is companyName, this approval rule applies to the standard question of "Company Name".
If the value is address1, this approval rule applies to the standard question of "Address 1".
If the value is address2, this approval rule applies to the standard question of "Address 2".
If the value is city, this approval rule applies to the standard question of "City".
If the value is state, this approval rule applies to the standard question of "State".
If the value is zipCode, this approval rule applies to the standard question of "Zip/Post Code".
If the value is countryRegion, this approval rule applies to the standard question of "Country Region".
If the value is workPhone, this approval rule applies to the standard question of "Work Phone".
If the value is fax, this approval rule applies to the standard question of "Fax".
Judgment expression for approval rules.
The content of the answer contains the value.
The content of the answer does not contain the value
The content of the answer begins with the value.
The content of the answer ends with the value.
The content of the answer is the same as the value.
The content of the answer is not the same as the value.
The keyword for the approval rule. If the rule matches the keyword, the corresponding action will be executed.
The automatic approval result for the approval rule.
If the user's registration value meets the criteria, the registration form will be automatically approved.
If the user's registration value meets the criteria, the registration form will be automatically rejected.
Whether to check the case of values.
The priority number of the approval rule. Approval rules for standard questions and custom questions need to be ordered together.
External keys created by an integration application in its own domain, for example Zendesk ticket IDs, Jira IDs, Salesforce Opportunity IDs, etc.
Simultaneous interpretation information for a meeting.
Whether or not simultaneous interpretation is enabled.
Interpreters for meeting.
Unique identifier for meeting interpreter.
Email address of meeting interpreter.
Display name of meeting interpreter.
Whether or not breakout sessions are enabled.
HATEOAS Breakout Sessions information for meeting.
Tracking codes information.
Name for the tracking code.
Value for the tracking code.
Whether or not the audio watermark is enabled.
Whether or not the visual watermark is enabled.
Opacity level for visual watermark.
Audio connection options.
Choose how meeting attendees join the audio portion of the meeting.
Provide a hybrid audio option, allowing attendees to join using their computer audio or a phone.
Only restricts attendees to join the audio portion of the meeting using their computer instead of a telephone option.
Other teleconference services.
The way of attendees join the audio portion of the meeting is the default value.
Whether or not to show toll-free call-in numbers.
Whether or not to show global call-in numbers to attendees.
Whether or not to allow attendees to receive a call-back and call-in is available. Can only be set true for a webinar.
Select the sound you want users who have a phone audio connection to hear when someone enters or exits the meeting.
All call-in users joining the meeting will hear the beep.
All call-in users joining the meeting will hear their names.
Turn off beeps and name announcements.
Whether or not to allow the host to unmute participants.
Whether or not to allow attendees to unmute themselves.
Whether or not to auto-mute attendees when attendees enter meetings.
Require attendees to sign in before joining the webinar.
Restrict webinar to invited attendees only.
Response Codes
The list below describes the common success and error responses you should expect from the API.
| Code | Status | Description |
|---|---|---|
| 200 | OK | Successful request with body content. |
| 201 | Created | The request has succeeded and has led to the creation of a resource. |
| 202 | Accepted | The request has been accepted for processing. |
| 204 | No Content | Successful request without body content. |
| 400 | Bad Request | The request was invalid or cannot be otherwise served. An accompanying error message will explain further. |
| 401 | Unauthorized | Authentication credentials were missing or incorrect. |
| 403 | Forbidden | The request is understood, but it has been refused or access is not allowed. |
| 404 | Not Found | The URI requested is invalid or the resource requested, such as a user, does not exist. Also returned when the requested format is not supported by the requested method. |
| 405 | Method Not Allowed | The request was made to a resource using an HTTP request method that is not supported. |
| 409 | Conflict | The request could not be processed because it conflicts with some established rule of the system. For example, a person may not be added to a room more than once. |
| 410 | Gone | The requested resource is no longer available. |
| 415 | Unsupported Media Type | The request was made to a resource without specifying a media type or used a media type that is not supported. |
| 423 | Locked | The requested resource is temporarily unavailable. A Retry-After header may be present that specifies how many seconds you need to wait before attempting the request again. |
| 428 | Precondition Required | File(s) cannot be scanned for malware and need to be force downloaded. |
| 429 | Too Many Requests | Too many requests have been sent in a given amount of time and the request has been rate limited. A Retry-After header should be present that specifies how many seconds you need to wait before a successful request can be made. |
| 500 | Internal Server Error | Something went wrong on the server. If the issue persists, feel free to contact the Webex Developer Support team. |
| 502 | Bad Gateway | The server received an invalid response from an upstream server while processing the request. Try again later. |
| 503 | Service Unavailable | Server is overloaded with requests. Try again later. |
| 504 | Gateway Timeout | An upstream server failed to respond on time. If your query uses max parameter, please try to reduce it. |
Header
Body
- Meeting title. The title can be a maximum of 128 characters long.
- Meeting agenda. The agenda can be a maximum of 1300 characters long.
- Meeting password. Must conform to the site's password complexity settings. Read [password management](https://help.webex.com/en-us/zrupm6/Manage-Security-Options-for-Your-Site-in-Webex-Site-Administration) for details.
- Date and time for the start of meeting in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format. `start` cannot be before current date and time or after `end`. Duration between `start` and `end` cannot be shorter than 10 minutes or longer than 23 hours 59 minutes. Refer to the [Webex Meetings](/docs/meetings#restrictions-on-updating-a-meeting) guide for more information about restrictions on updating date and time for a meeting. Please note that when a meeting is being updated, `start` of the meeting will be accurate to minutes, not seconds or milliseconds. Therefore, if `start` is within the same minute as the current time, `start` will be adjusted to the upcoming minute; otherwise, `start` will be adjusted with seconds and milliseconds stripped off. For instance, if the current time is `2022-03-01T10:32:16.657+08:00`, `start` of `2022-03-01T10:32:28.076+08:00` or `2022-03-01T10:32:41+08:00` will be adjusted to `2022-03-01T10:33:00+08:00`, and `start` of `2022-03-01T11:32:28.076+08:00` or `2022-03-01T11:32:41+08:00` will be adjusted to `2022-03-01T11:32:00+08:00`.
- Date and time for the end of meeting in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format. `end` cannot be before current date and time or before `start`. Duration between `start` and `end` cannot be shorter than 10 minutes or longer than 23 hours 59 minutes. Refer to the [Webex Meetings](/docs/meetings#restrictions-on-updating-a-meeting) guide for more information about restrictions on updating date and time for a meeting. Please note that when a meeting is being updated, `end` of the meeting will be accurate to minutes, not seconds or milliseconds. Therefore, `end` will be adjusted with seconds and milliseconds stripped off. For instance, `end` of `2022-03-01T11:52:28.076+08:00` or `2022-03-01T11:52:41+08:00` will be adjusted to `2022-03-01T11:52:00+08:00`.
- [Time zone](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones#List) in which the meeting was originally scheduled (conforming with the [IANA time zone database](https://www.iana.org/time-zones)).
- Meeting series recurrence rule (conforming with [RFC 2445](https://www.ietf.org/rfc/rfc2445.txt)). Applies only to a recurring meeting series, not to a meeting series with only one scheduled meeting. Multiple days or dates for monthly or yearly `recurrence` rule are not supported, only the first day or date specified is taken. For example, "FREQ=MONTHLY;INTERVAL=1;COUNT=10;BYMONTHDAY=10,11,12" is not supported and it will be partially supported as "FREQ=MONTHLY;INTERVAL=1;COUNT=10;BYMONTHDAY=10". If you specify a `recurrence` like `FREQ=DAILY;INTERVAL=1` which never ends, the furthest date of the series is unlimited. You can also specify a `recurrence` with a very distant ending date in the future, e.g. `FREQ=DAILY;INTERVAL=1;UNTIL=21241001T000000Z`, but the actual furthest date accepted for the recurring meeting is five years from now. Specifically, if it has an ending date, there can be up to 5 occurrences for a yearly meeting, 60 occurrences for a monthly meeting, 261 occurrences for a weekly meeting, or 1826 occurrences for a daily meeting.
- Whether or not meeting is recorded automatically.
- Whether or not to allow any attendee with a host account on the target site to become a cohost when joining the meeting. The target site is specified by `siteUrl` parameter when creating the meeting; if not specified, it's user's preferred site.
- Whether or not to allow any attendee to join the meeting before the host joins the meeting.
- Whether or not to allow any attendee to connect audio in the meeting before the host joins the meeting. This attribute is only applicable if the `enabledJoinBeforeHost` attribute is set to true.
- Number of minutes an attendee can join the meeting before the meeting start time and the host joins. Only applicable if the `enabledJoinBeforeHost` attribute is set to true. Valid options for a meeting are `0`, `5`, `10`, and `15`, and valid options for a webinar are `0`, `15`, `30`, `45`, and `60`. The default is `0` if not specified.
- Whether or not to exclude the meeting password from the email invitation.
- Whether or not to allow the meeting to be listed on the public calendar.
- The number of minutes before the meeting begins, that an email reminder is sent to the host.
- Specifies how the people who aren't on the invite can join the unlocked meeting.
- Unique identifier for a meeting session type for the user. This attribute is required while scheduling webinar meeting. All available meeting session types enabled for the user can be retrieved by [List Meeting Session Types](/docs/api/v1/meetings/list-meeting-session-types) API.
- Whether or not webcast view is enabled.
- Password for panelists of a webinar meeting. Must conform to the site's password complexity settings. Read [password management](https://help.webex.com/en-us/zrupm6/Manage-Security-Options-for-Your-Site-in-Webex-Site-Administration) for details. If not specified, a random password conforming to the site's password rules will be generated automatically.
- Whether or not to automatically lock the meeting after it starts.
- The number of minutes after the meeting begins, for automatically locking it.
- Whether or not to allow the first attendee of the meeting with a host account on the target site to become a cohost. The target site is specified by `siteUrl` parameter when creating the meeting; if not specified, it's user's preferred site.
- Whether or not to allow authenticated video devices in the meeting's organization to start or join the meeting without a prompt.
- Whether or not to send emails to host and invitees. It is an optional field and default value is true.
- Email address for the meeting host. This attribute should only be set if the user or application calling the API has the admin-level scopes. When used, the admin may specify the email of a user in a site they manage to be the meeting host. The field is not editable and is only used to update a meeting on behalf of the real meeting host. Please use the [Reassign Meetings to a New Host](/docs/api/v1/meetings/reassign-meetings-to-a-new-host) API if you need to update the meeting host.
- Meeting Options.
- Attendee Privileges. This attribute is not supported for a webinar.
- External keys created by an integration application in its own domain, for example Zendesk ticket IDs, Jira IDs, Salesforce Opportunity IDs, etc. The integration application queries meetings by a key in its own domain. The maximum size of `integrationTags` is 3 and each item of `integrationTags` can be a maximum of 64 characters long. Please note that an empty or null `integrationTags` will delete all existing integration tags for the meeting implicitly. Developer can update integration tags for a `meetingSeries` but he cannot update it for a `scheduledMeeting` or a `meeting` instance.
- Whether or not breakout sessions are enabled. If the value of `enabledBreakoutSessions` is false, users can not set breakout sessions. If the value of `enabledBreakoutSessions` is true, users can update breakout sessions using the [Update Breakout Sessions](/docs/api/v1/meetings/{meetingId}/breakoutSessions) API. Updating breakout sessions are not supported by this API.
- Tracking codes information. All available tracking codes and their options for the specified site can be retrieved by [List Meeting Tracking Codes](/docs/api/v1/meetings/list-meeting-tracking-codes) API. If an optional tracking code is missing from the `trackingCodes` array and there's a default option for this tracking code, the default option is assigned automatically. If the `inputMode` of a tracking code is `select`, its value must be one of the site-level options or the user-level value. Tracking code is not supported for a personal room meeting or an ad-hoc space meeting.
- Whether or not the audio watermark is enabled. If it's `true`, `scheduledType` equals or defaults to `meeting`, and `audioConnectionOptions.audioConnectionType` equals `VoIP`, the audio for this meeting will have a watermark. In this case, a unique identifier is embedded into the audio that plays out of each Webex app and device. An administrator can use this watermark when analyzing an unauthorized recording to identify which Webex app or device was the source of the recording.
- Whether or not the visual watermark is enabled. If it's `true`, the video for this meeting will have a watermark. In this case, Webex superimposes a watermark image pattern on top of the meeting video and shared content to deter participants from leaking meeting information. Each participant viewing the meeting sees a watermark image pattern with their email address. If the participant is not signed in, the watermark image pattern includes their display name and email address.
- Opacity level for the visual watermark. The value must be between 5 and 80, inclusive. A smaller value means less distraction for meeting participants, while a larger value shows a clearer watermark. It's supported when `enabledVisualWatermark` is `true`.
- Audio connection options.
- Require attendees to sign in before joining the webinar. This option works when the value of `scheduledType` attribute is `webinar`. Please note that `requireAttendeeLogin` cannot be set if someone has already registered for the webinar.
- Restrict webinar to invited attendees only. This option works when the registration option is disabled and the value of `scheduledType` attribute is `webinar`. Please note that `restrictToInvitees` cannot be set to `true` if `requireAttendeeLogin` is `false`.
{
"title": "Example Daily Meeting Modified",
"agenda": "Example Agenda Modified",
"password": "P@ssword789",
"timezone": "Asia/Shanghai",
"start": "2020-01-27T20:30:00+08:00",
"end": "2020-01-27T21:30:00+08:00",
"enabledAutoRecordMeeting": true,
"allowAnyUserToBeCoHost": true,
"enabledJoinBeforeHost": true,
"enableConnectAudioBeforeHost": true,
"joinBeforeHostMinutes": 15,
"excludePassword": false,
"publicMeeting": false,
"reminderTime": 30,
"unlockedMeetingJoinSecurity": "allowJoin",
"enableAutomaticLock": false,
"automaticLockMinutes": 0,
"allowFirstUserToBeCoHost": false,
"allowAuthenticatedDevices": true,
"sendEmail": true,
"hostEmail": "john.andersen@example.com",
"meetingOptions": {
"enabledChat": true,
"enabledVideo": true,
"enabledPolling": false,
"enabledNote": true,
"noteType": "allowAll",
"enabledFileTransfer": false,
"enabledUCFRichMedia": false
},
"attendeePrivileges": {
"enabledShareContent": true,
"enabledSaveDocument": false,
"enabledPrintDocument": false,
"enabledAnnotate": false,
"enabledViewParticipantList": true,
"enabledViewThumbnails": false,
"enabledRemoteControl": true,
"enabledViewAnyDocument": false,
"enabledViewAnyPage": false,
"enabledContactOperatorPrivately": false,
"enabledChatHost": true,
"enabledChatPresenter": true,
"enabledChatOtherParticipants": true
},
"integrationTags": [
"dbaeceebea5c4a63ac9d5ef1edfe36b9",
"85e1d6319aa94c0583a6891280e3437d",
"27226d1311b947f3a68d6bdf8e4e19a1"
],
"enabledBreakoutSessions": true,
"trackingCodes": [
{
"name": "Department",
"value": "Sales"
},
{
"name": "Division",
"value": "Part-time"
}
],
"enabledAudioWatermark": true,
"enabledVisualWatermark": true,
"visualWatermarkOpacity": 40,
"audioConnectionOptions": {
"audioConnectionType": "VoIP",
"enabledTollFreeCallIn": false,
"enabledGlobalCallIn": false,
"enabledAudienceCallBack": true,
"entryAndExitTone": "beep",
"allowHostToUnmuteParticipants": true,
"allowAttendeeToUnmuteSelf": false,
"muteAttendeeUponEntry": true
}
}
{
"id": "1d824a4a205042eba9574e00b711b226_20200127T120000Z",
"meetingSeriesId": "1d824a4a205042eba9574e00b711b226",
"meetingNumber": "123456789",
"title": "Example Daily Meeting Modified",
"agenda": "Example Agenda Modified",
"password": "P@ssword789",
"phoneAndVideoSystemPassword": "12345678",
"meetingType": "scheduledMeeting",
"state": "scheduled",
"isModified": true,
"timezone": "Asia/Shanghai",
"start": "2020-01-27T20:30:00+08:00",
"end": "2020-01-27T21:30:00+08:00",
"hostUserId": "Y2lzY29zcGFyazovL3VzL1BFT1BMRS9jN2ZkNzNmMi05ZjFlLTQ3ZjctYWEwNS05ZWI5OGJiNjljYzY",
"hostDisplayName": "John Andersen",
"hostEmail": "john.andersen@example.com",
"hostKey": "123456",
"siteUrl": "site4-example.webex.com",
"webLink": "https://site4-example.webex.com/site4/j.php?MTID=m31a1db24db78ac569f739e0cfb2741c1",
"sipAddress": "123456789@site4-example.webex.com",
"dialInIpAddress": "192.168.100.100",
"enabledAutoRecordMeeting": true,
"allowAnyUserToBeCoHost": true,
"enabledJoinBeforeHost": true,
"enableConnectAudioBeforeHost": true,
"joinBeforeHostMinutes": 15,
"excludePassword": false,
"publicMeeting": false,
"reminderTime": 30,
"unlockedMeetingJoinSecurity": "allowJoin",
"sessionTypeId": 3,
"enableAutomaticLock": false,
"automaticLockMinutes": 0,
"allowFirstUserToBeCoHost": false,
"allowAuthenticatedDevices": true,
"telephony": {
"accessCode": "1234567890",
"callInNumbers": [
{
"label": "US Toll",
"callInNumber": "123456789",
"tollType": "toll"
}
],
"links": [
{
"rel": "globalCallinNumbers",
"href": "/api/v1/meetings/1d824a4a205042eba9574e00b711b226_20200127T120000Z/globalCallinNumbers",
"method": "GET"
}
]
},
"meetingOptions": {
"enabledChat": true,
"enabledVideo": true,
"enabledPolling": false,
"enabledNote": true,
"noteType": "allowAll",
"enabledFileTransfer": false,
"enabledUCFRichMedia": false
},
"attendeePrivileges": {
"enabledShareContent": true,
"enabledSaveDocument": false,
"enabledPrintDocument": false,
"enabledAnnotate": false,
"enabledViewParticipantList": true,
"enabledViewThumbnails": false,
"enabledRemoteControl": true,
"enabledViewAnyDocument": false,
"enabledViewAnyPage": false,
"enabledContactOperatorPrivately": false,
"enabledChatHost": true,
"enabledChatPresenter": true,
"enabledChatOtherParticipants": true
},
"registration": {
"autoAcceptRequest": false,
"requireFirstName": true,
"requireLastName": true,
"requireEmail": true,
"requireJobTitle": false,
"requireCompanyName": true,
"requireAddress1": false,
"requireAddress2": false,
"requireCity": false,
"requireState": false,
"requireZipCode": false,
"requireCountryRegion": true,
"requireWorkPhone": true,
"requireFax": false
},
"integrationTags": [
"dbaeceebea5c4a63ac9d5ef1edfe36b9",
"85e1d6319aa94c0583a6891280e3437d",
"27226d1311b947f3a68d6bdf8e4e19a1"
],
"scheduledType": "meeting",
"simultaneousInterpretation": {
"enabled": true,
"interpreters": [
{
"id": "OGQ0OGRiM2U3ZTAxNDZiMGFjYzJjMzYxNDNmNGZhN2RfZTA5MTJiZDBjNWVlNDA4YjgxMTZlMjU4Zjg2NWIzZmM",
"languageCode1": "en",
"languageCode2": "de",
"email": "marcus.hoffmann@example.com",
"displayName": "Hoffmann"
}
]
},
"enabledBreakoutSessions": true,
"links": [
{
"rel": "breakoutSessions",
"href":"/v1/meetings/1d824a4a205042eba9574e00b711b226/breakoutSessions",
"method": "GET"
}
],
"trackingCodes": [
{
"name": "Department",
"value": "Sales"
},
{
"name": "Division",
"value": "Part-time"
}
],
"enabledAudioWatermark": true,
"enabledVisualWatermark": true,
"visualWatermarkOpacity": 40,
"audioConnectionOptions": {
"audioConnectionType": "VoIP",
"enabledTollFreeCallIn": false,
"enabledGlobalCallIn": false,
"enabledAudienceCallBack": true,
"entryAndExitTone": "beep",
"allowHostToUnmuteParticipants": true,
"allowAttendeeToUnmuteSelf": false,
"muteAttendeeUponEntry": true
}
}