TCL / Zoom API / Update Zoom Room settings
Back to Collection Items
load ./chilkat.dll
# This example assumes the Chilkat API to have been previously unlocked.
# See Global Unlock Sample for sample code.
set http [new_CkHttp]
set req [new_CkHttpRequest]
CkHttpRequest_put_HttpVerb $req "PATCH"
CkHttpRequest_put_Path $req "/"
CkHttpRequest_put_ContentType $req "multipart/form-data"
set jsonFormData1 [new_CkJsonObject]
CkJsonObject_UpdateBool $jsonFormData1 "upcoming_meeting_alert" 1
CkJsonObject_UpdateBool $jsonFormData1 "show_alert_before_meeting" 1
CkJsonObject_UpdateBool $jsonFormData1 "start_airplay_mirroring" 1
CkJsonObject_UpdateBool $jsonFormData1 "start_airplay_manually" 1
CkJsonObject_UpdateBool $jsonFormData1 "weekly_system_restart" 0
CkJsonObject_UpdateBool $jsonFormData1 "display_meeting_list" 0
CkJsonObject_UpdateBool $jsonFormData1 "display_top_banner" 1
CkJsonObject_UpdateBool $jsonFormData1 "display_feedback_survey" 1
CkJsonObject_UpdateBool $jsonFormData1 "auto_direct_sharing" 1
CkJsonObject_UpdateBool $jsonFormData1 "transform_meeting_to_private" 1
CkJsonObject_UpdateBool $jsonFormData1 "hide_id_for_private_meeting" 0
CkJsonObject_UpdateBool $jsonFormData1 "auto_start_scheduled_meeting" 1
CkJsonObject_UpdateBool $jsonFormData1 "auto_stop_scheduled_meeting" 0
CkJsonObject_UpdateBool $jsonFormData1 "hide_share_instruction" 0
CkJsonObject_UpdateBool $jsonFormData1 "audio_device_daily_auto_test" 0
CkJsonObject_UpdateBool $jsonFormData1 "support_join_3rd_party_meeting" 0
CkJsonObject_UpdateBool $jsonFormData1 "encrypt_shared_screen_content" 0
CkJsonObject_UpdateBool $jsonFormData1 "allow_multiple_content_sharing" 1
CkJsonObject_UpdateBool $jsonFormData1 "show_non_video_participants" 1
CkJsonObject_UpdateBool $jsonFormData1 "show_call_history_in_room" 0
CkJsonObject_UpdateBool $jsonFormData1 "show_contact_list_on_controller" 1
CkJsonObject_UpdateBool $jsonFormData1 "count_attendees_number_in_room" 1
CkJsonObject_UpdateBool $jsonFormData1 "send_whiteboard_to_internal_contact_only" 0
CkHttpRequest_AddParam $req "zoom_rooms" [CkJsonObject_emit $jsonFormData1]
set jsonFormData2 [new_CkJsonObject]
CkJsonObject_UpdateBool $jsonFormData2 "upcoming_meeting_alert" 1
CkJsonObject_UpdateBool $jsonFormData2 "show_alert_before_meeting" 1
CkJsonObject_UpdateBool $jsonFormData2 "start_airplay_mirroring" 1
CkJsonObject_UpdateBool $jsonFormData2 "start_airplay_manually" 1
CkJsonObject_UpdateBool $jsonFormData2 "weekly_system_restart" 0
CkJsonObject_UpdateBool $jsonFormData2 "display_meeting_list" 0
CkJsonObject_UpdateBool $jsonFormData2 "display_top_banner" 1
CkJsonObject_UpdateBool $jsonFormData2 "display_feedback_survey" 1
CkJsonObject_UpdateBool $jsonFormData2 "auto_direct_sharing" 1
CkJsonObject_UpdateBool $jsonFormData2 "transform_meeting_to_private" 1
CkJsonObject_UpdateBool $jsonFormData2 "hide_id_for_private_meeting" 0
CkJsonObject_UpdateBool $jsonFormData2 "auto_start_scheduled_meeting" 1
CkJsonObject_UpdateBool $jsonFormData2 "auto_stop_scheduled_meeting" 0
CkJsonObject_UpdateBool $jsonFormData2 "hide_share_instruction" 0
CkJsonObject_UpdateBool $jsonFormData2 "audio_device_daily_auto_test" 0
CkJsonObject_UpdateBool $jsonFormData2 "support_join_3rd_party_meeting" 0
CkJsonObject_UpdateBool $jsonFormData2 "encrypt_shared_screen_content" 0
CkJsonObject_UpdateBool $jsonFormData2 "allow_multiple_content_sharing" 1
CkJsonObject_UpdateBool $jsonFormData2 "show_non_video_participants" 1
CkJsonObject_UpdateBool $jsonFormData2 "show_call_history_in_room" 0
CkJsonObject_UpdateBool $jsonFormData2 "show_contact_list_on_controller" 1
CkJsonObject_UpdateBool $jsonFormData2 "count_attendees_number_in_room" 1
CkJsonObject_UpdateBool $jsonFormData2 "send_whiteboard_to_internal_contact_only" 0
CkHttpRequest_AddParam $req "meeting_security" [CkJsonObject_emit $jsonFormData2]
CkHttpRequest_AddHeader $req "Authorization" "Bearer <access_token>"
# resp is a CkHttpResponse
set resp [CkHttp_SynchronousRequest $http "reprehenderit" 80 0 $req]
if {[CkHttp_get_LastMethodSuccess $http] == 0} then {
puts [CkHttp_lastErrorText $http]
delete_CkHttp $http
delete_CkHttpRequest $req
delete_CkJsonObject $jsonFormData1
delete_CkJsonObject $jsonFormData2
exit
}
set sbResponseBody [new_CkStringBuilder]
CkHttpResponse_GetBodySb $resp $sbResponseBody
set jResp [new_CkJsonObject]
CkJsonObject_LoadSb $jResp $sbResponseBody
CkJsonObject_put_EmitCompact $jResp 0
puts "Response Body:"
puts [CkJsonObject_emit $jResp]
set respStatusCode [CkHttpResponse_get_StatusCode $resp]
puts "Response Status Code = $respStatusCode"
if {$respStatusCode >= 400} then {
puts "Response Header:"
puts [CkHttpResponse_header $resp]
puts "Failed."
delete_CkHttpResponse $resp
delete_CkHttp $http
delete_CkHttpRequest $req
delete_CkJsonObject $jsonFormData1
delete_CkJsonObject $jsonFormData2
delete_CkStringBuilder $sbResponseBody
delete_CkJsonObject $jResp
exit
}
delete_CkHttpResponse $resp
delete_CkHttp $http
delete_CkHttpRequest $req
delete_CkJsonObject $jsonFormData1
delete_CkJsonObject $jsonFormData2
delete_CkStringBuilder $sbResponseBody
delete_CkJsonObject $jResp
Curl Command
curl -X PATCH
-H "Authorization: Bearer <access_token>"
-H "Content-Type: multipart/form-data"
--form 'zoom_rooms={"upcoming_meeting_alert":true,"show_alert_before_meeting":true,"start_airplay_mirroring":true,"start_airplay_manually":true,"weekly_system_restart":false,"display_meeting_list":false,"display_top_banner":true,"display_feedback_survey":true,"auto_direct_sharing":true,"transform_meeting_to_private":true,"hide_id_for_private_meeting":false,"auto_start_scheduled_meeting":true,"auto_stop_scheduled_meeting":false,"hide_share_instruction":false,"audio_device_daily_auto_test":false,"support_join_3rd_party_meeting":false,"encrypt_shared_screen_content":false,"allow_multiple_content_sharing":true,"show_non_video_participants":true,"show_call_history_in_room":false,"show_contact_list_on_controller":true,"count_attendees_number_in_room":true,"send_whiteboard_to_internal_contact_only":false}'
--form 'meeting_security={"upcoming_meeting_alert":true,"show_alert_before_meeting":true,"start_airplay_mirroring":true,"start_airplay_manually":true,"weekly_system_restart":false,"display_meeting_list":false,"display_top_banner":true,"display_feedback_survey":true,"auto_direct_sharing":true,"transform_meeting_to_private":true,"hide_id_for_private_meeting":false,"auto_start_scheduled_meeting":true,"auto_stop_scheduled_meeting":false,"hide_share_instruction":false,"audio_device_daily_auto_test":false,"support_join_3rd_party_meeting":false,"encrypt_shared_screen_content":false,"allow_multiple_content_sharing":true,"show_non_video_participants":true,"show_call_history_in_room":false,"show_contact_list_on_controller":true,"count_attendees_number_in_room":true,"send_whiteboard_to_internal_contact_only":false}{"end_to_end_encrypted_meetings":true,"encryption_type":"enhanced_encryption"}'
https://api.zoom.us/v2/rooms/:roomId/settings?setting_type=quis officia in reprehenderit
Postman Collection Item JSON
{
"name": "Update Zoom Room 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\":true,\"show_alert_before_meeting\":true,\"start_airplay_mirroring\":true,\"start_airplay_manually\":true,\"weekly_system_restart\":false,\"display_meeting_list\":false,\"display_top_banner\":true,\"display_feedback_survey\":true,\"auto_direct_sharing\":true,\"transform_meeting_to_private\":true,\"hide_id_for_private_meeting\":false,\"auto_start_scheduled_meeting\":true,\"auto_stop_scheduled_meeting\":false,\"hide_share_instruction\":false,\"audio_device_daily_auto_test\":false,\"support_join_3rd_party_meeting\":false,\"encrypt_shared_screen_content\":false,\"allow_multiple_content_sharing\":true,\"show_non_video_participants\":true,\"show_call_history_in_room\":false,\"show_contact_list_on_controller\":true,\"count_attendees_number_in_room\":true,\"send_whiteboard_to_internal_contact_only\":false}",
"type": "text"
},
{
"key": "meeting_security",
"value": "{\"end_to_end_encrypted_meetings\":true,\"encryption_type\":\"enhanced_encryption\"}",
"type": "text"
}
]
},
"url": {
"raw": "{{baseUrl}}/rooms/:roomId/settings?setting_type=quis officia in reprehenderit",
"host": [
"{{baseUrl}}"
],
"path": [
"rooms",
":roomId",
"settings"
],
"query": [
{
"key": "setting_type",
"value": "quis officia in reprehenderit",
"description": "The type of setting that you would like to update.<br> `alert`: Alert Settings applied on the Zoom Room.<br>\n`meeting`: Meeting settings of the Zoom Room.<br>\n`signage`: Digital signage settings applied on the Zoom Room."
}
],
"variable": [
{
"key": "roomId",
"value": "quis officia in reprehenderit",
"description": "(Required) Unique Identifier of the Zoom Room."
}
]
},
"description": "Update either meeting or alert settings applied to a specific Zoom Room. To update **Alert Settings**, specify `alert` as the value of the `setting_type` query parameter. To update **Meeting Settings**, specify `meeting` as the value of the `setting_type` query parameter.<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 **[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. ",
"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\":true,\"show_alert_before_meeting\":true,\"start_airplay_mirroring\":true,\"start_airplay_manually\":true,\"weekly_system_restart\":false,\"display_meeting_list\":false,\"display_top_banner\":true,\"display_feedback_survey\":true,\"auto_direct_sharing\":true,\"transform_meeting_to_private\":true,\"hide_id_for_private_meeting\":false,\"auto_start_scheduled_meeting\":true,\"auto_stop_scheduled_meeting\":false,\"hide_share_instruction\":false,\"audio_device_daily_auto_test\":false,\"support_join_3rd_party_meeting\":false,\"encrypt_shared_screen_content\":false,\"allow_multiple_content_sharing\":true,\"show_non_video_participants\":true,\"show_call_history_in_room\":false,\"show_contact_list_on_controller\":true,\"count_attendees_number_in_room\":true,\"send_whiteboard_to_internal_contact_only\":false}",
"type": "text"
},
{
"key": "meeting_security",
"value": "{\"end_to_end_encrypted_meetings\":true,\"encryption_type\":\"enhanced_encryption\"}",
"type": "text"
}
]
},
"url": {
"raw": "{{baseUrl}}/rooms/:roomId/settings?setting_type=quis officia in reprehenderit",
"host": [
"{{baseUrl}}"
],
"path": [
"rooms",
":roomId",
"settings"
],
"query": [
{
"key": "setting_type",
"value": "quis officia in reprehenderit"
}
],
"variable": [
{
"key": "roomId",
"value": "quis officia in reprehenderit",
"description": "(Required) Unique Identifier of the Zoom Room."
}
]
}
},
"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\":true,\"show_alert_before_meeting\":true,\"start_airplay_mirroring\":true,\"start_airplay_manually\":true,\"weekly_system_restart\":false,\"display_meeting_list\":false,\"display_top_banner\":true,\"display_feedback_survey\":true,\"auto_direct_sharing\":true,\"transform_meeting_to_private\":true,\"hide_id_for_private_meeting\":false,\"auto_start_scheduled_meeting\":true,\"auto_stop_scheduled_meeting\":false,\"hide_share_instruction\":false,\"audio_device_daily_auto_test\":false,\"support_join_3rd_party_meeting\":false,\"encrypt_shared_screen_content\":false,\"allow_multiple_content_sharing\":true,\"show_non_video_participants\":true,\"show_call_history_in_room\":false,\"show_contact_list_on_controller\":true,\"count_attendees_number_in_room\":true,\"send_whiteboard_to_internal_contact_only\":false}",
"type": "text"
},
{
"key": "meeting_security",
"value": "{\"end_to_end_encrypted_meetings\":true,\"encryption_type\":\"enhanced_encryption\"}",
"type": "text"
}
]
},
"url": {
"raw": "{{baseUrl}}/rooms/:roomId/settings?setting_type=quis officia in reprehenderit",
"host": [
"{{baseUrl}}"
],
"path": [
"rooms",
":roomId",
"settings"
],
"query": [
{
"key": "setting_type",
"value": "quis officia in reprehenderit"
}
],
"variable": [
{
"key": "roomId",
"value": "quis officia in reprehenderit",
"description": "(Required) Unique Identifier of the Zoom Room."
}
]
}
},
"status": "Bad Request",
"code": 400,
"_postman_previewlanguage": "text",
"header": [
{
"key": "Content-Type",
"value": "text/plain"
}
],
"cookie": [
],
"body": ""
}
]
}
