patch

/meetings/{meetingId}

Update the details of a meeting.

Scopes: meeting:write:admin meeting:write

Authorization

oauth2 - authorizationCode

Request Parameters

1 Path Parameter
1 Query Parameter

Request Body

Meeting

1 Example
Schema
object

Meeting object

schedule_for
string

Email or userId if you want to schedule meeting for another user.

topic
string

Meeting topic.

type
integer

Meeting Types:
1 - Instant meeting.
2 - Scheduled meeting.
3 - Recurring meeting with no fixed time.
8 - Recurring meeting with a fixed time.

Allowed Values: 1, 2, 3, 8
default: 2
start_time
string

Meeting start time. When using a format like “yyyy-MM-dd’T’HH:mm:ss’Z’”, always use GMT time. When using a format like “yyyy-MM-dd’T’HH:mm:ss”, you should use local time and specify the time zone. Only used for scheduled meetings and recurring meetings with a fixed time.

format: date-time
duration
integer

Meeting duration (minutes). Used for scheduled meetings only.

timezone
string

Time zone to format start_time. For example, “America/Los_Angeles”. For scheduled meetings only. Please reference our time zone list for supported time zones and their formats.

password
string

Password to join the meeting. Password may only contain the following characters: [a-z A-Z 0-9 @ - _ *]. Max of 10 characters.

agenda
string

Meeting description.

tracking_fields
array[object]

Tracking fields

field
string

Tracking fields type

value
string

Tracking fields value

recurrence
object

Recurrence object.

type
integer

Recurrence meeting types:
1 - Daily.
2 - Weekly.
3 - Monthly.

2 validations
repeat_interval
integer

At which interval should the meeting repeat? For a daily meeting there’s a maximum of 90 days. For a weekly meeting there is a maximum of 12 weeks. For a monthly meeting there is a maximum of 3 months.

weekly_days
integer

Days of the week the meeting should repeat. Note: Multiple values should be separated by a comma.
1 - Sunday.
2 - Monday.
3 - Tuesday.
4 - Wednesday.
5 - Thursday.
6 - Friday.
7 - Saturday.

2 validations
monthly_day
integer

Day in the month the meeting is to be scheduled. The value range is from 1 to 31.

monthly_week
integer

The week a meeting will recur each month.
-1 - Last week.
1 - First week.
2 - Second week.
3 - Third week.
4 - Fourth week.

2 validations
monthly_week_day
integer

The weekday a meeting should recur each month.
1 - Sunday.
2 - Monday.
3 - Tuesday.
4 - Wednesday.
5 - Thursday.
6 - Friday.
7 - Saturday.

2 validations
end_times
integer

Select how many times the meeting will recur before it is canceled. (Cannot be used with “end_date_time”.)

2 validations
end_date_time
string

Select a date the meeting will recur before it is canceled. Should be in UTC time, such as 2017-11-25T12:00:00Z. (Cannot be used with “end_times”.)

1 validation
settings
object

Meeting settings.

host_video
boolean

Start video when the host joins the meeting.

participant_video
boolean

Start video when participants join the meeting.

cn_meeting
boolean

Host meeting in China.

1 validation
in_meeting
boolean

Host meeting in India.

1 validation
join_before_host
boolean

Allow participants to join the meeting before the host starts the meeting. Only used for scheduled or recurring meetings.

1 validation
mute_upon_entry
boolean

Mute participants upon entry.

1 validation
watermark
boolean

Add watermark when viewing a shared screen.

1 validation
use_pmi
boolean

Use a personal meeting ID. Only used for scheduled meetings and recurring meetings with no fixed time.

1 validation
approval_type
integer

0 - Automatically approve.
1 - Manually approve.
2 - No registration required.

3 validations
registration_type
integer

Registration type. Used for recurring meeting with fixed time only.
1 Attendees register once and can attend any of the occurrences.
2 Attendees need to register for each occurrence to attend.
3 Attendees register once and can choose one or more occurrences to attend.

3 validations
audio
string

Determine how participants can join the audio portion of the meeting.
both - Both Telephony and VoIP.
telephony - Telephony only.
voip - VoIP only.

3 validations
auto_recording
string

Automatic recording:
local - Record on local.
cloud - Record on cloud.
none - Disabled.

3 validations
enforce_login
boolean

Only signed in users can join this meeting.

enforce_login_domains
string

Only signed in users with specified domains can join meetings.

alternative_hosts
string

Alternative host’s emails or IDs: multiple values separated by a comma.

close_registration
boolean

Close registration after event date

1 validation
waiting_room
boolean

Enable waiting room

1 validation
global_dial_in_countries
array[string]

List of global dial-in countries

contact_name
string

Contact name for registration

contact_email
string

Contact email for registration

registrants_confirmation_email
boolean

Send confirmation email to registrants

Responses

Send a Test Request

Send requests directly from the browser (CORS must be enabled)
Path Params
1 path param not set
meetingId
$$.env
1 variable not set
oauth_access_token