PATCH /meetings/{meetingId}/recordings/settings

Update settings applied to a meeting's Cloud Recording

Scopes: recording:write:admin recording:write

Rate Limit Label: Light

Servers

Path parameters

Name Type Required Description
meetingId String Yes

To get Cloud Recordings of a meeting, provide the meeting ID or meeting UUID. If the meeting ID is provided instead of UUID,the response will be for the latest meeting instance.

To get Cloud Recordings of a webinar, provide the webinar ID or the webinar UUID. If the webinar ID is provided instead of UUID,the response will be for the latest webinar instance.

If a UUID starts with "/" or contains "//" (example: "/ajXp112QmuoKj4854875=="), you must double encode the UUID before making an API request.

Request headers

Name Type Required Description
Content-Type String Yes The media type of the request body.

Default value: "application/json"

Request body fields

Name Type Required Description
show_social_share_buttons Boolean No

Show social share buttons on registration page. This applies for On-demand recordings only.

topic String No

Name of the recording.

on_demand Boolean No

Determine whether registration isrequired to view the recording.

viewer_download Boolean No

Determine whether a viewer can download the recording file or not.

send_email_to_host Boolean No

Send an email to host when someone registers to view the recording. This applies for On-demand recordings only.

password String No

Enable password protection for the recording by setting a password. The password must have a minimum of eight characters with a mix of numbers, letters and special characters.

Note: If the account owner or the admin has set minimum password strength requirements for recordings via Account Settings, the password 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.

share_recording String No

Determine how the meeting recording is shared.

Valid values:

  • "publicly"
  • "internally"
  • "none"
approval_type Integer No

Approval type for the registration.
0- Automatically approve the registration when a user registers.
1 - Manually approve or deny the registration of a user.
2 - No registration required to view the recording.

Valid values:

  • 0
  • 1
  • 2
authentication_option String No

Authentication Options.

authentication_domains String No

Authentication domains.

recording_authentication Boolean No

Only authenticated users can view.

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.