PATCH /meetings/{meetingId}
Update the details of a meeting.
This API has a rate limit of 100 requests per day. Therefore, a meeting can only be updated for a maximum of 100 times within a 24 hour window.
Scopes: meeting:write:admin meeting:write
Rate Limit Label: Light
Servers
- https://api.zoom.us/v2
Path parameters
| Name | Type | Required | Description |
|---|---|---|---|
meetingId |
Integer | Yes |
The meeting ID in long format. The data type of this field is "long"(represented as int64 in JSON). While storing it in your database, store it as a long data type and not as an integer, as the Meeting IDs can be longer than 10 digits. |
Request headers
| Name | Type | Required | Description |
|---|---|---|---|
Content-Type |
String | Yes |
The media type of the request body.
Default value: "application/json" |
Query parameters
| Name | Type | Required | Description |
|---|---|---|---|
occurrence_id |
String | No |
Meeting occurrence id. Support change of agenda, start_time, duration, settings: {host_video, participant_video, join_before_host, mute_upon_entry, waiting_room, watermark, auto_recording} |
Request body fields
| Name | Type | Required | Description |
|---|---|---|---|
agenda |
String | No |
Meeting description. |
timezone |
String | No |
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. |
topic |
String | No |
Meeting topic. |
tracking_fields[] |
Array | No |
Tracking fields |
tracking_fields[].field |
String | No |
Tracking fields type |
tracking_fields[].value |
String | No |
Tracking fields value |
start_time |
String | No |
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. |
recurrence |
Object | No |
Recurrence object. Use this object only for a meeting with type |
recurrence.weekly_days |
String | No |
This field is required if you're scheduling a recurring meeting of type
Valid values:
Default value: "1" |
recurrence.end_date_time |
String | No |
Select the final date on which 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".) |
recurrence.end_times |
Integer | No |
Select how many times the meeting should recur before it is canceled. (Cannot be used with "end_date_time".) Default value: 1 |
recurrence.type |
Integer | Yes |
Recurrence meeting types: Valid values:
|
recurrence.repeat_interval |
Integer | No |
Define the interval at which the meeting should recur. For instance, if you would like to schedule a meeting that recurs every two months, you must set the value of this field as For a daily meeting, the maximum interval you can set is |
recurrence.monthly_day |
Integer | No |
Use this field only if you're scheduling a recurring meeting of type For instance, if you would like the meeting to recur on 23rd of each month, provide Default value: 1 |
recurrence.monthly_week |
Integer | No |
Use this field only if you're scheduling a recurring meeting of type Valid values:
|
recurrence.monthly_week_day |
Integer | No |
Use this field only if you're scheduling a recurring meeting of type
Valid values:
|
password |
String | No |
Meeting passcode. Passcode may only contain the following characters: [a-z A-Z 0-9 @ - _ *] and can have a maximum of 10 characters. Note: If the account owner or the admin has configured minimum passcode requirement settings, the passcode value provided here must meet those requirements. |
type |
Integer | No |
Meeting Types: Valid values:
Default value: 2 |
schedule_for |
String | No |
Email or userId if you want to schedule meeting for another user. |
duration |
Integer | No |
Meeting duration (minutes). Used for scheduled meetings only. |
template_id |
String | No |
Unique identifier of the meeting template. Use this field if you would like to schedule the meeting from a meeting template. You can retrieve the value of this field by calling the List meeting templates API. |
How to start integrating
- Add HTTP Task to your workflow definition.
- Search for the API you want to integrate with and click on the name.
- This loads the API reference documentation and prepares the Http request settings.
- Click Test request to test run your request to the API and see the API's response.