lianja / Zoom API / Update Zoom Room account settings
Back to Collection Items
// This example assumes the Chilkat API to have been previously unlocked.
// See Global Unlock Sample for sample code.
loHttp = createobject("CkHttp")
loReq = createobject("CkHttpRequest")
loReq.HttpVerb = "PATCH"
loReq.Path = "/v2/rooms/account_settings?setting_type=meeting"
loReq.ContentType = "multipart/form-data"
loJsonFormData1 = createobject("CkJsonObject")
loJsonFormData1.UpdateBool("upcoming_meeting_alert",.F.)
loJsonFormData1.UpdateBool("show_alert_before_meeting",.T.)
loJsonFormData1.UpdateBool("start_airplay_manually",.F.)
loJsonFormData1.UpdateBool("weekly_system_restart",.F.)
loJsonFormData1.UpdateBool("display_meeting_list",.T.)
loJsonFormData1.UpdateBool("display_top_banner",.F.)
loJsonFormData1.UpdateBool("display_feedback_survey",.F.)
loJsonFormData1.UpdateBool("auto_direct_sharing",.T.)
loJsonFormData1.UpdateBool("transform_meeting_to_private",.T.)
loJsonFormData1.UpdateBool("hide_id_for_private_meeting",.T.)
loJsonFormData1.UpdateBool("auto_start_scheduled_meeting",.T.)
loJsonFormData1.UpdateBool("auto_stop_scheduled_meeting",.T.)
loJsonFormData1.UpdateBool("audio_device_daily_auto_test",.F.)
loJsonFormData1.UpdateBool("support_join_3rd_party_meeting",.T.)
loJsonFormData1.UpdateBool("email_address_prompt_before_recording",.T.)
loJsonFormData1.UpdateBool("secure_connection_channel",.T.)
loJsonFormData1.UpdateBool("encrypt_shared_screen_content",.F.)
loJsonFormData1.UpdateBool("allow_multiple_content_sharing",.T.)
loJsonFormData1.UpdateBool("show_non_video_participants",.T.)
loJsonFormData1.UpdateBool("show_call_history_in_room",.F.)
loJsonFormData1.UpdateBool("make_room_alternative_host",.T.)
loJsonFormData1.UpdateBool("show_contact_list_on_controller",.T.)
loJsonFormData1.UpdateBool("count_attendees_number_in_room",.T.)
loJsonFormData1.UpdateBool("send_whiteboard_to_internal_contact_only",.T.)
loReq.AddStringForUpload2("zoom_rooms","",loJsonFormData1,"utf-8","application/json")
loReq.AddHeader("Authorization","Bearer <access_token>")
loResp = loHttp.SynchronousRequest("api.zoom.us",443,.T.,loReq)
if (loHttp.LastMethodSuccess = .F.) then
? loHttp.LastErrorText
release loHttp
release loReq
release loJsonFormData1
return
endif
loSbResponseBody = createobject("CkStringBuilder")
loResp.GetBodySb(loSbResponseBody)
loJResp = createobject("CkJsonObject")
loJResp.LoadSb(loSbResponseBody)
loJResp.EmitCompact = .F.
? "Response Body:"
? loJResp.Emit()
lnRespStatusCode = loResp.StatusCode
? "Response Status Code = " + str(lnRespStatusCode)
if (lnRespStatusCode >= 400) then
? "Response Header:"
? loResp.Header
? "Failed."
release loResp
release loHttp
release loReq
release loJsonFormData1
release loSbResponseBody
release loJResp
return
endif
release loResp
release loHttp
release loReq
release loJsonFormData1
release loSbResponseBody
release loJResp
Curl Command
curl -X PATCH
-H "Authorization: Bearer <access_token>"
-H "Content-Type: multipart/form-data"
--form 'zoom_rooms={"upcoming_meeting_alert":false,"show_alert_before_meeting":true,"start_airplay_manually":false,"weekly_system_restart":false,"display_meeting_list":true,"display_top_banner":false,"display_feedback_survey":false,"auto_direct_sharing":true,"transform_meeting_to_private":true,"hide_id_for_private_meeting":true,"auto_start_scheduled_meeting":true,"auto_stop_scheduled_meeting":true,"audio_device_daily_auto_test":false,"support_join_3rd_party_meeting":true,"email_address_prompt_before_recording":true,"secure_connection_channel":true,"encrypt_shared_screen_content":false,"allow_multiple_content_sharing":true,"show_non_video_participants":true,"show_call_history_in_room":false,"make_room_alternative_host":true,"show_contact_list_on_controller":true,"count_attendees_number_in_room":true,"send_whiteboard_to_internal_contact_only":true}'
https://api.zoom.us/v2/rooms/account_settings?setting_type=meeting
Postman Collection Item JSON
{
"name": "Update Zoom Room account settings",
"request": {
"auth": {
"type": "oauth2"
},
"method": "PATCH",
"header": [
{
"key": "Content-Type",
"value": "multipart/form-data"
}
],
"body": {
"mode": "formdata",
"formdata": [
{
"key": "zoom_rooms",
"value": "{\"upcoming_meeting_alert\":false,\"show_alert_before_meeting\":true,\"start_airplay_manually\":false,\"weekly_system_restart\":false,\"display_meeting_list\":true,\"display_top_banner\":false,\"display_feedback_survey\":false,\"auto_direct_sharing\":true,\"transform_meeting_to_private\":true,\"hide_id_for_private_meeting\":true,\"auto_start_scheduled_meeting\":true,\"auto_stop_scheduled_meeting\":true,\"audio_device_daily_auto_test\":false,\"support_join_3rd_party_meeting\":true,\"email_address_prompt_before_recording\":true,\"secure_connection_channel\":true,\"encrypt_shared_screen_content\":false,\"allow_multiple_content_sharing\":true,\"show_non_video_participants\":true,\"show_call_history_in_room\":false,\"make_room_alternative_host\":true,\"show_contact_list_on_controller\":true,\"count_attendees_number_in_room\":true,\"send_whiteboard_to_internal_contact_only\":true}",
"type": "text"
}
]
},
"url": {
"raw": "{{baseUrl}}/rooms/account_settings?setting_type=meeting",
"host": [
"{{baseUrl}}"
],
"path": [
"rooms",
"account_settings"
],
"query": [
{
"key": "setting_type",
"value": "meeting",
"description": "(Required) The type of setting that you would like to update.<br> `alert`: Alert Settings applied on the Zoom Rooms Account.<br>\n`meeting`: Meeting settings of the Zoom Rooms Account.<br>\n`signage`: View digital signage settings of the Zoom Rooms Account."
}
]
},
"description": "Update account settings applied for Zoom Rooms in a Zoom account. With this API, you can update either the **Account Meeting Settings** or the **Alert Settings** (Client Alert Settings and Notfication Settings) of the Zoom Rooms account by specifying the required setting type in the `setting_type` parameter. To update only **Alert Settings**, specify `alert` as the value of the `setting_type` query parameter and to update only **Account Meeting Settings**, specify `meeting` as the value of the `setting_type` query parameter.<br><br>\n**Prerequisites:**<br>\n* Zoom Room licenses\n* Owner or Admin privileges on the Zoom Account.<br>\n**Scopes:** `room:write:admin`<br> \n\n **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Medium`"
},
"response": [
{
"name": "**HTTP Status Code:** `204` **No Content**<br>\nSettings updated successfully.\n",
"originalRequest": {
"method": "PATCH",
"header": [
{
"description": "Added as a part of security scheme: oauth2",
"key": "Authorization",
"value": "<token>"
}
],
"body": {
"mode": "formdata",
"formdata": [
{
"key": "zoom_rooms",
"value": "{\"upcoming_meeting_alert\":false,\"show_alert_before_meeting\":true,\"start_airplay_manually\":false,\"weekly_system_restart\":false,\"display_meeting_list\":true,\"display_top_banner\":false,\"display_feedback_survey\":false,\"auto_direct_sharing\":true,\"transform_meeting_to_private\":true,\"hide_id_for_private_meeting\":true,\"auto_start_scheduled_meeting\":true,\"auto_stop_scheduled_meeting\":true,\"audio_device_daily_auto_test\":false,\"support_join_3rd_party_meeting\":true,\"email_address_prompt_before_recording\":true,\"secure_connection_channel\":true,\"encrypt_shared_screen_content\":false,\"allow_multiple_content_sharing\":true,\"show_non_video_participants\":true,\"show_call_history_in_room\":false,\"make_room_alternative_host\":true,\"show_contact_list_on_controller\":true,\"count_attendees_number_in_room\":true,\"send_whiteboard_to_internal_contact_only\":true}",
"type": "text"
}
]
},
"url": {
"raw": "{{baseUrl}}/rooms/account_settings?setting_type=meeting",
"host": [
"{{baseUrl}}"
],
"path": [
"rooms",
"account_settings"
],
"query": [
{
"key": "setting_type",
"value": "meeting"
}
]
}
},
"status": "No Content",
"code": 204,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [
],
"body": "{}"
},
{
"name": "**HTTP Status Code:** `400` **Bad Request**<br><br>\n**Error Code:** `200`<br>\nZoom Room subscription not found. Try again after purchasing a Zoom Room subscription.<br>\nAccess restricted.",
"originalRequest": {
"method": "PATCH",
"header": [
{
"description": "Added as a part of security scheme: oauth2",
"key": "Authorization",
"value": "<token>"
}
],
"body": {
"mode": "formdata",
"formdata": [
{
"key": "zoom_rooms",
"value": "{\"upcoming_meeting_alert\":false,\"show_alert_before_meeting\":true,\"start_airplay_manually\":false,\"weekly_system_restart\":false,\"display_meeting_list\":true,\"display_top_banner\":false,\"display_feedback_survey\":false,\"auto_direct_sharing\":true,\"transform_meeting_to_private\":true,\"hide_id_for_private_meeting\":true,\"auto_start_scheduled_meeting\":true,\"auto_stop_scheduled_meeting\":true,\"audio_device_daily_auto_test\":false,\"support_join_3rd_party_meeting\":true,\"email_address_prompt_before_recording\":true,\"secure_connection_channel\":true,\"encrypt_shared_screen_content\":false,\"allow_multiple_content_sharing\":true,\"show_non_video_participants\":true,\"show_call_history_in_room\":false,\"make_room_alternative_host\":true,\"show_contact_list_on_controller\":true,\"count_attendees_number_in_room\":true,\"send_whiteboard_to_internal_contact_only\":true}",
"type": "text"
}
]
},
"url": {
"raw": "{{baseUrl}}/rooms/account_settings?setting_type=meeting",
"host": [
"{{baseUrl}}"
],
"path": [
"rooms",
"account_settings"
],
"query": [
{
"key": "setting_type",
"value": "meeting"
}
]
}
},
"status": "Bad Request",
"code": 400,
"_postman_previewlanguage": "text",
"header": [
{
"key": "Content-Type",
"value": "text/plain"
}
],
"cookie": [
],
"body": ""
}
]
}
