PATCH /groups/{groupId}/settings

Update settings for a group.


Note: The force_pmi_jbh_password field under meeting settings is planned to be deprecated on September 22, 2019. This field will be replaced by another field that will provide the same functionality.

Prerequisite: Pro, Business, or Education account
Scopes: group:write:admin

Rate Limit Label: Medium

Servers

Path parameters

Name Type Required Description
groupId String Yes

Id of the group.

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
option String No

Valid values:

  • "recording_authentication"
  • "meeting_authentication"
  • "meeting_security"
custom_query_fields String No

Provide the name of the field by which you would like to filter the response. For example, if you provide "host_video" as the value of this field, you will get a response similar to the following:
{ "schedule_meeting": { "host_video": false } }
You can provide multiple values by separating them with commas(example: "host_video,participant_video”).

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.