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

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 8 i.e., a recurring meeting with fixed time.

recurrence.weekly_days String No

This field is required if you're scheduling a recurring meeting of type 2 to state which day(s) of the week the meeting should repeat.

The value for this field could be a number between 1 to 7 in string format. For instance, if the meeting should recur on Sunday, provide "1" as the value of this field.

Note: If you would like the meeting to occur on multiple days of a week, you should provide comma separated values for this field. For instance, if the meeting should recur on Sundays and Tuesdays provide "1,3" as the value of this field.


1 - Sunday.
2 - Monday.
3 - Tuesday.
4 - Wednesday.
5 - Thursday.
6 - Friday.
7 - Saturday.

Valid values:

  • "4"
  • "3"
  • "2"
  • "1"
  • "7"
  • "6"
  • "5"

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:
1 - Daily.
2 - Weekly.
3 - Monthly.

Valid values:

  • 1
  • 2
  • 3
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 2 and the value of the type parameter as 3.

For a daily meeting, the maximum interval you can set is 90 days. For a weekly meeting the maximum interval that you can set is of 12 weeks. For a monthly meeting, there is a maximum of 3 months.

recurrence.monthly_day Integer No

Use this field only if you're scheduling a recurring meeting of type 3 to state which day in a month, the meeting should recur. The value range is from 1 to 31.

For instance, if you would like the meeting to recur on 23rd of each month, provide 23 as the value of this field and 1 as the value of the repeat_interval field. Instead, if you would like the meeting to recur every three months, on 23rd of the month, change the value of the repeat_interval field to 3.

Default value: 1

recurrence.monthly_week Integer No

Use this field only if you're scheduling a recurring meeting of type 3 to state the week of the month when the meeting should recur. If you use this field, you must also use the monthly_week_day field to state the day of the week when the meeting should recur.
-1 - Last week of the month.
1 - First week of the month.
2 - Second week of the month.
3 - Third week of the month.
4 - Fourth week of the month.

Valid values:

  • 1
  • 2
  • 3
  • -1
  • 4
recurrence.monthly_week_day Integer No

Use this field only if you're scheduling a recurring meeting of type 3 to state a specific day in a week when the monthly meeting should recur. To use this field, you must also use the monthly_week field.


1 - Sunday.
2 - Monday.
3 - Tuesday.
4 - Wednesday.
5 - Thursday.
6 - Friday.
7 - Saturday.

Valid values:

  • 1
  • 2
  • 3
  • 4
  • 5
  • 6
  • 7
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.

If the requirements are enabled, you can view those requirements by calling either the Get User Settings API or the Get Account Settings API.

type Integer No

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

Valid values:

  • 1
  • 2
  • 3
  • 8

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

  1. Add HTTP Task to your workflow definition.
  2. 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.
  3. Click Test request to test run your request to the API and see the API's response.