Swift3 / Zoom API / Update location settings
Back to Collection Items
func chilkatTest() {
// This example assumes the Chilkat API to have been previously unlocked.
// See Global Unlock Sample for sample code.
let http = CkoHttp()!
var success: Bool
let req = CkoHttpRequest()!
req.httpVerb = "PATCH"
req.path = "/v2/rooms/locations/:locationId/settings?setting_type=meeting"
req.contentType = "multipart/form-data"
let jsonFormData1 = CkoJsonObject()!
jsonFormData1.updateBool("upcoming_meeting_alert", value: false)
jsonFormData1.updateBool("show_alert_before_meeting", value: true)
jsonFormData1.updateBool("start_airplay_mirroring", value: true)
jsonFormData1.updateBool("start_airplay_manually", value: true)
jsonFormData1.updateBool("weekly_system_restart", value: true)
jsonFormData1.updateBool("display_meeting_list", value: false)
jsonFormData1.updateBool("display_top_banner", value: false)
jsonFormData1.updateBool("display_feedback_survey", value: false)
jsonFormData1.updateBool("auto_accept_incoming_call_and_fecc", value: true)
jsonFormData1.updateBool("hide_self_view", value: true)
jsonFormData1.updateBool("lock_speaker_volume_control", value: true)
jsonFormData1.updateBool("start_hdmi_content_share_manualy", value: true)
jsonFormData1.updateBool("auto_direct_sharing", value: false)
jsonFormData1.updateBool("voice_commands", value: true)
jsonFormData1.updateBool("transform_meeting_to_private", value: false)
jsonFormData1.updateBool("hide_id_for_private_meeting", value: false)
jsonFormData1.updateBool("auto_start_scheduled_meeting", value: false)
jsonFormData1.updateBool("auto_stop_scheduled_meeting", value: true)
jsonFormData1.updateBool("audio_device_daily_auto_test", value: true)
jsonFormData1.updateBool("support_join_3rd_party_meeting", value: true)
jsonFormData1.updateBool("encrypt_shared_screen_content", value: false)
jsonFormData1.updateBool("allow_multiple_content_sharing", value: false)
jsonFormData1.updateBool("show_non_video_participants", value: false)
jsonFormData1.updateBool("show_call_history_in_room", value: false)
jsonFormData1.updateBool("show_contact_list_on_controller", value: true)
jsonFormData1.updateBool("count_attendees_number_in_room", value: false)
jsonFormData1.updateBool("send_whiteboard_to_internal_contact_only", value: true)
req.addParam("zoom_rooms", value: jsonFormData1.emit())
let jsonFormData2 = CkoJsonObject()!
jsonFormData2.updateBool("upcoming_meeting_alert", value: false)
jsonFormData2.updateBool("show_alert_before_meeting", value: true)
jsonFormData2.updateBool("start_airplay_mirroring", value: true)
jsonFormData2.updateBool("start_airplay_manually", value: true)
jsonFormData2.updateBool("weekly_system_restart", value: true)
jsonFormData2.updateBool("display_meeting_list", value: false)
jsonFormData2.updateBool("display_top_banner", value: false)
jsonFormData2.updateBool("display_feedback_survey", value: false)
jsonFormData2.updateBool("auto_accept_incoming_call_and_fecc", value: true)
jsonFormData2.updateBool("hide_self_view", value: true)
jsonFormData2.updateBool("lock_speaker_volume_control", value: true)
jsonFormData2.updateBool("start_hdmi_content_share_manualy", value: true)
jsonFormData2.updateBool("auto_direct_sharing", value: false)
jsonFormData2.updateBool("voice_commands", value: true)
jsonFormData2.updateBool("transform_meeting_to_private", value: false)
jsonFormData2.updateBool("hide_id_for_private_meeting", value: false)
jsonFormData2.updateBool("auto_start_scheduled_meeting", value: false)
jsonFormData2.updateBool("auto_stop_scheduled_meeting", value: true)
jsonFormData2.updateBool("audio_device_daily_auto_test", value: true)
jsonFormData2.updateBool("support_join_3rd_party_meeting", value: true)
jsonFormData2.updateBool("encrypt_shared_screen_content", value: false)
jsonFormData2.updateBool("allow_multiple_content_sharing", value: false)
jsonFormData2.updateBool("show_non_video_participants", value: false)
jsonFormData2.updateBool("show_call_history_in_room", value: false)
jsonFormData2.updateBool("show_contact_list_on_controller", value: true)
jsonFormData2.updateBool("count_attendees_number_in_room", value: false)
jsonFormData2.updateBool("send_whiteboard_to_internal_contact_only", value: true)
req.addParam("meeting_security", value: jsonFormData2.emit())
req.addHeader("Authorization", value: "Bearer <access_token>")
var resp: CkoHttpResponse? = http.synchronousRequest("api.zoom.us", port: 443, ssl: true, req: req)
if http.lastMethodSuccess == false {
print("\(http.lastErrorText!)")
return
}
let sbResponseBody = CkoStringBuilder()!
resp!.getBodySb(sbResponseBody)
let jResp = CkoJsonObject()!
jResp.loadSb(sbResponseBody)
jResp.emitCompact = false
print("Response Body:")
print("\(jResp.emit()!)")
var respStatusCode: Int = resp!.statusCode.intValue
print("Response Status Code = \(respStatusCode)")
if respStatusCode >= 400 {
print("Response Header:")
print("\(resp!.header!)")
print("Failed.")
resp = nil
return
}
resp = nil
}
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": ""
}
]
}
