C / Zoom API / Update location settings
Back to Collection Items
#include <C_CkHttp.h>
#include <C_CkHttpRequest.h>
#include <C_CkJsonObject.h>
#include <C_CkHttpResponse.h>
#include <C_CkStringBuilder.h>
void ChilkatSample(void)
{
HCkHttp http;
BOOL success;
HCkHttpRequest req;
HCkJsonObject jsonFormData1;
HCkJsonObject jsonFormData2;
HCkHttpResponse resp;
HCkStringBuilder sbResponseBody;
HCkJsonObject jResp;
int respStatusCode;
// This example assumes the Chilkat API to have been previously unlocked.
// See Global Unlock Sample for sample code.
http = CkHttp_Create();
req = CkHttpRequest_Create();
CkHttpRequest_putHttpVerb(req,"PATCH");
CkHttpRequest_putPath(req,"/v2/rooms/locations/:locationId/settings?setting_type=meeting");
CkHttpRequest_putContentType(req,"multipart/form-data");
jsonFormData1 = CkJsonObject_Create();
CkJsonObject_UpdateBool(jsonFormData1,"upcoming_meeting_alert",FALSE);
CkJsonObject_UpdateBool(jsonFormData1,"show_alert_before_meeting",TRUE);
CkJsonObject_UpdateBool(jsonFormData1,"start_airplay_mirroring",TRUE);
CkJsonObject_UpdateBool(jsonFormData1,"start_airplay_manually",TRUE);
CkJsonObject_UpdateBool(jsonFormData1,"weekly_system_restart",TRUE);
CkJsonObject_UpdateBool(jsonFormData1,"display_meeting_list",FALSE);
CkJsonObject_UpdateBool(jsonFormData1,"display_top_banner",FALSE);
CkJsonObject_UpdateBool(jsonFormData1,"display_feedback_survey",FALSE);
CkJsonObject_UpdateBool(jsonFormData1,"auto_accept_incoming_call_and_fecc",TRUE);
CkJsonObject_UpdateBool(jsonFormData1,"hide_self_view",TRUE);
CkJsonObject_UpdateBool(jsonFormData1,"lock_speaker_volume_control",TRUE);
CkJsonObject_UpdateBool(jsonFormData1,"start_hdmi_content_share_manualy",TRUE);
CkJsonObject_UpdateBool(jsonFormData1,"auto_direct_sharing",FALSE);
CkJsonObject_UpdateBool(jsonFormData1,"voice_commands",TRUE);
CkJsonObject_UpdateBool(jsonFormData1,"transform_meeting_to_private",FALSE);
CkJsonObject_UpdateBool(jsonFormData1,"hide_id_for_private_meeting",FALSE);
CkJsonObject_UpdateBool(jsonFormData1,"auto_start_scheduled_meeting",FALSE);
CkJsonObject_UpdateBool(jsonFormData1,"auto_stop_scheduled_meeting",TRUE);
CkJsonObject_UpdateBool(jsonFormData1,"audio_device_daily_auto_test",TRUE);
CkJsonObject_UpdateBool(jsonFormData1,"support_join_3rd_party_meeting",TRUE);
CkJsonObject_UpdateBool(jsonFormData1,"encrypt_shared_screen_content",FALSE);
CkJsonObject_UpdateBool(jsonFormData1,"allow_multiple_content_sharing",FALSE);
CkJsonObject_UpdateBool(jsonFormData1,"show_non_video_participants",FALSE);
CkJsonObject_UpdateBool(jsonFormData1,"show_call_history_in_room",FALSE);
CkJsonObject_UpdateBool(jsonFormData1,"show_contact_list_on_controller",TRUE);
CkJsonObject_UpdateBool(jsonFormData1,"count_attendees_number_in_room",FALSE);
CkJsonObject_UpdateBool(jsonFormData1,"send_whiteboard_to_internal_contact_only",TRUE);
CkHttpRequest_AddParam(req,"zoom_rooms",CkJsonObject_emit(jsonFormData1));
jsonFormData2 = CkJsonObject_Create();
CkJsonObject_UpdateBool(jsonFormData2,"upcoming_meeting_alert",FALSE);
CkJsonObject_UpdateBool(jsonFormData2,"show_alert_before_meeting",TRUE);
CkJsonObject_UpdateBool(jsonFormData2,"start_airplay_mirroring",TRUE);
CkJsonObject_UpdateBool(jsonFormData2,"start_airplay_manually",TRUE);
CkJsonObject_UpdateBool(jsonFormData2,"weekly_system_restart",TRUE);
CkJsonObject_UpdateBool(jsonFormData2,"display_meeting_list",FALSE);
CkJsonObject_UpdateBool(jsonFormData2,"display_top_banner",FALSE);
CkJsonObject_UpdateBool(jsonFormData2,"display_feedback_survey",FALSE);
CkJsonObject_UpdateBool(jsonFormData2,"auto_accept_incoming_call_and_fecc",TRUE);
CkJsonObject_UpdateBool(jsonFormData2,"hide_self_view",TRUE);
CkJsonObject_UpdateBool(jsonFormData2,"lock_speaker_volume_control",TRUE);
CkJsonObject_UpdateBool(jsonFormData2,"start_hdmi_content_share_manualy",TRUE);
CkJsonObject_UpdateBool(jsonFormData2,"auto_direct_sharing",FALSE);
CkJsonObject_UpdateBool(jsonFormData2,"voice_commands",TRUE);
CkJsonObject_UpdateBool(jsonFormData2,"transform_meeting_to_private",FALSE);
CkJsonObject_UpdateBool(jsonFormData2,"hide_id_for_private_meeting",FALSE);
CkJsonObject_UpdateBool(jsonFormData2,"auto_start_scheduled_meeting",FALSE);
CkJsonObject_UpdateBool(jsonFormData2,"auto_stop_scheduled_meeting",TRUE);
CkJsonObject_UpdateBool(jsonFormData2,"audio_device_daily_auto_test",TRUE);
CkJsonObject_UpdateBool(jsonFormData2,"support_join_3rd_party_meeting",TRUE);
CkJsonObject_UpdateBool(jsonFormData2,"encrypt_shared_screen_content",FALSE);
CkJsonObject_UpdateBool(jsonFormData2,"allow_multiple_content_sharing",FALSE);
CkJsonObject_UpdateBool(jsonFormData2,"show_non_video_participants",FALSE);
CkJsonObject_UpdateBool(jsonFormData2,"show_call_history_in_room",FALSE);
CkJsonObject_UpdateBool(jsonFormData2,"show_contact_list_on_controller",TRUE);
CkJsonObject_UpdateBool(jsonFormData2,"count_attendees_number_in_room",FALSE);
CkJsonObject_UpdateBool(jsonFormData2,"send_whiteboard_to_internal_contact_only",TRUE);
CkHttpRequest_AddParam(req,"meeting_security",CkJsonObject_emit(jsonFormData2));
CkHttpRequest_AddHeader(req,"Authorization","Bearer <access_token>");
resp = CkHttp_SynchronousRequest(http,"api.zoom.us",443,TRUE,req);
if (CkHttp_getLastMethodSuccess(http) == FALSE) {
printf("%s\n",CkHttp_lastErrorText(http));
CkHttp_Dispose(http);
CkHttpRequest_Dispose(req);
CkJsonObject_Dispose(jsonFormData1);
CkJsonObject_Dispose(jsonFormData2);
return;
}
sbResponseBody = CkStringBuilder_Create();
CkHttpResponse_GetBodySb(resp,sbResponseBody);
jResp = CkJsonObject_Create();
CkJsonObject_LoadSb(jResp,sbResponseBody);
CkJsonObject_putEmitCompact(jResp,FALSE);
printf("Response Body:\n");
printf("%s\n",CkJsonObject_emit(jResp));
respStatusCode = CkHttpResponse_getStatusCode(resp);
printf("Response Status Code = %d\n",respStatusCode);
if (respStatusCode >= 400) {
printf("Response Header:\n");
printf("%s\n",CkHttpResponse_header(resp));
printf("Failed.\n");
CkHttpResponse_Dispose(resp);
CkHttp_Dispose(http);
CkHttpRequest_Dispose(req);
CkJsonObject_Dispose(jsonFormData1);
CkJsonObject_Dispose(jsonFormData2);
CkStringBuilder_Dispose(sbResponseBody);
CkJsonObject_Dispose(jResp);
return;
}
CkHttpResponse_Dispose(resp);
CkHttp_Dispose(http);
CkHttpRequest_Dispose(req);
CkJsonObject_Dispose(jsonFormData1);
CkJsonObject_Dispose(jsonFormData2);
CkStringBuilder_Dispose(sbResponseBody);
CkJsonObject_Dispose(jResp);
}
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_mirroring":true,"start_airplay_manually":true,"weekly_system_restart":true,"display_meeting_list":false,"display_top_banner":false,"display_feedback_survey":false,"auto_accept_incoming_call_and_fecc":true,"hide_self_view":true,"lock_speaker_volume_control":true,"start_hdmi_content_share_manualy":true,"auto_direct_sharing":false,"voice_commands":true,"transform_meeting_to_private":false,"hide_id_for_private_meeting":false,"auto_start_scheduled_meeting":false,"auto_stop_scheduled_meeting":true,"audio_device_daily_auto_test":true,"support_join_3rd_party_meeting":true,"encrypt_shared_screen_content":false,"allow_multiple_content_sharing":false,"show_non_video_participants":false,"show_call_history_in_room":false,"show_contact_list_on_controller":true,"count_attendees_number_in_room":false,"send_whiteboard_to_internal_contact_only":true}'
--form 'meeting_security={"upcoming_meeting_alert":false,"show_alert_before_meeting":true,"start_airplay_mirroring":true,"start_airplay_manually":true,"weekly_system_restart":true,"display_meeting_list":false,"display_top_banner":false,"display_feedback_survey":false,"auto_accept_incoming_call_and_fecc":true,"hide_self_view":true,"lock_speaker_volume_control":true,"start_hdmi_content_share_manualy":true,"auto_direct_sharing":false,"voice_commands":true,"transform_meeting_to_private":false,"hide_id_for_private_meeting":false,"auto_start_scheduled_meeting":false,"auto_stop_scheduled_meeting":true,"audio_device_daily_auto_test":true,"support_join_3rd_party_meeting":true,"encrypt_shared_screen_content":false,"allow_multiple_content_sharing":false,"show_non_video_participants":false,"show_call_history_in_room":false,"show_contact_list_on_controller":true,"count_attendees_number_in_room":false,"send_whiteboard_to_internal_contact_only":true}{"end_to_end_encrypted_meetings":true,"encryption_type":"enhanced_encryption"}'
https://api.zoom.us/v2/rooms/locations/:locationId/settings?setting_type=meeting
Postman Collection Item JSON
{
"name": "Update location 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_mirroring\":true,\"start_airplay_manually\":true,\"weekly_system_restart\":true,\"display_meeting_list\":false,\"display_top_banner\":false,\"display_feedback_survey\":false,\"auto_accept_incoming_call_and_fecc\":true,\"hide_self_view\":true,\"lock_speaker_volume_control\":true,\"start_hdmi_content_share_manualy\":true,\"auto_direct_sharing\":false,\"voice_commands\":true,\"transform_meeting_to_private\":false,\"hide_id_for_private_meeting\":false,\"auto_start_scheduled_meeting\":false,\"auto_stop_scheduled_meeting\":true,\"audio_device_daily_auto_test\":true,\"support_join_3rd_party_meeting\":true,\"encrypt_shared_screen_content\":false,\"allow_multiple_content_sharing\":false,\"show_non_video_participants\":false,\"show_call_history_in_room\":false,\"show_contact_list_on_controller\":true,\"count_attendees_number_in_room\":false,\"send_whiteboard_to_internal_contact_only\":true}",
"type": "text"
},
{
"key": "meeting_security",
"value": "{\"end_to_end_encrypted_meetings\":true,\"encryption_type\":\"enhanced_encryption\"}",
"type": "text"
}
]
},
"url": {
"raw": "{{baseUrl}}/rooms/locations/:locationId/settings?setting_type=meeting",
"host": [
"{{baseUrl}}"
],
"path": [
"rooms",
"locations",
":locationId",
"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`: Digital signage settings."
}
],
"variable": [
{
"key": "locationId",
"value": "quis officia in reprehenderit",
"description": "(Required) Unique identifier of the location type. This can be retrieved using the [List Zoom Room Location API](https://marketplace.zoom.us/docs/api-reference/zoom-api/rooms-location/listzrlocations) (Id property in the response)."
}
]
},
"description": "Update information on either meeting or alert settings applied to Zoom Rooms located in a specific location. To update **Alert Settings**, specify `alert` as the value of the `setting_type` query parameter. Similarly, to update **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 **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Medium`"
},
"response": [
{
"name": "**HTTP Status Code:** `204` **No Content**<br>\nLocation settings 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\":false,\"show_alert_before_meeting\":true,\"start_airplay_mirroring\":true,\"start_airplay_manually\":true,\"weekly_system_restart\":true,\"display_meeting_list\":false,\"display_top_banner\":false,\"display_feedback_survey\":false,\"auto_accept_incoming_call_and_fecc\":true,\"hide_self_view\":true,\"lock_speaker_volume_control\":true,\"start_hdmi_content_share_manualy\":true,\"auto_direct_sharing\":false,\"voice_commands\":true,\"transform_meeting_to_private\":false,\"hide_id_for_private_meeting\":false,\"auto_start_scheduled_meeting\":false,\"auto_stop_scheduled_meeting\":true,\"audio_device_daily_auto_test\":true,\"support_join_3rd_party_meeting\":true,\"encrypt_shared_screen_content\":false,\"allow_multiple_content_sharing\":false,\"show_non_video_participants\":false,\"show_call_history_in_room\":false,\"show_contact_list_on_controller\":true,\"count_attendees_number_in_room\":false,\"send_whiteboard_to_internal_contact_only\":true}",
"type": "text"
},
{
"key": "meeting_security",
"value": "{\"end_to_end_encrypted_meetings\":true,\"encryption_type\":\"enhanced_encryption\"}",
"type": "text"
}
]
},
"url": {
"raw": "{{baseUrl}}/rooms/locations/:locationId/settings?setting_type=meeting",
"host": [
"{{baseUrl}}"
],
"path": [
"rooms",
"locations",
":locationId",
"settings"
],
"query": [
{
"key": "setting_type",
"value": "meeting"
}
],
"variable": [
{
"key": "locationId",
"value": "quis officia in reprehenderit",
"description": "(Required) Unique identifier of the location type. This can be retrieved using the [List Zoom Room Location API](https://marketplace.zoom.us/docs/api-reference/zoom-api/rooms-location/listzrlocations) (Id property in the response)."
}
]
}
},
"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_mirroring\":true,\"start_airplay_manually\":true,\"weekly_system_restart\":true,\"display_meeting_list\":false,\"display_top_banner\":false,\"display_feedback_survey\":false,\"auto_accept_incoming_call_and_fecc\":true,\"hide_self_view\":true,\"lock_speaker_volume_control\":true,\"start_hdmi_content_share_manualy\":true,\"auto_direct_sharing\":false,\"voice_commands\":true,\"transform_meeting_to_private\":false,\"hide_id_for_private_meeting\":false,\"auto_start_scheduled_meeting\":false,\"auto_stop_scheduled_meeting\":true,\"audio_device_daily_auto_test\":true,\"support_join_3rd_party_meeting\":true,\"encrypt_shared_screen_content\":false,\"allow_multiple_content_sharing\":false,\"show_non_video_participants\":false,\"show_call_history_in_room\":false,\"show_contact_list_on_controller\":true,\"count_attendees_number_in_room\":false,\"send_whiteboard_to_internal_contact_only\":true}",
"type": "text"
},
{
"key": "meeting_security",
"value": "{\"end_to_end_encrypted_meetings\":true,\"encryption_type\":\"enhanced_encryption\"}",
"type": "text"
}
]
},
"url": {
"raw": "{{baseUrl}}/rooms/locations/:locationId/settings?setting_type=meeting",
"host": [
"{{baseUrl}}"
],
"path": [
"rooms",
"locations",
":locationId",
"settings"
],
"query": [
{
"key": "setting_type",
"value": "meeting"
}
],
"variable": [
{
"key": "locationId",
"value": "quis officia in reprehenderit",
"description": "(Required) Unique identifier of the location type. This can be retrieved using the [List Zoom Room Location API](https://marketplace.zoom.us/docs/api-reference/zoom-api/rooms-location/listzrlocations) (Id property in the response)."
}
]
}
},
"status": "Bad Request",
"code": 400,
"_postman_previewlanguage": "text",
"header": [
{
"key": "Content-Type",
"value": "text/plain"
}
],
"cookie": [
],
"body": ""
},
{
"name": "**HTTP Status Code:** `404` **Not Found**<br><br>\n**Error Code:** `4801`<br>\nLocation not found: {locationId}",
"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_mirroring\":true,\"start_airplay_manually\":true,\"weekly_system_restart\":true,\"display_meeting_list\":false,\"display_top_banner\":false,\"display_feedback_survey\":false,\"auto_accept_incoming_call_and_fecc\":true,\"hide_self_view\":true,\"lock_speaker_volume_control\":true,\"start_hdmi_content_share_manualy\":true,\"auto_direct_sharing\":false,\"voice_commands\":true,\"transform_meeting_to_private\":false,\"hide_id_for_private_meeting\":false,\"auto_start_scheduled_meeting\":false,\"auto_stop_scheduled_meeting\":true,\"audio_device_daily_auto_test\":true,\"support_join_3rd_party_meeting\":true,\"encrypt_shared_screen_content\":false,\"allow_multiple_content_sharing\":false,\"show_non_video_participants\":false,\"show_call_history_in_room\":false,\"show_contact_list_on_controller\":true,\"count_attendees_number_in_room\":false,\"send_whiteboard_to_internal_contact_only\":true}",
"type": "text"
},
{
"key": "meeting_security",
"value": "{\"end_to_end_encrypted_meetings\":true,\"encryption_type\":\"enhanced_encryption\"}",
"type": "text"
}
]
},
"url": {
"raw": "{{baseUrl}}/rooms/locations/:locationId/settings?setting_type=meeting",
"host": [
"{{baseUrl}}"
],
"path": [
"rooms",
"locations",
":locationId",
"settings"
],
"query": [
{
"key": "setting_type",
"value": "meeting"
}
],
"variable": [
{
"key": "locationId",
"value": "quis officia in reprehenderit",
"description": "(Required) Unique identifier of the location type. This can be retrieved using the [List Zoom Room Location API](https://marketplace.zoom.us/docs/api-reference/zoom-api/rooms-location/listzrlocations) (Id property in the response)."
}
]
}
},
"status": "Not Found",
"code": 404,
"_postman_previewlanguage": "text",
"header": [
{
"key": "Content-Type",
"value": "text/plain"
}
],
"cookie": [
],
"body": ""
}
]
}
