SQL Server / Zoom API / Update Zoom Room account settings
Back to Collection Items
-- Important: See this note about string length limitations for strings returned by sp_OAMethod calls.
--
CREATE PROCEDURE ChilkatSample
AS
BEGIN
DECLARE @hr int
DECLARE @iTmp0 int
-- Important: Do not use nvarchar(max). See the warning about using nvarchar(max).
DECLARE @sTmp0 nvarchar(4000)
-- This example assumes the Chilkat API to have been previously unlocked.
-- See Global Unlock Sample for sample code.
DECLARE @http int
EXEC @hr = sp_OACreate 'Chilkat_9_5_0.Http', @http OUT
IF @hr <> 0
BEGIN
PRINT 'Failed to create ActiveX component'
RETURN
END
DECLARE @success int
DECLARE @req int
EXEC @hr = sp_OACreate 'Chilkat_9_5_0.HttpRequest', @req OUT
EXEC sp_OASetProperty @req, 'HttpVerb', 'PATCH'
EXEC sp_OASetProperty @req, 'Path', '/v2/rooms/account_settings?setting_type=meeting'
EXEC sp_OASetProperty @req, 'ContentType', 'multipart/form-data'
DECLARE @jsonFormData1 int
EXEC @hr = sp_OACreate 'Chilkat_9_5_0.JsonObject', @jsonFormData1 OUT
EXEC sp_OAMethod @jsonFormData1, 'UpdateBool', @success OUT, 'upcoming_meeting_alert', 0
EXEC sp_OAMethod @jsonFormData1, 'UpdateBool', @success OUT, 'show_alert_before_meeting', 1
EXEC sp_OAMethod @jsonFormData1, 'UpdateBool', @success OUT, 'start_airplay_manually', 0
EXEC sp_OAMethod @jsonFormData1, 'UpdateBool', @success OUT, 'weekly_system_restart', 0
EXEC sp_OAMethod @jsonFormData1, 'UpdateBool', @success OUT, 'display_meeting_list', 1
EXEC sp_OAMethod @jsonFormData1, 'UpdateBool', @success OUT, 'display_top_banner', 0
EXEC sp_OAMethod @jsonFormData1, 'UpdateBool', @success OUT, 'display_feedback_survey', 0
EXEC sp_OAMethod @jsonFormData1, 'UpdateBool', @success OUT, 'auto_direct_sharing', 1
EXEC sp_OAMethod @jsonFormData1, 'UpdateBool', @success OUT, 'transform_meeting_to_private', 1
EXEC sp_OAMethod @jsonFormData1, 'UpdateBool', @success OUT, 'hide_id_for_private_meeting', 1
EXEC sp_OAMethod @jsonFormData1, 'UpdateBool', @success OUT, 'auto_start_scheduled_meeting', 1
EXEC sp_OAMethod @jsonFormData1, 'UpdateBool', @success OUT, 'auto_stop_scheduled_meeting', 1
EXEC sp_OAMethod @jsonFormData1, 'UpdateBool', @success OUT, 'audio_device_daily_auto_test', 0
EXEC sp_OAMethod @jsonFormData1, 'UpdateBool', @success OUT, 'support_join_3rd_party_meeting', 1
EXEC sp_OAMethod @jsonFormData1, 'UpdateBool', @success OUT, 'email_address_prompt_before_recording', 1
EXEC sp_OAMethod @jsonFormData1, 'UpdateBool', @success OUT, 'secure_connection_channel', 1
EXEC sp_OAMethod @jsonFormData1, 'UpdateBool', @success OUT, 'encrypt_shared_screen_content', 0
EXEC sp_OAMethod @jsonFormData1, 'UpdateBool', @success OUT, 'allow_multiple_content_sharing', 1
EXEC sp_OAMethod @jsonFormData1, 'UpdateBool', @success OUT, 'show_non_video_participants', 1
EXEC sp_OAMethod @jsonFormData1, 'UpdateBool', @success OUT, 'show_call_history_in_room', 0
EXEC sp_OAMethod @jsonFormData1, 'UpdateBool', @success OUT, 'make_room_alternative_host', 1
EXEC sp_OAMethod @jsonFormData1, 'UpdateBool', @success OUT, 'show_contact_list_on_controller', 1
EXEC sp_OAMethod @jsonFormData1, 'UpdateBool', @success OUT, 'count_attendees_number_in_room', 1
EXEC sp_OAMethod @jsonFormData1, 'UpdateBool', @success OUT, 'send_whiteboard_to_internal_contact_only', 1
EXEC sp_OAMethod @jsonFormData1, 'Emit', @sTmp0 OUT
EXEC sp_OAMethod @req, 'AddParam', NULL, 'zoom_rooms', @sTmp0
EXEC sp_OAMethod @req, 'AddHeader', NULL, 'Authorization', 'Bearer <access_token>'
DECLARE @resp int
EXEC sp_OAMethod @http, 'SynchronousRequest', @resp OUT, 'api.zoom.us', 443, 1, @req
EXEC sp_OAGetProperty @http, 'LastMethodSuccess', @iTmp0 OUT
IF @iTmp0 = 0
BEGIN
EXEC sp_OAGetProperty @http, 'LastErrorText', @sTmp0 OUT
PRINT @sTmp0
EXEC @hr = sp_OADestroy @http
EXEC @hr = sp_OADestroy @req
EXEC @hr = sp_OADestroy @jsonFormData1
RETURN
END
DECLARE @sbResponseBody int
EXEC @hr = sp_OACreate 'Chilkat_9_5_0.StringBuilder', @sbResponseBody OUT
EXEC sp_OAMethod @resp, 'GetBodySb', @success OUT, @sbResponseBody
DECLARE @jResp int
EXEC @hr = sp_OACreate 'Chilkat_9_5_0.JsonObject', @jResp OUT
EXEC sp_OAMethod @jResp, 'LoadSb', @success OUT, @sbResponseBody
EXEC sp_OASetProperty @jResp, 'EmitCompact', 0
PRINT 'Response Body:'
EXEC sp_OAMethod @jResp, 'Emit', @sTmp0 OUT
PRINT @sTmp0
DECLARE @respStatusCode int
EXEC sp_OAGetProperty @resp, 'StatusCode', @respStatusCode OUT
PRINT 'Response Status Code = ' + @respStatusCode
IF @respStatusCode >= 400
BEGIN
PRINT 'Response Header:'
EXEC sp_OAGetProperty @resp, 'Header', @sTmp0 OUT
PRINT @sTmp0
PRINT 'Failed.'
EXEC @hr = sp_OADestroy @resp
EXEC @hr = sp_OADestroy @http
EXEC @hr = sp_OADestroy @req
EXEC @hr = sp_OADestroy @jsonFormData1
EXEC @hr = sp_OADestroy @sbResponseBody
EXEC @hr = sp_OADestroy @jResp
RETURN
END
EXEC @hr = sp_OADestroy @resp
EXEC @hr = sp_OADestroy @http
EXEC @hr = sp_OADestroy @req
EXEC @hr = sp_OADestroy @jsonFormData1
EXEC @hr = sp_OADestroy @sbResponseBody
EXEC @hr = sp_OADestroy @jResp
END
GO
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": ""
}
]
}
